Form descriptions
Portal record
| Field | Mandatory | Description |
|---|---|---|
| Title | N | 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 This value should be unique and not used by other portals. |
| Logo | N | Specify a portal logo appearing in the page header. |
| Favicon | N | Specify a portal favicon appearing in the tab header. |
SCSS variables | N | Define the portal-specific SCSS classes developed to customize the portal. |
SCSS styles | N | Define the portal-specific SCSS styles developed to customize the portal. |
| Active | N | Select this 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 (implemented with the corresponding tree). |
Portal page
| 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 configuring. | ||
| Dynamic Link Name | N | The page title to use in the breadcrumbs and the sidebar menu. |
| Dynamic Page Title | N | Specify variables to generate titles depending on the loaded content. |
| Active | Select this checkbox to make the page active or inactive. When active, you can use this page for portal needs. | |
| Public | Select this checkbox to make this page visible for unauthorized persons. In fact, when this checkbox is selected, the page is for public access, so use it cautiously. | |
| Use for Home Page | Select this checkbox to use this page as a home page (a page you want users to see when they sign in). | |
| Use Portal Header | Select this checkbox to use this page as a portal header. | |
| Use Portal Footer | Select this checkbox to use this 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 variables defined there override the ones 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 styles entered there to override the ones 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. To add a custom color different from the existing one, please contact your vendor. |
Portal node
Field | Mandatory | Description |
|---|---|---|
| Portal | N | Specify a portal (a record created earlier) to define a structure with this 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 this portal node. |
| Item Table | N | Specify the table containing the 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 (please keep in mind that in this example, Item Table should be equal to Article):
|
| Item Page | N | A template of the item specified in the Page ID field. |
| Active | Select this checkbox to make this portal node active or inactive. | |
| Public | Select this checkbox to make this page visible for unauthorized persons. In fact, when this checkbox is selected, the page is for public access, so use it cautiously. | |
| Enable Dynamic Nodes | Select this 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 this container. |
| CSS Class Names | N | Specify CSS classes for the container. Classes defined there 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. To add a custom color different from the existing one, please contact your vendor. |
| Order | N | Enter a number that will define the container order in a template. Items are sorted in ascending order. |
| Fixed Width | N | Select this checkbox to turn the container indent on and off. |
| Active | N | Select this checkbox to make a container active or inactive. |
Page row form description
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 this 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 (for example, if there are two columns in a row with width values 4 and 8, respectively, then the width of one of them will be equal to 1/3 of a page, and another one’s width will be equal to 2/3 of that page). This parameter is responsible for portal view in browsers in extra small devices (phones less than 768px). |
| Small Devices | N | This parameter is responsible for portal view in browsers in small devices (tablets 768px and up). |
| Medium Devices | N | This parameter is responsible for portal view in browsers in medium-size devices (desktops 992px and up). |
| Large Devices | N | This parameter is responsible for portal view in browsers in large devices (large desktops 1200px and up). |
| Active | N | Select this 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 New 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 | This field allows changing some output data for specified widgets. Specify clarifying options in JSON format. For example below, the empty selection performed against the Employee table.
|
| Active | N | Select this checkbox to make this widget instance active or inactive. |
| Public | N | Select this checkbox to make this widget visible on the portal page. |
| Order | N | This field specifies the order of widgets location in a portal column. Fill in this field with the integer number to display the widgets by increasing this 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). After you have defined these options as described above, they are available in the options global object. Option Schema Values {
"itemView": "SP%20View%20Only",
"tsGroupId": "158983234712988195"
}
should be used in Template this way: Template <search tsGroupId=options.tsGroupId searchQuery="{data.search}"
onChange="s_widget_custom.search(arguments[0]);"
searchUrl="/portal/search_result" showTitle="true" size="lg"
placeholder={data.placeholderMessage} itemPage ="record" itemView=options.itemView>
|
