SAP Function OIJ_IF_NOM_MAINTAIN - TSW Nomination : Change TSW Nomination

Parameter Reference Type Length Default Optional Text
CALL_FROM_BAPI BAPIFLAG-BAPIFLAG C 1 SPACE X Call from a BAPI FunctioCounter when adjustings the Nomination items Actual Qun
CHANGE_WITH_CONFIRM BAPITSWNOM06-AUTOCONFIRM C 1 X OIL-TSW: Change item indicator
GEN_BPD CHAR1 C 1 SPACE X Generate BPD Process through RFC
HEADERDATA_IN BAPITSWNOM02 u 265 TSW Nomination Header Data
HEADERDATA_INT_X OIJ_IF_NOMH_INT_X u 25 X Internal Checkbox List for maintaining TSW Nomination Header Data
HEADERDATA_INX BAPITSWNOM02X u 32 Checkbox List for maintaining TSW Nomination Header Data
INT_NUMBER_ASSIGNMENT BAPIFLAG-BAPIFLAG C 1 SPACE X internal positionnumbering
TESTRUN BAPITSWTESTRUN u 1 SPACE X Switch to Simulation Session for Write BAPIs
UPDATE_WORKLIST BAPITSWNOM06-WORKLISTUPDATE C 1 X OIL-TSW: Worklist entry indicator

Parameter Reference Type Length Text
HEADERDATA_OUT BAPITSWNOM02_O u 265 TSW Nomination Header Data

Parameter Reference Length Optional Text
EXTENSIONIN BAPIPAREX 990 X Ref. structure for BAPI parameters EXTENSIONIN/EXTENSIONOUT
EXTENSIONOUT BAPIPAREX 990 X Ref. structure for BAPI parameters EXTENSIONIN/EXTENSIONOUT
MATERIALBALANCE_OUT BAPITSWNOM08 78 X TSW Nomination-materials balance check
NOMINATIONEVENTS BAPITSWNOM07 150 X TSW Nomination Event Data
NOMINATIONEVENTSX BAPITSWNOM07X 53 X Checkbox List: TSW Nomination Event Data
NOMINATIONEVENTTEXTS BAPITSWNOM09 171 X TSW Nomination Event Texts
NOMINATIONHEADER_TEXT BAPITSWHEADERTEXT 158 X TSW Header Text Information
NOMINATIONITEMCOPY_OUT BAPITSWNOM03_O 360 X TSW Nomination Item Data out
NOMINATIONITEM_IN BAPITSWNOM03 376 X TSW Nomination Item Data
NOMINATIONITEM_INT_X OIJ_IF_NOMI_INT_X 42 X Internal Checkbox List for Maintaining a TSW Nomination Item
NOMINATIONITEM_INX BAPITSWNOM03X 67 X Checkbox List for Maintaining a TSW Nomination Item
NOMINATIONITEM_OUT BAPITSWNOM03_O 360 X TSW Nomination Item Data
NOMINATIONITEM_TEXT BAPITSWITEMTEXT 168 X TSW Partner Communication Text Information
NOMINATIONSTATUS_IN BAPITSWNOMST 35 X TSW Nomination status update
RETURN BAPIRET2 548 Return parameter

Functionality
TSW Nominations: Maintain Nominations
Note the following.

  • Specify only those fields that should be changed

  • Select these fields by entering an X in the checkboxes

  • Enter a U in the UPDATEFLAG field for modification

  • Always specify key fields when changing the data, including in the
  • checkboxes
    The possible UPDATEFLAGS follow.
    U = change
    D = delete
    I = add

    Examples
    Change nomination header
    Change nomination items data (for example, scheduled quantity or date)
    Update nomination events

    Note

    Minimum entry
    You must enter at least the nomination number (fieldNOMINATIONNUMBER_SAP) in the structure HEADERDATA_IN for ChangeNomination.
    You must always enter key fields for changes.
    You must always specify the update indicator in the HEADERDATA_INX
    For Create Nomination, if available, the required fields are like thosedescribed in RFC_TSW_
    NOM_CREATEFROMDATA

    Commit control
    The function does not run a database commit, which means that theapplication must trigger the commit so that the changes are read to thedatabase. To do this, use for example the functionBAPI_TRANSACTION_COMMIT.

    Notes

    Description
    Nomination Header Data
    When, for example, only the internal nomination number is given in theheader data import parameter, then the other fields are populatedinternally by the supply chain data and by data from the scheduled lineitems.

    Description
    Indicators used if the function module was called from a BAPI (forexample, method "Create", "Change", or "DELETE".)

    Description
    If this parameter is checked, the nomination line items are set tostatus Confirmed without sending the nomination to the involvedcarrier.

    Note
    Carrier tickets that actualize the scheduled items of a nominationrequire a confirmed schedule.

    Nomination Header Fields

    Description

    Required_entries for modifications of existing nominations
    NOMINATIONNUMBER_SAP

    Note
    Changeable fields at the header level are :
    NOMINATIONNUMBER_EXT, as long as no ticket has beenposted against the nomination
    QUANTITYUNIT_SAP
    QUANTITYUNIT_ISO
    SHIPMENTTYPE, as long as no ticket has been postedagainst the nomination
    TRANSPORTATIONPLANNINGPOINT, as long as no ticket hasbeen posted against the nomination
    VEHICLEID, as long as no ticket has been postedagainst the nomination
    VEHICLEREFERENCEID for marine nominations, as longas no ticket has been posted against the nomination
    INTRANSITSTORAGELOCATION, as long as no ticket hasbeen posted against the nomination
    BALANCECHECKINDICATOR

    Description
    Internal Nomination Header Check List

    • Controls processing functions with the value in the UPDATEFLAG field
    • (change indicator).
      The following entries are available:
      I: Insert values in an existing Nomination Header
      U: Change values in an existing Nomination
      D: Delete values in an existing Nomination
      • Controls the field entry with checkboxes If the UPDATEFLAG field has
      • been activated, the system only copies thosefields from theHEADERDATA_IN parameter that have been activated with 'X'

        Fields

        • NOMINATIONSTATUS

        • CONFIRMEDITEMS

        • PARTIALLYCOMPLETEDITEMS

        • COMPLETEDITEMS
        • Caution

          This Chekboxlist is for internal use only (e.g. TSW Ticketing sets the

          Counters when adjustings the Nomination items Actual Quantities)

          Never use in open interfaces like BAPI

          Description
          Nomination Header Check List controls processing functions according tothe value in the UPDATEFLAG field which is a change indicator.
          The following entries are available:

          • I - Create an existing nomination

          • U - Change an existing nomination

          • D - Delete an existing nomination

          • If the UPDATEFLAG field has been activated, the system copies onlythose fields from the HEADERDATA_IN parameter that have been activatedwith X. (Possible modifiable header fields are described in theappropriateImportparameter.)

            Note:
            Deletion is possible only if no open tickets exist and all pendingdocuments (a shipment, for example) are completed.

            Description
            If set, the nomination item numbers are set internally during the createactivity.

            Description
            Describes the test run.

            Description
            If this parameter is set, the worklist is refreshed when the nominationis saved.

            Description
            Inbound Extension Parameter for Nominations

            Extension structures Defined for Nomination relevant Tables :

            • BAPI_TE_OIJNOMH

            • BAPI_TE_OIJNOMI

            • BAPI_TE_OIJNOMC

            • BAPI_TE_OIJNOMM

            • see also detail information for ExtnesionOut Parameter

              Description
              Extension Parameter for Nominations

              Extension structures Defined for Nomination relevant Tables :

              • BAPI_TE_OIJNOMH

              • BAPI_TE_OIJNOMI.

              • BAPI_TE_OIJNOMC

              • BAPI_TE_OIJNOMM

              • BAPI_TE_OIJNE
              • Use
                This structure is used in the BAPI parameter extension concept forcustomers.
                Using append or include techniques customer-defined table extensionscan be used automatically in the interface and in the BAPI program.
                Customers can freely use these predefined extension parameters toenhance the interface without causing incompatabilities in theinterface communication.

                BAPI Table Extensions
                The structures of BAPI table extensions consist of a key part(identifier), defined by SAP and a data part defined by the customerusing an append technique. The naming convention for the structure namis BAPI_TE_<(><<)> table name>, where the name of the table is the thtable extended by the customer.
                Consider, for example the BAPI table extension "BAPI_TE_OIJNOMH",field"NOMTK", the customer can add extended Nomination Data to thestructure using appends.
                The name of the BAPI table extension is inserted into the "structure""field of the extension parameter. The identifier, like e.g.BAPI_TE_OIJNOMH and the data part specified by the customer using anappend technique are inserted into the data fields "ValuePart1" to"ValuePart4" in the extension parameter.
                If the fields added by the customer using an append technique to BAPItable extensions are the same as the fields of the table extended bythe customer, the data can be automatically read or written by theBAPI.
                Example: The BAPI table extension "BAPI_TE_OIJNOMH" can be used in theBAPI parameter "Extensionout".
                Using an append, the customer has extended the structure"BAPI_TE_OIJNOMH" by the customer-defined fields from the Nominationheader table OIJNOMH.
                When a Nomination is read with a Parameter "NOMINATIONNUMBER_SAP =1234" (representing the field OIJNOMH-NOMTK) the Extionsionout isfilled with
                Extensionout:
                Structure ValuePart1 ValuePart2 ...
                ---------------------------------------------------------------------
                Data:
                BAPI_TE_OIJNOMH 1234 <(><<)>customer-defined data>

                Description
                Contains the material balance values (meaning the quantities relevantfor load and discharge) for each material used within a nomination inthe nomination header unit

                Description
                During scheduling, you can use events handling to maintain informationon a wide range of transport-related services such as scheduling aninsspection at loading, or scheduling cleaning services for a ship.
                You can set up event default groups in Customizing for the Nomination.Event default groups automatically enter an event type and event typetext as defined for Nomination.
                This feature could be used to ensure, for example, that compartmentcleaning is always proposed for a marine shipment.

                Description
                Nomination Item Event Check Table
                This parameter completes the following tasks:

                • Controls processing functions with the value in the UPDATEFLAG field
                • (change indicator)
                  The following entries are available:
                  • I - Create a new Nomination item Event

                  • U - Change an existing Nomination item Event

                  • D - Delete an existing Nomination item Event

                  • Controls the field entry with checkboxes

                  • If the UPDATEFLAG field has been activated, the system copies only thefields from the data parameter that have been activated with X.

                    Description
                    You can enter text for each event assigned to a nomination line item.

                    Fields

                    • NOMINATIONNUMBER_SAP

                    • This is set internally during the nomination dreate step. For text tobe changed, it must be filled correctly
                      • ITEMNUMBER

                      • This number uniquely specifies a nomination item within a givennomination. The number is generated internally, and is subsequent, forexample, 10, 20, 30, and so on.
                        For Eventtexts to be updated, it must be filled correctly
                        • EVENTNUMBER

                        • Event Number. Numeric value.
                          • TEXT_FORM

                          • INCLUDE STXD_DE_TDFORMAT OBJECT DOKU ID TX
                            • TEXT_LINE

                            • INCLUDE STXD_DE_TDLINE OBJECT DOKU ID TX
                              • FUNCTION

                              • Internally used

                                Description
                                Table holding the schedule lines of a Nomination

                                Required_entries
                                Itemtype
                                Scheduleddate
                                ( &NOTE& : If Scheduleddate is in the past, you will get a warningmessage in the Return table. )
                                LOCATIONID
                                SCHEDULEMATERIAL
                                NOMINATEDQUANTITY
                                DOCUMENTINDICATOR

                                Description
                                Nomination Item Check Table for internal use
                                This parameter completes the following tasks:
                                Controls processing functions with the value in the UPDATEFLAG field(change indicator) The following entries are available:

                                • I - Create a new nomination item

                                • U - Change an existing nomination item

                                • D - Delete an existing nomination item

                                • Controls the field entry with checkboxes. If the UPDATEFLAG field hasbeen activated, the system copies only the fields from the dataparameter that have been activated with X.

                                  Fields
                                  ITEMSTATUS
                                  ITEMSUBSTATUS
                                  LOCATIONPLANT
                                  LOCATIONSTORAGELOCATION
                                  SHIPMENTNUMBER
                                  SHIPMENTITEM
                                  ITEMPARTCOMPLETEFLAG
                                  ACTUALQUANTITY
                                  ACTUALQUANTITYUNIT_SAP
                                  ACTUALQUANTITYUNIT_ISO
                                  LASTITEMACTION

                                  Note
                                  Inserting additional item data requires "standard" item data to befilled in the Insert-Item Case.
                                  Updating internal additional data is required for example for TSWticketing data source (table parameter NOMINATIONITEM_IN).

                                  Description
                                  Nomination Item Check Table
                                  This parameter completes the following tasks:

                                  • Controls processing functions with the value in the UPDATEFLAG field
                                  • (change indicator)
                                    The following entries are available:
                                    I - Create a new nomination item
                                    U - Change an existing nomination item
                                    D - Delete an existing nomination item
                                    • Controls the field entry with checkboxes

                                    • If the UPDATEFLAG field has been activated, the system copies only thefields from the data parameter that have been activated with X.

                                      Description
                                      Shows the nomination item fields that are populated during the creationand validation of a nomination.

                                      Fields
                                      NOMINATIONNUMBER_SAP
                                      ITEMNUMBER
                                      ITEMTYPE
                                      ITEMSTATUS
                                      ITEMSUBSTATUS
                                      SCHEDULEDDATE
                                      LOCATIONID
                                      PLANNINGLOCATIONINDICATOR
                                      LOCATIONPLANT
                                      LOCATIONSTORAGELOCATION
                                      DEMANDMATERIAL
                                      SCHEDULEMATERIAL
                                      NOMINATEDQUANTITY
                                      QUANTITYUNIT_SAP
                                      QUANTITYUNIT_ISO
                                      DOCUMENTINDICATOR
                                      DOCUMENTNUMBER
                                      DOCUMENTTYPE
                                      DOCUMENTITEM
                                      WORKLISTINDICATOR
                                      TANKAGE
                                      CONSIGNEE
                                      LOCATIONPARTNER
                                      CONTRACTPARTNER
                                      INSPECTOR
                                      IMPORTEREXPORTER
                                      IMPORTEREXPORTERFLAG
                                      BATCHORIGIN
                                      VALUATIONTYPEORIGIN
                                      BATCHDESTINATION
                                      VALUATIONTYPEDESTINATION
                                      REEDVAPOURPRESSURE
                                      SHIPMENTNUMBER
                                      SHIPMENTITEM
                                      ITEMPARTCOMPLETEFLAG
                                      ITEMCOMPLETEFLAG
                                      ACTUALQUANTITY
                                      ACTUALQUANTITYUNIT_SAP
                                      ACTUALQUANTITYUNIT_ISO
                                      LASTITEMACTION
                                      OVERTOLERANCEPERCT
                                      UNDERTOLERANCEPERCT
                                      OVERTOLERANCEABSOLUTE
                                      UNDERTOLERANCEABSOLUTE
                                      TOLERANCEUNIT_SAP
                                      TOLERANCEUNIT_ISO
                                      UNLIMITEDTOLERANCE
                                      CREATION
                                      CREATEDBY
                                      MODIFICATION
                                      AUTOCONFIRM
                                      BLOCKINGINDICATOR
                                      DELTIONINDICATOR

                                      Description
                                      INCLUDE SD_BAPI_RETURN OBJECT DOKU ID TX