Skip to main content

Domains

Introduction to domains

Domains are abstract data types, used to indicate the data type of columns and parameters. Changing a domain will update all columns and parameters that use this domain. Depending on the database management system, user-defined data types or reference-fields are created for domains to be used in SQL business logic.

Create a domain

menu Data > Domains > tab Form

  1. Enter a Domain name.

  2. Select a Data type.

  3. If mandatory or necessary, enter constraints to limit the possible input:

    • Length.
    • Scale.
    • Min. value and Max. value.
    • Elements - to offer the user a pre-defined selection.
tip

These are static constraints that will be applied to the database (stored data will be checked). Data will also be checked by the UI and the API. However, if a domain with a constraint is used in, for example, a view or a task, a database constraint cannot be applied, (though the UI and API will still check the input). To use a dynamic constraint instead, see Add dynamic domain input constraints.

  1. Enter the User interface settings:

    • Select the Control that should be used to visualize the columns and parameters in the user interface, for instance as a text field, an image or a checkbox.

    • Alignment - Alignment in the grid (left, right, or center). The numerical alignment for the entire form can be set with the Extended property: FormAlignmentOfNumbers.

    • Universal GUI Word wrap is available for a Multiline control. If checked, the text will wrap to the next line when it reaches the end of the field. Newlines are retained. In edit mode, word wrap is not applied.

      Note that the row height is not determined by the column's content. See: Row height.

  2. The Default value type can be a 'Constant value' or an 'Expression'. An expression can fill any new or changed column during the upgrade.

  3. If necessary, enter the tab Default settings:

Overview of the Domains screen

Adding elements to a domain Adding elements to a domain

Add dynamic domain input constraints

Universal GUI Indicium

When creating domains, it is possible to add some static constraints (minimum and maximum values or lengths and a pre-defined selection (Elements)).

Input constraints are a more dynamic extension of these domain constraints. These are simple checks on entered data at the domain level, similar to the minimum and maximum values or lengths. Data stored on the database will not be checked, but the UI and API will not accept unallowed input and not process it.

Things you need to know before you add a dynamic input constraint:

  • Input constraints are applied to columns, task- and report parameters, and deep-link process variable input.
  • They are only applied to user input, not to the database.
  • Existing records are not subject to the constraints.
  • When a column receives a value programmatically, it will not be checked against the input constraints. A programmatical value is received, for example, through copying a record, default values, input mapping in process flows, detail- or look-up context propagation, task binding, drag-drop binding, default logic, and so forth.
  • Input constraints are checked only at the moment of input. This allows using date/time-sensitive input constraints, such as planned_date > sysdatetime(), without the problem that updating the record later will make this constraint fail. That is, as long as the planned_date is not modified, it will not be re-checked.
  • A regex will be matched on the input and does not have to refer to the value.
  • An input constraint can be translated. Multiple input constraints on domains can share a translation using the same ID. The translation will be shown to the user when breaking the constraint.

To add an input constraint to a domain:

menu Data > Domains > tab Input constraints

  1. Select a Domain.

  2. In the field Input constraint, enter a name.

  3. Select a Constraint type:

    • SQL expression - To evaluate the entered data with an SQL expression. An SQL input constraint can refer to the input value using the domain ID as a column alias, optionally prefixed with t1 and quoted if needed. For instance, t1.[planned_date] > sysdatetime(). It is rare to have an SQL input constraint that does not refer to the input value.
    • Regular expression - To evaluate the entered data with a regular expression.
  4. Select a Timing:

    • Immediate - Data will be evaluated while entered into the field. Only available for regular expressions as these can be verified directly by the UI.
    • On change - Data will be evaluated before it is processed further, usually when the cursor leaves the field.

    Both constraints prevent the value from being processed, and further logic, such as defaults, layouts, expressions, and look-ups, will not be executed with the entered value. The sequence is always in the context of constraint timing. Immediate is always verified before On change.

  5. Select a Sequence no. If you use multiple input constraints for the same domain, the sequence determines the order in which they are evaluated.

  6. Enter the Expression that has to be used to evaluate the data. It has to match the syntax of the selected Constraint type.

input constraints Input constraints for a domain

Make columns created with a domain mandatory

You can indicate that columns using a domain will be mandatory by default. New columns created with this domain will be mandatory by default. This can be adjusted per column.

menu Data > Domains > tab Form > tab Default settings

  1. In the group Column, select the checkbox Mandatory.
note

If a checkbox is set to mandatory, it may give users the impression that they have to select it, even if they do not want to. To address this issue, you can set the checkbox to a default state of 'null' (indeterminate) using the extended property AllowNullMandCheckbox. After a user selects an indeterminate checkbox, the mandatory indicator disappears.

Use columns created with a domain for optimistic locking

You can indicate that columns using a domain will be used for optimistic locking by default. This can be adjusted per column. Most domains can be marked manually, according to your preferences. Only if it has the datatype ROWVERSION, Use for optimistic locking will be selected by default. If the domain with datatype ROWVERSION is used for a column, the column will also be hidden by default and set as the last column.

The other columns have no effect on the optimistic locking.

menu Data > Domains > tab Form > tab Default settings

  1. In the group Column, select the checkbox Use for optimistic locking.

Set the field height

You can set the height in rows for a form field. This is particularly useful when dealing with large amounts of text that span multiple lines. Be aware that the outcome may differ between the Windows GUI and the Universal GUI, as Windows screens are oriented horizontally while Universal GUI screens are vertical.

menu Data > Domains > tab Form > tab Default settings

  1. In the group Column, fill in the field Field height in positions.

Make a domain unavailable

It is possible to mark a domain element as 'unavailable'. This way, it won't be shown in the drop-down, so it can't be selected for future entries. This setting doesn't affect older or historic entries. For these, the domain element is still available.

menu Data > Domains > tab Elements > tab Form > tab Element

  1. Uncheck the Available checkbox.

Configure read-only display settings in edit mode

Universal GUI

You can configure how a read-only field will be displayed in edit mode.

Data > Domains > tab Form > group User interface

The rendition of a read-only field depends on the setting Read-only input control:

Read-only input controlRendition
Selected (default)Disabled input control
ClearedPlain text label

Show or hide the action button for read-only fields

menu Data > Domains > tab Form

Some fields are always read-only, used only to show data. The Show action button option allows you to hide the action button for that domain. There are three options:

  • Never: the action button is hidden.
  • When editable: the action button is only displayed if the field is editable.
  • Always: the button is always displayed.

Control with action button Always Control with action button set to Always

Controls

Available domain controls

Using a control, you can specify how a column should be displayed in the user interface.

menu Data > Domains > tab Form > tab Domain

  1. In the Control field, select the domain.

The following options are available:

ControlDescriptionPlatformSQLORACLEDB2
Barcode scanner Text input with a barcode scanner.UniversalVARCHARVARCHAR2VARCHAR
CalculatorShows a calculator for performing calculations.AllINT, NUMERICINT, NUMERICINT, NUMERIC
CheckboxGives the possibility to check a checkmark. The value can be on, off or unknown.AllBIT, TINYINT, SMALLINTSMALLINTSMALLINT
Code editorHighlights the syntax for data in JSON or XML format.All
ColorSelecting a color.AllINTINTINT
ComboSelecting a value from a list.AllDepending on elementsDepending on elementsDepending on elements
Copy to clipboard (form)Copy the field's value to the user's clipboardWindows/UniversalCharacter-basedCharacter-basedCharacter-based
Cortex decoderText input with a barcode scanner.UniversalVARCHARVARCHAR2VARCHAR
CurrencyFor compatibility, use NUMERIC.AllNUMERICNUMERICNUMERIC
DateDisplays a calendar in which a date can be entered.AllDATE, DATETIMEDATE, TIMESTAMPDATE, TIMESTAMP
DatetimeDisplays a calendar for selecting the date and a time format in hours, minutes, and seconds.AllDATETIMETIMESTAMPTIMESTAMP
Datetime shortDisplays a calendar for selecting the date and a time format in hours and minutes (no seconds).UniversalDATETIMETIMESTAMPTIMESTAMP
EmailOpening an email program with email address as send to.AllVARCHARVARCHAR2VARCHAR
File linkWhen adding or editing a file, the location can be selected.
Universal GUI For use in a 3-tier environment, see File link.
Windows/WebVARCHARVARCHAR2VARCHAR
File uploadUploading and downloading a file. The Storage location is used when files are uploaded.AllVARCHARVARCHAR2VARCHAR
Folder linkSelecting and opening a folder.
Universal GUI For use in a 3-tier environment, see Folder link.
Windows/WebVARCHARVARCHAR2VARCHAR
Google mapsOpening Google maps based on a location.Windows/WebVARCHARVARCHAR2VARCHAR
Group header icon (form, read only)Creates an icon in front of the group header labelAllVARCHARVARCHAR2VARCHAR
Group header label (form, read only)Creates a header label from your own dataAllVARCHARVARCHAR2VARCHAR
HtmlText is displayed as HTML.AllNVARCHARNVARCHAR2/NCLOBVARGRAPHIC/DBCLOB
Image comboSelecting an image from a list.
See also
- Domain elements
- Name in tooltip
AllDepending on elementsDepending on elementsDepending on elements
Image linkSelecting and displaying a photo.AllVARCHARVARCHAR2VARCHAR
Image uploadUploading a photo.AllVARCHARVARCHAR2VARCHAR
Label (form, read only)Creates a label without a fieldAllVARCHARVARCHAR2VARCHAR
LocationDisplays a location pin to collect GPS coordinates (latitude, longitude). See LOCATION controlUniversalVARCHARVARCHAR2VARCHAR
MultilineEditing a text with several lines, possibly via a separate pop-up screen.AllVARCHARVARCHAR2VARCHAR
Numeric (thousands separator)Displays numbers with a comma for thousands.AllNUMERICNUMERICNUMERIC
PasswordThe text is replaced by an asterisk.AllVARCHARVARCHAR2VARCHAR
PercentageDisplays numbers as a percentage.AllINT or NUMERICINT or NUMERICINT or NUMERIC
Phone numberText with link to open a phone applicationAllVARCHARVARCHAR2VARCHAR
Progress bar (read only)Displays a bar with the progress (only in grids).Windows/WebINTINTINT
Radio buttonDisplays a list with various options.AllTINYINTSMALLINTSMALLINT
Remote folderUpload or download files with crud rights on the folder.Windows/WebVARCHARVARCHAR2VARCHAR
Remote folder simpleMore secure version of Remote folder without delete or upload the whole folder.WindowsVARCHARVARCHAR2VARCHAR
RtfText is displayed as RTF.AllNVARCHAR_MAXNVARCHAR2VARCHAR
SignatureField to enter a signature.UniversalVARCHARVARCHAR2VARCHAR
SqleditorThis control is used, for example, in the Software Factory to highlight the syntax for data in SQL format.All
TimeTime format in hours, minutes, and seconds. The time can possibly be selected with an up and down button.AllTIMETIMESTAMPTIME
Time shortTime format in hours and minutes (no seconds). The time can possibly be selected with an up and down button.UniversalTIMETIMESTAMPTIME
UrlOpening URL in the active browser.AllVARCHARVARCHAR2VARCHAR
Video linkShows a media player.WindowsVARCHARVARCHAR2VARCHAR
Universal GUI

The File link domain control is designed for 2-tier GUIs. This control is especially suited for desktop applications where all users can access a file or folder from the same environment.

However, in a 3-tier architecture and Azure, files can be in a different location where users cannot link to directly. Moreover, browser applications cannot access desktop files. For this reason, you should use the File upload control for the Universal GUI (3-tier) instead.

Universal GUI

The Folder link domain control is designed for 2-tier GUIs. This control is especially suited for desktop applications where all users can access a file or folder from the same environment.

However, in a 3-tier architecture and Azure, files can be in a different location where users cannot link to directly. Moreover, browser applications cannot access desktop files. For this reason, you should use an alternative for the Universal GUI (3-tier) that best fits your needs.

For example:

  • Remove the control entirely, converting it into a freely editable text field. The GUI will not verify the existence of the entered path.
  • Use a process flow for upload/download.
  • Use a Copy to clipboard control. Users can use the link on the clipboard to go to the right environment and access the folder.

Time zone for DATETIME controls

Universal GUI

When you select a control for a domain that shows a DateTime value, you can select the Time zone:

  • Show as stored - The time zone as stored in the database.
  • Local - The user's current time zone as set in IAM. See Users.

time zone setting for domains Time zone setting for domains

Domain elements for COMBO, IMAGE COMBO, and RADIO BUTTON

For the controls COMBO, IMAGE COMBO and RADIO BUTTON you can define elements. An element translates a database value into a human-readable value.

menu Data > Domains > Elements

  1. Select a Domain name.

  2. Enter the Element ID. This is used to translate the elements.

  3. Enter a Database value. This is the value that is stored in the database. It is often a number, but that is not mandatory.

  4. The IMAGE COMBO control uses icons instead of text. Select images in field Icon. For a RADIO BUTTON control it is optional to use icons instead of text. For example: Gender has the elements unknown, man and woman with database values 0, 1 and 2. Instead of displaying this as texts, you can use icons that represent the different genders.

  5. Enter a Sequence no. This is used to sort the elements.

Using images in domain elements Two domain elements with icons

Domain element name of IMAGE COMBO in tooltip

In the grid, you can view the domain element name of an image combo in its tooltip. You can set the domain element name in the menu Data > Domains > tab Elements > field Element.

PASSWORD control fields

In a password control field, passwords are by default hidden from view. Users can toggle the 'visibility' icon to display the password in plain text or to hide the password from view.

Password control field with visibility icon in the Universal GUI

When a password field is non-editable or read-only, the 'visibility' icon is hidden, and the number of characters is set to 8 instead of revealing the password length.

warning

If the password control is used, the field has not yet been encrypted. The value will therefore still be visible in the database when it is stored and can also be passed on to the defaults and layouts.

PROGRESS BAR in forms

Universal GUI

The PROGRESS BAR control displays a progress bar in grids. To display a progress bar in forms, use the FormProgressBar extended property. You can apply conditional layouts to the progress bar.

LOCATION control

Universal GUI

The LOCATION control adds a location pin to the input field. If a user clicks on this pin, they will be asked to give permission to add the location coordinates of their current location. The format of the coordinates is latitude, longitude, for example, 52.2083228,5.9794353.

If the user adds a new row, the LOCATION control automatically fills in the current location for empty mandatory input fields.

Mandatory field In an empty mandatory field, the location is filled automatically

If the field is not in edit mode, it will become a clickable link that opens the coordinates in Google Maps.

Clickable location link A clickable location link in an non-editable field

Barcode scanner controls

Third-party integrations for barcode scanning

Universal GUI

Thinkwise supports two barcode scanner controls. This topic provides information for both types of barcode controls.

  • Barcode scanner (ZXing). This barcode scanner is an open-source third-party component. It is a free alternative to the more powerful, paid Cortex barcode scanner.
  • Thinkwise partner CortexScan from CodeCorp.
note

When using Google Chrome on iOS, both the regular and Cortex barcode scanners only work on iOS 14.3 and higher due to vendor limitations.

In addition to the integrated barcode scanning capabilities, it is also possible to process the input from connected handheld scanners in the Universal GUI. For scanners with a display that run a recent browser version, for example Zebra scanners, it is even possible to run the Universal GUI on the scanner itself.

Settings for barcode scanner controls

For both scanner controls, after scanning, a key code is sent to the application. Usually, this is the tab key, but this so called suffix can be configured for some barcode scanners. As a result, the scanned value is sent to the database, and the cursor moves to the next field.

  • To change the field where the cursor moves after scanning, apply a Default with a cursor_to_col_id parameter.
  • With the same Default, you can also process the scanned barcode into the database. This way, you can keep the task open and scan multiple items in a short time.
  • In a situation or location where the internet connection may occasionally drop, and the task is marked as Offline executable, consider using the RepeatOfflineTasks extended property until the task is canceled.
  • If the barcode field is not the last field in a task and you want to scan another item directly, consider Repeating a task after execution.

Barcode scanner

This barcode scanner control is a regular text input with a barcode icon next to it. It can be used in two different ways:

  • If you use an external hand-held barcode scanner that is connected to your device, the text input field is automatically filled after scanning.
  • If you use your device to scan a barcode, it uses your device's camera to scan the barcode and extract the data. When a user clicks the barcode icon the first time, permission is asked to use the camera. If the camera permission has been given, scanning will start in a pop-up.

Barcode scanner

If you're using a hand-held scanner and scanning is the last step in a task, the task is submitted directly, if:

  • The barcode scanner is configured to send Tab after the barcode (this is commonly called 'postfix').
  • The hand-held scanner is connected to, e.g., a cell phone or a desktop.
  • The focus is on the 'BARCODE_SCANNER' input field in a a task.
  • The barcode field is the last visible field in a task.

Supported barcode symbologies

The Barcode scanner supports the following barcode symbologies:

Supported
AztecDataBarExpandedPDF417
CodabarDataMatrixQRCode
Code39EAN-8UPC-A
Code93EAN-13UPC-E
Code128ITF1D-Codes
DataBarMaxiCode2D-Codes

By default, the barcode scanner will try to find barcodes with all of the symbologies above.

If only a few symbologies need to be supported, the scan performance can be improved by letting the barcode scanner search for only specific symbologies. This can be configured in the config.json file in the Universal GUI folder. For example, when only UPC-E and QRCode are necessary, config.json can be configured like this:

{
"barcodeScannerSymbologies": "UPC-E, QRCode",
"defaultApplication": "",
"defaultPlatform": 3,
"loginOptionsDisabled": false,
"installNotificationDisabled": true,
"installNotificationExpirationInDays": 30,
"serviceUrl": "https://web10.thinkwise.app/ng_indicium/iam/iam"
}

Cortex barcode scanner

Universal GUI

The Cortex barcode scanner is a more powerful alternative to the free to use barcode scanner.

To use the Cortex barcode scanner, you need a license from the manufacturer. For more information, see https://codecorp.com/products/web-sdk.

note

When using Google Chrome on iOS, both the regular and Cortex barcode scanners only work on iOS 14.3 and higher due to vendor limitations.

To use Cortex in the Universal GUI:

menu Data > Domains

  1. Configure CORTEX_DECODER as the domain control.
  2. In the Universal GUIs configuration file config.json, add the license like this:
"cortexLicense": "your-license-key-here",

To improve the scan performance, you can configure only the symbologies you need:

"cortexEnabledSymbologies": ["Code128", "EAN8", "EAN13", "UPCA"].

By default, Cortex scans the following symbologies:

Supported (default)
AztecUPCAUPCEPDF417Interleaved2of5
Code93Code128Code39QREAN8
EAN13DataMatrixDotCodeGS1Databar14

However, Cortex supports a lot more symbologies. This is the full list:

Supported (all)
AustraliaPostMSIPlesseyCode128PlesseyEAN8
CanadaPostMicroPDF417Code49Straight2of5GridMatrix
Code11PharmacodeDataMatrixUPCAIATA2of5
Code39RoyalMailEAN13USPSIntelligentKoreaPost
CompositeCodeTriopticGoCodeBC412Maxicode
DutchPostUPUHongKong2of5CodablockFPDF417
GS1Databar14USPSPostnetJapanPostCode32QR
HanXinCodeAztecMatrix2of5Code93Telepen
Interleaved2of5CodabarNEC2of5DotCodeUPCE
USPSPlanet

Was this page helpful?