tiCrypt 2.18.1

Custom Fields

Prerequisites

User Role:

Sub-admin, Admin, Super-admin

Permission Requirements

• User Administration
  • View user profiles (permission templates)
  • Create and edit user profiles

A custom field is an extra input, defined by your institution, that appears in the team or project create and edit forms, such as a grant number or an IRB approval number. Each custom field belongs to either teams or projects and has a type: text, number, date or a list of choices. Custom fields are not System Settings: they add data to individual teams and projects instead of changing how the system behaves.

Permissions

The Custom Fields item appears for everyone who can open Management. tiCrypt stores custom fields with the global settings that also hold user profiles, so the backend reads them with View user profiles (permission templates) and saves changes only with Create and edit user profiles.

Deleting a custom field cannot be undone

Deleting a custom field is a permanent action and cannot be undone.

View Custom Fields in Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Settings section.
3. Click Custom Fields in the left panel.

The page has a Teams section and a Projects section. Each has an Editor column, with one card per field and an Add button at the bottom, and a Preview column that shows the fields as they appear in the form.

Each field card shows:

• Label: the label of the field.
• Summary: the type and rule, as "Text field • <rule>", "Number field • <rule>", "Date field" or "Choice field • N choices".
• ID line: "ID: <id>, optional" or "ID: <id>, required".
• Buttons: the edit button and the delete button.

Every change on this page, including dragging a card, saves immediately. If a save fails, tiCrypt shows "Failed to save changes".

Custom Field Dialog

The following table describes the fields of the custom field dialog.

Field	Description
ID	Required. Up to 20 characters, with no spaces and none of / \ | " : * ? < > { }. It must be unique among the fields of the same section. The hint reads "The ID is for tracking purposes, and will not be shown."
Optional input*	Optional or Required. You must pick one.
Data* > Type	Text input, Number input, Date selector or Custom select.
Format rule (Text input)	String, Email or Phone number (10 digits, dashes optional).
Format rule (Number input)	Integer or Decimal.
Minimum value (optional), Maximum value (optional) (Number input)	The lowest and highest accepted number.
Custom Choices (Custom select)	The choices. Type a choice and press Enter to add it; drag the choices to reorder them. Each choice has up to 60 characters and none of / \ | " : * ? < > { }. At least one choice is required ("You must enter at least one choice").
Visual elements > Label	Required. The text above the input, up to 60 characters, with none of / \ | " : * ? < > { }.
Placeholder (optional)	Text shown in the empty input, up to 60 characters, with the same character limits.
Hint (optional)	A short message under the input, up to 60 characters, with the same character limits.

A Date selector has no extra fields. Below the fields, "Preview of the custom field" shows the field as users will see it.

Create a New Custom Field for Teams

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Settings section.
3. Click Custom Fields in the left panel.
4. In the Teams section, click the Add button at the bottom of the Editor column.
5. In the pop-up, enter the field ID, optional input, type, label, placeholder and hint.
6. Click Create.

Result: The field appears in the Teams section and in the team create and edit forms.

caution

Creating a mandatory custom field requires users to complete that field in every team. Teams cannot be saved or updated if the field is left blank.

Create a New Custom Field for Projects

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Settings section.
3. Click Custom Fields in the left panel.
4. In the Projects section, click the Add button at the bottom of the Editor column.
5. In the pop-up, enter the field ID, optional input, type, label, placeholder and hint.
6. Click Create.

Result: The field appears in the Projects section and in the project create and edit forms.

caution

Creating a mandatory custom field requires users to complete that field in every project. Projects cannot be saved or updated if the field is left blank.

Create a Number Input Field

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Settings section.
3. Click Custom Fields in the left panel.
4. Click the Add button at the bottom of the Editor column in either the Teams or Projects section.
5. In the pop-up, set the type to Number input.
6. Enter the field ID, optional input, label, placeholder and hint.
7. Under Format rule, select Integer or Decimal.
8. Optionally, enter a Minimum value (optional) and a Maximum value (optional).
9. Click Create.

Result: The field accepts only numbers that match the format rule and fall within the minimum and maximum.

Create a Date Input Field

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Settings section.
3. Click Custom Fields in the left panel.
4. Click the Add button at the bottom of the Editor column in either the Teams or Projects section.
5. In the pop-up, set the type to Date selector.
6. Enter the field ID, optional input, label, placeholder and hint.
7. Click Create.

Result: The field shows a date picker.

Create a Fully Custom Field

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Settings section.
3. Click Custom Fields in the left panel.
4. Click the Add button at the bottom of the Editor column in either the Teams or Projects section.
5. In the pop-up, set the type to Custom select.
6. Enter the field ID, optional input, label, placeholder and hint.
7. Under Custom Choices, type each choice and press Enter. Drag the choices to reorder them.
8. Click Create.

Result: The field shows a list with the choices in the order you set.

Edit an Existing Custom Field

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Settings section.
3. Click Custom Fields in the left panel.
4. Click the edit button on the field card.
5. In the pop-up, edit the field's optional input, format rule, label, placeholder and hint.
6. Click Update.

Result: The field card and the Preview column show the change.

note

The field ID and type cannot be edited after the field is created.

Arrange Existing Custom Fields in Prompt

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Settings section.
3. Click Custom Fields in the left panel.
4. Click and hold the Move handle on the field card.
5. Drag and drop the field card into the appropriate position.

Result: The new order is saved immediately and used in the team or project forms.

info

You cannot mix team field cards with project field cards.

Change Preview of a Custom Field

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Settings section.
3. Click Custom Fields in the left panel.
4. Under the Preview column, enter the preview input for each field.

note

Preview inputs depend on the field type, such as text, number, date, or custom.

Delete a Custom Field

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Settings section.
3. Click Custom Fields in the left panel.
4. Click the delete button on the field card.
5. In the pop-up, click Delete custom field.

Result: The field disappears from the team or project forms, tables and details.

Deleting a custom field cannot be undone

Deleting a custom field is a permanent action and cannot be undone.

Where Custom Field Values Appear

• Forms: each field appears in the team or project create and edit forms, in the order of the Editor column.
• Tables: each field adds a column to the Teams or Projects table in Management.
• Details: the team or project detail pane has a Custom fields card with one line per field, showing "Not set" when the field has no value.

Related

• Teams: where team custom fields are filled in and shown.
• Projects: where project custom fields are filled in and shown.
• System Settings: the deployment-wide settings in the same Settings section.