High- Level Specification
| Implementing System | Kinaxis Maestro |
|---|---|
| Invoked by/Invokes | ERP-1647 - Getting issue details... STATUS |
| Business Process Reference | 04.04.06.01. Data provisioning ERP to Maestro |
Functional Overview
Contains forecasted currency conversion rates. The records in this table represent conversion rates that will be used as of the specified date. The rates in this table are combined with the CurrencyConversionActual and HistoricalCurrencyConversion tables to determine the rates used to perform currency conversions. The date specified for the conversion determines which conversion rate is used. For example, the rates in this table are used as conversion rates only if the specified conversion date is later than the current date.
Scope and Objectives
The scope of this interface is between Global Integration Suite and Maestro. This document includes details of the CurrencyConversionForecast.tab object.
The objective is to populate the CurrencyConversionForecast 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 CurrencyConversion table, with the load initiated either manually or through a scheduled system task. |
6 | The Data Tables which store information in Maestro |
Assumptions
- Two data sources are set up in Maestro
- Global: Contains data provided by ROW Integration Suite
- China: Contains data provided by China Integration Suite
- Each data source will provide a unique key. Therefore neither data source will overwrite data provided by the other.
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 - 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 | Currency | Currency.Value | Ref String | N | ExtractField | Default | Currency code for which the exchange rate is defined (e.g., USD, EUR). |
| 2 | Date | Date | Date | N | ExtractField | Default | Effective date of the exchange rate. Defines the validity date of the rate value. |
| 3 | Rate | Rate | Quantity | N | ExtractField | Default | Exchange rate value applicable for the specified currency and date. |
File Formats
See File Formats - SFTP section in the Data Integration Document.
Data Model CurrencyConversionForecast 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 CurrencyConversionForecast custom fields:
There are no custom fields for this table
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 CurrencyConversionForecast is omitted from any of these loads, the CurrencyConversionForecast 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 CurrencyConversionForecast table data have to be either loaded manually before loading the CurrencyConversionForecast table or at the same time as the CurrencyConversionForecast table is loaded or set to be created automatically in data model or in DSM.
Below tables need to be taken into account before OnHand table data load:
Table | SyWay configuration |
Currency | This is loaded manually prior to the data load |
Volumetrics
Current APS Volume of CurrencyConversionForecast records is 986.
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> |
| 4 | Data file contains duplicates | Duplicates for CurrencyConversionForecast.tab are permitted technically as there are no keys, so no duplicate errors should exist, but a manual comparison test should be performed to ensure that no 2 rows are the same. |
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 |
|---|---|---|---|