Module overview
Reference summary of the Events and Shipments modules: screens, records, event types and how to read the reference pages.
A lookup reference for the Events and Shipments modules: screens, tables, fields, accepted values, defaults, actions, rules and messages. For step-by-step instructions, see Get started with Events and Shipments.
How to read this guide
- Bold text is an exact label from the interface.
- Req. shows whether a field is required: Yes, No, or Conditional (the condition is stated).
- Default is the value the form shows before you change anything.
- Event times are shown in UTC, with the offset of the time zone the event was logged in in parentheses beside the time, such as (-06:00).
- A shipment's Status is shown as the app displays it. This guide lists the values and does not interpret them.
Purpose and location
The Events module records what happens to lots and containers over time: commissioning, observing, shipping, receiving, packing, unpacking, transforming and decommissioning. The Shipments module lists the movements between Locations that those events create, and lets you open a shipment's supply chain.
Open Events or Shipments under Traceability in the left navigation.
Account-wide options, such as the account time zone, are in Settings, which opens with the gear icon at the bottom of the left-hand navigation bar or the Settings button on the Dashboard. The account time zone is on the Account tab (Organization Settings > Account). See Account settings.
Tabs and screens
| Screen | Tabs and main controls |
|---|---|
| Events | Event List, Event Resolver, Templates. Add Events button at the top right. |
| Add Events drawer | Single Event and Bulk Upload modes. |
| Shipments | Inbound and Outbound. New Inbound Shipment on Inbound, New Outbound Shipment on Outbound. |
| Shipment page (View Shipment / Preview Shipment) | Details and Documents toggle; Map, Diagram and List tabs. |
| Supply chain window (from an Event List row) | Map, Diagram and List tabs; Cancel and Ok buttons. |
| Link Trace Information drawer | Event details, Shipment Lots, All Events and Inventory Lots tabs. |
Event Resolver, Templates and Bulk Upload are outside this reference.
Records and how they relate
| Record | What it is | Where it appears |
|---|---|---|
| Event | One recorded activity of one of eight types, at a time and place. | Event List. |
| Lot | A quantity of one product with a lot code. | Lot(s) column; Lot / Serial search. |
| Container | A packed unit identified by an SSCC or Logistic ID that holds lots. | Containers tab of inventory selection; Primary ID in the List view. |
| Shipment | The movement of lots or containers from an origin Location to a destination Location. | Shipments > Inbound and Outbound. |
| Trace | The link between a Direct Ship or a Receive and the earlier events that came before it. When a Receive is linked with Link Trace Info, it requires a Ship event. | Link Trace Info button and Trace Added label on Outbound; Link Trace Info in the Inbound row menu. |
Event types
| Event Type | Records |
|---|---|
| Commission | A new lot coming into existence at a Location. |
| Observe | A lot or container seen, counted or checked at a Location. It can adjust a Lot's quantity (for example to re-weigh Lots or during stock taking) but does not change the Lot number. Business Step defaults to Packing (CBV) and can be changed. |
| Ship | Lots or containers, or part of a lot, leaving an origin Location for a destination Location. |
| Receive | A shipment, or goods with no shipment record (a Direct Receive), arriving at a destination Location. |
| Aggregation | Lots packed into a container. |
| Disaggregation | A container unpacked. |
| Transform | Input lots consumed to create output lots. |
| Decommission | A lot or part of a lot removed from active inventory. It requires a Disposition, which records why; there is no Reason field. |
Related: Get started with Events and Shipments; Wholechain Events Overview; Events overview and list navigation; Shipments overview and table controls; Shared event fields; FAQ.