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

Create activity

The Create activity is intended to create an object, such as a user, computer, or group in Active Directory. The activity allows you to configure the following characteristics of the object to be created:

  • Container: You can specify the Organizational Unit (OU) or container in which you want the activity to create an object. The following options are available:

    • Fixed container in directory: Create an object in the given OU or container. You can select the desired OU or container in Active Directory when you configure a Create activity.

    • Parent OU of workflow target object: In case of a change workflow, create an object in the OU that holds the target object of the request that started the workflow.

    • Activity target object: Create an object in 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 a Create activity.

    • Object identified by workflow parameter: Create an object in 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 a Create activity.

    • Object from workflow data context: Create an object in the OU or container that will be selected by the Create activity on the basis of the data found in the workflow environment at the time of executing the workflow. When configuring a Create 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: Create an object in 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 a Create activity.

  • Object type and name: You can specify the type and the name of the object to be created by the activity. When you configure a Create activity, you can choose the appropriate object type and define how the activity will generate the object name when creating an object. The following options are available:

    • Text string: Use the given string of characters as the name of the object. You can specify the string when you configure a Create activity.

    • Name of workflow target object: In case of a change workflow, use the name of the target object of the request that started the workflow.

    • Name of workflow target object, followed by text string: In case of a change workflow, use a certain text string prefixed with the name of the target object of the request that started the workflow. You can specify the text string when you configure a Create activity.

    • Workflow parameter value: The name of the object is specified by the string value of a certain parameter of the workflow. You can choose the parameter from the workflow definition when you configure a Create activity.

    • Property of object from workflow data context: The name of the object is specified by the value of a certain property of the object that will be selected by the Create activity on the basis of the data found in the workflow run-time environment. When you configure a Create activity, you can choose the property and specify which object you want the activity to select at workflow run time.

    • Value generated by rule expression: The name of the object is identified 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 a Create activity.

  • Object properties: You can define how you want the activity to populate the properties of the new object. When you configure a Create activity, you can choose the properties you want the activity to populate and, for each property, specify the value to be assigned to that property. The following options are available:

    • Text string: Use the given string of characters as the value of the property. You can specify the string when you configure a Create activity.

    • Property of workflow target object: In case of a change workflow, the value of a certain property of the target object of the request that started the workflow. You can select the property when you configure a Create activity.

    • Property of workflow initiator: Use the value of a certain property of the user whose request started the workflow. You can select the property when you configure a Create activity.

    • Changed value of workflow target object property: In case of a change workflow, use the value that is requested to be assigned to a certain property of the workflow target object. You can select the property when you configure a Create activity.

    • Workflow parameter value: Use the value of a certain parameter of the workflow. You can choose the parameter from the workflow definition when you configure a Create activity.

    • Property of object from workflow data context: Use the value of a certain property of the object that will be selected by the Create activity on the basis of the data found in the workflow environment at the time of executing the workflow. When you configure a Create activity, you can choose the property and specify which object you want the activity to select at workflow run time.

    • Value generated by rule expression: Use 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 rule expression when you configure a Create activity.

The Create activity also has a number of configuration settings that are common to CRUD activities:

  • Notification: Active Roles can notify via email about whether or not the activity has encountered an error condition at run time.

  • Error handling – CRUD activities: Determines whether or not the workflow is allowed to continue if the activity has encountered an error condition at run time.

  • "Run as" options: Determines the user account under which to run the activity.

  • Additional settings – CRUD activities: Some advanced configuration options that allow you to adjust the processing of the operation requested by the activity.

Update activity

The Update activity is intended to make changes to particular properties of a certain object. This activity has the following configuration options:

  • Activity target: This option lets you specify the object whose properties you want the activity to change. You can select the object when you configure the activity, or you can configure the activity to select the appropriate object at workflow run time. For more information, see Activity target.

  • Target properties: You can define how you want the activity to change the properties of the object. When you configure an Update activity, you can choose the properties you want the activity to change and, for each property, specify the new value to be assigned to that property. For a multi-value property, you can choose to add or remove the value from that property. The following options are available:

    • Text string: Use the given string of characters as the value of the property. You can specify the string when you configure an Update activity.

    • Property of workflow target object: In case of a change workflow, use the value of a certain property of the target object of the request that started the workflow. You can select the property when you configure an Update activity.

    • Property of workflow initiator: Use the value of a certain property of the user whose request started the workflow. You can select the property when you configure an Update activity.

    • Changed value of workflow target object property: In case of a change workflow, use the value that is requested to be assigned to a certain property of the workflow target object. You can select the property when you configure an Update activity.

    • Workflow parameter value: Use the value of a certain parameter of the workflow. You can choose the parameter from the workflow definition when you configure an Update activity.

    • Property of object from workflow data context: Use the value of a certain property of the object that will be selected by the Update activity on the basis of the data found in the workflow environment at the time of executing the workflow. When you configure an Update activity, you can choose the property and specify which object you want the activity to select at workflow run time.

    • Value generated by rule expression: Use 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 rule expression when you configure an Update activity.

The Update activity also has a number of configuration settings that are common to CRUD activities:

  • Notification: Active Roles can notify via email about whether or not the activity has encountered an error condition at run time.

  • Error handling – CRUD activities: Determines whether or not the workflow is allowed to continue if the activity has encountered an error condition at run time.

  • "Run as" options: Determines the user account under which to run the activity.

  • Additional settings – CRUD activities: Some advanced configuration options that allow you to adjust the processing of the operation requested by the activity.

Add to group activity

The Add to group activity is intended to add a certain object, such as a user, computer, or group, to particular groups in Active Directory. This activity has the following configuration options:

  • Activity target: This option lets you specify the object you want the activity to add to groups. You can select the object when you configure the activity, or you can configure the activity to select the appropriate object at workflow run time. For more information, see Activity target.

  • Groups: This option lets you define the groups to which you want the activity to add the object. When you configure an Add to group activity, you can specify a list of groups. For each of the groups in the list, the activity will add the object to that group. To add a group to the list, you can choose from the following options:

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

    • Object from workflow data context: The group will be selected by the activity on the basis of the data found in the workflow environment at the time of executing the workflow. When configuring an 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 an Add to group activity.

The Add to group activity also has a number of configuration settings that are common to CRUD activities:

  • Notification: Active Roles can notify via email about whether or not the activity has encountered an error condition at run time.

  • Error handling – CRUD activities: Determines whether or not the workflow is allowed to continue if the activity has encountered an error condition at run time.

  • "Run as" options: Determines the user account under which to run the activity.

  • Additional settings – CRUD activities: Some advanced configuration options that allow you to adjust the processing of the operation requested by the activity.

Remove from group activity

The Remove from group activity is intended to remove a certain object, such as a user, computer or group, from particular groups in Active Directory. This activity has the following configuration options:

  • Activity target: This option lets you specify the object you want the activity to remove from groups. You can select the object when you configure the activity, or you can configure the activity to select the appropriate object at workflow run time. For more information, see Activity target.

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

    NOTE: The Remove from group activity cannot remove the object from its primary group. It can only remove the object from all other groups.

  • Groups - Remove the object from these groups: This option lets you list the groups from which you want the activity to remove the object. You can specify a list of groups when you configure a Remove from group activity. 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. To add a group to the list, you can choose from the following options:

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

    • Object from workflow data context: The group will be selected by the activity on the basis of the data found in the workflow environment at the time of executing the workflow. When configuring a Remove from 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 a Remove from group activity.

The Remove from group activity also has a number of configuration settings that are common to CRUD activities:

  • Notification: Active Roles can notify via email about whether or not the activity has encountered an error condition at run time.

  • Error handling – CRUD activities: Determines whether or not the workflow is allowed to continue if the activity has encountered an error condition at run time.

  • "Run as" options: Determines the user account under which to run the activity.

  • Additional settings – CRUD activities: Some advanced configuration options that allow you to adjust the processing of the operation requested by the activity.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating