High- Level Specification

Functional Overview

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

Syensqo uses Descartes (3rd party system) which is the market-leading global trade content for GTS that provides the most current regulatory data for Compliance Classification Codes (Export Control on EARUS). New classification codes are always provided by Descartes on a regular basis via XML files.

The purpose of this system interface is to automatize the process by, uploading the list of EARUS compliance classification codes published by the Government into SAP GTS. The update should occur when a file is provided by Descartes. Updates can be received on a weekly basis, hence the set up of the program will be marked as weekly.

In terms of errors that can occur via the automatic upload, IT GTS users will get a notification within Fiori Launchpad in order to troubleshoot the problem (manual intervention).

The file movement (CPI-S/4) is covered via FS: ERP-716 Process and Upload Compliance (EARUS) Classification Codes automatically in GTS - Integration process - SyWay Project - Syensqo - Wiki knowledge base

Scope and Objectives

While GTS is the leading system for classification codes and product assignment, this step is the prerequisite before classifying any product and before any export can happen in the system. 

The emails that Descartes is sending to GTS IT team with the new classification codes will be replaced by this new automatization which follows one straight objective: to reduce the workload of man/hour which involves emails, dependency on an user action/availability or knowledge transfer within the team.

With the 3 different instances of GTS system for US, China and Rest of World, the EARUS file must be available in all systems for the product-classification codes to happen.

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

Assumptions

1. SAP GTS E4H system will be available at the time of upload.
2. Numbering schemes content & Legal Regulations will be configured in GTS system.
3. Upload logs will be generated.
4. Notification functionality will be handled by standard GTS Fiori Launchpad.
5. Users listed under DL sco-digops-gts@syensqo.com will be used as basis to receive notification via Fiori whenever custom program runs successfully or fails.

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

Descartes must published first the XML content for EARUS codes.

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

• Uploading the file to an accessible file server (to be accessed by the Standard Program) is to be done securely through Cloud Connector.

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

You have made the following settings in Customizing for the GTS system:

• You have defined numbering schemes content in Customizing for the general settings. The numbering scheme contains the underlying structure for the numbers. 

• You have defined and configured the necessary legal regulations in Customizing and activated them for the application areas.

• You have set up system communication.

• You transferred products from your feeder system to the GTS system.

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

Special Requirements

Overwriting should be possible. Whenever there is an emergency and cannot wait for the interface program to run, the GTS IT user can login to the FTP server, download the XML file and then upload the file to GTS manually.. However, at the next run of the program this should overwrite the entries stated by the GTS IT user.

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

Existing process is manual upload of EARUS XML file on a regularly basis and it needs to be replaced by this automated solution.

Variant for the file weekly upload program of /SAPSLL/LLNS_UPL002 (/SAPSLL/NSC_NUM_UPLOAD_002).

→ Number specific-parameters:

• Data Provider: Descartes
• Numbering schemes content: ECCN**

→ Application Servers:

• Path of number file: application server.

→ General Control Parameters:

• Package check active: ticked
• Update Schema definition: ticked
• Simulation Mode: only when is controlled manually or testing purposes.

Additional explanation on some of the mentioned fields:

• Path of Number files → This is the path taken from the APP server.
• Package Check Active→ If this indicator is active a new version can only be loaded if all packages or files were loaded successfully for the previous version. If is deactivated you can upload a new version, although the previous version was not loaded completely (not recommended).
• Update Schema Definition → Displays whether scheme definitions are to be transferred from the upload file.
• Simulation Mode → If this indicator is selected, processing is only performed in the simulation mode and results cannot be updated to the database.

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

API usage is provided.

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

Data Structure

N/A

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

Calculation and Validation

N/A

Populate the table below to list the calculation and validation rules per field

Processing Logic

Once the XML files are fetched from the Data Provider, these will be uploaded to GTS system using standard transaction /n/SAPSLL/LLNS_UPL002. This program will be scheduled to run once a week (date & time TBD).

Describe the processing requirement in the System

Delta or Full Load Requirements

First upload will be considered the initial upload for EARUS XML classification codes → full upload.

After that, the rest are considered delta, whenever new codes shows up or changes.

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

Interface Alert & Monitoring

A notification via Fiori Launchpad (standard) is send to the GTS IT user if any error occurs during file upload in GTS, but also if upload was successfully executed.

Users listed under DL sco-digops-gts@syensqo.com will be added to a custom maintenance table (SM30):

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

Language Requirements

English

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.

Volumetrics

Provide volumetrics details: Initial load volumes, Number of Records, Expected Frequency, Expected Long term Growth)

Performance Consideration

For the XML size during upload, reach out to the owner of the FS to get the details to login to Descartes website and to do the technical check.

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

When a file has errors during upload the file is not archived from the directory. A notification is sent to the GTS IT user to check the error. Worst case, the user must upload manually the XML and do correction manually in GTS.

If no file found the customs program will stop with an error ending the program.

Log requirements (Is there a log that shows the job has run?):

1. Extract - Not able to access folder → notification via Fiori Launchapd to the GTS IT users
2. Upload- File error when moving file from FTP site to Application server →  notification via Fiori Launchapd to the GTS IT users
3. No file available at the time when the custom program is scheduled to run →  End program.

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