High- Level Specification
| Implementing System | Kinaxis Maestro |
|---|---|
| Invoked by/Invokes | ERP-1526 - Getting issue details... STATUS |
| Business Process Reference | 04.04.06.01. Data provisioning ERP to Maestro |
Functional Overview
This table stores information for GBU + Country combination for Location Hierarchy in Maestro.
Scope and Objective
The scope of this interface is between Global Integration Suite and Maestro. This document includes details of the GBUCountry.tab object.
The objective is to populate the GBUCountry and it's referenced tables based on the file provided by Global Integration Suite.
Process Flow Diagram
draw.io
/display/ER/System+Interface+-+Reference+Specification+for+Maestro
Step | Description |
|---|---|
1 | Global Integration Suite transfers transformed Composites / Rest of World data from S/4, and performs some formatting, and sends the data to Maestro. |
3 | Transferred files will be sent to Maestro’s Client SFTP server. This sits outside of the Maestro firewall and is accessible by client using a user id/ password. Files are transferred from this component to the Planning Server SFTP by a Kinaxis automatic process once the trigger file has been placed (see below) |
4 | Files are moved to this SFTP server automatically, where they await loading into Maestro. |
5 | Maestro uses the configured DSM (Data Sources and Mapping) setup to load the data into the GBUCountry table, with the load initiated either manually or through a scheduled system task. |
6 | The Data Tables which store information in Maestro |
Assumptions
See OnHand.tab System Interface document for assumptions.
Dependencies
See OnHand.tab System Interface document for dependencies.
Security, Integrity and Controls
See Application Architecture Kinaxis Maestro for security requirements for SFTP/REST based authentication and security.
Configuration Requirements
The Data Sources and Mapping for this interface should be configured once, according to the structure in the Data Structure section below.
The Data Model needs to be configured with the Syway-specific fields shown in the Data Model Custom Fields section below.
Special Requirements
None
Design Rationale
The base of this design has been taken from the existing Maestro implementation, as designed during the Advanced Planning System (APS) Project.
A fit-gap analysis was undertaken within Syway, and changes were identified which have been incorporated into the Syway spec as shown.
API Use
The data object provided by either Integration Suite will be consumed by Maestro.
For more information see the Data Integration Document.
Data Structure
The following Maestro fields will be populated by the file provided by Integration Suite:
| Column Number | Field Name | Technical Field Name | Data Type | Key | Field Type | Autocreate | Description |
|---|---|---|---|---|---|---|---|
1 | Country | Country.Id | Ref String | Y | ExtractField | N | A unique identifier associated with this country or market. |
2 | GBU | GBU.Id | Ref String | Y | ExtractField | N | The GBU id |
3 | Description | Description | String | N | ExtractField | Default | GBUCountry Description |
File Formats
See File Formats - SFTP section in the Data Integration Document.
Data Model GBUCountry table settings:
| Allow Data update to: | Currency | |||
|---|---|---|---|---|
| Insert, Modify and Delete records | Insert and Modify records only | Allow automatic record creation | Determined by Maestro | Expression |
| Y | - | N | Y | - |
Data Model GBUCountry custom fields:
Field name | Description | Data type | Key |
CountryGBUZone1 | GBU Zone 1 specific to Country GBU's | Ref String | N |
CountryGBUZone2 | GBU Zone 2 specific to Country GBU's | Ref String | N |
Processing Logic
See Processing Logic - SFTP section in the Data Integration Document.
Delta or Full Load Requirements
The preference is to do a full load.
For more information on the difference between Full and Delta loads, see the Full Loads and Delta Loads - SFTP section in the Data Integration Document.
Interface Alert & Monitoring
See the Interface Alert & Monitoring - SFTP section in the Data Integration Document,
Language Requirements
None
User Interface Requirements
Not required.
Sequencing
Reference tables to support GBUCountry table data have to be either loaded manually before loading the GBUCountry table or at the same time as the GBUCountry table is loaded or set to be created automatically in data model or in DSM. This point is open in the fit gap excel file and section to be modified once concluded.
Below tables need to be taken into account before GBUCountry table data load:
Table | SyWay configuration |
Country | Auto create not allowed |
GBU | Auto create not allowed |
GBUZone1 | Set to allow automatic record creation |
GBUZone2 | Set to allow automatic record creation |
Volumetrics
Current APS Volume of GBUCountry records is 1481. Because APS makes up approximately 60% of Syway projected records, an expected estimate for Syway is therefore 2370.
This value is expected to grow by 1-2% per year.
Performance Consideration
N/A
Testing
How to Test
See OnHand.tab System Interface document for information on how to test.
Test Conditions and Expected Results
| 1 | Data Load Successful | The Data in the data file matches the data in the Maestro table, and there are no errors. | ||||
| 2 | Data File contains 0 records | The Data Update should fail with a status of Pending. | ||||
| 3 | Data File contains invalid references (or other error) | The Data Update should Fail, the invalid references should be visible in the error log and the records with the error are not loaded into Maestro, and an alert is sent to the Admin team <Or whatever action is needed> Fields for GBUCountry.tab which should be checked for invalid references are shown in the Data Structure table above as "Ref String" and are:
| ||||
| 4 | Data file contains duplicates | The GBUCountry.tab file must be checked further for data uniqueness with respect to the key fields, in case data is available in file but not in Maestro |
Test Considerations/Dependencies
Dependent files should already be loaded into Maestro for these tests to complete. See Sequencing section above.
Other Information
Development Details
Package
| Package Name | Parent Package |
|---|---|
Other Development Objects
| Object Type | Object Name | Purpose/High Level Logic | Design Rationale Reference |
|---|---|---|---|