High- Level Specification
| Implementing System | Kinaxis Maestro |
|---|---|
| Invoked by/Invokes | ERP-1488 - Getting issue details... STATUS |
| Business Process Reference | 04.04.06.01. Data provisioning ERP to Maestro |
Functional Overview
BillOfMaterial identifies the parent and child relationships between Assembly parts, such as product assemblies and sub-assemblies, and the Component parts used to produce them, including assemblies, sub-assemblies, and raw materials. It defines how an assembly is built by listing the components required in its production.
Both the Assembly and its Components must already exist in the Part table, as the BillOfMaterial references that table directly. Depending on the system, this structure may also be referred to as a Planning BOM, Sales Order BOM, or Formula, but the purpose stays the same: clearly defining what goes into making a finished item.
Scope and Objectives
The scope of this interface is between Global Integration Suite and Maestro. This document includes details of the BillOfMaterial.tab object.
The objective is to populate the BillOfMaterial 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. |
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 BillOfMaterial 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 - 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 | BaseKey | BaseKey.Id | String | N | NULL | Default | Optional field that can be used as a key field. In SyWay, this is set to Null. |
0 | BatchStatus | Batch.Status.Value | Ref String | N | FixedValue | Y | A unique identifier that describes the status of a batch. Typically used to help determine if a batch is usable or not. For SyWay, this is set to Null. |
1 | BatchPart | Batch.Part.Name | Ref String | N | ExtractField | Default | The part that belongs to this batch record. |
1 | PartName | Part.Name | Ref String | N | ExtractField | Default | The part number of the inventory. Referenced Table: Part |
2 | BatchPartSite | Batch.Part.Site.Value | Ref String | N | ExtractField | Default | The site associated with this part. |
2 | LocationWarehouse | Location.Warehouse.Site.Value | Ref String | N | ExtractField | Y | The warehouse where this location is. |
2 | Site | Part.Site.Value | Ref String | N | ExtractField | Default | The site of the part number of the inventory. |
3 | Type | Type.Value | Ref String | N | ExtractField | N | A value that determines whether the stock or inventory is considered in netting. This field references the OnHandType table. Valid values are' Net' or 'NoNet'. Referenced Table: OnHandType |
4 | Location | Location.Id | Ref String | N | ExtractField | Default | The stocking or bin location where the inventory is located. Referenced Table: Location |
5 | Warehouse Id | Location.Warehouse.Id | Ref String | N | ExtractField | Default | An Id code for the warehouse |
6 | Date | Date | Date | N | ExtractField | Default | Indicates the date at which inventory was received. |
7 | Quantity | Quantity | Quantity | N | ExtractField | Default | The amount in stock. |
7 | TotalQuantity | TotalQuantity | Quantity | N | ExtractField | Default | Saving the total quantity from SAP before the data automations for reservations, Consignment, and Tolling |
8 | Expiry Date | ExpiryDate | Date | N | ExtractField | Default | The date on which this inventory expires (is no longer usable). |
9 | BatchID | Batch.Id | .CString | N | ExtractField | Y | The identifier for this batch record. |
10 | Info | Info | CString | N | ExtractField | Default | Information coming from SAP |
File Formats
See File Formats - SFTP section in the Data Integration Document.
Data Model OnHand 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 OnHand custom fields:
Field name | Description | Data type | Key |
ReservedQuantity | Used internally in Maestro. Supports the reservation solution by saving the quantity reserved for customers. | Quantity | N |
TotalQuantity | Saving the total quantity from SAP before the data automations for reservations, Consignment, and Tolling | Quantity | N |
Info | Information coming from SAP | String | N |
HoldType | Used to support the reservations for customers or production orders Referenced table: HoldType | Reference | N |
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 BillOfMaterial is omitted from any of these loads, the BillOfMaterial 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 BillOfMaterial table data have to be either loaded manually before loading the BillOfMaterial table or at the same time as the BillOfMaterial table is loaded or set to be created automatically in data model or in DSM.
Below tables need to be taken into account before BillOfMaterial table data load:
Table | SyWay configuration |
Batch | Set to allow automatic record creation |
Location | Set to allow automatic record creation |
Model | Not needed in SyWay. Picks Maestro default value - None |
Pool | Not needed in SyWay. Picks Maestro default value - Unpooled |
HoldType | Set to allow automatic record creation |
Volumetrics
Current APS Volume of BillOfMaterial records is 110,000. Because APS makes up approximately 60% of Syway projected records, an expected estimate for Syway is therefore 150,000
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
See OnHand.tab System Interface document for information on how to test.
There are no BillOfMaterial-specific testing requirements.
Test Conditions and Expected Results
See OnHand.tab System Interface document for information on test conditions and expected results.
There are no BillOfMaterial-specific test conditions.
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 |
|---|---|---|---|