| Status | |
|---|---|
| Owner | The person responsible for driving this decision and documenting it. Type @ to mention people by name |
| Stakeholders | The business stakeholders involved in making, reviewing, and endorsing this decision. Type @ to mention people by name |
| Jira Request ID | Enter the Jira request card URL here (Use the Jira macro to search and add) |
| Jira Development ID | Enter the Jira development card URL here (Use the Jira macro to search and add) |
High- Level Specification
| Implementing System | The system in which this System Interface is implemented |
|---|---|
| Invoked by/Invokes | Link to any Integration Process spec which is related to this System Interface, e.g. because it is invoking this interface, or because this interface is sending data to it. |
| Business Process Reference |
Functional Overview
The OnHand table stores inventory quantities and associated attributes for a part at a specific location within a warehouse. It represents the inventory position used by Maestro for planning, allocation, and pegging activities and is synonymous with inventory.
When on-hand inventory is allocated to demands for pegging, higher-priority demands are protected. If no priority is defined, on-hand inventory for a part is consumed based on the following attributes, in order:
- Expiry date (earliest first)
- Date (earliest first)
- Unit cost (lowest cost first)
- Quantity (smallest quantity first)
- Location identifier and warehouse
Scope and Objectives
The scope of this interface is between Global Integration Suite and Maestro. This document includes details of the OnHand.tab object.
The objective is to populate the OnHand and it's referenced tables based on the file provided by Global Integration Suite.
Process Flow Diagram
Step | Description | Comment |
|---|---|---|
1 | Global Integration Suite transfers transformed Composites / Rest of World data from S/4, and performs some formatting, and sends the data to Maestro. | <Integration Spec Link> |
2 | China Integration Suite transfers transformed China data from S/4, and performs some formatting, and sends the data to Maestro. | <Integration Spec Link> |
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 OnHand table, with the load initiated either manually or through a scheduled system task. | |
6 | The Data Tables which store information in Maestro |
Assumptions
See Assumptions section in System Interface - Reference Specification for Maestro.
Dependencies
See Dependencies section in System Interface - Reference Specification for Maestro.
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.
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 Data Structure - File Formats section in System Interface - Reference Specification for Maestro.
Data Model OnHand table settings:
<Nihaal>
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 |
|
TotalQuantity | Saving the total quantity from SAP before the data automations for reservations, Consignment, and Tolling | Quantity | |
Info | Information coming from SAP | String | |
HoldType | Used to support the reservations for customers or production orders Referenced table: HoldType | Reference |
|
Calculation and Validation
Not required.
eDocument mapping
Not required.
Processing Logic
See Processing Logic section in System Interface - Reference Specification for Maestro.
Tolerance setting should be set to
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 OnHand is omitted from any of these loads, the OnHand data within Maestro will be unchanged.
For more information see Delta or Full Load Requirements section in System Interface - Reference Specification for Maestro.
Interface Alert & Monitoring
See Interface Alert & Monitoring section in System Interface - Reference Specification for Maestro.
Language Requirements
None
User Interface Requirements
Not required.
Sequencing
Reference tables to support OnHand table data have to be either loaded manually before loading the OnHand table or at the same time as the OnHand 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 |
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 OnHand records is 110,000. Because APS makes up approximately xx% of Syway projected records, an expected estimate for Syway is therefore xxxx. <Ahmed>
This value is expected to grow by xx per year. <Ahmed>
The Kinaxis Guardrail document indicates that no more than xxx records should be stored in the OnHand table. <Ahmed - Samer>
Performance Consideration
SFTP - None (aside from the Volumetric considerations above)
Error Handling
See Interface Alert & Monitoring section.
Testing
How to Test
See Testing - How to Test section in System Interface - Reference Specification for Maestro.
Test Conditions and Expected Results
See Testing - Test Conditions and Expected Results section in System Interface - Reference Specification for 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.
