/SAPAPO/OM_PEG_CAT_GET_ORDERS - Uses Pegging Areas, Categories, and Time Intervals to Get Order Data

Vendor Master (General Section)   RFUMSV00 - Advance Return for Tax on Sales/Purchases  
This documentation is copyright by SAP AG.

Functionality

This function module combines most of the functionality contained in modules OM_PEGID_SELECT_ORDERSand OM_ORDER_GET_DATA. That is, it selects I/O nodes in the liveCache according to the criteria specified in the import tables and gets the requested data for your (sub-) orders in the export tables.

Module OM_PEGID_SELECT_ORDERS offers better performance than this module, and should therefore be preferred if:

• you are only interested in the order GUIDs, and

• you can work without the additional selection options in import structure IV_ADDITIONAL_SEL_OPTIONS, many of which are not supported by OM_PEGID_SELECT_ORDERS.

** To ensure that this module provides the same data as the obsolete module OM_PEGID_GET_ORDERS, the flag ADD_TOPORDERS in structure IV_ADDITIONAL_SEL_OPTIONS must be set to gc_om_toporder_complete (= "T"). **

The meaning of the export tables and exclude structure OM_EXCLUDE_EXPORTS is documented in function module OM_ORDER_GET_DATA.

The import tables (selection criteria) are documented in module OM_PEGID_SELECT_ORDERS. The additional selection options that are only available with this module are:

• IV_ADDITIONAL_SEL_OPTIONS:

• SEL_BY_SUBORDER_REQUESTED_TIME:
  If this flag is GC_FALSE, the time interval [IV_START_TIME,IV_END_TIME[ refers to the times of the I/O nodes in the (sub-)orders, that is, all (sub-)orders areselected that have at least one I/O node that belongs to a pegging area from IT_PEGID, have an ATP categoryfrom IT_CATEGORY (if IT_CATEGORY is not empty), are of the type given by IV_IONODE_PEG_SEL and intersect with the time interval [IV_START_TIME, IV_END_TIME[.
  If this flag is GC_TRUE, the time interval [IV_START_TIME, IV_END_TIME[ refers primarily to the requiredtime interval of the (sub-)orders. That is, all (sub-)orders are selected whose required time intervalintersects with the time interval [IV_START_TIME, IV_END_TIME[, provided that they have at least oneI/O node that belongs to a pegging area from IT_PEGID, have an ATP category from IT_CATEGORY (if IT_CATEGORYis not empty), are of the type given by IV_IONODE_PEG_SEL and interest with the time interval [IV_START_TIME minus TOLERANCE_TIME, IV_END_TIME plus TOLERANCE_TIME[.

• TOLERANCE_TIME: This time only has the meaning described above if SEL_BY_SUBORDER_REQUESTED_TIME is set to GC_TRUE.

• ADD_TOPORDERS: If this flag is set to GC_TRUE, and one of the selected orders is not a top order,the system will determine its top order and return it in export table ET_ORDERS. The order key and order map entries will also be returned in the export tables for these orders.
  If this flag is set to gc_om_toporder_complete, the suborders of the I/O nodes will not be determined.Instead, the top orders will determined and returned together with the complete order data (including their suborders).

• ANY_ACT_IN_INTERVAL: If this flag is set to GC_FALSE, all orders are selected that have I/O nodesof type IONODE_PEG_SEL in the specified pegging area and in the required time interval. If this flagis set to GC_TRUE, all orders are first retrieved that have I/O nodes of type IONODE_PEG_SEL in thepegging area and then it is checked whether any activity of an order intersects the specified time interval. This variant is relatively costly in runtime.

• SEND_GUIDS_ONLY: If gc_true, only the order GUIDs are returned, not the complete order data. If gc_om_topguids_only, only the top order GUIDs are returned.

Example

Notes

Error codes to be queried (table ET_RC):

• OM_INALID_PEGAREA: Pegging area GUID not found.

Further information

Parameters

ET_ACTIVITIES
ET_CAP_REQS
ET_CHARACT_REQ_INPNODE
ET_CHARACT_VAL_ACTS
ET_CHARACT_VAL_OUTNODE
ET_EXTERN_CONSTRAINTS
ET_EXT_INPUTS
ET_EXT_OUTPUTS
ET_INPUTS
ET_INTERN_CONSTRAINTS
ET_MODES
ET_ORDERS
ET_ORDKEYS
ET_ORDMAPS
ET_OUTPUTS
ET_PEG_INPNODE
ET_PEG_OUTNODE
ET_POSITIONS
ET_PRODFLOW
ET_RC
IS_EXCLUDE_EXPORTS
IS_EXCLUDE_FIELDS
IS_GEN_PARAMS
IT_CATEGORY
IT_CHARACT_REQ_OUTNODE
IT_CHARACT_VAL_INPNODE
IT_EXT_FIXED
IT_ORDER_REQTIME
IT_ORDER_STATUS
IT_ORDER_TYPES
IT_PEGID
IT_TOPORDER_EXCLUDES
IV_ADDITIONAL_SEL_OPTIONS
IV_END_TIME
IV_GET_FIX_PEG_ONLY
IV_IONODE_PEG_SEL
IV_SIMSESSION
IV_START_TIME

Exceptions

LC_APPL_ERROR
LC_COM_ERROR
LC_CONNECT_FAILED

Function Group

APO/SAPLOM_PLANNING

SUBST_MERGE_LIST - merge external lists to one complete list with #if... logic for R3up   PERFORM Short Reference  
This documentation is copyright by SAP AG.


Length: 5099 Date: 20120525 Time: 045517     triton ( 163 ms )