Working with Schedulers
Work-Relay Schedulers
From version 8.2:
From the Schedulers Settings screen, Work-Relay Admins can perform the following actions:
- Turn on/off Schedulers for Work-Relay jobs (1)
- Review job statistics
- Force a job to run, by clicking the desired Start Now button (2).
Jobs are scheduled to run every 10 minutes, except where indicated, and perform the following actions:
- Automatic Tasks - Completes System process steps.
- Pending Tasks - Resolves all Pending process steps.
- Reminders/Escalations - Sends reminder notifications and escalates steps (where escalations are configured) to the proper assignees. (Runs every 20 minutes.)
- Time Based Processes - Starts scheduled process instances.
- Validation Rules - Performs validation of automatic (System) and pending steps.
Columns in the Jobs table display the total number of items to process, the number of items processed, a count of any failures, and job execution duration for the last execution of each job.
Several useful reports can be accessed from this screen (see below in this article for more information):
- Stuck Steps report (3)
- Job Trends (4)
- Failure statistics (5)
Note:
The user who has turned on schedulers for Work-Relay jobs will receive the job error notifications (e.g., unhandled exceptions).
Clicking on one of the Start Now buttons (2) starts the proper job execution. During the job run, this button will be disabled and the Status will read "In Progress."
Arrow icons (6) indicate if a statistic value has increased, decreased or remained the same, in comparison with the previous Job run. Hover over the icon to reveal a tooltip (7) containing more information.
The Scheduled Job Stats widget displays statistics for the most recent Job runs (8) and warns about Stuck Steps (9), which are steps that are not completed due to validation rules or errors.
Trends Page
Clicking a Job name will display the Job's trends chart (10). This chart contains:
- A Job Name selector (11), which will default to the Job that was clicked but may be changed to view trends for other Jobs.
- A time period selector (12), which allows the user to define which week's trends will be displayed.
- A "Back to List" button (13), which returns the user to Jobs table.
- A legend (14) that describes which trend line color corresponds to which item type.
- A "?" button (15), which will open the appropriate article of the Work-Relay documentation site in a new browser tab.
- An "Average Number of Items" chart (16), which displays the selected Job's daily average number of items executed for each item type.
- An "Average Duration" chart (17), which displays the daily average duration of the selected Job's executions.
Hovering over any day's vertical line on either chart displays a tooltip that summarizes the values displayed in each chart, respectively (18).
The Legend is dynamic, allowing the user to click each item type in order to display or remove its trend line from the "Average Number of Items" chart.
Notes:
- At least one item type must be selected. A user cannot remove all trend lines.
- When selecting a different Job, all trend lines will be displayed, by default.
Day Stats Page
Clicking on any day's vertical line (vertical) in either chart will display that day's statistics page, which contains:
- A Job Name selector (19), which will default to the Job that was displayed on the Trends Page, but may be changed to view trends for other Jobs.
- A date selector (20), which allows the user to define which day's statistics will be displayed. (Note: The selector is limited to dates within the week that had been selected on the Trends Page.)
- A "Back to Trends" button (21), which returns the user to the Trends Page.
- A legend (22), which indicates which trend line color corresponds to which item type.
- A "?" button (23), which will open the appropriate article of the Work-Relay documentation site in a new browser tab.
- A "Number of Items" chart (24), which displays the number of items and errors for each job run.
- A "Duration" chart (25), which displays the duration of each job execution.
- A "Date Stats by Category" widget (26), which displays summarized statistics and warnings for the selected day.
Hovering over any point on either chart displays a tooltip which summarizes the values displayed in each chart, respectively (27).
The Legend is dynamic, allowing the user to click each item type in order to display or remove its trend line from the "Number of Items" chart.
Notes:
- At least one item type must be selected. A user cannot remove all trend lines.
- When selecting a different Job, all trend lines will be displayed, by default.
"Date Stats by Category" Widget
This widget displays the following statistics:
- Total Runs - Total number of times Jobs were executed automatically.
- Total Items Processed - Total number of items processed in the selected day.
- Total Items Errored - Total number of items that returned an error as a result of job run (Note: If an item resulted in more than one error, it is still only counted as 1 for this metric.)
- Average Items Processed - Average number of items processed per single job run.
- Average Items Errored - Average number of items resulting with errors per single job run.
- Average Duration to Proceed - Average time spent per each job run.
- Max Items - Maximum number of items processed by the selected Job in a single run.
- Max Items Errored - Maximum number of items processed, that resulted in errors, by the selected Job in a single run.
- Max Duration to Proceed - Longest time spent by a single job run.
- Top Errored Records - The three records which have steps with the most errors in their process instances.
- Top Errored Processes - The three processes which have steps with the most errors in their process instances.
- Top Errored Steps - The three steps which have the most errors in process instances that include these steps.
Each of these Top 3 tables allows the user to click the Record/Process/Step name, in order to navigate to the corresponding record page.
Stuck Steps Report
Users may access this report by clicking the appropriate link (3) on main Jobs Page, as described above. This report contains:
- A sortable table (28) of Steps that are currently unable to proceed, along with relevant information described below.
- A "Filter" button (29), which allows the user to define criteria for the report.
- A "Back to List" button (30), which returns the user to Jobs Page.
Report contains the following columns:
- Process Version - The name of the Process Version which contains the stuck step. Clicking the name will navigate the user to the corresponding Process Diagram.
- Step - The name of the Step that cannot proceed.
- Status - The Step's current state (Pending, In Progress, etc.)
- Details - An explanation of why the Step is in its current Status.
- Record - The name of the Process Instance contains the Step that cannot proceed. Clicking the name will navigate the user to the corresponding record page.
Hovering over a cell in the Details column will display an eye icon, indicating there are additional details available. Clicking on the cell will display a popup with those additional details.
Click the "Filters" button to display a Filters sidebar (31). The report may be filtered by performing the following actions:
- Click the "Add filter" button (32) to display the filter configuration options (33).
- Select one of pre-defined properties or source objects (34) and click the conformation button (35).
- For the selected field (36), select an operator (37) and enter the desired value (if available).
- Add more filters, if desired (38).
- Remove a filter by clicking the "X" button (39)
- Click the "Apply" button (40) when all desired criteria have been defined.
- Click the "Reset" button (41) to clear all filters.
Schedulers Settings
Prior to version 8.2:
Work-Relay Admins may force a job to run by clicking the desired Start Now button (42). Basic information about the last job run 43) is available in the table.
Processing mechanics (for developers and enthusiasts):
When Schedulers are on, in Setup -> Scheduled Jobs there are 6 jobs named "Workflow Scheduler 1" through "Workflow Scheduler 6." This way, a scheduler is getting called each 10 minutes to invoke jobs processing. If the run of the previously invoked job cycle is still in progress, the scheduler does not invoke another job cycle.
The Jobs themselves are being called in a particular sequence. The engine would know whether there is a need to process a category of jobs, after executing a query. If, for a given category, there is nothing to process within the given run, this category will be skipped.
The general sequence of categories processing is as follows:
Commands -> Time Based Processes -> Reminders/Escalations -> Validation Rules -> Pending Tasks -> Automatic Tasks
0 Comments
Add your comment