This document is a User Guide to functionality and processes for the Controller dashboard functions. It is intended primarily for technical, supervisory, and administrative users of the Actionabl system.
Actionabl.ai is a platform that automates your business processes and alerts users whenever human intervention is needed.
This guide covers the Controller Dashboard, which is central to managing the flow of automated processes through the system and enables monitoring and reporting on the workflows being managed in Actionabl.
If you are a new technical or supervisory user of Actionabl, you may find it helpful to first review Getting Started with Actionabl to familiarize yourself with the critical concepts and terms used throughout this document.
Related Documents:
Two modules are unique to the Controller dashboard: Control Center and Process Analytics.
For convenience, you can also access the Search tools, Process View, and Error Tasks queue directly from the Controller menu.
The Control Center can be thought of as air traffic control at a busy airport. This is where you:
The Process Analytics dashboard gives you a visual overview of how items are moving through your automation based on reports and charts that your system administrator builds to monitor your metrics.
The Automation Manager module shows you all automations and tasks configured in the system, with an at-a-glance view of their status (running, paused, failed, etc.).
It contains 2 tabs:
Each automation or task shows:
In the Process Name or Task Name fields, an asterisk (*) indicates that the automation is a “Common Process Automation.” This means that it runs across all processes or tasks, so any change in its status will affect all items flowing through the system. Examples include data or report archives, which run across the entire system.
To see all of the automations and tasks relating to a specific process, select the process from the dropdown at the top right. This activates the process filter; when this filter is on, you will not see any Common Process Automations listed.
Pausing An Automation
This should be done whenever you make changes to an automation or task configuration, ensuring that items queued for processing follow the new configuration.
To pause an automation, click the green indicator on its right.
When it has been fully paused, the indicator will turn red.
To restart a paused automation, click its red indicator. Once it has restarted, the indicator turns green.
To refresh any automation, click the yellow “refresh” icon on the far right of the line. This will pause the current job and restart it. This can be useful in troubleshooting if a process or item appears “stuck.”
The Automation Scheduler is where you build or edit the schedules that manage the automations and tasks listed in the Automation Manager.
The list shows all of the existing schedules. There are both standalone and process-specific schedules in the list.
Standalone schedules are applied to any matching item flowing through the system, regardless of the process or task it is in.
In the example, the Standalone schedule “Read Support Emails” runs each time a new email is received that matches the definition within the schedule.
Process-specific schedules only examine items while they are flowing through the specified process or task. If they match during that time, the schedule applies to them.
In the example, the Process schedule “Task Notification Email” will be run only against items currently in the send_notification process and the send_email task.
View Schedule Details
Click the expand icon on the right of any schedule to open its details.
The automation editor popup will appear. The popup will show different options for each type of automation (by execution mode). This is an example of a “Call” automation.
Change Automation Configuration
Click the blue Edit button to change the automation’s configuration. Click the gray Cancel button to cancel without saving any changes.
The Schedule Type can be set to process or standalone, as previously described. For process automations, you must specify the process and (optionally) task to which the schedule should apply. If the automation should span all processes and/or tasks, enter an asterisk (*) in the appropriate field.
NOTE: The Process Name and Task Name must exactly match the way they are shown in the Process View, including capitalization. This will happen automatically if you select “Create Automation Schedules” while you’re deploying the process.
All automations require a Connector. Click the selection icon to pick the connector from the list.
HINT: Configure connectors on the Task Manager dashboard (for users with technical, supervisory, or system admin rights). Details are in the Task Management guide.
Set an Execution Mode
The Execution Mode for the automation determines how it runs. The options are:
To determine the schedule, specify either a Cron schedule or set a Recurrent Frequency and Recurrent Time Unit.
Hint: Cron jobs do not check to see if the previous run of the job has been completed, so scheduling runs too close together for long items like backups could result in overlapping runs and errors.
Set up a Recurrent Schedule or Cron
Select Run Interval from the dropdown:
Select a Time Unit and enter a Recurrence Frequency (in the selected time unit). This is the wait time between the end of one execution and the start of the next.
OR
Select a Cron Schedule by clicking the selection icon in the field. Making a selection here overrides any entries in the Run Interval.
There are cases where you will want an automation rule to be selective about when and how it runs within a process. Some examples include:
- You want to notify customers about proofing only if an invoice exceeds a threshold amount.
- Certain vendors have asked not to receive emails about individual order invoice payments because they prefer an end-of-month summary statement.
- You want a conditional case that alerts a user and shows new fields if a field has a specific value. For example, in processing a loan application, if a user has input “Owns” for home ownership, pause the automation and display new fields asking about mortgage balances, real estate taxes, etc.
In the Automation Scheduler list, click the expander icon to the right of the automation you want to apply the rule to.
Click the blue Edit button to enter Edit mode.
Click the selection icon in the Disable Rule field.
The existing rules are displayed in the list. To view their details, click on the expand icon to the right of any rule.
If you need to adjust a rule’s definition, remember that changes you make here will take effect in ALL automations that use this rule.
If the changes apply only to this automation, click the green Duplicate button to create a new copy of the rule. The copy appears immediately below the existing one. Make changes in this NEW copy, then save and select the new rule.
After saving your changes to the rule, reactivate the automation so it restarts with the new rule definitions.
If none of the rules match your needs, you can create a new disable rule. There are two ways to do this:
If no rules in the list are close to the one you need, click the green plus sign at the top right of the popup to create a new rule from scratch.
Select a Category for the new rule.
Select the rule’s Type. This determines the fields you have available to build the logic for the rule. The next section, Building Rule Logic, covers the logic available for each type.
Enter a unique ID. This ID is restricted to letters, numbers, and underscores. No spaces or special characters are allowed.
Enter the rule’s Name. This is what appears on the popups when you select a rule or when you view an automation’s configuration, so it should be unique and clearly describe the rule’s scope. For example, “Amount LT 1000” or “Opted out of daily invoices”
NOTE: Names must contain no special characters other than underscore (_), dash (-), and period (.). They can contain spaces and alphanumeric characters.
Click the “Active” box (if it is not already selected) to indicate that the rule should apply when it is saved and the automation is restarted.
Actionabl looks at the values and criteria defined here in the logic section and bypasses the automation for any record that evaluates “YES” against these criteria. The logic section, where you build this logic, changes depending on the Type selected in the top line.
Regardless of the rule type, click the green plus sign to the right of the criteria header to get started adding the logic:
Default Rule
This defines a condition that, when matched, causes the item to be bypassed when the automation runs.
In this example, attached to the “AutoPay” automation, any invoice with a total amount greater than or equal to $1000 will disable the AutoPay automation.
You can “stack” additional conditions onto this rule. At the top of the condition list, select whether the conditions should be boolean AND or OR, and click the green plus sign to add a new row.
The green “grouping” icon next to the green plus lets you add a condition group. A condition group is treated as a single condition in evaluating the boolean AND/OR above it. Let’s look at some examples to clarify this.
This example disables autopay for any invoice greater than or equal to $1000.
This example disables autopay for invoices greater than $1000 plus ANY invoice from supplier “VendX” for any amount. Using boolean OR matches against either one of these conditions.
The following example uses grouping. It disables autopay for invoices greater than or equal to $1000 but ONLY if they are Manually Completed OR from supplier VendX.
You may also define additional actions that happen when these conditions are met. These actions are taken after the automation is disabled and can be:
Click the green plus sign on the right of the Action field to define more actions.
In the following example, Error Message is the action type, which generates an error task for the user to resolve and stops the task’s execution.
Click Save to finish, and then select the rule you just created to apply it to the task.
This rule will now also be available in the Disable Automation list for all other tasks and can be selected for reuse there.
Expression rules are built using the same techniques as the default rule, but instead of selecting fields and values to match, you define those conditions using Javascript expressions.
This rule type uses Javascript (either in an attached file or a function entered directly here) to determine the eligibility of a record to run this automation.
Either click the [ ] icon in the Script File field to select an existing script file or enter the javascript code directly in the Script field.
HINT: Script files are added directly to the deployed folder in your system. If that folder is under source control, such as Github, follow your company’s practices.
Once you’ve selected a file or entered a script, you can set parameters that govern how that script should behave. Click the green plus sign to the right of Rule Parameters to open that section.
AI spaces are components that are part of the machine-learning tasks within a process. The computing needs of an AI space are usually intense, so they are set up as separate-but-trusted environments that work as components within Actionabl.
AI spaces are typically used for classification or language detection models. These trained models sit separately from the core of Actionabl but are used by Actionabl within a process. In many ways, they run like an external component, but they are trusted items.
When the Actionabl team sets up your system, the AI spaces are also set up as part of that process, so client users cannot edit these spaces.
AI Space Manager is used simply to check the status, pause, or start one of the AI spaces, as needed.
Details of an AI space include whether it is running, the mode(s) enabled, and a count of the current workers running in the space.
The Cron Job Scheduler in Actionabl is where you set up a task to run and match it with a schedule you’ve defined under Cron Schedules. This process creates a cron job.
Cron jobs are tasks that are managed by a time-based scheduler that is built into all Unix-based operating systems. You use a cron schedule to specify precisely when and with what frequency the task or script should execute, such as “every 15 minutes” or “every other Thursday at 2 PM”.
The Cron Job Scheduler shows all cron jobs currently set up:
To set up a new cron job schedule, click the green plus icon at the top right of the screen.
The Type is either Report, Batch Job, or Task Event. When you pick one, the appropriate additional fields appear to set it up.
Cron Schedules
The Cron Schedules module defines all of the possible schedules that a task could use for its run schedule. It is prepopulated with some common schedules.
Add A New Cron Schedule
You can specify an optional Effective Start Date and Effective End Date for the schedule, which is helpful if you create a temporary cron job.
Likewise, you can specify an Effective Start Time and Effective End Time. If you leave these fields blank and specify a start and end date, the job will start at midnight on the start date and end at 11:59 PM on the end date.
Click the browse brackets [ ] to specify Disable Rule(s) that disqualify items from being included in this cron job. For details about defining rules, see Configuring Disable Rules for Automations.
Click the browse brackets [ ] next to Cron Expression to set up the schedule for jobs to run.
Check each appropriate box to build the schedule you want. You can select single or multiple options in each section or select “No Restriction” for sections that do not apply.
The following example sets the schedule to run daily at 9 PM:
HINT: If you are used to setting up cron jobs using crontab code, the code generated by the schedule is shown at the bottom for ease of verification.
Click Save at the top right to save this parameter.
You can continue adding parameters to this cron schedule if you need.
When the schedule contains all of the necessary parameters, click the green Save button to save it. If the “Active” box at the top is checked, this also activates the schedule.