Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
When When creating a widget, define its form, fields, and its behavior by using the template elements to specify the way it displays with HTML and Widget Attributes.
Common SimpleTags
Learn how to apply Apply HTML tags to that add and control elements such as buttons and various types of fields.
infoPortal SimpleTags
SomeLearn SimpleTags that implement portal widgets
and are described in a dedicated article: Portal Simple Tags.
| Note |
|---|
When a widget is implementingimplemented, all tag attribute values are transmitted as a string regardless of the the attribute type; and during the processing phase, the attribute attribute value is applied in line with the type specified. |
<attachment>
Adds the attachment widget for uploading files into a record.
The following attributes are applicable:
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
<attachment tableName={data.table_name} recordId={data.record_id}></attachment>
|
<button>
Use this attribute to add a button to your widget form. This element behavior is similar as React does.
The following attributes are applicable:
This attribute allows specifying button displaying style for forms and lists. Available attribute values are the same as database values for UI Action Form Style or List Style:
- unstyled
- primary
- approve
- destructive
- secondary
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<button buttonType="approve" event-click="window.s_widget_custom.approve();">
{data.approveBtnTitle}
</button>
<button buttonType="destructive" event-click="window.s_widget_custom.reject();">
{data.rejectBtnTitle}
</button> |
<checkbox>
This element allows adding and configuring the checkbox field.
The following attributes are applicable:
This attribute specifies the display settings (size, font, color, and etc.) of the widget elements using the CSS syntax.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<modal model="data.modal" title="{data.modalTitle}" isShow="{data.isShow}"
doClose="window.s_widget_custom.closeModal();">
<checkbox model="data.ignoreAutoCAB" label="{data.questionText}"></checkbox>
<div simple-if="{data.showInput}" class="select-area">
<multiselect label="{data.cabParticipantsTitle}" title="{data.cabParticipantsTitle}" model="data.CABparticipants"
values="" options="{data.optionsValues}" event-change="s_widget_custom.optionsSelected();">
</multiselect>
</div>
</modal> |
<codemirror>
The element adds a text field with the code formatting.
The following attributes are applicable:
readOnly
This attribute allows to set a read-only status to field. For this, set it equal to 'true'.
This attribute specifies the display settings (size, font, color, and etc.) of the widget elements using the CSS syntax.
value
Specifies the default value for field.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<codemirror model="data.mirror" label="Code Editor" isMandatory="true"></codemirror> |
<conditions>
Adds the condition builder widget.
The following attributes are applicable:
readOnly
This attribute allows to set a read-only status to field. For this, set it equal to 'true'.
This attribute specifies the display settings (size, font, color, and etc.) of the widget elements using the CSS syntax.
value
Specifies the default value for field.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<conditions model="data.condition" tableName="itsm_incident" tableId="155964310500000569"></conditions> |
<datetime>
The element provides a data input of the datetime format.
The following attributes are applicable:
readOnly
This attribute allows to set a read-only status to field. For this, set it equal to 'true'.
This attribute specifies the display settings (size, font, color, and etc.) of the widget elements using the CSS syntax.
value
Specifies the default value for field.
| Code Block | ||||
|---|---|---|---|---|
| ||||
<datetime model="data.dueDate" label="data.dueDateTitle" isMandatory="true" beginDate="{data.beginDate}" endDate="{data.endDate}"></datetime> |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
const nowDate = new SimpleDateTime();
data.beginDate = nowDate.getDate();
nowDate.addDays(3);
data.endDate = nowDate.getDate(); |
<daysofweek>
The element adds a field that allows selecting days of week.
The following attributes are applicable:
readOnly
This attribute allows to set a read-only status to field. For this, set it equal to 'true'.
This attribute specifies the display settings (size, font, color, and etc.) of the widget elements using the CSS syntax.
value
Specifies the default value for field.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<daysofweek model="data.daysofweek" label="Calendar Widget" isMandatory="true" isVisible="true" readOnly="false" value="Mon,Tue,Wed,Thu,Fri,Sat,Sun"></daysofweek> |
<duration>
The tag adds a field counting the time duration.
The following attributes are applicable:
readOnly
This attribute allows to set a read-only status to field. For this, set it equal to 'true'.
This attribute specifies the display settings (size, font, color, and etc.) of the widget elements using the CSS syntax.
value
Specifies the default value for field.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<duration model="data.absence" label="Absence" isMandatory="true" value="3600000"></duration> |
<htmlEditor>
This widget adds an HTML input field with text formatting options.
The following attributes are applicable:
readOnly
This attribute allows to set a read-only status to field. For this, set it equal to 'true'.
This attribute specifies the display settings (size, font, color, and etc.) of the widget elements using the CSS syntax.
value
Specifies the default value for field.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<htmlEditor label="Description" model="data.description" isMandatory="true"></htmlEditor> |
<modal>
This tag allows implementing a modal window.
The following attributes are applicable:
Specify actions to perform after one of the predefined patterns is selected:
- click
- context
- mouseOver
readOnly
This attribute allows to set a read-only status to field. For this, set it equal to 'true'.
This attribute specifies the display settings (size, font, color, and etc.) of the widget elements using the CSS syntax.
value
Specifies the default value for field.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<modal
title="{data.modalTitle}"
isMandatory="true"
isShow="{data.isShow}"
doClose="window.s_widget_custom.countClosing();">
</modal> |
<multiselect>
Provides multiple choice selection for widgets.
The following attributes are applicable:
This field type matches database values with what will be displayed. Specify options available for selecting using the CodeMirror JSON formatting to set the options you need.
| Info |
|---|
You can put as much options into drop-down menu as you need, but after the sixth one is placed, a vertical scroll appears. |
readOnly
This attribute allows to set a read-only status to field. For this, set it equal to 'true'.
This attribute specifies the display settings (size, font, color, and etc.) of the widget elements using the CSS syntax.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<multiselect model="data.values" canExcludeAll="true" values='["1", "2"]' options='[{"database_value":"","display_value":""},{"database_value":"1","display_value":"First"},{"database_value":"2","display_value":"Second"}]'></multiselect> |
<reference>
This element adds a reference field to a widget for establishing connections with data tables by a custom reference.
The following attributes are applicable:
readOnly
This attribute allows to set a read-only status to field. For this, set it equal to 'true'.
This attribute specifies the display settings (size, font, color, and etc.) of the widget elements using the CSS syntax.
value
Specifies the default value for field.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<reference label="Configuration Item" model="data.element" tableName="cmdb" isMandatory="true" condition="{data.condition}"></reference> |
<rem>
This widget is used to add model attributes to a form. The use case is when administrator needs to extend a record form in the agent interface. The tag must bespecified |
The following attributes are applicable:
This attribute specifies the display settings (size, font, color, and etc.) of the widget elements using the CSS syntax.
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
<rem modelId="{data.model_id}" tableName="{data.table_name}" recordId ="{data.record_id}" /> |
| Code Block |
|---|
| ( () => {
window.s_widget_custom = window.s_widget_custom || {};
const modelId = new URLSearchParams(window.location.search).get('model_id'); // Getting model id from URL
//Setting model from model_id URL parameter so new record knows from which model to add attributes
s_widget . setFieldValue('model_id', modelId); // Setting table name and record ID of existing record in order to find a model s_widget.setFieldValue('table_name', window.s_form.getTableName()); s_widget.setFieldValue('record_id', window.s_form.getUniqueValue()); })(); |
<remform>
This tag allows adding to portal a form consisting of model attributes.
The following attributes are applicable:
This attribute specifies the display settings (size, font, color, and etc.) of the widget elements using the CSS syntax.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<remform modelId="{data.model_id}" isPortal="true" tableName="rem_table" saveButtonCaption="Save" /> |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
(() => {
window.s_widget_custom = window.s_widget_custom || {};
const modelId = new URLSearchParams(window.location.search).get('model_id');
s_widget.setFieldValue('model_id', modelId); // Provide form of new record with model id
})(); |
<report>
Add this SimpleTag to display a particular report.
The following attributes are applicable:
readOnly
This attribute allows to set a read-only status to field. For this, set it equal to 'true'.
This attribute specifies the display settings (size, font, color, and etc.) of the widget elements using the CSS syntax.
value
Specifies the default value for field.
When placing two or more conditions into the condition string, merge them with the carat symbol ( ^ ). The condition syntax will look like this:
To know more about possible condition operators, please refer to the Condition Operators article.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<report reportid="{data.monthBarReportId}" condition="(group.nameLIKEdesk^ORstate=active)"/> |
<select>
A field that allows selecting items.
The following attribute is applicable:
readOnly
This attribute allows to set a read-only status to field. For this, set it equal to 'true'.
This attribute specifies the display settings (size, font, color, and etc.) of the widget elements using the CSS syntax.
value
Specifies the default value for field.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<select label="Class" isMandatory="true" model="data.class" options='[{"database_value":"","display_value":""},{"database_value":"155964310500000004","display_value":"Server"},{"database_value":"155964310500000006","display_value":"Database"}]'></select> |
<string>
In a widget, use this attribute to designate an input field for text information. The element is similar to the React component.
The following attributes are applicable:
readOnly
This attribute allows to set a read-only status to field. For this, set it equal to 'true'.
This attribute specifies the display settings (size, font, color, and etc.) of the widget elements using the CSS syntax.
value
Specifies the default value for field.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<h1>{data.fullname}</h1>
<string model="data.firstname" event-change="s_widget_custom.updateFullname();"></string>
<string model="data.lastname" event-change="s_widget_custom.updateFullname();"></string> |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
;
(() => {
window.s_widget_custom.updateFullname = async function () {
const firstname = s_widget.getFieldValue('firstname') || '';
const lastname = s_widget.getFieldValue('lastname') || '';
s_widget.setFieldValue('fullname', lastname + ' ' + firstname);
}
})(); |
<template>
This element is used to create form templates with a particular set of fields.
The following attributes are applicable:
readOnly
This attribute allows setting a read-only status to field. For this, set it equal to 'true'.
This attribute specifies the display settings (size, font, color, and etc.) of the widget elements using the CSS syntax.
value
Specifies the default value for field.
<textarea>
A multi-line text field.
The following attributes are applicable:
readOnly
This attribute allows to set a read-only status to field. For this, set it equal to 'true'.
This attribute specifies the display settings (size, font, color, and etc.) of the widget elements using the CSS syntax.
value
Specifies the default value for field.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<textarea model="data.name" label="Name" placeholder="Your search request" value=""></textarea>
<textarea model="data.description" label="Description" value="" placeholder="Your search request"></textarea> |