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>

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

The following attributes are applicable:

AttributeTypeDefault valueRequiredDescriptionclassString""NSpecify a CSS class name defined in the CSS field.isRegistrationBoolean"false"N

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

isSwitchLangBoolean"true"NThis 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.isRememberMeBoolean"false"NThis 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""N

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

https://example.com/logo.png

isResetPasswordBoolean"false"N

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""NSpecify 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 component allows displaying a user's name and avatar, or prompts them to log in if they haven't already. The following attributes are applicable:

AttributeTypeDefault valueRequiredDescriptionclassString""'NSpecify a CSS class name defined in the CSS field.profileUrlString'""N

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 portal tag allows to display a navigation chain consisting of page nodes, portal categories and a an terminating item (a page, for example).

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

{sys_id, title, url}

Image Removed

<card>

You can use this tag part of the different system functionality, for example, Portals, or Taskboards.

The following attributes are applicable:

AttributeTypeDefault valueRequiredDescriptionclassString""NSpecify a CSS class name defined in the CSS field.urlString"/"NAn URL defining the page for this card. imgStringellipse.svg (icon)NIn this field, specify the code of SVG image file (previously decoded).,nameString""YThe card title.shortDescriptionString""NThe 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} shortDescription={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 portal tag is a component allowing displaying portal categories and items structure. It interacts with some other widgets, like <breadcrumbs> or <sidemenu> widgets.

The following attributes are applicable:

AttributeTypeDefault valueRequiredDescriptionclassString""NSpecify a CSS class name defined in the CSS field.nodeIdBig Integer""NPortal node ID.categorySubjectString""Y

Specify a table field containing category titles.

categoryDescriptionString""YSpecify a table field containing category descriptions. itemSubjectString""YSpecify a table field containing item titles.itemDescriptionString""YSpecify a table field containing item descriptions.categoryIconString""NSpecify a table column containing category icons.itemIconString""NSpecify 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" itemIcon="icons"></Category>

<categoryFlat>

This portal tag is intended to display various portal object categories, for example, Knowledge Base categories. It involves two elements types: subcategories and category elements; subcategory go first in element hierarchy, and elements do go second.

The following attributes are applicable:

AttributeTypeDefault valueRequiredDescriptionclassString""NSpecify a CSS class name defined in the CSS field.nodeIdBig Integer""NPortal node name.categorySubjectString""Y

Specify a table field containing category titles.

categoryDescriptionString""YSpecify a table field containing category descriptions. itemSubjectString""YSpecify a table field containing item titles.itemDescriptionString""YSpecify a table field containing item descriptions.categoryIconString""NSpecify a table column containing category icons.itemIconString""NSpecify a table column containing item icons.userString""NSpecify a column from which the information about item originator should be taken (for better clarity, see the example below).dateString""NSpecify a column from which the item creation date and time should be taken (for better clarity, see the example below).previewString""NSpecify a column containing information can be used for the card preview.

Code Block

language	xml
title	categoryFlat
linenumbers	true

<CategoryFlat nodeId="158934872713077631" categorySubject="name" categoryDescription="description"  itemDescription="body" itemSubject="name" date="sys_created_at" user="sys_created_by"></CategoryFlat>

<dropdownMenu>

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

The following attributes are applicable:

AttributeTypeDefault valueRequiredDescriptionclassString""NSpecify a CSS class name defined in the CSS field.sizeString""Y

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

low (224px)
large (464px).

eventsString""Y

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

click
context
mouseOver

isShowBooleanfalseNThis attribute is responsible for menu displaying.doCloseFunction""NThis is a method defining an additional action when the menu closes.modelString"{}"YA reference to the dynamic variable storing a menu items and actions.

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>

This tag is responsible for displaying a record form. For more information, please refer to the Form Widget Tag article.

<listitems>

The list of records portal tag allows displaying table items as a list view.

The following attributes are applicable:

AttributeTypeDefault valueRequiredDescriptionclassString""NSpecify a CSS class name defined in the CSS field. See the screenshot below the table to learn more.tableNameString""YSpecify a table containing output elements to display. This attribute is mandatory.listViewString""Y

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

itemPageString""Y

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

itemViewString""YSpecify the view used for item rendering.conditionString""N

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

choiceConditionNameString""N

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

dateConditionNameString""N

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.

perPageInteger"20"NSpecify the number of page items.displayColumnNumberInteger""NSpecify 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="Widget" itemPage="page" itemView="view" choiceConditionName="sys_created_at" dateConditionName="sys_created_at" perPage="25" displayColumnNumber="2"></listitems>

Image Removed

<previewList>

This list view portal tag allows displaying table items as a customizable list.

The following attributes are applicable:

AttributeTypeDefault valueRequiredDescriptionclassString""NSpecify a CSS class name defined in the CSS field.tableNameString""YSpecify a table containing items to display on the list view.viewString""NSpecify a list view name used.elementCountString"20"NSpecify the number of page items. If not specified, then equal to '5' by default. subjectColumnString"subject"Specify a table column containing list item subjects.dateColumnString"sys_created_at"Specify a table column containing dates related to list items. stateColumnString"state"Specify a table column containing list item states.transparentBoolean"false"Set this attribute to "true" to set up the full view.wrapBoolean"false"Set this attribute to "true" to set up the quick view.itemViewString"Default"Specify the view used for item rendering.ListHeaderString""This 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 portal tag responsible for displaying the Search results.

The following attributes are applicable:

AttributeTypeDefault valueRequiredDescriptionclassString""NSpecify a CSS class name defined in the CSS field.isTreeShownBoolean"false"itemPageString""Y

Specify a path to a page in the portal structure. This attribute is responsible for customizing search results page URL.

Example:

If you set the pageItem attribute value to "page", as shown in code example below, then your search results URL will look alike

https://your_instance_url/page?searchQuery

itemViewString"Default"NSpecify a view name for a specified search result when opened. If not specified, then the record is opened with the Default view.quantityString""NSpecify the maximum search results amount per page.searchQueryString""NSearch bar input string to perform search request and display results.tsGroupIdBig Integer""NEnter 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="Default">

<search>

A portal tag responsible for search functionality implementing.

AttributeTypeDefault valueRequiredDescriptionclassString""NSpecify a CSS class name defined in the CSS field.itemPageString""Y

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

itemViewString"Default"NSpecify a view name responsible for the search page looking.onChangeFunction""NSpecify a function called when clicking the Search button.placeholder String""N

A text inside the search field.

resultPageStringsearchUrl String""NA URL suffix defining a page to redirect to after clicking the Search button.searchQueryString""NSearch bar initial value.showTitleBoolean"false"NA boolean-type attribute with possible true or false values. It is responsible for title displaying.size String""NSpecifies the search bar size. Available values: lg (large) or sm (small).titleString""N

Define a custom title instead of a default one.

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

topInteger"0"NHow many matches should be shown in search suggestion.tsGroupIdBig Integer""NEnter 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="Service Portal RO" showTitle="1" onChange="s_widget_custom.search(arguments[0]);">

<sidemenu>

This tag allows to add a side-menu.

The following attributes are applicable:

AttributeTypeDefault valueRequiredDescriptionparentsDepthInteger0YSpecify the depth of the parent category.childrenDepthInteger0YSpecify the depth of the child categories.includeCategoriesBoolean"false"NThis attribute is responsible for including categories into the sidemenu.includeItemsBoolean"false"NThis attribute is responsible for including items into the sidemenu.

Code Block

language	xml
theme	Eclipse
title	Sidemenu
linenumbers	true

<SideMenu
parentsDepth="1"
childrenDepth="1"
   includeCategories="1"
   includeItems="1">\
</SideMenu>

Table of ContentsclassfixedPosition

Page tree

Versions Compared

Old Version 76

New Version Current

Key

<authfull>

<authheader>

<card>

<category>

<categoryFlat>

<dropdownMenu>

<form>

<listitems>

<previewList>

<results>

<search>

<sidemenu>