Chat now with support
Chat with Support

Active Roles 8.1.1 - Administration Guide

Introduction Getting started Rule-based administrative views Role-based administration
Access Templates as administrative roles Access Template management tasks Examples of use Deployment considerations Windows claims-based access rules
Rule-based autoprovisioning and deprovisioning
Provisioning Policy Objects Deprovisioning Policy Objects How Policy Objects work Policy Object management tasks Policy configuration tasks
Property Generation and Validation User Logon Name Generation Group Membership AutoProvisioning Exchange Mailbox AutoProvisioning AutoProvisioning in SaaS products OneDrive Provisioning Home Folder AutoProvisioning Script Execution Microsoft 365 and Azure Tenant Selection E-mail Alias Generation User Account Deprovisioning Office 365 Licenses Retention Group Membership Removal Exchange Mailbox Deprovisioning Home Folder Deprovisioning User Account Relocation User Account Permanent Deletion Group Object Deprovisioning Group Object Relocation Group Object Permanent Deletion Notification Distribution Report Distribution
Deployment considerations Checking for policy compliance Deprovisioning users or groups Restoring deprovisioned users or groups Container Deletion Prevention policy Picture management rules Policy extensions
Using rule-based and role-based tools for granular administration Workflows
Key workflow features and definitions About workflow processes Workflow processing overview Workflow activities overview Configuring a workflow
Creating a workflow definition for a workflow Configuring workflow start conditions Configuring workflow parameters Adding activities to a workflow Configure an Approval activity Configuring a Notification activity Configuring a Script activity Configuring an If-Else activity Configuring a Stop/Break activity Configuring an Add Report Section activity Configuring a Search activity Configuring CRUD activities Configuring a Save Object Properties activity Configuring a Modify Requested Changes activity Enabling or disabling an activity Enabling or disabling a workflow Using the initialization script
Approval workflow Email-based approval Automation workflow Activity extensions
Temporal Group Memberships Group Family Dynamic groups Active Roles Reporting Management History Entitlement profile Recycle Bin AD LDS data management One Identity Starling Join and configuration through Active Roles Managing One Identity Starling Connect Configuring linked mailboxes with Exchange Resource Forest Management Configuring remote mailboxes for on-premises users Azure AD, Microsoft 365, and Exchange Online Management
Configuring Active Roles to manage Hybrid AD objects Managing Hybrid AD users
Creating a new Azure AD user with the Web Interface Viewing or updating the Azure AD user properties with the Web Interface Viewing or modifying the manager of a hybrid Azure user Disabling an Azure AD user Enabling an Azure AD user Deprovisioning of an Azure AD user Undo deprovisioning of an Azure AD user Adding an Azure AD user to a group Removing an Azure AD user from a group View the change history and user activity for an Azure AD user Deleting an Azure AD user with the Web Interface Creating a new hybrid Azure user with the Active Roles Web Interface Converting an on-premises user with an Exchange mailbox to a hybrid Azure user Licensing a hybrid Azure user for an Exchange Online mailbox Viewing or modifying the Exchange Online properties of a hybrid Azure user Creating a new Azure AD user with Management Shell Updating the Azure AD user properties with the Management Shell Viewing the Azure AD user properties with the Management Shell Delete an Azure AD user with the Management Shell Assigning Microsoft 365 licenses to new hybrid users Assigning Microsoft 365 licenses to existing hybrid users Modifying or removing Microsoft 365 licenses assigned to hybrid users Updating Microsoft 365 licenses display names
Unified provisioning policy for Azure M365 Tenant Selection, Microsoft 365 License Selection, Microsoft 365 Roles Selection, and OneDrive provisioning Microsoft 365 roles management for hybrid environment users Managing Microsoft 365 contacts Managing Hybrid AD groups Managing Microsoft 365 Groups Managing cloud-only distribution groups Managing cloud-only dynamic distribution groups Managing Azure security groups Managing cloud-only Azure users Managing cloud-only Azure guest users Managing cloud-only Azure contacts Changes to Active Roles policies for cloud-only Azure objects Managing room mailboxes Managing cloud-only shared mailboxes
Modern Authentication Managing the configuration of Active Roles
Connecting to the Administration Service Managed domains Using unmanaged domains Evaluating product usage Creating and using virtual attributes Examining client sessions Monitoring performance Customizing the Console Using Configuration Center Changing the Active Roles Admin account Enabling or disabling diagnostic logs Active Roles Log Viewer
SQL Server replication Using regular expressions Administrative Template Communication ports Active Roles and supported Azure environments Integrating Active Roles with other products and services Active Roles Language Pack Active Roles Diagnostic Tools Active Roles Add-on Manager

Monitoring performance

Active Roles includes a set of performance counters to monitor various aspects of the Administration Service’s performance. Counters are grouped into performance objects that include the following:

  • Requests: Counts data management requests submitted to the Administration Service.

  • LDAP operations: Counts LDAP requests issued by the Administration Service.

  • Permissions propagation: Counts changes to Active Directory security made by the Administration Service.

  • External changes: Counts data changes polled by the Administration Service from Active Directory, and changes made to the Administration Database.

  • Script modules: Counts the average execution time of Active Roles script modules, the number of times a particular script module was executed, and number of script module instances being currently executed.

  • Miscellaneous: Counts the number of clients connected to the Administration Service and the number of queued post-policy processing operations.

To examine Administration Service performance counters, you can use the Performance tool on the computer running the Administration Service:

  1. Start the Performance tool: click Start and select All Programs > Administrative Tools > Performance.

  2. In the Console tree, select System Monitor.

  3. Click in the details pane, then press CTRL+I to display the Add Counters dialog.

  4. From the list in the Performance object box, select any name that begins with the prefix AR Server. For example, you might select AR Server:Requests.

  5. Select an item from the list of counters. For example, you might select Requests/sec.

  6. Click Add and then click Close.

As a result, the Performance tool displays the output of the counter you have selected.

Customizing the Console

The Active Roles Console provides a convenient way to customize object creation wizards and property pages found in the Console, and to customize display names for object types and object properties. Customization is performed through the use of Active Directory objects called display specifiers.

Each display specifier object holds information describing the various user interface elements for a particular object type. These elements include (but not limited to) creation wizard pages, property pages, and names to use for object types and properties in user interfaces.

The following sections summarize the customization-related features that are based on the use of display specifiers:

  • Other Properties page in the object creation wizard

  • Other Properties tab in the Properties dialog

  • Customizing display names

Other Properties tab in the Properties dialog

The Active Roles Console also makes it possible to extend the Properties dialog for directory objects with an extra tab named Other Properties, allowing the management of a custom set of object properties through the use of the Properties command.

The Active Roles Console makes it easy to view or modify the set of properties on the Other Properties tab by using a separate tab in the Properties dialog for display specifier objects. In this way, you can customize the set of properties included on the Other Properties tab. Note that the Properties dialog only includes the Other Properties tab if there are any properties to display on that tab.

The Other Properties to Display tab can be used to add or remove properties from the Other Properties tab, only affecting the object type that the display specifier is associated with. The Other Properties to Display tab lists the object properties included on the Other Properties tab for that object type, and allows you to make changes to the list.

You can use the following instructions to add the Other Properties tab to the Properties dialog for user objects. Similarly, you can extend the property pages for a different object type by creating and configuring a custom display specifier for that object type. For example, to extend the Properties dialog for Group, Computer, or Organizational Unit, create and configure a custom display specifier named group-Display, computer-Display, or organizationalUnit-Display, respectively.

NOTE: The names of display specifiers are case-sensitive, so you must type the name exactly as specified in the Active Directory schema. To view the names of display specifiers, you can use the Console to examine the Active Directory > Configuration Container > Display Specifiers > 409 container in the Raw view mode.

To extend the Properties dialog for User objects

  1. Open the Active Roles Console and switch into Raw view mode: Select View > Mode, then click Raw Mode and click OK.

  2. In the Console tree, expand Configuration > Application Configuration, and select the Active Roles Display Specifiers (Custom) container.

  3. Use the All Tasks > Advanced Create command to create the appropriate locale container.

    The custom display specifier must be created in the locale container matching the locale of your environment. These locale containers are named using the hex representation of that locale’s LCID. Thus the US/English locale’s container is named 409, the German locale’s container is named 407, the Japanese locale’s container is named 411, and so forth.

    You may need to first create the appropriate locale container. You can do this by using the All Tasks > Advanced Create command to create an object of the EDS-Display-Specifier-Container class.

  4. In the locale container, create the custom display specifier named user-Display.

    You can do this by using the All Tasks > Advanced Create command on the locale container to create an object of the Display-Specifier class. Note that the name of the display specifier is case-sensitive, so you should type the name for the new display specifier exactly user-Display, not user-display or User-display.

  5. In the details pane, right-click user-Display and click Properties.

  6. Navigate to the Other Properties to Display tab.

  7. Add one or more properties to the Other properties on the object property pages list. Then, click OK.

  8. Restart the Administration Service and reconnect the Console to the Service, for your changes to take effect.

As a result of these steps, the Properties dialog includes the Other Properties tab where you can view or modify values of the properties you selected in Step 7. You can access that tab in the Active Roles Console by right-clicking a user account and clicking Properties.

Other Properties page in object creation wizard

In the Active Roles Console, directory objects are created using creation wizards. Thus, creating a user account starts the New Object - User wizard. The Active Roles Console makes it possible to extend creation wizards with an extra page allowing additional properties to be populated in the course of the object creation process.

The Active Roles Console makes it easy to view or modify the set of properties on the wizard extension page by using a separate tab in the Properties dialog for display specifier objects. The Other Properties to Display tab provides a way to customize the set of properties included on the extension page of object creation wizards. If there are no properties to include on the extension page, the page is not displayed.

The Other Properties to Display tab can be used to add or remove properties from the extension page of the creation wizard for the object type that the display specifier is associated with. The tab lists the object properties included on the extension page, and allows you to make changes to that list.

You can use the following instructions to add the Other Properties page to the New Object - User wizard. Similarly, you can extend the creation wizard for a different object type by creating and configuring a custom display specifier for that object type. For example, to extend the wizard for Group, Computer, or Organizational Unit, create and configure a custom display specifier named group-Display, computer-Display, or organizationalUnit-Display, respectively.

NOTE: The names of display specifiers are case-sensitive, so you must type the name exactly as specified in the Active Directory schema. To view the names of display specifiers, you can use the Console to examine the Active Directory > Configuration Container > Display Specifiers > 409 container in the Raw view mode.

To extend the New Object - User wizard

  1. Open the Active Roles Console and switch into Raw view mode: Select View > Mode, then click Raw Mode and click OK.

  2. In the Console tree, expand Configuration > Application Configuration, and select the Active Roles Display Specifiers (Custom) container.

  3. Use the All Tasks > Advanced Create command to create the appropriate locale container.

    The custom display specifier must be created in the locale container matching the locale of your environment. These locale containers are named using the hex representation of that locale’s LCID. Thus the US/English locale’s container is named 409, the German locale’s container is named 407, the Japanese locale’s container is named 411, and so forth.

    You may need to first create the appropriate locale container. You can do this by using the All Tasks > Advanced Create command to create an object of the EDS-Display-Specifier-Container class.

  4. In the locale container, create the custom display specifier named user-Display.

    You can do this by using the All Tasks > Advanced Create command on the locale container to create an object of the Display-Specifier class.

    NOTE: The name of the display specifier is case-sensitive, so you should type the name for the new display specifier exactly user-Display, not user-display or User-display.

  5. In the details pane, right-click user-Display and click Properties.

  6. Navigate to the Other Properties to Display tab.

  7. Add one or more properties to the Other properties in the object creation wizard list. Then, click OK.

  8. Restart the Administration Service and reconnect the Console to the Service for your changes to take effect.

As a result of these steps, the New Object - User wizard includes an extra page where you can specify values for the properties you selected in Step 7. You can start the wizard in the Active Roles Console by right-clicking an organizational unit in the Console tree and selecting New > User. Follow the wizard steps to reach the page containing the list of “other” properties.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating