Page History

canCreateBooleanSpecify the attribute to add the button

Image Removed for

true to add the button Image Added for creating a new record. The default value is false.

class

canRead

String

Define the CSS styles classes description.

Define the attribute it in the Template field of the widget. Then, describe it in the CSS field.

Code Block

language	xml
title	class

<button
  id="addBtn"
  class="button disable"
  event-click="window.s_widget_custom.addParticipants()">
  {data.createCABbuttonTitle}
</button>

Code Block

language	css
title	CSS
collapse	true

.button {
  font-weight: 600;
  font-size: 14px;
  color: #fff;
  display: inline-block;
  vertical-align: top;
  text-align: center;
  border-radius: 4px;
  padding: 0 14px;
  line-height: 30px;
  letter-spacing: 0.2px;
  background-color: #0f8af9;
  white-space: nowrap;
  overflow: hidden;
  text-overflow: ellipsis;
  cursor: pointer;
  height: 32px;
}
.button.disable {
  cursor: not-allowed;
  pointer-events: none;
  color: #c0c0c0;
  background-color: #ffffff;
 }

Boolean

To restrict access to the specified table, set the attribute to false. By default, the value is true.

categoryDescription

String

Specify a table field that contains category descriptions.

categoryIcon

String

Specify a table column that contains category icons.

categorySubject

String

Specify a table field that contains category descriptions.

childDepth

Integer

Specify the depth of the child categories.

choiceConditionName

String

Define the columns that contain data of the Choice type to specify choice options in your condition.

class

String

Specify a CSS class name defined in the CSS field of the widget.

Define the attribute it in the Template field of the widget. Then, describe it in the CSS field.

Code Block

language	xml
title	class

<button
  id="addBtn"
  class="button disable"
  event-click="window.s_widget_custom.addParticipants()">
  {data.createCABbuttonTitle}
</button>

Code Block

language	css
title	CSS
collapse	true

.button {
  font-weight: 600;
  font-size: 14px;
  color: #fff;
  display: inline-block;
  vertical-align: top;
  text-align: center;
  border-radius: 4px;
  padding: 0 14px;
  line-height: 30px;
  letter-spacing: 0.2px;
  background-color: #0f8af9;
  white-space: nowrap;
  overflow: hidden;
  text-overflow: ellipsis;
  cursor: pointer;
  height: 32px;
}
.button.disable {
  cursor: not-allowed;
  pointer-events: none;
  color: #c0c0c0;
  background-color: #ffffff;
 }

All SimpleTags except for the Common tags

attachment>

and Portal tags

condition

String

Specify the condition. It is an equivalent of Reference Qualifier

Code Block

language	xml
title	isFixed
linenumbers	true

<reference
  isFixed="true"
  condition="{data.condition}"
  label="{data.instanceTitle}"
  tableName="sys_cmdb_ci_instance"
  model="data.instance"
  event-change="s_widget_custom.instanceSelected();">
</reference>

Code Block

language	js
theme	Eclipse
title	Server Script

if (!!input.tableName && !!input.caller) {
  data.condition =
    `owned_by=${input.caller}^ORDERBYDESCsys_created_at`;
}

config

String

Configure the Activity Feed. Describe the object in JSON format, as in the example below.

Define the following parameters:

title – change the title of the Activity Feed.
journal – specify the Journal Input fields to display.
columns – filter the fields to display in History.
classes – add classes to style the Activity Feed. These class styles can be redefined.
isNotStylized – remove the styling of the Activity Feed.

date

String

Specify a column containing the item creation date and time (for more details, see the example below).

dateColumn

String

Specify a table column that contains dates related to list items.

dateConditionName

String

Define the columns that contain data of the Date or Date/Time type to specify date ranges in your condition.

disabled

Boolean

Specify whether the button should be disabled. A disabled button cannot be clicked.

displayColumnNumber

Integer

Specify the number of the column, by clicking on which the record opens.

doClose

Function

Specify the function to execute when the modal window or menu is closed.

Code Block

language	xml
title	doClose

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

Code Block

language	js
theme	Eclipse
title	Client Script

window.s_widget_custom.countClosing = function () {
  window.closeCount = window.closeCount + 1 || 1
  s_widget.setFieldValue('isShow', false);
}

elementCount

String

Specify the number of page items. If not specified, then equal to 5 by default.

endDate

String

Specify a maximum possible date for a field.

Code Block

language	xml
title	beginDate

<datetime model="data.dueDate" label="data.dueDateTitle" isMandatory="true" isVisible="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();

<date>

events

String

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

click
context
mouseOver

exclude

Array

Specify the parameters to exclude from the display.

Code Block

language	xml
title	exclude
linenumbers	true

<durationinput value='{data.duration1}' exclude='["days","seconds"]' alignRight='true' onChange="s_widget_custom.onChange1(arguments[0]);"></durationinput>
<durationinput value='{data.duration2}' exclude='["days","seconds"]' alignRight='true' onChange="s_widget_custom.onChange2(arguments[0]);"></durationinput>

fixedCondition

String

Specify the condition applied to the list. Unlike the condition specified with the condition attribute, this condition is fixed and cannot be removed. It can be only specified more precisely.

The attribute work logic is similar to the fixed reference qualifiers.

hint

String

Specify the button text hint.

includeCategories

Boolean

If true, adds categories to the side menu.

includeItems

Boolean

If true, adds items to the side menu.

isAlwaysOpen

Boolean

To make the Activity Feed widget always open, set the attribute equal to true. If the widget is always open, it has no chevron Image Added icon and option to hide.

isFixed

Boolean

Set the true value to disable the editing of the condition value.

Code Block

language	xml
title	isFixed
linenumbers	true

<reference
  isFixed="true"
  isMandatory="true"
  condition="(state!=10)"
  label="Incident"
  model="data.incident_id"
  tableName="itsm_incident">
</reference>

isFullScreenMode

Boolean

Set the attribute to true to display the modal window in full screen when opened on a mobile device.

isMandatory

Boolean

To make a field mandatory, set the attribute equal to true.

Code Block

language	xml
title	isMandatory
linenumbers	true

<select model="data.reason" label="{data.reasonTitle}" options='[{ "database_value": "", "display_value": "--None--" },
      {"database_value": "defect", "display_value": "Defect"},
      {"database_value": "low_test_coverage", "display_value": "Low Test Coverage"},
      {"database_value": "other", "display_value": "Other"}]' value='{"database_value": ""}' isMandatory="true">
</select>

Common SimpleTags except for

isPortal

Boolean

Set the attribute to true to give the tag portal behavior and rendering.

remform>

isRegistration

Boolean

Set to true to make registration available to new users of the service portal. By default, the attribute value is false and only existing users can log in.

isRememberMe

Boolean

Set to true to store the user's credentials on the computer. The default value is false.

isResetPassword

Boolean

Set to true to add a password reset link to the widget form. By default, this feature is disabled and the value is false.

isShow

Boolean

Set the attribute to true to display the modal window or menu.

Code Block

language	xml
title	isShow

<modal
  model="data.modal"
  title="{data.modalTitle}"
  isShow="{data.isShow}">
</modal>

isSwitchLang

Boolean

If the attribute value is false, users cannot change the interface language, and it is displayed in the system language. The default value is true.

isTreeShown

Boolean

Set this attribute value to true to group search results and display the results grouping tree.

isUserScripts/userScripts

Boolean

To disable the client scripts execution, set the false value. The default value is true.

isVisible

Boolean

This attribute is equal to true by default. To disable the tag, set the false value.

Code Block

language	xml
title	isVisible

<string
  model="data.additionalComment"
  isVisible="{data.showComment}">
</string>

Common SimpleTags except for

itemDescription

String

Specify a table field that contains item descriptions.

itemIcon

String

Specify a table column that contains item icons.

itemPage

String

Specify the path to a page in the portal structure.

Example:

itemPage="page" defines the URL slug as page and the whole path has the following view:

https://your_instance_url/page?searchQuery

https://your_instance_url/your_portal/page

itemSubject

String

Specify a table field that contains item titles.

itemView

String

Specify the view used for item rendering.

label

String

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

Code Block

language	xml
title	lable
linenumbers	true

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

Common SimpleTags except for

listView/view

String

Specify a list view to use. Note that first you need to create this view in the List Views (sys_ui_list) table.

logo

String

Define the absolute path to the logo displayed on the authorization page.

For example:

https://example.com/logo.png

maxValue

Integer

Specify the maximum value in milliseconds.

model

String

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

Code Block

language	xml
title	model
linenumbers	true

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

Common SimpleTags and PortalTag <dropdownMenu> except for the Common tags

modelId

String

Use this attribute to specify the Record Extended Model ID to show its attributes.

options

Array

Specify the options available for selecting. Use the CodeMirror JSON formatting

All Simple Tags (except for Portal Tags <attachment>

<sidemenu>)

condition

String

Specify the condition. It is an equivalent of Reference Qualifier in the agent interface.

Code Block

language	xml
title	isFixed
linenumbers	true

<reference
  isFixed="true"
  condition="{data.condition}"
  label="{data.instanceTitle}"
  tableName="sys_cmdb_ci_instance"
  model="data.instance"
  event-change="s_widget_custom.instanceSelected();">
</reference>

Code Block

language	js
theme	Eclipse
title	Server Script

if (!!input.tableName && !!input.caller) {
  data.condition =
    `owned_by=${input.caller}^ORDERBYDESCsys_created_at`;
}

doClose

FunctionSpecify the function to execute when the modal window is closed

.

Code Block

title
language	xml

doClose<modal isShow

options
linenumbers	true

<select model="data.reason" label="{data.

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

Code Block

language	js
theme	Eclipse
title	Client Script

window.s_widget_custom.countClosing = function () {
  window.closeCount = window.closeCount + 1 || 1
  s_widget.setFieldValue('isShow', false);
}

endDate

String

Specify a maximum possible date for a field.

Code Block

language	xml
title	beginDate

<datetime model="data.dueDate" label="data.dueDateTitle" isMandatory="true" isVisible="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();

<datetime>fixedConditionString

Specify a condition applied to the list. Unlike the condition specified with the condition attribute, this condition is fixed and cannot be removed; it can be only specified more precisely.

The attribute work logic is similar to the Reference Qualifiers (fixed).

listitems

isFixed

Boolean

Disable the changing of the condition value by making attribute equal to 'true'.

Code Block

language	xml
title	isFixed
linenumbers	true

<reference
  isFixed="true"
  isMandatory="true"
  condition="(state!=10)"
  label="Incident"
  model="data.incident_id"
  tableName="itsm_incident">
</reference>

isMandatory

Boolean

Enable setting a mandatory status to a field. To do so, set the attribute equal to 'true'.

Code Block

language	xml

<select model="data.reason" label="{data.reasonTitle}" options='[{ "database_value": "", "display_value": "--None--" },
      {"database_value": "defect", "display_value": "Defect"},
      {"database_value": "low_test_coverage", "display_value": "Low Test Coverage"},
      {"database_value": "other", "display_value": "Other"}]' value='{"database_value": ""}' isMandatory="true">
</select>

All Simple Tags (except for Portal Simple Tags and <attachment>

<remform>)

isPortal

BooleanEnable the display of the attributed widget on the Self-Service Portal.

remform>

isShow

Boolean

Enable the display of the modal window.

Code Block

language	xml
title	isShow

<modal
  model="data.modal"
  title="{data.modalTitle}"
  isShow="{data.isShow}">
</modal>

isUserScripts

BooleanDisable the client scripts execution in a form.

isVisible

Boolean

Disable the visibility of a widget. By default, the attribute is equal to 'true'.

Code Block

language	xml
title	isVisible

<string
  model="data.additionalComment"
  isVisible="{data.showComment}">
</string>

All Simple Tags (except for <attachment>)

label

String

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

Code Block

language	xml

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

All Simple Tags (except for <attachment>

<remform>)

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.

Code Block

language	xml

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

All Simple Tags (except for <attachment>

reasonTitle}" options='[{ "database_value": "", "display_value": "--None--" },
      {"database_value": "defect", "display_value": "Defect"},
      {"database_value": "low_test_coverage", "display_value": "Low Test Coverage"},
      {"database_value": "other", "display_value": "Other"}]' value='{"database_value": ""}'>
</select>

parentsDepth

Integer

Specify the depth of the parent category.

placeholder

String

Specify a placeholder for a text field.

Code Block

language	xml
title	placeholder

<textarea
  model="data.name"
  label="Name"
  placeholder="{data.namePlaceholderText}">
</textarea>

<date>

preview

String

Specify a column that contains information for the card preview.

profileUrl

String

Specify the path to the service portal section that contains the current user's profile page.

If specified, the Profile item is available in the user menu. Otherwise, this item is not available, and users cannot open their profiles.

quantity

Integer

Specify the maximum number of the search results per page.

radioButtonsMode

Boolean

Set the attribute to true to display choice options in the form of radio buttons. Otherwise, the standard drop-down list is used.

readOnly/isReadOnly

Boolean

To make the field read-only, set the attribute equal to true.

Code Block

language	xml

<select model="data.state" label="{data.stateTitle}" options='[
      {"database_value": "registered", "display_value": "Registered"},
      {"database_value": "open", "display_value": "Open"},
      {"database_value": "in_progress", "display_value": "In Progress"}]' value='{"database_value": ""}'
  readOnly="true">
</select>

Common SimpleTags except for

recordId

String

Specify an ID of an existing record to extend. When using, do not forget to specify a table (use the tableName attribute). See the example code for the <rem> SimpleTag.

Code Block

language	xml
theme	Eclipse
title	recordId

<rem modelId="{data.model_id}" tableName="{data.table_name}" recordId ="{data.record_id}" />

redirectTo

String

Specify the path to redirect a user to the service portal after successful authorization.

reportId

String

Specify the report ID for viewing.

Code Block

language	xml
title	reportId

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

save

Sting

Add a Save button on the form with the customized text (see the code example below).

It makes sense to use this attribute when it is impossible to use the UI actions due to any reasons (the uiActions attribute is equal to false).

saveButtonCaption

String

Specify a text displayed on the Save button on the portal form.

Code Block

language	xml
theme	Eclipse
title	saveButtonCaption

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

searchUrl

String

Specify the URL path that determines which page the user will be redirected to after clicking the Search button.

searchQuery

String

Add a search bar initial value.

searchQuery

String

Add a search bar to perform search requests and display results.

showTitle

Boolean

To enable the title displaying, set the attribute value equal to true. The default value is false.

size

String

Specify the search bar size. Available values:

lg (large)
sm (small)

size

String

Specify the dropdown menu size by selecting from the predefined options:

low (224px)
large (464px)

shortDescription

String

Add a short description for the card.

<card>

stateColumn

String

Specify a table column that contains item states.

style

String

Specify the display settings (size, font, color, and others.) of the tag elements using the CSS syntax.

Code Block

language	xml
title	style

<textarea
  model="data.notes"
  label="Notes"
  style="height: 328px; width: 100%; padding: 32px 64px 40px 64px;">
</textarea>

Common SimpleTags except for

subjectColumn

String

Specify a table column that contains item subjects.

svg/img

String

Specify the code of the SVG file with the pre-decoded image or a link to the image.

<card>

sysId

String

Specify the ID of the table record. The table should be specified first via the tableName attribute. If the <activityFeed> tag is specified near the <Form> tag, the value of this attribute is populated automatically with the value from the relevant <Form> attribute.

tableId

Big Integer

Specify the table ID that the tag refers to.

tableName

String

Specify the table title that the tag refers to.

Code Block

language	xml
title	tableName
linenumbers	true

<reference
  isFixed="true"
  isMandatory="true"
  condition="(state!=10)"
  label="Incident"
  model="data.incident_id"
  tableName="itsm_incident">
</reference>

title

String

Specify the modal window or search title.

Code Block

language	xml
title	isShow

<modal
  title="{data.modalTitle}"
  isShow="{data.isShow}"
</modal>

titleHide

Boolean

If set to true by default, the form header is hidden.

top

Integer

Specify the number of first matches to display in the search autosuggestion.

transparent

Boolean

Set this attribute to true to change the style of the list and make its background transparent. It is false by default.

tsGroupId

String

Enter an ID of the table group to specify the search area. Find the necessary information in the Text Search Group (ts_group) table.

UiActions

Boolean

Set this attribute value to true to make UI actions available to use. Otherwise, their usage is prohibited (except for the Save button specified by the save attribute).

url

String

Specify a URL that defines the page for this card.

<card>

user

String

Specify a column that contains the information about the item originator (for more details, see the example below).

useSourceUrl

Boolean

Set to true to keep the original URL after a redirect if the user has not previously logged in. The default value is false.

Note
If the attribute value is true, it is a higher priority than the redirectTo attribute value.

modelId

StringUse this attribute to specify the Record Extended Model ID when configuring a form extension.

options

Array

Specify the options available for selecting. Use the CodeMirror JSON formatting to set the necessary options.

Code Block

language	xml

<select model="data.reason" label="{data.reasonTitle}" options='[{ "database_value": "", "display_value": "--None--" },
      {"database_value": "defect", "display_value": "Defect"},
      {"database_value": "low_test_coverage", "display_value": "Low Test Coverage"},
      {"database_value": "other", "display_value": "Other"}]' value='{"database_value": ""}'>
</select>

placeholder

String

Specify a placeholder for a text field.

Code Block

language	xml
title	placeholder

<textarea
  model="data.name"
  label="Name"
  placeholder="{data.namePlaceholderText}">
</textarea>

readOnly

Boolean

To make a fiels read-only, set the attribute value equal to 'true'.

Code Block

language	xml

<select model="data.state" label="{data.stateTitle}" options='[
      {"database_value": "registered", "display_value": "Registered"},
      {"database_value": "open", "display_value": "Open"},
      {"database_value": "in_progress", "display_value": "In Progress"}]' value='{"database_value": ""}'
  readOnly="true">
</select>

All Simple Tags (except for Portal Tags, <attachment>

<remform>)

recordId

String

Specify a record ID for the extention. When using, do not forget to specify a table (use the tableName attribute for this). See the example code for the <rem> SimpleTag.

Code Block

language	xml
theme	Eclipse
title	recordId

<rem modelId="{data.model_id}" tableName="{data.table_name}" recordId ="{data.record_id}" />

reportId

String

Specify the report ID for viewing.

Code Block

language	xml
title	reportId

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

saveButtonCaption

String

Specify a text displayed on the Save button on the portal form.

Code Block

language	xml
theme	Eclipse
title	saveButtonCaption

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

style

String

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

Code Block

language	xml
title	style

<textarea
  model="data.notes"
  label="Notes"
  style="height: 328px; width: 100%; padding: 32px 64px 40px 64px;">
</textarea>

All Simple Tags (except for <attachment>

<button>)

tableId

Big Integer

Specify the referenced dictionary by its ID.

tableName

String

Specify the referenced dictionary.

Code Block

language	xml
title	tableName
linenumbers	true

<reference
  isFixed="true"
  isMandatory="true"
  condition="(state!=10)"
  label="Incident"
  model="data.incident_id"
  tableName="itsm_incident">
</reference>

title

String

Specify the modal window title.

Code Block

language	xml
title	isShow

<modal
  title="{data.modalTitle}"
  isShow="{data.isShow}"
</modal>

value

String (Array for the <list> tag)

Specify the default value for a field.

Code Block

language	xml
title	value

<checkbox
  model="data.locked_out"
  label="{data.lockedOutLabel}"
  value="true">
</checkbox>

Code Block

language	xml
theme	Eclipse
title	List

<list label="Configuration Item" model="data.element" tableName="cmdb" isMandatory="true" condition="{data.condition

}" value='[{"database_value":"","display_value":""},

}" value='[{"database_value":"1","display_value":"First"},{"database_value":"2","display_value":"Second"}]'></list>

All Simple Tags (

Common SimpleTags except for

)

values

String

Array

Specify the default value for a field.

Code Block

language	xml
title	values

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

}]'></multiselect>

view

String

Define a view name of the table, for example, Default.