Overview
Rules are used to control the display of actions, tiles, pagescape content, and navigation items within the platform.
Administrators can create rules to determine:
- What content should be displayed.
- Where it should be displayed.
- When it should be displayed.
Rules allow administrators to use configurations across multiple entities instead of configuring them separately for each entity.
Platform-Level Rules
Overview
Platform-Level Rules are predefined rules that are included in the system package and configured by default in the platform.
These rules provide standard platform functionality and are automatically applied by the system when the configured conditions are met. Certain Platform-Level Rules are enabled by default and are available immediately after deployment.
Examples include:
- Default entity tiles
- Standard actions
- Navigation behaviour
- Default page components
Note: The conditions associated with Platform-Level Rules cannot be viewed or edited. Admins can only enable or disable these rules.
Working
When a page is loaded, the platform evaluates the available rules based on the current context and configured conditions.
If the rule conditions are satisfied, the UI component associated with the rule, such as action, tile, pagescape, or navigation components are displayed.
Applicable scenarios
Platform Rules are automatically applied by the system when an entity is created, viewed, or updated.
The system evaluates the applicable Platform Rules and displays the associated actions, tiles, navigation items, and pagescape components when the rule conditions are satisfied.
Examples include:
- When a new Case entity is created and when the rule conditions are satisfied, the system applies the configured Action Rules and displays the associated actions, such as Edit, Change Status, Add Link, Assign, Delete, and Download.
- When one or more same entities are linked to a Case entity, the system automatically applies the predefined Summary Tile Rule and displays a summary tile for linked entities in the Case Entity Explorer, including entity counts, entity details, and donut chart visualizations.
- When a Case entity contains linked child or grandchild entities, the system automatically applies the predefined Navigation Rule and displays the corresponding navigation items in the navigation pane and All Navigations page. The navigation items display linked entity counts, navigation descriptions, and configured layout visualizations.
- When the requirements of a Pagescape Rule are satisfied, the associated page components are displayed automatically.
In these scenarios, the system evaluates the enabled platform rules and applies the corresponding functionality to the entity based on the current context and available data.
Scenarios where rules are not qualified
Platform Rules are limited to the functionality predefined by the platform. System-defined Platform Rules cannot be modified. Platform Rules are applied only when the required data is available for the entity. If the required data is not available, the associated action, tile, pagescape component, or navigation items may not be displayed.
- When the configured rule conditions are not satisfied.
- When the entity does not contain the required linked entities.
- When the entity type does not match the configured Query Entity Name.
- When the parent entity does not match the configured Parent Entity Name.
- When the rule has been disabled by an administrator.
For example:
- A Case Entity Tile configured to display only Active Cases is not displayed when the Case status is Pending, On Hold, or Completed.
- A Summary Tile configured for Task entities is not displayed when no linked Task entities exist.
- A Navigation Rule configured for Lead entities is not displayed when the case entity does not contain linked Lead entities.
- When a Case entity does not satisfy the configured Action Rule conditions, actions such as Edit, Change Status, Add Link, Assign, Delete, and Download are not displayed.
- A Pagescape Rule is not applied when the required conditions for displaying the page component are not met.
Note: The system evaluates only enabled Platform Rules. Disabled rules are not applied.
Accessing the Interface
To access the Rules interface:
- Log into the Hubstream instance.
- Click the gear icon in the top-right corner of the screen.
- Click Admin.
- Select the Rules option from the left navigation panel.
Note: The Add Rule (+) button on the All Rules page is currently disabled.
Custom rules can be created from the Entity’s Rules page. Follow the steps below:
- Navigate to the Entity Types page.
- Click the View Rules hyperlink of a desired entity type (for example, Case). The Rules page for the selected entity is displayed.
- Click the plus (+) icon button in the top right corner.
The New Rule form is displayed, allowing admins to create a rule for the selected entity.
Sections of Rules Page
- Header - Displays the page label and the Add Rule (+) button.
- Left Pane - Contains a local search widget to filter the list based on predefined filters, such as Rule Type and Is Enabled status.
- Right Pane - Displays the list of existing rules along with their details.
- Footer - Shows the total number of rows, a pagination dropdown and navigation buttons with pagination labels.
Rule Types
Rules are categorized based on the functionality they provide within the platform. The following rule types are available:
- Action – Control the display of actions, such as Edit, Delete, Change Status, and Assign.
- Tile – Control the display of tiles that show entity information within the user interface.
- Pagescape – Controls the visualizations available for an entity type within the user interface.
- Navigation – Controls the display of linked entity navigations within the navigation pane and all navigation page.
Each rule type serves a specific purpose and can be configured to control the visibility of actions, tiles, pagescape components, and navigations within the user interface.