Portal contexts

Portal context engine allows restricting access to specified portals for some user categories defined by User Criteria. 

Example case:

  1. You create two portals: Moscow Users Portal and London Users Portal.
  2. You need to restrict access to these portals only for users from relevant cities.
  3. Using the portal contexts engine, you can easily do this by creating a user criteria record (in this case, you have to specify the location as a criterion).

Creating portal context

Role required: admin.


Before you start, you need to create the necessary user criteria first. For information on how to create them, please refer to the User Criteria article.

To create a portal context, please complete the steps below:

  1. Navigate to Portal Structure → Context Rules → Portal Contexts.
  2. Click New and fill in the fields.
  3. Click Save or Save and Exit to apply changes.

Portal context form description

FieldMandatoryDescription
PortalY

Specify a portal to which you need to restrict access.

You can create only one portal context record for one interface (agent interface or Self-Service Portal).

To configure portal contexts for agent interface, create record and select the Agent Interface as a target portal.


ActiveNSelect this checkbox to make this portal context record active.
Audience CriteriaNIn this field, select user criteria to define users who will have access to the portal specified. If no criteria are specified, this portal will be available to all users.
OrderN

Specify a portal context record processing order. If some user fits more than one portal context record, then a record with the lesser Order value is applied to the user.


Related properties

  1. You can enable or disable this engine by editing the portals.portal_context.enable property value. It is disabled by default. To enable portal context, edit the property value and type 'true'.
  2. You can define roles the owners of which disregard portal context rules and have access to all categories and items of the portal specified. For this, edit the portals.portal_conteхt.override_roles property value and specify roles here.

Users with the admin role can always access any portal. The setting is preconfigured for portal context overriding.

Page mappings

The page mappings engine is used to configure redirect rules in case the visited link is not accessible due to role restrictions.

Example case:

  1. One user sent a task link to another. The task link leads to the agent interface and looks like this: https://instance.example.com/record/task/162306286418042670.
  2. The other user does not have an agent role, so they will not be able to open and see it. But they can open portal links, respectively.
  3. The page mappings engine allows creating a rule which will convert agent interface links to portal links.
  4. After processing with a rule, the initial link looks like this:
    • https://instance.example.com/portal/record/?table_name=task&record_id=162306286418042670&view=SP
  5. Now, the link recipient can see the link content.

Creating page mapping

Role required: admin.

To create a page mapping rule from scratch, please complete the steps below:

  1. Navigate to Portal Structure → Context Rules → Page Mappings.
  2. Click New and fill in the fields.
  3. Click Save or Save and Exit to apply changes.

It is more effective to create page mapping rules out of the portal context rules. For this, navigate to the relevant portal context record, scroll down to the Related Lists area, open the Page Mapping tab and create rules.


FieldMandatoryDescription
Portal ContextYSpecify a reference to the previously created portal context.
URL TemplateY

Specify initial URL template.

The value should start with a slash: / 

You can use variables here.

Examples:

/record/{tableName}/{recordID}


There is no limit for the variables name. In the example below, it can be not only {id}, but  also {identificator}, {identify}, etc. But please keep in mind that:

  1. Variable names should be enclosed in the curly brackets, like this: {id}.
  2. Variable names in the URL Template and Portal Page should match to avoid errors.


Portal PageY

Specify portal page URL template. This template is used to create URLs for portal pages out of URLs passed.

The value should start with a slash: / 

Example:

/portal/record?table_name={tableName}&record_id={recordID}&view=SP

.

Related articles