To define a custom field, you need to add a customFieldDefinitions array to your IrisX App manifest:

  customFieldDefinitions: [
    {
      type: 'STRING',
      entityType: 'ASSET',
      key: 'myKey',
      translations: [{
        language: 'en',
        title: 'String Field',
        description: 'String Field Description',
      }],
      uiEditable: true,
      uiVisible: true,
      scopeType: ScopeType.ACCOUNT
    }
  ]

type defines the custom field type (see below for all options).
entityType defines what type of entity a custom field can be used on. The following types are available:

ACCOUNT
ASSET
GROUP
SITE

key defines the programmatic name of the field and cannot be changed after it has been created.
translations defines the languages, and the UI visible name and description of the field in each of the languages.
uiEditable / uiVisible controls how the field will be shown in the Manager UI. This does not limit how the field is used inside the IrisX App.
scopeType controls who can access the field values. Default is only within the users account.

Apart from the these standard properties, some field types have extra properties defined below.

All custom fields defined by an IrisX App will be owned by the IrisX App, and the IrisX App developer should consider existing data when changing field definitions.

Custom field types

Field type	Description	Extra properties
BOOLEAN	Boolean value that can store true or false.
DATE	Date stored in ISO8601 format.
DROPDOWN	A predefined list of options. Supports both single and multi selects.	`allValues`, `multiSelect`, `dropDownValueReplacements`
EMAIL	Email field. Will be rendered with a mailto link in the UI.
NUMBER	Numeric values	`minimum`, `maximum`, `isInteger`
PHONE_NUMBER	Phone number stored in E.164 format. Validated using Google libphonenumber.
STRING	Free text field	`minimumLength`, `maximumLength`, `pattern`
WEB_ADDRESS	Web address. Will be shown as a link to open a new window in the UI.
JSON	JSON values.
MONETARY	Monetary values with currency in ISO 4217 standard.	`minimum`, `maximum`

Scope types

Scope type	Description
ACCOUNT	Values with account scope will be shared within a single account
ACCOUNT_WRITE_GLOBAL_READ	Updating values will be possible within a single account and visible to all accounts (read)
GLOBAL	Values with global scope will be shared between all accounts with access to the entity

Type specific properties

Property	Field type	Required	Description
`maximum`	NUMBER	No	Maximum numeric value
`minimum`	NUMBER	No	Minimum numeric value
`unitSi`	NUMBER	No	Unit used for users using SI Customary system of measurement
`unitUs`	NUMBER	No	Unit used for users using US Customary system of measurement
`isInteger`	NUMBER	No	Disallow decimal values. Can't be true if `unitSi` or `unitUs` is specified
`maximumLength`	STRING	No	Maximum length of the text
`minimumLength`	STRING	No	Minimum length of the text
`pattern`	STRING	No	The allowed regular expression. Syntax is documented here.
`allValues`	DROPDOWN	Yes	All allowed values
`multiSelect`	DROPDOWN	No	Allow multiple options to be selected. Default `false`
`valueReplacements`	DROPDOWN	No	Map from old values no longer allowed to new values. Used for updating existing data
`currency`	MONETARY	yes	Currency in ISO 4217 standard

📘
Nice to know
All custom fields defined by an app will be owned by the app, and the app developer should consider existing data when changing field definitions.