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

Configuring a script-based condition

Workflows > Configuring a workflow > Configuring an If-Else activity > Configuring a script-based condition

To configure a script-based condition, you need to create and apply a script module containing a function that analyzes the requested operation to determine whether to run the branch. The function could use the Active Roles ADSI Provider to access properties of objects involved in the operation, analyze the properties, and return TRUE or FALSE depending on the result of the analysis. The branch runs if the function returns TRUE.

To apply a script-based condition

  1. Right-click the name of the branch and click Properties.
  2. In the If-Else Branch Activity Properties dialog box, under Conditions, do the following:
    1. Click the title of the condition group and then click Insert condition.
    2. Click Configure condition to evaluate and then click Value generated by rule expression.
  3. In the Configure Rule Expression dialog box, click Add entry and then click Value generated by script.
  4. Use the Configure Entry dialog box to select the appropriate script module and script function.
  5. Click OK to close the Configure Entry dialog box.
  6. Click OK to close the Configure Rule Expression dialog box.
  7. In the If-Else Branch Activity Properties dialog box, under Conditions, do the following:
    1. Verify that comparison operator equals is selected.
    2. click Define value to compare to, and then click Text string.
  8. In the Configure Entry dialog box, under Text string, type TRUE.
  9. Click OK to close the Configure Entry dialog box.
  10. Click OK to close the If-Else Branch Activity Properties dialog box.
  11. Save your changes to the workflow definition.

As a result of these steps, the If-Else branch you have configured will be selected if the function specified in Step 4 returns TRUE at workflow run time. For more information and instructions, see “Developing Script Condition Functions” in the Active Roles SDK.

Configuring a Stop/Break activity

Workflows > Configuring a workflow > Configuring a Stop/Break activity

When configuring a Stop/Break activity, you can specify the text of an information message. The activity terminates the workflow instance and reports the corresponding event to the Active Roles event log. The message is included in the event description. If possible, the activity also displays that message in the client user interface (such as the Active Roles console or Web Interface) that was used to request the operation that started the workflow.

To configure a Stop/Break activity

  1. In the Active Roles console tree, expand Configuration | Policies | Workflow, and select the workflow containing the Stop/Break activity you want to configure.

    This opens the Workflow Designer window in the details pane, representing the workflow definition as a process diagram.

  1. In the process diagram, right-click the name of the activity and click Properties.
  2. View and, if necessary, change the message text in the Information message box.

Configuring an Add Report Section activity

Workflows > Configuring a workflow > Configuring an Add Report Section activity

You can use an Add Report Section activity to add custom information to the change history report (in case of workflow started by an operation request) or run history report (in case of automation workflow). The activity adds a separate section to the Workflow activities and policy actions area of the report. The section consists of a header and a body. When you configure an Add Report Section activity, you specify what information you want the header and the body to contain.

To configure an Add Report Section Activity

  1. In the Active Roles console tree, expand Configuration | Policies | Workflow, and select the workflow containing the Add Report Section activity you want to configure.

    This opens the Workflow Designer window in the details pane, representing the workflow definition as a process diagram.

  1. In the process diagram, right-click the name of the activity and click Properties.
  2. Under This report section is intended to display information about, select the Error condition option if you want the report to display the text of the header and the body of the report section in red. Otherwise, select the Successful operation option.
  3. Under Header of the report section, click Define to compose the text of the header. The following options are available:
    • Text string  Specify a literal string of characters to be displayed as the header of the report section. The workflow designer prompts you to type the desired string.
    • Value generated by rule expression  Compose the header text of data entries to be calculated during execution of the activity. The workflow designer prompts you to configure a string of entries, and offers various entry types allowing the header text to include properties of objects involved in the workflow and related objects, date and time of activity execution, and workflow parameters.
  4. Under Body of the report section, click Add text and choose from the following options to configure the body text of the report section:
    • Text string  Add a literal string of characters. The workflow designer prompts you to type the desired string.
    • Workflow date and time  Add a date/ time string representing the date and time that the activity is started at workflow run time (referred to as the current date and time in the workflow designer). You can change the format of the date/time string and specify a time offset, in days, if needed.
    • Workflow parameter value  Add a text string specified by a particular parameter of the workflow. The workflow designer prompts you to select the desired parameter.
    • Workflow parameter value  Add a text string specified by a particular parameter of the workflow. The workflow designer prompts you to select the desired parameter.
    • Newline character (CR/LF)  Add the end-of-line code to start a new string.
    • Tab character  Add a tab character to the string.
    • Bullet character  Add a bullet point to the string. You might use a bullet point followed by a tab character at the beginning of a string to format the string as a bulleted list item.
    • Property of object from workflow data context  Add the value of a certain property of the object that will be selected by the activity on the basis of the data found in the workflow environment at the time of executing the workflow. The workflow designer prompts you to choose the desired property and specify which object you want the activity to select upon creating the report section at workflow run time.

In the Body of the report section box, you can modify, reorder or remove text entries. To modify a text entry, click the text and then click Edit. To reorder or remove text entries, use the buttons on the right side of the list items representing the text entries in the Body of the report section box. Thus, to remove an entry, click the X button on the right side of the list item representing that entry in the Body of the report section box.

Configuring a Search activity

Workflows > Configuring a workflow > Configuring a Search activity

You can use a Search activity to perform a search against directory data to find objects, such as users or groups, that match the criteria you specify based on object properties, object location and other information available in the execution environment of the workflow, and to pass these objects to other activities so that the workflow can perform the appropriate actions on them. You can insert activities into a Search activity and have those activities process the objects found by the Search activity.

To add an activity to a Search activity

  1. In the Active Roles console tree, expand Configuration | Policies | Workflow, and select the workflow containing the Search activity.

    This opens the Workflow Designer window in the details pane, representing the workflow definition as a process diagram.

  1. In the details pane, drag the activity from the left panel onto Search activity in the process diagram.

To configure a Search activity, right-click the name of that activity in the process diagram and click Properties. Then, perform the following tasks in the “Search” Activity Properties dialog box:

Related Documents