| 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
The PartUOMConversion table is used to store part-specific unit of measure conversion rates.
Records stored in this table are used to calculate forecast item quantities when generating a statistical forecast. They are also used when performing workbook-level conversions for quantity or currency fields that have a "Unit of Measure Item Path" defined (as described in the Maestro Data Integration Help). This table therefore allows a part to be calculated using a factor that is specific to that part, instead of the UnitOfMeasure.BaseConversion that is specified for a UnitofMeasure.
If a part has a unit of measure conversion record in the PartUOMConversion table, the UnitOfMeasure.BaseConversion is ignored. Therefore this table should be used if the Part.UnitOfMeasure has a different base unit value than the one that is given in UnitOfMeasure.BaseConversion. The part-specific unit of measure conversion factor needs to be entered to ensure that the quantities are correctly converted to a different unit of measure. For more information, see Define unit of measure. Quantities in the following tables are calculated using PartUOMConversion:
- ForecastItemParametersActual
- StatisticalForecast
- StatisticalForecastDetail
- StatisticalForecastDisaggregationRate
Scope and Objectives
The scope of this interface is between Global Integration Suite and Maestro. This document includes details of the PartUOMConversion.tab object.
The objective is to populate the PartUOMConversion 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. |
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 PartSource table, with the load initiated either manually or through a scheduled system task. |
6 | The Data Tables which store information in Maestro |
Assumptions
- Data will only come from Global Integration Suite into the Global Data Source, set up in Maestro.
Dependencies
- (SFTP) SFTP credentials needs to be set up, along with the file transfer mechanism.
- Integration suites should provide data in the format described by the Data Sources and Mapping section of this document.
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 | PartName | Part.Name | String | Y | ExtractField | Default | Material / part identifier for which the unit of measure conversion is defined. |
| 2 | PartSite | Part.Site.Value | Ref String | Y | ExtractField | Default | Site / plant where the part and its unit of measure conversion are valid. |
| 3 | UnitOfMeasure | UnitOfMeasure.Value | Ref String | Y | ExtractField | Default | Alternate unit of measure associated with the part. |
| 4 | Factor | Factor | Quantity | N | ExtractField | Default | Conversion factor between the base unit of measure and the specified alternate unit. |
File Formats
See File Formats - SFTP section in the Data Integration Document.
Data Model PartUOMConversion 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 PartUOMConversion custom fields:
This data object does not have any custom fields.
Processing Logic
See Processing Logic - SFTP section in the Data Integration Document.
Delta or Full Load Requirements
This file will be a Partial Load, sent 3 times a day, so the file has been loaded at the beginning of day for each global region. If PartUOMConversion is omitted from any of these loads, the PartUOMConversion data within Maestro will be unchanged.
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 PartUOMConversion table data have to be either loaded manually before loading the PartUOMConversion table or at the same time as the PartUOMConversion table is loaded or set to be created automatically in data model or in DSM.
Below tables need to be taken into account before PartUOMConversion table data load:
Table | SyWay configuration |
UnitOfMeasure | To be loaded before or with this data object |
Part | To be loaded before or with this data object |
Volumetrics
Current APS Volume of PartUOMConversion records is 429000.
This value is expected to grow by 1-2% per year.
Performance Consideration
N/A
Error Handling
See Interface Alert & Monitoring section.
Testing
How to Test
Testing of the interface consists of executing the data load into Maestro and validating the results using standard monitoring and validation tools. After each load, the Data Import and Update log is reviewed to confirm successful execution and to identify any errors or warnings generated during the load process.
Loaded data is then validated using a Data Validation workbook to ensure data completeness and correctness. Validation checks include confirming that required fields are populated, values are displayed in the correct format, and that data quality issues such as blank fields, incorrect quantities, or zero or invalid unit costs are not present. Additional checks may be performed to ensure consistency across key attributes such as part, location, and quantity.
Any errors or data issues identified during testing are documented in the agreed issue tracking mechanism (for example, in Jira or an action log). Most common error types are duplicate errors, missing references, junk values in input fields.
Duplicate errors need further investigation, in case valid data is flagged as duplicate by Maestro during data load and key field combinations have to be looked into for data uniqueness.
Missing references are to be resolved by either providing the missing data that is required to support the file upload (this could be in the form of a file or Maestro settings to allow for the data to be created automatically) or removing the references from the file.
Required corrections are implemented in the middleware (Integration Suite), and the data is reloaded. Validation steps are repeated until no errors are present (or reasons are fully understood).
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 PartUOMConversion.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 PartUOMConversion.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
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.
