Skip to end of metadata
Go to start of metadata

Metadata template fields are essential components of the metadata templates. The list of metadata template fields for a given metadata template can be listed by clicking on the Metadata Template Fields tab on the Metadata Template Configuration page.

Creating a metadata template field

You can create a new metadata template field by clicking on the Add New Metadata Template Field link on the Metadata Template Configuration page. After selecting the link, the following page is opened.

The following table describes the available fields:

 

Field

Description

Requirements
Display NameThe displayed name of the custom field variable. It is displayed on the web interface for the users.

Required field
Minimum length: 3
Maximum length: 128 

Field IdentifierUnique identifier of the field used by external applications to refer to the field through the API.

Required field
Minimum length: 3
Maximum length: 128
Must be unique in the system

The field cannot contain special characters and spaces, only alphanumerical characters including underscore (_) or dash (-) can be used.

Property IdUnique identifier of the property mapped to the metadata field. The built-in templates for the various integration use this identifier to map the source data to a metadata field.-
Enable API AccessIndicates whether external applications can access/write this field or not. If you want to insert information into this field by an external application, this option has to be enabled.-
EditableIf enabled, users can edit/modify the content of the field on the web interface.-
PrivateBy default, all custom fields are public, which means that the content of the field is available for anyone in the system, who has access to the call itself. If the private flag is enabled on the custom field, then only the user, which filled in the data in the field can edit the content of the field. API driven fields cannot be private.-
Type

Type of the custom field variable. The following valid values apply:

  • Text
  • Numeric
  • Date
  • Boolean

Note: all values are stored as string variables in the database to avoid discrepancies and incompatibility, however in order to provide sophisticated search controls and operators, the system has to know the type of the data inserted into the custom field variable. E.g. for numerical fields, users can use "Greater Then" or "Less Then" operators.

-
Appearance

Defines the way how the custom field is displayed on the user interface. The following valid values apply:

  • Single-line Input Box
  • Multi-line Input Box
  • Selection List
  • CheckBox.

The type of the custom field defines the available appearance options.

  • Numeric: Single-line Input Box, Selection List
  • Text: Single-line Input Box, Multi-line Input Box, Selection List
  • Date: Single-line Input Box
  • Boolean: CheckBox
-
Maximum Number of Characters on the Search ScreenDefines the maximum number of characters displayed on the search screen. If the value is longer then this value, the system will display '...' at the end of the text. 
Display in New Row(s) Instead of in a ColumnBy default, the field is displayed as a new column on the search screen (when the field is added to the conversation list layout). By enabling this option, the field will be displayed as a new line instead of a column. This is especially useful when the field can contain long text. 
Display Values in One RowWhen enabled, the multiple values in the field are displayed as a single line separated with ',' (comma) instead of displaying the values in new lines. 
Mapped ID/Name ValuesDefines if the items for Selection List type fields should be displayed based on a matching ID. 
Items

If the appearance is set to Selection List, the list of pre-configured items can be defined, which are automatically offered for the user. The items have to be added separated by ';' (semicolon).

If the Mapped ID/Name Values setting is enabled, both the ID and the Name have to be defined. When a value is added to the field as an ID, the system will look for the matching Name attribute, which will be used for displaying the value.

 

 

After filling out the form, press the Save button to save metadata template field data in the database.

Modifying and deleting metadata template fields

To edit a metadata template field entry, you have to click on the desired row of the table showing registered metadata templates. After clicking on the row, a new page opens automatically.

To make changes effective, push the Save button. All conditions, which are described in the previous part, have to be met.

You can delete the metadata template field by clicking on the Delete button. Metadata Template Fields can only be deleted if they have not been attached to a recorded call and are not part of a default template field.