TASK TEMPLATE OBJECT
- Josep Benavent
- Pedro Jose Sanchez Luling
- Alexey Kapitula (Unlicensed)
This is the main object that defines a specific action of a PROGRAM that must be completed by a CASE or PROFESSIONAL, or executed automatically by the system. It is basically a container of activities assigned to a CASE or PROFESSIONAL, and which are are supposed to be completed at a specific date/time as a block.
TASK TEMPLATE PROPERTIES
| PROPERTY | NAME | TYPE | DESCRIPTION | COMMENTS |
|---|---|---|---|---|
| ID | Id | Integer | Local Identifier of the TASK TEMPLATE | A unique identifier local to the DB instance. TASK TEMPLATES exported to another instance will not share the same ID. |
| REF | Reference | TASK TEMPLATE reference | This value has been designed as a Universal Unique Identifier (UUID) to allow sharing TASK TEMPLATES with other instances. Note that different versions of the same TASK TEMPLATE share the same REF value, and only changes the #TASK_TEMPL:VERSION value | |
| VERSION | Version | DATE | Can have two values:
| |
| CODE | Task Code | STRING | Task Code assigned to the TASK TEMPLATE | |
| TYPE | Type | see: TASK TYPES | The treatment of TASKS does not depend in the TASK TYPE value. It is used only for presentation purposes. | |
| NAME | Name | STRING | Name of the TASK TEMPLATE | |
| DESC | Description | STRING | Description of the TASK TEMPLATE | |
| OWNER | Owner | TEAM OBJECT | TEAM owner of this TASK | This property only has a non NULL value when the TASK TEMPLATE is part of a library of objects and can be shared by multiple PROGRAMs |
| MONITORED | Monitored | BOOL | Indicates if TASKs generated form this TASK TEMPLATE should be monitored | Used for statistical purposes |
| IMAGE | Image | LIBRARY RESOURCE OBJECT | Image to be displayed as background of the TASK when it is displayed in the client interface | |
| CREATION_DATE | Created | DATE | Date of creation of the TASK TEMPLATE | |
| MODIFICATION_DATE | Modified | DATE | Date of last modification of the TASK TEMPLATE | |
| PUBLISH_DATE | Publish Date | DATE | Publish date of a TASK TEMPLATE version (or NULL if it has not been published yet) | |
| ACTIVITIES | Activities | List of ACTIVITY TEMPLATE OBJECT | List of ACTIVITY TEMPLATE OBJECTs included in this TASK TEMPLATE | |
| SYNC_DATE | Sync Date | DATE | Used in TASK TEMPLATEs imported from another instance. Is the date of the last synchronization (update) of the local TASK TEMPLATE | |
| SOURCE | Source | SOURCE | Used in TASK TEMPLATES imported from another instance. Provides the information about the procedence | |
| DOCUMENT | Document | INTEGER | NOT USED | |
| MESSAGE | Message | INTEGER | NOT USED | |
| MINUTES | INTEGER | NOT USED | ||
| UNIQUE | BOOL | NOT USED | ||
| HIDDEN | INTEGER | NOT USED | ||
| EXTRACTION | TEXT | NOT USED (Replaced by SETTINGS) |
TASK TYPES
The following TASK types (except for COM) can be applied to TASKS or isolated ACTIVITIES
| VALUE | DESCRIPTION |
|---|---|
| COM | Generic compound task (contains multiple ACTIVITIES) |
| CUE | Questionnaire (TASK with only one questionnaire, as opposed to COM, which contains multiple activities) |
| DIS | Device: Task intended to collect information from a device (e.g. a step counter, blood pressure...) |
| SYS | System task: internal TASKS managed by the system and not visible for users (except those with role "Service") |
| REP | Report |
| DOC | Document |
| EDU | Educational Task Note that this type of TASK has a special behavior, as explained in EDUCATIONAL TASKS |
CATEGORIES
Task categories are available under the code TASK.CATEGORY
WEB SERVICES
| WS | DESCRIPTION |
|---|---|
| library_program_task_action_list () | Returns a list of possible choices related with actions with the versions of a library_program tasks |
| library_program_task_delete () | Remove a task from a work plan. If the task is a Program Task and this is the last schedule, remove the Task. |
| library_program_task_get () | Returns details of one task of work plan with stage, program and protocol information. |
| library_program_task_list () | Returns list of tasks of work plan grouped by stage and sub-stage. |
| library_program_task_move () | Sets new order for tasks in stage of program. |
| library_program_task_role_list () | Returns list of possible roles for an activity(task). |
| workplan_get () | Returns details of one task's workplan, stage, day, trial_group, etc. |
| workplan_set () | Modifies details of one task's workplan, stage, day, trial_group, etc. |
| library_program_task_set () | Modifies details of the task template. |
| library_program_task_stage_list () | Returns list of stages depending on task id. |
| library_program_task_template_move () | Moves a template (activity or form) from one position to another position. |
| library_program_task_unlock_edit () | Returns details of one task of workplan with stage, program and protocol information. |