| Status |
| ||||||||
|---|---|---|---|---|---|---|---|---|---|
| Owner | |||||||||
| Stakeholders | |||||||||
| Jira Request ID |
| ||||||||
| Jira Development ID |
|
High- Level Specification
| Implementing System | Kinaxis Maestro | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| Invoked by/Invokes |
| ||||||||
| Business Process Reference | 04.04.06.01. Data provisioning ERP to Maestro |
Functional Overview
This is a corporate-led segmentation dimension, applied to both customer and product combination within the system. It functions in parallel with but is separate to the GBU-based hierarchy.This table stores information for a distinct division or unit in Maestro.
A Segment is a sub-category within a Market. It usually represents a key functionality the customer needs (functional segmentation). In some cases where functionality doesn’t apply (e.g., Consumer Goods), the Segment simply groups similar types of products or uses.
Scope and Objective
The scope of this interface is between Global Integration Suite and Maestro. This document includes details of the CorporateSegment.tab object.
The objective is to populate the CorporateSegment and it's referenced tables based on the file provided by Global Integration Suite.
Process Flow Diagram
| Embed draw.io Diagram | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
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. |
2 | China Integration Suite transfers transformed China 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 CorporateSegment 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 | Id | Id | String | Y | ExtractField | A value that uniquely identifies the CorporateSegment | |
2 | Description | Description | String | N | ExtractField | CorporateSegment Description |
File Formats
See File Formats - SFTP section in the Data Integration Document.
Data Model CorporateSegment 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 | - | Y | Y | - |
Data Model CorporateSegment custom fields:
There are no additional custom fields in this table. See section Data Structure above.
Processing Logic
See Processing Logic - SFTP section in the Data Integration Document.
Delta or Full Load Requirements
This file will be a Full Load, sent 3 times a day, so the file has been loaded at the beginning of day for each global region. If CorporateSegment is omitted from any of these loads, the CorporateSegment data within Maestro will be unchanged.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
N/A
Volumetrics
Current APS Volume of CorporateSegment records is 171. Because APS makes up approximately 60% of Syway projected records, an expected estimate for Syway is therefore 274.
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.
There are no CorporateSegment-specific testing requirements.
Test Conditions and Expected Results
There are no CorporateSegment-specific test conditions.| 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 duplicates | The CorporateSegment.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 |
|---|---|---|---|
Appendix
See also
| Attachments | ||||||
|---|---|---|---|---|---|---|
|
Change log
| Change History | ||
|---|---|---|
|