Chat now with support
Chat with Support

Active Roles 8.2.1 - Administration Guide

Introduction Getting started with Active Roles Configuring rule-based administrative views Configuring role-based administration Configuring rule-based autoprovisioning and deprovisioning
Configuring Provisioning Policy Objects
User Logon Name Generation E-mail Alias Generation Exchange Mailbox AutoProvisioning Group Membership AutoProvisioning Home Folder AutoProvisioning Property Generation and Validation Script Execution O365 and Azure Tenant Selection AutoProvisioning in SaaS products
Configuring Deprovisioning Policy Objects
User Account Deprovisioning Group Membership Removal User Account Relocation Exchange Mailbox Deprovisioning Home Folder Deprovisioning User Account Permanent Deletion Office 365 Licenses Retention Group Object Deprovisioning Group Object Relocation Group Object Permanent Deletion Script Execution Notification Distribution Report Distribution
Configuring entry types Configuring a Container Deletion Prevention policy Configuring picture management rules Managing Policy Objects Checking for policy compliance Deprovisioning users or groups Restoring deprovisioned users or groups Configuring policy extensions
Using rule-based and role-based tools for granular administration Workflows
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 Configuring 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 Migrating Active Roles configuration with the Configuration Transfer Wizard Managing Skype for Business Server with Active Roles
About Skype for Business Server User Management Active Directory topologies supported by Skype for Business Server User Management User Management policy for Skype for Business Server User Management Master Account Management policy for Skype for Business Server User Management Access Templates for Skype for Business Server Configuring the Skype for Business Server User Management feature Managing Skype for Business Server users
Exchanging provisioning information with Active Roles SPML Provider Monitoring Active Roles with Management Pack for SCOM Configuring Active Roles for AWS Managed Microsoft AD Azure AD, Microsoft 365, and Exchange Online Management
Azure tenant types and environment types supported by Active Roles Using Active Roles to manage Azure AD objects Unified provisioning policy for Azure M365 Tenant Selection, Microsoft 365 License Selection, Microsoft 365 Roles Selection, and OneDrive provisioning Changes to Active Roles policies for cloud-only Azure objects
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 Configuring federated authentication Communication ports and URLs used by Active Roles Integrating Active Roles with other products and services Active Roles Language Pack Active Roles Diagnostic Tools Active Roles Add-on Manager

Using the Add-on Manager command-line interface

You can use the Active Roles Add-on Manager from the command-line.

To run Add-on Manager

  1. Open the Windows command prompt.

  2. Navigate to the folder where the Add-on Manager is installed.

  3. Run the ActiveRolesAddOnManager_8.2.1.exe file with the appropriate parameters.

    TIP: To list the available parameters, run the following command:

    ActiveRolesAddOnManager_8.2.1.exe /?

Creating an add-on

You can create new add-ons with the Add-on Editor component of the Add-on Manager.

To create a new add-on

  1. To open the Add-on Editor, perform one of the following steps:

    • In the Windows Start menu, click Add-on Editor.

    • In the Active Roles Console, navigate to the Add-on Manager application page, and click Create New.

  2. In the Connect to Administration Service dialog, select the Active Roles Administration Service you want the Add-on Editor to connect to, then specify a user name and password.

  3. On the Create or Edit Add-on page, select Create a new add-on and click Next.

  4. On the General Add-on Settings page, configure all settings and click Next.

  5. On the Add-on Objects page, select the Active Roles objects and/or Web Interface customization items you want to include in your add-on.

    • To add Active Roles objects, click Add Active Roles Objects. Then, on the Add Active Roles Objects page, select the objects to include in your add-on. To apply your selection, click OK.

    • To add Web Interface customization items, click Add WI Customization items. On the Add Web Interface Customization Items page, specify the configuration from which you want to export customization items, then select the items to include in the add-on. To apply your selection, click OK.

  6. Once you selected the objects to include in the add-on, click Next.

  7. On the Save Add-on page, specify the file name of your add-on and click Next.

  8. On the Ready to Create Add-on page, review the settings for your add-on. If you want to specify advanced settings, click the Advanced button.

  9. (Optional) On the Advanced Settings page, configure the following settings for your add-on. To apply your advanced settings, click OK.

    • Show in Raw mode only: If selected, Add-on Manager will display your add-on only if the Active Roles Console is in Raw view mode.

    • Show Uninstall link: If selected, Add-on Manager will show the Uninstall option for your add-on in the Active Roles Console.

      NOTE: If this option is not selected, you can only uninstall your add-on later via the Add-on Manager command line.

      For the list of command-line options, use the AddOnManager.exe /? command in the Windows command prompt.

    • Show Add-on Configuration page: If selected, the add-on title link in the Add-on Manager page will open the Add-on Details dialog.

      TIP: One Identity recommends selecting this option if your add-on has a configuration page, then configuring the add-on title link to open that configuration page.

      To do so, select Show Add-on Configuration page, then supply the Distinguished Name (DN) of the application object included in your add-on.

    • Web Interface customization label: Contains the Web Interface customization label. All Web Interface customization items added by the configured add-on will be marked in the add-on XML with this label. By default, the label consists of the add-on name and version.

    • Show Web Interface customization link: If selected, Add-on Manager will provide the Web Interface Customization link for your add-on in the Active Roles Console. When clicking this customization link, you can select the Web Interface configurations and sites you want your add-on to customize, then also apply the customization items to the selected configurations and sites.

    • Apply customization to Site for Administrators: If selected, the customization items of your add-on will be applied to the Active Roles Web Interface site for Administrators.

    • Apply customization to Site for Help Desk: If selected, the customization items of your add-on will be applied to the Active Roles Web Interface site for Helpdesk.

    • Apply customization to Site for Self-Service: If selected, the customization items of your add-on will be applied to the Active Roles Web Interface site for Self-Service.

    • System Requirements: Use this setting to specify the minimum and maximum versions of Active Roles supported by your add-on.

    • Required add-ons: Use this setting to specify add-ons that must be installed before installing your add-on. To specify a new add-on, click Add.

    • Pre-install script: If selected, you can specify a script to run before installing your add-on. Enter the script in the text box of the setting.

      NOTE: Add-on Manager supports only PowerShell scripts.

    • Post-install script: If selected, you can specify a script to run after installing your add-on. Enter the script in the text box of the setting.

    • Pre-uninstall script: If selected, you can specify a script to run before uninstalling your add-on. Enter the script in the text box of the setting.

    • Post-uninstall script: If selected, you can specify a script to run after uninstalling your add-on. Enter the script in the text box of the setting.

  10. To create the add-on, click Finish.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating