PROD GLA Integration Guideline - SAP WO5 Import Protocol
Source document: IP016_PROD-GLA-Integration-Guideline.pdf
Version: 1
Effective date: 01-Jan-2022
Contents
- 1 WO5 import protocol
- 2.1 Data to be Transferred to SAP
- 2.2 Return Data from SAP
- 3.1 Error Handling
- 3.2 Error/Success codes with description
- 4.1 Interface Triggering
- 4.2 WSDL File
1 WO5 import protocol
The main purpose of this section is to describe the Production Order data, batch information, download interface specifications.
This interface will replace the existing text file interface for SAP WO data download. The data structure will be similar but also includes more data than the existing interface.
SOAP web service technology will be used for GLA-SAP communication. The SAP system will be the server and GLA will be the client that connects to SAP and transfers the production order data.
2.1 Data to be Transferred to SAP
The following data is transferred to SAP as an input message.
Formatting note: The original PDF table contains merged headers and some OCR-fragmented text. The table below preserves the available extracted information in MDX-safe Markdown.
| Parameter | Name | Mandatory / Optional | Default value | Description |
|---|---|---|---|---|
IV_APPLICATION | Application Name | M | SF system identifier in the format GLA_<Plant ID>. Examples: GLADEP1 for Trier, GLAPLP2 for Poland GLA, MOM_PLP2 for Poland MOM | |
IV_WERKS | Plant ID | M | Factory plant code. Example: TRP1, DEP1, PLP2, etc | |
IV_DATEFROM | From date | O | Today - 1 | Date from and Date to parameters are aimed to specify a time frame for analysis. In case of Production orders, they are used for release date, production start date, or production end date. In case of Purchase orders, they are used for purchase order date or PO delivery date. If the function is called with either IV_DATEFROM or IV_DATETO empty, default values for both IV_DATEFROM, yesterday, and IV_DATETO, today, will be applied |
IV_DATETO | To date | O | Today | End date of the analysis period |
2.2 Return Data from SAP
SAP will return the following data.
The following new table will be created in GLA:
WorkorderBOM: stores material characteristics and their values
Formatting note: The original PDF contains a very large return-data table spanning many pages. Some rows are heavily fragmented by OCR. Rows that could be reliably reconstructed are converted below. Fragmented rows are preserved in notes where needed rather than silently corrected.
Material batch data
| Parameter | SAP / GLA Field | M/O | Description / Translation Rules | Data Type | Sample Value |
|---|---|---|---|---|---|
ET_MAT_BATCH | CHARG / Workorder.SAP_BatchNumber | M | Batch number, including leading zeros | CHAR(10) | 0009217614 |
Production order data
| Parameter | SAP / GLA Field | M/O | Description / Translation Rules | Data Type | Sample Value |
|---|---|---|---|---|---|
ET_PP_ORDER | IGMNG / WorkorderBOM | Total confirmed quantity in GLA | Decimal | 150.00 | |
ET_PP_ORDER | GWEMG / Workorder.BatchDeliveryQuantity | O | Delivery quantity | 0 | |
ET_PP_ORDER | FTRMI / Workorder.BatchActualReleaseDate | M | Actual release date | DATE(10) | 42396 |
ET_PP_ORDER | GSTRP / Workorder.SAP_Production_StartDate; set SAP_Production_StartTimeZone to +00:00; set SAP_Production_Start_Time to 00:00:00 | M | Basic start date, AFKO-GSTRP, planned PO start date | DATE(10) | 42396 |
ET_PP_ORDER | GLTRP / Workorder.BatchBasicFinishDate | M | Basic finish date, AFKO-GLTRP, planned PO end date | DATE(10) | 42396 |
ET_PP_ORDER | GSTRI / Workorder.BatchActualStartDate | O | Actual start date. This value should be understood as actual PO start date, when first confirmation was posted | DATE(10) | Empty |
ET_PP_ORDER | GLTRI / Workorder.BatchActualFinishDate | O | Actual finish date. This value should be understood as actual PO end date, when last confirmation was posted, or today if production is ongoing | DATE(10) | Empty |
ET_PP_ORDER | KDAUF / Workorder.SAP_SalesOrder | O | Referenced Sales Order number, Make-to-Order production | CHAR(10) | 1010609195 |
ET_PP_ORDER | KDPOS / Workorder.SAP_SalesOrderItem | O | Sales order item | NUMERIC(6) | 10 |
Production order BOM data
| Parameter | SAP / GLA Field | M/O | Description / Translation Rules | Data Type | Sample Value |
|---|---|---|---|---|---|
ET_PP_BOM | UNIT_TO_ISO / WorkorderBOM.BaseUOM_To_ISOCode | Base unit of measure in ISO code | CHAR(3) | ||
ET_PP_BOM | VALUE_CHAR_LONG / WorkorderBOM.ValueCharLong | Character field, length 70 | CHAR(70) | ||
ET_PP_BOM | VALUE_NEUTRAL_LONG / WorkorderBOM.ValueNeutralLong | Character field, length 70 | CHAR(70) |
Purchase order data
| Parameter | SAP / GLA Field | M/O | Description / Translation Rules | Data Type | Sample Value |
|---|---|---|---|---|---|
ET_PO_ORDER | MATNR / Workorder.SAP_SKUNumber | M | Material | CHAR(18) | |
ET_PO_ORDER | CHARG / Workorder.WorkorderID; SAP_BatchNumber | M | Batch | CHAR(10) | |
ET_PO_ORDER | EBELN / Workorder.SAPPOrder; Workorder.SAPPONumber; Workorder.SAP_PO; Workorder.WorkorderID | M | PO order | CHAR(10) | |
ET_PO_ORDER | EBELP / Workorder.PurchaseOrderItemNumber | M | PO item | NUMERIC(5) | |
ET_PO_ORDER | PSTYP / Workorder.PurchaseOrderItemCategory | M | PO item category, subcontract 3 | CHAR(1) | |
ET_PO_ORDER | LOEKZ / Workorder.PurchaseOrderItemDeleted | O | Item deletion indicator | CHAR(1) | |
ET_PO_ORDER | WERKS / Workorder.SAP_PlantCode | M | Receiving plant | CHAR(4) | |
ET_PO_ORDER | MENGE / Workorder.SAP_PO_Quantity | M | Quantity | DECIMAL(13,3) | |
ET_PO_ORDER | MEINS / Workorder.SAP_POQuantityUOM | M | Unit of measure | CHAR(3) | |
ET_PO_ORDER | EINDT / Workorder.PurchaseOrderPlannedDeliveryDate | M | Date of planned delivery. This value should be understood as planned delivery date for co-packing Purchase Order | DATE(10) | |
ET_PO_ORDER | LIFNR / Workorder.SAP_VendorID | M | Vendor | CHAR(10) | |
ET_PO_ORDER | NAME / Workorder.SAP_VendorName | M | Name | CHAR(35) | |
ET_PO_ORDER | LAND1 / Workorder.SAP_VendorCountryCode | M | Country key | CHAR(3) | |
ET_PO_ORDER | VAT / Workorder.SAP_VendorVAT | O | VAT Registration Number | CHAR(255) | |
ET_PO_ORDER | EOID / Workorder.SAP_VendorEOID | O | Economic Operator ID code | CHAR(255) | |
ET_PO_ORDER | CITY / Workorder.SAP_VendorCity | O | City | CHAR(25) | |
ET_PO_ORDER | STRAS / Workorder.SAP_VendorAddress | O | House name and street | CHAR(30) |
Purchase order BOM data
| Parameter | SAP / GLA Field | M/O | Description / Translation Rules | Data Type | Sample Value |
|---|---|---|---|---|---|
ET_PO_BOM | EBELN / WorkorderBOM.WorkorderID | M | PO order | CHAR(10) | |
ET_PO_BOM | EBELP / WorkorderBOM.PurchaseOrderItemNumber | M | PO item | NUMERIC(5) | |
ET_PO_BOM | MATNR / WorkorderBOM.SAP_SKUNumber | M | Component material | CHAR(18) | |
ET_PO_BOM | MATKL / WorkorderBOM.SAP_MatGroup | M | Material Group of Components | CHAR(9) | |
ET_PO_BOM | CHARACT / WorkorderBOM.MaterialCharacteristicID; MaterialCharacteristic.MaterialCharacteristicID | Characteristic name. Multiple values are possible. Insert new characteristic if it does not exist in GLA | CHAR(30) | ||
ET_PO_BOM | VALUE_CHAR / WorkorderBOM.CharacteristicValue | Characteristic value | CHAR(30) |
Return message data
| Parameter | SAP / GLA Field | M/O | Description / Translation Rules | Data Type | Sample Value |
|---|---|---|---|---|---|
ET_RETURN | M | Program return message structure with different message type. The table will be used to return success or failure feedback to GLA |
Workorder calculation fields
Some of the Workorder calculation fields are listed below.
| Field | Rule / Comment |
|---|---|
SAP_Description50 | Same as SAP_Prod_Description |
SAP_IsCartonTrackingRequired | If SAP_TTProdIdent is 4, 5, 6, or 7, then IsCartonTrackingRequired is 1 |
SAP_IsPackTrackingRequired | If T&T ID is 6 or 7, then IsPackTrackingRequired is 1 |
SAP_IsTrackingRelevant | If T&T ID is 2 or 3, then SAP_IsTrackingRelevant is 1, master case tracking |
SAP_LineDescription | The PDF asks whether a field should be added into the Workcenter table |
SAP_MRP | Not used, not required |
SAP_OuterImageLeft | Characteristic |
SAP_OuterPriceImprint | Characteristic |
SAP_PrackPriceImprint | Characteristic |
SAP_PurchaseOrder_1 | Same as SAP_PO |
SAP_ShelfLifeDuration | Use default value 365 |
SAP_SubMarket_Description | Market type characteristic's value |
SAP_SubMarketCode | Market type characteristic's value |
ShelfLifeDurationUOM | Use default value D |
3.1 Error Handling
A new field SAPReturnData shall be included in the Workorder table to store the success or failure SAP return data in concatenation format.
SAP return message will also include the following success or failure status data.
| Parameter | Name | Mandatory / Optional | Description |
|---|---|---|---|
TYPE | Return Success or Error | M | If confirmation is successful, it will return S. If there is an error, it will return E |
ID | Extracted without full description | ||
NUMBER | Error code | Error code | |
MESSAGE | Error or warning message text | Error or warning message text | |
LOG_NO | Extracted without full description |
3.2 Error/Success codes with description
Formatting note: The original PDF table was fragmented across pages. The following entries preserve the extracted error and warning information available from the document.
Error descriptions
| # | Description | Error number and message |
|---|---|---|
| 2 | If user does not have authorization for object C_AFKO_AWK, company code. Review user's authorizations | 534 - No authorization for plant, Order type. Auth.Obj: C_AFKO_AWK |
| 3 | If user does not have authorization for object M_BEST_WRK, company code. Review user's authorizations | 535 - No authorization for plant. Auth.Obj: M_BEST_WRK |
| 4 | If application parameter is not filled. Fill that parameter | 501 - IV_APPLICATION parameter is empty |
| 5 | If value of IV_PLANT parameter is not a Plant code in SAP | 502 - IV_PLANT parameter does not exist or incorrect |
| 6 | If value of IV_MATNR parameter is not a material code in SAP | 511 - IV_MATNR parameter is incorrect |
| 7 | If any value of IT_MATKL table parameter is not a material group code in SAP | 527 - Material group incorrect IT_MATKL |
| 8 | If date from is bigger than date to. Modify input date parameters | 532 - Invalid date interval. DATE FROM higher than DATE TO |
| 9 | If date to is filled and date from is empty. Modify date from or date to input parameters | 533 - Only DATE TO is filled. Please, fill in DATE FROM parameter |
| 10 | If no production order and no purchase order are selected | 508 - No data selected |
| 19 | If any conversion error is generated when creating unified characteristic table in method set_charact_output | 553 - Not all fields for Material & and Characteristic & are correctly shown |
Warning descriptions
| # | Description | Error number and message |
|---|---|---|
| 01 | If any problem arises in email sending process | 558 - Problem sending email. Exception &. |
| 02 | If no data is found for values Model, Serial, OEM, equipment and work center | 525 - No Model, Serial, OEM, equipment and arbpl have been selected |
If the interface returns an error code, then log this error into the ErrorLog table and send an email notification message to ErrorReportingUser defined in the SetupParameter.
4.1 Interface Triggering
The new work order web service interface will be run by GLA periodically.
At the beginning, by default, the GLA interface scheduler will be configured to run every minute.
The default values of web service input parameters shall be configured or updated by the GLA admin.
The interface can be run manually at any time with given input parameters. These given input parameters will not overwrite existing interface scheduler input parameters.
4.2 WSDL File
The WSDL file is published in the source document, but the extracted content available here did not provide a usable WSDL URL.