| Status | Revision under Review |
|---|---|
| Owner | RUIZ SOMOZA-ext, Carolina |
| Stakeholders | |
| Jira Request ID | ERP-543 - Getting issue details... STATUS |
| Jira Development ID | ERP-977 - Getting issue details... STATUS |
High- Level Specification
| Implementing System | S/4 HANA |
|---|---|
| Invoked by/Invokes | |
| Business Process Reference |
Functional Overview
This Functional Specification describes the outgoing Reservation Interface between SAP S/4HANA and 3PLs (via CPI) using SAP standard OData API_RESERVATION_DOCUMENT.
This interface will send the Reservation document information to the 3PL for their processing.
Scope and Objectives
This interface covers the transmission of Reservation documents created in S/4 HANA to the 3PLs (via CPI).
Process Flow Diagram
Step | Description | Comment |
|---|---|---|
1 | Reservation document is created or updated in S/4 HANA | |
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 | Relevant event is published to SAP Event Mesh | If previous steps are successful |
5 | CPI consumes the event and retrieves full reservation doc information | CPI will also get the 3PL partner from the 3PL assignment table for routing purposes |
6 | S/4 updates Monitoring Table | Using System date and time |
7 | 3PL consumes, post the document and send an Ack back | |
8 | S/4 updates Monitoring Table | with the Ack information received |
Assumptions
Dependencies
Security, Integrity and Controls
Configuration Requirements
Special Requirements
Design Rationale
API Use
APIs to be consumed:
API_RESERVATION_DOCUMENT - (OData service) Retrieve Reservation Document
Retrieve Items with Header using RKPF-RSNUM (Reservation number) and RESB table for items
Example
GET <host>/sap/opu/odata4/sap/api_reservation_document/srvd_a2x/sap/apireservationdocument/0001/ReservationDocument('{{Reservation}}')/_ReservationDocumentItem
Processing Logic
1) Every time a new event is raised from a Reservation document, it should be published for transmission if the following criteria is met:
- Interface is activated: Check 3PL assignment table included in
- If previous check is successful, event should be published for consumption and all information (header and item) should be retrieved and sent to the 3PL from CPI.
- 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=RESERVATION
DOC_ID= RKPF-RSNUM
DATE_SENT = System date
TIME_SENT = System time
Delta or Full Load Requirements
Interface Alert & Monitoring
Monitoring will be handled by
Language Requirements
User Interface Requirements
Sequencing
Volumetrics
Performance Consideration
Error Handling
Error handling should be done at AIF level, if there is an error sending the data to the 3PL, the interface should be retriggered.
Testing
How to Test
Test Conditions and Expected Results
| ID | Condition | Expected Results |
|---|---|---|
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 |
|---|---|---|---|