High- Level Specification
| Implementing System | Kinaxis Maestro |
|---|---|
| Invoked by/Invokes | ERP-1623 - Getting issue details... STATUS |
| Business Process Reference | 04.04.06.01. Data provisioning ERP to Maestro |
Functional Overview
The Independent Demand table identifies demand not directly related to demand for other parts. They represent open quantities on a sales order, materials that have been completed and issued to a sales order but not have been removed from site. Work orders that have been completed and closed for current month will be included also,to ensure we have right forecast consumption data.
Scope and Objectives
The scope of this interface is between Global Integration Suite and Maestro. This document includes details of the IndependentDemand.tab object.
The objective is to populate the IndependentDemand and it's referenced tables based on the file provided by Global Integration Suite.
Process Flow 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 IndependentDemand 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 |
|---|---|---|---|---|---|---|---|
0 | Control Set | Status.ControlSet.Value | FixedValue | N | Fixed | N | The control set associated with this record |
1 | Line | Line | String | Y | ExtractField | Default | A unique identifier associated with each IndependentDemand record with the same Order.Id |
2 | Order Id | Order.Id | String | Y | ExtractField | Y | A value that identifies an order number for an IndependentDemand record |
3 | Order Site | Order.Site.Value | String | Y | ExtractField | N | The site this demand order relates to. |
3 | Batch Site | Batch.Part.Site.Value | String | N | ExtractField | N | The site associated with this part. This field is a reference to the Value field on the Site table. |
3 | Part Site | Part.Site.Value | String | N | ExtractField | N | The site associated with this part. This field is a reference to the Value field on the Site table. |
4 | Order Type | Order.Type.Value | String | Y | ExtractField | N | A value that determines the processing policies of demand. |
5 | Customer Id | Order.Customer.Id | String | N | ExtractField | N | A value that identifies the customer. |
6 | Batch Part | Batch.Part.Name | String | N | ExtractField | N | The part that belongs to this batch record. |
6 | Part | Part,Name | String | N | ExtractField | N | Part number or item number. |
7 | Unit Selling Price | UnitSellingPrice | Money | N | ExtractField | Default | The unit price for this line item. |
8 | Due Date | DueDate | Date | N | ExtractField | Default | The date the order is scheduled to be completed to stock. |
9 | Request Date | RequestDate | Date | N | ExtractField | Default | The date by which the order would need to be completed to stock in order to ensure it can be shipped in time to meet the customer's requested date. |
10 | Quantity | Quantity | Quantity | N | ExtractField | Default | The amount still to be delivered. |
11 | Shipped Quantity | ShippedQuantity | Quantity | N | ExtractField | Default | The quantity that has already been shipped. |
12 | Status | Status.Value | String | N | ExtractField | N | A value for this type of DemandStatus. |
13 | Customer Request Date | CustomerRequestDate | Date | N | ExtractField | Default | The date on which the customer wants to receive delivery of the order at their location. |
14 | Batch | Batch.Id | String | N | ExtractField | Y | The identifier for this batch record. |
15 | Order Prioirty | Order.Priority.Value | String | N | ExtractField | N | The priority associated with this demand - Consider Using delivery priority and importing into this field. |
16 | Saved Priority | SavedPriority.Value | String | N | ExtractField | N | Duplicates OrderPriority, load with same data as OrderPriority. Not used by any algorithms, but may be used by Maestro legacy applications. |
File Formats
See File Formats - SFTP section in the Data Integration Document.
Data Model IndependentDemand 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 IndependentDemand custom fields:
Field name | Description | Data type | Key |
RevenueRecognitionDate | Calculated field | Date | 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 IndependentDemand table data have to be either loaded manually before loading the IndependentDemand table or at the same time as the IndependentDemand table is loaded or set to be created automatically in data model or in DSM.
Below tables need to be taken into account before IndependentDemand table data load:
Table | SyWay configuration |
| DemandOrder | Set to allow automatic record creation |
| Part | Auto create not allowed |
| Customer | Auto create not allowed |
| Site | Auto create not allowed |
| DemandStatus | Control table; Auto create not allowed |
| DemandType | Control table; Auto create not allowed |
| Batch | Set to allow automatic record creation |
Volumetrics
Current APS Volume of IndependentDemand records is 1,043,268.
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 IndependentDemand-specific testing requirements.
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 IndependentDemand.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 IndependentDemand.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 |
|---|---|---|---|
1 Comment
GARG-ext, Praful
First Pass peer review completed. KAVLEKAR-ext, Nihaal MOHAMOUD-ext, Ahmed Please make the required changes.
FYI- NARAHARI-ext, Bhargavi BROWN-ext, Kevin