Managing Custom Field Templates

Required Permissions

Access to this capability requires the following permissions:

 View & Edit

Workstation

→

Custom Fields Templates

Custom field templates can be created, modified, and deleted as necessary.

Creating Custom Field Templates

The Custom Field Templates screen provides the tools necessary for creating custom field templates.

To access the screen:

1. At the top right of Cogynt Workstation's home page, click the Settings cog.
2. From the left side drawer, click Custom Fields.
3. At the top right side of the screen, click the blue + New Custom Field button. A New Custom Field modal appears.
4. Configure the Custom Field Template according to the type you desire.
5. If creating a select, checkbox, or multichip custom field, set up any field options.

note

When creating a new custom field template, a default Field Name is generated. Field Name has a 50-character limit and outputs a specific name to the custom field template when used in a collection.

Editing Custom Field Templates

Attributes of custom field templates can be changed as needed. It is also possible to change the following custom field template types:

• From text (plain text) to rich text.
• From select menu to checkbox or multichip.

These fields cannot return to their old value, and no other fields can be changed.

To edit a custom field template:

1. From the Custom Fields page, locate the custom field template to edit.
2. Click the Edit button to edit the field.
3. In the Edit Custom Template modal, modify any value or any field options as appropriate.
4. Click the Submit/Save button to save the edits, or Cancel to discard them.

Deleting Custom Field Templates

If a custom field template needs to be removed, or was created by mistake, it can be deleted.

To delete a custom field template:

1. In the Custom Fields screen, locate the custom field template to delete.
2. Click the trash can icon (🗑) and confirm deletion, or click Cancel to discard changes.

warning

Any references to deleted templates are removed from all collections that utilized them.

Field Options and Values

Field options must be defined for the select, checkbox, or multichip custom field types.

Each field option contains an Option Label field and an Option Value field, although only the option label is required.

The Option Label field outputs as a list item for the collection analyst to select or interact with.

The Option Value field applies the desired value to the option label it is associated with.

Adding Field Options

To add a new field option:

1. In the Edit/New Custom Field modal, next to Field Options, click the + button.
2. In the Option Label field, enter the desired option label.
3. In the Option Value field, enter a value to assign to the Option Label if desired.

Deleting Field Options

If a field option needs to be removed, or was created by mistake, it can be deleted.

To delete a field option:

1. In the Edit Custom Field modal, locate the Field Option to delete.
2. Click the trash can icon (🗑) and confirm deletion, or click Cancel to discard changes.

warning

Any collections that use a deleted custom field option will lose reference to it.

Re-Ordering Field Options

To re-order field options:

1. On the Custom Field Templates screen, in the Edit Custom Field modal, hover the mouse cursor over the move icon next to the field option. The cursor changes to a hand icon.
2. Click and drag to re-order field options.

Grouping Custom Fields

It can become necessary to group similar custom field templates together for readability and navigation. To do so, start by adding groups, then assign custom fields to each group as needed. To create, edit, or delete custom field groups, users should have View and Edit permissions for Custom Field Templates.

Similar to reordering custom field templates and custom field options, drag to reorder groups. The order of groups and custom fields from the Designer screen is reflected in the custom field templates used in collections.

Creating Custom Field Groups

To create a custom field group:

1. At the top of the Custom Fields screen, click + New Group.
2. In the right side column, enter a Field Group Name. By default, the group name My New Custom Field Group is used.
3. Click Submit/Save to create the group, or Cancel to discard it.

Adding Custom Fields to Groups

Once a group is created, custom fields can be added to it.

To add custom fields to groups:

1. In the Custom Fields page, locate the custom field template to add to a group.
2. Hover over the custom field. The cursor changes to a hand icon.
3. Drag the custom field into the group it should be added to.
4. Click Submit/Save to add the custom field template to the selected group, or Cancel to discard it.

Editing Custom Field Group Names

The custom field group name can be changed anytime.

To edit custom field groups:

1. In the Custom Fields page, locate the custom field group to edit.
2. Click the Edit icon.
3. In the modal, enter a new Field Group Name.
4. Click Submit/Save to confirm changes to the custom field group name, or Cancel to discard those changes.

Deleting Custom Field Groups

Delete a custom field group to remove it. Deleting groups only removes the group, not any custom field templates within the group.

To delete custom field groups:

1. In the Custom Fields page, locate the custom field group to be deleted.
2. Click Delete and then confirm deletion, or Cancel to stop the operation.

Re-Ordering Custom Field Templates

The order of templates listed on the Custom Fields screen can be altered to affect how other users see the list of templates. It can be efficient to move recently created or highly used custom field templates to the top of this screen.

To re-order custom field templates:

1. In the Custom Field Templates column, hover the mouse cursor over any custom field template. The cursor changes to a hand icon.
2. Click and drag to re-order custom field templates. Reorder field templates within groups as well.

At the bottom right of the screen, a green toast indicates that custom fields have been successfully re-ordered.