Page History

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. Apply HTML tags to add and control elements such as buttons and various types of fields.

Note
When a widget is implementing, all tag attribute values are transmitted as a string regardless of the attribute type; and during the processing phase, the attribute value is applied in line with the type specified.

<attachment>

Adds a files attachment widget.

The following attributes are applicable:

Attribute

Type

Description

class

String

This attribute allows defining CSS styles classes description and specifying.

isMandatory

Boolean

This attribute allows to set a mandatory status to field. For this, set it equal to "true".

isVisible

Boolean

If this attribute is equal to "true" (by default), then the widget of the type from the list below is displayed; otherwise, it is not displayed.

label

String

A field label with text information generally describing the field content.

model

String

This attribute points to the client controller data object. When the model data changes, it is automatically transferred to data of the client script.

readOnly

Boolean

This attribute allows to set a read-only status to field. For this, set it equal to "true".

style

String

This attribute specifies the display settings (size, font, color, and etc.) of the widget elements using the CSS syntax.

Code Block

language	xml
theme	Eclipse
title	attachment

<div style="fontSize: 15px, width: 600px"></div>

value

String

Specifies the default value for field.

Code Block

language	xml
theme	Eclipse
title	attachment
linenumbers	true

<attachment class="form" model="data.attachments"></attachment>

<button>

Use this attribute to add a button to your widget form. This element behavior is similar as React does.

Code Block

language	xml
title	Button
linenumbers	true

<button event-click="window.s_widget_custom.submit();">
  {data.submitBtnTitle}
</button>

<button event-click="window.s_widget_custom.cancel();">
  {data.cancelBtnTitle}
</button>

<checkbox>

This element allows adding and configuring the checkbox field.

The following attributes are applicable:

Attribute	Type	Description
class	String	This attribute allows defining CSS styles classes description and specifying.
isMandatory	Boolean	This attribute allows to set a mandatory status to field. For this, set it equal to "true".
isVisible	Boolean	If this attribute is equal to "true" (by default), then the widget of the type from the list below is displayed; otherwise, it is not displayed.
label	String	A field label with text information generally describing the field content.
model	String	This attribute points to the client controller data object. When the model data changes, it is automatically transferred to data of the client script.
readOnly	Boolean	This attribute allows to set a read-only status to field. For this, set it equal to "true".
style	String	This attribute specifies the display settings (size, font, color, and etc.) of the widget elements using the CSS syntax.
value	String	Specifies the default value of the field.

Code Block

language	xml
title	checkbox
linenumbers	true

<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:

Attribute	Type	Description
class	String	This attribute allows defining CSS styles classes description and specifying.
isMandatory	Boolean	This attribute allows to set a mandatory status to field. For this, set it equal to "true".
isVisible	Boolean	If this attribute is equal to "true" (by default), then the widget of the type from the list below is displayed; otherwise, it is not displayed.
label	String	A field label with text information generally describing the field content.
model	String	This attribute points to the client controller data object. When the model data changes, it is automatically transferred to data of the client script.
readOnly	Boolean	This attribute allows to set a read-only status to field. For this, set it equal to "true".
style	String	This attribute specifies the display settings (size, font, color, and etc.) of the widget elements using the CSS syntax.
value	String	Specifies the default value for field.

Code Block

language	xml
title	Codemirror
linenumbers	true

<codemirror model="data.mirror" label="Code Editor" isMandatory="true"></codemirror>

<conditions>

Adds the condition builder widget.

The following attributes are applicable:

Attribute	Type	Description
class	String	This attribute allows defining CSS styles classes description and specifying.
model	String	This attribute points to the client controller data object. When the model data changes, it is automatically transferred to data of the client script.
isMandatory	Boolean	This attribute allows to set a mandatory status to field. For this, set it equal to "true".
isVisible	Boolean	If this attribute is equal to "true" (by default), then the widget of the type from the list below is displayed; otherwise, it is not displayed.
label	String	A field label with text information generally describing the field content.
readOnly	Boolean	This attribute allows to set a read-only status to field. For this, set it equal to "true".
style	String	This attribute specifies the display settings (size, font, color, and etc.) of the widget elements using the CSS syntax.
tableId	Big Integer	Connection with a table by the ID.
tableName	String	Connection with a table by its name.
value	String	Specifies the default value for field.

Code Block

language	xml
title	Conditions
linenumbers	true

<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:

Attribute	Type	Description
beginDate	String	Specify a date in this field defining a period beginning.
class	String	This attribute allows defining CSS styles classes description and specifying.
endDate	String	Specify a date in this field defining a period ending.
isMandatory	Boolean	This attribute is responsible for specifying whether this input field is mandatory or not.
isVisible	Boolean	If this attribute is equal to "true" (by default), then the widget of the type from the list below is displayed; otherwise, it is not displayed.
label	String	A field label with text information generally describing the field content.
model	String	This attribute points to the client controller data object. When the model data changes, it is automatically transferred to data of the client script.
readOnly	Boolean	This attribute allows to set a read-only status to field. For this, set it equal to "true".
style	String	This attribute specifies the display settings (size, font, color, and etc.) of the widget elements using the CSS syntax.
value	String	Specifies the default value for field.

Code Block

language	xml
title	beginDate

<datetime model="data.dueDate" label="data.dueDateTitle" isMandatory="true" beginDate="{data.beginDate}" endDate="{data.endDate}"></datetime>

Code Block

language	js
theme	Eclipse
title	Server Script

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:

Attribute	Type	Description
class	String	This attribute allows defining CSS styles classes description and specifying.
isMandatory	Boolean	This attribute allows to set a mandatory status to field. For this, set it equal to "true".
isVisible	Boolean	If this attribute is equal to "true" (by default), then the widget of the type from the list below is displayed; otherwise, it is not displayed.
label	String	A field label with text information generally describing the field content.
model	String	This attribute points to the client controller data object. When the model data changes, it is automatically transferred to data of the client script.
readOnly	Boolean	This attribute allows to set a read-only status to field. For this, set it equal to "true".
style	String	This attribute specifies the display settings (size, font, color, and etc.) of the widget elements using the CSS syntax.
value	String	Specifies the default value for field.

Code Block

language	xml
title	daysofweek
linenumbers	true

<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:

Attribute	Type	Description
class	String	This attribute allows defining CSS styles classes description and specifying.
isMandatory	Boolean	This attribute allows to set a mandatory status to field. For this, set it equal to "true".
isVisible	Boolean	If this attribute is equal to "true" (by default), then the widget of the type from the list below is displayed; otherwise, it is not displayed.
label	String	A field label with text information generally describing the field content.
model	String	This attribute points to the client controller data object. When the model data changes, it is automatically transferred to data of the client script.
readOnly	Boolean	This attribute allows to set a read-only status to field. For this, set it equal to "true".
style	String	This attribute specifies the display settings (size, font, color, and etc.) of the widget elements using the CSS syntax.
value	String	Specifies the default value for field.

Code Block

language	xml
title	duration
linenumbers	true

<duration model="data.duration" label="Indication Duration" isMandatory="true" value="24"></duration>

<html>

This widget adds an HTML input field with text formatting options.

The following attributes are applicable:

Attribute	Type	Description
class	String	This attribute allows defining CSS styles classes description and specifying.
isMandatory	Boolean	This attribute allows to set a mandatory status to field. For this, set it equal to "true".
isVisible	Boolean	If this attribute is equal to "true" (by default), then the widget of the type from the list below is displayed; otherwise, it is not displayed.
label	String	A field label with text information generally describing the field content.
model	String	This attribute points to the client controller data object. When the model data changes, it is automatically transferred to data of the client script.
readOnly	Boolean	This attribute allows to set a read-only status to field. For this, set it equal to "true".
style	String	This attribute specifies the display settings (size, font, color, and etc.) of the widget elements using the CSS syntax.
value	String	Specifies the default value for field.

Code Block

language	xml
title	html
linenumbers	true

<html label="Description" model="data.description" isMandatory="true"></html>

This tag allows implementing a modal window.

The following attributes are applicable:

Attribute	Type	Description
class	String	This attribute allows defining CSS styles classes description and specifying.
doClose	Function	Specify actions to perform after one of the predefined patterns is selected: click context mouseOver
isMandatory	Boolean	This attribute allows to set a mandatory status to field. For this, set it equal to "true".
isShow	Boolean	If this attribute is equal to "true", then the modal window is displayed.
isVisible	Boolean	If this attribute is equal to "true" (by default), then the widget of the type from the list below is displayed; otherwise, it is not displayed.
label	String	A field label with text information generally describing the field content.
readOnly	Boolean	This attribute allows to set a read-only status to field. For this, set it equal to "true".
style	String	This attribute specifies the display settings (size, font, color, and etc.) of the widget elements using the CSS syntax.
title	String	Specifies the modal window title.
value	String	Specifies the default value for field.

Code Block

language	xml
title	modal
linenumbers	true

<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:

Attribute

Type

Description

canExcludeAll

Boolean

This parameter is responsible for items deselecting; if it's equal to TRUE, then bulk item selection cancellation is available.

class

String

This attribute allows defining CSS styles classes description and specifying.

isMandatory

Boolean

This attribute allows to set a mandatory status to field. For this, set it equal to "true".

isVisible

Boolean

If this attribute is equal to "true" (by default), then the widget of the type from the list below is displayed; otherwise, it is not displayed.

label

String

A field label with text information generally describing the field content.

model

String

This attribute points to the client controller data object. When the model data changes, it is automatically transferred to data of the client script.

options

String

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

Boolean

This attribute allows to set a read-only status to field. For this, set it equal to "true".

style

String

This attribute specifies the display settings (size, font, color, and etc.) of the widget elements using the CSS syntax.

values

String

Specify values for the selection.

Code Block

language	xml
title	multiselect
linenumbers	true

<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:

Attribute	Type	Description
class	String	This attribute allows defining CSS styles classes description and specifying.
condition	String	Specify a condition query.
isFixe~d	Boolean	When this attribute is equal to 'true', then the condition value cannot be changed.
isMandatory	Boolean	This attribute allows to set a mandatory status to field. For this, set it equal to "true".
isVisible	Boolean	If this attribute is equal to "true" (by default), then the widget of the type from the list below is displayed; otherwise, it is not displayed.
label	String	A field label with text information generally describing the field content.
model	String	This attribute points to the client controller data object. When the model data changes, it is automatically transferred to data of the client script.
readOnly	Boolean	This attribute allows to set a read-only status to field. For this, set it equal to "true".
style	String	This attribute specifies the display settings (size, font, color, and etc.) of the widget elements using the CSS syntax.
tableName	String	Connection with a table by its name.
value	String	Specifies the default value for field.

Code Block

language	xml
title	reference
linenumbers	true

<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 be specified in the Template field of the widget.

The following attributes are applicable:

Attribute	Type	Description
isUserScripts	Boolean	This attribute allows to enable client scripts execution. The default value is "true".
isPortal	Boolean	This attribute allows declaring that this widget should be displayed on the portal.
modelId	String	This attribute allows to specify RE model ID.
recordId	String	This attribute allows to specify an ID of existing record to extend.
tableName	String	This attribute allows to specify a table containing the extending record.

Code Block

language	js
theme	Eclipse
title	rem
linenumbers	true

<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:

Attribute	Type	Description
isPortal	Boolean	This attribute allows declaring that this widget should be displayed on the portal. In the case of the <remform> SimpleTag, the default value of this attribute is "true".
isUserScripts	Boolean	This attribute allows to enable client scripts execution. The default value is "true".
recordId	String	This attribute allows to specify an ID of existing record to extend.
saveButtonCaption	String	Specify text displayed on the Save button.
tableName	String	This attribute allows to specify a table containing the extending record.

Code Block

language	xml
theme	Eclipse
title	remform

<remform modelId="{data.model_id}" isPortal="true" tableName="rem_table" saveButtonCaption="Save" />

Code Block

language	js
title	remform widget code
linenumbers	true

(() => {
    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:

Attribute	Type	Description
class	String	This attribute allows defining CSS styles classes description and specifying.
condition	String	Specify a condition to build a report.
isMandatory	Boolean	This attribute allows to set a mandatory status to field. For this, set it equal to "true".
isVisible	Boolean	If this attribute is equal to "true" (by default), then the widget of the type from the list below is displayed; otherwise, it is not displayed.
label	String	A field label with text information generally describing the field content.
model	String	This attribute points to the client controller data object. When the model data changes, it is automatically transferred to data of the client script.
readOnly	Boolean	This attribute allows to set a read-only status to field. For this, set it equal to "true".
style	String	This attribute specifies the display settings (size, font, color, and etc.) of the widget elements using the CSS syntax.
reportId	String	Specify the report with the appropriate ID to display.
value	String	Specifies the default value for field.

Note

When placing two or more conditions into the condition string, merge them with the carat symbol ( ^ ). The condition syntax will look like this:

Condition word	Notation	Example
AND	^	emailLIKE-group^state=active
OR	^OR	impact=high^ORurgency=high

To know more about possible condition operators, please refer to the Condition Operators article.

Code Block

language	xml
title	report
linenumbers	true

<report reportid="{data.monthBarReportId}" condition="(group.nameLIKEdesk^ORstate=active)/>

<select>

A field that allows selecting items.

The following attribute is applicable:

Attribute	Type	Description
class	String	This attribute allows defining CSS styles classes description and specifying.
isMandatory	Boolean	This attribute allows to set a mandatory status to field. For this, set it equal to "true".
isVisible	Boolean	If this attribute is equal to "true" (by default), then the widget of the type from the list below is displayed; otherwise, it is not displayed.
label	String	A field label with text information generally describing the field content.
model	String	This attribute points to the client controller data object. When the model data changes, it is automatically transferred to data of the client script.
readOnly	Boolean	This attribute allows to set a read-only status to field. For this, set it equal to "true".
options	String	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.
style	String	This attribute specifies the display settings (size, font, color, and etc.) of the widget elements using the CSS syntax.
value	String	Specifies the default value for field.

Code Block

language	xml
title	select
linenumbers	true

<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:

Attribute	Type	Description
class	String	This attribute allows defining CSS styles classes description and specifying.
isMandatory	Boolean	This attribute allows to set a mandatory status to field. For this, set it equal to "true".
isVisible	Boolean	If this attribute is equal to "true" (by default), then the widget of the type from the list below is displayed; otherwise, it is not displayed.
label	String	A field label with text information generally describing the field content.
model	String	This attribute points to the client controller data object. When the model data changes, it is automatically transferred to data of the client script.
readOnly	Boolean	This attribute allows to set a read-only status to field. For this, set it equal to "true".
style	String	This attribute specifies the display settings (size, font, color, and etc.) of the widget elements using the CSS syntax.
value	String	Specifies the default value for field.

Code Block

language	js
title	string
linenumbers	true

<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

language	js
theme	Eclipse
title	Client Script

;
(() => {
  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);
  } 
})();

<textarea>

A multi-line text field.

The following attributes are applicable:

Attribute	Type	Description
class	String	This attribute allows defining CSS styles classes description and specifying.
isMandatory	Boolean	This attribute allows to set a mandatory status to field. For this, set it equal to "true".
isVisible	Boolean	If this attribute is equal to "true" (by default), then the widget of the type from the list below is displayed; otherwise, it is not displayed.
label	String	A field label with text information generally describing the field content.
model	String	This attribute points to the client controller data object. When the model data changes, it is automatically transferred to data of the client script.
placeholder	String	Specifies the placeholder for text field.
readOnly	Boolean	This attribute allows to set a read-only status to field. For this, set it equal to "true".
style	String	This attribute specifies the display settings (size, font, color, and etc.) of the widget elements using the CSS syntax.
value	String	Specifies the default value for field.

Code Block

language	xml
title	textarea
linenumbers	true

  <textarea model="data.name" label="Name" placeholder="Your search request" value=""></textarea>
  <textarea model="data.description" label="Description" value="" placeholder="Your search request"></textarea>

Table of Contents

class	fixedPosition

Page tree

Versions Compared

Old Version 119

New Version 120

Key

<attachment>

<button>

<checkbox>

<codemirror>

<conditions>

<datetime>

<daysofweek>

<duration>

<html>

<multiselect>

<reference>

<rem>

<remform>

<report>

<select>

<string>

<textarea>

Page tree

Page History

Versions Compared

Old Version 119

New Version 120

Key

<attachment>

<button>

<checkbox>

<codemirror>

<conditions>

<datetime>

<daysofweek>

<duration>

<html>

<modal>

<multiselect>

<reference>

<rem>

<remform>

<report>

<select>

<string>

<textarea>