IBM Food Trust™ spreadsheet templates, and completed examples, are provided for download, editing, and conversion to XML. You will complete a spreadsheet for each event type, data type, and transaction document type that you want to upload. You can download templates and upload your completed files using the IBM Food Trust UI Onboarding module.
Note: As an alternative to uploading spreadsheets via the UI, your Data integration experts can use the Converter API to transform your spreadsheet files into XML for uploading to IBM Food Trust using the Connector API.
Attention: To comply with EU General Data Protection Regulation (GDPR) data privacy requirements, you must ensure that no personal data is uploaded to IBM Food Trust in any free-form text fields or in any comments.
Spreadsheet bulk upload
Use the following procedure to upload spreadsheets through either the UI Onboarding module or the Data module:
- Access Spreadsheet bulk upload by selecting the Data module:
Figure 1. Data module
- Select Spreadsheet bulk upload from the left menu:
Figure 2. Spreadsheet bulk upload
- Download the spreadsheet templates that you want to use, for products (Master data), facilities (Master data), Purchase Orders, Receive Advice, Despatch Advice, Aggregation Events, Disaggregation Events, Commission Events, Decommission Events, Observation Events, and Payloads:
Figure 3. Spreadsheet templates
Figure 4. Spreadsheet templates, cont.
The Microsoft® Excel™ spreadsheet files (.xlsx workbook files) provided below include field-by-field details for each spreadsheet. They include detailed field descriptions, required formats, examples, and requirements.
Attention: Many of the worksheets contain a Level column, which represents groupings. Level 1 represents a new event or transaction. Anything above Level 1 represents an array. For example, the Aggregation description workbook contains both Level 1 and Level 2 groupings. To populate an Aggregation template workbook with one aggregation event, and three trade items, for example:
- First populate all required Level 1 cells in the first workbook row. The first trade item description, quantity, and quantity UoM cells (all Level 2) will be populated in the first workbook row.
- To populate the second trade item, create a new row, do NOT populate the Level 1 cells, and populate the Level 2 trade item description, quantity, and quantity UoM (unit of measure) cells.
- Then create another row and populate the Level 2 cells for the third trade item. Adding a new row and populating the required Level 1 cells creates a new aggregation event.
Figure 5. Spreadsheet templates example
Click any link below to view or save the sample spreadsheet file. Each sample explains the requirements referenced on the Spreadsheet templates page. Note that you should complete the products and facilities spreadsheets first, because that data is referenced by other data types.
Products spreadsheet fields
The Products spreadsheet consists of two worksheets—Entitlement mode and Products:
- Choose the Entitlement mode: None, Linked, Restricted, Private
- Next fill out the product detail information (use the Excel™ workbook links above for reference on the fields)
Facilities spreadsheet fields
The Facilities spreadsheet consists of two worksheets—Entitlement mode and Facilities:
- Choose the entitlement mode: None, Linked, Restricted, or Private
- Next fill out the facility detail information (use the spreadsheet workbook links above for reference on the fields)
Aggregation Events spreadsheet fields
The Aggregation Events spreadsheet consists of four worksheets—Entitlement mode, Products, Facilities, and Aggregation Events:
Commission Events spreadsheet fields
The Commission Events spreadsheet consists of five worksheets—Entitlement mode, Products, Facilities, Commission Events, and ILMDs:
Decommission Events spreadsheet fields
The Decommission Events spreadsheet consists of four worksheets—Entitlement mode, Products, Facilities and Decommissions. The first sheet is Entitlement mode. This is indicated by the drop-down box.
Disaggregation Events spreadsheet fields
The Disaggregation Events spreadsheet consists of four worksheets—Entitlement mode, Products, Facilities, and Disaggregation Events:
Observation Event spreadsheet fields
The Observation Event Spreadsheet consists of four worksheets—Entitlement mode, Products, Facilities, and Observations:
Transformation Events spreadsheet fields
The Transformation Event spreadsheet consists of five worksheets—Entitlement mode, Products, Facilities, Transformation Events, and ILMDs:
Payloads Spreadsheet Fields
The Payloads Spreadsheet consists of three worksheets—Entitlement Mode, Products, and Payloads:
Purchase Orders spreadsheet fields
The Purchase Orders spreadsheet consists of four worksheets—Entitlement mode, Products, Facilities, and Purchase Orders:
Despatch Advice spreadsheet fields
The Despatch Advice spreadsheet consists of four worksheets—Entitlement mode, Products, Facilities, and Despatch Advice:
Receive Advice spreadsheet fields
The Receive Advice spreadsheet consists of four worksheets—Entitlement mode, Products, Facilities, and Receiving Advice:
Entitlement mode worksheets
All spreadsheets include an Entitlement mode worksheet to specify which of your supply chain partners can view the data. To change the entitlement mode, select a new value from the drop-down list. The entitlement mode applies to all data in the XML file that is generated from the spreadsheet, and supersedes the data access control policy selected by your organization. An Entitlement Mode of none indicates that the default entitlement mode for your organization is applied, as specified by your organization's data access control policy.
See Data entitlement mode to learn about data entitlement and default access control for each IBM Food Trust message type. Attention The documentation describes setting the entitlement mode via the
IFT-Entitlement-Mode header when submitting the XML to the IBM Food Trust API; usage of this header supersedes the entitlement mode specified in the spreadsheet.
Modify your downloaded sample files, or create them programmatically, and submit them to the spreadsheet Converter API for conversion to XML. If you have multiple single events to convert to XML, enter the additional events on their corresponding worksheets and submit them to the API.
Click any link to view or save the sample Microsoft® Excel™ spreadsheet (workbook file):
- Despatch Advice
- Master Facility
- Master product
- Purchase Order
- Receive Advice