Skip to end of banner
Go to start of banner

UI Page Structure and Terminology

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

he EmpowerID web user interface comprises pages within the UI container role as well as the user interfaces provided by microservices applications (e.g., IAM Shop, My Identity, etc.). Understanding the defined structure of the user interface within the UI container role is beneficial for supporting the EmpowerID platform and communicating with EmpowerID support staff.

Key features of the pages in the UI container role include:

  1. A responsive design web application built using Microsoft http://ASP.NET MVC and HTML5.

  2. A brandable user interface that can be customized and styled using CSS and JavaScript.

  3. The ability to "override" out-of-the-box pages with custom pages by copying your custom page of the same name into a mirrored folder structure called "Overrides."

  4. Pages can be classified based on a few specific templates that are repeated for different types of objects (e.g., People, Groups, etc.).

Navigation Sidebar

  • The Navigation Sidebar is the primary tool for navigating through the pages of the EmpowerID website and searching for people and various types of resources.

  • Notably, the sidebar is "security trimmed," meaning that the number of sections and links visible to a user depends on the level of access granted by your organization.

  • Additionally, the sidebar includes the Global Search control for quick and easy searches.

Find Pages

  • In the EmpowerID system, each object type has a Find page that displays the objects of that type stored or referenced in the Identity Warehouse.

  • The URL for Find pages is: https://%yourserver%/ui#Common/Find/%ObjectName%

  • On the server, Find pages are located under %InstallFolder%\EmpowerID\Web Sites\EmpowerID.Web.PortableAreas.Common\Views\ObjectTypeSearch

  • Find pages usually consist of one or more tabs listing objects of that specific type

  • Optionally, Find pages can also feature a Tree pane of locations on the left and an action pane of workflows and page actions on the right.



View One Pages

View One pages display a single instance of any object. For example, when clicking on a group link in the Find Group page, the next page to load is the View One page for that group.

Key characteristics of View One pages include:

  1. They are typically read-only and used to display information about an object and any related data.

  2. Multiple View One pages can exist for a specific object type to display only relevant fields when a single type has various subtypes (e.g., Account for AD versus Account for Office 365).

  3. The specific View One page to be loaded is determined by logic on the SQL view and configured in ResourceTypeFormIdentifiers, which define each subtype and the View One and Editone to load.

  4. View One pages are located:

    • %InstallPAth%Root\UI\Web Sites\EmpowerID.Web\EmpowerID.Web.PortableAreas.Common\Views\ViewOne\Details



Edit One Pages

Edit One pages display a single editable instance of any object. For example, when clicking on a group link in the group's View One page, the next page to load is the Edit One page for that group.

Key characteristics of Edit One pages include:

  1. Multiple Edit One pages can exist for a specific object type to display only relevant fields when a single type has various subtypes (e.g., Account for AD versus Account for Office 365).

  2. The specific Edit One page to be loaded is determined by logic on the SQL view and configured in ResourceTypeFormIdentifiers, which define each subtype and the View One and Edit One to load.

Edit One pages are located at:

%INSTALLPATH%\Root\UI\Web Sites\EmpowerID.Web\EmpowerID.Web.PortableAreas.Common\Views\EditOne

Each Edit One page sends its edited data to one or more workflows for processing.



ResourceTypeFormIdentifiers

ResourceTypeFormIdentifiers determine the specific View One and Edit One pages to load for an object, based on the logic configured in the SQL view. These identifiers define each subtype and their corresponding View One and Edit One pages.

You can view and configure ResourceTypeFormIdentifiers in the EmpowerID UI by visiting the following URL: https://%yourserver%/ui#Common/Find/ResourceTypeFormIdentifier


Report Pages

Report pages use the same template as Find pages and are designed to show some specific view of the data


Run Workflow Page

Workflows in EmpowerID can be executed as either anonymous or authenticated:

  1. Anonymous workflows run from the following URL: https://%yourserver%/ui#aw/%workflowname%

  2. Authenticated workflows run from the following URL: https://%yourserver%/ui#w/%workflowname%

Branding the UI Role Container Web Site

To customize the look and feel of the UI role container web application (excluding microservices), you can override the default CSS rules and images used for the website. You can change the theme globally or have different themes for each exposed URL.

Follow these steps:

  1. Create a new folder named after the FQDN or fully resolvable DNS of the tenant in the EmpowerID Web CDN Overrides/Tenants directory: "%INSTALLPATH%\Web Sites\EmpowerID.Web.Cdn\Overrides\Tenants\CustomTenantFolder", where "CustomTenantFolder" is the name of the folder you create.

  2. Create a child folder named "Themes" within the custom folder.

  3. Create a child folder named "EmpowerID" within the "Themes" folder.

  4. Create a child folder named "Images" within the "EmpowerID" folder.

To customize images, place them in:

%INSTALLPATH%\Web Sites\EmpowerID.Web.Cdn\Overrides\Tenants<YourCustomTenant>\Themes\EmpowerID\Images

To add custom CSS, edit the blank "overrides.css" file located in:

%INSTALLPATH%\Web Sites\EmpowerID.Web.Cdn\Overrides\Tenants<YourCustomTenant>\Themes\overrides.css


Overriding Out-of-the-Box Pages

To customize web pages without altering the original pages, use EmpowerID's Override technology. This allows you to easily revert to the default pages if needed.

Follow these steps to use the Override technology:

  1. Create an "Overrides" folder structure within the EmpowerID Web Sites directory that mirrors the shipping page directory structure.

  2. Place your custom pages with the same names as the original pages in the corresponding locations within the Overrides folder structure. EmpowerID will load the custom pages preferentially.

For example, to override View One pages, place your custom pages in:

EmpowerID.Web.Overrides\Areas\Common\Views\ViewOne\Details

Always use the Overrides folder for customizations and avoid modifying shipping pages or JavaScript files outside of the Overrides directory.

Customize the Web Interface

  • No labels