UI Extension fields

The fields of the UI extension form are listed below and recommendations for using each of them are provided.

Name

The short name of the UI extension is entered in the Name field.

Section Header

In the Section Header field, enter the text that will be displayed as the section header above the UI extension when it is presented in the form.

Category

In the Category field, select the type of record in which you can select this UI extension.

Disabled

The Disabled checkbox is set if the UI extension can no longer be linked to other entries.

Version

The version of the UI extension is selected in the Version field. The version is marked “Being prepared" if it has not yet been activated. The activated version is selected using the “Active” option. Previously activated versions indicate the date and time of their activation.

HTML

In the HTML field on the corresponding tab, the HTML code for the UI extension is entered, and you can use the code editor with special shortcut keys.

JavaScript

In the JavaScript field on the corresponding tab, JavaScript code is entered to extend the UI, and you can use the code editor with special shortcut keys.

CSS

In the CSS field on the corresponding tab, CSS code is entered to extend the UI, and you can use the code editor with special shortcut keys.

Fragments

Field

The field in the Fragments section of the HTML tab is used to add fields to the UI extension. When the button is pressed Insert fragment the HTML code is inserted under the code in the HTML field. The added HTML code is highlighted, so it's easier to understand what exactly was added. In the Fragments section, you can add the following types of fields: Attachment – field “Attachment (add attachment)” allows you to add an attachment to a record. The checkbox is one option that can be set or disabled. Custom suggestion is a suggestion field based on a custom collection for which a custom view has been created. This option is only available if at least one custom view with the entry type ‘Custom Collection Items' is enabled. Date-time – is used to specify the date and/or time. Location – you can specify the location using the map, the corresponding application is downloaded from the app store. Number – this field is used to enter numeric values. Organization Suggestion – allows the user to select any organization to which he has access. Person Suggestion – Using this field, the user can select any person from the internal organization. The person can be selected from the same space in which the user is registered, or from the spaces of the support domains. A user from an external organization can select a person only from this external organization. Secret – the field is available for application suggestions. When the customer fills in this field, a webhook message is sent using app_instance.secrets-update. Section – used to create a header above the fields. Selection List – Offers a list of options from which you can select one. Site Suggestion – Allows the user to select any site they have access to. Team Suggestion – Allows specialists to select any team they have access to. Text – this field is used for text input.

Label

You can use the Label field (Fragments section, HTML tab) to add a label to the field.

ID

You can use the ID field (Fragments section, HTML tab) to create a unique HTML ID.

Options

You can use the Options field (Fragments section, HTML tab) to add optional attributes to the field. They depend on the values in the Category and Field fields: Add to Topic – Adds the field value to the topic of a request, problem, or workflow. Viewed (only for the Checkbox field) – the checkmark is added by default. Filtering – Filters can be applied to the field. Hidden – the field will be available only for automation rules and API. Displayed only for specialists, auditors, and administrators of this space – the field is visible only to specialists, auditors, and administrators of the space where the UI extension was created, as well as to specialists, auditors, and administrators of support domain spaces from the same directory. Multiline (for text only) – You can enter multiline text. Multiple Values – You can add multiple values or attachments. Required – the field is required. Rich Text (text only) – you can enter formatted text and add images. Search is possible – The field values can be found using the search function. Show if empty – displays the field even if no value has been entered.

Type

You can use the Type field (Fragments section, JavaScript tab) to add JavaScript code to the UI extension. When the button is pressed Insert fragment the JavaScript code is inserted under the code already entered in the JavaScript field. The added JavaScript code is highlighted, so it's easier to understand what exactly was added. The following types can be added: Asset Required – adds JavaScript code that makes it mandatory to fill in the Asset field on the self-service portal when the end user sends a new request. Attachment Required – Adds JavaScript code that makes the ‘Add Attachment link mandatory...’ for new requests or newly assigned tasks. It is necessary to fill in a comment – adds JavaScript code that makes it mandatory to fill in the Comment field on the self-service portal when the end user sends a new request. The CSS tab also has a Type field, which is used to add CSS code to the UI extension. When the button is pressed Insert fragment The CSS code is inserted under the code already entered in the CSS field. The added CSS code is highlighted, so it's easier to understand what exactly was added. The following types can be added: Field Layout – adds CSS code that makes less padding between fields in the UI extension. This option is usually used if many fields have been added to the UI extension. Hide Elements – Adds CSS code that hides the “Subject” and “Comment” fields in the user interface on the self-service portal by default. This option also hides the attachment link, which is usually displayed under the Comment field on the self-service portal.

Phrases

Phrases

The Phrases field, located under the HTML field, lists all the UI extension texts for which translation is available in the settings console.