Overview
You can define metadata for new fields in the Field Dictionary so they can be used in Structured layouts. You can define fields either individually or as a group.
Defining a single field
To define a single new field:
- Click on the Add Fields button in the top right of the Field Dictionary page.
- In the modal that opens, ensure that the Create New Field tab is selected, then provide the Display Name and Data Type for the new field. An output name may also be specified but is not required.
- Click the Create button in the lower right of the modal, or use the "Save and Create New" button in the lower-left to create another new field after saving the first.
Since Display Names must be unique to a single field in the field dictionary, the create action will fail and error message will be shown if the Display Name of the new field matches that of an existing field.
Defining multiple fields at once
You can also upload a CSV file containing multiple field definitions, which are then processed by the system and added to the Field Dictionary.
To define multiple fields:
- Click on the Add Fields button in the top right of the Field Dictionary page.
- In the modal that opens, ensure the Import Fields tab is selected, and a list of upload instructions is shown.
- Select Next to upload a CSV file with multiple fields. For an example of what to upload, select the Download Sample CSV option in the lower left of the import modal.
- After uploading the CSV file, click the Import button to begin processing the upload. If any errors are encountered processing the file, they will be communicated via a modal with an error or warning message.
- The Import of Existing Fields selection at the bottom of the page simply dictates how the system should handle duplicate fields. Make your selection before clicking Import.
The CSV file must meet the following criteria in order to be properly processed:
- Uploads larger than 1000 rows are not supported.
- Headers for all required columns - i.e. Display Name and Data Type - must be present.
- Optional columns are Output Name, Status, and Field Groups.
- Display Name values must be unique within the file - if multiple rows with the same display name are found in the file, subsequent entries will be skipped.
- Data Type values must match the data types which exist in the system.
- Status values are Enabled or Disabled.
- Field Group values will be matched to existing groups in the system or created if they do not exist. Multiple values should be separated by a semi-colon (;).