Verifying and Enabling Your Workflow
Before enabling a workflow, you should always verify that it targets the desired users. This plugin provides both a dry-run mode to verify targeted user before enabling a workflow and an action log to trace all actions performed by the plugin.
This section will show you how to perform a dry-run, enable a workflow, and monitor the workflow's activity via the action log.
(1) Opening the workflow details page
- Sign in to your Moodle site as an administrator.
- Navigate to Site administration / Plugins.
- Scroll down and click on Admin tools / User Lifecycle Management / Workflows 1.
- Open your previously create workflow by clicking on the inspection button 2.
(2) Performing a dry-run
This is a safe operation
The dry-run mode is a safe operation that does not perform any real actions. It only simulates which users the workflow would ingest if you were to enable the workflow right now.
- Enable edit mode by clicking on Turn editing on 3 in the workflow header.
- Go to the dry-run page by clicking on Dry-run 4 in the workflow header.
- Check the list of users 5 matches your expectations. You can click on the usernames to open their profiles and inspect them in more detail.
Note that only users that match the filters of the first step of your workflow will be shown. This is due to the fact that users already have to be part of the workflow (i.e. have to be ingested by the workflow) to be processed by later steps.
(3) Enabling the workflow
Risk of user data loss
This is not a drill - Enabling the workflow actually enables the workflow ... D'oh!
Marking the workflow as active via Enable workflow will start the automated user lifecycle management. This can lead to users directly being processed by your workflow.
- Return to the workflow details page and disabled edit mode by clicking on Turn editing off 6 in the workflow header.
- Enable the workflow by clicking on Enable workflow 7 in the workflow header.
- Return to the workflow overview page and assert that the workflow status 8 is now "Active".
Your workflow will now be automatically processed by a scheduled task in the background. Depending on your configuration, it will take some time until the workflow is run for the first time.
(4) Inspecting the action log
If your workflow did run and performed some actions, these will be listed in the action log. To inspect the action log, perform the following steps:
- Navigate to Site administration / Plugins.
- Scroll down and click on Admin tools / User Lifecycle Management / Action log.
- (Optional) Use the filter bar to narrow down the list of actions.
That's it, you completed the quickstart guide!
Yeah! You successfully installed the plugin, created your first workflow, verified it using dry-run mode, and finally got it up and running 🚀
If you wish to learn more about the plugin's features and how to use them, check out the rest of the documentation. Here are some recommended places to start:
Found anything funny on the way or still having questions? Don't hesitate to ask for help or report any issues you encounter via the issue tracker over on GitHub.