Manage model inventory fields

Manage the fields that appear on all models in your model inventory. Choose from an array of field types with different properties and use cases.

Prerequisites

• You are logged in to ValidMind.
• You are a Customer Admin or assigned another role with sufficient permissions to perform the tasks in this guide.¹

¹ Manage permissions

Add or edit inventory fields

1. In the left sidebar, click Settings.

2. Under Models, select Model Inventory Fields.

   Here you can edit existing inventory fields, or add a new one:

Add field

To add a new field, click Add Field:

1. Fields require a type,² a name, and a description.

   • (Optional) You can also choose to indicate that a field is required on registration.
   • (Optional) You can also assign a field to a group.³
   • Assign write permissions to allow granular access to editing this field gated by model stakeholder types.⁴

2. When you are satisfied with the setup of your field, click Save.

² Field types

³ Add groups

⁴ 

Leave this field blank to leave permissions as default.

• By default, only the
  Customer Admin role has write access.
• All other users will have read-only access unless specified under the write permissions as a model stakeholder type.

Manage model stakeholder types

Edit field

To edit an existing field:

1. Hover over the field you would like to edit.

2. When the appears under the Actions column, select Edit Details.

3. Make your desired changes to your field, then click Save.

Inventory field types

Single Line Text

Simple text value.

Attachments

Upload supporting files for your model.⁵ Files must be less than 50 MB each in size.

⁵ Manage supporting documentation

Long Text

Toggle Enable rich text formatting to create a template using the rich text editor.

Single Select

Click Add Option to define a list of options.

Multiple Select

Click Add Option to define a list of options.

Checkbox

A true/false value set by a toggle.

Number

Text value in valid number format. Number display (comma, fullstop, etc.) is determined by your browser’s locale. Select a number type:

• Simple — Define the decimal places that the number should be displayed up to and any large number abbreviations.
• Currency — Define the currency you would like the field to display in, as well as the decimal places that the number should be displayed up to and any large number abbreviations.

Simple number field type

Currency number field type

URL

Text value in valid URL format.

Date

• Date value in yyyy-mm-dd format.
• Selection is in the current user’s timezone; other users viewing this field will see the value automatically in their timezone.
• Set the date format for date fields under your profile.⁶

⁶ Manage your profile

Date Time

• Date value in yyyy-mm-dd, 24hr format.
• Selection is in the current user’s timezone; other users viewing this field will see the value automatically in their timezone.
• Set the date format for date time fields under your profile.⁷

⁷ Manage your profile

Email

Text value in valid email (user@domain.com) format.

User

• Select list pre-populated with users from your User Directory.⁸
• Toggle allow linking to multiple records on to allow multi-selection of users.

⁸ Manage users

Calculation

Define a formula(params) function that automatically calculates and returns a value based on the params dictionary, which includes selected custom field keys retrieved from your other inventory model fields.

1. Click in front of the inventory field to allow your formula access to the field’s values.
2. Replace the demonstration formula with your own in the code box provided.
3. Enter in sample values in the testing area then click Test Formula to validate your formula.

Stick to basic operations.

Keep your code simple and avoid complex logic and imports.

For example, say you have numeric model inventory fields of materiality and complexity, where a larger value indicates a lower risk:

Adding a calculation type field

    def formula(params):
        # High Risk: If materiality is high risk, return high risk regardless of complexity
        if params.materiality == "High Risk":
                return "High Risk"
        # Medium Risk: If materiality is low risk but complexity is high risk, return medium risk
        if params.materiality == "Low Risk" and params.complexity  == "High Risk":
                return "Medium Risk"
        # Low Risk: Both materiality and complexity are low risk
        return "Low Risk"

Search and filter existing inventory fields

1. In the left sidebar, click Settings.

2. Under Models, select Model Inventory Fields.

3. Narrow down existing inventory fields available to your models by searching or filtering for results:

Note that searching and filtering of fields stack.

For example, if you first search by keyword for date under Title without clearing that search, any additional filters applied will only apply to the results returned by that initial search.

Search fields

1. Click Search to search by keywords within an inventory field.

2. Select whether to search in the Title or Description.

3. Click Search to narrow down your results by your entered keywords.

Filter fields

1. Click Filter to filter fields by any of the following criteria:

   • required on registration — Whether or not the field was set up as required on model registration.
   • types — What type of field it is.⁹
   • workflow triggered by field — What workflows are initiated when this field is edited.¹⁰
   • write permissions — Which model stakeholder types have permissions to edit this field.¹¹

2. Click Apply Filters to narrow down your results by your configured criteria.

⁹ Inventory field types

¹⁰ Configure model workflows

¹¹ Manage model stakeholder types

Add inventory field groups

To group model inventory fields, first create an inventory field group:

1. In the left sidebar, click Settings.

2. Under Models, select Model Inventory Fields.

3. Click Add Group and enter in a name and a description for the group.

4. Click Create Group to add the new group.

5. Assign the desired fields to the group.¹²

¹² Add or edit fields

Delete inventory fields

1. In the left sidebar, click Settings.

2. Under Models, select Model Inventory Fields.

3. Hover over the field you would like to delete.

4. When the appears under the Actions column, click on it and select Delete Field.

5. After you confirm, the field will be removed.