Task Reports
The task report displays information about a selected task and how it is used in the deconflicted schedule.
The task report is designed so that it provides information about the definition of one or more tasks in such a manner that it may be programmatically parsed using an external application.
Task Reports may be created by selecting Task -> Report from the Menu Bar, then selecting a task if one is not already selected.
Task Reports
Report Details
The report details section contains a set of keywords with their associated data for each task included in the report. The following sections detail each keyword.
| Keyword | Format | Description |
|---|---|---|
| TR_TASK_NAME | TR_TASK_NAME '{task name}' | The TR_TASK_NAME keyword precedes the name given to the task on the Task Definition Form. The name of the task will appear contained within quotation marks. |
| TR_DESCRIPTION | TR_DESCRIPTION '{task description}' | The TR_DESCRIPTION keyword precedes the description given to the task on the Task Definition Form. The description of the task will appear contained within single quotation marks. |
| TR_ALLOWBONUSING | TR_ALLOWBONUSING {YES/NO} | The TR_ALLOWBONUSING keyword precedes a yes or no Boolean value that describes if the task can be bonused, or allow its assignments to bonus other tasks who also have this value set to true. |
| TR_BONUSEDTASKS | TR_BONUSEDTASKS TaskA, TaskB, ... | The TR_BONUSEDTASKS keyword precedes a comma delimited list of tasks that were bonused due to this task's assignments. |
| TR_DEFERRED | TR_DEFERRED {YES/NO} | The TR_DEFERRED keyword precedes a yes or no Boolean value that describes whether or not the task is currently deferred as define on the Status Tab of the Task Definition Form. |
| TR_LOCKED | TR_LOCKED {YES/NO} | The TR_LOCKED keyword precedes a yes or no Boolean value that describes whether or not the task is currently locked as defined on the Status Tab of the Task Definition Form. |
| TR_PRIORITY | TR_PRIORITY {task priority value} | The TR_PRIORITY keyword precedes the priority given to the task on the General Tab of the Task Definition Form. |
| TR_SCHEDULING_PREFERENCE | TR_SCHEDULING_PREFERENCE {EARLY/MIDDLE/LATE/NONE} | The TR_SCHEDULING_PREFERENCE keyword precedes the scheduling preference of the task as defined on the General Tab of the Task Definition Form. |
| TR_TIMESLOT_PREFERENCE | TR_TIMESLOT_PREFERENCE {EARLY/MIDDLE/LATE/NONE} | The TR_TIMESLOT_PREFERENCE keyword precedes the timeslot preference of the task as defined on the General Tab of the Task Definition Form. This refers to the relation of the scheduled time and where it falls within a timeslot. |
| TR_GROUPS | TR_GROUPS {number of groups} | The TR_GROUPS keyword precedes the number of task groups that the task is included in as defined on the General Tab of the Task Definition Form. |
| TR_GROUP_NAME | TR_GROUP_NAME '{group name}' | The TR_GROUP_NAME keyword precedes the name of a group in which the task is included in as defined on the General Tab of the Task Definition form. The group name is contained within single quotation marks. The number of TR_GROUP_NAME keywords in the report will equal the number of groups the task is included in (See TR_GROUPS above). |
| TR_TASK_TYPE | TR_TASK_TYPE {task type - RECURRING_PARENT_DEFINITION/TEMPLATE_PARENT_DEFINITION/SINGLE_INSTANCE_DEFINITION} '{name of template parent task}' '{name of recurring parent task}' | The TR_TASK_TYPE keyword precedes parameters that define the type of task. Parameters include the task type, name of template task (if any), and name of recurring parent task (if any). |
| TR_FOM_TOTAL | TR_FOM_TOTAL {task's FOM} | The TR_FOM_TOTAL keyword precedes the task's FOM score, which is a sum of components, each component being scaled by a weight set on the FOM Properties Tab of the Schedule Properties form. |
| TR_FOM_ASSIGN | TR_FOM_ASSIGN {raw Assign component of the task's FOM} | The TR_FOM_ASSIGN keyword precedes the Assign component of the task's FOM score, unscaled by the corresponding FOM weight. |
| TR_FOM_DUR | TR_FOM_DUR {raw Dur component of the task's FOM} | The TR_FOM_DUR keyword precedes the Dur component of the task's FOM score, unscaled by the corresponding FOM weight. |
| TR_FOM_PP | TR_FOM_PP {raw PP component of the task's FOM} | The TR_FOM_PP keyword precedes the PP component of the task's FOM score, unscaled by the corresponding FOM weight. |
| TR_FOM_PN | TR_FOM_PN {raw PN component of the task's FOM} | The TR_FOM_PN keyword precedes the PN component of the task's FOM score, unscaled by the corresponding FOM weight. |
| TR_FOM_EARLY | TR_FOM_EARLY {raw Early component of the task's FOM} | The TR_FOM_EARLY keyword precedes the Early component of the task's FOM score, unscaled by the corresponding FOM weight. |
| TR_FOM_MAXDUR | TR_FOM_MAXDUR {raw MaxDur component of the task's FOM} | The TR_FOM_MAXDUR keyword precedes the MaxDur component of the task's FOM score, unscaled by the corresponding FOM weight. |
| TR_FOM_PT | TR_FOM_PT {raw PT component of the task's FOM} | The TR_FOM_PT keyword precedes the PT component of the task's FOM score, unscaled by the corresponding FOM weight. |
| TR_RECURRING_TYPE | TR_RECURRING_TYPE {TIME/RESOURCE/NA} | The TR_RECURRING_TYPE keyword precedes a parameter that describes what the task uses as a basis to define its scheduling windows defined by on the Scheduling Tab of the Task Definition Form. |
| TR_APPLY_RECURR_DUR_EXTENSION | TR_APPLY_RECURR_DUR_EXTENSION {TRUE/FALSE} | The TR_APPLY_RECURR_DUR_EXTENSION keyword precedes a parameter that describes if the recurring children tasks will have their timeslots extended by a certain value as define by on the Scheduling Tab of the Task Definition Form. |
| TR_RECURRING_CONSTRAINTS | TR_RECURRING_CONSTRAINTS {minAfterType} {minTimeAfter} {maxAfterType} {maxTimeAfter} | The TR_RECURRING_CONSTRAINTS keyword precedes the parameters that describes how the recurring children tasks will be scheduled in relation to other children tasks of the same parent on the Scheduling Tab of the Task Definition Form. |
| TR_SINGLEINST_DISCRETE_WINDOWS | TR_SINGLEINST_DISCRETE_WINDOWS {number of windows} | The TR_SINGLEINST_DISCRETE_WINDOWS keyword precedes the number if discrete windows that are used to define the scheduling times for a single instance task as defined on the Scheduling Tab of the Task Definition Form. |
| TR_WINDOW_DEF | TR_WINDOW_DEF {window start time/date} {window stop time/date} '{window comment}' | The TR_WINDOW_DEF keyword precedes parameters that define a discrete window used to describe the scheduling windows of the task. The parameters include the window start time, window stop time, and window comments as defined on the Scheduling Tab of the Task Definition Form. The number of TR_WINDOW_DEF keywords in the report equals the number of discrete windows (See TR_SINGLEINST_DISCRETE_WINDOWS above). |
| TR_SINGLEINST_STKREPORTS | TR_SINGLEINST_STKREPORTS {number of reports} | The TR_SINGLEINST_STKREPORTS keyword precedes the number of STK reports that are used to define the scheduling windows of a single instance task as defined on the Scheduling Tab of the Task Definition Form. |
| TR_STKREPORT_DEF | TR_STKREPORT_DEF {report start time/date} {report stop time/date} {WINDOW/FIXEDSTART/FIXEDSTOP} {start offset time duration} {duration or end offset time} '{STK object 1 path}' '{STK object 2 path}' '{report type}' '{maintain offset times (YES or NO)}' '{use next time value in report (TRUE or FALSE)}' | The TR_STKREPORT_DEF keyword precedes parameters that define a STK report that is used to describe the scheduling windows for the task. The parameters include the report start time, reports stop tine, report type (window, fixed start, or fixed stop), durations and/or offset times, STK object paths, the report type as define on the DefineSTK Time Report Form, and report start/stop time definition type (maintain report start/stop time offsets from schedule start/stop times or not when schedule start/stop times are changed), report duration type as using the next line in the report (TRUE) or explicitly defining the fixed duration (FALSE). The number of TR_STKREPORT_DEF keywords in the report equals the number of defined STK reports (See TR_SINTLEINST_STKREPORTS above). |
| TR_SINGLEINST_PERIODIC_DEFS | TR_SINGLEINST_PERIODIC_DEFS {number of periodic definitions} | The TR_SINGLEINST_PERIODIC_DEFS keyword precedes the number of periodic definitions that are used to define the scheduling windows of a single instance task as defined on the Scheduling Tab. |
| TR_SINGLEINST_PERIOD | TR_SINGLEINST_PERIOD {frequency} {periodic start time/date} {epoch (custom frequency only)} {interval (custom frequency only} {periodic stop time/date} '{periodic comments}' {number of inner windows} | The TR_SINGLEINST_PERIOD keyword precedes parameters that define a period window definition that is used to describe scheduling windows of a single instance task. The parameters include the periodic frequency, periodic start time, periodic stop time, epoch (custom frequency only), interval (custom frequency only), user-defined comments, and the number of inner windows as defined on the Scheduling Tab of the Task Definition Form. The number of TR_SINGLEINST_PERIOD keywords in the report equal the number of periodic report definitions. (See TR_SINGLEINST_PERIODIC_DEFS above.) |
| TR_INNER_WINDOW_DEF | TR_INNER_WINDOW_DEF {inner window start time} {inner window duration} '{period comment}' | The TR_INNER_WINDOW_DEF keyword precedes parameters that define the inner windows of a period window definition that is used to describe the scheduling windows of a single instance task. The parameters include the inner window start time, inner window duration, and user-defined comments as defined on the Scheduling Tab of the Task Definition Form. The number of TR_INNER_WINDOW_DEF keywords in the report equals the number of inner windows. (See TR_SINGLEINST_PERIOD above). |
| TR_RECURRING_DISCRETE_WINDOWS | TR_RECURRING_DISCRETE_WINDOWS {number of windows} | The TR_RECURRING_DISCRETE_WINDOWS keyword precedes the number of recurring windows that are used to define the scheduling times for a recurring instance task as defined on the Scheduling Tab of the Task Definition Form. |
| TR_WINDOW_DEF | TR_WINDOW_DEF {window start time/date} {window stop time/date} '{window comments}' | The TR_WINDOW_DEF keyword precedes parameters that define a discrete window used to describe the scheduling windows of the task. The parameters include the window start time, window stop time, and window comments as defined on the Scheduling Tab of the Task Definition Form. The number of TR_WINDOW_DEF keywords in the report equals the number of recurring windows (See TR_RECURRING_DISCRETE_WINDOWS above). |
| TR_RECURRING_STKREPORTS | TR_RECURRING_STKREPORTS {number of reports} | The TR_RECURRING_STKREPORTS keyword precedes the number of STK reports that are used to define the scheduling windows of a period task as defined on the Scheduling Tab of the Task Definition Form. |
| TR_STKREPORT_DEF | TR_STKREPORT_DEF {report start time/date} {report stop time/date} {WINDOW/FIXEDSTART/FIXEDSTOP} {start offset time or duration} {duration or end offset time} '{STK object 1 path}' '{STK object 2 path}' '{report type}' '{maintain offset times (YES or NO)}' '{use next time value in report (TRUE or FALSE)}' | The TR_STKREPORT_DEF keyword precedes parameters that define a STK report that is used to describe the scheduling windows for the task. The parameters include the report start time, report stop time, report type (window, fixed start, or fixed stop), durations and/or offset times, STK object paths, the report type as defined on the Define STK Time Report Form, and report start/stop time definition type (maintain report start/stop time offsets from schedule start/stop times or not when schedule start/stop times are changed), report duration type as using the next line in the report (TRUE) or explicitly defining the fixed duration (FALSE). The number of TR_STKREPORT_DEF keywords in the report equals the number of define STK reports (See TR_RECURRING_STKREPORTS above). |
| TR_RECURRING_PERIODIC_DEFS | TR_RECURRING_PERIODIC_DEFS {number of periodic definitions} | The TR_RECURRING_PERIODIC_DEFS keyword precedes the number of periodic definitions that are used to define the scheduling windows of a recurring task as defined on the Scheduling Tab on the Task Definition Form. |
| TR_RECURRING_PERIOD | TR_RECURRING_PERIOD {frequency} {period start time/date} {epoch (custom frequency only)} {interval (custom frequency only)} {periodic stop time/date} {RepeatType - PERPERIOD/PERWINDOW} {repeats per period} {Priority Delta} '{periodic comments}' {number of inner windows} | The TR_RECURRING_PERIOD keyword precedes parameters that define a period window definition that is used to describe scheduling windows of a recurring task. The parameters include the periodic frequency, periodic start time, periodic stop time, epoch (custom only), interval (custom only), perwindow or perperiod option, number of repeats per period/window, priority delta value, user defined comments, and the number of inner windows as defined on the Scheduling Tab of the Task Definition Form. The number of TR_RECURRING_PERIOD keywords in the report equals the number of periodic report definitions (See TR_RECURRING_PERIODIC_DEFS above). |
| TR_INNER_WINDOW_DEF | TR_INNER_WINDOW_DEF {inner window start time} {inner window duration} '{periodic comments}' | The TR_INNER_WINDOW_DEF keyword precedes parameters that define the inner windows of a period window definition that is used to describe the scheduling windows of a recurring task. The parameters include the inner window start time, inner window duration, and user-defined comments as define on the Scheduling Tab of the Task Definition Form. The number of TR_INNER_WINDOW_DEF keywords in the report equals the number of inner windows (See TR_RECURRING_PERIOD above). |
| TR_DURATION_VALUES | TR_DURATION_VALUES {duration type - variable/fixed/full_timeslot} {multiple segments allowed} {resource changes between segments} {overlap required} {fixed duration} {minimum total duration} {maximum total duration} {minimum segment duration} {max overlap duration} {overlap duration required} | The TR_DURATION_VALUES keyword precedes the parameters that define the type of duration specified on the Duration Tab of the Task Definition Form. |
| TR_RESOURCE_FORMULA | TR_RESOURCE_FORMULA {number of possibilities} '{resource constraint formula}' | The TR_RESOURCE_FORMULA keyword precedes a True or False Boolean value that defines if the task uses the common setup time feature as referenced on the Resource Usage Tab of the Task Definition Form. |
| TR_USE_COMMON_SETUP_TIME | TR_USE_COMMON_SETUP_TIME {TRUE/FALSE} | The TR_USE_COMMON_SETUP_TIME keyword precedes a True or False Boolean value that defines if the task uses the common setup time feature as referenced on the Resource Usage Tab of the Task Definition Form. |
| TR_POSSIBILITY | TR_POSSIBILITY {priority value} '{list of resources}' {number of resources} {number of STK reports} {number of timeslots} | The TR_POSSIBILITY keyword precedes parameters that define one of a task's possibilities as defined on the Timeslots Definitions Tab of the Task Definition Form. The parameters include the possibility priority value, list of resources that are included in the possibility (comma delimited), the number of resources in the possibility, the number of STK reports used to define the possibility's timeslot(s), and the number of timeslots. |
| TR_RES_USAGE | TR_RES_USAGE '{resource name}' {setup duration} {breakdown duration} {capacity usage - NA/DEPLETE/REPLENISH/SETENDVALUE} {capacity change method - NA/FIXED/RATE} {capacity amount} {rate time - seconds/NA} {accommodation applicable - YES/NO} {animation - NA/OBJECTLINE/SENSORON/NONE} {cost amount} {cost rate - PERASSIGNMENT/PERSECOND} {cost setup applied- YES/NO} {cost breakdown applied - YES/NO} {usable setup modes indices - 'comma delimited list in single quotes'} {usable body modes indices - 'comma delimited list in single quotes'} {usable breakdown modes indices - 'comma delimited list in single quotes'} {resource range min constraint applied - YES/NO} {resource range min value} {resource range max constraint applied - YES/NO} {resource range max value} {duration override type} {duration override value - integer/NA} | The TR_RES_USAGE keyword precedes a number of parameters that defines how a resource is used as defined on the Resource Usage Tab of the Task Definition Form. The parameters include resource setup time, the name of the resource, capacity usage, capacity change method, capacity amount, rate time, capacity intervals, accommodation applicability, and animation setting. A separate TR_RES_USAGE keyword for each resource will appear after each task possibility (See TR_RESOURCE_FORMULA above). |
| TR_FILE_IMPORT_DEF | TR_FILE_IMPORT_DEF '{filepath/name}' | The TR_FILE_IMPORT_DEF keyword precedes a time window filename (including directory path) applied for calculating timeslots for the possibility via the File Import Form accessed through the File Import button on the Timeslots Definition Form. The number of TR_FILE_IMPORT_DEF keywords under each possibility equals the number of files applied to that possibility. |
| TR_STKREPORT_DEF | TR_STKREPORT_DEF {report start time/date} {report stop time/date} {WINDOW/FIXEDSTART/FIXEDSTOP/VALUERANGE} {start offset time or duration} {duration or end offset time} '{STK object 1 path}' '{STK object 2 path}' '{report type}' '{maintain offset times (YES or NO)}' '{use next time value in report (TRUE or FALSE)} {number of repeats}' | The TR_STKREPORT_DEF keyword precedes parameters that define a STK report that is used to describe the scheduling windows for the task. The parameters include the report start time, report stop time, report type (window, fixed start, or fixed stop), durations and/or offset times, STK object paths, the report type as defined on the Define STK Time Report Form, and report start/stop time definition type (maintain report start/stop time offsets from schedule start/stop times or not when schedule start/stop times are changed), report duration type as using the next line in the report (TRUE) or explicitly defining the fixed duration (FALSE). The number of TR_STKREPORT_DEF keywords in the report equals the number of defined STK reports (See TR_POSSIBILITY above). |
| TR_TIMESLOT | TR_TIMESLOT {timeslot start time/date} {timeslot stop time/date} {timeslot preferred start time/date} {timeslot desirability} '{user comments}' | The TR_TIMESLOT keyword precedes a set of parameters that describes the attributes of a task's timeslot as defined on the Timeslot Definition Tab of the Task Definition Form. The parameters include the timeslot start time/date, timeslot stop time/date, desirability, and comments. The number of TR_TIMESLOT keywords equals the number of timeslots for each possibility (See TR_POSSIBILITY above). |
| TR_TOTAL_TIMESLOT_DURATION | TR_TOTAL_TIMESLOT_DURATION {total timeslot duration} {total timeslot duration excluding overlaps} | The TR_TOTAL_TIMESLOT_DURATION keyword provides 2 values. The first value is the summation of all of the timeslot durations. The second value is the summation of all the timeslot durations excluding any overlaps. |
| TR_ANCHOR_TYPE | TR_ANCHOR_TYPE {NA} {Start} {End} | The TR_ANCHOR_TYPE keyword precedes parameters that describe the task's anchoring constraint requirements. |
| TR_DEPENDENCIES | TR_DEPENDENCIES {nOf during constraints} {total during constraints} {nOf predecessor constraints} {total predecessor constraints} | The TR_DEPENDENCIES keyword precedes parameters that describe the task's dependency constraint requirements. |
| TR_DEPENDENCY | TR_DEPENDENCY '{task name}' {dependency type} {minTimeAfter} {minAfterType} {maxTimeAfter} {maxAfterType} | The TR_DEPENDENCY keyword precedes an individual task dependency constraint definition as defined on the Dependency Tab of the Task Definition Form.
The types are:
|
| TR_NOTES | TR_NOTES '{text of note}' | The TR_NOTES keyword precedes text of the note contained in the note text as defined on the Notes Tab of the Task Definition Form. |
| TR_HIDDEN | TR_HIDDEN {YES/NO} | The TR_HIDDEN keyword precedes a YES/NO term. YES indicates that the task is hidden (not displayed) on the Scheduler main Gantt view. NO indicates that the task is displayed normally on the Gantt view. |
| TR_ASSIGNMENTS | TR_ASSIGNMENTS {number of assignments} {total assigned duration} {total cost of task assignments} | The TR_ASSIGNMENTS keyword precedes the total number of assignments that the task has as defined on the Status Tab of the Task Definition Form, as well as the total assigned task duration (sum of individual assignment durations if more than one assignment has been made) and the total cost of resources used by the task. |
| TR_ASSIGNMENT | TR_ASSIGNMENT {assignment id} {assignment start date/time} {assignment stop date/time} {assignment duration} '{assigned resources}' {cost of task assignment} {is bonused} {common setup start time or NA} {notes} | The TR_ASSIGNMENT keyword precedes a number of parameters that describes the task assignment as defined on the Status Tab of the Task Definition Form. The parameters include the assignment id, assignment start date and time, assignment stop date and time, the duration of the assignment, list of comma delimited resources that are assigned, the cost of the assignment, and if the assignment was bonused. The number of TR_ASSIGNMENT keywords is equal to the number of task assignments (See TR_ASSIGNMENTS above). |
| TR_CHILD_ASSIGNMENTS | TR_CHILD_ASSIGNMENTS {number of assignments} {total assigned duration including overlap times} {total assigned duration excluding overlaps per child task} {total assigned duration excluding overlaps over all child tasks} {total cost of all child task assignments} |
The TR_CHILD_ASSIGNMENTS keyword provides 5 values. The values are:
|
| TR_CHILD_ASSIGNMENT | TR_CHILD_ASSIGNMENT {assignment id} {assignment start date/time} {assignment stop date/time} {assignment duration} '{assigned resources}' {cost of child task assignment} {is bonused} | The TR_CHILD_ASSIGNMENT keyword precedes a number of parameters that describes a child task assignment. The parameters include the assignment id, assignment start date and time, assignment stop date and time, the duration of the assignment, list of comma delimited resources that are assigned, and if the assignment is bonused for the task child assignment. The number of TR_CHILD_ASSIGNMENT keywords is equal to the number of child task assignments (See TR_CHILD_ASSIGNMENTS above). |
| TR_TOTAL_CHILD_TIMESLOT_DURATION | TR_TOTAL_CHILD_TIMESLOT_DURATION {total child timeslot duration including overlap} {total child timeslot duration excluding overlaps per child task} {total child timeslot duration excluding overlaps over all child tasks} |
The TR_TOTAL_CHILD_TIMESLOT_DURATION keyword provides 3 values if the task of interest is a recurring parent definition. The values are:
|
| TR_ASSIGNED_VS_AVAILABLE_RATIO | TR_ASSIGNED_VS_AVAILABLE_RATIO {ratio for all duration time} {ratio for all duration times excluding overlaps within each child task} {ratio for all duration times excluding overlaps over all child tasks.} |
The TR_ASSIGNED_VS_AVAILABLE_RATIO keyword provides the ratio of the total assigned duration over the total available duration excluding any overlaps. For a single instance task, only the second value (no overlap per child) is provided. For a recurring parent task definition, 3 ratios are provided. The ratios are:
|
| TR_VIOLATION | TR_VIOLATION {violation message} | The TR_VIOLATION keyword precedes text that describes the source of a violation, should one occur. |
| TR_VIOLATION_RES_AVAILABILITY | TR_VIOLATION_RES_AVAILABILITY {violation message} | The TR_VIOLATION_RES_AVAILABILITY keyword precedes text that describes the source of a violation where a task's assignment resource is utilized outside of availability times, should one occur. |
| TR_SATELLITE_ORBIT_OPTIONS | TR_SATELLITE_ORBIT_OPTIONS {OrbitLineColor} {UsesOrbitLineColor [True/False]} {OrbitLineWidth} {UseOrbitLineWidth [True/False]} {DisplayTaskName [True/False]} {DisplayTaskStartTime [True/False]} {DisplayTaskStopTime [True/False]} {ObjectLine} |
The TR_SATELLITE_ORBIT_OPTIONS keyword precedes a number of parameters that describe how satellite orbit are displayed in STK and what annotations should go with them. These values are found on the Task STK Tab. These values are:
|
Print Button
The print button prints an ASCII version of the report to the Windows default printer.
Save Button
The save button opens the Save As.. form allowing you to specify a file name and a location for an ASCII version of the report to be saved.
Close Button
The close button closes the form.
JSON Report
The task report can also be returned in a JSON format via the API. Each key is described below.
Task JSON Report
Report Details
The report details section contains a set of keys with their associated data for each task included in the report.
| Keyword | Format | Description |
|---|---|---|
| task_name | String | The task name defined on the Task Definition Form. |
| description | String | The description given to the task on the Task Definition Form. |
| allow_bonusing | Boolean | The value that describes if the task can be bonused, or allow its assignments to bonus other tasks who also have this value set to true. |
| bonused_tasks | Array of Strings | The tasks that were bonused due to this task's assignments. |
| is_deferred | Boolean | The value that describes whether or not the task is currently deferred as define on the Task Definition Form. |
| is_locked | Boolean | The value that describes whether or not the task is currently locked as defined on the Task Definition Form. |
| priority | Integer | The priority given to the task on the General Tab of the Task Definition Form. |
| scheduling_preference | String | The scheduling preference of the task as defined on the General Tab of the Task Definition Form. |
| scheduling_preference_exact_time | String | The exact time scheduling preference of the task (if applicable) as defined on the General Tab of the Task Definition Form. |
| timeslot_preference | String | The timeslot preference of the task as defined on the General Tab of the Task Definition Form. This refers to the relation of the scheduled time and where it falls within a timeslot. |
| groups | Integer | The number of task groups that the task is included in as defined on the General Tab of the Task Definition Form. |
| group_names | Array of Strings | The groups in which the task is included in as defined on the General Tab of the Task Definition form. |
| task_type_info -> type | String | The type of task (single instance, recurring). |
| task_type_info -> template_parent_task | String | The name of the task's parent template (if applicable). |
| task_type_info -> recurring_parent_task | String | The name of the task's recurring parent (if applicable). |
| fom_info -> fom_total | Float | The task's FOM score, which is a sum of components, each component being scaled by a weight set on the FOM Properties Tab of the Schedule Properties form. |
| fom_info -> fom_assigned | Float | The Assign component of the task's FOM score, unscaled by the corresponding FOM weight. |
| fom_info -> fom_dur | Float | The Dur component of the task's FOM score, unscaled by the corresponding FOM weight. |
| fom_info -> fom_pp | Float | The PP component of the task's FOM score, unscaled by the corresponding FOM weight. |
| fom_info -> fom_pn | Float | The PN component of the task's FOM score, unscaled by the corresponding FOM weight. |
| fom_info -> fom_early | Float | The Early component of the task's FOM score, unscaled by the corresponding FOM weight. |
| fom_info -> fom_max_dur | Float | The MaxDur component of the task's FOM score, unscaled by the corresponding FOM weight. |
| fom_info -> fom_pt | Float | The PT component of the task's FOM score, unscaled by the corresponding FOM weight. |
| fom_info -> fom_cost | Float | The COST component of the task's FOM score, unscaled by the corresponding FOM weight. |
| recurring_type | String | Whether the task is recurring |
| apply_recurr_dur_extension | Boolean | Whether the recurring children tasks will have their timeslots extended by a certain value as define by on the Scheduling Tab of the Task Definition Form. |
| recurring_constraint_report -> min_after_type | String | If applicable, how the minimum time between instance of this task configured on the Scheduling Tab of the Task Definition Form. |
| recurring_constraint_report -> max_after_type | String | If applicable, how the maximum time between instance of this task configured on the Scheduling Tab of the Task Definition Form. |
| single_instance_discrete_windows | Integer | The number of discrete windows that are used to define the scheduling times for a single instance task as defined on the Scheduling Tab of the Task Definition Form. |
| discrete_window_list | Array | The discrete windows used to describe the scheduling windows of the task. |
| single_instance_stk_reports | Integer | The number of STK Report windows that are used to define the scheduling times for a single instance task as defined on the Scheduling Tab of the Task Definition Form. |
| stk_report_list | Array | The STK Report windows used to describe the scheduling windows of the task. |
| single_instance_periodic_windows | Integer | The number of periodic windows that are used to define the scheduling times for a single instance task as defined on the Scheduling Tab of the Task Definition Form. |
| periodic_window_list | Array | The periodic windows used to describe the scheduling windows of the task. |
| recurring_discrete_windows | Integer | The number of discrete windows that are used to define the scheduling times for a recurring task as defined on the Scheduling Tab of the Task Definition Form. |
| recurring_discrete_window_list | Array | The discrete windows used to describe the scheduling windows of the task. |
| recurring_stk_reports | Integer | The number of STK Report windows that are used to define the scheduling times for a recurring task as defined on the Scheduling Tab of the Task Definition Form. |
| recurring_stk_report_list | Array | The STK Report windows used to describe the scheduling windows of the task. |
| recurring_periodic_windows | Integer | The number of periodic windows that are used to define the scheduling times for a recurring task as defined on the Scheduling Tab of the Task Definition Form. |
| recurring_periodic_window_list | Array | The periodic windows used to describe the scheduling windows of the task. |
| duration_info -> is_variable | Boolean | Whether the task duration is variable as defined on the Duration Tab of the Task Definition Form. |
| duration_info -> is_full_timeslot | Boolean | Whether the task requires the full timeslot as defined on the Duration Tab of the Task Definition Form. Only for variable duration tasks |
| duration_info -> allow_multiple_segments | Boolean | Whether the task can be split into multiple segments as defined on the Duration Tab of the Task Definition Form. Only for variable duration tasks |
| duration_info -> allow_resource_changes | Boolean | Whether a task split into segments may use different sets of resources for the different segments as defined on the Duration Tab of the Task Definition Form. Only for variable duration tasks that allow segments |
| duration_info -> require_overlap | Boolean | Whether a task split into segments must have overlaps of a certain duration between segments as defined on the Duration Tab of the Task Definition Form. Only for variable duration tasks that allow segments |
| duration_info -> is_max_unlimited | Boolean | Whether a task's max duration is unlimited as defined on the Duration Tab of the Task Definition Form. Only for variable duration tasks |
| duration_info -> fixed_duration | String | The task's fixed duration as defined on the Duration Tab of the Task Definition Form. Only for fixed duration tasks |
| duration_info -> min_total_duration | String | The task's minimum duration as defined on the Duration Tab of the Task Definition Form. Only for variable duration tasks |
| duration_info -> max_total_duration | String | The task's maximum duration as defined on the Duration Tab of the Task Definition Form. Only for variable duration tasks |
| duration_info -> min_segment_duration | String | The minimum task segment duration as defined on the Duration Tab of the Task Definition Form. Only for variable duration tasks that allow segments |
| duration_info -> max_overlap_duration | String | The maximum time task segments must overlap as defined on the Duration Tab of the Task Definition Form. Only for variable duration tasks that allow segments |
| duration_info -> overlap_duration | String | The time task segments must overlap as defined on the Duration Tab of the Task Definition Form. Only for variable duration tasks that allow segments |
| apply_start_no_later_than | Boolean | Whether the task must apply start time no later than a specified value |
| start_no_later_than | String | The time that the task must start no later than |
| number_of_possibilities | Integer | The number of resource possibilities the task has |
| resource_constraint_formula | String | The resource formula for the task. |
| use_common_setup_time | Boolean | The value that defines if the task uses the common setup time feature as referenced on the Resource Usage Tab of the Task Definition Form. |
| is_template_parent | Boolean | Whether the task is a template parent |
| possibility_report_list -> resource_capacities_string | String | The list of resources that are included in the possibility (comma delimited) |
| possibility_report_list -> priority | Integer | The priority of the possibility |
| possibility_report_list -> number_of_resources | Integer | The number of resources in the possibility |
| possibility_report_list -> number_of_stk_reports | Integer | The number of STK reports used by the possibility |
| possibility_report_list -> number_of_timeslots | Integer | The number of timeslots that exist for the possibility |
| possibility_report_list -> resource_usage_list -> name | String | The name of the resource used in the possibility |
| possibility_report_list -> resource_usage_list -> setup_duration | String | The setup time for the resource used in the possibility |
| possibility_report_list -> resource_usage_list -> breakdown_duration | String | The breakdown time for the resource used in the possibility |
| possibility_report_list -> resource_usage_list -> capacity_type | String | The type of capacity applicable to the resource used in the possibility |
| possibility_report_list -> resource_usage_list -> is_accommodation_applicable | Boolean | Whether this possibility would use up accommodation for the resource |
| possibility_report_list -> resource_usage_list -> animation_type | String | The type of animation used for visualizing this possibility |
| possibility_report_list -> resource_usage_list -> cost | Float | The cost of the possibility |
| possibility_report_list -> resource_usage_list -> cost_type | String | How the cost applies. Options are PerSecond or PerAssignment. |
| possibility_report_list -> resource_usage_list -> cost_setup_applied | Boolean | Whether cost applies during setup time for this possibility |
| possibility_report_list -> resource_usage_list -> cost_breakdown_applied | Boolean | Whether cost applies during breakdown time for this possibility |
| possibility_report_list -> resource_usage_list -> usable_setup_mode_indices | Array | The setup mode indices that are usable |
| possibility_report_list -> resource_usage_list -> usable_body_mode_indices | Array | The body mode indices that are usable |
| possibility_report_list -> resource_usage_list -> usable_breakdown_mode_indices | Array | The breakdown mode indices that are usable |
| possibility_report_list -> resource_usage_list -> resource_range_min_constraint_applied | Boolean | Whether the resource range minimum constraint applies for the possibility |
| possibility_report_list -> resource_usage_list -> resource_range_min_value | Integer | The resource range minimum constraint value for the possibility |
| possibility_report_list -> resource_usage_list -> resource_range_max_constraint_applied | Boolean | Whether the resource range maximum constraint applies for the possibility |
| possibility_report_list -> resource_usage_list -> resource_range_max_value | Integer | The resource range maximum constraint value for the possibility |
| possibility_report_list -> resource_usage_list -> duration_override_type | String | The type of optional task duration override. Options are None, FixedDur, or EfficiencyFactor. Override Fixed Value is the fixed duration in seconds that will override the defined task duration if used in an assignment. Override Efficiency Value is the efficiency factor that is used as the denominator when overriding the task duration if used in an assignment (Override Duration = Task Defined Fixed Duration / Efficiency Factor). |
| possibility_report_list -> resource_usage_list -> duration_override_fixed | String | The fixed duration in seconds that will override the defined task duration if used in an assignment for this possibility. |
| possibility_report_list -> resource_usage_list -> duration_override_efficiency_factor | String | The efficiency factor that is used as the denominator when overriding the task duration if used in an assignment for this possibility (Override Duration = Task Defined Fixed Duration / Efficiency Factor). |
| possibility_report_list -> stk_report_def_list -> stk_report_name | String | The STK Report Name used for defining this possibility |
| possibility_report_list -> stk_report_def_list -> start_time | String | The start time for the STK Report used for defining this possibility |
| possibility_report_list -> stk_report_def_list -> end_time | String | The end time for the STK Report used for defining this possibility |
| possibility_report_list -> stk_report_def_list -> window_type | String | The window type for the STK Report used for defining this possibility |
| possibility_report_list -> stk_report_def_list -> start_offset_value | Float | The offset from the STK Report start time used for defining this possibility |
| possibility_report_list -> stk_report_def_list -> stop_offset_value | Float | The offset from the STK Report stop time used for defining this possibility |
| possibility_report_list -> stk_report_def_list -> map_object_1_name | String | The STK object path used for object 1 in the STK Report used for defining this possibility |
| possibility_report_list -> stk_report_def_list -> map_object_2_name | String | The STK object path used for object 2 in the STK Report used for defining this possibility |
| possibility_report_list -> stk_report_def_list -> is_auto_update | Boolean | Whether the STK Report window auto updates when the schedule period updates. |
| possibility_report_list -> stk_report_def_list -> stk_report_type | String | The STK report type used for this possibility |
| possibility_report_list -> time_file_list | Array | The time window filename applied for calculating timeslots for the possibility |
| possibility_report_list -> explicit_times_list | Array | Additional restricted time windows configured on the possibility |
| possibility_report_list -> timeslot_list | Array | The timeslots that were created for this possibility |
| possibility_report_list -> resource_usages_string | String | The list of resources that are included in the possibility (comma delimited) |
| total_ts_duration | String | The summation of all of the timeslot durations. |
| total_ts_duration_excluding_overlap | String | The summation of all of the timeslot durations excluding any overlaps. |
| anchor_type | String | The value that describe the task's anchoring constraint requirements. |
| predecessor_dependency_reports_list | Array | The list of task predecessors that are options of tasks that must be scheduled before this task |
| during_dependency_reports_list | Array | The list of options of tasks that must be scheduled during this task |
| dependency_info -> n_of_during_constraints | Integer | The number of tasks from the during task list that must be scheduled during this task |
| dependency_info -> total_during_constraints | Integer | The total number of during constraints on this task |
| dependency_info -> n_of_predecessor_constraints | Integer | The number of tasks from the predecessor task list that must be scheduled before this task |
| dependency_info -> total_predecessor_constraints | Integer | The total number of predecessor constraints on this task |
| notes | String | The notes contained in the note text as defined on the Notes Tab of the Task Definition Form. |
| is_visible | Boolean | Whether the task is visible or not. False indicates that the task is hidden (not displayed) on the Scheduler main Gantt view. True indicates that the task is displayed normally on the Gantt view. |
| operational_status | String | The operational status of this task |
| plugin_info | String | Any applicable plugin data for the task |
| total_assignments | Integer | The total number of assignments that the task has as defined on the Assignment Tab of the Task Definition Form |
| assignments_list | Array of Objects | List of assignments scheduled for this task |
| assignments_list -> start_time | String | The start date/time of the assignment |
| assignments_list -> stop_time | String | The stop date/time of the assignment |
| assignments_list -> duration | String | The duration of the assignment |
| assignments_list -> assigned_resources | String | The resources used by the assignment |
| assignments_list -> cost | Float | The cost of the assignment |
| assignments_list -> is_bonused | Boolean | Whether the assignment is bonused with another assignment |
| assignments_list -> common_setup_start_time | String | The common assignment start date/time with applicable setup times |
| assignments_list -> notes | String | Any notes on the assignment |
| assignments_list -> plugin_assignment_info | Array | Any applicable Scheduler Online plugin data for the assignment |
| assignments_list -> id | Integer | The ID for the assignment |
| assignments_list -> profile_id | Integer | The profile ID for the assignment |
| total_duration | String |
The total duration of all assignments for this task |
| total_cost | Float | The total cost of this task |
| proc_cmds_list | Array |
The list of procedures and commands configured on this task |
| assigned_vs_available_ratio | Float |
The ratio of the total assigned duration over the total available duration excluding any overlaps. |
| satellite_orbit_options -> orbit_line_color | String | The 9 digit RGB color of the task's satellite orbit for visualization |
| satellite_orbit_options -> uses_orbit_line_color | Boolean | Whether to use the configured satellite orbit line color |
| satellite_orbit_options -> orbit_line_width | Float | The task's satellite orbit line width for visualization |
| satellite_orbit_options -> use_orbit_line_width | Boolean | Whether to use the configured satellite orbit line width |
| satellite_orbit_options -> display_task_name | Boolean | Whether to display the task name for visualization |
| satellite_orbit_options -> display_task_start_time | Boolean | Whether to display the task start time for visualization |
| satellite_orbit_options -> display_task_stop_time | Boolean | Whether to display the task stop time for visualization |
| satellite_orbit_options -> object_line_color | String |
The 9 digit RGB color of the object line for visualization |
