Status

OwnerThe person responsible for driving this decision and documenting it. Type @ to mention people by name
StakeholdersThe business stakeholders involved in making, reviewing, and endorsing this decision. Type @ to mention people by name
Jira Request IDEnter the Jira request card URL here (Use the Jira macro to search and add)
Jira Development IDEnter the Jira development card URL here (Use the Jira macro to search and add)

High- Level Specification

Implementing SystemSAP S/4HANA 
Invoked by/Invokes

Business Process Reference02.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

  1. From data directly available in the Elemica XML or
  2. 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

Insert the flowchart and fill in the steps

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

  1. No system interface functional specification is required for Elemica as the approach is to keep as-is the process on the Elemica side for the SyWay project. 
  2. API Management is for security/routing and do not change the message structure or format

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 

3

Sales Order is created in SAP S/4HANA based on the message received from SAP CPI


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

  1. 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
  2. The source object and S/4HANA System target field mappings, including custom fields, will be updated based on mapping requirements in S/4HANA System.
  3. The Custom API should be able to map all source and target mappings to successfully create a sales order

Dependencies

Indicate any dependencies or constraints that may impact development, in terms of requirements from internal or external applications or teams, limited access to legacy systems, time constraints or data restrictions. Also, please specify schedule dependencies e.g. interface or batch jobs that must run prior to execution.

  1. All configurations in S/4HANA from where the custom API should look up values should already be implemented before the interface is deployed.
  2. Connection between SAP CPI and S/4HANA already set up
  3. Required master data in S/4HANA already loaded

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.

  • 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

Specify the configuration requirements for this object. Like in case of substitution/ routine specify the configuration needed

tbc

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.

tbc

new custom table to map Header DUNS and Body DUNS

Design Rationale

This template section may be used to specify the custom API design. The requirement can be for an API provider which means the API will be designed in the system or can be for an API consumer which means that an API will be consumed in the system.

API Use

Populate the type of the API use  in this section. Will the API be Consumed or Provided. 

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:

ParentFieldDescriptionMandatory (Y/N)Data Type
ZDocumentHeaderDocumentIdentifier
Y

DocumentIdentifierDateTime
Y

RequestingDocumentIdentifier
N

RequestingDocumentDateTime
N

SenderPartnerName
Y

SenderPartnerRole
Y

SenderDUNS
Y

SenderContactName
N

SenderContactDescription
N

SenderTelephoneNumberTelecomCountryCode
N

SenderTelephoneNumberTelecomAreaCode
N

SenderTelephoneNumberPhoneNumber
N

SenderFaxNumberTelecomCountryCode
N

SenderFaxNumberTelecomAreaCode
N

SenderFaxNumberPhoneNumber
N

SenderEmailAddress
N

SenderAlternativeCommunicationMethod
N

SenderAddressLine
N

SenderCityName
N

SenderStateProvince
N

SenderPostalCode
N

SenderPostalCountry
N

SenderLocationCode
N

SenderTaxIdentifierNumber
N

ReceiverPartnerName
Y

ReceiverPartnerRole
Y

ReceiverDUNSCode
Y

ReceiverContactName
N

ReceiverContactDescription
N

ReceiverTelephoneNumberTelecomCountryCode
N

ReceiverTelephoneNumberTelecomAreaCode
N

ReceiverTelephoneNumberPhoneNumber
N

ReceiverFaxNumberTelecomCountryCode
N

ReceiverFaxNumberTelecomAreaCode
N

ReceiverFaxNumberPhoneNumber
N

ReceiverEmailAddress
N

ReceiverAlternativeCommunicationMethod
N

ReceiverAddressLine
N

ReceiverCityName
N

ReceiverStateProvince
N

ReceiverPostalCode
N

ReceiverPostalCountry
N

ReceiverLocationCode
N

ReceiverTaxIdentifierNumber
N
A_SaleOrderDsitributionChannel
Y

OrganisationDivision
Y

SalesOrderType
Y

SalesOrgansation
Y

PurchaseOrderByCustomerCustomer reference number that the customer uses to uniquely
identify a purchasing document (for example, a sales inquiry or
a purchase order)		Y

ZContractNumberCustomer reference number that the customer uses to uniquely
identify a purchasing document (for example, a sales inquiry or
a purchase order)		N

TransactionCurrencyThe currency that applies to the sales order

N



ZRevisionNumber

N



ZReleaseNumber

N



IncotermsClassificationCommonly used trading terms that comply with the standards
established by the International Chamber of Commerce (ICC)

N



IncotermsLocation1Provides additional information for the primary Incoterm

N



CustomerPaymentTerms

N



ZDiscountPercentage

N



ZDiscountAmount

N



ZDiscountDaysDue

N



ZShipWithPurchaseOrder

N



ZCountryOfFinalDestination

N


A_SalesOrderHeaderPartnerSoldtoPartyThe customer who orders the goods or services. The sold-to party
is contractually responsible for sales orders.

Y



ZBuyerContactName
N

ZBuyerContactDescription

N



ZSeller
N

ZSellerContactName
N

ZSellerContactDescription
N

ZShipto
N

ZPayer
N

ZBillto
N

ZShipper
N

ZShipFrom
N

ZCarrier
N
A_SalesOrderPartnerAddressBuyerTelephoneNumberTelecomCountryCode
N

BuyerTelephoneNumberTelecomAreaCode
N

BuyerTelephoneNumberPhoneNumber
N

BuyerFaxNumberTelecomCountryCode
N

BuyerFaxNumberTelecomAreaCode
N

BuyerFaxNumberPhoneNumber
N

BuyerEmailAddress
N

BuyerAlternativeCommunicationMethod
N

BuyerAddressLine
N

BuyerCityName
N

BuyerStateProvince
N

BuyerPostalCode
N

BuyerPostalCountry
N

BuyerLocationCode
N

BuyerTaxIdentifierNumber
N

ShipToTelephoneNumberTelecomCountryCode
N

ShipToTelephoneNumberTelecomAreaCode
N

ShipToTelephoneNumberPhoneNumber
N

ShipToFaxNumberTelecomCountryCode
N

ShipToFaxNumberTelecomAreaCode
N

ShipToFaxNumberPhoneNumber
N

ShipToEmailAddress
N

ShipToAlternativeCommunicationMethod
N

ShipToAddressLine
N

ShipToCityName
N

ShipToStateProvince
N

ShipToPostalCode
N

ShipToPostalCountry
N

ShipToLocationCode
N
 ShipToTaxIdentifierNumber
N

PayerTelephoneNumberTelecomCountryCode
N

PayerTelephoneNumberTelecomAreaCode
N

PayerTelephoneNumberPhoneNumber
N

PayerFaxNumberTelecomCountryCode
N

PayerFaxNumberTelecomAreaCode
N

PayerFaxNumberPhoneNumber
N

PayerEmailAddress
N

PayerAlternativeCommunicationMethod
N

PayerAddressLine
N

PayerCityName
N

PayerStateProvince
N

PayerPostalCode
N

PayerPostalCountry
N

PayerLocationCode
N

PayerTaxIdentifierNumber
N

BillToTelephoneNumberTelecomCountryCode
N

BillToTelephoneNumberTelecomAreaCode
N

BillToTelephoneNumberPhoneNumber
N

BillToFaxNumberTelecomCountryCode
N

BillToFaxNumberTelecomAreaCode
N
 BillToFaxNumberPhoneNumber
N

BillToEmailAddress
N

BillToAlternativeCommunicationMethod
N

BillToAddressLine
N

BillToCityName
N

BillToStateProvince
N

BillToPostalCode
N

BillToPostalCountry
N

BillToLocationCode
N

BillToTaxIdentifierNumber
N
A_SalesOrderTextLanguage
(key)		The language key indicates the following:

  • The language in which texts are displayed

  • The language in which you enter texts

  • The language in which the system prints texts

Y

LongTextID
(key)
Y

LongText
Y


Calculation and Validation 

Not needed as information will be in the processing logic section

Populate the table below to list the calculation and validation rules per field. Can be deleted if not needed.

ParentFieldRule TypeRule Instruction












Processing Logic

Describe the processing requirement in the System

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

Please describe change tracking requirements, i.e. transferring only delta, or always full load

Interface Alert & Monitoring

Please describe any alert & monitoring requirement for business users and support organization, i.e. AIF

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

IDConditionExpected 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

Package NameParent Package




Other Development Objects

Object TypeObject NamePurpose/High Level LogicDesign 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.


Change log