| Status | |
|---|---|
| Owner | RUIZ SOMOZA-ext, Carolina |
| Stakeholders | |
| Jira Request ID | |
| Jira Development ID |
High- Level Specification
| Implementing System | S/4HANA |
|---|---|
| Invoked by/Invokes | Link to any Integration Process spec which is related to this System Interface, e.g. because it is invoking this interface, or because this interface is sending data to it. |
| Business Process Reference |
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
Describe any assumptions that have been made in the process of completing this design. What functionality is expected of configuration or other developments that pass information to this development and/ or retrieve the information processed by it (performance, triggers, exceptions, etc.)
Dependencies
The table defined in this development should be checked within this development
Security, Integrity and Controls
To detail the security requirements for processing this object, any data integrity issues associated with the object and the teams that will be responsible for processing the object, i.e. authorization/roles required to who can execute the interface, encryption requirement, etc.
Configuration Requirements
Specify the configuration requirements for this object. Like in case of substitution/ routine specify the configuration needed
Special Requirements
Specify any special requirements or considerations that may impact the interface based on specific locations, regulatory compliance or system limitations. Clearly outline requirements e.g. localization rules for countries like China
If the interface interacts with third-party systems such as Icertis, describe any additional integration, security or authentication considerations that must be taken into account.
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
Please describe change tracking requirements, i.e. transferring only delta, or always full load
Interface Alert & Monitoring
Monitoring will be handled by and
Language Requirements
Specify multi language requirements
User Interface Requirements
Capture the requirements for the user interface (UI) associated with the interface. It should provide a clear description of how users will interact with the interface and how information will be presented to ensure usability and accuracy.
Sequencing
Please describe delivery requirements driven by message sequencing, i.e. specific order, impact of disruption of sequence, are duplicates allowed, etc.
Volumetrics
Provide volumetrics details: Initial load volumes, Number of Records, Expected Frequency, Expected Long term Growth)
Performance Consideration
Specify if there are any specific performance factors that need to be taken into consideration during development i.e. interface must be able to handle 100 posting per-hour, etc.
Error Handling
Detail how errors will be handled: Notification, Restart/ Recovery and Re-Processing Procedures
Testing
How to Test
Please provide some guidance and/or test data to help the developer unit test the interface. Please include both positive and negative testing (to validate error situations handling)
The developer will need to test repeatedly, so where appropriate provide instructions to reverse the actions performed so the test may be run again, or explain how to create new input data to the test. In particular, the developer will need logons for test users representing the various roles within the approval process.
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
List any considerations essential for application test planning (e.g., test this before ABC along with DEF separate from GHI). If the development encompasses a user interface, explain how to test it. List any insights as to how this component could be tested the most efficiently.
Other Information
Development Details
Package
| Package Name | Parent Package |
|---|---|
Other Development Objects
| Object Type | Object Name | Purpose/High Level Logic | Design Rationale Reference |
|---|---|---|---|
Appendix
See also
Insert links and references to other documents which are relevant when trying to understand this decision and its implications. Other decisions are often impacted, so it's good to list them here with links. Attachments are also possible but dangerous as they are static documents and not updated by their authors.
