Fonction SAP BAPI_TSW_NOM_GETLIST - TSW Nomination : read Nomination Data for specified selection

Paramètre Reférence Type Long. Valeur par déf. Facultatif Description
CARRIER BAPITSWNOM01-CARRIER C 10 X OIL-TSW: Nomination Carrier
CYCLE_ID BAPITSWNOM01-CYCLE_ID C 10 X OIL-TSW: Pipeline cycle ID
MAXROWS BAPIF4A-MAX_ROWS I 4 200 X Maximum number of lines of hits
SHIPMENTNUMBER BAPITSWNOM01-SHIPMENTNUMBER C 10 X TD shipment number
SHIPMENTTYPE BAPITSWNOM01-SHIPMENTTYPE C 4 X TD shipment type
SHIPPER BAPITSWNOM01-SHIPPER C 10 X OIL-TSW: Nomination Shipper
TRANSPORTSYSTEM BAPITSWNOM01-TRANSPORTSYSTEM C 10 X OIL-TSW: Transport system used in Nomination
VEHICLEID BAPITSWNOM01-VEHICLEID C 10 X TD vehicle number

Paramètre Reférence Long. Facultatif Description
EXTENSIONOUT BAPIPAREX 990 X Ref. structure for BAPI parameters EXTENSIONIN/EXTENSIONOUT
MATERIALBALANCE BAPITSWNOM08 78 X TSW Nomination-materials balance check
NOMINATIONEVENTS BAPITSWNOM07 150 X TSW Nomination Events
NOMINATIONEVENTTEXTS BAPITSWNOM09 171 X TSW Nomination Event Texts
NOMINATIONHEADER BAPITSWNOM02 265 X TSW Nomination Header Data
NOMINATIONITEM BAPITSWNOM03 376 X TSW Nomination Item Data
NOMINATIONITEMCOPYTABLE BAPITSWNOM03_O 360 X TSW Nomination Item Data Copy Table
NOMINATIONNUMBER_EXT BAPITSWNOM05 43 TSW external Nominationnumber Selection Range
NOMINATIONNUMBER_SAP BAPITSWNOM04 43 TSW internal Nomination NumberSelection Range
RETURN BAPIRET2 548 X Return parameter

Description
Carrier

Description
Pipeline Cycle ID

Description
MAXROWS

Description
SHIPMENTNUMBER

Description
SHIPMENTTYPE

Description
SHIPPER

Description
TRANSPORTSYSTEM

Description
VEHICLEID

Value range

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 nameis BAPI_TE_<(><<)> table name>, where the name of the table is the thetable 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
    Nomination Balanve Table.
    Depending on the scheduled TSW Movement Scenario, the Quantities aresumed up for each Scheduled Material when the Scenarion is load ordischarge relevant from the Transportsystems perspective (that means,that e.g. in Tank Tranfers at Location would not impact the Balance

    Fields
    NOMINATIONNUMBER_SAP
    SCHEDULEMATERIAL
    NOMINATIONNUMBER_EXT
    LOADQUANTITY
    DISCHARGEQUANTITY
    QUANTITYUNIT_SAP
    QUANTITYUNIT_ISO

    Description
    TSW Nomination Event Data

    Fields
    NOMINATIONNUMBER_SAP
    ITEMNUMBER
    EVENTNUMBER
    NOMINATIONNUMBER_EXT
    EVENTTYPE
    EVENTDOCTYPE
    EVENTSEQUENCE
    ASSIGNEDDOCUMENT
    SHIPMENTITEM
    EVENTSTATUS
    PLANNEDSTARTFROM
    PLANNEDSTARTTO
    PLANNEDENDFROM
    PLANNEDENDTO
    ACTUALSTARTFROM
    ACTUALSTARTTO
    ACTUALENDFROM
    ACTUALENDTO
    VEHICLENUMBER
    STAGEOFTRANSPORTSEQ

    Fields
    NOMINATIONNUMBER_SAP
    ITEMNUMBER
    EVENTNUMBER
    TEXT_FORM
    TEXT_LINE
    FUNCTION (possible values :

    • 003 Delete: Message contains objects to be deletedains changes

    • 004 Change: Message contains changese: This message replaces previous
    • messages
      • 005 Replace: This message replaces previous messagese for process

      • 009 Original: First message for processst: Data should not be imported

      • 023 Wait/Adjust: Data should not be imported 018 Resend
      • Fields from Nomination Header

        Description

        Nomination Schedule Items

        Description

        Value range

        Description
        The reference data used during replanning activities at a nominationline item when the original plan was already communicated to externalpartners, such as a carrier.

        Fields
        Sign
        Option
        Low
        High

        Fields
        Sign
        Option
        Low
        High

        Default

        Description
        Return parameter
        INCLUDE BAPI_TABLE