Schema Entities¶

Entity: RAM_Act_Template_Operation (Data)¶

Links an operation to an activity template.

Entity: RAM_Act_Template_Usage_Period (Data)¶

Defines the expected usage against this activity template of the specified class and between the specified dates.

Entity: RAM_Act_Type_Custom_Metric (Data)¶

This defines the value activities of an activity type have against a custom metric.

Entity: RAM_Activity_Class (Lookup)¶

Defines the class of an activity. Maps to Activity_Class in Scheduling Schema.

Entity: RAM_Activity_Template (Data)¶

Defines a template used to create regular visit activities, such as planned maintenance work.

Entity: RAM_Activity_Type (Data)¶

Defines a type used to group activities together that share scheduling specific information.

Entity: RAM_Activity_Type_App_Template (Data)¶

Used to link an activity type to an appointment template for use in the Scheduling Workbench appointment booking client.

Entity: RAM_Activity_Type_Category (Data)¶

Represents the association between an activity type and a category.

Entity: RAM_Activity_Type_Part (Data)¶

Defines the part information for an activity type.

Entity: RAM_Activity_Type_Skill (Data)¶

Defines the required skills for an activity type.

Entity: RAM_Activity_Type_Tool (Data)¶

Defines required tools for an activity type.

Entity: RAM_Alert_Level (Lookup)¶

Determines the level of alert for the various levels within a capacity requirement

Entity: RAM_Appointment_Template (Data)¶

Defines a template of slots to consider when requesting appointments. Maps to Appointment_Template in Scheduling Schema.

Entity: RAM_Appointment_Template_Item (Data)¶

Defines a slot within an appointment template.

Entity: RAM_Appt_Template_Slot_Usage (Data)¶

Used to associate an Appointment_Template to either one or multiple slot usage rule sets.

Entity: RAM_Attribute (Data)¶

A user defined attribute that can be linked to a resource, division or project.

Entity: RAM_Attribute_Allowed_Value (Data)¶

Defines a list of allowed values for attributes with the data type DOMAIN.

Entity: RAM_Attribute_Type (Lookup)¶

A lookup table of allowed attribute types.

Entity: RAM_Attribute_Value (Data)¶

Links an attribute to a resource, project or division.

Entity: RAM_Calendar (Data)¶

Defines a calendar which can be applied to the SLAs of an activity. The slopes on the SLA will only apply during active calendar periods. Links to Calendar in the Scheduling Schema.

Entity: RAM_Calendar_Item (Data)¶

Defines the general pattern of active periods for the calendar.

Entity: RAM_Capacity (Data)¶

Defines the parts capacity that can be carried by a resource. It consists of an overall maximum volume that can be carried, a default maximum part quantity, and individual capacities for particular parts.

Entity: RAM_Capacity_Part (Data)¶

This defines an override for the maximum quantity of stock that can be carried for a particular part. If the maximum quantity is null then there is no maximum. If exclusivity required is set to true then the resource must carry only this part for this capacity requirement.

Entity: RAM_Categorisation (Data)¶

Represents a high-level grouping or classification of categories, serving as a parent entity for organising them into meaningful groups. This can be used for filtering or grouping resources and activities in the Scheduling Workbench, or for defining rules that can restrict how the categories can be scheduled in parallel with each other.

Entity: RAM_Category (Data)¶

Defines specific items or entities within a categorisation. Activities and resources can belong to up to one category per categorisation.

Entity: RAM_Category_Custom_Metric (Data)¶

Defines the value a custom metric has for activities belonging to a particular category.

Entity: RAM_Comment (Data)¶

Defines a comment against any row in the database.

Entity: RAM_Contract (Data)¶

Defines a contract that can be used for display purposes on the Scheduling Workbench, and is also used in the Schedule Archive reporting table.

Entity: RAM_Counters (System)¶

Used for encryption.

Entity: RAM_Custom_Metric (Data)¶

This defines a custom metric that can be specified against activities.

Entity: RAM_Customer (Data)¶

Defines a customer that can be used for display purposes on the Scheduling Workbench, and is also used in the Schedule Archive reporting table.

Entity: RAM_Data_Request (System)¶

Logs any requests for RAM data to be brought through to the scheduling system.

Entity: RAM_Data_Type (Lookup)¶

Defines allowed types of data: [STRING, INTEGER, DOUBLE, DATETIME, TIMESPAN, BOOLEAN, MESSAGE_TEXT, DOMAIN, TIME, URL]

Entity: RAM_Data_Update (Data)¶

Used to update a particular value of the database, or delete rows.

Entity: RAM_Dataset (Data)¶

Defines a dataset that contains data within the RAM.

Entity: RAM_Dataset_Type (Lookup)¶

Used to describe the type and purpose of a dataset (e.g. for modelling).

Entity: RAM_Depot_Transfer_Settings (Data)¶

Defines settings to be used for transferring a part from a parent depot to a child depot, and whether the transfer rules should be used for all parts at the parent depot or not. A template need not be provided here, as part transfer settings could be used to define rules for specific parts, overriding any rules defined here that apply to all parts. The parent and child depots are not defined here (or anywhere in the ARP).

Entity: RAM_Distance_Penalty (Data)¶

The travel penalties that relate to a particular travel cost model. See 'Travel Cost Model' in the Scheduling Schema for details.

Entity: RAM_Distance_Penalty_Type (Lookup)¶

Lists the different types of travel penalty that can be applied.

Entity: RAM_Division (Data)¶

A division within which shifts need to be planned. Divisions are defined as a tree structure.

Entity: RAM_Division_Requirement (Data)¶

A requirement for resources to work within a particular division.

Entity: RAM_Division_Type (Data)¶

Pre-defined types of divisions.

Entity: RAM_Exception (Data)¶

An exception generated when validating a rota.

Entity: RAM_Exception_Parameter (Data)¶

A parameter to be used within an exception message.

Entity: RAM_External_Task_Data (System)¶

Data being used by an external task.

Entity: RAM_Fuel_Type (Data)¶

Defines the type of fuel used in the vehicle.

Entity: RAM_Icon (Data)¶

An icon to be used when displaying data in the application. This can currently be linked to resource types and activity types.

Entity: RAM_Icon_Type (Lookup)¶

A lookup table of icon types.

Entity: RAM_Location (Data)¶

A location for a resource or activity.

Entity: RAM_Location_Division (Data)¶

Used to specify a location as being within a division.

Entity: RAM_Location_Type (Data)¶

Type information for a location.

Entity: RAM_Membership_Category (Data)¶

When a resource is planned into the rota they are given a rota membership period for the entire time they have been planned. Membership categories allow these membership periods to be separated into different time categories. For example if a resource is expected to stay at a particular location for a period of time, working a number of shifts while stationed there, then this can be reflected in the membership category.

As a more specific example, suppose that resources are working on an oil rig. They stay on the rig for 14 days, working 12 hour shifts every day during this time. They then have a further period of 14 days back on land where they are not working. In this example, a membership category of 'Offshore' can be used for the first 14 days to signify that the resource is on the rig for this entire period.

Membership categories can be given a colour which will appear as a background colour when shifts are planned for the resource. They can also be linked to rules and requirements.

Entity: RAM_Modelling_Pattern (Data)¶

Defines a modelling pattern to use when planning cyclic work. See Scheduling Schema for details.

Entity: RAM_Object_Group (Data)¶

Specify that a group has permission to see a resource, resource type, or a location.

Entity: RAM_Operation (Data)¶

Defines an operation that can be linked to an activity template. See 'Operation' in the Scheduling Schema for details.

Entity: RAM_Operation_Hierarchy (Data)¶

This allows operations to be placed in a hierarchy. In such cases, whenever a parent operation is carried out, the child operation will also be taken to have been carried out.

Entity: RAM_Operation_Ordering (Data)¶

This allows a specific ordering of operations to be defined when multiple operations are carried out within a visit.

Entity: RAM_Operation_Skill (Data)¶

Used to set a skill requirement for a particular operation.

Entity: RAM_Part (Data)¶

A part that can be used by a resource to carry out activities.

Entity: RAM_Part_Stock (Data)¶

Defines the amount of stock for parts to be carried by resources or resource types. This can be used to specify parts against a resource or resource type which can be time dependent. If no available_datetime is specified then the part is assumed to be available to the resource or resource type from the start of the schedule, otherwise the part is only available from the specified time. The override_existing states whether this part is in addition to any parts currently held by the resource or resource type (set to false), or whether it replaces any existing parts (set to true). The stock level can be set to recur using recurrence_interval and day_pattern. See examples below.

Example¶

As an example, take the following xml:

<RAM_Part_Stock>
    <id>1</id>
    <ram_part_id>KEYBOARD</ram_part_id>
    <ram_resource_id>RES1</ram_resource_id>
    <stock>5</stock>
    <override_existing>true</override_existing>
</RAM_Part_Stock>
<RAM_Part_Stock>
    <id>2</id>
    <ram_part_id>KEYBOARD</ram_part_id>
    <ram_resource_id>RES1</ram_resource_id>
    <stock>2</stock>
    <available_datetime>2010-10-13T08:00:00</available_datetime>
    <override_existing>false</override_existing>
</RAM_Part_Stock>
<RAM_Part_Stock>
    <id>3</id>
    <ram_part_id>KEYBOARD</ram_part_id>
    <ram_resource_id>RES1</ram_resource_id>
    <stock>6</stock>
    <available_datetime>2010-10-15T08:00:00</available_datetime>
    <override_existing>true</override_existing>
</RAM_Part_Stock>

This would mean that the resource has 5 KEYBOARD parts at the start of the schedule today, picks up an extra two on Wednesday (regardless of how many he has used at this point), and then starts Friday with 6 KEYBOARD parts (again regardless of how many he has used up to this point). So if he were to carry out activities on Tuesday and Thursday which required 3 KEYBOARDs each, his stock levels at the end of each day would be :-

Monday 5 (initial stock)
Tuesday 2 (used 3)
Wednesday 4 (2 added)
Thursday 1 (used 3)
Friday 6 (reset to 6)

To demonstrate stock recurrence, consider the following xml:

<RAM_Part_Stock>
    <id>1</id>
    <ram_part_id>KEYBOARD</ram_part_id>
    <ram_resource_id>RES1</ram_resource_id>
    <stock>5</stock>
    <available_datetime>2014-03-10T08:00:00</available_datetime>
    <override_existing>true</override_existing>
    <recurrence_interval>P3D</recurrence_interval>
    <day_pattern>YYYYYNN</day_pattern>
</RAM_Part_Stock>

The resource's part stock would start on 5 on 10th March (Monday), and would be reset to 5 again on 13th March (Thursday), but not on 16th March as this is a Saturday, which is disallowed by the day pattern. The stock would then continue to be reset from 19th March (Wednesday).

Entity: RAM_Part_Transfer_Settings (Data)¶

Defines the transfer rules to use for a specific part, providing the template to use and the depot transfer settings it applies to.

Entity: RAM_Pending_Unavailability (Data)¶

Used when creating unavailabilities on the resource planner screen. This table cannot be updated externally.

Entity: RAM_Pending_Update (Data)¶

Used for changes made to data maintenance tables from within the resource planner, before applying changes. This table cannot be updated externally.

Entity: RAM_Position (Data)¶

Positions can be used for two purposes in the ARP.

Firstly, they can be used as a label for resources, which can then be searched against within the resource planner. This search will also use the position hierarchy, so for example when searching for the position 'Engineer', any resources in the parent position 'Senior Engineer' would also be shown.

Secondly, requirements can be created using positions, which will then require resources to be explicitly planned into a particular position (unlike role requirements where matches are calculated automatically). Note that it is not necessary for a resource to have a particular position assigned to them in order to be planned into that position. However, if a role is linked to the position, then any resources planned into this position must satisfy the role.

Entity: RAM_Project (Data)¶

Defines known projects that resources are required to work on

Entity: RAM_Project_Group (Data)¶

Allows pre-requisite projects to be defined.

Entity: RAM_Project_Level (Data)¶

Defines an amount of time or number of resources required for a project and an associated alert level.

Entity: RAM_Project_Template (Data)¶

Pre-defined projects from which other projects may be created.

Entity: RAM_Project_Template_Group (Data)¶

Defines pre-requisites between template projects.

Entity: RAM_Project_Template_Level (Data)¶

Defines an amount of time or number of resources required for a project tempate and an associated alert level.

Entity: RAM_Project_Type (Lookup)¶

A lookup table of project types.

Entity: RAM_Request (System)¶

A request for the RPL service to carry out an action.

Entity: RAM_Request_Type (Lookup)¶

Defines the different types of request that can be made.

Entity: RAM_Requirement (Data)¶

Defines a requirement for particular roles and/or posiitons to be filled at certain times.

Entity: RAM_Requirement_Position (Data)¶

The requirements for a particular position within an overall requirement.

Entity: RAM_Requirement_Position_Level (Data)¶

The alert level that should be displayed for a given number of resources.

Entity: RAM_Requirement_Role (Data)¶

A particular role required within an overal requirement.

Entity: RAM_Requirement_Role_Level (Data)¶

A number of resources, and alert level this number represents.

Entity: RAM_Resource (Data)¶

A person or team against which activities can be scheduled.

Entity: RAM_Resource_Capacity (Data)¶

This links a capacity to a resource. It is possible for a resource to have more than one capacity, representing for example different compartments within a van. If no resource capacity is specified the resource is assumed to be capable of carrying any parts.

Entity: RAM_Resource_Category (Data)¶

Represents the association between a resource and a category.

Entity: RAM_Resource_Class (Lookup)¶

The classification of this resource, one of [BUCKET, PARALLEL, PERSON, TEAM].

Entity: RAM_Resource_Division (Data)¶

Used to specify that a resource is within a particular division.

Entity: RAM_Resource_Division_Avail (Data)¶

Used to specify a period of time in which a resource belongs to a particular division.

Entity: RAM_Resource_Pool (Data)¶

Defines a set of resources which may be used to schedule a set of activities linked in a "chain". Activities are linked into a chain using Activity Resource Pool Set. All activities in the chain must be scheduled to resources from a single Resource Pool, although there may be several alternative Resource Pools in the Resource Pool Set. Some Resource Pools may be preferred to others.

Entity: RAM_Resource_Pool_Res_Type (Data)¶

Defines a Resource Type to be a member of a Resource Pool. Many resources types may be in a single resource pool, and a resource type may be in more than one pool.

Entity: RAM_Resource_Pool_Resource (Data)¶

Defines a Resource to be a member of a Resource Pool. Many resources may be in a single resource pool, and a resource may be in more than one pool.

Entity: RAM_Resource_Pool_Set (Data)¶

Defines a number of different groups of resources which may be used to schedule a set of activities linked in a "chain". Activities are linked into a chain using Activity Resource Pool Set. All activities in the chain must be scheduled to resources from a single Resource Pool, although any of the Resource Pools in this set may be chosen.

Entity: RAM_Resource_Pool_Set_Item (Data)¶

An item within a resource pool set.

Entity: RAM_Resource_Preference (Data)¶

Defines a preference between a resource or resource type and an activity type.

Entity: RAM_Resource_Retention (Data)¶

Defines periods of time where the resource is employed. If a resource has no retention they are considered as always available. Otherwise they are only available during the times specified.

Entity: RAM_Resource_Skill (Data)¶

Used to specify that a resource has a particular skill.

Entity: RAM_Resource_Skill_Availability (Data)¶

Used to specify a period of time that a resource has a particular skill.

Entity: RAM_Resource_Tool (Data)¶

Used to specify that a resource has a particular tool.

Entity: RAM_Resource_Travel_With (Data)¶

Defines periods of time where a resource is travelling with another resource.

Entity: RAM_Resource_Type (Data)¶

Used to specify shared type information for resources.

Entity: RAM_Resource_Type_Capacity (Data)¶

This links a capacity to a resource type. It is possible for a resource type to have more than one capacity, representing for example different compartments within a van. If no resource type capacity is specified the resource type is assumed to be capable of carrying any parts.

Entity: RAM_Resource_Type_Category (Data)¶

Represents the association between a resource type and a category.

Entity: RAM_Resource_Type_Location (Data)¶

Used to link locations to resource types for use with the WISE.

Entity: RAM_Resource_Type_Skill (Data)¶

Used to specify that a resource type has a particular skill.

Entity: RAM_Resource_Type_Transition (Data)¶

These are used to allow the WISE to consider switching resources from one type to another. This could be to a more skilled resource type, or to a resource type with a different shift pattern for example.

Entity: RAM_Response (System)¶

Used when the RPL Service responds to a RAM request.

Entity: RAM_Response_Result (Lookup)¶

The response results that can be included in a RAM_Response record.

Entity: RAM_Role (Data)¶

A role which can be fulfilled by a resource.

Entity: RAM_Role_Skill (Data)¶

A skill required to fulfill this role.

Entity: RAM_Role_Type (Lookup)¶

Defines the type of a role. One of [ALLSKILLS, ANYSKILL].

Entity: RAM_Rota (Data)¶

A mapping of shifts to resources, and people to teams, for a period of time.

Entity: RAM_Rota_Alteration (Data)¶

Notes that the master rota has changed in the periods specified.

Entity: RAM_Rota_Item (Data)¶

A shift to be worked by a resource in a rota.

Entity: RAM_Rota_Item_Break (Data)¶

A break within a shift.

Entity: RAM_Rota_Item_Comment (Data)¶

A comment against a rota item.

Entity: RAM_Rota_Item_Resource_Pool (Data)¶

Resource pool membership accosicated with a given shift.

Entity: RAM_Rota_Membership_Period (Data)¶

Links a resource to a division or team for a period of time within a rota

Entity: RAM_Rota_Requirement_Alert (Data)¶

This highlights where requirements have not been met in the master rota.

Entity: RAM_Rota_Requirement_Match (Data)¶

This shows which resources have been used to match role requirements in the master rota.

Entity: RAM_Rota_Role_Override (Data)¶

A manually assigned role for a resource for a given period of time.

Entity: RAM_Rota_Type (Lookup)¶

The type of a rota. Can be [MASTER, WORKING SET].

Entity: RAM_Rule (Data)¶

A rule to validate rotas against.

Entity: RAM_Rule_Collection (Data)¶

A collection of rules, which can be linked to a resource.

Entity: RAM_Rule_Collection_Rule (Data)¶

Used to include a rule in a rule collection.

Entity: RAM_Rule_Override (Data)¶

Used to override the rules defined in the collection for a particular resource.

Entity: RAM_Rule_Parameter (Data)¶

The value of a parameter for a given rule.

Entity: RAM_Rule_Type (Lookup)¶

Defines the types of rules that can be setup: [BREAK, EXCLUDED_HOURS, REST1, REST2, SHIFT, WORKING_TIME]

Entity: RAM_Rule_Type_Category (Lookup)¶

Defines the category for a particular rule type. One of [COMMIT, PARALLEL, ROTA_VALIDATION, SHIFT_CAPACITY].

Entity: RAM_Rule_Type_Parameter (Lookup)¶

Defines the parameters required for a particular rule type.

Entity: RAM_Secured (System)¶

Used to encrypt data.

Entity: RAM_Separation_Group (Data)¶

Defines a group of activities to which separation rules should apply. The rules are defined in a separation model.

Entity: RAM_Separation_Model (Data)¶

This defines a set of rules for preventing activities from being scheduled too closely together, or too far apart. Activities to which the rules apply must belong to a separation group, which they can be linked to via the separation_group_id attribute on RAM_Activity_Type. Resources are then linked to the separation model via the separation_model_id attribute on either RAM_Resource or RAM_Resource_Type.

The rules themselves are defined via RAM_Separation_Model_Item rows. Each row specifies a separation group from and to, and a minimum and maximum allowed separation (at least one or other should be supplied). Additionally an incentive can be provided. With the default incentive value of -1 the separation will be applied as a hard constraint, so the minimum and maximum must be satisfied. If a positive incentive value is used then the value is added to the plan margin if the separation conditions are satisfied.

In the case of a hard maximum separation constraint, the plan is considered invalid if the gap between an activity in the separation to group and the nearest previously scheduled activity in the separation from group (scheduled to the same resource) exceeds the maximum separation. If there is no such activity then this is valid. If an activity in the separation from group is followed by multiple activities in the separation to group, then only the first of these must obey the maximum separation constraint.

For a soft separation constraint the incentive is applied if the gap between an activity in the separation to group and the nearest previously scheduled activity in the separation from group (scheduled to the same resource) is within both the minimum and maximum separations. If an activity in the separation from group is followed by multiple activities in the separation to group, then the incentive will only be applied to the first of these.

Entity: RAM_Separation_Model_Item (Data)¶

Defines the items that make up a separation model. See `Separation Model' for details.

Entity: RAM_Shift_Category (Data)¶

Defines a category for a shift, which rules can be created against (e.g. unsociable hours, hazardous).

Entity: RAM_Shift_Template (Data)¶

A template for creating rota items.