Skip to main content

Custom Input Field Management

Standardize how Custom Fields are added throughout the application with central administration of all Custom Fields.

Setup


Navigate to Settings > Configuration > Fields & Lists. The page has two tabs. Custom Fields lists every custom field used throughout the workspace. Predefined Lists holds the shared option lists those fields can draw from.

Custom Fields are currently supported within Part Detail, Item Detail, Issues, Hazards, Work Orders, Purchase Orders, and Risks. Those areas can be added or edited from their respective locations and/or from the Custom Fields central administration.

For Parts, fields are placed on the part form under Builds Settings > Configuration > Forms, rather than

under Custom Fields.

Click the + New Field button to add a new field.

The Field ID is there to help differentiate Custom Fields of the same Display name.

Custom Field types:

  • Text

  • Number

  • Time

  • Date

  • Date Time

  • Checkbox

  • Predefined List

  • Ad Hoc List

  • External Data

  • Records

This will create a new Custom Field definition; however, this will not be applied to any entities automatically. Each field still needs to be added within the settings for the area that will use it.

For Parts, add the field to the part form under Builds Settings > Configuration > Forms. For other areas, use Issues Settings, Risks Settings, and so on.

A custom field marked Required must have a value before the record can be saved from its detail screen.

Custom Fields created within one of the entities will automatically populate within the central management screen.

For example:

""Cal Set Required" was added as a Part Detail with the Field ID of "Part Calibration" and the Field Type of "Text" on the Part form:

That option now displays under the central management screen.

Editing List Options While Authoring


When authoring an entity with a Predefined List or Ad Hoc List field, for example, a procedure or a tool, you can add or change that field's options directly from the authoring page, without navigating to Settings > Configuration > Fields & Lists first.

within a procedure:

within tools:

Editing a Predefined List updates the shared list everywhere it's referenced, while an Ad Hoc List's options apply only to that field.

Values that have already been recorded do not change. An answer keeps the text it was signed off with, and a

renamed option applies to new selections only.

Expressions


Evaluate expressions within a text field to allow for evaluated numbers to be interpolated with text.

Use if/else conditional logic for expressions to change the expression based on the value of another field.

Expressions / logic rules are set for Custom Fields within the Settings of the area they are applied (ie. Builds Settings, Issues Settings, etc)

Edit an existing Custom Field using the 3 Dot menu on the right. This will bring up an edit modal.

Set the Input Method to Expression.

Here you can add Expressions using Math.js similar to Expression fields within a procedure, but referencing other custom fields within the associated module.

The expression can reference another field and simply concat more information as strings even when no math is involved.

Expression Math Syntax Examples

In addition to standard math (+ , - , * , /) there are other functions that can be performed such as abs() for absolute value and round() for rounding.

Check out these links for help with functions and syntax:

Input Logic

Add Input Logic to vary what the input says based on the reference selected.

For example:
If Disposition Option 1 is selected show "Option 1 Mitigation Cycle" if not the result will be different.

On the Issue itself, the results for Issue Type are dependent upon the selection for Disposition.

Display Logic

Set Display Logic to have the field hidden or displayed depending on conditions being met.

In this example, if the weight is entered then the Issue Type field is displayed but if the Weight field is empty, Issue Type is not displayed.

Predefined Lists


A Predefined List is a shared set of options defined once in Settings and available anywhere a Predefined List field is used. An Ad Hoc List is defined on the entity itself and its options apply only to that field.

Navigate to Settings > Configuration > Fields & Lists and open the Predefined Lists tab to create and manage lists.

The option editor

Select a list to open its options. The editor has two panes: the options themselves on the left, and the details of whichever option is selected on the right. Click an option to edit it.

  • Adding options. Add options one at a time, or paste a set separated by commas or line breaks to create several at once.

  • Ordering. Drag an option into position. The order set here is the order shown in every dropdown that uses the list. Dragging is unavailable while a search filter is applied, or while a group is collapsed.

  • Renaming. Click the pencil icon for the option and edit the label in the right-hand pane.

Groups

Group related options under a heading to make a long list easier to scan. Create a group, then drag options into it. Options can be moved between groups, and a group can be renamed or deleted. Deleting a group does not delete its options. They move back out of the group and remain in the list.

Ungrouped options appear after every group.

Groups carry through to the dropdown wherever the list is used, including procedure authoring, run inputs, run tables, and custom fields on issues and other entities.

Descriptions

Each option can carry a short description. Descriptions appear as small grey text beneath the option label while the dropdown is open. They are not shown on the field once it is closed, and a selection has been made.

Archiving options

Archive an option instead of deleting it when it should no longer be selected but has already been used. An archived option:

  • No longer appears in dropdowns for new selections

  • Stays visible everywhere it was already recorded, including run values and procedure default values

  • Can be unarchived at any time, which returns it to the dropdowns

Saving a list

Two rules apply when saving:

  • Option labels must be unique within the list. Labels are compared ignoring capitalization and surrounding spaces, and archived options are included in the comparison. Saving is blocked until each conflict is resolved, and the conflicting options are marked.

  • Numerical values. When “Enable numerical values for expressions” is turned on, every option needs a value before the list can be saved. Turning the setting off clears the values on all options.

Changing a list does not change data that has already been recorded. A recorded answer keeps the text it was signed off with. Renaming, reordering, grouping, or archiving an option affects new selections only.

Import Custom Input Fields


Admins can bulk-import custom field definitions (Settings > Configuration > Fields & Lists) via CSV.

Follow the format in the module when creating the CSV.

Only the following field types can be bulk imported via CSV: Text, Number, Date, Time, Date Time, Checkbox, and Ad Hoc List. Ad Hoc List options must be comma-separated and in quotations in the Ad Hoc List Options column (e.g. "Option One, Option Two, Option Three"). Predefined List and External Data types are not supported for CSV import.

Did this answer your question?