Skip to main content

Custom Fields

Introducing Custom Fields​

By default, the Alice T&S platform is provided with a wide variety of fields to describe your items. The Alice T&S platform enables your organization to add additional customized fields that describe the items to be analyzed in order to detect violations. For example, you might define a new Custom Field named Subscription, which can have one of the following values – Premium, Basic or Free.

Editable and Collected Custom Fields​

Two types of Custom Fields can be created on the T&S platform using an API – Editable (by a moderator) and Collectible (read-only). Both types of Custom Fields will appear throughout the T&S platform user interface after they are created, meaning that they can be defined to appear in the item data of Moderation Views and can be used to define all types of filters. Custom Fields can also be used to build Automated Workflows based on their values.

The difference between the two types of fields is as follows –

  • Editable Custom Fields – The values of Editable Custom Fields can be entered and changed by a moderator in a Moderation View. This means that a T&S manager is free to define these fields and to implement all their functionality without needing any programmatic support, although editable fields values can also be sent through an API request While defining Editable Custom Fields (as described below), To edit a field right click the cell you want to edit or click the floating icon cog on each row, as shown below –

cog

  • Collected Custom Fields – These custom fields are read only, and can not be edited from within the moderation view. This option is useful when you want to send data via API but don't want the moderator to edit it.

Adding Custom Fields​

To define Custom Fields –

  1. Click the Account Settings cog button that appears in the top right corner of the Alice T&S page.

  2. Select MODERATION CAPABILITIES and then select Custom Fields. The following displays listing the Custom Fields that were defined –

cog

By default, the EDITABLE list of that is displayed. Clicking the Collected tab displays the list of Collected Custom Fields that have been defined.

  1. To add a new field, click the Add Field button. The following displays –

cog

Defining a Collected Custom Field​

To define a Collected Custom Field –

  1. Display the Choose Custom Field type window, click on the COLLECTED option and then the Next button to specify that this field will be created in the T&S platform be ready to be populated via API. The following displays –

cog

  1. In the Title field, enter any free-text name. This name appears as the name of this Custom Field and as title of this field’s column in the Moderation View. This field can include spaces.

  2. In the Key field, enter any free text name for this key. This name appears as the name of this field in an API request to the T&S platform. Spaces and periods (.) are not permitted. Underscores (_) and dashes (-) are permitted.

  3. From the Type dropdown menu, select the data type of the Custom Field, which can be Text, Number, Date or Boolean (true/false).

Note – The data type of fields sent to the Alice T&S platform in a Custom Field will be verified and if incorrect, an error is generated.

The T&S platform will also validate the data type received in API requests accordingly.

  1. Click the Finish button. The following displays listing the Collected Custom Fields that have been defined –

cog

Clicking the cog button enables you to edit or delete the definition of a Custom Field.

  1. You can now push data to the Alice T&S platform. For additional information on how to send data through API, check the API documentation.

Defining an Editable Custom Field​

To define an Editable Custom Field –

  1. Display the Choose Custom Field type window, click on the EDITABLE option and then the Next button to specify that this field will be created in the T&S platform and its value can be entered/modified by a moderator in the Moderation View. The following displays –

cog

  1. In the Title field, enter any free-text name. This name appears as the name of this Custom Field and as title of this field’s column in the Moderation View. This field can include spaces.

  2. In the Key field, enter any free text name for this key to be used as an internal identifier of this field in the T&S platform. Spaces and periods (.) are not permitted. Underscores (_) and dashes (-) are permitted.

  3. From the Type dropdown menu, select the data type of the Custom Field, which can be Text, Number, Date, Boolean (true/false) or Dropdown.

Note – The data type of fields entered by a moderator in a Moderation View are verified and if incorrect, an error is displayed.

  1. An additional field for entering the default value of this Custom Field is displayed according to the data type that you selected in the Type field (as described above). The following is an example of a Text Type field.

cog

  1. In the Tooltip field, enter the text to appear when a moderator hovers over this Custom Field in a Moderation View. For example, the following displays when you select the Dropdown option in the Type field, so that you can enter the tooltip.

cog

  1. In the Add values to dropdown area, type in multiple values to appear in the dropdown menu. Press the Enter key after you enter each one, which displays it in its own box, as shown below –

cog

Note – You can click cog to delete a value that you entered.

  1. Click the Finish button. The following displays listing the Editable Custom Fields that have been defined –

cog

  1. Clicking the cog button enables you to edit or delete the definition of a Custom Field.

These fields are now available to be added to Moderation Views ot to the api using the View Configuration option. For example, as shown below –

cog