Low-code designer > App builder / System data types

System data types

To store data on forms as well as in widgets, tasks, or business process start events, you can use sets of fields. The information you want to display determines the field types you need to use. For example, you can create a String type field for a comment and a Money type field for a contract amount.

Read more about adding fields to forms in the Context tab article. Below you can find the description of all the data types available in the system. Read about working with different types in scripts in ELMA365 TS SDK.

String

This type is used to add text information.

data-types-1

The content can be displayed as a string or as text. The Markdown option allows you to format the text you enter. Read more in the Markdown article.

data-types-2

Apart from general settings, this type has an additional setting:

  • Validators. Here you can set a template to validate the text that the user enters.
  • Input mask. An input mask is a set of regular expressions. Only expressions without flags are available in masks. Read more about writing regular expressions in the MDN Web Docs documentation.
  • Message shown when the input does not comply with the mask. Write a message shown when the user enters text that doesn’t comply with the input mask. Read more in the Create input masks for Strings using regular expressions article.

Number

This field is used for entering numbers.

data-types-3

It is not possible to enter other characters than digits in this field.

Select the number type:

  • Integer or Non-integer. Here you can select the number format. The Non‑integer type allows entering non-integral numbers.

data-types-4

Yes/No switch

This type adds a checkbox or a radio button that allows the user to mark one of two options.

The default options are Yes and No, but you can rename them.
To display one of the values on the form by default, select the check box next to it. If necessary, you can change the field value on the form.

data-types-5

Choose a selection type:

  • Checkbox

data-types-6

  • Radio button

data-types-7

You can configure the selection type you chose when creating the field. To do that, open the Form Settings, select the field, and change the type.

Date/Time

This type is used to add a date and/or time to a form.

sdt 9

The display format can be configured only when creating the property or context variable.

  1. Date/Time. The user will need to specify a date and time.
  2. Date. The user will need to specify only a date. The time is automatically set to 00:00.
  3. Time. The user will need to specify only time.

sdt 10

You can also enable the following options:

  • Set current date and time. The current date and time will be specified in the field by default. If you select this option for a business process variable, the date of the process start will be specified in the field.
  • Do not require to specify time. Apart from the date, the user will be able to specify the time if needed. This option is available for the Date/Time format.

data-types-8

You can also define the default time:

    • Day Start. The default time will be 12:00 am.
    • Day End. The default time will be 11:59 pm.

The time you choose will be shown in the Time field by default.

Category

This type of field allows you to let the user choose one or more options from a drop-down list. The list of option is defined when configuring or editing a form or when creating a context variable.

data-types-9

Open the drop-down list to select an option in the configured field on the form.

sdt 16

You can reset the value by clicking the clip0235  icon or by selecting an empty row.

When working with a Category field, you can use scripts to automatically fill out the options in the list, for example, with app statuses. To do that, you have to configure a dynamic list and using a variable that will collect the statuses and their values sent to the Category field as an array. This configuration will also allow for automatic update of the list is the statuses in the app are modified, without having to do it manually. You can learn more about these settings in ELMA365 TS SDK.

Money

A field for entering numbers with a currency code.

sdt 17

  • Currency. Select a currency from the drop-down list. You can change the currency when you edit the field after saving. However, the values entered by users before that will not change until somebody edits the field and saves the data. The currency names and codes are in accordance with the ISO 4217 standard.
  • Digits after the decimal point to be displayed. Specify the number of digits to be displayed after the decimal point on an app item form. This feature is available for integers as well. For example, if you enter 2 in this field, the data on a form will be displayed in the following way: $100.00.

Account

This field type is used to store messenger accounts. An app that has this type of field in its context can be linked with sessions in live chats from the Live Chats workspace.

You can specify the Account type: Telegram, WhatsApp, etc. You can also select Other. This format can be used to store an account not included in the list, for example, an additional email address.

data-types-12

If you select Several, the user will be able to select the account type on their own and add several accounts when entering information in this field on the form.

data-types-13

Phone number

A field for entering a phone number.

You can specify the Phone number type: main, home, work, etc.

sdt 19

If you select Several, the user will be able to select the phone number type on their own when entering information in this field on the form.

The Validation level option allows you to determine how the number entered on the form is checked against the format of numbers in the selected country:

  • Warn about invalid value. If the user enters a number in an incorrect format, the clip0236 icon will appear to the right of the field. At the same time, the app item with such a value in the field can be saved.
  • Forbid invalid values. If the number format is incorrect, a warning message will appear below the field. To save the app item, the user needs to correct the phone number.

data_types_01

You can add a phone extension using a separator. For example:

  • +14841234567 x1234
  • +14841234567 ext 1234
  • +14841234567;1234

The extension will be displayed on the form as +14841234567 x1234.

When filling in and editing the field, the phone number is validated. The rules depend on the specified country. If the format of the main phone number or the extension does not comply with the validation settings, the incorrect-format-icon icon is displayed on the right of the field.

Email address

This type of field is used to enter an email address.

You can select the Email address type: main, home, or work.

data-types-18

If you select Several, the user will be able to select the type on their own.

The Validation level option allows you to how the email address entered on the form is checked:

  • Warn about invalid value. If the user enters an email address in an incorrect format, the clip0236 icon will appear to the right of the field. At the same time, the app item with such a value in the field can be saved.
  • Forbid invalid values. If the address format format is incorrect, a warning message will appear below the field. To save the app item, the user needs to correct the address.

data_types_02

When this field is filled out, new options become available on the view form. You can quickly compose and send an email to the specified address or copy the address to the clipboard. To do that, click the arrow-down-icon icon next to the entered email and select the option you need.

data-types-19

  • Default Email Client. Select this option to open the page of the main email client installed on your PC. The recipient’s address will be filled out automatically.
  • ELMA365. If you linked an email address to the ELMA365 built-in email client in the Email workspace, you can create and send an email directly in the ELMA365 interface. The Write message window will open if you click it. The To field will be filled in automatically.
  • Copy to Clipboard. Copy the email address to clipboard.

Image

In an Image type field, you can attach a .jpg, .tiff, .gif, .bmp, or .png file. When setting up this field, you can select how many images can be attached to it: One or Many.

If you check the Clip image when uploading box, the user will be able to select an area of the image to display when uploading it.

sdt 25

This is how it is displayed on the form.

data-types-21

Files

Files type field allows you to attach files of any type, such as invoices, documents, videos, etc.

You can specify if the user can attach One or Many files.

sdt 28

Here is what an uploaded file looks like:

doc_scan

By clicking on the file on an app item or task form, you can open its preview page. On the preview page, you can:

  • Download the file to your PC by clicking save-doc-icon.
  • Open a menu with more options by clicking doc-options-icon:
    • Manage access. By default, the access settings for the app are also applied to the files uploaded to app item pages. You can provide additional permissions for the file to other users of the system.
    • Create copy. You can save a copy of this file to the Files workspace. All the actions available for files will also become available for this file.

 

File version history

For files uploaded to the Files field of the One type, version history is available. Users can add a new version by uploading it from their computer when editing the app item. It is also possible to attach a new version during a business process by using the Assign Value and Edit App Item activities.

All the file versions are saved in the system. To display the list of versions on the task or app item form, add the Document versions widget to the form and specify the property storing the file in its settings.

system-data-types-doc-versions

начало внимание

To enable file version history in ELMA365 On-Premises, the system administrator needs to activate the allowAddVersionFileFields feature flag on the server. To enable it for ELMA365 SaaS, contact tech support.

конец внимание

Full Name

This field allows the user to enter the last name, first name, and middle name.

sdt 29

Arbitrary app

This type allows the user to select an item from any app.

You can specify if the user can select One or Many app items.

If Many is selected, items from different apps can be specified on the form.

data-types-25

To select an app item, click the field on the form or the magnifying glass icon in it. In the window that opens, an app from the list needs to be selected.

data-types-26

A window with app items will open, and you will be able to select an app item by clicking on it. On the form, the app item will be displayed as a link. Click it to access the app item page.

To select another app item, click the recycle bin icon to the right of the link. The field will be cleared.

data-types-27

If the recycle bin icon is not displayed, the field is read-only. It is impossible to change its value.

You can add an Arbitrary app type field to a widget. Then you can use it as a universal component on different forms.

Please note, that when you configure input and output variables or bind settings to an Arbitrary app type field, you can specify variables of the following types: Arbitrary app, App, File, or Users.

Read more about input and output variables and binding fields.

Link

This field allows displaying a link to a website, a document or workspace in ELMA365, or to other internet sources.

data-types-28

Table

With the Table field, you can structure data by rows and columns, change its design, and insert special formulas that will perform calculations. Learn more about working with fields of this type in the Table data type article.

sdt 33

Role

In a Role type field, you can specify a user, a group of users, or an org chart item.

data-types-30

Using a Role type field is convenient when you need to specify a whole group of users of an org chart item. You don’t need to select each specific user. You only need to select the necessary group or position.

When setting up the field, you can also check the Show locked users box.

data-types-31

Users

In this field, you can select one or more specific system users.

sdt 31

When setting up the field, you can check the Show locked users box. You can also specify if One or Many users can be selected on the form.

If you click the magnifying glass icon in a field with the Many option, you can select several users in the list that opens.

system-data-types-users-many

You can also limit the list of users who can be selected. To do that, check the Add filter box and click on the Set up filter link that appears.

data-types-33

In the window that opens, click the +filter button and select fields from the user page that will be used for filtering.

For example, you can set up a filter so that only employees from a certain group are displayed on the form in the list of users

App

If you place a field of this type on an app form, you can use it to specify one or more app items of another app. This creates a link between the two apps. The link to the associated app item is displayed on the page of the main app item. Click on it to open the page of the associated item.

начало внимание

An added link between apps cannot be edited or deleted, even if the fields are deleted.

конец внимание

The app is selected when configuring the form or creating the context variable. To determine how many app items the user will be able to specify in the field, select One or Many in the variable’s settings.

sdt 34

When the app is selected, additional options become available:

sdt 35

  • Default values for new items. This option is used if you want to make it possible for users to create new app items with pre-filled fields directly from the form. For example, the user can create supplementary agreements directly on the form of a contract they relate to. Their fields will be pre-filled with values form the contract. To learn more, see Default values for new items.
  • Bound app. You can bind items of one app with items of another app. The items of the child app are then created on the form of the parent app item, and they aren’t saved until the parent app item is saved. To learn more, see Bound apps.
  • Restrict choice. This option allows you to limit the list of app items available for users to select. For example, only app items created after a specific date or app items added by the current user can be made available. To learn more, see Dynamic forms.

To fill in a field on a configured form, start typing the name of an item or click the magnifying glass icon to go to the list of available items and search by options.

If you have permissions to create app items in the selected app, you will be able to create a new app item as you fill out the fields on the form. To do that, click the +Create button.

 

 

app_type_1

In the advanced mode, the Read-only option is automatically enabled for fields of the App type. When filling out a field on the form, users will only see a button to create a new item. You can configure how it will look like. Read more about it in Create an app item on the page of another app.

To allow users to select an item from the list of existing items when filling out a field, go to the app form settings and disable the Read-only option for this property. Read more in Create, View, and Edit tabs.

 

Also note that when an app item is added to the form of another app item, this creates a link between apps that cannot be edited or removed, even if the fields themselves are deleted.

Report

A report is a system component that displays data from several source apps in the form of a table. For example, in the Order Register report you can link different apps of the system and display information about an order, customer, contract, and invoice. Read more in Report.

The Report type field allows to add a link to the report created in the system to the app form or page. When you click on the link, the page with the configured report table will be opened.

data_types_03

Creating a Report type field is available only in the interface designer on the Context tab.

To add a Report type field:

  1. In the app, enable advanced mode.
  2. Go to the interface designer of the selected app form or page and click +Add on the Context tab.
  3. Specify a name and property type, select the report created in the system, and click Create.

data_types_04

Now you will be able to refer to the fields of the selected report in scripts using TS SDK methods or add a link to the report on a form or page.

  1. Click the Template tab, select Properties in the right panel, and drag the Report type property to the field to be modeled.
  2. In the opened window, name the field on the form and click Save.
  3. To edit the report link name, change the field name on the Context tab.
  4. Save and publish the configured form or page.

For the Report type field, the Read-only option is enabled. Users will be able to navigate to the report page using the specified link, but will not be able to change the field value.

Found a typo? Highlight the text, press ctrl + enter and notify us