{{shiftType}}" } |
| --- |
## Roster/RpiEngine/
### BatchSize
#### Definition
Setting to specify how many days should be batched at a time as the engine runs.
#### Usage
This App setting accepts a numeric value and represents how many days in advance should be batched to cycle through, generating Roster Position Instances to match Pattern and Segment configurations. Limit this value if the environment is seeing significant performance issues and the engine is failing due to timeout, to limit the number of days batched.
#### Default Value
| 50 |
| --- |
### OutOfScopeRpiBehaviour
#### Definition
Setting to specify how the RPI Engine handles when RPI's need to be changed based on an event such as the position or allocation changing.
#### Usage
This App setting is used in Power Automate to determine how the RPIs needs to be changed when a position or allocation is updated. Accepted values are Deactivate, Delete, Do Nothing.
Note: This App setting is used in the following Power Automates.
- *Rostering IP - (Child) - RPI Generation Engine*
#### Default Value
| Deactivate |
| --- |
### UpdatedPatternRpiBehaviour
#### Definition
Setting to specify how the RPI Engine handles when RPI's need to be updated and it detects if we have manually edited RPI's in the pattern.
#### Usage
This App setting is used in Power Automate to determine how the RPIs are updated when a manual edit is detected in the Pattern. Accepted values are Override, Do Nothing.
Affects: Activity Type, From & To fields.
Note: This App setting is used in the following Power Automates.
- *Rostering IP - (Child) - RPI Generation Engine*
#### Default Value
| Do Nothing |
| --- |
## Roster/SegmentsTimeline/ (Deprecated as of v8.1)
### Config (Deprecated as of v8.1)
#### Definition
The Segment Timeline grouping and row data represented as JavaScript Functions. Read by the Segment Timeline PCF Control.
#### Usage
Configure the row and grouping function to have the segment timeline represent the data as desired for the Environment or given Roster via Roster Settings / App Setting Options.
#### Default Value
| { "content": "(segment) => { console.log( segment.vel_startdate.toLocaleDateString('en-AU')); return '
' + segment.vel_resourceid?.RecordName ?? '' + '
' + segment.vel_startdate.toLocaleDateString('en-AU') + (segment.maxDate ? ' - ' + segment.maxDate.toLocaleDateString('en-AU') : '') + '
'}", "groups": [ "(segment) => !segment.vel_resourceid ? { id: 'Unallocated', content: 'Unallocated' } : { id: segment.vel_rosterpositionid.RecordId, content: segment.vel_rosterpositionid.RecordName }", "(segment) => ({ id: (segment.vel_resourceid?.RecordId ?? '') + segment.vel_rosterpositionallocationid.RecordId, content: segment.vel_rosterpositionallocationid.RecordName })" ], "groupOrder": [ "(a, b) => a.content === 'Unallocated' ? -1 : b.content === 'Unallocated' ? 1 : (a.content).localeCompare(b.content)" ], "name": "Unallocated at the top" } |
| --- |
### CustomCss (Deprecated as of v8.1)
#### Definition
Configure the style of the Segment Timeline Control by updating the Custom CSS App Setting.
#### Usage
Update the App Setting to have a unique CSS Rule set to change the style of the Segment Timeline, to suit the environments look, feel, and branding.
#### Default Value
Note: The default value is a complete CSS File, not included in this documentation.
## Roster/ShiftLens/ (Introduced in v8.3)
### AvailabilityTrigger (Introduced in v8.3)
#### Definition
Configures the automatic initiation and cancellation of ShiftLens shift replacement processing for Availability records classified as Unavailable. This JSON setting defines which Availability Types and Statuses trigger processing.
#### Usage
The setting is evaluated when an Unavailable Availability record is created or its Availability Status is updated.
Configure the following JSON properties:
- isEnabled: Set to true to enable processing or false to disable it.
- typePolicy.mode: Set to "include" to restrict processing to the Availability Types listed in availabilityTypes. If typePolicy is omitted, all Unavailable Availability Types are eligible.
- typePolicy.availabilityTypes: Names of the Availability Types to include.
- statusPolicy.triggerStatuses: Availability Status names that create a ShiftLens shift replacement record with a status of Proceed, provided no record already exists for that Availability that is neither Completed nor Cancelled.
- statusPolicy.cancelStatuses: Availability Status names that mark related ShiftLens records as Cancelled, excluding records already Completed or Cancelled.
- statusPolicy.unmatchedStatusBehaviour: Set to "ignore" to take no action when the Availability Status does not match either list.
Type and status names are matched case-insensitively. Use names configured in your environment and avoid placing the same status in both lists, as trigger statuses take precedence..
**Example**
| { "isEnabled": false, "typePolicy": { "mode": "include", "availabilityTypes": [ "ShiftLens - Leave", ] }, "statusPolicy": { "mode": "configured", "triggerStatuses": [ "In Review", "Approved", ], "cancelStatuses": [ "Draft", "Cancelled" ], "unmatchedStatusBehaviour": "ignore" } } |
| --- |
In this example, approved Annual Leave or Sick Leave initiates ShiftLens processing. Changing the Availability Status to Cancelled cancels any related ShiftLens records that are still in progress.
Processing does not run when the setting is missing or empty, isEnabled is false, or statusPolicy is omitted. Disabling the setting does not cancel existing ShiftLens records.
#### Default Value
| { "isEnabled": false, "typePolicy": { "mode": "include", "availabilityTypes": [ "ShiftLens - Leave", ] }, "statusPolicy": { "mode": "configured", "triggerStatuses": [ "In Review", "Approved", ], "cancelStatuses": [ "Draft", "Cancelled" ], "unmatchedStatusBehaviour": "ignore" } } |
| --- |
### FailureNotificationEmail (Introduced in v8.3)
#### Definition
Email address that receives a notification whenever the ShiftLens agent encounters a failure at any point during its execution process.
#### Usage
Enter a single monitored email address (typically a support mailbox or on‑call distribution list) that should be alerted when the ShiftLens agent fails. The agent uses this address as the recipient for its failure notification email so that operational issues — such as retrieval errors, policy lookup failures, or unhandled exceptions during summary generation — are surfaced to the responsible team for investigation.
It is recommended to point this at a shared inbox rather than an individual, to avoid missed alerts when staff are on leave.
#### Default Value
| failure-notifications@example.com |
| --- |
### SharePointLeavePolicy (Introduced in v8.3)
#### Definition
SharePoint document library location where the organisation's leave policy documents are stored. The ShiftLens agent reads from this location to retrieve policy content used when generating summaries for the leave types a user is applying for.
#### Usage
Enter the URL of the SharePoint document library (or folder within a library) that contains the leave policy documents the agent should consult. When a user initiates a leave request, the agent uses this path to locate the relevant policy document(s) for the selected leave type(s) and produce a plain‑language summary of the applicable policy terms.
Notes:
- The path must point to a location the agent's service principal / connection has read access to.
- Documents should be organised so that the agent can match them to leave types (for example, by consistent file naming or a folder‑per‑leave‑type structure).
- Only supported document formats readable by the agent (e.g. .docx, .pdf) will be used for summary generation.
#### Default Value
| https://tenant-name.sharepoint.com/sites/site-name/Shared%20Documents/LeavePolicy.pdf |
| --- |
## Roster/TimelinePCF/
### Config
#### Definition
Controls how the Timeline PCF interprets and renders row data. This setting is a JavaScript configuration object that can include functions for:
- Rendering each timeline item (segment) into HTML/content
- Grouping items into hierarchical rows
- Ordering groups and items
- Applying custom CSS styling that the timeline will inject/use
This is the primary “shape and presentation” contract between Dataverse segment data and the Timeline PCF UI.
#### Usage
Use this setting when you need to change how segments are displayed or grouped for your environment, customer, or roster context. Common use cases:
- Change what text appears on each segment card (resource, dates, shift type, status, etc.)
- Group rows differently (by Position, Persona, Resource, Allocation, Location, etc.)
- Adjust ordering to keep the timeline deterministic and easy to scan (for example, Unallocated first, alphabetical otherwise)
- Apply custom styling aligned to your UI standards (Fluent-like look, weekend styling, severity colours, etc.)
- Override the configuration per roster via Roster Settings / App Setting Options when different rosters need different grouping behaviour
#### Default Value
```css
{
collapsed: false,
render: (segment) => ({
entity: {
name: "vel_rosterpositionallocationsegment",
id: segment.entityid,
},
content:
"
" +
(segment[
"_vel_resourceid_value@OData.Community.Display.V1.FormattedValue"
] ?? "Unallocated") +
"
" +
segment["startdate@OData.Community.Display.V1.FormattedValue"] +
(segment.maxDate
? " - " + new Date(segment.enddate).toLocaleDateString("en-AU")
: "") +
"
",
}),
name: "Segments",
groups: [
(segment) => {
if (!segment["_vel_resourceid_value"]) {
return {
id: "Unallocated",
content: "Unallocated",
};
}
return {
id: segment["_vel_rosterpositionid_value"],
content:
segment[
"_vel_rosterpositionid_value@OData.Community.Display.V1.FormattedValue"
],
};
},
(segment) => ({
id:
(segment["_vel_resourceid_value"] ?? "") +
segment["_vel_rosterpositionallocationid_value"],
content:
segment[
"_vel_rosterpositionallocationid_value@OData.Community.Display.V1.FormattedValue"
],
}),
],
groupOrder: [
(a, b) =>
a.content === "Unallocated"
? -1
: b.content === "Unallocated"
? 1
: a.content.localeCompare(b.content),
],
css: `
/* Custom styles for vis.js Timeline by Velrada
https://visjs.github.io/vis-timeline/docs/timeline/#Styles
With simulated Fluent UI styling:
https://developer.microsoft.com/en-us/fluentui#/
*/
:root {
--system-ui: system-ui, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif,
'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol';
--dyn-symbol: 'Dyn CRM Symbol';
--box-shadow: rgba(0, 0, 0, 0.12) 0px 0px 2px, rgba(0, 0, 0, 0.14) 0px 2px 4px;
}
/* Timeline */
.vis-timeline {
border: 1px solid transparent;
border-radius: 4px;
border-color: #eee;
box-shadow: none;
}
.vis-panel.vis-bottom,
.vis-panel.vis-center,
.vis-panel.vis-left,
.vis-panel.vis-right,
.vis-panel.vis-top {
border: 1px #ddd;
}
.vis-panel.vis-center,
.vis-panel.vis-top {
border-left-style: none;
}
.vis-item .vis-item-content {
padding: 5px;
font-size: 0.9rem;
}
.vis-time-axis .vis-grid.vis-odd,
.vis-time-axis .vis-grid.vis-even {
background-color: #fff;
}
.vis-time-axis .vis-grid.vis-major {
border-color: #eee;
}
.vis-time-axis .vis-grid.vis-minor {
border-color: #f4f4f4;
}
.vis-background .vis-group:nth-of-type(even),
.vis-foreground .vis-group:nth-of-type(even) {
background-color: rgb(128, 128, 128, 0.05);
}
.vis-current-time {
background-color: inherit;
pointer-events: none;
width: 3px;
z-index: 1;
position: relative;
top: 45px !important;
box-shadow: var(--box-shadow);
}
.vis-current-time::before {
content: '';
display: block;
width: 11px;
height: 11px;
background-color: inherit;
border-radius: 50%;
position: absolute;
top: 0;
left: -4px;
box-shadow: var(--box-shadow);
}
/* left column */
.vis-labelset {
min-width: 12rem;
}
.vis-labelset .vis-label {
border-color: transparent;
font-size: 13px;
}
.vis-label.vis-nested-group.vis-group-level-1,
.vis-label.vis-nested-group.vis-group-level-2,
.vis-label.vis-nested-group.vis-group-level-3 {
background-color: #fff;
border-right: 1px solid #ddd;
display: flex;
flex-direction: row;
align-items: center;
}
.vis-label.vis-nested-group.vis-group-level-2 {
background-color: #fff !important;
}
.vis-label.vis-nesting-group.vis-nested-group.vis-group-level-1 {
background-color: #fff !important;
border-right-color: #fff !important;
}
.vis-label.vis-nesting-group.vis-nested-group.vis-group-level-2 {
background-color: #fff !important;
border-bottom-color: #fff !important;
}
.vis-labelset .vis-label {
border-bottom: 1px solid #fff !important;
}
.vis-panel.vis-bottom,
.vis-panel.vis-center,
.vis-panel.vis-top {
border-left-style: none;
border-right-style: none;
}
.vis-ltr .vis-label.vis-nested-group.vis-group-level-1 .vis-inner,
.vis-ltr .vis-label.vis-nested-group.vis-group-level-2 .vis-inner,
.vis-ltr .vis-label.vis-nested-group.vis-group-level-3 .vis-inner {
padding-left: 8px;
margin-left: 8px;
}
.vis-ltr .vis-label.vis-nested-group.vis-group-level-1.expanded .vis-inner,
.vis-ltr .vis-label.vis-nested-group.vis-group-level-2.expanded .vis-inner,
.vis-ltr .vis-label.vis-nested-group.vis-group-level-3.expanded .vis-inner {
padding-left: 0;
}
.vis-ltr .vis-label.vis-nested-group.vis-group-level-1.collapsed .vis-inner,
.vis-ltr .vis-label.vis-nested-group.vis-group-level-2.collapsed .vis-inner,
.vis-ltr .vis-label.vis-nested-group.vis-group-level-3.collapsed .vis-inner {
padding-left: 0;
}
.vis-ltr
.vis-labelset
.vis-label.vis-nested-group.vis-group-level-1
.vis-inner {
margin-top: 4px;
margin-left: 2px;
padding-left: 4px;
padding-top: 2px;
font-weight: 600;
}
.vis-ltr .vis-label.vis-nested-group.vis-group-level-1 .vis-inner:hover {
background-color: #f0f0f0;
border-radius: 3px;
transition: 0.5s;
}
/* alternating column backgrounds */
.vis-time-axis .vis-grid.vis-odd {
background: #f5f5f5;
}
/* gray background in weekends, white text color */
.vis-time-axis .vis-grid.vis-saturday,
.vis-time-axis .vis-grid.vis-sunday {
background: #eee;
}
.vis-time-axis .vis-text {
color: #333;
padding: 3px;
font-size: 0.9rem;
}
/* vis-background */
.vis-item.vis-background {
background-color: rgb(153, 51, 153, 0.15);
color: #333;
}
/* END vis-background */
/* vis-box */
.vis-item.vis-box {
background-color: rgb(0, 121, 200, 0.1);
border-color: rgb(2, 89, 146, 0.25);
color: #333;
padding: 5px 18px;
box-shadow: var(--box-shadow);
}
.vis-item.vis-box:hover {
background-color: rgb(2, 89, 146, 0.1);
transition: 0.5s;
cursor: pointer;
box-shadow: none;
}
.vis-item.vis-box .vis-item-content {
padding: 0;
}
.vis-item.vis-box.vis-selected {
background-color: #ffe5e5;
border-color: #ebacac;
z-index: 2;
}
.vis-item.vis-box.vis-selected::before {
background-color: #ebacac;
}
/* END vis-box */
/* vis-dot */
.vis-item.vis-dot {
border-color: inherit;
border-width: 8px;
border-radius: 8px;
box-shadow: var(--box-shadow);
}
.vis-item.vis-dot:hover {
border-color: inherit;
box-shadow: none;
transition: 0.5s;
}
/* END vis-dot */
/* vis-point */
.vis-item.vis-point {
background-color: inherit;
border-color: inherit;
color: #333;
position: relative;
padding: 5px 18px;
}
/* END vis-point */
/* vis-range */
.vis-item.vis-range {
background-color: rgb(153, 51, 153, 0.1);
border-color: rgb(105, 36, 105, 0.25);
color: #333;
/* position: relative; */
padding: 0 8px;
box-shadow: none;
}
.vis-item.vis-range:hover {
background-color: rgb(180, 45, 180, 0.1);
box-shadow: var(--box-shadow);
transition: 0.5s;
cursor: pointer;
}
.vis-item.vis-range.vis-selected {
background-color: rgb(153, 51, 153, 1);
border-color: rgb(105, 36, 105, 1);
color: #fff;
transition: 0.5s;
}
.vis-item.vis-range.vis-selected:hover {
background-color: rgb(105, 36, 105, 1);
border-color: rgb(105, 36, 105, 1);
color: #fff;
}
/* END vis-range */
/* 1_basic */
.vis-labelset {
min-width: 1rem;
}
.vis-time-axis .vis-grid.vis-odd,
.vis-time-axis .vis-grid.vis-even {
background-color: #fff;
}
.vis-time-axis .vis-grid.vis-major {
border-color: #ccc;
}
.vis-time-axis .vis-grid.vis-minor {
border-color: #eee;
}
#visualization .vis-current-time {
top: 0px !important;
}
/* END 1_basic */
/* 2_grouped */
.vis-foreground .vis-group:empty {
background-color: #fff;
border-bottom-color: #ddd;
}
.vis-group.red .vis-item {
color: #333;
background-color: rgb(164, 32, 32, 0.1);
border-color: rgb(73, 13, 13, 0.2);
}
.vis-group.red .vis-dot {
background-color: rgb(164, 32, 32, 1);
}
.vis-group.black .vis-item {
color: #333;
background-color: rgb(51, 51, 51, 0.1);
border-color: rgb(51, 51, 51, 0.2);
}
.vis-group.black .vis-dot {
color: #333;
background-color: rgb(51, 51, 51, 1);
}
.vis-group.green .vis-item {
color: #333;
background-color: rgb(122, 164, 32, 0.1);
border-color: rgb(122, 164, 32, 0.2);
}
.vis-group.green .vis-dot {
background-color: rgb(122, 164, 32, 1);
}
.vis-group.teal .vis-item {
color: #333;
background-color: rgb(0, 90, 81, 0.1);
border-color: rgb(0, 90, 81, 0.2);
}
.vis-group.teal .vis-dot {
background-color: rgb(132, 171, 167);
}
.vis-group.gold .vis-item {
color: #333;
background-color: rgba(173, 150, 0, 0.1);
border-color: rgb(173, 150, 0, 0.2);
}
.vis-group.gold .vis-dot {
background-color: rgb(173, 150, 0);
}
.vis-item::before {
content: none;
display: none !important;
}
/* END 2_grouped */
`
}
```
### Datasources
#### Definition
Defines the set of data sources the Timeline PCF loads and combines to produce timeline items. Each data source describes:
- Where data is retrieved from (FetchXML string or reference to another App Setting)
- Optional parameters for query substitution
- Load ordering and dependency behaviour (preload/hidden)
- Search indexing fields used by the Timeline UI search experience
The Timeline PCF uses this to build the “raw dataset” that is later passed into `TransformFunction` (if present) and then into `Config.render`.
#### Usage
Use this setting to control *what data the Timeline shows* and *how it is retrieved*. Common use cases:
- Add additional datasets beyond segments (for example allocations, positions, external shifts, availability, compliance indicators)
- Preload a “reference” data source that provides IDs used by later FetchXML queries
- Hide helper sources that are only used for parameter substitution, not for rendering
- Configure `searchKeys` so the built-in timeline search can match meaningful fields (position name, resource name, codes, etc.)
- Split complex retrieval into multiple smaller sources to keep FetchXML readable and maintainable
#### Default Value
```json
[
{
id: 'segments',
fetchXml: 'Roster/TimelinePCF/FetchXml',
searchKeys: ['PositionName', 'ResourceName']
},
]
```
### FetchXml
#### Definition
Provides the FetchXML query used by a timeline data source (commonly the default `segments` source) to retrieve roster-related records. The query is expected to return a dataset that includes:
- A stable unique identifier for navigation (`entityid` alias)
- Start/end boundary values (at minimum a start value; end may be derived)
- Any fields required by `Config.render`, grouping functions, and search keys
This is the default retrieval query the Timeline PCF uses when no custom per-datasource FetchXML is supplied.
#### Usage
Use this setting when you need to tailor which segment records are returned, or which linked attributes are available for rendering/grouping. Common use cases:
- Add linked attributes needed for display (persona, shift type, location, allocation metadata, derived flags)
- Restrict results (only active, only certain statuses, only segments matching a roster filter)
- Change joins if your environment has different entity relationships or additional optional links
- Improve performance by removing unused columns/links when the timeline is slow on large rosters
- Support custom grouping strategies by ensuring the query returns the fields used by `groups` and `searchKeys`
#### Default Value
```xml
```
### Options
#### Definition
A JSON object of vis.js Timeline configuration options that modifies timeline behaviour and presentation at the component level (stacking, zooming, interaction, orientation, editable behaviour, etc.). This is applied after the PCF control constructs the timeline instance.
#### Usage
Use this setting to tune the end-user timeline experience without changing data retrieval or render/group logic. Common use cases:
- Enable/disable stacking when many items overlap
- Adjust zoom/move behaviour to reduce accidental navigation or improve usability
- Configure timeline height/width rules for different form factors
- Enable or restrict selection and interaction affordances
- Apply consistent timeline behaviour across environments while leaving `Config` focused on layout and grouping
#### Default Value
```json
{
"stack": true
}
```
### TransformFunction
#### Definition
A JavaScript function executed after all data sources are loaded. It transforms, merges, filters, sorts, or enriches the raw entities from the `Datasources` configuration into the final array of items that the Timeline PCF will pass to `Config.render`.
This is the “data shaping” layer used when the raw FetchXML output is not directly suitable for timeline display (for example missing end dates, derived ordering, multi-source joins).
#### Usage
Use this setting when you need deterministic, client-side shaping that is difficult or undesirable to express purely in FetchXML. Common use cases:
- Calculate missing end dates (for example infer end based on the next segment start, allocation end, or query window end)
- Combine multiple data sources into a single, unified item model
- Filter out records that should not be displayed (hidden states, internal markers, incomplete rows)
- Add derived fields used in rendering/grouping (duration, flags, labels, composite keys)
- Ensure stable ordering and predictable grouping, especially when dealing with large datasets or partially populated segment data
#### Default Value
```typescript
(dataSources) => {
const orderSegmentsAndAssigEndDate = (segments, paramsEndDate) => {
segments.sort((a, b) => {
const startA = new Date(a.startdate);
const startB = new Date(b.startdate);
return startA - startB;
});
const orderedSegments = segments.map((segment, index) => {
segment.index = index;
if (index === segments.length - 1) {
if (!segment.enddate) {
const allocationLastRpiDate = segment["allocation.vel_latestrpidate"];
const allocationEndDate = segment["allocation.vel_allocationenddate"];
segment.enddate =
allocationLastRpiDate || allocationEndDate || paramsEndDate;
}
return segment;
}
const nextSegment = segments[index + 1];
const enddate = new Date(nextSegment.startdate);
segment.enddate = enddate.toISOString();
const splitDate = segment.enddate.split("T")[0].split("-");
segment["enddate@OData.Community.Display.V1.FormattedValue"] =
splitDate[2] + "/" + splitDate[1] + "/" + splitDate[0];
return segment;
});
return orderedSegments;
};
let endDate;
const groupedSegments = dataSources.reduce((acc, dataSource) => {
endDate = dataSource.params?.endDate;
const segments = dataSource.entities || [];
segments.forEach((segment) => {
const allocation =
segment["_vel_rosterpositionallocationid_value"] || "default";
if (!acc[allocation]) {
acc[allocation] = [];
}
acc[allocation].push(segment);
});
return acc;
}, {});
const orderedSegments = Object.entries(groupedSegments).reduce(
(acc, [, segments]) =>
acc.concat(orderSegmentsAndAssigEndDate(segments, endDate)),
[]
);
return orderedSegments;
}
```
## Roster/WorkHoursCalendar/
### AllocationRowCount
#### Definition
Technical setting to change the batch size to be used to update Work Hours Calendar when roster is published.
#### Usage
This setting is used in Custom Action for WorkHoursCalendar when a roster calendar is published.
Accepts number.
#### Default Value
| 100 |
| --- |
### ExtentCode
#### Definition
Technical setting to handle overlaps in work hour calendar for a resource when roster is published.
#### Usage
This setting is used in Custom Action for WorkHoursCalendar when a roster calendar is published.
Accepted values 0,1,2.
- 0 - No shadowing of calendar rules. All rules are displayed even if they are shadowed or preceded by other rules.
- 1 - The recurrence duration determines the shadowing of that rule. Use this value to indicate working hours and a full day 24-hour shadow
- 2 - Only the rule duration is shadowed. Use this value to indicate time off. For example, 4 hours of time off allow working hours to appear before and after
#### Default Value
| 0 |
| --- |
### RPIPriorityOffset
#### Definition
Technical setting to identify the offset of how many days to prioritize updates to be sent to workhours calendar when roster is published.
#### Usage
This setting is used in Custom Action for Generating RPIs to identify the offset of how many days to be prioritized. Accepts Numbers
#### Default Value
| -1 |
| --- |
## 10- Appendix A
### Roster Position Instance object
The following object keys can be used to input values relating to the given Roster Position Instance.
Note that the below values do not work for External Roster Position Instances.
| **Key** | **Value** | **Sample Output** |
| --- | --- | --- |
| Id | GUID of the RPI record | 6e95d94f-3154-ed11-9562-0022489334d5 |
| From | From Date/Time of the RPI Record | 2021-11-16T01:00:00.000Z |
| To | From Date/Time of the RPI Record | 2021-11-16T09:00:00.000Z |
| Activity | Numerical value of the Activity Type | 285930001 |
| Name | Name of the RPI record | Contact 002 - DayShift |
| RosterPositionIndex | Numerical Value of the Position Order Index | 1 |
| fromDateTimeString | String value of time only for From field | 0900 |
| toDateTimeString | String value of time only for To field | 1700 |
| shift | Activity Type name value | Day |
| shiftType | Name of the Shift Type assigned | Day Shift |
| isRDOActivity | boolean 'true' if Activity == RDO | false |
| isDayActivity | boolean 'true' if Activity == Day | true |
| isNightActivity | boolean 'true' if Activity == Night | false |
| isResourceAllocated | boolean 'true' if Resource is not null | true |
### Related Objects
The below are objects relating to the Roster Position Instance, such as the Position or Resource.
These keys cannot be used with External Roster Position Instances
**RosterPosition**
| **Key** | **Value** | **Sample Output** |
| --- | --- | --- |
| RosterPosition.Id | Guid of the Roster Position | 5bbd72cd-aa25-ec11-b6e6-00224811991a |
| RosterPosition.DaysInAdvance | Numberical Value for days in advance | 45 |
| RosterPosition.Name | Name of the Position | Position 002 |
| RosterPosition.Quantity | Numerical Value for Quantity | 1 |
| RosterPosition.PositionStartDate | Start Date of the Position | 2021-10-01T00:00:00Z |
| RosterPosition.PositionEndDate | End Date of the Position | 2021-11-28T00:00:00Z |
| RosterPosition.DefaultResource.name | Name of the Default Resource | Contact 002 |
| RosterPosition.DefaultResource.bookeableresourceid | GUID of the Default Resource | b791326b-a925-ec11-b6e6-000d3a6ab617 |
| RosterPosition.Pattern.name | Name of the Roster Pattern | RosterValidation: Single Day Only |
| RosterPosition.Pattern.vel_rosterpatternid | GUID of the Roster Pattern | 5684b928-aa25-ec11-b6e6-002248112348 |
**Resource**
| **Key** | **Value** | **Sample Output** |
| --- | --- | --- |
| name | Name of the Resource | Contact 002 |
| bookableresourceid | GUID of the Resource | b791326b-a925-ec11-b6e6-000d3a6ab617 |
| resourcetype | Numerical value representing Resource Type | 2 |
| resourcetypename | Label value representing Resource Type | Contact |
| timezone | Numerical value for Time Zone Code | 225 |
| PositionId | GUID of the Roster Position | 5bbd72cd-aa25-ec11-b6e6-00224811991a |
| PositionAllocationId | GUID of the Roster Allocation | b2026bd3-aa25-ec11-b6e6-00224811991a |
**PositionAllocation**
| **Key** | **Value** | **Sample Output** |
| --- | --- | --- |
| Id | GUID of the Position Allocation | b2026bd3-aa25-ec11-b6e6-00224811991a |
| Index | Numeric value for Order Index | 1 |
| Name | Name of the Roster Allocation | Position 002 1 |
| PositionId | GUID of the Postion | 5bbd72cd-aa25-ec11-b6e6-00224811991a |
| ResourceId | GUID or the Resource | b791326b-a925-ec11-b6e6-000d3a6ab617 |
| RosterId | GUID of the Roster | 851baecf-a925-ec11-b6e6-002248112348 |
| Resource.name | Name of the Resource | Contact 002 |
| Resource.bookableresourceid | GUID of the Resource | b791326b-a925-ec11-b6e6-000d3a6ab617 |
| Resource.resourcetype | Numerical Value of the Resource Type | 2 |
| Resource.resourcetypename | String Value of the Resource Type | Contact |
| Resource.timezone | Numerical Value of the Resources Time Zone Code | 225 |
| Resource.PositionId | GUID of the Position | 5bbd72cd-aa25-ec11-b6e6-00224811991a |
| Resource.PositionAllocationId | GUID of the Position Allocation | b2026bd3-aa25-ec11-b6e6-00224811991a |
| Resource.CustomFields | Specific to the Custom Field used | |