Resource Reports
The resource report displays information about a selected resource and how it is used in the deconflicted schedule.
The resource report is designed so that it provides information about the definition of one or more resources in such a manner that it may be programmatically parsed using an external application. The report consists of a header section and resource details section.
Resource Reports may be created by selecting Resource -> Report from the Menu Bar, then selecting a resource if one is not already selected.
Resource Reports
Report Header
The header contains information about the schedule in which the resource(s) described in the report appear.
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 each resource included in the report. The following sections detail each keyword.
| Keyword | Format | Description |
|---|---|---|
| RR_RESOURCE_NAME | RR_RESOURCE_NAME '{resource name}' | The RR_RESOURCE_NAME keyword precedes the name given to the resource on Resource Definition Form. The name of the resource will appear contained within single quotation marks. |
| RR_DESCRIPTION | RR_DESCRIPTION '{resource description}' | The RR_DESCRIPTION keyword precedes the description given to the resource on Resource Definition Form. The description of the resource will appear contained within single quotation marks. |
| RR_COST | RR_COST {resource cost} {resource cost application} | The RR_COST keyword precedes the cost in dollars given to the resource and the how the cost is applied on Resource Definition Form. Options for cost application are PerSecond or PerAssignment. |
| RR_PRIORITY | RR_PRIORITY {resource priority value} | The RR_PRIORITY keyword precedes the priority given to the resource on the General Tab of the Resource Definition Form. |
| RR_SETUP_TIME | RR_SETUP_TIME {duration} | The RR_SETUP_TIME keyword has 1 argument value, the minimum setup time. This value precedes the duration of the Minimum Setup Time for the resource as defined on the General Tab of the Resource Definition Form. The duration is reported as the number of seconds to millisecond fidelity. |
| RR_BREAKDOWN_TIME | RR_BREAKDOWN_TIME {duration} | The RR_BREAKDOWN_TIME keyword precedes the duration of the Breakdown Time for the resource as defined on the General Tab of the Resource Definition Form. The duration is reported as the number of seconds to millisecond fidelity. |
| RR_BUFFER_TIME | RR_BUFFER_TIME {duration / NA} | The RR_BUFFER_TIME keyword precedes the duration from the beginning of the schedule to apply the buffer time, as defined on the General Tab of the Resource Definition Form. The duration will appear in this location, if buffer time is enabled for that resource. Otherwise, this keyword will simply show NA. |
| RR_STK_OBJECT | RR_STK_OBJECT '{STK object path}' | The RR_STK_OBJECT keyword precedes the path and filename of the STK object that is associated with the resource as defined on the General Tab of the Resource Definition Form. The path is contained within single quotation marks. The STK object path text string starts with "/" and does not include scenario name |
| RR_GROUPS | RR_GROUPS {number of groups} | The RR_GROUPS keyword precedes the number of resource groups that the resource is included in as defined on the General Tab of the Resource Definition Form. |
| RR_GROUP_NAME | RR_GROUP_NAME '{group name}' | The RR_GROUP_NAME keyword precedes the name of a group in which the resource is included as defined on the General Tab of the Resource Definition Form. The group name is contained within single quotation marks. The number of RR_GROUP_NAME keywords in the report will equal the number of groups the resource is included in. (See RR_GROUPS above). |
| RR_CONSTRAINT_GROUPS | RR_CONSTRAINT_GROUPS {number of groups} | The RR_CONSTRAINT_GROUPS keyword precedes the number of resource constraint groups that the resource is included in as defined on the Resources Required Tab of the Task Definition Form. |
| RR_CONSTRAINT_GROUP_NAME | RR_CONSTRAINT_GROUP_NAME '{group name}' {nOf/All} | The RR_CONSTRAINT_GROUP_NAME keyword precedes the name of a resource constraint group in which the resource is included as defined on the Resources Required Tab of the Task Definition Form. The group name is contained within single quotation marks. Either the nOf number or All will be after the group name. The number of RR_CONSTRAINT_GROUP_NAME keywords in the report will equal the number of resource constraint groups the resource is included in. (See RR_CONSTRAINT_GROUPS above). |
| RR_TEMPLATE_GROUPS | RR_TEMPLATE_GROUPS {number of groups} | The RR_TEMPLATE_GROUPS keyword precedes the number of resource template groups that the resource is included in as defined on the Resources Required Tab of the Task Definition Form. |
| RR_TEMPLATE_GROUP_NAME | RR_TEMPLATE_GROUP_NAME '{group name}' | The RR_TEMPLATE_GROUP_NAME keyword precedes the name of a resource template group in which the resource is included as defined on the Resources Required Tab of the Task Definition Form. The group name is contained within single quotation marks. The number of RR_TEMPLATE_GROUP_NAME keywords in the report will equal the number of resource template groups the resource is included in. (See RR_TEMPLATE_GROUPS above). |
| RR_DEFAULTAVAILABLE | RR_DEFAULTAVAILABLE {YES/NO} | The RR_DEFAULTAVAILABLE keyword precedes a YES or NO term. A YES term indicates that the windows of time defined by the WINDOW_DEF, RR_AVAIL_PERIOD, and INNER_WINDOW_DEF keywords are times when the resource is not available to be tasked. A NO term indicates that the windows are times when the resource is available to be tasked. The term corresponds to the availability option button that is selected on the Availability Tab of the Resource Definition Form. |
| RR_AVAIL_DISCRETE_WINDOWS | RR_AVAIL_DISCRETE_WINDOWS {number of windows} | The RR_AVAIL_DISCRETE_WINDOWS keyword precedes the number of discrete windows that are used to define the resource's availability as defined on the Availability Tab of the Resource Definition Form. |
| RR_WINDOW_DEF | RR_WINDOW_DEF {window start time/date} {window stop time/date} "{window comments}" | The RR_WINDOW_DEF keywords precedes parameters that define a discrete window used to describe the availability of the resource. The parameters include the window start time, window stop time, and window comments as defined on the Availability Tab of the Resource Definition Form. The number of RR_WINDOW_DEF keywords in the report equal the number of discrete windows. (See RR_AVAIL_DISCRETE_WINDOWS above). |
| RR_AVAIL_STKREPORTS | RR_AVAIL_STKREPORTS {number of reports} | The RR_AVAIL_STKREPORTS keyword precedes the number of STK reports that are used to define the resource's availability as defined on the Availability Tab of the Resource Definition Form. |
| RR_STKREPORT_DEF | RR_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 RR_STKREPORT_DEF keyword precedes parameters that define a STK report that is used to describe the availability (or blackout) windows for the resource. 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 RR_STKREPORT_DEF keywords in the report equal the number of defined STK reports (See RR_AVAIL_STKREPORTS above). |
| RR_AVAIL_PERIODIC_DEFS | RR_AVAIL_PERIODIC_DEFS {number of periodic definitions} | The RR_AVAIL_PERIODIC_DEFS keyword precedes the number of periodic definitions that are used to define the resource's availability as defined on the Availability Tab of the Resource Definition Form. |
| RR_AVAIL_PERIOD | RR_AVAIL_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 RR_AVAIL_PERIOD keyword precedes parameters that define a period window definition that is used to describe the availability of the resource. 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 Availability Tab of the Resource Definition Form. The number of RR_AVAIL_PERIOD keywords in the report equal the number of periodic report definitions. (See RR_AVAIL_PERIODIC_DEFS above.) |
| RR_AVAIL_TIMES | RR_AVAIL_TIMES {# availability windows to follow} {availability window list (comma delimited)} | The RR_AVAIL_TIMES keyword precedes the # of availability windows for this resource. The first parameter is the number of windows to follow. The optional second parameter is a comma delimited list of time pairs that represent each availability start and end times. |
| RR_ACCOMMODATION | RR_ACCOMMODATION {accommodation value} | The RR_ACCOMMODATION keyword precedes the accommodation value of the resources defined on the Accommodation Tab of the Resource Definition Form. |
| RR_CAPACITY | RR_CAPACITY {capacity applicable - YES/NO} {RESILIENT/CONSUMABLE/STATEMODES} {minimum capacity limit} {maximum capacity limit} {initial capacity value} {minimum capacity type - HARD/SOFT} {maximum capacity type -HARD/SOFT} '{capacity units}' | The RR_CAPACITY keyword precedes parameters that define the capacity characteristics of the resource. The parameters include the capacity applicability, capacity type, minimum capacity limit, maximum capacity limit, minimum capacity type, maximum capacity type, and user-defined capacity units as defined on the Capacity Tab of the Resource Definition Form. |
| RR_STATE_MODES | RR_STATE_MODES {# defined modes} '{Mode Name List}' | The RR_STATE_MODES keyword precedes parameters that define the defined modes of the resource. The parameters include the number of defined modes followed by a comma delimited list of the mode names. The modes can also be referenced by their zero based index position in the list. |
| RR_STATE_MATRIX | RR_STATE_MATRIX {Matrix List} | The RR_STATE_MATRIX keyword precedes parameters that define the defined buffer matrix of the resource state modes. The parameters is a comma delimited list of the buffer times in seconds to millisecond fidelity. The parameter will be empty if a matrix is not defined, or the state mode matrix is not defined. |
| RR_OVERRIDE_DURATION | RR_OVERRIDE_DURATION {Override Type} {Override Fixed Value} {Override Efficiency Value} | The RR_OVERRIDE_DURATION keyword precedes parameters that define optional task duration override values. Override Type value is an enumeration of either 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). |
| RR_NOTES | RR_NOTES '{text of note}' | The RR_NOTES keyword precedes text of the notes as defined on the Notes Tab of the Resource Definition Form. |
| RR_HIDDEN | RR_HIDDEN {YES/NO} | The RR_HIDDEN keyword precedes a YES/NO term. YES indicates that the resource's availability histogram is hidden (not displayed) on the Scheduler main Gantt view. NO indicates that the resource's availability histogram is displayed normally on the Gantt view. |
| RR_TOTAL_GLOBAL_AVAIL_DURATION | RR_TOTAL_GLOBAL_AVAIL_DURATION {time duration} | The RR_TOTAL_GLOBAL_AVAIL_DURATION keyword precedes the global availability duration of the resource as shown on the Status Tab of the Resource Definition Form. |
| RR_TOTAL_ASSIGNED_SETUP_TIME | RR_TOTAL_ASSIGNED_SETUP_TIME {time duration} | The RR_TOTAL_ASSIGNED_SETUP_TIME keyword precedes the resource's assigned duration that only includes the setup time durations, and excludes all task time durations and excludes all breakdown time durations. |
| RR_TOTAL_ASSIGNED_TASK_TIME | RR_TOTAL_ASSIGNED_TASK_TIME {time duration} | The RR_TOTAL_ASSIGNED_TASK_TIME keyword precedes the resource's assigned duration that only includes the task time durations, and excludes all setup time durations and excludes all breakdown time durations. |
| RR_TOTAL_ASSIGNED_BREAKDOWN_TIME | RR_TOTAL_ASSIGNED_BREAKDOWN_TIME {time duration} | The RR_TOTAL_ASSIGNED_BREAKDOWN_TIME keyword precedes the resource's assigned duration that only includes the breakdown time durations, and excludes all task time durations an excludes all setup time durations. |
| RR_TOTAL_ASSIGNED_TIME | RR_TOTAL_ASSIGNED_TIME {time duration} {total cost} | The RR_TOTAL_ASSIGNED_TIME keyword precedes the resource's assigned duration that includes all setup, task, and breakdown time durations. Additionally includes the total cost value at the end that represents the total cost for all assignments for this resource. |
| RR_DUTY_CYCLE_SETUP | RR_DUTY_CYCLE_SETUP {duty cycle percentage that accounts for resource setup times only and excludes task time durations and excludes resource breakdown time durations}% | The RR_DUTY_CYCLE_SETUP keyword precedes the resource's duty cycle calculated by only including setup time durations. |
| RR_DUTY_CYCLE_TASK | RR_DUTY_CYCLE_TASK {duty cycle percentage that accounts for resource usage during task time durations only, excluding resource setup time durations and excluding resource breakdown time durations}% | The RR_DUTY_CYCLE_TASK keyword precedes the "Duty Cycle Without Setup and Breakdown Times" value as shown on the Status Tab of the Resource Definition Form. |
| RR_DUTY_CYCLE_BREAKDOWN | RR_DUTY_CYCLE_BREAKDOWN {duty cycle percentage that accounts for resource breakdown time durations only and excludes task time durations and excludes resource setup time durations}% | The RR_DUTY_CYCLE_BREAKDOWN keyword precedes the resource's duty cycle calculated by only including breakdown time durations. |
| RR_DUTY_CYCLE_TOTAL | RR_DUTY_CYCLE_TOTAL {duty cycle percentage that accounts for resource setup time durations, task time durations, and resource breakdown time durations}% | The RR_DUTY_CYCLE_TOTAL keyword precedes the "DutyCycle With Setup and Breakdown Times" value as shown on the Status Tab of the Resource Definition Form. |
| RR_SUPPORTED_TASKS | RR_SUPPORTED_TASKS {number of tasks} | The RR_SUPPORTED_TASKS keyword precedes the number of tasks that the resource supports. |
| RR_SUPPORTED_TASK | RR_SUPPORTED_TASK "{task name}" {minimum setup start date/time} {actual setup start date/time} {assigned start date/time} {assigned stop date/time} {breakdown stop date/time} {DEPLETE/REPLENISH/SETENDVALUE/NA} {amount} {rate time - seconds/NA} {accommodation applicable - YES/NO} {cost} '{setup mode, body mode, breakdown mode}' {is bonused} | The RR_SUPPORTED_TASK keyword precedes parameters that describe how the resource is used by the task. The parameters include a task name, setup start date/time, the assignment start date/time, the assignment stop date/time, the breakdown stop date/time, capacity usage, number of units, accommodation applicability, cost as shown on the Status Tab of the Resource Definition Form, and the applied 'setup, body, breakdown' modes (-1 if not applicable), and if the assignment is bonused. The number of RR_SUPPORTED_TASK keywords equals the number of tasks the resource supports (See RR_SUPPORTED_TASKS above). |
| RR_VIOLATION | RR_VIOLATION {violation message} | The RR_VIOLATION keyword precedes text that describes the source of a violation, should one occur. |
Print Button
The print button prints an ASCII form 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 resource report can also be returned in a JSON format via the API. Each key is described below.
Resource JSON Report
Report Details
The report details section contains a set of keys with their associated data for the active schedule.
| Key | Format | Description |
|---|---|---|
| res_name | String | The name of the resource. |
| description | String | The description set on the resource |
|
cost_info -> value |
Integer | The cost in dollars given to the resource and the how the cost is applied on Resource Definition Form. Options for cost application are PerSecond or PerAssignment. |
|
cost_info -> application |
String | How the cost is applied on Resource Definition Form. Options for cost application are PerSecond or PerAssignment. |
| priority | Integer | The priority given to the resource on the General Tab of the Resource Definition Form. |
| setup_time | String | The setup time for the resource as defined on the General Tab of the Resource Definition Form. |
| breakdown_time | String | The breakdown time for the resource as defined on the General Tab of the Resource Definition Form. |
| buffertime_applies | Boolean | Whether buffer time applies to the resource. |
| buffertime_end | String | The date and time for the end of when the buffer time was applied, as defined on the General Tab of the Resource Definition Form. The date and time for the last application of the buffer time will appear in this location, if buffer time is enabled for that resource. |
| stk_object | String | The path of the STK object that is associated with the resource as defined on the General Tab of the Resource Definition Form. |
| group_names | Array of Strings | The resource tags that the resource is included in as defined on the General Tab of the Resource Definition Form. |
| constraint_groups | Array of Strings | The resource constraint groups that the resource is included in. |
| template_group_names | Array of Strings | The resource template groups that the resource is included in. |
| is_default_available | Boolean | Whether the resource is available by default or not as defined on the Availability Tab of the Resource Definition Form. |
| avail_discrete_windows | Integer | The number of discrete windows that are used to define the resource's availability as defined on the Availability Tab of the Resource Definition Form. |
| discrete_window_reports | Array | The discrete windows used to describe the availability (or blackout) of the resource. |
| avail_stk_reports | Integer | The number of STK reports that are used to define the resource's availability as defined on the Availability Tab of the Resource Definition Form. |
| stk_reports | Array | The STK reports used to describe the availability (or blackout) windows for the resource. |
| avail_periodic_def | Integer | The number of periodic definitions that are used to define the resource's availability as defined on the Availability Tab of the Resource Definition Form. |
| periodic_def_reports | Array | The periodic windows used to describe the availability of the resource. |
| avail_time_info | Object | The overall availability times for the resource. |
| is_accommodation_unlimited | Boolean | Whether the resource's max accommodation is unlimited. |
| max_accommodation | Integer | The max accommodation value of the resources defined on the Accommodation Tab of the Resource Definition Form. |
| is_capacity_applicable | Boolean | Whether a capacity applies to the resource |
| capacity_info -> type | String | The type of capacity that applies. Options are CONSUMABLE or RESILIENT |
| capacity_info -> minimum | Integer | The minimum capacity level for the resource |
| capacity_info -> maximum | Integer | The maximum capacity level for the resource |
| capacity_info -> initial | Integer | The initial capacity level for the resource |
| capacity_info -> min_limit_type | String | The type of limit the minimum capacity level is. Options are HARD or SOFT |
| capacity_info -> max_limit_type | String | The type of limit the maximum capacity level is. Options are HARD or SOFT |
| capacity_info -> units | String | The units of the capacity |
| state_mode_info -> num_state_modes | Integer | The number of state modes for the resource |
| state_mode_info -> state_mode_names | Array | The names of state modes for the resource |
| state_matrix | Array | The buffer matrix of the resource state modes. |
| duration_info -> override_type | String | The type of optional task duration override for this possibility. 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). |
| duration_info -> fixed_value | String | The fixed duration in seconds that will override the defined task duration if used in an assignment. |
| duration_info -> efficiency_value | Float | 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). |
| notes | String | The notes as defined on the Notes Tab of the Resource Definition Form. |
| is_visible | Boolean | Whether the resource is visible. False indicates that the resource's availability histogram is hidden (not displayed) on the Scheduler main Gantt view. True indicates that the resource's availability histogram is displayed normally on the Gantt view. |
| total_global_avail_duration | String | The global availability duration of the resource as shown on the Status Tab of the Resource Definition Form. |
| total_assigned_setup_time | String | The resource's assigned duration that only includes the setup time durations, and excludes all task time durations and excludes all breakdown time durations. |
| total_assigned_task_time | String | The resource's assigned duration that only includes the task time durations, and excludes all setup time durations and excludes all breakdown time durations. |
| total_assigned_breakdown_time | String | The resource's assigned duration that only includes the breakdown time durations, and excludes all task time durations an excludes all setup time durations. |
| total_assigned_time | String | The resource's assigned duration that includes all setup, task, and breakdown time durations. Additionally includes the total cost value at the end that represents the total cost for all assignments for this resource. |
| total_cost | Float | The resource's total cost |
| duty_cycle_info -> setup | String | The resource's duty cycle calculated by only including setup time durations. |
| duty_cycle_info -> task | String | The resource's duty cycle calculated with the supported task assignment times without setup/breakdown times. |
| duty_cycle_info -> breakdown | String | The resource's duty cycle calculated by only including breakdown time durations. |
| duty_cycle_info -> total | String | The resource's duty cycle calculated with the supported task assignment times with setup/breakdown times. |
| num_supported_tasks | Integer | The number of tasks that the resource supports. |
| supported_tasks | Object | The tasks the resource supports |
| plugin_info | Array | Any plugin data associated with the resource |
