Data Fields¶
This section lists the data fields that can be used to customise the display of data in columns, tooltips, details and labels on the Scheduling Workbench.
The table and field must be separated by a period and surrounded by curly brackets e.g. {Activity.#label} apart from when they are being used to define list values when the curly brackets must be omitted.
Some child relations are not able to be selected in a field. This is the case for tables with one to many relationships, for example a resource can have multiple skills associated to it via Resource_Region rows. The Workbench can't display these fields as there is no way to determine which value to display.
Scheduling - Activity Data Fields¶
| Table | Field | Description |
|---|---|---|
| Activity | Displays the value in the specified column for the activity row e.g. Activity.id Activity.base_value | |
| #label | Shows the generated label for the activity using the ActivityLabel parameter. The table name is not required. This is useful in for example the ActivityText parameter. If an ActivityPrivateLabel is specified, you can specify the same label in ActivityPrivateText. Do not use #label in ActivityPrivateText. | |
| Activity | #duration | Shows the calculated duration of the activity using the durations on the allocations. |
| Activity | #base_value | Shows the base value of the activity |
| Activity | #type | Displays a label (description if present otherwise id) for the activity type. |
| Activity | #primary_sla_start | Displays the start of the primary SLA. |
| Activity | #primary_sla_end | Displays the end of the primary SLA. |
| Activity | #available | Boolean specifying if the activity is considered available for scheduling. The parameter ActivityAvailabilityLeeway controls the period in which the activity must have availability to be considered available. |
| Allocation | Displays the value in the specified column for the allocation row e.g. Allocation.activity_start Allocation.resource_id | |
| Allocation | #status | Shows the readable representation of the allocations visit status. |
| Resources | Displays the value in the specified column for the resource row e.g. Resources.id Resources.first_name | |
| Resources | #label | Shows the generated label for the resource using the ResourceLabel parameter. |
| Resources | #available | Boolean specifying if the resource is considered available (on shift and not at a private activity). The parameter ResourceAvailabilityLeeWayMinutes controls how close the current time line needs to be to a shift before the resource is considered available |
| Resources | #type | Displays a label (description if present otherwise id) for the resource type. |
| Location | Displays the value in the specified column for the location row e.g. Location.id Location.city | |
| Location | #label | Displays the generated label for the location using the LocationLabel parameter. |
| Additional_Attribute | Displays the activities additional attribute value with the specified label e.g. Additional_Attribute.PhoneNumber The activities additional attribute that has the label set to PhoneNumber. | |
| Activity_Status | Displays the value in the specified column for the latest activity status row for the activity (based on date_time_stamp) e.g. Activity_Status.memo | |
| Contract | Activity.Contract.description | Displays description of the contract the activity relates to. |
Note
The resource row is found using the Allocation.resource_id on the activity's active allocation.
Note
The location row is found using the Activity.location_id column.
Scheduling - Resource Data Fields¶
| Table | Field | Description |
|---|---|---|
| Resources | Displays the value in the specified column for the resource row e.g. Resources.id Resources.first_name | |
| Resources | #label | Shows the generated label for the resource using the ResourceLabel parameter. |
| Resources | #available | Boolean specifying if the resource is considered available (on shift and not at a private activity). The parameter ResourceAvailabilityLeeWayMinutes controls how close the current time line needs to be to a shift before the resource is considered available |
| Resources | #type | Displays a label (description if present otherwise id) for the resource type. |
| Location | Displays the value in the specified column for the location row e.g. Location.id Location.city | |
| Location | #label | Displays the generated label for the location using the LocationLabel parameter. |
| Additional_Attribute | Displays the resources additional attribute value with the specified label e.g. Additional_Attribute.PhoneNumber The resources additional attribute that has the label set to PhoneNumber. |
Note
The location row is found using the Resources.location_id_start column.
Scheduling - Location Data Fields¶
| Table | Field | Description |
|---|---|---|
| Location | Displays the value in the specified column for the location row e.g. Location.id Location.city | |
| Location | #label | Displays the generated label for the location using the LocationLabel parameter. |
Planning - Resource Data Fields¶
| Table | Field | Description |
|---|---|---|
| RAM_Resource | Displays the value in the specified column for the resource row. e.g. RAM_Resource.id RAM_Resource.first_name | |
| RAM_Resource | #label | Shows a label for the resource |
| RAM_Resource | #type | Shows a label for the resource type |
| RAM_Resource | #rota_hours | Shows the number of hours the resource is working in the rota |
| RAM_Resource | #rota_utilisation | Shows the percentage of time the resource is used in the rota |
| RAM_Resource | #proficiency | Shows how proficient the resource is in the matching role or skill |
| RAM_Resource | #skill_availability | Shows the times where the resource has availability for the matching role or skill |
| RAM_Resource | #alert_status | Shows the alert status for the matching role or skill |
| RAM_Resource | #satisfaction | Shows the satisfaction level for the matching role or skill. It is recommended to use the format 'P0' to display this as a percentage. |
| RAM_Resource | #position | Shows a label for the position assigned to the resource |
| RAM_Resource_Type | Displays the value in the specified column for the resource type row | |
| RAM_Location | Displays the value in the specified column for the location | |
| RAM_Attribute | Displays the resources attribute value with the specified id e.g. RAM_Attribute.PhoneNumber The resources attribute that has the ID set to PhoneNumber |
Note
The RAM_Resource_Type row is found using the RAM_Resource.ram_resource_type_id column.
Note
The RAM_Location row is found using the RAM_Resource.ram_location_id_start column.
Planning - Division Data Fields¶
| Table | Field | Description |
|---|---|---|
| RAM_Division | Displays the value in the specified column for the division row | |
| RAM_Division | #label | Shows a label for the division |
| RAM_Division_Type | Displays the value in the specified column for the division type row | |
| RAM_Attribute | Displays the division's attribute value with the specified id e.g. RAM_Attribute.Info The division's attribute value that has the ID set to Info |
Note
The RAM_Division_Type row is found using the RAM_Division.ram_division_type_id column.