The Data Field Manager allows you to update field properties and view your fields and usage in one place. You can also use the Data Field Manager to permanently delete fields from the template record, which helps avoid confusion between unused fields on the design.
Terminology
Template Record
The master structure containing the fields and settings for a pass design.
Pass Designer
The interface used to visually create and modify the appearance of a digital pass.
Field Key
The unique identifier assigned to a data field, often used for API interactions.
API (Application Programming Interface)
A set of rules and specifications that software applications can follow to communicate with each other.
JSON (JavaScript Object Notation)
A lightweight data-interchange format used for representing structured data.
Template Override
Customisations applied to a specific platform's (e.g., Google Wallet) display of a field.
Lock Screen Message
A notification displayed on a device's lock screen when a field is updated.
Relative Date
A date displayed in relation to the current time (e.g., "in 2 days").
Absolute Date
A date displayed with a specific date and time (e.g., "December 25, 2024").
Link Suppression
The ability to prevent automatic link generation for text fields.
Opening the Data Field Manager
The data Field Manager can be access from the left hand menu when viewing the designer.
Navigate to the the Data Field Manager
When viewing the pass designer, click on the Data Field Manager icon.
Data Field Manager Columns
1. Unique Name
This displays the field key. This is useful to identify fields where the label may not be descriptive, and for use with the API.
2. Label
The field label.
3 Data Type
What type of data the field is used for, i.e Text, Text_long, Date
4. Field Type
Protocol Field - These are fields specific to the pass type you have selected.
PII Field - This field is for PII data (Personally Identifiable Information), which is any data that can be used to identify a specific individual. These fields are encrypted on our servers.
Static Field - These fields are custom fields, which can hold data that is the same for all passes.
Meta Field - These field contain data which can be different for each individual pass.
Universal Field - A predefined field that can hold a static data.
4. Required
Is the field required in order for a pass to be issued.
Managing Fields in the Data Field Manger
The Data Field Editor
Clicking on the Field row will open the editor
The editor has 2 tabs.
Details
Here you can edit the,
Custom Field type - this shows if the you are editing a custom field
Unique Name - This forms the field Key
Label - This is the field label displayed on the pass design
Default Value - The default value (mainly used for static fields)
Delete Field - This permanently deletes the field from the template
Note: Any greyed out fields cannot be edited
Apple Wallet
Here you can edit specific Apple Wallet settings for the field.
Change Message - This is the message that is shown on the device lock screen when a field is updated.
Link Suppression - This allows you to disable Apple Wallet automatically creating links from properly formatted text, like addresses, dates, URL's (which haven't used <a> tags and phone numbers.
Editing a field in the Field Manager
Click on the Field row to open the editor
Make any changes, then click Save when finished. Click Save Design to save all changes.
Deleting a Field
This action will permanently delete the field from the pass, and the template.
To remove a field from either the Apple design, Google design or Data Collection form design only, this should be done from the pass designer.
Click on the Field row to open the editor, then click on DELETE to delete the field and confirm you wish to delete the field.
