Configuration Guide

Hub

Definition

A hub Feature is used to list several Features on tabs on the same screen.

Capture d'écran 2024-01-23 171129.png


A hub Feature is split into two parts:

  • Upper part: a banner with the display of different informations (keys and picture).

  • Tabs part: a hub with links to other Features and an Object switcher (optional).

A hub Feature is only accessible through another Feature by using an action button.

Usage

In a hub Feature, depending on the Scope configuration, the user can only see tabs for which the Scope matches. If the managed user doesn't match the Scope then the tab is hidden.

Steps

Preview

1

Display a feature within a hub, the hub banner and feature screen are displayed.
In this case, the user access a hub through a search feature and a dropdown button.

image-20220928-072111.png
image-20220928-072115.png


2

Click on a tab. to display other Feature within the same hub.

image-20220928-072119.png


Configuration

HubFeature.png


Prerequisite

The following prerequisite are mandatory before configuring a hub Feature:

  • Have configured an object type (Identity, Organization, Resource, Role or Role Publication).

  • All attributes definition and features listed in the hub Feature must be created and linked to the object type.

Properties

Mandatory configuration elements

Global configuration elements are detailed on the Feature page.

Configuring a hub is also mandatory in a hub feature if not, the Feature will not be usable.

Properties name

Type

Mandatory

Description

hub

-

YES

First configuration level.

hub properties

Properties name

Type

Mandatory

Description

banner

-

YES

Allows to configure the banner of a hub Feature.

features

-

YES

Used to list features that will be displayed on tabs.

objectSwitcher

String

NO

Allows to display Attributes that describe a sibling Object. 

You can click on Object switcher to display the id of the sibling.

Properties name

Type

Mandatory

Description

keys

-

YES

Used to list attributes to display in the banner.

picture

String

NO

Allows to display a picture in the banner.

If no picture is specified then a blue ribbon will be displayed instead.
If you don't want to put a picture, you have to delete the tags.

keys properties

Properties name

Type

Mandatory

Description

key

String

YES

Used to indicate the id of the attribute.

The Attributes will be displayed following in order of keys.

To optimize display, choose key with short value.

Do not configured too many keys; otherwise, the banner will be unreadable. There is no possibility to configure key locations.

features properties

Properties name

Type

Mandatory

Description

feature

String

YES

Used to indicate the id of the features.

Tabs with each Features should be translated by the following key: ui.features."hub id".feature."feature id".tab

objectSwitcher properties

Properties name

Type

Mandatory

Description

displayedAttributes

-

YES if objectSwitcher is configured

Used to list attributes to display.

displayedAttributes properties

Properties name

Type

Mandatory

Description

attribute

String

YES if displayedAttributes is configured

Used to indicate the id of the attribute.

The following requirements are recommended to build the configuration XML:

  • Authentication: define the authentication level to access Features.

  • OperationOnSelf: define if the Feature is used for a "self" usage.

  • HomeTile: use to access a Feature from the home page.

Example

Sample_Hub.xml

  • Deduplication

    A deduplication Feature allows to check for duplicates before creating a new object.

  • Create

    A Feature of type Create is used to create objects by listing attributes.

  • Read

    A Feature of type Read is used to read the content of created objects by listing attributes.

  • Search

    A Search feature is used to allow search for objects and displays the results in a table.

  • Update

    An Update feature is used to allow modifications on objects by listing attributes.

  • Bulk

    A Feature of type bulk allows to apply several operations on these objects at the same time.

  • Raw Update

    A Raw Update feature is used to perform modifications on all attributes on objects (built-in and related to object).

  • UI for Object

    A Ui for Object (UI_FOR_OBJECT in XML) is used to configure a dedicated element on an object, like a Role Assignment Widget or a Role Dashboard Widget.

  • Application Portal

    An application portal feature allows users to have a quick and simple access to all his applications.