Chat now with support
Chat with Support

Active Roles 7.2.1 - Administrator Guide

Introduction About Active Roles 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
About Policy Objects Policy Object management tasks Policy configuration tasks
Property Generation and Validation User Logon Name Generation Group Membership AutoProvisioning E-mail Alias Generation Exchange Mailbox AutoProvisioning Home Folder AutoProvisioning Script Execution User Account Deprovisioning 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
Workflows
Understanding workflow Workflow activities overview Configuring a workflow
Creating a workflow definition 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
Example: Approval workflow E-mail based approval Automation workflow Activity extensions
Temporal Group Memberships Group Family Dynamic Groups Active Roles Reporting Management History
Understanding Management History Management History configuration Viewing change history
Workflow activity report sections Policy report items Active Roles internal policy report items
Examining user activity
Entitlement Profile Recycle Bin AD LDS Data Management Managing Configuration of Active Roles
Connecting to the Administration Service Adding and removing managed domains Using unmanaged domains Evaluating product usage Configuring replication Using AlwaysOn Availability Groups Using database mirroring 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
Using regular expressions Administrative Template Communication ports

“Delete” activity

“Delete” activity is intended to delete a particular object in Active Directory. The activity allows you to specify the object you want the activity to delete. 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. See Activity target for further details.

“Delete” activity also has a number of configuration settings that are common to CRUD activities:

  • Notification  Active Roles can notify via e-mail about whether or not the activity has encountered an error condition at run time.
  • Error handling  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  Some advanced configuration options that allow you to adjust the processing of the operation requested by the activity.

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 57: 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 e-mail if no significant errors occurred during execution of this activity.
  • Activity encountered an error  When configured to notify of this event, the activity causes Active Roles to send a notification e-mail if any significant errors occurred during execution of this activity.

The notification settings specify the event to notify of, and notification recipients. When executed 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 upon occurrence of that event. The notification settings are similar to the notification settings of a Notification activity (see Notification activity earlier in this document).

Error handling

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 terminate 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 the “Encountered 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, the “Encountered an error” branch condition evaluates to TRUE, causing the workflow to execute the activities intended to perform the compensation action.

Related Documents