Stop Search activity
You can use a Stop Search activity within a Search activity to stop the search being performed by the Search activity. Basically, a Stop Search activity is intended to be used within an If-Else activity nested into a Search activity, in order to stop the search if certain conditions occur. In this scenario, the If-Else activity analyzes data returned by the search, and executes the If-Else branch containing the Stop Search activity if the data returned by the search meets the conditions of that If-Else branch.
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:
-
Create activity: Creates an object, such as a user, group, or computer, in Active Directory.
-
Update activity: Changes properties of an object, such as a user, group, or computer, in Active Directory.
-
Add to group activity: Adds an object, such as a user, group, or computer, to specified groups in Active Directory.
-
Remove from group activity: Removes an object, such as a user, group, or computer, from specified groups in Active Directory.
-
Move activity: Moves an object, such as a user, group, or computer, to a specified container in Active Directory.
-
Deprovision activity: Deprovisions a user or group, by applying the Active Roles deprovisioning policy.
-
Undo deprovision activity: Restores a user or group that was deprovisioned by using Active Roles.
-
Delete activity: Deletes an object, such as a user, group, or computer, in Active Directory.
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 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.
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.