You use masks in Design Studio to restrict Task web client user input for a field to a specific format. When using masks, refer to the following topics:
Masks enable you to restrict Task web client user input for a field to a specific format. Using the Data Dictionary editor OSM tab, you can specify the strings of characters used to define the format of the data in the field and use a mandatory mask character to create a field where a user must enter information in the appropriate format to complete the task. See the "Data Schema Editor OSM Tab" for more information.
Use the following mask characters for text fields:
| Mask Character | Description |
|---|---|
| # | Mandatory digit |
| 9 | Optional digit |
| A | Mandatory alphanumeric |
| a | Optional alphanumeric |
| ? | Mandatory alpha |
| z | Optional alpha |
Mask characters serve as placeholders in Task web client fields. All non-mask characters appear in text type fields; you cannot edit them. For example, if you enter TEXT in the OSM Element Mask field, it appears in the Task web client field as TEXT. To use mask characters as literals, you must enter "\" in front of the character.
Use the following mask characters for numeric fields:
| Mask Character | Description |
|---|---|
| 9 | Optional digit |
| 0 | Use to the right of the decimal. Displays 0 if no value is entered. |
| . | Decimal placeholder |
| , | Numeric placeholder |
Note:
You must include at least one numeric mask character for the field to be valid. You cannot use quotation marks (" ") for numeric masks.The following table illustrates how numeric mask characters defined in the Data Schema editor would affect data entered into the Task web client:
| Mask Defined in Data Dictionary | Entered into the Web Client | Displayed in Web Client |
|---|---|---|
| 9,999 | 1234 | 1,234 |
| 99.99 | 34.12345 | 34.12 |
| 99.00 | 12 | 12.00 |
| 99.00 | 34.1256 | 34.13 |
Use masks in Design Studio to restrict Task web client user input for a field to a specific format.
To define a mask for a Task web client field:
From the Studio menu, select Show Design Perspective.
Click the Data Element tab.
Select the data schema entity that contains the field for which you want to define the mask.
The entity opens in the Data Schema editor.
In the Dictionary area, select the data node for which you want to define the mask.
Click the Data Schema editor OSM tab.
See "Data Schema Editor OSM Tab" for more information about the fields on this tab.
In the OSM Element Mask field, specify the string of characters used to define the format of the data in the Task web client field.
Use a mandatory mask character to create a field where a user must enter information in the appropriate format to complete the task. See "About Masks" for more information.For elements that inherit data from a base type, this field is read-only. See "Leveraging Existing Data Information" for more information.
Click Save.