High- Level Specification

Functional Overview

This Functional Specification describes the Outbound Delivery Interface between SAP S/4HANA and CPI using SAP standard OData API API_OUTBOUND_DELIVERY_SRV_0002. 

Scope and Objectives

The interface covers all outbound deliveries created or updated in S/4HANA that are relevant for transmission to 3PL systems.

Process Flow Diagram

Insert the flowchart and fill in the steps

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

For tracing the transmission in the monitoring table

The table defined in this development should be included in the configuration Dashboard for 3PLs.

3PL assignment and activation table

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_OUTBOUND_DELIVERY_SRV_0002 – Outbound Delivery (OData service)

• API_CUSTOMER_RETURNS_DELIVERY_SRV_0002 - Customer returns Deliveries (OData service)

Outbound 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.

Parameter table structure:

API Use

API_OUTBOUND_DELIVERY_SRV_0002 will be consumed for documents where LIKP- VBTYP = J and 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 Outbound Delivery Including All Outbound Delivery Items 

Retrieve Single Outbound Delivery Header Text

Retrieve Single Outbound Delivery Item Text (for all items in the delivery - LIPS)

Customer returns uses another API (API_CUSTOMER_RETURNS_DELIVERY_SRV_0002) but the document category is the same as Outbound (J), should we have this API determination as well in the configuration dashboard?

Data Structure

The following fields will be used to provide the required data structure of the interface:

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 with ORG_TYPE = VSTEL, ORG_VALUE=LIKP-VSTEL and DOC_TYPE="DELIVERY". If there is an entry, and the field INTERFACE_ACT = X, retrieve the 3PL assigned and continue to next check, otherwise the delivery is Not relevant for transmission.
    • 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.

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

Interface Alert & Monitoring

Monitoring will be handled by

Language Requirements

N/A

User Interface Requirements

DELIVERIES_3PL should be included in the Configuration Dashboard and should be visible by business users. 
 

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

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

Other Development Objects

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.

Change log