Chat now with support
Chat with Support

Active Roles 8.2 - 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

Activity target

The execution of a CRUD activity results in a request to perform a certain operation on a certain object. For example, an Update activity requests Active Roles to make changes to the properties of a certain object, an Add to group activity requests Active Roles to add a certain object to particular groups, and so forth. The object on which the operation is requested by a CRUD activity is referred to as the target object of that activity, or simply "activity target".

When you configure a CRUD activity, you can use the following options to specify the activity target for that activity:

  • Fixed object in directory: The activity target is the given object. You can select the desired object in Active Directory when you configure a CRUD 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 a CRUD 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. When configuring a CRUD 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 a CRUD activity.

The following table helps distinguish CRUD activity targets.

Table 19: CRUD activity targets

Activity

Activity target

Update

The object whose properties are to be changed. An Update activity requests Active Roles to change certain properties of a particular object. That object is referred to as the activity target of the Update activity.

Add to group

The object to be added to the groups. An Add to group activity requests Active Roles to add a certain object to particular groups. That object is referred to as the activity target of the Add to group activity.

Remove from group

The object to be removed from the groups. A Remove from group activity requests Active Roles to remove a certain object from particular groups. That object is referred to as the activity target of the Remove from group activity.

Move

The object to be moved. A Move activity requests Active Roles to move a certain object to a particular container in Active Directory. That object is referred to as the activity target of the Move activity.

Deprovision

The object to be deprovisioned. A Deprovision activity requests Active Roles to deprovision a certain object. That object is referred to as the activity target of the Deprovision activity.

Undo deprovision

The object to be restored. An Undo deprovision activity requests Active Roles to restore a certain object that was deprovisioned. That object is referred to as the activity target of the Undo deprovision activity.

Delete

The object to be deleted. A Delete activity requests Active Roles to delete a certain object. That object is referred to as the activity target of the Delete activity.

Notification

You can configure a CRUD activity to subscribe recipients to the notifications of the following events:

  • Activity completed successfully: When configured to notify of this event, the activity causes Active Roles to send a notification email if no significant errors occurred during the run of this activity.

  • Activity encountered an error: When configured to notify of this event, the activity causes Active Roles to send a notification email if any significant errors occurred during the run of this activity.

The notification settings specify the notification event and its recipients. When run by the workflow, the activity prepares a notification message appropriate to the specified event. Active Roles retains the message prepared by the activity, and sends the message to the specified recipients when the event occurs. The notification settings are similar to the notification settings of a Notification activity. For more information, see Notification activity.

Error handling – CRUD activities

When configuring a CRUD activity, you can choose whether to suppress errors encountered by that activity. The following option is available: Continue workflow even if this activity encounters an error. If this option is not selected (default setting), an error encountered by the activity causes Active Roles to stop the workflow.

If you configure a CRUD activity so that the workflow is allowed to continue in case of an error encountered by that activity, then you can have the workflow take an appropriate compensation action. This could be accomplished by using an If-Else activity with a branch condition that evaluates the Encountered an error execution status of the CRUD activity. Add an If-Else activity following the CRUD activity and configure a condition on an If-Else branch to detect theEncountered an error execution status of that CRUD activity. Then, configure that If-Else branch to contain the activities you want to perform the compensation action. As a result, once the CRUD activity has encountered an error, theEncountered an error branch condition evaluates to TRUE, causing the workflow to execute the activities intended to perform the compensation action.

"Run as" options

By default, Active Roles runs CRUD activities under the user account specified with the Workflow options and start conditions > Configure > "Run as" options setting. This user account can be the service account of the Active Roles Administration Service or the account of the user who caused the workflow to start. You can configure the activity to override the default "Run as" options setting by choosing to run the activity under the service account or the account of the user who caused the workflow to start. The account under which the activity is running determines the access rights of the activity in the directory.

One more option determines whether to apply approval rules to the operation requested by the activity if the activity is executed under a privileged account, such as the Active Roles service account, an Active Roles Admin account, or the account of the user who is designated as an approver. By default, the activity uses the option setting specified in the workflow options and start conditions. However, the workflow-wide option setting can be overridden on a per-activity basis.

When you configure a CRUD activity, you can enable or disable the Enforce approval option for that activity. When enabled, this option causes the approval rules to be applied, submitting the operation for approval regardless of the account under which the activity is executed. Otherwise, the operation requested by the activity bypasses approval rules if the activity is executed under the Active Roles service account, an Active Roles Admin account, or the account of the user who is designated as an approver, so the operation is not submitted for approval.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating