Skip to main content
Version: 1.21.3

Portal Integration

When you create a page, you can make it available on the portal. To do so, you need to create a portal node that will bind your page with the portal record.

The following diagram illustrates a typical portal structure:

To integrate a page into a portal, you need to complete the steps below:

  1. Create a portal record.
  2. Create a portal node.
  3. Create a page.
note

You should consider the portal structure first before configuring. It should have at least one portal node and at least one page to work properly. Otherwise, it will not display correctly.

Create a portal record​

Create a portal record, so you will be able to bind a page, its elements, and a portal node to it.

To create a single portal, complete the steps below:

  1. Navigate to Portal Structure → Portals.
  2. Click New and fill in the fields.
  3. Click Save or Save and exit to apply the changes.
note

When filling in the Path name field, keep in mind that this is the URL suffix of your future portal, so fill in this field carefully.

Portal record form fields

FieldMandatoryDescription
TitleNSpecify an internal portal title.
Path nameN

Specify a 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 cannot be used by other portals.

LogoNSpecify a portal logo appearing in the page header.
FaviconNSpecify a portal favicon appearing in the header.
SCSS variablesNDefine the portal-specific SCSS classes developed to customize the portal.
SCSS stylesNDefine the portal-specific SCSS styles developed to customize the portal.
ActiveNSelect the checkbox to make the portal active or inactive.
Login pageNSpecify 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 pageNSpecify 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 pageNSpecify 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 containerNSpecify 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 containerNSpecify 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 menuNSpecify a reference to the portal header menu that is implemented with the corresponding tree.

Create a portal node​

Within the portal node, there are two various entity types used to configure the portal structure:

  • Portal nodes are massive structural components defining layouts of portals, categories, and pages through the Page field.
  • Categories and items are pages that bind child objects based on the same features. Categories are any structures based on parent-child relationships, for example, Knowledge Base with categorized Articles in it. Portal Nodes help implement ready-to-use structures into the portal structure.

To create a portal node, complete the steps below:

  1. Navigate to Portal Structure → Portal Nodes.
  2. Click New and fill in the fields.
  3. Click Save or Save and exit to apply the changes.

Portal Node form fields

FieldMandatoryDescription
PortalNSpecify a portal to define a structure with the portal node.
Parent nodeNSpecify a parent node. This node is used as a high-level element for the menus and breadcrumbs.
PageNSpecify a page containing a template to define a structure with the portal node.
Item tableNSpecify a table containing portal items. For example, it can be the Article (article) table.
Item parent columnNSpecify the column that will define the parent-child relationship between items and categories. For example, if the Article table has been chosen as the item table, you can select the KB Category (knowledge_base_category) column as the item parent category column.
Category item conditionN

Specify conditions that must be met to display a category item. Use the condition builder to build complex AND/OR filters for this. You can also define a sorting by any preferable field.

For example, you need to display only published Knowledge Base articles sorted by the publication date. To do so, complete the following steps:

  1. In the Category item condition field, click the funnel icon to open the condition builder.
    1. In the Field field, select State
    2. In the Operator field, select is
    3. In the Value field, select Published.
  2. Click Sort.
  3. In the field that appears, select Order.
  4. Select the preferred sorting order (ascending or descending).
  5. Close the condition builder. The conditions are saved.

Keep in mind that in this example, Item Table should be equal to Article.

Item pageNA template of the item specified in the Page field.
ActiveNSelect the checkbox to make the portal node active.
PublicN

Select the checkbox to make the page visible for unauthorized users.

When this checkbox is selected, the page is available for public access, so use this checkbox with caution.

Enable dynamic nodesNSelect the checkbox to enable or disable the ability to resize dynamic nodes.
Ignore ACLN

Select this checkbox to ignore the ACL rules when displaying the page connected to the node.

This field is displayed when the Enable Dynamic Nodes checkbox is selected.

Category tableNSpecify the table containing the portal item categories. For example, it can be the KB Category (knowledge_base_category) table.
Category parent columnNSpecify the column to define the parent-child relationship for elements. For example, if the KB Category table has been chosen as a category table, select the Parent KB category[parent_knowledge_base_category] column.
Category conditionNSpecify the conditions that must be met to display a category. Use the condition builder to build complex AND/OR filters for this. You can also define sorting by any preferable field.

Configure the portal structure​

To configure the portal structure, you need to follow these instructions:

  1. Bind the portal record you have created and the portal node (or nodes). If you have created nodes within the portal record, it will be done automatically at the time of the creation.

    Nodes and records

    1. Open the portal record you need to work with.
    2. In the Related Lists area, select the Portal Node tab.
    3. Click Edit.
    4. Move desired portal node records from Available to Selected areas.
    5. Click Save.

    To define the portal node record ID, complete the steps below:

    1. Navigate to Portal Structure → Portal Nodes.
    2. Open the desired portal record.
    3. The node record ID is displayed in the URL.

  2. Bind this node to a previously created page you want to display on the portal. Specify reference to this page in the Page field of the node record form.