Chat now with support
Chat with Support

Active Roles 7.2 - Administration 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

CRUD activities

Active Roles offers a number of workflow activities, collectively referred to as CRUD activities, intended to create new objects, and modify or delete existing objects in Active Directory. The CRUD abbreviation designates the key operations that can be performed by using these activities: Create, Read, Update, Delete. The following CRUD activities are available in the Active Roles workflow designer:

The following topics in this section provide an overview of the 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.

“Create” activity

“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 desired 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 desired 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 desired 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 desired 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 desired 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 desired 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 desired 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 desired property when you configure a Create activity.
    • Workflow parameter value  Use 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.
    • 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 desired 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 desired rule expression when you configure a Create activity.

“Create” 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.

“Update” activity

“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. See Activity target for further details.
  • 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 desired 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 desired 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 desired 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 desired property when you configure an Update activity.
    • Workflow parameter value  Use the value of a certain parameter of the workflow. You can choose the desired 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 desired 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 desired rule expression when you configure an Update activity.

“Update” 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.

“Add to group” activity

Workflows > Workflow activities overview > CRUD activities > “Add to group” activity

“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. See Activity target for further details.
  • 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.

“Add to group” 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.
Related Documents