IDHUB Self Service Application

Follow

IDHUB Self Service Application

The IDHUB Self Service application is intended to allow users to manage their own details within the IDHUB. Initially their personal details.

About this Document

This document provides an overview of the example Self Service application that is delivered with the IDHUB product. This illustrates how the REST services of the IDHUB can be used to create a simple self service application.

Intended Readership

This document is meant for Administrators and Users of the IDHUB and developers that may be using REST services of the IDHUB to create a self service application.

User Profile Page

The user profile page within the Self Service application is created from User Attributes that are specified within the IDHUB Admin application.

Attribute Behaviour

The page is rendered depending how the User Attributes are configured in the following manner.

Single Value Attributes

If a user attribute is specified as a single value within the IDHUB Admin application (IDA) then it will be displayed as a single text input within the Self Service (SSVC). To specify an attribute as a single value the singlevalue check box must be selected in the IDA.

The field is then displayed as a single text entry within the self service application

Multi Value Attributes

If a user attribute is specified as a multi-value within the IDA application then it will initially be displayed as a single text input with a button toAdd [attributeName]more single input fields for that one attribute. To specify an attribute as a multi valuedo notselect the single value check box.

Within SSVC the field is displayed as a single attribute with an add button and each row that is added carries a delete button to remove that single row.

If the multi value attribute is also a required attribute then the last input cannot be removed, so there must be at least one entry.

Required Attributes

When a user attribute is specified as a required value within IDA then at least one entry for that field must be entered or selected. The table below details how each type of attribute behaves when it is also selected as required.

Field Type Behaviour
Single Value A value must be entered in the text box
Multi Value A least one entry field must be present with a value and the last entry field cannot be removed
Enumeration Single Value One value must be selected
Enumeration Multi Value At least one value must be checked

Read Only Attributes

If an attribute is marked as read only in IDA then the label is displayed with no means of entry and a value if one has been specified by the administrator.

Enumeration Attributes

These are attributes that have specific, fixed, values that have been pre-defined in IDA such as a list of countries. Within the Self Service application the user can select a single or multiple value from the pre-defined list.

Single Value Enumerations

To create a single value enumeration in IDA first select theData FormatasENUMERATIONthen enter the values.Then check the single value check box.

This is then displayed as a select box within SSVC.

Multi Value Enumerations

A multi value enumeration user attribute is created the same way as a single value except the single value check box shouldnotbe selected. The multi value enumeration is displayed as check boxes within SSVC.

Email Attributes

Email attributes, specified as an email data type within the IDHUB Admin, are displayed as normal single value inputs.

Categories

Categories are groups of user attributes. When a user attribute is created within IDA then it is assigned to a group.

The user attributes are grouped in the IDA by their category on the list screen.

These categories are also used within SSVC to output the user attributes. The first category is the defaultcommoncategory, output asDetailsin SSVC and then all categories are output after that.

Validation

If user attributes are marked as required and no value is provided then validation will fail and any changes will not be saved to the database. When a validation fails the field that failed is focussed, scrolled into view and a message displayed below the input describing the field and reason.

Have more questions? Submit a request

Comments