High- Level Specification

Functional Overview

BOMAlternate defines alternative component structures for the same assembly. It allows different sets of components or versions of a BOM to be used for the same finished item, depending on conditions such as availability, location, production method, or planning requirements.

Scope and Objectives

The scope of this interface is between Global Integration Suite and Maestro. This document includes details of the BOMAlternate.tab object. 

The objective is to populate the BOMAlternate and it's referenced tables based on the file provided by Global Integration Suite.

Process Flow Diagram

Assumptions

• Data will only come from Global Integration Suite into the Global Data Source, set up in Maestro.

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:

File Formats 

See File Formats - SFTP section in the Data Integration Document.

Data Model BOMAlternate table settings:

Data Model BOMAlternate custom fields:

There are no custom BOMAlternate fields.

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 BOMAlternate table data have to be either loaded manually before loading the BOMAlternate table or at the same time as the BOMAlternate table is loaded or set to be created automatically in data model or in DSM.

BOMAlternate has no referenced tables.

Volumetrics

Current APS Volume of BOMAlternate records is approximately 170 including auto-created records. Because APS makes up approximately 60% of Syway projected records, an expected estimate for Syway is therefore 280

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

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

Other Development Objects

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.

Change log