--- title: "App Settings" slug: "app-settings" updated: 2026-10-12T08:35:31Z published: 2026-10-12T08:35:31Z canonical: "docs.powerworker.com/app-settings" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.powerworker.com/llms.txt > Use this file to discover all available pages before exploring further. # App Settings ## Availability/Behaviors/ ### Approval #### Definition Setting to describe the behaviour to apply to overlapping Shift RPI's when approving Leave Availability. #### Usage This App setting is used in Leave Approval process to handle overlapping RPI’s on approval. Accepted values are Unassign Shift, Deactivate, Do Nothing. - Unassign Shift – Overlapping Shift RPI's will have the Resource field cleared (set to null). - Deactivate – Overlapping Shift RPI's will have the status field set to Inactivate. - Do Nothing – Overlapping Shift RPI's will have no action executed on to them. #### Default Value | Unassign Shift | | --- | ### Cancelled #### Definition Setting to describe the behaviour to apply to overlapping Shift RPI's when cancelling an approved leave. #### Usage This App setting is used in Leave Approval process to handle overlapping RPI’s on cancelling an approved leave. Accepted values are Unassign Shift, Deactivate, Do Nothing. - Reassign Shift – Overlapping Shift RPI's will have the Resource field cleared (set to null). - Activate – Overlapping Shift RPI's will have the status field set to Inactivate. - Do Nothing – Overlapping Shift RPI's will have no action executed on to them. #### Default Value | Reassign Shift | | --- | ## PowerWorker/Licensing/ ### FunctionAppUrl #### Definition Encoded URL for the Licensing End-Point used for querying licensing information for the client’s environment. #### Usage Allows clients to enter in a unique encoded URL to point to other licensing environments. This is a failsafe for events that the primary environment is down. #### Default Value | LD2nuLpZX9shji1Gi3gyAJzuzHQseiDXOjly4X/tj/DK1udR7Q0q4aBDvwTrcN/3BGtFmzWHF9+2tg8+pPxrrj8kmbr+oIxnb6kAnAT4KHaaGh1Yldv8cbFXSA/GFZAhxD0//8TSGJELBdpQapidzV+v9HEYML49EbazsNyfM0CpYSWLO73NQL56CKT6Kyjo | | --- | ## Roster/Compliance/ ### BreachesPCF/FetchXML #### Definition Fetch query used to retrieve the Compliance Total Breaches for the target Roster or Resource. This is used for the PCF Control that exists on both the Roster and Bookable Resource Form. #### Usage The default value returns all related Compliance Breaches grouped by severity. The filter and linked sections of this fetch can be modified to alter the returned items, but it is imperative that it is only the filter that is modified, as the entity name, attribute aliases and variables are left untouched. #### Default Value | | | --- | ### CustomJsonForValidation (Introduced in v8.1) #### Definition Define a sample Dataset in JSON used for validating Compliance Rules that use Custom Data in both shift details as well as Future and Previous Shifts. #### Usage Give a sample dataset in JSON format so that Compliance Rules may be validated. The Is Valid flag is set to true if the Lambda expression compiles and validates against the sample dataset without error. Example: | {"Categories":["Actor"],"Characteristics":[{"Characteristic":"Dancer","Rating":"Excellent","RatingValue":"5"}],"ResourceType":1} | | --- | #### Default Value | empty | | --- | ### DefaultFilters/PreviousAndFutureShiftsFromOffsetDays #### Definition This setting specifies the lower bound of the previous and future shifts related to a target shift, which is used by the compliance engine to evaluate the target shift against user configured compliance rules. #### Usage This value is used to calculate the *Earliest Previous Shift Date* field when creating a Compliance Run. *Earliest Previous Shift Date* will be recalculated when a Compliance Run Target Shifts From field is changed. *Earliest Previous Shift Date = Target Shift From + this configuration value (in days). For example when the setting is set to –60 and the Target Shift From is change to 01/03/2024 then the Earliest Previous Shift Date will be set to 01/01/2024* This setting can be adjusted when a user configured compliance rules requires historic shift information for the resource on target shifts. It is recommended to keep the value as low as possible to avoid potential performance issues with the compliance engine. #### Default Value | -119 | | --- | ### DefaultFilters/PreviousAndFutureShiftsToOffsetDays #### Definition This setting specifies the upper bound of the previous and future shifts related to a target shift, which is used by the compliance engine to evaluate the target shift against user configured compliance rules. #### Usage This value is used to calculate the *Latest Previous Shift Date* field when creating a Compliance Run. *Latest Previous Shift Date* will be recalculated when a Compliance Run Target Shifts To field is changed. *Latest Previous Shift Date = Target Shifts To + this configuration value (in days). For example when the setting is set to 60 and the Target Shifts To is change to 01/03/2024 then the Latest Previous Shift Date will be set to 30/04/2024* This setting can be adjusted when a user configured compliance rules requires historic shift information for the resource on target shifts. It is recommended to keep the value as low as possible to avoid potential performance issues with the compliance engine. #### Default Value | 119 | | --- | ### DefaultFilters/TargetShiftsFromOffsetDays #### Definition This setting specifies the lower bound of the targets shifts to be evaluate against user configured compliance rules. #### Usage This value is used to calculate the *Target Shifts From* field when creating a Compliance Run. *Target Shifts From* *Date* will be calculated on Compliance Run form load. *Target Shifts From = current date + this configuration value. For example when the setting is set to -119 and the current date is 01/03/2024 then the Target Shifts From will be set to 03/11/2023* Clients requirements regarding the date range of shifts to be processed through the compliance engine will dictate this app settings value. It is recommended to keep the value as low as possible to avoid potential performance issues with the compliance engine. #### Default Value | -60 | | --- | ### DefaultFilters/TargetShiftsToOffsetDays #### Definition This setting specifies the upper bound of the targets shifts to be evaluate against user configured compliance rules. #### Usage This value is used to calculate the *Target Shifts To* field when creating a Compliance Run. *Target Shifts To Date* will be calculated on Compliance Run form load. *Target Shifts To = current date + this configuration value. For example when the setting is set to 119 and the current date is 01/03/2024 then the Target Shifts To will be set to 28/07/2024* Clients requirements regarding the date range of shifts to be processed through the compliance engine will dictate this app settings value. It is recommended to keep the value as low as possible to avoid potential performance issues with the compliance engine. #### Default Value | 60 | | --- | ### FunctionApp/ValidateShifts #### Definition This setting specifies the URL endpoint for the ValidateShifts Function App within the Compliance Function Apps suite. It enables the system to make on-demand, real-time API calls to validate shifts against compliance rules and standards. The validation process ensures that shifts adhere to organizational policies, regulatory requirements, and other compliance criteria before they are finalized or altered. #### Usage The value of this App Setting is a URL that points to the specific instance of the ValidateShifts Function App. This URL is used by the system whenever a shift validation request is initiated, typically as part of the shift creation or modification process. The Function App then processes the request and returns validation results, which may include approval, rejection, or suggestions for adjustments to comply with set rules. This setting is a system configuration, typically set up by a Velrada implementer during the initial system configuration or during an environment setup. This setting is only expected to have a value if Compliance is enabled on the environment. #### Default Value | Empty | | --- | ### DisplayDismissReason (Introduced in v8.1) #### Definition This setting enables a dialog to be displayed when a breach is dismissed forcing users to enter a dismiss reason. #### Usage Used to enforce a dismiss reason being mandatory when users dismiss a compliance breach. #### Default Value | false | | --- | ## Roster/FeatureFlags/ ### UseVirtualizedCalendar (Introduced in v8.1) #### Definition Boolean setting that if set to true, will enable Virtualisation on the Roster Calendar control. Virtualisation is a pattern that only renders components in the view port window, so cuts down on load times and operations of a control. #### Usage It is recommended to enable this feature when using Rosters that have a large data set and load times may be a factor #### Default Value | true | | --- | ## Roster/FormNotification/ ### EnableDraftWarning (Deprecated as of v8.2) #### Definition Boolean setting that enables or disables the Draft Warning Message on the Roster form. #### Usage Enable this setting if you would like to display the Draft Roster Message on the form for all users. Useful for conveying that the Roster needs to be published in order to write to working house calendar. #### Default Value | false | | --- | ### EnablePublishedWarning (Deprecated as of v8.2) #### Definition Boolean setting that enables or disables the Published Warning Message on the Roster form. #### Usage Enable this setting if you would like to display the Published Roster Message on the form for all users. Useful for conveying that the Roster cannot be edited while in this state. #### Default Value | true | | --- | ## Roster/FrontlineApp/ ### AdditonalDaysShifts #### Definition Numeric value that indicates the number of days that a Frontline App User see’s their shifts. #### Usage Increase this value to display additional shifts on the Frontline App. #### Default Value | 1 | | --- | ### ClientLogo #### Definition Setting to identify and populate the Client logo in Mobile App. Format should be SVG.. #### Usage Client logo SVG string needs to be used. Default value is Velrada Logo svg string. #### Default Value | | | --- | ### DefaultTimeEntryDraftStatus #### Definition Links the Time Entry Status that will be applied to newly created Time Entry records, required for Frontline App functionality. #### Usage Set the name of the default Time Entry Status that all Time Entries will be created in. #### Default Value | Draft | | --- | ### DefaultTimeEntryDraftStatus (Introduced in v8.3) #### Definition Links the Time Entry Status that will be applied to newly created Time Entry records, required for Frontline App functionality. #### Usage Set the name of the default Time Entry Status that all Time Entries will be created in, that are not linked to an Approval Process. #### Default Value | Draft | | --- | ### DefaultTimeEntrySubmitStatus (Introduced in v8.3) #### Definition Links the Time Entry Status that will be applied to Time Entry records that are submitted through the Frontline App. #### Usage Set the name of the Time Entry Status that will be applied to any Time Entries submitted through the Frontline App, that are not linked to an Approval Process. #### Default Value | Submitted | | --- | ### DraftStatus #### Definition Setting to specify the draft status for leave requests in Frontline App. #### Usage Used in Frontline canvas app to populate draft status for leave requests. #### Default Value | Draft | | --- | ### EditableStatuses (Introduced in v8.3) #### Definition Specify the primary Status that is allowed for editing Time Entries through the Frontline App. #### Usage Set the name of the Time Entry Status that will allow users to edit Time Entry records. #### Default Value | Draft | | --- | ### EnableBreaks #### Definition Setting to enable add breaks feature in Frontline App. #### Usage Used in Frontline canvas app to enable or disable add breaks feature. Accepted Values true, false. #### Default Value | true | | --- | ### EnableClockOn #### Definition Setting to enable clock on/ clock off feature in Frontline App. #### Usage Used in Frontline canvas app to enable or disable clock on/ clock off feature. Accepted Values true, false. #### Default Value | false | | --- | ### EnableLeave #### Definition Setting to enable leave feature in Frontline App. #### Usage Used in Frontline canvas app to enable or disable leave feature. Accepted Values true, false. #### Default Value | true | | --- | ### EnableLeaveDetails (Deprecated as of v8.2) #### Definition Setting to enable leave details screen in Frontline App. #### Usage Used in Frontline canvas app to enable or disable leave details screen feature. Accepted Values true, false. #### Default Value | true | | --- | ### EnableShiftSwap #### Definition Setting to enable shift swap feature in Frontline App. #### Usage Used in Frontline canvas app to enable or disable shift swap feature. Accepted Values true, false. #### Default Value | true | | --- | ### EnableTeams #### Definition Setting to enable teams feature in Frontline App. #### Usage Used in Frontline canvas app to enable or disable teams feature. Accepted Values true, false. #### Default Value | true | | --- | ### Styles #### Definition Setting to specify css rules for Frontline App Display. #### Usage Used in Frontline canvas app to apply css styling in UI. #### Default Value | { "PrimaryColour": "#7A05E8", "ScreenColour": "#E6E3E8", "TextColour": "#000000", "LightTextColour": "#959595", "ErrorColour": "#f44336", "PendingColour": "#F57F17", "SuccessColour": "#4caf50", "HeaderColour": "#FFFFFF", "ContainerColour": "#FFFFFF", "SeperatorColour": "#F0F0F0", "DisabledColour": "#F4F4F4", "ControlColour": "#E4E4E4" } | | --- | ### SubmittedStatus #### Definition Setting to specify the submitted status for leave requests in Frontline App. #### Usage Used in Frontline canvas app to populate submitted status for leave requests. #### Default Value | In Review | | --- | ## Roster/RosterPCF/ ### AllowDoubleBooking #### Definition This setting is to allow or block double booking thus show/hide resource that already have shift assigned in Resource Picker. #### Usage Setting accepts following values: - **True:** allows a resource to be displayed and selected for a shift even they have a shift assigned. - **False**: blocks display & selection of a resource if they already have a shift assigned. #### Default Value | False | | --- | ### AllowRpiDelete #### Definition This setting is to toggle the ability to delete an RPI from the Calendar PCF by right-clicking it. #### Usage Setting accepts following values: - **True:** allows delete of RPI from the context menu. ![Graphical user interface Description automatically generated with medium confidence](https://cdn.document360.io/7abff6c0-4eeb-4bb0-a6a4-8718bf640435/Images/Documentation/powerroster-8.0-2025---app-settings-image-nmmnu8mq.png) - **False**: blocks delete of RPI form context menu. ![Graphical user interface, table Description automatically generated](https://cdn.document360.io/7abff6c0-4eeb-4bb0-a6a4-8718bf640435/Images/Documentation/powerroster-8.0-2025---app-settings-image-9tavg27r.png) #### Default Value | **True** | | --- | ### AvailabilityDefaultDayRange (Introduced in v8.3) #### Definition When an entity does not have an End Date, calculate a temporary End Date by adding the configured AvailabilityDefaultDayRange value to the entity Start Date. This calculated date should then be used when evaluating resource availability within the Resource Picker. Will be added to today’s date, or entity Start Date, whichever is greater. #### Usage Numeric number that should be considered for increasing or decreasing to balance optimisation versus accurancy. #### Default Value | 90 | | --- | ### BookableResourceFetchXml #### Definition This setting to store the FetchXml for retrieval of Bookable Resources to display in the Roster Grid. #### Usage Configure this fetchXML query when there is a need to modify the list of Resources that should be returned when using the ‘Show All Resources’ toggle on the Roster grid. #### Default Value | | | --- | ### CustomFields #### Definition To add custom fields that can be used for Grouping and Shift Templating, add the fields logical name to the JSON body of this app setting. #### Usage The JSON body accepts the following attributes: - **name**: Schema name of the field. This field must exist on the Roster Position Instance. - **type**: The data type of the field. Values accepted: String, Number, and Date - **label**: This is used for Grouping, the value displayed in Header and in the Drop-Down Option - **allowGrouping**: Accepts true or false values, whether the custom field can be used for Grouping. Note: Custom fields are used in “ShiftDisplayTemplates” App Settings as explained [here](/docs/app-settings#_ShiftDisplayTemplates). #### Default Value | [ { "name": "vel_shiftopen", "type": "string", "label": "Shift Open", "allowGrouping": false }, { "name": "vel_clockingstatus", "type": "string", "label": "Clocking Status", "allowGrouping": true } ] | | --- | ### DefaultRpiClickBehavior #### Definition This setting controls the click behaviour when interacting with a Roster Position Instance via the Roster Calendar Control. #### Usage Update this setting to change the default behaviour when interacting with an RPI. These are the possible options: - Assign Resource - Edit When clicking on a Roster Position Instance, the Advanced Resource Picker dialogue window(Assign Resource) is opened, or the RPI Panel (Edit) appears. #### Default Value Edit ### DemandForecastActualDataQueryFetchXml #### Definition This setting to store the FetchXml for retrieval of RPIs (shifts) to calculate the actuals in the Demand Forecast Chart. #### Usage Used in demand forecast chart to retrieve the actual data for the roster between selected dates. #### Default Value ### DemandForecastChartColours #### Definition This setting to configure the chart colour for each status in the demand forecast chart. #### Usage Used in demand forecast chart to determine the colour of the chart for each Status. JSON object accepts key value pair with Key being the name of the Status and value being the HEX code for the colour to be used. #### Default Value | { "Satisfied":"#FF77FF", "Short":"#FF7788", "Exceeded":"#77FF88", "Forecast":"#997788" } | | --- | ### DemandForecastEditFilterPaneSecurityRole #### Definition This setting to configure the security roles that can edit the filter pane on the demand forecast chart #### Usage The setting takes a comma delimited list of guids for each security role that can edit the Demand Forecast Chart Filter Pane. Preferably app settings should never be deleted therefore use a value of "[empty]" to ignore this setting and allow all security roles to edit the Demand Forecast Chart Filter Pane. Preferably the comma delimited list of guids should contain no spaces. While every attempt has been made to handle spaces, correct functionality cannot be guaranteed if spaces exist in the list. **Examples of Valid Values** , 00bb53d6-da92-e111-9d8c-000c2959f9b8, 54068ef6-7a1e-eb11-a813-0022480fea01,cad52a75-568c-e611-80d4-00155d42a122 [empty] #### Default Value | [empty] | | --- | ### DemandForecastForecastDataQueryFetchXml #### Definition This setting to store the FetchXml for retrieval of Demand Forecast Data (based on selected Demand Forecast Models) to calculate the forecast data in the Demand Forecast Chart. #### Usage Used in demand forecast chart to retrieve the forecast data for the selected Demand Forecast Models between selected dates. #### Default Value | {{demandModelsCondition}} | | --- | ### DemandForecastIntervalConfiguration #### Definition This setting to configure the intervals that will be displayed on the interval drop down list on the filter pane in the demand forecast chart. #### Usage **WARNING** The 3 default interval configs should never be modified or removed. However new interval configs can be added. To add a new interval config add a new item to the JSON array, with the 4 required attributes label, minutes, maximumDateRange and maximumTicks. Below is an example of a custom interval for 15 minutes and 2 weeks { "label": "15 Minutes", "minutes": 15, "maximumDateRange": 5, "maximumTicks": 10 }, { "label": "Fortnight", "minutes": 20160, "maximumDateRange": 4380, "maximumTicks": 10 }, - Label - label that is display in the interval drop down list. - Minutes - number of minutes for the interval. Day = 24 hours * 60 minutes per hour = 1440 minutes. Hour = 60 minutes. Week = 7 days * 24 hours * 60 minutes per hour = 10080 minutes - maximumDateRange - maximum date range that can be selected. Use to set the max valid date on the custom end date picker, to prevent large datasets that could cause out of memory exceptions in the browser. maximumTicks - maximum number of ticks to display on the chart, used to prevent over crowding of labels for data points on the horizontal/time axis. ![A screenshot of a computer Description automatically generated](https://cdn.document360.io/7abff6c0-4eeb-4bb0-a6a4-8718bf640435/Images/Documentation/powerroster-8.0-2025---app-settings-image-g3fbjf2g.png) #### Default Value | [ { "label": "Hour", "minutes": 60, "maximumDateRange": 14, "maximumTicks": 25 }, { "label": "Day", "minutes": 1440, "maximumDateRange": 182, "maximumTicks": 10 }, { "label": "Week", "minutes": 10080, "maximumDateRange": 2190, "maximumTicks": 10 } ] | | --- | ### DemandForecastModelQueryFetchXml #### Definition This setting to store the FetchXml for retrieval of demand forecast models. #### Usage Used in demand forecast chart to populate the models drop down list for selected date range. #### Default Value | | | --- | ### DemandForecastPersonaForModelQueryFetchXml #### Definition This setting to store the FetchXml for retrieval distinct personas associated with a Demand Forecast Model(s). #### Usage Query 1 of 2, used to populate the Persona drop down list in the demand forecast chart. Note: Unique values from the combination of both queries (1.1.9 & 1.1.10) are used to populate the Persona drop down on the demand forecast chart. #### Default Value | {{demandModelIds}} | | --- | ### DemandForecastPersonaForRosterQueryFetchXml #### Definition This setting to store the FetchXml for retrieval of persona information for RPIs in current Roster. #### Usage Query 2 of 2, used to populate the Persona drop down list in the demand forecast chart. Note: Unique values from the combination of both queries (1.1.9 & 1.1.10) are used to populate the Persona drop down on the demand forecast chart. #### Default Value | | | --- | ### DemandForecastPositionForModelQueryFetchXml #### Definition This setting to store the FetchXml for retrieval distinct positions associated with a Demand Forecast Model(s). #### Usage Query 1 of 2, used to populate the Persona drop down list in the demand forecast chart. Note: Unique values from the combination of both queries (1.1.11 & 1.1.12) are used to populate the Position drop down on the demand forecast chart. #### Default Value | {{demandModelIdList}} | | --- | ### DemandForecastPositionForRosterQueryFetchXml #### Definition This setting to store the FetchXml for retrieval of position information for RPIs in current Roster. #### Usage Query 2 of 2, Used to populate the position drop down list in the demand forecast chart. Note: Unique values from the combination of both queries (1.1.11 & 1.1.12) are used to populate the Position drop down on the demand forecast chart. #### Default Value | | | --- | ### DSBackColour #### Definition Setting to apply default background colour for Day Shift RPI’s in Roster Grid. #### Usage Setting accepts HEX code for the colour to be applied RPI background. Note: This is overridden if you have a specific Shift Type colour for the RPI. #### Default Value | #e0f4ec ![](https://cdn.document360.io/7abff6c0-4eeb-4bb0-a6a4-8718bf640435/Images/Documentation/powerroster-8.0-2025---app-settings-image-33ptyc9r.png) | | --- | ### EnableFormsOverPanels #### Definition When opening the Position, Allocation, or Roster Position Instance from the Roster Calendar control, if this setting is set to true then the Dataverse Form will be opened, if false the fluent ui Panel will instead be opened. #### Usage Set this value as true to allow access to the Dataverse Form, which is highly configurable. #### Default Value | true | | --- | ### EnableMoveRPI #### Definition Setting to allow the drag and drop functionality of the RPI on the Calendar PCF control. #### Usage Setting accepts following values: - **True**: will allow drag and drop of RPI to different slot. ![Graphical user interface, application Description automatically generated](https://cdn.document360.io/7abff6c0-4eeb-4bb0-a6a4-8718bf640435/Images/Documentation/powerroster-8.0-2025---app-settings-image-a9fa0d0u.png) - **False**: will disable the drag and drop functionality. #### Default Value | True | | --- | ### EnableMustChooseFrom #### Definition To enable or disable ‘Must Choose From’ resources filter in the Resource Picker based on Account Resource preferences. #### Usage Setting accepts following values: - **True**: will only display resources with valid ‘Must Choose From’ account preferences even if other resources match the search criteria. ![Graphical user interface, text, application Description automatically generated](https://cdn.document360.io/7abff6c0-4eeb-4bb0-a6a4-8718bf640435/Images/Documentation/powerroster-8.0-2025---app-settings-image-4hllskad.png) ![Graphical user interface, text, application Description automatically generated](https://cdn.document360.io/7abff6c0-4eeb-4bb0-a6a4-8718bf640435/Images/Documentation/powerroster-8.0-2025---app-settings-image-6ndqphdw.png) - **False**: will display all valid resources matching search criteria. #### Default Value | False | | --- | ### EnableQuickActionBar #### Definition Setting to enable the 'Quick Action Bar' feature which allows users to add shifts to dates that have a shift already and a paste button. #### Usage Setting accepts following values: - **True:** will display the shift copy and paste options in context menu on Roster Grid. ![A picture containing graphical user interface Description automatically generated](https://cdn.document360.io/7abff6c0-4eeb-4bb0-a6a4-8718bf640435/Images/Documentation/powerroster-8.0-2025---app-settings-image-lzwwsxhr.png) - **False**: will hide the option for shift copy and paste in context menu on Roster Grid. ![Graphical user interface Description automatically generated with low confidence](https://cdn.document360.io/7abff6c0-4eeb-4bb0-a6a4-8718bf640435/Images/Documentation/powerroster-8.0-2025---app-settings-image-bug9x5gz.png) #### Default Value | **True** | | --- | ### EnableRestrictedResources #### Definition This setting is to enable or disable removal of restricted resources from Resource Picker based on Account Resource Preferences. #### Usage Setting accepts following values: - **True:** removes the un-expired restricted resources from the Account preferences from the Resource picker even if it matches search criteria. ![Graphical user interface, text, application, chat or text message, email Description automatically generated](https://cdn.document360.io/7abff6c0-4eeb-4bb0-a6a4-8718bf640435/Images/Documentation/powerroster-8.0-2025---app-settings-image-sice0b17.png) ![Graphical user interface, application Description automatically generated](https://cdn.document360.io/7abff6c0-4eeb-4bb0-a6a4-8718bf640435/Images/Documentation/powerroster-8.0-2025---app-settings-image-cebqq68i.png) - **False**: will include the restricted resources for selection in Resource Picker if it matches other search criteria. #### Default Value | **True** | | --- | ### EnableRpiCopyPaste #### Definition To enable or disable copy & paste options from shift context menu in Roster Grid. #### Usage Setting accepts following values: - **True:** will display the shift copy and paste options in context menu on Roster Grid. ![Chart, treemap chart Description automatically generated](https://cdn.document360.io/7abff6c0-4eeb-4bb0-a6a4-8718bf640435/Images/Documentation/powerroster-8.0-2025---app-settings-image-ky5sitt4.png) - **False**: will hide the option for shift copy and paste in context menu on Roster Grid. ![Chart, treemap chart Description automatically generated](https://cdn.document360.io/7abff6c0-4eeb-4bb0-a6a4-8718bf640435/Images/Documentation/powerroster-8.0-2025---app-settings-image-nbt0rdmb.png) #### Default Value | **True** | | --- | ### ExternalShiftFetchXml #### Definition This setting to store the FetchXml for retrieval of RPIs (shifts) from other Rosters matching the start and end date displayed in Roster Grid. #### Usage FetchXml generated from Power platform is used to retrieve the RPIs from other Rosters between same start and end date of Roster Grid. This setting is based on Display External Shifts in Roster Settings. #### Default Value | {{resourceIds}} {{startDate}} {{endDate}} | | --- | ### HolidaysBackgroundColour #### Definition Control the colour of the Holiday overlay, visible from the Roster Calendar control. #### Usage Enter a Hex Code for a colour to be used by the Roster Calendar to show as the Holidays overlay on the control. #### Default Value | #fcfcc5 | | --- | ### NSBackColour #### Definition Setting to apply default background colour for Night Shift RPI’s in Roster Grid. #### Usage Setting accepts HEX code for the colour to be applied RPI background. Note: This is overridden if you have a specific Shift Type colour for the RPI. #### Default Value | #f0ecfc ![](https://cdn.document360.io/7abff6c0-4eeb-4bb0-a6a4-8718bf640435/Images/Documentation/powerroster-8.0-2025---app-settings-image-0569f54t.png) | | --- | ### PersonaCardConfig #### Definition To add custom fields that can be used for Grouping and Shift Templating, add the fields logical name to the JSON body of this app setting. #### Usage The Roster Calendar persona card display can be configured via App Settings. To learn more about how to change the persona card visit the following QRG document: [Power Roster QRG - Roster Configuration - Change the Persona Card.docx](https://velrada365.sharepoint.com/:w:/t/D365RosteringIP/EXZ2qfPBY4ZDt50UJ-OzWcQBERWmcv_MbGib-cjTM9p5XQ?e=q8pqN5) The JSON body accepts the following attributes: - **primaryText**: - **secondaryText**: - **teritiaryText**: - **showPersonaCoin:** flag to show/hide Persona Coin. Accepted values true, false. - **template**: HTML template to render the primary & secondary Texts. - The template property in JSON object is a template of HTML that is injected into the Persona Header. Users can opt to use HTML language as well as inline CSS to control the persona card content. - Pipe data into the shift by using the {{ }} characters into template property. #### Default Value | { “primaryText”: “secondaryText”: “teritiaryText”: “showPersonaCoin”: “template”: } | | --- | ### PositionAllocationSegmentsFetchXml #### Definition This setting to store the FetchXml for retrieval of Roster Position Allocation Segments be used in Roster PCF on Roster Position Allocation Update. #### Usage FetchXml generated from Power platform is used to retrieve the Roster Position Allocation Segment when updating Roster Position Allocation (Assign Resource form). #### Default Value | 00000000-0000-0000-0000-000000000000 {{positionAllocationIds}} | | --- | ### PositionAllocationsFetchXml #### Definition This setting to store the FetchXml for retrieval of Position Allocations to display in the Roster Grid. #### Usage FetchXml generated from Power platform is used to retrieve the Position Allocations to display in Roster Grid PCF control. #### Default Value | | | --- | ### PositionOutsideDateColour #### Definition Setting to apply background colour for RPI’s which are disabled/greyed out in Roster Grid. #### Usage Setting accepts HEX code for the colour to be applied RPI background. Note: This is overridden if you have a specific Shift Type colour for the RPI. #### Default Value | #f8f8f8 ![](https://cdn.document360.io/7abff6c0-4eeb-4bb0-a6a4-8718bf640435/Images/Documentation/powerroster-8.0-2025---app-settings-image-r00jvn0l.png) | | --- | ### PositionsFetchXml #### Definition This setting to store the FetchXml for retrieval of Roster Positions to display in the Roster Grid. #### Usage FetchXml generated from Power platform is used to retrieve the roster positions to display in Roster Grid PCF control. #### Default Value | | | --- | ### RDOBackColour #### Definition Setting to apply default background colour for RDO Shift RPI’s in Roster Grid. #### Usage Setting accepts HEX code for the colour to be applied RPI background. Note: This is overridden if you have a specific Shift Type colour for the RPI. #### Default Value | #ffe4e4 ![](https://cdn.document360.io/7abff6c0-4eeb-4bb0-a6a4-8718bf640435/Images/Documentation/powerroster-8.0-2025---app-settings-image-oswsvp40.png) | | --- | ### ResourceCardTemplate (Introduced in v8.2) #### Definition Handlebars HTML template used to render each Resource Card inside the Advanced Resource Picker / Resource Explorer. The template is compiled per resource returned from the vel_ResourcePickerFilterResources custom API and injected into the card body, giving full control over the layout, information density, and visual styling of the resource selection list. Consumed by every Roster surface that shows the Resource Picker / Resource Explorer, including the Roster Calendar Assign Resource, the Form Resource Picker, the Segment Manager and Allocation Segment panels, the Add Position panel, and the Allocations Grid. #### Usage The setting value is a **Handlebars (v4.7.7)** template — plain HTML with `{{ }}` expressions and helpers. If left empty, the control falls back to the built‑in Fluent UI Persona card layout. **Data context available to every card** Core fields (always present): - `id` – GUID of the Bookable Resource. - `name` – Display name of the resource. - `resourceType` – Resource type label (e.g. `Contact`, `User`). - `index` – Zero‑based position in the current result list. - `isDoubleBooked` – `true` when the resource already has a conflicting shift. - `isPreferred` – `true` when the resource is marked as preferred for the target position. - `isBookedToShift` – `true` when already assigned to the current shift. - `isBookedToSegment` – `true` when already assigned to the current segment. Custom / dynamic fields: - Any field listed in the `Roster/RosterPCF/ResourceExplorerApiResourceFields` app setting is merged into the context and can be referenced directly by its schema name (e.g. `{{vel_employeeid}}`, `{{vel_skillrating}}`). **Built‑in Handlebars helpers** `{{#if}}`, `{{#unless}}`, `{{#each}}`, `{{#with}}` are supported as standard. **Custom helpers** | Helper | Syntax | Purpose | | --- | --- | --- | | `ifEquals` | `{{#ifEquals a b}}…{{else}}…{{/ifEquals}}` | Conditional equality comparison. | | `formatNumber` | `{{formatNumber value}}` | Locale‑aware number formatting. | | `uppercase` / `lowercase` | `{{uppercase text}}` | Text case transformation. | | `truncate` | `{{truncate text length}}` | Truncate with ellipsis. | | `initials` | `{{initials name}}` | Extract initials from a name (e.g. `John Smith` → `JS`). | | `colorFromIndex` | `{{colorFromIndex index}}` | Deterministic HSL color from the row index. | | `icon` | `{{icon "name"}}` | Inline SVG icon injection (40+ pre‑registered icons – warning, error, star, calendar, clock, person, location, day‑shift, night‑shift, lock, etc.). | **Notes** - Any custom field referenced in the template **must** also be added to `Roster/RosterPCF/ResourceExplorerApiResourceFields`, otherwise the value will be `undefined`. - Templates are compiled once per session and cached, so syntax errors will prevent all cards from rendering — validate templates in a development environment first. - Inline CSS is the recommended styling approach (matches the pattern used by `ShiftDisplayTemplates` and `PersonaCardConfig`). #### Default Value |
{{initials name}}
{{name}}
{{#if isPreferred}}
{{icon "star"}}
{{/if}}
{{#if resourcetype}}
{{resourcetype}}
{{/if}}
{{#if isDoubleBooked}}
{{icon "warning"}}
{{/if}}
| | --- | ### ResourcePickerEnableAvailabilityFilter (Introduced in v8.3) #### Definition Enables (true) or disables (false) filter resources based on availability in the Resource Picker. #### Usage Set to true for resources to be excluded from the resource picker when a resources availability pattern does not match the evaluated entities (segment, allocation, position or shift) pattern. #### Default Value | true | | --- | ### ResourcePickerCustomFields #### Definition To add custom fields that can be displayed in resource picker results, add the fields logical name to the JSON body of this app setting. Works with the Custom Filter feature, allowing clients to provide unique values to be displayed in the Resource Picker list #### Usage Custom fields are shown in the Resource Picker selection list next to the name of resource. The JSON body accepts the following attributes: - name: Schema name of the field. This field must exist on the Bookable Resource or provided by the Custom API - type: The data type of the field. Values accepted: String, Number, and lookup. - label: This is optional property. - Source: This is optional, defaults to ‘d365’ but change to ‘custom’ if the value is from the Custom API ![](https://cdn.document360.io/7abff6c0-4eeb-4bb0-a6a4-8718bf640435/Images/Documentation/powerroster-8.0-2025---app-settings-image-y6kz261f.png) #### Default Value | [ { "name":"name", "type":"string", "label":"", "source":"d365" }, { "name":"resourcetype", "type":"number", "label":"" } ] | | --- | ### ResourcePickerEnableCustomFilter #### Definition Enables or Disables the Custom Filter feature on the Resource Picker. #### Usage Custom filter allows clients to hook up to the ‘ResourcePickerCustomFilter’ Custom API, as part of the Rostering solution. Clients can then provide name and id of bookable resources they would like added to the Resource Picker filter. #### Default Value | false | | --- | ### RosterPositionAllocationCompactFormId #### Definition Allows users to enter in the GUID of a different form that can be used by the Roster Control. When opening a Roster Position Allocation this form will be opened instead of the OOTB compact form. #### Usage Enter the GUID of the Roster Position Allocation Form. #### Default Value | 18a06194-cf3d-ef11-a316-000d3ae19850 | | --- | ### RosterPositionCompactFormId #### Definition Allows users to enter in the GUID of a different form that can be used by the Roster Control. When opening a Roster Position this form will be opened instead of the OOTB compact form. #### Usage Enter the GUID of the Roster Position Form. #### Default Value | da85147c-733a-ef11-a316-000d3ae19850 | | --- | ### RosterPositionFormFieldsConfig #### Definition To control the visibility and default values of fields in Add Position, Update RPI, Bulk Edit RPI Forms. #### Usage The JSON body accepts the following attributes: - **name**: Form field property name. Values accepted: daysInAdvance, quantity, persona, pattern, shiftType, shiftDescription - **visible**: This is used to set visibility of the field on the forms. Values accepted: true, false. - **defaultValue**: Optional property to capture the default value to be passed. Accepts numbers and booleans. ![Graphical user interface, text, application, email Description automatically generated](https://cdn.document360.io/7abff6c0-4eeb-4bb0-a6a4-8718bf640435/Images/Documentation/powerroster-8.0-2025---app-settings-image-m3nycnwd.png) #### Default Value | [ { "name": "daysInAdvance", "visible": true }, { "name": "persona", "visible": true }, { "name": "pattern", "visible": true }, { "name": "quantity", "visible": true, "defaultValue": 1 }, { "name": "shiftDescription", "visible": true }, { "name": "shiftType", "visible": true }, { "name": "isNonBlocking", "visible": false, "defaultValue": false } ] | | --- | ### RosterPositionInstanceCompactFormId #### Definition Allows users to enter in the GUID of a different form that can be used by the Roster Control. When opening a Roster Position Instance this form will be opened instead of the OOTB compact form. #### Usage Enter the GUID of the Roster Position Instance Form. #### Default Value | 71dfa7a4-793a-ef11-a316-002248e15b5b | | --- | ### RosterSettingsConfiguration #### Definition Configure the Roster Setting hierarchy to allow for layered settings from Global to Roster. Interacts with the Roster Setting entity and Roster Settings Power Platform Page. #### Usage Accepts a JSON Array of Roster Setting Configuration objects, specifying the Level in the Hierarchy, Entity information, and Read Only and Hidden Setting values. The FetchXML must be from the perspective of the entity, and should reference the higher levels using alias, such as ‘Level1Id’ and ‘Level1Name’. Use {{recordId}} to filter current record. #### Default Value | [{ "EntityName": "Global", "EntitySchema": null, "Level": 0, "Fetch": null, "ReadOnlySettings": [], "HiddenSettings": [] },{ "EntityName": "Roster", "EntitySchema": "vel_roster", "Level": 1, "Fetch": "", "ReadOnlySettings": [], "HiddenSettings": [] }] | | --- | ### RpiCardHeight (Introduced in v8.1) #### Definition Static value for the RPI Card Height on the Roster Calendar in Pixels (px). #### Usage This setting allows consistency of the RPI cards across the Calendar and helps improves performance with Virtualisation. Clients may adjust this value to suit their needs if more or less information is required to be displayed on the RPI cards. #### Default Value | 70 | | --- | ### RpiFetchXml #### Definition This setting to store the FetchXml for retrieval of RPIs (shifts) to display in the Roster Grid. #### Usage FetchXml generated from Power platform is used to retrieve the RPIs to display in Roster Grid PCF control. #### Default Value | {{startDate}} {{endDate}} | | --- | | | ### ShiftDisplaySettings #### Definition To link the Group By value and Shift Template that is to be displayed when Grid when specific group by is Selected. #### Usage The JSON object contains the key pair value with key being the “Group By” and value being “Shift Display Template Name”. #### Default Value | {"position":"default","persona":"not-position","resource":"not-position","external":"external", "vel_clockingstatus":"clockingtemplate"} | | --- | ### ShiftDisplayTemplates #### Definition Holds the HTML and Templating Languages used to depict how a shift should be displayed in the Roster Calendar #### Usage The Shift Display App Setting is a JSON object of various templates, mapping a template name to HTML that is injected into the Shift. Users can opt to use HTML language as well as inline CSS to control the shift configuration. Pipe data into the shift by using the {{ }} characters and allow to use Custom fields by inputting {{ CustomFields.*custom_field_name*.value }} Note: Custom fields are to be defined in “CustomFields” Appsettings before usage as explained [here](/docs/app-settings#_CustomFields) Note: List of readily available fields is listed [here](/docs/app-settings#_Appendix_A). #### Default Value | { "default":"
{{fromDateTimeString}} - {{toDateTimeString}}
{{shift}}
{{shiftType}}
", "not-position":"
{{RosterPosition.Name}}
{{fromDateTimeString}} - {{toDateTimeString}}
{{shift}}
{{shiftType}}
", "external":"
{{Roster.Name}}
{{fromDateTimeString}} - {{toDateTimeString}}
{{shift}}
{{shiftType}}", "clockingtemplate":"
{{Name}}
Position: {{ RosterPosition.Name }}
Clocking Status: {{ CustomFields.vel_clockingstatus.value }}
{{fromDateTimeString}} - {{toDateTimeString}}
{{shift}}
{{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 | |