Status

OwnerABOLAJI-ext, Luqman 
Stakeholders
Jira Request ID

Jira Development ID

High- Level Specification

Implementing SystemThe system in which this System Interface is implemented
Invoked by/InvokesLink 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


Functional Overview

The functional design of the system interface defines the API to be provided or consumed. 

Scope and Objectives

Detail the functional scope and objectives of the Interface. Please also describe the gap that will be addressed by this interface (Compared to SAP Standard)

Process Flow Diagram

Insert the flowchart and fill in the steps

Step

Description

Comment










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

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.

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

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. 

Data Structure

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

ParentFieldDescriptionMandatory (Y/N)Data Type











Calculation and Validation

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

ParentFieldRule TypeRule Instruction












eDocument mapping

Populate the table below to list the mapping for edocument implementations. Can be deleted if not needed.

GeneralSyensqo XML (Intermediate Target)SAP eDoc Standard Mapping (Source)Custom Mapping (Source)
S-NRFlow (SD/FI/MM/ALL)Target FieldTarget Field DetailsConditionSyensqo XML NodeSyensqo XML FieldSAP eDoc Standard NodeSAP eDoc Standard FieldFixed ValueCustom Logic




Conditional / Mandatory Header / Header Tax / Header Value / Header Extension / Sender / Sender Extension / Receiver / Receiver Extension / Item / Item Tax / Item Value / Item Extension















Processing Logic

Describe the processing requirement in the System


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