You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 108 Next »

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. 

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:

AttributeTypeDescription
classStringThis attribute allows defining CSS styles classes description and specifying.
isMandatoryBooleanThis attribute allows to set a mandatory status to field. For this, set it equal to "true".
isVisibleBooleanIf 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.
labelStringA 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".

styleString

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

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

value

String

Specifies the default value for field.

attachment
<attachment></attachment>



<button>

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

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

AttributeTypeDescription
classStringThis attribute allows defining CSS styles classes description and specifying.
isMandatoryBooleanThis attribute allows to set a mandatory status to field. For this, set it equal to "true".
isVisibleBooleanIf 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.
labelStringA field label with text information generally describing the field content.
modelStringThis attribute points to the client controller data object. When the model data changes, it is automatically transferred to data of the client script.
readOnlyBooleanThis attribute allows to set a read-only status to field. For this, set it equal to "true".
styleString

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

valueStringSpecifies the default value of the field.
checkbox
<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:

AttributeTypeDescription
classStringThis attribute allows defining CSS styles classes description and specifying.
isMandatoryBooleanThis attribute allows to set a mandatory status to field. For this, set it equal to "true".
isVisibleBooleanIf 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.
labelStringA field label with text information generally describing the field content.
modelStringThis 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".

styleString

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.

Codemirror
<codemirror model="data.mirror"></codemirror>



<conditions>

Adds the condition builder widget.

The following attributes are applicable:

AttributeTypeDescription
classStringThis attribute allows defining CSS styles classes description and specifying.
modelStringThis attribute points to the client controller data object. When the model data changes, it is automatically transferred to data of the client script.
isMandatoryBooleanThis attribute allows to set a mandatory status to field. For this, set it equal to "true".
isVisibleBooleanIf 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.
labelStringA 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".

styleString

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

tableIdBig IntegerConnection with a table by the ID.
tableNameStringConnection with a table by its name.

value

String

Specifies the default value for field.


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

AttributeTypeDescription
classStringThis attribute allows defining CSS styles classes description and specifying.
isMandatoryBooleanThis attribute is responsible for specifying whether this input field is mandatory or not.
isVisibleBooleanIf 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.
labelStringA field label with text information generally describing the field content.
modelStringThis 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".

styleString

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.

datetime
<datetime model="data.dueDate" label="Date and Time" isMandatory="true" isVisible="true" readOnly="false"></datetime>



<daysofweek>

The element adds a field that allows selecting days of week.

The following attributes are applicable:

AttributeTypeDescription
classStringThis attribute allows defining CSS styles classes description and specifying.
isMandatoryBooleanThis attribute allows to set a mandatory status to field. For this, set it equal to "true".
isVisibleBooleanIf 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.
labelStringA field label with text information generally describing the field content.
modelStringThis 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".

styleString

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.

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

AttributeTypeDescription
classStringThis attribute allows defining CSS styles classes description and specifying.
isMandatoryBooleanThis attribute allows to set a mandatory status to field. For this, set it equal to "true".
isVisibleBooleanIf 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.
labelStringA field label with text information generally describing the field content.
modelStringThis 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".

styleString

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.

duration
<duration model="data.duration"></duration>



<html>

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

The following attributes are applicable:

AttributeTypeDescription
classStringThis attribute allows defining CSS styles classes description and specifying.
isMandatoryBooleanThis attribute allows to set a mandatory status to field. For this, set it equal to "true".
isVisibleBooleanIf 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.
labelStringA field label with text information generally describing the field content.
modelStringThis 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".

styleString

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.

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



<modal>

A modal window solution.

The following attributes are applicable:

AttributeTypeDescription
classStringThis attribute allows defining CSS styles classes description and specifying.
doCloseFunction

Specify actions to perform after one of the predefined patterns is selected:

  • click
  • context
  • mouseOver
isMandatoryBooleanThis attribute allows to set a mandatory status to field. For this, set it equal to "true".
isShowBooleanIf this attribute is equal to "true", then the modal window is displayed.
isVisibleBooleanIf 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.
labelStringA 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".

styleString

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

titleStringSpecifies the modal window title.

value

String

Specifies the default value for field.


modal
<modal
  title="{data.modalTitle}"
  isShow="{data.isShow}"
  doClose="window.s_widget_custom.countClosing();">
</modal>



<multiselect>

Provides multiple choice selection for widgets.

The following attributes are applicable:

AttributeTypeDescription
canExcludeAllBooleanThis parameter is responsible for items deselecting; if it's equal to TRUE, then bulk item selection cancellation is available.
classStringThis attribute allows defining CSS styles classes description and specifying.
isMandatoryBooleanThis attribute allows to set a mandatory status to field. For this, set it equal to "true".
isVisibleBooleanIf 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.
labelStringA field label with text information generally describing the field content.
modelStringThis attribute points to the client controller data object. When the model data changes, it is automatically transferred to data of the client script.
optionsString

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.

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".

styleString

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

valuesStringSpecify values for the selection.


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

AttributeTypeDescription
classStringThis attribute allows defining CSS styles classes description and specifying.
conditionStringSpecify a condition query.
isFixedBooleanWhen this attribute is equal to 'true', then the condition value cannot be changed.
isMandatoryBooleanThis attribute allows to set a mandatory status to field. For this, set it equal to "true".
isVisibleBooleanIf 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.
labelStringA field label with text information generally describing the field content.
modelStringThis 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".

styleString

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

tableNameStringConnection with a table by its name.

value

String

Specifies the default value for field.


reference
<reference label="Configuration Item" model="data.element" tableName="cmdb" isMandatory="true" condition="{data.condition}"></reference>



<report>

Add this SimpleTag to display a particular report.

The following attributes are applicable:

AttributeTypeDescription
classStringThis attribute allows defining CSS styles classes description and specifying.
conditionStringSpecify a condition to build a report.
isMandatoryBooleanThis attribute allows to set a mandatory status to field. For this, set it equal to "true".
isVisibleBooleanIf 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.
labelStringA field label with text information generally describing the field content.
modelStringThis 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".

styleString

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

reportIdStringSpecify the report with the appropriate ID to display.

value

String

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:

Condition wordNotationExample
AND^emailLIKE-group^state=active
OR^ORimpact=high^ORurgency=high

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

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



<select>

A field that allows selecting items.

The following attribute is applicable:

AttributeTypeDescription
classStringThis attribute allows defining CSS styles classes description and specifying.
isMandatoryBooleanThis attribute allows to set a mandatory status to field. For this, set it equal to "true".
isVisibleBooleanIf 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.
labelStringA field label with text information generally describing the field content.
modelStringThis 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".

optionsStringThis 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.
styleString

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.


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

AttributeTypeDescription
classStringThis attribute allows defining CSS styles classes description and specifying.
isMandatoryBooleanThis attribute allows to set a mandatory status to field. For this, set it equal to "true".
isVisibleBooleanIf 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.
labelStringA field label with text information generally describing the field content.
modelStringThis 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".

styleString

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.

string
<string model="data.lastname" event-change=";(() => { const lastname = s_widget.getFieldValue('lastname') || ''; const firstname = s_widget.getFieldValue('firstname') || ''; s_widget.setFieldValue('fullname', lastname + ' ' + firstname) })();"></string>
<string model="data.firstname" event-change=";(() => { const lastname = s_widget.getFieldValue('lastname') || ''; const firstname = s_widget.getFieldValue('firstname') || ''; s_widget.setFieldValue('fullname', lastname + ' ' + firstname) })();"></string><h1>{data.fullname}</h1>
// In this example, we put values into two fields, and after that, they are displayed concatenated and formatted with H1 tag.



<textarea>

A multi-line text field.

The following attributes are applicable:

AttributeTypeDescription
classStringThis attribute allows defining CSS styles classes description and specifying.
isMandatoryBooleanThis attribute allows to set a mandatory status to field. For this, set it equal to "true".
isVisibleBooleanIf 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.
labelStringA field label with text information generally describing the field content.
modelStringThis attribute points to the client controller data object. When the model data changes, it is automatically transferred to data of the client script.
placeholderStringSpecifies 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".

styleString

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.


textarea
  <textarea model="data.name" label="Name" value=""></textarea>
  <textarea model="data.description" label="Description" value=""></textarea>

  • No labels