Basic tab

On the Basic tab, the overall settings of the field can be done.

Setting

Usage

Tab

Select the tab under which the part should be placed.

Name

The part name as displayed to the object editor.

Internal name

The unique identifier of a part. Must be unique within the template.

Help text

The text displayed to the object editor to provide help with entering data into this part.

Type

Defines the type of part. See Type of part for a full list and descriptions. Refer to the chapter Part types

Data source

Defines the source from which selectable values are retrieved. Options include:

  • DataStore – retrieves records from a configured datastore.

  • Support groups – lists groups.

  • Documents – lists available documents.

  • Service actors – lists actors

Note: Only DataStore is always available. The other three options (Support groups, Documents, Service actors) are only shown when they are configured and available in the current template.

Parameter

Allows selection of a predefined parameter that filters or modifies the retrieved data. Only available when the selected data source is DataStore.

Key field

Specifies which field in the datastore uniquely identifies the record. Each record must have a unique key value.

Filter type

The Filter type defines how the list of values retrieved from the selected data source is filtered before being shown to the user. Each filter type determines how the filter expression is interpreted and how flexible or dynamic the filtering can be.

Type

Usage

(none)

No filtering is applied. All results from the selected data source are displayed.

Plain text

Filters results based on a fixed, static text value. Useful for simple exact-match or contains filters.

NCalc

Allows the use of NCalc expressions to define dynamic filter rules. Supports references to other parts and advanced logic.

JavaScript

Allows defining filter logic using JavaScript. Useful for complex transformations or conditional filtering based on multiple values.

Filter

Filter type

Filter field content

(none)

Not applicable — the Filter field is disabled.

Plain text

A plain text value used for simple filtering. Examples: • [{ "fieldname": "Department", "filtervalue": "HR" }]

• [{ "fieldname": "Continent", "filtervalue": #REPLACE-PARTVALUE-Continent||# }] • [{ "fieldname": "Email", "filteroperator": "contains", "filtervalue": "gmail.com" },{ "connector": "or", "subfilter": [{ "fieldname": "Email", "filteroperator": "contains", "filtervalue": "company" }, { "fieldname": "Email", "filteroperator": "notcontains", "filtervalue": "john" } ]}]

NCalc

JSON-like filter rules for dynamic filtering. Example: [{ "fieldname": "Continent", "filtervalue": "#REPLACE-PARTVALUE-Continent||#" }]

JavaScript

A JavaScript expression used to filter datastore rows. Example: return record.Department === "HR";

Refer to the chapter Part Filtering for examples

Display field

Defines which datastore field is displayed to the user in the input control (default: same as key field).

Sort field

Defines which datastore field is used to sort the displayed options (default: same as display field).

Help text field

Specifies a datastore field containing contextual help text that appears as a tooltip when hovering over a value.

Value is different per language

When this option is set to Yes, the object editor can enter different content for this part in each available language — only available for text parts.

Essential phase

Specifies the lifecycle phase during which the part is mandatory. Note: Before an object is published, mandatory parts are advisory only. Once published, these parts must have a value.

Default value type

Defines how a default value is calculated. There are three options: 1. Plain Text – a fixed, manually entered value. 2. NCalc – a calculated value using NCalc expressions. 3. JavaScript – a dynamically generated value using JavaScript logic.

Default value

The Default value allows you to pre-fill a part when a new object is created. The behaviour depends on the selected Default value type, which determines how the content is interpreted. - Plain text: fixed text. - NCalc: an NCalc formula. - JavaScript: a JavaScript expression. In all cases, references to other parts can be used.

Default value examples

Refer to the default value chapter

Last updated

Was this helpful?