Running an automation workflow on demand
An automation workflow can be configured so that users can run it manually regardless of the schedule. This allows them to start the workflow on demand. One can only run an automation workflow on demand if the workflow is enabled and the Allow the workflow to be run on demand setting is selected in the workflow start conditions. For information about enabling a workflow, see Re-enabling an automation workflow to run. For instructions on how to view or change workflow start conditions, see Configuring start conditions for an automation workflow.
You can run an automation workflow on demand from the Active Roles console or Web Interface.
To run an automation workflow on demand from the Active Roles console
- In the Active Roles console tree, under Configuration | Policies | Workflow, right-click the desired automation workflow and click Run.
- If prompted, examine or change the values of the workflow parameters.
- Click OK in the confirmation message box.
To run an automation workflow on demand from the Web Interface
- On the home page in the Web Interface, click Directory Management.
- In the TREE pane, expand the Workflow branch and click the container that holds the desired workflow.
- In the list of the workflow names, to the right of the TREE pane, click the name of the desired workflow.
- Choose the Run command from the menu.
- If prompted, examine or change the values of the workflow parameters.
- Click OK in the confirmation message box.
Active Roles prompts you for parameter values if the workflow has any parameters that need to be supplied by the user running the workflow on demand. If the workflow has no parameters that require user input, then Active Roles will start the workflow without prompting you for parameter values.
Once you have started an automation workflow, Active Roles opens a run history report, allowing you to examine the progress of workflow execution. The report displays the workflow execution status along with information about the activities performed during workflow run. For a workflow that is in progress you have the option to cancel execution of the workflow by clicking the Terminate button.
Viewing run history of an automation workflow
You can use the run history report to examine the running or completed instances of the automation workflow. The report displays the workflow execution status (success or failure) along with the activities that were performed during each workflow run.
After the workflow is completed, the report retains history information about the workflow run. For each completed run of the workflow, the report allows you to identify when and by whom the workflow was started, when the workflow was completed, and what parameter values were used.
The report also lists the workflow activities that were executed during the workflow run. For each activity, you can determine whether the activity was completed successfully or returned an error. In case of error, the report provides an error description. For activities requesting changes to directory data (for example, activities that create new objects or modify existing objects), you can examine the requested changes in detail by clicking the Operation ID number in the run history report. The report sections have the same contents as with Change History reports (see Workflow activity report sections in the Active Roles Administration Guide).
To view run history of an automation workflow from the Active Roles console
- In the Active Roles console tree, under Configuration | Policies | Workflow, right-click the desired automation workflow and click Run History.
To view run history of an automation workflow from the Web Interface
- On the Home page in the Web Interface, click Directory Management.
- In the TREE pane, expand the Workflow branch and click the container that holds the desired workflow.
- In the list of the workflow names, to the right of the TREE pane, click the name of the desired workflow.
- Choose the Run History command from the menu.
Terminating a running automation workflow
You can terminate a running automation workflow to stop the workflow from completing its actions.
To terminate a running automation workflow
- Click the Terminate button on the page that displays the automation workflow’s run history.
For instructions on how to access run history, see Viewing run history of an automation workflow.
The Run History page displays both running and completed instances of the automation workflow. The Terminate button is available on each instance that is currently running. After you click the button to terminate a running instance of an automation workflow, you may experience a delay (up to several minutes) before the workflow shuts down.
Terminating a running automation workflow does not roll back or cancel the workflow activities that have already been performed; this only stops the workflow from running the activities that are in progress or not yet started.
Disabling an automation workflow from running
If you want to prevent an automation workflow from running for a certain period of time, you can disable the workflow. The workflow can be enabled at a later time so that it is allowed to run. For more information, see Re-enabling an automation workflow to run.
To disable an automation workflow from running
- In the Active Roles console tree, under Configuration | Policies | Workflow, right-click the desired automation workflow and click Disable Workflow.