Manage model inventory fields

Published

November 20, 2024

Create and edit 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

Add or edit inventory fields

  1. In the left sidebar, click Settings.

  2. Under Workspace Settings, select Model Inventory Fields. Here you can edit existing inventory fields, or add a new one:

    • To add a new field, click Add New Field.
    • To edit an existing field, select Edit under the Actions column for the desired field.

  3. Fields require a type,2 a name, and a description.

    You can also choose to indicate that a field is required on registration.

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

Inventory field types

Single Line Text
Simple text value.
Attachments
Upload supporting files for your model.3 Files must be less than 50 MB each in size.
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.

A screenshot showing a simple number field type

Simple number field type

A screenshot showing a currency number field type

Currency number field type
URL
Text value in valid URL format.
Date
Date value in yyyy-mm-dd format.
Date Time
Date value in yyyy-mm-dd, 24hr format.
Email
Text value in valid email (user@domain.com) format.
User
  • Select list pre-populated with users from your User Directory.4
  • Toggle allow linking to multiple records on to allow multi-selection of 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:

A screenshot showing the screen for adding a calculation type field

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"

Delete inventory fields

  1. In the left sidebar, click Settings.

  2. Under Workspace Settings, select Model Inventory Fields.

  3. Select Edit under the Actions column for the field you’d like to delete.

  4. Click Delete.

    After you confirm, the field will be removed.

What’s next