Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Portal record
Field | Mandatory | Description | ||||||
---|---|---|---|---|---|---|---|---|
Title | N | Specify an internal portal title. | ||||||
Path Name | N | Specify a URL suffix to use in a portal URL. For example, if you type portal, the instance URL for this portal will be <your_instance_url>/portal
| ||||||
Logo | N | Specify a portal logo appearing in the page header. | ||||||
Favicon | N | Specify a portal favicon appearing in the tab header. | ||||||
| N | Define the portal-specific SCSS classes developed to customize the portal. | ||||||
| N | Define the portal-specific SCSS styles developed to customize the portal. | ||||||
Active | Select the checkbox to make the portal active or inactive. | |||||||
Login Page | N | Specify a login page for the portal, selecting a preferred one from the dictionary. You can skip this step and get back to it later after you create the necessary pages. | ||||||
Home Page | N | Specify a home page for the portal, selecting a preferred one from the dictionary. You can skip this step and get back to it later after creating the necessary pages. | ||||||
404 Page | N | Specify a 404 error page for the portal, selecting a preferred one from the dictionary. You can skip this step and get back to it later after creating the necessary pages. | ||||||
Footer Container | N | Specify a portal footer selecting a preferred one from the container list. You can skip this step and get back to it later after creating the necessary containers. | ||||||
Header Container | N | Specify a portal header selecting a preferred one from the container list. You can skip this step and get back to it later after creating the necessary containers. | ||||||
Header Navigation Menu | N | Specify a reference to portal header menu that is implemented with the corresponding tree. |
Portal page
For more information, please refer to the Portal Pages article.
Field | Mandatory | Description | ||
---|---|---|---|---|
Title | N | Specify a page title. | ||
Description | N | Specify a page description. | ||
Path Name | Y | Specify a URL suffix to be used in a portal URL. For example, if you type page, and the portal suffix typed earlier is portal, the URL for this page will be <your_instance_url>/portal/page.
| ||
Options tab. This tab is responsible for the page template configuration. | ||||
Dynamic Link Name | N | Define a page title to use in breadcrumbs and the sidebar menu. | ||
Dynamic Page Title | N | Specify a title to display on the page form. | ||
Active | Select the checkbox to make the page active or inactive. When it is active, you can use the page for portal needs. | |||
Public | Select the checkbox to make the page visible for unauthorized users.
| |||
Use for Home Page | Select the checkbox to use the page as a home page, a page you want users to see when they sign in. | |||
Use Portal Header | Select the checkbox to use the page as a portal header. | |||
Use Portal Footer | Select the checkbox to use the page as a portal footer. | |||
Styles tab. This tab is responsible for page customizing. | ||||
SCSS Variables | N | Define the page-specific SCSS variables customizing the page. The defined variables override variables defined on the portal level (in the SCSS variables field of the Portal table). | ||
SCSS Styles | N | Define the page-specific SCSS styles customizing the page. The entered styles to override styles defined on the portal level (in the Portal table's SCSS styles field). | ||
Background Image | N | Attach an image to use as a background for your page. The maximum size of the image is 20 Mb. | ||
Background Color | N | Select the page background color. These colors are preconfigured and stored in the Colors (sys_color) dictionary.
|
Portal node
Field | Mandatory | Description | ||
---|---|---|---|---|
Portal | N | Specify a portal (a record created earlier) to define a structure with the portal node. | ||
Parent Node | N | Specify a parent node ID. This ID is used as a high-level element for menus and breadcrumbs. | ||
Page | N | Specify a page containing a template to define a structure with the portal node. | ||
Item Table | N | Specify a table containing portal items. For example, it can be the Article (article) table. | ||
Item Parent Column | N | Specify the column in the Item table related to the parent category to assign . For example, if the Article table has been chosen as the item table, you can select the KB Category (knowledge_base_category) column as an item parent category column. | ||
Category Item Condition | N | Specify a condition that must be met to display a category item. Use a Condition Builder to build complex AND/OR filters for this. You can also define a sorting there by any preferable field. For example, you need to display only published Knowledge Base articles sorted by the publication date. In this case, please complete the state below:
| ||
Item Page | N | A template of the item specified in the Page ID field. | ||
Active | Select the checkbox to make the portal node active or inactive. | |||
Public | Select the checkbox to make the page visible for unauthorized users.
| |||
Enable Dynamic Nodes | Select the checkbox to enable or disable the possibility of the dynamic nodes resizing. | |||
Category Table | N | Specify the table containing the portal item categories. For example, it can be the KB Category (knowledge_base_category) table. | ||
Category Parent Column | N | Specify a column in the Category table related to the parent category to assign a parent category. For example, if the KB Category table has been chosen as a category table, select the Parent KB Category (parent_knowledge_base_category). | ||
Category Condition | N | Specify a condition that must be met to display a category. Use a Condition Builder to build complex AND/OR filters for this. You can also define a sorting there by any preferable field. |
Page container
Field | Mandatory | Description | ||
---|---|---|---|---|
Name | N | Specify a container name. | ||
Page | N | Specify a reference page for the container. | ||
CSS Class Names | N | Specify CSS classes for the container. Defined classes override classes defined on upper levels (for the page or the portal). | ||
Background Image | N | Attach an image to use as a background for your container. The maximum size of the image is 20 Mb. | ||
Background Color | N | Select the container background color. These colors are preconfigured and stored in the Colors (sys_color) dictionary.
| ||
Active | N | Select the checkbox to make a container active or inactive. | ||
Fixed Width | N | Select the checkbox to turn the container indent on and off. | ||
Order | N | Enter a number that will define the container order in a template. Items are sorted in ascending order. |
Page row
Field | Mandatory | Description |
---|---|---|
Page Сontainer | N | Specify a page container for this row. |
CSS Class Names | N | Specify CSS class names customizing the elements view located on this row. Classes defined there override classes defined on upper levels. |
Active | N | Select this checkbox to make a row active or inactive. |
Order | N | Enter a number that will define the row order on a page. Rows are sorted in ascending order. |
Page column
Field | Mandatory | Description | ||
---|---|---|---|---|
Page Row | N | Specify a previously created row for the column. | ||
CSS Class Names | N | Specify CSS class names customizing the elements view located on this row. Classes defined there override classes defined on upper levels. | ||
Extra-Small Devices | N | Enter a number from 0 to 12 that will define the width of the column. The parameter is responsible for portal view in browsers in extra small devices (phones less than 768px).
| ||
Small Devices | N | The parameter is responsible for portal view in browsers in small devices (tablets 768px and up). | ||
Medium Devices | N | The parameter is responsible for portal view in browsers in medium-size devices (desktops 992px and up). | ||
Large Devices | N | The parameter is responsible for portal view in browsers in large devices (large desktops 1200px and up). | ||
Active | Select the checkbox to make this column active or inactive. | |||
Order | N | Enter a number that will define the column order in a row. Columns are sorted in ascending order. |
Widget
To get full widget form description, please refer to the Create a widget article.
Widget instance
Field | Mandatory | Description | ||
---|---|---|---|---|
Widget | N | Specify a widget configured earlier. Choose it from the Widget (sys_widget) dictionary. | ||
Page Column ID | N | Specify an ID of the column on some page for applying these settings. | ||
Option Schema Values | N | The field allows changing some output data for specified widgets. Specify clarifying options in JSON format. For example below, the empty selection performed for the Employee table. | ||
Active | N | Select the checkbox to make this widget instance active or inactive. | ||
Public | N | Select the checkbox to make this page visible for unauthorized users.
| ||
Order | N | Specify the order of the widget location in a portal column. Fill in this field with the integer number to display widgets by increasing the field value. When displaying a single widget in a column, the order value does not matter. |
Widget option
Field | Mandatory | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Portal | N | Select a previously created portal record from the list. | ||||||||||||||||||||||||
Widget Instance | N | Select the previously created widget instance from the list to bind options it. | ||||||||||||||||||||||||
Option Schema Values | N | Specify widget instance clarifying options in JSON format. These options allow transmitting values of the variables defined in the widget body for the different contexts (different widget instances).
|
Table of Contents | ||||||
---|---|---|---|---|---|---|
|