HelpField and settings reference

Field and settings reference

Quick lookup of Forms fields, owner settings, statuses, sharing values, import options, messages and rules.

Applies to: Forms List and Forms Manager

Audience: Suppliers and account owners looking up a field, setting or message

Prerequisites: none

Related: Open and complete a shared Ship Event form; Add products and submit a Ship Event form; Create and configure a form; Publish, share, and manage a form

Labels below are the Wholechain defaults or those on the example forms. Form owners can rename most of them.

Forms page

ItemDescription
LocationCompliance → Forms (second module under Compliance).
Forms List tabForms shared with your account. Columns: Name, Shared By, Last Updated. Search box: Search forms. Row click opens the form in a side drawer.
Forms Manager tabForms your account owns. Columns: Name, Status, Sharing, Last Updated. Button: Create Form. Row click opens configuration.
Supported form typeShip Event.

Forms Manager row menu

ActionWhen shownWhat it does
PublishOnly when there are edits not yet publishedPublishes the latest configuration.
Edit FormAlwaysOpens a drawer to rename the form (Form Name, Save Changes).
Manage SharingAlwaysOpens the sharing drawer.
Copy URLAlwaysCopies a link to the form.
Delete FormAlwaysOpens the Delete Form? confirmation.

Status and sharing values

FieldValues
StatusDraft (never published); Published (an information icon appears when a newer edit is unpublished).
SharingDon't Share; All Network Partners; Specific Network Partners.

Create Form drawer

FieldRequiredNotes
Form NameYesShown to recipients.

Form configuration (owner)

SectionSettingDefaultNotes
Information DetailsSection TitleblankHeading of the supplier's instructions section.
Instruction DocumentnoneChooses an existing document from Documents.
Information ContentblankRich text: undo/redo; Small, Body, Large, Heading; Arial, Times New Roman, Helvetica, Georgia, Verdana; bold, italic, underline, color; bulleted and numbered lists; links.
Vendor DetailsSection TitleVendor
Vendor Selection LabelVendor Details
Ship From DetailsSection TitleShip From
Ship To DetailsSection TitleShip To
Shipping to LabelShip to Location
Shipment DetailsSection TitleShipment Details
SSCC Display LabelSSCC
Purchase Order Number Label, Purchase Order Number TooltipPurchase Order Number; no tooltip
Universal TLC Label, Universal TLC TooltipTLC; no tooltip
TLC Source Label, TLC Source TooltipTLC Source; no tooltip
Use SSCC ValidationOffGS1 check-digit validation.
Use Universal TLC FormatOffOne TLC across all product rows and lot or serial entries.
Custom Template AttributeAttribute Key, Attribute Label, Attribute Type (all three required to create the attribute), Attribute Tooltip, Dropdown ItemsnoneTypes: Dropdown, Number, Text, Date. Delete removes a row.
Trade Item Table SectionSection TitleTrade Item Table
Product Column Name, Product TooltipProduct
Quantity Column Name, Quantity Tool TipQuantity
TLC Column Name, TLC TooltipTLC
TLC Source Column Name, TLC Source TooltipTLC Source
Lot Serial Column Name, Lot Serial TooltipLot/Serial
Optional Trade Item ColumnsItem Number (Visibility, Name, Tooltip)Shown; "Item Number"Supplier's item number.
Owner's Item Number (Visibility, Column Name, Tooltip)ShownItem number assigned by the form owner.
UoM, GTIN, UPC, PLU, Brand (Visibility, column name, Tooltip)ShownVisibility values: Shown, Not Shown.

Manage Sharing drawer

ItemDescription
Sharing modeDon't Share, All Network Partners, Specific Network Partners.
Trade partnersSelector enabled for Specific Network Partners.
Save SharingSaves the choice.

Supplier form (Forms List)

SectionField or controlNotes
Information and InstructionsExpand to readOwner's instructions and document.
VendorVendor DetailsRequired. Your own (self) Trade Partner.
Ship FromLocation (required); Add Location (selector)Selector option opens Add Locations (Single Location, Bulk Upload).
Add Location (button by heading)Adds a Location entry to this form.
Ship From Location toggleOne entry at a time.
Remove LocationUnavailable on the current Ship From Location.
Ship ToShip to LocationRequired. Locations shared by the form owner. One per form.
Shipment DetailsSSCCOptional. You decide whether the shipment was sent in a container; leave it blank when no container code applies.
Purchase Order NumberRequired. Free entry.
TLC, TLC SourceRequired. Per buyer instructions.
Shipment DateRequired. Date plus hours, minutes, seconds; OK applies.
Manually enter TLC Source for each productHides shared TLC Source; row cells become editable.
Invoice NumberOptional but encouraged. Information icon shows guidance.
Product tableAdd Product, Import XLSX/CSV
Row columnsProduct name, Owner's Item Number (read-only), Quantity, TLC (read-only with a universal TLC), TLC Source, Lot/Serial. Product, Quantity, TLC Source and Lot/Serial are required on every row.
Row three-dot menuDelete.
Bottom of formClear Form, SubmitClear Form empties entries without confirmation.

Import window

ItemDescription
TitleImport Data from XLSX/CSV
Upload areaClick or drag file to upload; "Supports CSV and XLSX."
ButtonsCancel, Import
MappingMap Attribute selectors. Required: Item Number/ID, Lot/Serial, Quantity. TLC and TLC Source when the form requires them.
MatchingBy item number or ID, not item name.

Messages

MessageWhen it appears
"Compliance form created successfully."After Create Form.
"Saving"While an automatic configuration save is running.
"Draft published successfully."After publishing.
"There is a newer edit version that has not been published yet."Information icon beside Published.
"Form URL copied to clipboard."After Copy URL.
"This form will not be shared with any trade partners."Manage Sharing with Don't Share.
"Please input a ship from location"A supplier leaves Ship From empty.
"Please input required fields."A product row with missing required values (shown beside a red X on submit).
Delete Form?Confirmation naming the form, with Cancel and Delete.

Rules and restrictions

RuleApplies toBehavior
Supported typeFormsShip Event is the only form type.
Publish before recipients see changesConfigurationRecipients see only the published version.
Sharing does not include master dataSharingDestination Locations and Trade Items must be shared separately.
One destination per formShared formA shipment has one Ship To destination. Use one form per shipment and destination.
One Ship From LocationShip FromOnly one entry can be designated; the designated entry cannot be removed.
Import matchingImportMatches item numbers or IDs, not names.
SSCC validationShipment DetailsApplies only when Use SSCC Validation is on.
Universal TLCShipment Details, product rowsWhen on, product TLC values are read-only.
Clear FormShared formNo confirmation window.
Labels varyAll formsOwners can rename sections, fields and columns, and hide optional columns.