Forms – ReferenceModule overview

Module overview

What the Wholechain Forms module is, where to find it, its two tabs, its records and key concepts.

This reference states what each screen, field, action, value, rule and message in the Wholechain Forms module is. It does not explain procedures; the User Guide covers how to complete each task. Labels in bold are the exact interface text. Form owners can rename most section titles, field labels and column names, so a form you open may show different wording from the defaults listed here.

Conventions: Req. is Yes, No or Conditional. "No (encouraged)" means the field can be left blank but should be completed when the information exists.

Purpose

Forms lets an account owner (usually a buyer) give Trade Partners a structured form to complete so that shipment information reaches the owner in a consistent format. The supported form type is the Ship Event form. Using a form supports traceability programs, including FSMA 204 use cases. It does not by itself guarantee regulatory compliance.

Location

In the left sidebar, open Compliance → Forms. Forms is the second module under Compliance, between Labels and Documents.

Tabs

TabShowsUsed by
Forms ListForms that connected Trade Partners shared with your account.Suppliers completing a form.
Forms ManagerForms your account owns. Contains the Create Form button.Account owners creating, configuring, publishing and sharing forms.

The number beside each tab name is the count of forms in that tab. An account can use both tabs.

Records and relationships

RecordDescription
FormA Ship Event form definition owned by one account. It has a name, a configuration, a status and a sharing setting.
Published versionThe configuration recipients see. It changes only when the owner publishes.
Draft configurationThe configuration the owner is editing. Changes save automatically but stay unpublished until published.
SubmissionA completed Ship Event form sent by a supplier to the owner.

Key concepts

ConceptMeaning
Creating, saving, publishing, sharingFour separate stages. Creating or configuring a form does not publish it, and publishing does not share it.
Sharing scopeSharing a form does not share the destination Locations or Trade Items a supplier needs to complete it.