| Status | Revision under Review |
|---|---|
| Owner | RUIZ SOMOZA-ext, Carolina |
| Stakeholders | |
| Jira Request ID | ERP-545 - Getting issue details... STATUS |
| Jira Development ID | ERP-982 - Getting issue details... STATUS |
High- Level Specification
| Implementing System | S/4HANA |
|---|---|
| Invoked by/Invokes | ERP-983 - Getting issue details... STATUS |
| Business Process Reference | 06.10.01.01. Manage 3PL Warehouse Interfaces |
This Functional Specification describes the Inbound Delivery Interface between SAP S/4HANA and CPI using SAP standard OData API API_INBOUND_DELIVERY_SRV_0002.
Scope and Objectives
The interface covers all Inbound deliveries created or updated in S/4HANA that are relevant for transmission to 3PL systems.
Process Flow Diagram
1 | Delivery created/updated in S/4HANA | |
2 | S/4 raises an internal event. | |
3 | System checks the 3PL assignment table | To determine if the interface is active and retrieve the 3PL assigned |
4 | System checks the DELIVERIES_3PL table | To determine if the delivery type, shipping point and event is relevant for transmission |
5 | Relevant event is published to SAP Event Mesh | If previous steps are successful |
6 | CPI consumes the event and retrieves full delivery using API | CPI will also get the 3PL partner from the 3PL assignment table for routing purposes |
7 | S/4 updates Monitoring Table | Using System date and time |
8 | 3PL consumes and executes warehouse processes. |
Assumptions
Dependencies
ERP-984 - Getting issue details... STATUS The table defined in this development should be checked within this development
Security, Integrity and Controls
Configuration Requirements
N/A
Special Requirements
N/A
Design Rationale
APIs to be consumed:
API_INBOUND_DELIVERY_SRV_0002
Inbound deliveries will be relevant for transmission only for specific shipping points (the ones related to a 3PL), delivery types and at certain event.
This criteria may change between 3PLs so a custom table is needed to save this parameters and should be checked by Event Mesh before publishing the event for consumption. This table (DELIVERIES_3PL) is described in the FS ERP-984 3PL Warehouse Interface - Outbound Delivery Interface to Cloud Integration Suite and will be part of
API Use
API_INBOUND_DELIVERY_SRV_0002 will be consumed if the criteria described in the Processing logic section is met
The following information should be retrieved for the document (LIKP-VBELN) using the following services:
Retrieve Single Inbound Delivery Including All Inbound Delivery Items
Example
GET <host>/sap/opu/odata/sap/API_INBOUND_DELIVERY_SRV;v=2/A_InbDeliveryHeader(DeliveryDocument='180000247')?$expand=to_DeliveryDocumentItem HTTP/1.1Data Structure
The following fields will be used to provide the required data structure of the interface:
| Parent | Field | Description | Mandatory (Y/N) | Data Type |
|---|---|---|---|---|
Processing Logic
1) Every time a new event is raised from a Delivery document, it should be published for transmission if the following criteria is met:
- Interface is activated: Check 3PL assignment table included in
- Check the custom table DELIVERIES_3PL with LIKP-VSTEL, LIKP-LFART and the event raised. If there is an entry the event should be published for consumption and the API detailed in that entry should be used to extract the data.
- Interface is activated: Check 3PL assignment table included in
2) If previous step is successful, an entry should be logged into the monitoring table to trace the correct transmission to the 3PL. This table is detailed in
DOC_TYPE=DELIVERY
DOC_ID= LIKP-VBELN
DATE_SENT = System date
TIME_SENT = System time
If an entry exists for the DOC_TYPE, it should be updated with the current DATE_SENT and TIME_SENT.
Delta or Full Load Requirements
Interface Alert & Monitoring
Monitoring will be handled by ERP-865 - Getting issue details... STATUS and ERP-844 - Getting issue details... STATUS
Language Requirements
Document texts will be in the language of the source document.
User Interface Requirements
Sequencing
Volumetrics
Around 200 docs / DAY
Performance Consideration
Error Handling
Testing
How to Test
Test Conditions and Expected Results
| ID | Condition | Expected Results |
|---|---|---|
| 1 | Inbound delivery creation (relevant Inb del type) | Event is published and consumed according to the custom table entries |
| 2 | Inbound delivery update | Event is published and consumed based on the custom table entries. |
| 3 | Inbound delivery deletion | Event is published and consumed. |
| 4 | Inbound delivery creation/update (not relevant in custom table) | Event is not published |
| 5 | Inbound delivery created for a non relevant shipping point | Event is not published |
Test Considerations/Dependencies
Other Information
Development Details
Package
| Package Name | Parent Package |
|---|---|
Other Development Objects
| Object Type | Object Name | Purpose/High Level Logic | Design Rationale Reference |
|---|---|---|---|