SAP Function Modules

comments icon Comments

OIJ_NOM_DOCUMENTS_READ SAP Function module - Read nomination document data







OIJ_NOM_DOCUMENTS_READ is a standard SAP function module available within R/3 SAP systems depending on your version and release level. Below is the pattern details for this FM showing its interface including any import and export parameters, exceptions etc as well as any documentation contributions (Comments) specific to the object.

See here to view full function module documentation and code listing, simply by entering the name OIJ_NOM_DOCUMENTS_READ into the relevant SAP transaction such as SE37 or SE80.

Associated Function Group: OIJ_NOM_CORE
Released Date: Not Released
Processing type: Normal fucntion module
Normal function module settings


Pattern for FM OIJ_NOM_DOCUMENTS_READ - OIJ NOM DOCUMENTS READ 





CALL FUNCTION 'OIJ_NOM_DOCUMENTS_READ' "Read nomination document data
  EXPORTING
    it_nomh_key =               " roijnomh_key_t  Nomination Header Key Table Type
*   iv_lock = ' '               " boolean       boolean variable (X=true, -=false, space=unknown)
*   iv_bypassing_buffer = ' '   " boolean       boolean variable (X=true, -=false, space=unknown)
*   iv_refresh_buffer = ' '     " boolean       boolean variable (X=true, -=false, space=unknown)
*   iv_prefetch_for_dialog = ' '  " boolean     boolean variable (X=true, -=false, space=unknown)
*   it_nom_header =             " roijnomhio_t  Nomination Header Communcation Table Type
*   it_nom_item =               " roijnomiio_t  Nomination Item Communication
*   iv_no_tickets = ' '         " boolean       in case of X do not(!) read tickets
  IMPORTING
    et_nom_header =             " roijnomhio_t  Nomination Header Communcation Table Type
    et_nom_header_text =        " oij_txt       TSW: table type to roij_txt
    et_nom_item =               " roijnomiio_t  Nomination Item Communication
    et_nom_item_text =          " oij_txt       TSW: table type to roij_txt
    et_nom_events =             " roijneio_t    Nomination Events Communication Table
    et_nom_events_text =        " oij_txt       Table Type for TSW BAPI Structure BAPITSWNOM09
    et_nom_balance =            " roijnommvb_t  Nomination Material Balance Table Type
    et_nom_stages =             " roij_stagesio_t  TSW (&TD) STages IO
    et_nom_comm =               " oijnomcomm_t  Nomination Partner Communication Table Type
    et_nom_ref =                " roijnomrio_t  Nomination Reference Documents IO Table Type
    et_nom_pegging =            " oij_peg_tt    TSW: Table type - Pegging of scheduled movements
    et_nom_loaddischarge =      " roijnomi_lds_io_t  Table type for holding berth scheduling data
    et_nom_status =             " roijnomst_upd_t  Nomination status update structure
    et_enq_ok =                 " roijnomh_key_t  Nomination Header Key Table Type
    et_enq_nok =                " roijnomh_key_t  Nomination Header Key Table Type
    et_nom_subitem =            " roijnomsubitemsio_t  TSW: Table type for Nomination sub-items communication
    et_nom_hatchload =          " roijnomhatloadio_t  Hatch load sequence communication table
    et_nom_hatchplan =          " roijnomhatplanio_t  Table type for the hatch plan communication structure
* CHANGING
*   xt_return =                 " bapiret2_t    Return parameter table
    .  "  OIJ_NOM_DOCUMENTS_READ

ABAP code example for Function Module OIJ_NOM_DOCUMENTS_READ





The ABAP code below is a full code listing to execute function module OIJ_NOM_DOCUMENTS_READ including all data declarations. The code uses the latest in-line data DECLARATION SYNTAX but I have included an ABAP code snippet at the end to show how declarations would look using the original method of declaring data variables up front. This will allow you to compare and fully understand the new inline method. Please note some of the newer syntax such as the @DATA is not available until a later 4.70 service pack (SP8).

DATA:
ld_et_nom_header    TYPE ROIJNOMHIO_T
,
ld_et_nom_header_text    TYPE OIJ_TXT
,
ld_et_nom_item    TYPE ROIJNOMIIO_T
,
ld_et_nom_item_text    TYPE OIJ_TXT
,
ld_et_nom_events    TYPE ROIJNEIO_T
,
ld_et_nom_events_text    TYPE OIJ_TXT
,
ld_et_nom_balance    TYPE ROIJNOMMVB_T
,
ld_et_nom_stages    TYPE ROIJ_STAGESIO_T
,
ld_et_nom_comm    TYPE OIJNOMCOMM_T
,
ld_et_nom_ref    TYPE ROIJNOMRIO_T
,
ld_et_nom_pegging    TYPE OIJ_PEG_TT
,
ld_et_nom_loaddischarge    TYPE ROIJNOMI_LDS_IO_T
,
ld_et_nom_status    TYPE ROIJNOMST_UPD_T
,
ld_et_enq_ok    TYPE ROIJNOMH_KEY_T
,
ld_et_enq_nok    TYPE ROIJNOMH_KEY_T
,
ld_et_nom_subitem    TYPE ROIJNOMSUBITEMSIO_T
,
ld_et_nom_hatchload    TYPE ROIJNOMHATLOADIO_T
,
ld_et_nom_hatchplan    TYPE ROIJNOMHATPLANIO_T
.




DATA(ld_xt_return) = 'Check type of data required'.

DATA(ld_it_nomh_key) = 'Check type of data required'.

DATA(ld_iv_lock) = 'Check type of data required'.

DATA(ld_iv_bypassing_buffer) = 'Check type of data required'.

DATA(ld_iv_refresh_buffer) = 'Check type of data required'.

DATA(ld_iv_prefetch_for_dialog) = 'Check type of data required'.

DATA(ld_it_nom_header) = 'Check type of data required'.

DATA(ld_it_nom_item) = 'Check type of data required'.

DATA(ld_iv_no_tickets) = 'Check type of data required'.
.

CALL FUNCTION 'OIJ_NOM_DOCUMENTS_READ'
  EXPORTING
    it_nomh_key =                ld_it_nomh_key
*   iv_lock =                    ld_iv_lock
*   iv_bypassing_buffer =        ld_iv_bypassing_buffer
*   iv_refresh_buffer =          ld_iv_refresh_buffer
*   iv_prefetch_for_dialog =     ld_iv_prefetch_for_dialog
*   it_nom_header =              ld_it_nom_header
*   it_nom_item =                ld_it_nom_item
*   iv_no_tickets =              ld_iv_no_tickets
  IMPORTING
    et_nom_header =              ld_et_nom_header
    et_nom_header_text =         ld_et_nom_header_text
    et_nom_item =                ld_et_nom_item
    et_nom_item_text =           ld_et_nom_item_text
    et_nom_events =              ld_et_nom_events
    et_nom_events_text =         ld_et_nom_events_text
    et_nom_balance =             ld_et_nom_balance
    et_nom_stages =              ld_et_nom_stages
    et_nom_comm =                ld_et_nom_comm
    et_nom_ref =                 ld_et_nom_ref
    et_nom_pegging =             ld_et_nom_pegging
    et_nom_loaddischarge =       ld_et_nom_loaddischarge
    et_nom_status =              ld_et_nom_status
    et_enq_ok =                  ld_et_enq_ok
    et_enq_nok =                 ld_et_enq_nok
    et_nom_subitem =             ld_et_nom_subitem
    et_nom_hatchload =           ld_et_nom_hatchload
    et_nom_hatchplan =           ld_et_nom_hatchplan
* CHANGING
*   xt_return =                  ld_xt_return
    .  "  OIJ_NOM_DOCUMENTS_READ

IF SY-SUBRC EQ 0.
  "All OK
ENDIF.







ABAP code to compare 7.40 inline data declaration with original syntax

The below ABAP code uses the older none in-line data declarations. This allows you to see the coding differences/benefits of the later inline syntax. It may also be useful if you are using an older version of SAP as some of the newer syntax above, such as the @DATA is not available until 4.70 EHP 8.

DATA:


ld_xt_return  TYPE BAPIRET2_T ,
ld_et_nom_header  TYPE ROIJNOMHIO_T ,
ld_it_nomh_key  TYPE ROIJNOMH_KEY_T ,
ld_et_nom_header_text  TYPE OIJ_TXT ,
ld_iv_lock  TYPE BOOLEAN ,
ld_et_nom_item  TYPE ROIJNOMIIO_T ,
ld_iv_bypassing_buffer  TYPE BOOLEAN ,
ld_et_nom_item_text  TYPE OIJ_TXT ,
ld_iv_refresh_buffer  TYPE BOOLEAN ,
ld_et_nom_events  TYPE ROIJNEIO_T ,
ld_iv_prefetch_for_dialog  TYPE BOOLEAN ,
ld_et_nom_events_text  TYPE OIJ_TXT ,
ld_it_nom_header  TYPE ROIJNOMHIO_T ,
ld_et_nom_balance  TYPE ROIJNOMMVB_T ,
ld_it_nom_item  TYPE ROIJNOMIIO_T ,
ld_et_nom_stages  TYPE ROIJ_STAGESIO_T ,
ld_iv_no_tickets  TYPE BOOLEAN ,
ld_et_nom_comm  TYPE OIJNOMCOMM_T ,
ld_et_nom_ref  TYPE ROIJNOMRIO_T ,
ld_et_nom_pegging  TYPE OIJ_PEG_TT ,
ld_et_nom_loaddischarge  TYPE ROIJNOMI_LDS_IO_T ,
ld_et_nom_status  TYPE ROIJNOMST_UPD_T ,
ld_et_enq_ok  TYPE ROIJNOMH_KEY_T ,
ld_et_enq_nok  TYPE ROIJNOMH_KEY_T ,
ld_et_nom_subitem  TYPE ROIJNOMSUBITEMSIO_T ,
ld_et_nom_hatchload  TYPE ROIJNOMHATLOADIO_T ,
ld_et_nom_hatchplan  TYPE ROIJNOMHATPLANIO_T .




ld_xt_return = 'Check type of data required'.
ld_it_nomh_key = 'Check type of data required'.
ld_iv_lock = 'Check type of data required'.
ld_iv_bypassing_buffer = 'Check type of data required'.
ld_iv_refresh_buffer = 'Check type of data required'.
ld_iv_prefetch_for_dialog = 'Check type of data required'.
ld_it_nom_header = 'Check type of data required'.
ld_it_nom_item = 'Check type of data required'.
ld_iv_no_tickets = 'Check type of data required'.

Contribute (Add Comments)

Please help keep this info upto date and use the comments section below to add useful hints, tips and information specific to this SAP function. This will then be available for you and other users to easily find by simply searching on the object name OIJ_NOM_DOCUMENTS_READ or its description.


   
 

OIJ_NOM_DOCUMENTS_READ - Read nomination document data
OIJ_NOM_DEP_UPD - Update dependent nominations
OIJ_NOM_DEFAULTING - TSW Nomination Defaulting
OIJ_NOM_DATA_SET - Sets temp. global nomination data
OIJ_NOM_DATA_MODIFY - Modifies temp. global nomination data
OIJ_NOM_DATA_GET - Gets temp. global nomination data