Schedule Reports

The schedule report displays information about the active schedule.

The schedule report is designed to provide information about the definition of the active schedule in such a manner that it may be programmatically parsed using an external application. The report consists of a header section and a schedule details section.

A Schedule Report may be created by selecting Schedule -> Report -> Schedule, from the Menu Bar.

Schedule Reports

Report Header

The header contains information about the active schedule.

The header information includes:

  • Schedule name
  • Schedule start date/time
  • Schedule end date/time
  • Duration of scheduling period
  • Algorithm used to de-conflict schedule
  • AutoValidate status (ON/OFF)
  • GraphicsUpdate status (ON/OFF)
  • Length of time it took to de-conflict schedule
  • Figure of Merit score
  • Time the report was generated

Report Details

The report details section contains a set of keywords with their associated data for the active schedule. The following sections detail each keyword.

Keyword Format Description
SR_SCHEDULENAME SR_SCHEDULENAME '{schedule name}' The SR_SCHEDULENAME keyword precedes the schedule name given as shown on Schedule Properties Form. The name of the schedule will appear contained within single quotation marks.
SR_SCHEDULEFILE SR_SCHEDULEFILE '{path of schedule file}' The SR_SCHEDULEFILE keyword precedes the path and file name that the schedule is stored as. The path will appear contained within single quotation marks.
SR_SCHEDULESTATUS SR_SCHEDULESTATUS {schedule status} The SR_SCHEDULESTATUS keyword precedes the validation status of the schedule.

The statuses are:

  • UNVALIDATED: Validation has not run yet, corresponds to a yellow flag
  • VALIDATED: Validation has run and no violations were found, corresponds to the green flag
  • VIOLATION: Validation has run and violations were found, corresponds to the red flag
SR_DESCRIPTION SR_DESCRIPTION '{resource description}' The SR_DESCRIPTION keyword precedes the description given to the schedule on Schedule Properties Form. The description of the schedule will appear contained within single quotation marks.
SR_STARTTIME SR_STARTTIME {start date/time} The SR_STARTTIME keyword precedes the date and time that marks the beginning of the scheduling period as defined on the General Tab of the Schedule Properties Form.
SR_STOPTIME SR_STOPTIME {stop date/time} The SR_STOPTIME keyword precedes the date and time that marks the end of the scheduling period as defined on the General Tab of the Schedule Properties form.
SR_BUFFERTIMES_APPLY SR_BUFFERTIMES_APPLY {TRUE / FALSE} The SR_BUFFERTIMES_APPLY keyword indicates whether or not buffer time is enabled for this schedule. It will show TRUE if enabled, or FALSE if it is disabled.
SR_BUFFERTIMES_USEREALTIME SR_BUFFERTIMES_USEREALTIME {TRUE / FALSE / NA} The SR_BUFFERTIMES_USEREALTIME keyword indicates whether or not the epoch for the buffer time is equivalent to the current real-time, as defined on the General Tab of the Schedule Properties form. If buffer time is not enabled for the schedule this keyword will simply show NA.
SR_BUFFERTIMES_EPOCH SR_BUFFERTIMES_EPOCH {epoch time / NA} The SR_BUFFERTIMES_EPOCH keyword precedes the date and time for the epoch of when the buffer time was applied, as defined on the General Tab of the Schedule Properties form. If buffer time is not enabled for the schedule this keyword will simply show NA.
SR_ALGORITHM SR_ALGORITHM {algorithm name} The SR_ALGORITHM keyword precedes the name of the currently selected algorithm as shown on the Algorithm Tab of the Schedule Properties Form.
SR_ALGORITHM_EXPAND_ENABLED SR_ALGORITHM_EXPAND_ENABLED {TRUE/FALSE} The SR_ALGORITHM_EXPAND_ENABLED keyword indicates whether or not the algorithm expansion option has been enabled on the Algorithm Tab of the Schedule Properties Form.
SR_ALGORITHM_EARLY_EXPAND_ENABLED SR_ALGORITHM_EARLY_EXPAND_ENABLED {TRUE/FALSE} The SR_ALGORITHM_EARLY_EXPAND_ENABLED keyword indicates whether or not the algorithm expansion option to expand tasks earlier than their initially assigned time has been enabled on the Algorithm Tab of the Schedule Properties Form.
SR_ALGORITHM_EXPAND_ASSIGNMENTS_FIRST SR_ALGORITHM_EXPAND_ASSIGNMENTS_FIRST {TRUE/FALSE} The SR_ALGORITHM_EXPAND_ASSIGNMENTS_FIRST keyword indicates whether or not the option to have the algorithms expand task assignments before assigning other tasks has been enabled on the Algorithm Tab of the Schedule Properties Form.
SR_BESTOF SR_BESTOF {bestof value} The SR_BESTOF keyword precedes the integer value of the current bestof value which specifies the number of algorithm runs to complete when either Random or Neural algorithms are selected.
SR_RANDOM_SEED SR_RANDOM_SEED {random seed value / NA} The SR_RANDOM_SEED keyword precedes the current integer value of the random seed which is used when the Random algorithm is selected. If the schedule is not set to use a random seed, NA will show instead.
SR_TASKPRIORITY SR_TASKPRIORITY {task priority convention} {task priority minimum} {task priority maximum} The SR_TASKPRIORITY keyword precedes parameters that describe how priorities are used for tasks as defined on the Task Priority Tab of the Schedule Properties Form. The parameters include the priority convention (LOW - lower number has higher priority, HIGH - higher number has higher priority), task priority minimum value, and task priority maximum value.
SR_RESOURCEPRIORITY SR_RESOURCEPRIORITY {resource priority convention } {resource priority minimum} {resource priority maximum} The SR_RESOURCEPRIORITY keyword precedes parameters that describe how priorities are used for resources as defined on the Resource Priority Tab of the Schedule Propertied Form. The parameters include the priority convention (LOW - lower number has higher priority, HIGH - higher number has higher priority), resource priority minimum value, and resource priority maximum value.
SR_TIMESLOTSCORE SR_TIMESLOTSCORE {timeslot score minimum} {timeslot score maximum} The SR_TIMESLOTSCORE keyword precedes parameters that describe how scoring is used for timeslots as defined on the Timeslot Score Tab of the Schedule Properties Form. The parameters include timeslot score minimum value, and timeslot score maximum value.
SR_FOM SR_FOM {Kassign} {Kdur} {KPP} {KPN} {Kearly} {KmaxDur} {KPT} The SR_FOM keyword precedes the user-defined figure of merit weights as defined on the FOM Properties Tab of the Schedule Properties Form.
SR_FOM_RESULT SR_FOM_RESULT {schedule's total FOM score} {KPT} The SR_FOM_RESULT keyword precedes the schedule's total FOM score, after applying the user-defined FOM weights.
SR_FOM_ASSIGN SR_FOM_ASSIGN {schedule's raw Assign score} The SR_FOM_ASSIGN keyword precedes the schedule's raw Assign score, not multiplied by the corresponding FOM component weight.
SR_FOM_DUR SR_FOM_DUR {schedule's raw Dur score} The SR_FOM_DUR keyword precedes the schedule's raw Dur score, not multiplied by the corresponding FOM component weight.
SR_FOM_PP SR_FOM_PP {schedule's raw PP score} The SR_FOM_PP keyword precedes the schedule's raw PP score, not multiplied by the corresponding FOM component weight.
SR_FOM_PN SR_FOM_PN {schedule's raw PN score} The SR_FOM_PN keyword precedes the schedule's raw PN score, not multiplied by the corresponding FOM component weight.
SR_FOM_EARLY SR_FOM_EARLY {schedule's raw Early score} The SR_FOM_EARLY keyword precedes the schedule's raw Early score, not multiplied by the corresponding FOM component weight.
SR_FOM_MAXDUR SR_FOM_MAXDUR {schedule's raw MaxDur score} The SR_FOM_MAXDUR keyword precedes the schedule's raw MaxDur score, not multiplied by the corresponding FOM component weight.
SR_FOM_PT SR_FOM_PT {schedule's raw PT score} The SR_FOM_PT keyword precedes the schedule's raw PT score, not multiplied by the corresponding FOM component weight.
SR_STKSCENARIO SR_STKSCENARIO '{path of scenario file}' The SR_STKSCENARIO keyword precedes the path and file name where the associated STK scenario file is stored as defined on the STK Properties Tab of the Schedule Propertied Form. The path will appear contained within quotation marks.
SR_STKTIMESTEP SR_STKTIMESTEP {timestep value} The SR_STKTIMESTEP keyword precedes the timestep value used for STK reports, defined on the STK Properties Tab of the Schedule Propertied Form.
SR_NOTES SR_NOTES '{text of note}' The SR_NOTES keyword contains the text of the note as defined on the Notes Tab of the Schedule Properties Form.

Print Button

The print button prints an ASCII form of the report to the Window 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 save.

Close Button

The close button closes the form.

JSON Format

The summary report can also be returned in a JSON format via the API. Each key is described below.

Keyword Format Description
schedule_name String The schedule name as shown on the Schedule Properties Form.
file_path String The full path to the schedule file on the file system.
validation_status String

The validation status of the schedule, the statuses are:

  • UNVALIDATED: Validation has not run yet, corresponds to a yellow flag
  • VALIDATED: Validation has run and no violations were found, corresponds to the green flag
  • VIOLATION: Validation has run and violations were found, corresponds to the red flag
description String The schedule description as shown on the Schedule Properties Form.
start_time String The date and time of the beginning of the scheduling period as defined on the General Tab.
stop_time String The date and time of the end of the scheduling period as defined on the General Tab.
buffertimes_apply Boolean Indicates whether or not buffer time is enabled for this schedule, as defined on the General Tab. It will show TRUE if enabled, or FALSE if it is disabled.
buffertimes_userealtime Boolean Indicates whether or not the epoch for the buffer time is equivalent to the current real-time, as defined on the General Tab. It will show TRUE if using real-time, FALSE if using an epoch time, or NA if buffer time is not enabled.
buffertimes_epoch String The date and time for the epoch of when the buffer time was applied, as defined on the General Tab. If buffer time is not enabled for the schedule this keyword will simply show NA
algorithm String The name of the currently selected algorithm as shown on the Algorithm Tab.
algorithm_expand_enabled Boolean Indicates whether or not the algorithm expansion option has been enabled on the Algorithm Tab.
algorithm_early_expand_enabled Boolean Indicates whether or not the algorithm expansion option to expand tasks earlier than their initially assigned time has been enabled on the Algorithm Tab.
algorithm_expand_assignments_first Boolean Indicates whether or not the algorithm expansion option to expand task assignments before assigning other tasks has been enabled on the Algorithm Tab.
best_of Integer The current bestof value which specifies the number of algorithm runs to complete when either Random or Neural algorithms are selected.
random_seed String Current integer value of the random seed which is used when the Random algorithm is selected, or NA if no random seed is selected.
task_priority/convention String Task priority convention (LOW - lower number has higher priority, HIGH - higher number has higher priority) as defined on the Task Priority Tab.
task_priority/minimum Integer Task priority minimum value, as defined on the Task Priority Tab.
task_priority/maximum Integer Task priority maximum value, as defined on the Task Priority Tab.
resource_priority/convention String Resource priority convention (LOW - lower number has higher priority, HIGH - higher number has higher priority) as defined on the Resource Priority Tab.
resource_priority/minimum Integer Resource priority minimum value, as defined on the Resource Priority Tab.
resource_priority/maximum Integer Resource priority maximum value, as defined on the Resource Priority Tab.
timeslot_score/minimum Integer Timeslot score minimum value, as defined on the Timeslot Score Tab.
timeslot_score/maximum Integer Timeslot score maximum value, as defined on the Timeslot Score Tab.
fom_constants/Kassign Integer User-defined figure of merit weight for Kassign, as defined on the FOM Properties Tab.
fom_constants/Kdur Integer User-defined figure of merit weight for Kdur, as defined on the FOM Properties Tab.
fom_constants/KPP Integer User-defined figure of merit weight for KPP, as defined on the FOM Properties Tab.
fom_constants/KPN Integer User-defined figure of merit weight for KPN, as defined on the FOM Properties Tab.
fom_constants/Kearly Integer User-defined figure of merit weight for Kearly, as defined on the FOM Properties Tab.
fom_constants/Kmax_dur Integer User-defined figure of merit weight for Kmax_dur, as defined on the FOM Properties Tab.
fom_constants/KPT Integer User-defined figure of merit weight for KPT, as defined on the FOM Properties Tab.
fom_result/result Integer The total Figure of Merit score.
fom_result/assign Integer The schedule's raw Assign score, not multiplied by the corresponding FOM component weight.
fom_result/dur Integer The schedule's raw Dur score, not multiplied by the corresponding FOM component weight.
fom_result/PP Integer The schedule's raw PP score, not multiplied by the corresponding FOM component weight.
fom_result/PN Integer The schedule's raw PN score, not multiplied by the corresponding FOM component weight.
fom_result/early Integer The schedule's raw Early score, not multiplied by the corresponding FOM component weight.
fom_result/max_dur Integer The schedule's raw MaxDur score, not multiplied by the corresponding FOM component weight.
fom_result/PT Integer The schedule's raw PT score, not multiplied by the corresponding FOM component weight.
stk_scenario String The path and file name where the associated STK scenario file is stored, as defined on the STK Properties Tab.
stk_timestep Integer The timestep value used for STK reports, defined on the STK Properties Tab.
notes String Text from the notes section, as defined on the Notes Tab.