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

Configuring an “Add to group” activity

When you configure an Add to group activity, you can specify the rules for selecting the object you want the activity to add to groups, and define the groups to which you want the activity to add the object. Additional options are available such as notification, error handling, and “Run as” options.

To configure an Add to group activity

  1. In the Active Roles Console tree, expand Configuration > Policies > Workflow, and select the workflow containing the Add to group activity you want to configure.

    This opens the Workflow Designer in the Details pane, representing the workflow definition as a process diagram.

  2. In the process diagram, right-click the name of the activity and click Properties.

  3. Navigate to the Activity target tab in the “Add to Group” Activity Properties dialog.

  4. Click in the Activity performs the operation on this object box to specify the object you want the activity to add to groups. This object is referred to as activity target. You can choose from the following options to specify the activity target:

    • Fixed object in directory: The activity target is the given object. You can select the desired object in Active Directory when you configure the Add to group activity.

    • Object identified by workflow parameter: The activity target is the object specified by the value of a certain parameter of the workflow. You can choose the desired parameter from the workflow definition when you configure the Add to group activity.

    • Object from workflow data context: The activity target is selected by the activity on the basis of the data found in the workflow environment at the time of executing the workflow. When configuring the Add to group activity, you can specify which object you want the activity to select at workflow run time.

    • Object identified by DN-value rule expression: The Distinguished Name (DN) of the activity target is specified by the string value of a certain rule expression. By using a rule expression you can compose a string value based on properties of various objects found in the workflow environment at the time of executing the workflow. You can create the desired rule expression when, you configure the Add to group activity.

  5. Navigate to the Groups tab in the “Add to Group” Activity Properties dialog.

  6. Configure the list of groups to which you want the activity to add the target object.

    To add a group to the list, click Add group, and then choose from the following options:

    • Fixed group in directory: You can select the desired group in Active Directory when you configure the Add to group activity. A unique identifier of the group is saved in the configuration of the activity. The activity uses that identifier to select the group when calculating the list of groups at workflow execution time.

    • Object from workflow data context: The group is selected by the activity on the basis of the data found in the workflow environment at the time of executing the workflow. When configuring the Add to group activity, you can specify which group you want the activity to select at workflow execution time.

    • Object identified by DN-value rule expression: The Distinguished Name (DN) of the group is specified by the string value of a certain rule expression. By using a rule expression, you can compose a string value based on properties of various objects found in the workflow environment at the time of executing the workflow. You can create the desired rule expression when you configure the Add to group activity.

    To remove a group from the list, click the Delete button labeled X on the right side of the list item representing that group.

  7. View or change notification settings. For more information, see Configuring a notification for a CRUD activity.
  8. View or change error handling settings. For more information, see Configuring error handling for a CRUD activity.
  9. View or change the "Run as" options. For more information, see Configuring “Run as” options for a CRUD activity.
  10. View or change additional settings. For more information, see Configuring additional settings for a CRUD activity.

Configuring a Remove from group activity

When you configure a Remove from group activity, you can specify the rules for selecting the object you want the activity to remove from groups, and define the groups from which you want the activity to remove the object. Additional options are available, such as notification, error handling, and “Run as” options.

To configure a Remove from group activity

  1. In the Active Roles Console tree, expand Configuration > Policies > Workflow, and select the workflow containing the Remove from group activity you want to configure.

    This opens the Workflow Designer in the Details pane, representing the workflow definition as a process diagram.

  2. In the process diagram, right-click the name of the activity and click Properties.

  3. Navigate to the Activity target tab in the “Remove from Group” Activity Properties dialog.

  4. Click in the Activity performs the operation on this object box to specify the object you want the activity to remove from groups. This object is referred to as the activity target. You can choose from the following options to specify the activity target:

    • Fixed object in directory: The activity target is the given object. You can select the desired object in Active Directory when you configure the Remove from group activity.

    • Object identified by workflow parameter: The activity target is the object specified by the value of a certain parameter of the workflow. You can choose the desired parameter from the workflow definition when you configure the Remove from group activity.

    • Object from workflow data context: The activity target is selected by the activity on the basis of the data found in the workflow environment at the time of executing the workflow. When configuring the Remove from group activity, you can specify which object you want the activity to select at workflow run time.

    • Object identified by DN-value rule expression: The Distinguished Name (DN) of the activity target is specified by the string value of a certain rule expression. By using a rule expression, you can compose a string value based on properties of various objects found in the workflow environment at the time of executing the workflow. You can create the desired rule expression when you configure the Remove from group activity.

  5. Navigate to the Groups tab in the “Remove from Group” Activity Properties dialog.

  6. Choose from these options:

    • Remove the object from all groups: This option configures the activity to remove the object from all groups in Active Directory.

      NOTE: You cannot remove objects from their primary groups. Instead, the activity will remove the object from all groups except its primary group.

    • Remove the object from these groups: This option lets you list the groups from which you want the activity to remove the object. For each of the groups in the list (with the exception of the object’s primary group), the activity will remove the object from that group.

  7. If you chose the option Remove the object from these groups, configure the list of groups from which you want the activity to remove the target object. To add a group to the list, click Add group, and then choose from the following options:

    • Fixed group in directory: You can select the desired group in Active Directory when you configure the Remove from group activity. A unique identifier of the group is saved in the configuration of the activity. The activity uses that identifier to select the group when calculating the list of groups at workflow runtime.

    • Object from workflow data context: The group is selected by the activity on the basis of the data found in the workflow environment at the time of executing the workflow. When configuring the Remove from group activity, you can specify which group you want the activity to select at workflow runtime.

    • Object identified by DN-value rule expression: The Distinguished Name (DN) of the group is specified by the string value of a certain rule expression. By using a rule expression, you can compose a string value based on properties of various objects found in the workflow environment at the time of running the workflow. You can create the desired rule expression when you configure the Remove from group activity.

    To remove a group from the list, click X on the right side of the list item representing that group.

  8. View or change notification settings. For more information, see Configuring a notification for a CRUD activity.
  9. View or change error handling settings. For more information, see Configuring error handling for a CRUD activity.
  10. View or change the "Run as" options. For more information, see Configuring “Run as” options for a CRUD activity.
  11. View or change additional settings. For more information, see Configuring additional settings for a CRUD activity.

Configuring a Move activity

When you configure a Move activity, you can specify the rules for selecting the object you want the activity to move, and specify the container to move the object to (destination container). Additional options are available such as notification, error handling, and “Run as” options.

To configure a Move activity

  1. In the Active Roles Console tree, expand Configuration > Policies > Workflow, and select the workflow containing the Move activity you want to configure.

    This opens the Workflow Designer in the Details pane, representing the workflow definition as a process diagram.

  2. In the process diagram, right-click the name of the activity and click Properties.

  3. Navigate to the Activity target tab in the “Move” Activity Properties dialog.

  4. Click in the Activity performs the operation on this object box to specify the object you want the activity to move. This object is referred to as activity target. You can choose from the following options to specify the activity target:

    • Fixed object in directory: The activity target is the given object. You can select the desired object in Active Directory when you configure the Move activity.

    • Object identified by workflow parameter: The activity target is the object specified by the value of a certain parameter of the workflow. You can choose the desired parameter from the workflow definition when you configure the Move activity.

    • Object from workflow data context: The activity target will be selected by the activity on the basis of the data found in the workflow environment at the time of executing the workflow. You can specify which object you want the activity to select at workflow run time.

    • Object identified by DN-value rule expression: The Distinguished Name (DN) of the activity target is specified by the string value of a certain rule expression. By using a rule expression you can compose a string value based on properties of various objects found in the workflow environment at the time of executing the workflow. You can create the desired rule expression when you configure the Move activity.

  5. Navigate to the Destination container tab in the “Move” Activity Properties dialog box.

  6. Click in the Activity moves the object to this container box to specify the container to which you want the activity to move the target object. You can choose from the following options:

    • Fixed container in directory: With this option, the activity moves the object to the given OU or container. You can select the desired OU or container in Active Directory when you configure the Move activity.

    • Parent OU of workflow target object: With this option, the activity moves the object to the OU that holds the target object of the request that started the workflow. This option is unavailable in case of an automation workflow.

    • Activity target object: With this option, the activity moves the object to the OU or container created or otherwise processed by another CRUD activity at the time of executing the workflow. You can select the desired CRUD activity from the workflow definition when you configure the Move activity.

    • Object identified by workflow parameter: With this option, the activity moves the object to the OU or container specified by the value of a certain parameter of the workflow. You can choose the desired parameter from the workflow definition when you configure the Move activity.

    • Object from workflow data context: With this option, the activity moves the object to the OU or container that is selected by the Move activity on the basis of the data found in the workflow environment at the time of executing the workflow. When configuring a Move activity, you can specify which OU or container you want the activity to select at workflow run time.

    • Object identified by DN-value rule expression: With this option, the activity moves the object to the OU or container whose Distinguished Name (DN) is specified by the string value of a certain rule expression. By using a rule expression, you can compose a string value based on properties of various objects found in the workflow environment at the time of executing the workflow. You can create the desired rule expression when you configure the Move activity.

  7. View or change notification settings. For more information, see Configuring a notification for a CRUD activity.
  8. View or change error handling settings. For more information, see Configuring error handling for a CRUD activity.
  9. View or change the "Run as" options. For more information, see Configuring “Run as” options for a CRUD activity.
  10. View or change additional settings. For more information, see Configuring additional settings for a CRUD activity.

Configuring a Deprovision activity

A Deprovision activity is intended to apply the Active Roles deprovisioning policies to a particular user or group. This activity causes Active Roles to perform all the tasks prescribed by the deprovisioning policies, thereby deprovisioning the user or group.

When you configure a Deprovision activity, you can specify the rules for selecting the user or group you want the activity to deprovision. Additional options are available such as notification, error handling, and “Run as” options.

To configure a Deprovision activity

  1. In the Active Roles Console tree, expand Configuration > Policies > Workflow, and select the workflow containing the Deprovision activity you want to configure.

    This opens the Workflow Designer in the Details pane, representing the workflow definition as a process diagram.

  2. In the process diagram, right-click the name of the activity and click Properties.

  3. Go to the Activity target tab in the “Deprovision” Activity Properties dialog.

  4. Click in the Activity performs the operation on this object box to specify the user or group you want the activity to deprovision. This object is referred to as activity target. You can choose from the following options to specify the activity target:

    • Fixed object in directory: The activity target is the given object. You can select the desired object in Active Directory when you configure the Deprovision activity.

    • Object identified by workflow parameter: The activity target is the object specified by the value of a certain parameter of the workflow. You can choose the desired parameter from the workflow definition when you configure the Deprovision activity.

    • Object from workflow data context: The activity target is selected by the activity on the basis of the data found in the workflow environment at the time of running the workflow. When configuring the Deprovision activity, you can specify which object you want the activity to select at workflow run time.

    • Object identified by DN-value rule expression: The Distinguished Name (DN) of the activity target is specified by the string value of a certain rule expression. By using a rule expression, you can compose a string value based on properties of various objects found in the workflow environment at the time of executing the workflow. You can create the desired rule expression when you configure the Deprovision activity.

  5. View or change notification settings. For more information, see Configuring a notification for a CRUD activity.
  6. View or change error handling settings. For more information, see Configuring error handling for a CRUD activity.
  7. View or change the "Run as" options. For more information, see Configuring “Run as” options for a CRUD activity.
  8. View or change additional settings. For more information, see Configuring additional settings for a CRUD activity.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating