Page History

When creating a widget, define its form, fields, and their behavior by behavior using the template elements to specify the widget view and the way it displays is displayed with HTML and and Widget Attributes. The widget template also allows end-users to input enter data and interact with it. Apply You can apply HTML tags to add and control elements such as buttons and various types of fields.

<authfull>

An Authorization widget component that contains full functionality of the user authorization including form of registration. It also supports configurable validation in strings containing user login and password.

The following attributes are applicable:

AttributeTypeDefault valueRequiredDescriptionisRegistrationBooleanFalse

This attribute is responsible for the ability of the new users' registration. If it is set to "true", then new portal users can sign up; otherwise, this is prohibited, and only existing users can sign in.

Possible attribute values: "true" or "false".

isSwitchLangBooleanTrueThis attribute is responsible for ability of user locale switching on authorization page. If this attribute is equal to 'false', then the user will not be able to change the interface language, and will use the default system language.isRememberMeBooleanFalseThis attribute is responsible for specifying whether should user credentials be saved on this computer or not. To save the credentials, make this attribute equal to "true".logoString''

Absolute path to the logo displayed on authorization page. For example:

https://example.com/logo.png

isResetPasswordBooleanFalse

This attribute is responsible for the ability of the user password retrieving. If it is set to "true", then the widget form will contain the retrieval link.

Possible attribute values: "true" or "false".

redirectToString''Specify the path to the portal where to redirect after successful authorization.

Code Block

language	xml
title	authfull
linenumbers	true

<authfull redirectTo="/portal" isRegistration="true" isSwitchLang="true" isRememberMe="false" isResetPassword="true"></authfull>

<authheader>

This portal widget allows to display a user's name and avatar, or prompts them to log in if they haven't already. The following attributes are applicable:

AttributeTypeDefault valueRequiredDescriptionprofileUrlString

Specify the path to the portal section containing the personal pages when the model item is clicked.

Info
If specified, then the Profile item is available in the User Menu; otherwise, this item is not available, and the user is not available to watch the profile.

Image Removed

Code Block

language	xml
title	authheader
linenumbers	true

<authheader profileURL="/portal/cabinet">

<breadcrumbs>

A Breadcrumbs widget component that displays a navigation chain trailing user activity.

This widget uses the object received from the server script to build the breadcrumbs chain with the format below:

{sys_id, title, url}

Image Removed

<card>

You can use this widget as part of the different system functionality, for example, Self-Service Portal, or Taskboards.

The following attributes are applicable:

AttributeTypeDefault valueRequiredDescriptionurlStringAn URL defining the page for this card. imgStringIn this field, specify the code of SVG image file (previously decoded).,nameStringThe card title.short_descriptionStringThe card short description.

Code Block

language	xml
theme	Eclipse
title	card
linenumbers	true

<div class="main-body__cards__column__items">
<card url="second_portal/catalog" name={data.catalogTitle} short_description={data.catalogDescription} img='<svg version="1.0" xmlns="http://www.w3.org/2000/svg" width="240" height="240" viewBox="0 0 180 180"><path d="M84 .7C43.9 3.4 10.8 32.2 2.5 71.6c-1.7 8.1-1.9 26.5-.4 35 6 33.7 31.9 61.6 65.7 70.6 11.2 2.9 33.5 2.9 44.7-.1 30.4-8.1 54.6-31.7 63.4-61.8 4.8-16.6 5.1-30 1-46.3-6.2-24.8-21.7-45.2-43.9-57.8C120 3.9 100.2-.4 84 .7zm21.6 11.4c24.3 4.5 45.7 21.4 56.8 45 5.4 11.4 6.9 18.6 7 32.9 0 15.3-1.5 21.6-8.6 36-4.5 9.3-6.3 11.6-14.7 20-7.8 7.8-11.3 10.5-18.7 14.3-13.5 6.9-22.3 9-37.4 9-10 0-14.1-.4-20.5-2.3-28.1-8-49.2-29.3-56.7-57.2-2.9-10.9-3.1-27.1-.4-37.8 7.4-29.7 31.1-53.2 60-59.5 7.5-1.7 25.2-1.9 33.2-.4z"/><path d="M45 57c-4.3 4.3-1.4 11 4.8 11 5.6 0 8.2-7 4.2-11-1.1-1.1-3.1-2-4.5-2s-3.4.9-4.5 2zM69 58.9c-1.6 3.1-1.2 4.9 1.4 6.6 2.1 1.4 6.6 1.5 33.5 1.3 33.4-.3 33-.3 33.1-5.3 0-4.4-.8-4.5-34.7-4.5-30.8 0-32.3.1-33.3 1.9zM48 83.8c-5 1.6-6.6 7.6-3 11.2 5.7 5.7 14.2-2 9.5-8.7-1.6-2.2-4.1-3.2-6.5-2.5zM69.6 86.6c-1.9 1.8-2 3.8-.6 6.5 1 1.8 2.3 1.9 23 1.9 18.5 0 22.1-.2 23.4-1.6 2.1-2.1 2-4.7-.2-6.7-2.7-2.5-43.2-2.5-45.6-.1zM45 114c-4.3 4.3-1.4 11 4.8 11 5.6 0 8.2-7 4.2-11-1.1-1.1-3.1-2-4.5-2s-3.4.9-4.5 2zM69 115.9c-1.5 2.8-1.2 4.6.8 6.4 1.6 1.5 5.4 1.7 32.9 1.7 28.8 0 31.1-.1 32.6-1.8 2-2.2 2.2-5.3.5-7-.9-.9-9.7-1.2-33.5-1.2-30.8 0-32.3.1-33.3 1.9z"/></svg>'></card>
</div>

<category>

This widget is a component that displays portal categories and items structure. It interacts with some other widgets, like <breadcrumbs> or <sidemenu> widgets.

The following attributes are applicable:

AttributeTypeDefault valueRequiredDescriptionnodeIdIDYPortal node name.categorySubjectStringY

Specify a table field containing category titles.

categoryDescriptionStringYSpecify a table field containing category descriptions. itemSubjectStringYSpecify a table field containing item titles.itemDescriptionStringYSpecify a table field containing item descriptions.categoryIconStringNSpecify a table column containing category icons.itemIconStringNSpecify a table column containing item icons.

Code Block

language	xml
title	category
linenumbers	true

<Category nodeId="158766114011088368" categorySubject="name" categoryDescription="short_description" itemDescription="vendor" itemSubject="city"></Category>

<dropdownMenu>

Creates a dropdown menu with menu elements with any nesting level.

The following attributes are applicable:

AttributeTypeDefault valueRequiredDescriptionsizeString

The dropdown menu size. You can specify it by choosing from predefined options:

low (224px)
large (464px).

eventsString

The code section defining events. Available predefined actions:

click
context
mouseOver

event_to_displayStringSpecify an action for the event.isShowBooleanThis attribute is responsible for menu displaying.doCloseFunctionThis is a method defining an additional action when the menu closes.modelString

Code Block

language	xml
theme	Eclipse
title	dropdownMenu
linenumbers	true

<dropdownMenu model="data.menu"></dropdownMenu>

Code Block

language	xml
title	dropdown_widget model example
linenumbers	true
collapse	true

; (() => {
    data.menu = {
        "menu": {
    "size": "low",
    "event_to_display": [
        "click"
    ],
    "sections": [
        {
            "order": "1",
            "elements": [
                {
                    "title": "Text",
                    "order": "1",
                    "event_to_display": ["click"],
                    "events": {
                        "click": "runScript()"
                    },
                    "child_elements": [
                        {
                            "title": "Text22",
                            "event_to_display": ["click"],
                            "events": {
                                "click": "runScript()"
                            },
                            "child_elements": [
                            {
                            "title": "Text2",
                            "event_to_display": ["click"],
                            "events": {
                                "click": "runScript()"
                            },
                            "child_elements": []
                        }
                            ]
                        }
                    ]
                },
                {
                    "title": "Title",
                    "order": "2",
                    "event_to_display": ["click"],
                    "events": {
                        "click": "runScript()"
                    },
                    "child_elements": [
                        {
                            "title": "Text2",
                            "event_to_display": ["click"],
                            "events": {
                                "click": "runScript()"
                            },
                            "child_elements": []
                        }
                    ]
                }
            ]
        },
        {
            "order": "2",
            "elements": [
                {
                    "title": "Text",
                    "order": "1",
                    "event_to_display": ["click"],
                    "events": {
                        "click": "runScript()"
                    },
                    "child_elements": []
                }
            ]
        }
    ]
}
    }
})();

<form>

The dynamic form creating component. The following attributes are applicable:

AttributeTypeDefault valueRequiredDescriptiontableNameStringSpecify the table name.viewStringDefines a name of the table template view, for example, "Default"saveString

Specifying this attribute will add a Save button on the form with the customized text (see the code example below).

Tip
Make sense to use this attribute when UI actions using is prohibited due to any reasons (the ui-actions attribute is equal to false).

ui-actionsBooleanThis attribute is responsible for using UI actions on the widget form. When set to true, then UI actions are available to use; otherwise, their usage is prohibited (except for the Save button specified by the save attribute).user-scriptsBooleanThis attribute is responsible for using user scripts defined in the Client Script field on the widget form. When set to true, then client scripts are available to use; otherwise, their usage is prohibitedsysidIDNID of the table record (table should specified first via the tableName attribute). This field is not mandatory.

Code Block

language	xml
title	form
linenumbers	true

<Form tableName="user" sysid="158747771611397284"  view="Profile" save="Custom save button" ui-actions="false" user-scripts="true"/>

<listitems>

This widget allows displaying table items as a list view.

The following attributes are applicable:

AttributeTypeDefault valueRequiredDescriptionclassStringSpecify a CSS class name defined in the CSS field. See the screenshot below the table to learn more.tableNameStringYSpecify a table containing output elements to display. This attribute is mandatory.listViewStringY

Specify a list view to use (this view need to be created first in the UI list (sys_ui_list) dictionary).

viewString

This attribute allows us to specify the view adjustability. Available attribute options:

adjustable - in this case, you can adjust the widget size to be able to use more than one widget on the page.
full - when this option is specified, the widget uses all the valuable page space.

itemPageString

Specify the path to a page in the portal structure.

Example:

If you set itemPage="page" as shown in code example below, then your URL may look like this:

https://your_instance_url/page

itemViewStringSpecify the view used for item rendering.conditionString

Specify a condition applied to the list. This attribute should contain data of the Conditions type.

choiceConditionNameString

This attribute is to specify columns containing data of the Choice type if you need to specify choice options in your condition.

dateConditionNameString

This attribute is to specify columns containing data of the Date or Date/Time type if you need to specify date ranges in your condition.

perPageInteger5Specify the number of page items.displayColumnNumberInteger1Specify a column number to open a record by clicking on it.

Code Block

language	xml
theme	Eclipse
title	listitems
linenumbers	true

<listitems class="linkStyles" tableName="itsm_incident" condition="" listView="Default" itemPage="page" itemView="view" choiceConditionName="class" dateConditionName="sys_created_at" perPage="25" displayColumnNumber="2"></listitems>

Image Removed

<previewList>

This list view widget allows displaying table items as a customizable list.

The following attributes are applicable:

AttributeTypeDefault valueRequiredDescriptiontableNameStringSpecify a table containing items to display on the list view.viewStringSpecify a list view name used.elementCountString5Specify the number of page items. If not specified, then equal to '5'by default. subjectColumnStringSpecify a table column containing list item subjects.dateColumnStringSpecify a table column containing dates related to list items. stateColumnStringSpecify a table column containing list item states.transparentBooleanSet this attribute to "true" to set up the full view.wrapBooleanSet this attribute to "true" to set up the quick view.itemViewStringSpecify the view used for item rendering.ListHeaderStringThis attribute allows to provide the list header.

Code Block

language	xml
title	previewList
linenumbers	true

<previewList tableName="announcement" view="AnnounceView" elementCount="3" subjectColumn="subject" dateColumn="sys_created_at" stateColumn="state" wrap="true" itemView="announceView"><ListHeader><div>Announcements</div></ListHeader></previewList>

<results>

A widget responsible for displaying the Search results.

The following attributes are applicable:

AttributeTypeDefault valueRequiredDescriptionitemPageString

Specify a path to a page in the portal structure.

Example:

If you set pageItem="page" as shown in code example below, then your search URL may look like this:

https://your_instance_url/page?searchQuery

itemViewStringSpecify a view name responsible for the search results page looking.quantityStringSpecify the maximum search results amount per page.searchQueryStringSearch bar input string to perform search request and display results.tsGroupIdBig IntegerEnter an ID of the table group to specify the search area.

Example:

Code Block

language	xml
theme	Eclipse
title	results

<results searchQuery="{data.search}" tsGroupId="157018693719021198" quantity="4" itemPage="page" itemView="view">

<search>

A Search widget component responsible for search functionality.

AttributeTypeDefault valueRequiredDescriptionitemPageString

Specify a path to a page in the portal structure..

Example:

If you set itemPage="page" as shown in code example below, then your search URL may look like this:

https://your_instance_url/page?searchQuery

itemViewStringSpecify a view name responsible for the search page looking.onChangeStringSpecify a function called when clicking the Search button.placeholder String

A text inside the search field.

searchUrl StringAn URL suffix defining a page to redirect to after clicking the Search button.searchQueryStringSearch bar initial value.showTitleBooleanA boolean-type attribute with possible true or false values. It is responsible for title displaying.size StringSpecifies the search bar size. Available values: lg (large) or sm (small).titleStringN

Define a custom title instead of a default one.

To use a custom title, please set a showTitle attribute equal to true first.

topIntegerHow many matches should be shown in search suggestion.tsGroupIdBig IntegerEnter an ID of the table group to specify the search area. You can find the necessary information in the Text Search Group (ts_group) table.

Code Block

language	xml
theme	Eclipse
title	Search
linenumbers	true

<search tsGroupId="157018693719021198" top="3" size="lg" itemPage="page" itemView="view" showTitle="1" onChange="s_widget_custom.search(arguments[0]);">

<sidemenu>

This widget adds a side-menu.

The following attributes are applicable:

AttributeTypeDefault valueRequiredDescriptionsimple-classStringSpecify a CSS class name defined in the CSS field.parents_depthIntegerSpecify the depth of the parent category.children_depthIntegerSpecify the depth of the child categories.include_categoriesBooleanThis attribute is responsible for including categories into the sidemenu.include_itemsBooleanThis attribute is responsible for including items into the sidemenu.

Code Block

language	xml
theme	Eclipse
title	Sidemenu
linenumbers	true

<SideMenu
simple-class="Main"
parents_depth="1"
children_depth="1"
   include_categories="1"
   include_items="1">\
</SideMenu>

Table of ContentsclassfixedPosition

Page tree

Versions Compared

Old Version 51

New Version Current

Key

<authfull>

<authheader>

<card>

<category>

<dropdownMenu>

<form>

<listitems>

<previewList>

<results>

<search>

<sidemenu>