The Tech Toolkit Scheduler is a user interface to the Retail Pro PrismSchedulingService. The PrismSchedulingService is a Windows service that runs in the background and executes tasks defined in Scheduler. Tasks are API processes, technically termed "actions," which perform specific functions.
The Scheduler user interface in Tech Toolkit enables users to adjust the timing and other settings of the currently defined tasks. End users cannot add new tasks to Scheduler at this time other than by doing do from Prism, e.g., by creating a new Markdown. The main use for the Scheduler UI in Tech Toolkit, is to provide an easy way for users to adjust the settings of existing scheduled tasks such as time of day to run, interval/how often (daily, every other day), or to turn a task off.
Key Uses of Scheduler UI in Tech Toolkit
- Adjust default settings of tasks to better match business hours, data loads, or other factors
- Check the success or status of specific scheduled tasks
- From time to time, delete once-only tasks that have successfully run
Access Scheduling Service
The Scheduler tool uses a REST connection. If a REST connection does not already exist, you will have to create one in Tech Toolkit Connection Manager. Select the REST connection in the Current Connection drop-down.
After the REST connection is selected. connection has been added, in Tech Toolkit, select the connection from the drop-down. The Scheduler button is enabled. Click the Scheduler button.
You will see the list of default tasks:
View Task Information
- Click the Scheduler button.
- Select a task.
- Click Open Form View (or use the right-click option).
- Edit details as needed. The edits are saved automatically. Click Close when finished.
Sample Task Form:
|Start Date||Day and time the task will start.|
|End Date||Day and time the task will end, If null then no end date.|
|Start Time||Start time for the time frame that the task can be run.|
|End Time||End time for the time frame that the task can be run.|
|Active||True if the task should be run currently. Inactive tasks will not be run.|
|Task Run Interval||(OneTime, Daily, Weekly).|
|Recur Every||Recur Every is based on Frequency, For instance if set to Daily and Recur Every is 1 the task will run every day, If set to 2 the task will run every other day.|
|Repeat every n||Repeat every N Seconds or Minutes.|
|Timeout (seconds)||Number of seconds to wait for service to start. Default 60 seconds. 0 means wait forever, -1 means do not wait at all, Positive integer is how many seconds to wait.|
|Days of the Week||(weekly tasks only) Seven-character string of zero or one. specifying SMTWTFS zero being false and 1 being true. Only applicable to Weekly schedules.|
|Max Retries on Error||Tells the Scheduling service to set a task to not active if it throws consecutive < MaxRetries # > errors. User can re-set task to active and execution cycle will attempt again. If Max Retries is null or 0, it is ignored by Scheduling service.|
|Days of Run History||If > 0, it tells the Scheduling service to keep only
|Workstation||Must be populated only for some tasks whose action requires a workstation "sit", such as price manager actions. Otherwise, can be left blank. However, if populated for a task that does not require it, the workstation populated must be valid otherwise the task will not run.|
|Action URL||Action URL with parameters. This is the path to the resource in the Prism API and the type of action that will be performed
(e.g. /api/common/?action=updateseason )
Note: You should not edit the Action URL.
|Action Payload||If required, a JSON CLOB for the request payload. Note: You should not edit the Action Payload.|
|Task Edit/Delete||Default = OK Edit No Delete.|
|Task Type Code||Four-character alpha-numeric free-form field to allow users to group or filter tasks. For example: PM for price manager or PMM for price manager markdown. Or, SYS for system. Currently grouping and filtering has not been implemented in the UI but will be in later release as more tasks get added to the Scheduler.|
|Public flag||If selected, only Public schedules will be replicated.|
On the bottom of the Scheduler UI is a toolbar with buttons for navigating back and forth from one task to another. Click the Lock icon to lock the task name.
Right-click to Open Form View
When viewing the grid, you can right-click on any field and select Open Form View to view the task in Form View. Form View is usually more convenient for editing tasks.
Scheduler Auto Refresh, Schedule Multiple Tasks
By enabling the Auto-Refresh option, a user can view task status in real-time. The task's TaskRun record will be refreshed with execution progress at the interval selected by the user: Every 10, 15, 30 or 60 seconds
The task will display the current status and a processing update message in the Task Run grid. This helps avoid situations where a user is looking at stale information on the Task Run grid.
To enable auto-refresh, click the drop-down arrow on the Auto-Refresh UI element, located at the bottom of the screen. You can select to refresh All tasks or One task.
- All = Refresh all tasks and task run data.
- One = Single task manual refresh or set task to auto-refresh.
The UI will show the current Auto-Refresh setting, on or off.
From the displayed pop-up menu, select the desired interval: 10, 15, 30 or 60 seconds.
The Status field displays the current status of the scheduled task.
Holds the tasks current task status. Possible values are:
0 - Running
1 - Idle
2 - Error
3 - Scheduled (meaning not yet run).
When a new task is added, it will show as Scheduled until such time as it runs. When the task completes, it will show as "Completed" if it is a OnceOnly task, otherwise it will show as "Idle." The ScheduleTaskRun record holds more status detail on the last execution of the task.
Duplicate Multiple Tasks
The Duplicate Multiple Tasks setting enables you to control what happens when multiple task records attempt to run the same action url simultaneously (at the same or overlapping times).
Possible values are:
0 - BlockWaitRun
1 - BlockDeactivate
2 - BlockDelete
3 - Allow
Scheduled task form showing Duplicate Multiple Tasks setting