| Status | Approved |
|---|---|
| Owner | |
| Stakeholders | |
| Jira Request ID | |
| Jira Development ID |
High- Level Specification
| Implementing System | SAP S/4HANA |
|---|---|
| Invoked by/Invokes | ERP-1138 - Getting issue details... STATUS |
| Business Process Reference | 02.04.02.01. Manage Standard Sales Order |
Functional Overview
EDI customers sends their Sales Order creation message through Elemica to Syensqo. Elemica sends the OrderCreate XML to SAP CPI which then calls a custom API to create the Sales Order in Syensqo's S/4HANA system.
The purpose of this functional specification is to create the custom API for the creation of a sales order in S/4HANA either
- From data directly available in the Elemica XML or
- from data derived from S/4HANA based on data in the Elemica XML.
Scope and Objectives
This System Interface, a custom implementation in SAP S/4HANA,
- consumes the OrderCreate data from SAP CPI
- maps this data into a structure to create a sales order in SAP S/4HANA
- transform some data OrderCreate message from SAP CPI into the Sales Order structure in S/4HANA
- performs lookup of specified data (as applicable) in S/4HANA
- stored certain data from OrderCreate message from SAP CPI into a S/4HANA custom table
The standard SAP Sales Order API is unable to support the above functions, hence the need for a custom API.
Process Flow Diagram
Step | Description | Comment |
|---|---|---|
1 | Based on the purchase order received from Syensqo's EDI customer, Elemica converts this into OrderCreate message and sends to SAP CPI via API Management |
|
2. | SAP CPI receives the OrderCreate XML message from Elemica and maps to SAP Sales Order in S/4HANA. To create the Sales Order, SAP CPI calls the custom API which is the scope of this functional specification | This is covered in Integration Process functional specification ERP-1138 - Getting issue details... STATUS |
3 | Sales Order is created in SAP S/4HANA based on the message received from SAP CPI |
Assumptions
- The custom Sales Order Create API will be called from SAP CPI and be able to lookup data from SAP S/4HANA to feed the target structure to create the sales order
- The source object and S/4HANA System target field mappings, including custom fields, will be updated based on mapping requirements in S/4HANA System.
- The Custom API should be able to map all source and target mappings to successfully create a sales order
Dependencies
- All configurations in S/4HANA from where the custom API should look up values should already be implemented before the interface is deployed.
- Connection between SAP CPI and S/4HANA already set up
- Required master data in S/4HANA already loaded
Security, Integrity and Controls
- Required authorisations to execute the custom API need to be defined.
- Existing secure connectivity for communication between SAP S/4HANA and SAP CPI will be applied.
Configuration Requirements
tbc
Special Requirements
tbc
new custom table to map Header DUNS and Body DUNS
Design Rationale
API Use
Custom API from API_SALES_ORDER_SRV_0001
Data Structure
The following fields will be used to provide the required data structure of the interface:
| Parent | Cardinality | Field | Description | Mandatory (Y/N) | Data Type |
|---|---|---|---|---|---|
| ZDocumentHeader | 1 | DocumentIdentifier | Y | String | |
| 1 | DocumentIdentifierDateTime | Y | DateTime | ||
| 1 | RequestingDocumentIdentifier | N | String | ||
| 1 | RequestingDocumentDateTime | N | DateTime | ||
| 1 | SenderPartnerName | Y | String | ||
| 1 | SenderPartnerRole | Y | String | ||
| 1 | SenderDUNS | Y | String | ||
| 1 | SenderContactName | N | String | ||
| 1 | SenderContactDescription | N | String | ||
| 1 | SenderTelephoneNumberTelecomCountryCode | N | ISO Country ? | ||
| 1 | SenderTelephoneNumberTelecomAreaCode | N | |||
| 1 | SenderTelephoneNumberPhoneNumber | N | |||
| 1 | SenderFaxNumberTelecomCountryCode | N | |||
| 1 | SenderFaxNumberTelecomAreaCode | N | |||
| 1 | SenderFaxNumberPhoneNumber | N | |||
| 1 | SenderEmailAddress | N | |||
| 1 | SenderAlternativeCommunicationMethod | N | |||
| 1 | SenderAddressLine | N | |||
| 1 | SenderCityName | N | |||
| 1 | SenderStateProvince | N | |||
| 1 | SenderPostalCode | N | |||
| 1 | SenderPostalCountry | N | |||
| 1 | SenderLocationCode | N | |||
| 1 | SenderTaxIdentifierNumber | N | |||
| 1 | ReceiverPartnerName | Y | |||
| 1 | ReceiverPartnerRole | Y | |||
| 1 | ReceiverDUNSCode | Y | |||
| 1 | ReceiverContactName | N | |||
| 1 | ReceiverContactDescription | N | |||
| 1 | ReceiverTelephoneNumberTelecomCountryCode | N | |||
| 1 | ReceiverTelephoneNumberTelecomAreaCode | N | |||
| 1 | ReceiverTelephoneNumberPhoneNumber | N | |||
| 1 | ReceiverFaxNumberTelecomCountryCode | N | |||
| 1 | ReceiverFaxNumberTelecomAreaCode | N | |||
| 1 | ReceiverFaxNumberPhoneNumber | N | |||
| 1 | ReceiverEmailAddress | N | |||
| 1 | ReceiverAlternativeCommunicationMethod | N | |||
| 1 | ReceiverAddressLine | N | |||
| 1 | ReceiverCityName | N | |||
| 1 | ReceiverStateProvince | N | |||
| 1 | ReceiverPostalCode | N | |||
| 1 | ReceiverPostalCountry | N | |||
| 1 | ReceiverLocationCode | N | |||
| 1 | ReceiverTaxIdentifierNumber | N | |||
| A_SalesOrder | 1 | DsitributionChannel | Y | ||
| 1 | OrganisationDivision | Y | |||
| 1 | SalesOrderType | Y | |||
| 1 | SalesOrganisation | Y | |||
| 1 | ZUserStatus | Y | |||
| 1 | CustomerPurchaseOrderType | Y | |||
| 1 | PurchaseOrderByCustomer | Customer reference number that the customer uses to uniquely identify a purchasing document (for example, a sales inquiry or a purchase order) | Y | String | |
| 1 | ZContractNumber | Customer reference number that the customer uses to uniquely identify a purchasing document (for example, a sales inquiry or a purchase order) | N | String | |
| 1 | TransactionCurrency | The currency that applies to the sales order | N | ||
| 1 | ZRevisionNumber | N | |||
| 1 | ZReleaseNumber | N | |||
| 1 | IncotermsClassification | Commonly used trading terms that comply with the standards established by the International Chamber of Commerce (ICC) | N | ||
| 1 | IncotermsLocation1 | Provides additional information for the primary Incoterm | N | ||
| 1 | CustomerPaymentTerms | N | |||
| 1 | ZDiscountPercentage | N | |||
| 1 | ZDiscountAmount | N | |||
| 1 | ZDiscountDaysDue | N | |||
| 1 | PurchaseOrderByShipToParty | N | |||
| 1 | ZCountryOfFinalDestination | N | |||
| A_SalesOrderHeaderPartner | 1 | SoldtoParty | The customer who orders the goods or services. The sold-to party is contractually responsible for sales orders. | Y | |
| 1 | ZBuyerContactName | N | String | ||
| 1 | ZBuyerContactDescription | N | String | ||
| 1 | ZSeller | N | String | ||
| 1 | ZSellerContactName | N | String | ||
| ZSellerContactDescription | N | String | |||
| 1 | ZShipto | N | String | ||
| 1 | ZPayer | N | String | ||
| 1 | ZBillto | N | String | ||
| 1 | ZShipper | N | String | ||
| 1 | ZShipFrom | N | String | ||
| 1 | ZCarrier | N | String | ||
| A_SalesOrderPartnerAddress | 1 | BuyerTelephoneNumberTelecomCountryCode | N | ||
| 1 | BuyerTelephoneNumberTelecomAreaCode | N | |||
| 1 | BuyerTelephoneNumberPhoneNumber | N | |||
| 1 | BuyerFaxNumberTelecomCountryCode | N | |||
| 1 | BuyerFaxNumberTelecomAreaCode | N | |||
| 1 | BuyerFaxNumberPhoneNumber | N | |||
| 1 | BuyerEmailAddress | N | String | ||
| 1 | BuyerAlternativeCommunicationMethod | N | String | ||
| 1 | BuyerAddressLine | N | String | ||
| 1 | BuyerCityName | N | String | ||
| 1 | BuyerStateProvince | N | |||
| 1 | BuyerPostalCode | N | |||
| 1 | BuyerPostalCountry | N | |||
| 1 | BuyerLocationCode | N | |||
| 1 | BuyerTaxIdentifierNumber | N | String | ||
| 1 | ShipToTelephoneNumberTelecomCountryCode | N | |||
| 1 | ShipToTelephoneNumberTelecomAreaCode | N | |||
| 1 | ShipToTelephoneNumberPhoneNumber | N | |||
| 1 | ShipToFaxNumberTelecomCountryCode | N | |||
| 1 | ShipToFaxNumberTelecomAreaCode | N | |||
| 1 | ShipToFaxNumberPhoneNumber | N | |||
| 1 | ShipToEmailAddress | N | String | ||
| 1 | ShipToAlternativeCommunicationMethod | N | String | ||
| 1 | ShipToAddressLine | N | String | ||
| 1 | ShipToCityName | N | String | ||
| 1 | ShipToStateProvince | N | |||
| 1 | ShipToPostalCode | N | |||
| 1 | ShipToPostalCountry | N | |||
| 1 | ShipToLocationCode | N | |||
| 1 | ShipToTaxIdentifierNumber | N | String | ||
| 1 | PayerTelephoneNumberTelecomCountryCode | N | |||
| 1 | PayerTelephoneNumberTelecomAreaCode | N | |||
| 1 | PayerTelephoneNumberPhoneNumber | N | |||
| 1 | PayerFaxNumberTelecomCountryCode | N | |||
| 1 | PayerFaxNumberTelecomAreaCode | N | |||
| 1 | PayerFaxNumberPhoneNumber | N | |||
| 1 | PayerEmailAddress | N | String | ||
| 1 | PayerAlternativeCommunicationMethod | N | String | ||
| 1 | PayerAddressLine | N | String | ||
| 1 | PayerCityName | N | |||
| 1 | PayerStateProvince | N | |||
| 1 | PayerPostalCode | N | |||
| 1 | PayerPostalCountry | N | |||
| 1 | PayerLocationCode | N | |||
| 1 | PayerTaxIdentifierNumber | N | String | ||
| 1 | BillToTelephoneNumberTelecomCountryCode | N | |||
| 1 | BillToTelephoneNumberTelecomAreaCode | N | |||
| 1 | BillToTelephoneNumberPhoneNumber | N | |||
| 1 | BillToFaxNumberTelecomCountryCode | N | |||
| 1 | BillToFaxNumberTelecomAreaCode | N | |||
| 1 | BillToFaxNumberPhoneNumber | N | |||
| 1 | BillToEmailAddress | N | String | ||
| 1 | BillToAlternativeCommunicationMethod | N | String | ||
| 1 | BillToAddressLine | N | String | ||
| 1 | BillToCityName | N | String | ||
| 1 | BillToStateProvince | N | |||
| 1 | BillToPostalCode | N | |||
| 1 | BillToPostalCountry | N | |||
| 1 | BillToLocationCode | N | |||
| 1 | BillToTaxIdentifierNumber | N | String | ||
| A_SalesOrderText | 1 to many | Language (key) | The language key indicates the following:
| Y | |
| 1 to many | LongTextID (key) | Y | |||
| 1 to many | LongText | Y | String | ||
| A_SalesOrderItem | 1 to many | UnderlyingPurchaseOrderItem | N | String | |
| 1 to many | SalesOrderItem (key) | N | |||
| 1 to many | MaterialByCustomer | Y | |||
| 1 to many | ZMaterialByCustomerDescription | N | String | ||
| 1 to many | Material | M | |||
| 1 to many | ZMaterialDescription | N | String | ||
| 1 to many | PurchaseOrderByCustomer | N | String | ||
| 1 to many | RequestedQuantity | The number or volume of materials specified for an item | N | ||
| 1 to many | RequestedQuantityISOUnit | N | |||
| 1 to many | IncotermsClassification | N | |||
| 1 to many | IncotermsLocation1 | N | |||
| 1 to many | ZLineItemPurposeCode | N | |||
| 1 to many | ZBalanceItemFlag | N | |||
| A_SalesOrderItemPartner | 1 to many | ZShipto | N | String | |
| 1 to many | ZPayer | N | String | ||
| 1 to many | ZBillto | N | String | ||
| 1 to many | ZShipper | N | String | ||
| 1 to many | ZShipFrom | N | String | ||
| 1 to many | ZCarrier | N | String | ||
1 to many | ZThirdParty | N | String | ||
| A_SalesOrderItemText | 1 to many | Language (key) | N | ||
| 1 to many | LongTextID (key) | N | |||
| 1 to many | LongText | N | String | ||
| A_SalesOrderItemPrElement | 1 to many | ConditionAmount | N | ||
1 to many | ConditionCurrency | N | |||
1 to many | ConditionRateValue | N | |||
1 to many | ConditionQuantityUnit | N | |||
| A_SalesOrderScheduleLine | 1 to many | RequestedDeliveryDate | N |
Calculation and Validation
Not needed as information will be in the processing logic section
| Parent | Field | Rule Type | Rule Instruction |
|---|---|---|---|
Processing Logic
describe the custom table for the header and body DUNS
how the header DUNS is fetched (which field in XML) and where it is stored
EDPAR look ups
Delta or Full Load Requirements
Interface Alert & Monitoring
Language Requirements
User Interface Requirements
Sequencing
Volumetrics
Performance Consideration
Error Handling
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 |
|---|---|---|---|