Summary
This article covers customizing tasks with the Scheduler.
Table of Contents
The Scheduler provides the capability to schedule jobs within the platform to run at a later date on a defined schedule. While the scheduler supports several standard job types, the scheduler can also support custom jobs made up of custom tasks. These custom tasks must be configured in the DA by a Software Implementation Specialist (SIS) and must have a corresponding custom Java file uploaded to the study.
This page describes the steps for configuring the DA and assumes you already have the custom Java file uploaded to the study through Trial Manager.
App Properties
Each custom task will have a unique app property name and values defining the task. Each value must be separated by a comma and must be in single quotes as shown in the example at the end of this section. This section describes the steps for adding a sample custom task. The exact steps for customizing a task can vary. The developer of the custom task should provide the Software Implementation Specialist (SIS)with instructions regarding the customization.
- Name: Enter ‘CustomTask-’ followed by a unique ID for the custom task.
Note: No spaces are accepted as part of the app property name.
- Value: Enter ‘name=’ followed by the name of the task as it should appear to the user when they are selecting the custom task. The name must be in single quotes.
- Value: Enter ‘desc=’ followed by a short description of the task in single quotes.
The description will appear in the user interface when the scheduler configures the task. - Value: Enter ‘class=’ followed by the name of the custom java file added to the study through Trial Manager. The name must be in single quotes.
- Value: Enter ‘parameter=’ followed by a comma separated list of all parameters used in the custom task. The list must be in single quotes.
Roles
For a role to be able to select custom tasks in the Scheduler, the role must be granted permission through the Roles worksheet. As the permission configuration is independent of the custom task, the developer of the custom task does not typically advise on the configuration of the roles.
Note: A role is allowed to run all or no custom tasks. There is no differentiation on the specific custom task.
- Custom Actions: Enter a descriptive name for the permission such as ‘Custom Task’
- Actions Required: Enter ‘customTask’
- Screens Required: Leave this column blank.
- Select the Roles that are permitted to schedule the custom task by placing an ‘X’ in the appropriate columns.
Need more help?
Please visit the Fountayn Contact Information page.