Parameters¶
The tables below contains a record of all the Parameters.
Warning
Changes to the default settings should be tested prior to implementing any changes into a live environment.
Note
Each parameter has an 'access_permission' value which determines how any updates to the parameter will be processed by the system when it is in operation. Access Permission can take the following values:
- RESTARTUPDATE: To indicate that any changes to the parameter will be picked up on service / application restart.
- DYNAMICUPDATE: To indicate that any changes will be picked up dynamically after a period of time.
- LOADUPDATE: To indicate that changes to parameters are picked up when new LOAD data is submitted.
Note
Each parameter has a 'parameter_class' value which determines whether that parameter is set by the system or organisation. If the Parameter Class is set to system then this parameter is only configurable by the Head Organisation, if the Parameter Class is set to organisation then the parameter is configurable by the Head Organisation and Sub Organisations. Parameter Class can take the following values:
- SYS: Indicates that the parameter is set at a system level.
- ORG: Indicates that the parameter is set at a organisational level.
Application: ABE¶
| Parameter ID | Access | Data Type | Group | Class |
|---|---|---|---|---|
| AppointmentFallbackProfileId Description: Profile to use for travel calculation during appointment booking when a travel has not previously been calculated | LOADUPDATE | STRING | TRAVEL | ORG |
| CheckForChangesSeconds Default Value: 1 Description: How often the ABE checks for changes on datasets it is already processing. | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| CheckForDatasetsSeconds Default Value: 5 Description: The frequency of ABE checks for new datasets. | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| CheckForOutputChangesSeconds Default Value: 5 Description: The frequency to check for output updates. | LOADUPDATE | INTEGER | ADMIN | SYS |
| DoNotPutActivitiesInJeopardy Default Value: false Description: If set to true, appointments will not be offered if they cause other activities to be moved into jeopardy. | LOADUPDATE | BOOLEAN | CONFIG | ORG |
| MaxDisplaceableActivityPriority Default Value: -1 Description: ABE Maximum Displaceable Activity Priority | LOADUPDATE | INTEGER | CONFIG | ORG |
| MaximumInvalidPositionsInRoute Default Value: 20 Description: The maximum failed insertion attempts for a single route. | LOADUPDATE | INTEGER | CONFIG | ORG |
| MaximumLinkedCallAttempts Default Value: 3 Description: The maximum number of attempts used to allocate any linked calls for each position tried for the main call. | LOADUPDATE | INTEGER | CONFIG | ORG |
| MaximumThreadsPerDataset Default Value: (P/D)+1 Description: Maximum number of threads to create for each dataset the ABE is processing. | LOADUPDATE | STRING | ADMIN | SYS |
| MaximumVisitCostReliefProportion Default Value: 0.5 Description: The maximum visit cost relief applicable due to low priority activities | LOADUPDATE | DOUBLE | CONFIG | ORG |
| MinimumAppointmentSlotsPerThread Default Value: -1 Description: Minimum appointment slots per thread when processing appointments in parallel. With the default value of -1 the engine will automatically detemine the optimal number of threads to use. | LOADUPDATE | INTEGER | ADMIN | SYS |
| MinimumNumberOfNearbyResourcesToConsider Default Value: 5 Description: The ABE will only consider allocating to this min. number of nearby resources. | LOADUPDATE | INTEGER | CONFIG | ORG |
| OptimiserDiagnosticOptions Description: A filename in which to hold optimiser diagnostic information. | LOADUPDATE | STRING | ADMIN | SYS |
| Port Default Value: 1365 Description: The port to use for remoting. | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| PreloadHTMRoutingAreas Default Value: True Description: When HTM routing is enabled, this will preload the routing areas around each scheduled location to improve performance when processing appointments. | LOADUPDATE | BOOLEAN | CONFIG | ORG |
| RefreshTravelCacheInterval Default Value: P7D Description: Determines how often unnecessary travels are removed from the travel cache | LOADUPDATE | TIMESPAN | ADMIN | SYS |
| ScheduleWindowStartBuffer Default Value: PT0S Description: The Appointment Booking Engine will move the schedule time forward by the specified value when considering appointment slots, to allow a buffer for accepted offers to be scheduled. | LOADUPDATE | TIMESPAN | CONFIG | ORG |
| TravelTimeToAllow Default Value: PT10M Description: Only allocate to routes which have sufficient time + this travel time. | LOADUPDATE | TIMESPAN | CONFIG | ORG |
| UseFallbackProfileForAppointmentSummary Default Value: false Description: Enables use of the appointment fallback profile for calculating appointment summaries | LOADUPDATE | BOOLEAN | CONFIG | ORG |
Application: ADM¶
| Parameter ID | Access | Data Type | Group | Class |
|---|---|---|---|---|
| ApplicationInstanceStatusRetentionSeconds Default Value: 7200 Description: Age of Application instance statuses to retain in seconds. | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| ARPSystemDataRetention Default Value: P7D Description: Determines how long system data records are kept before being deleted. | DYNAMICUPDATE | TIMESPAN | ADMIN | SYS |
| AutoReload Default Value: False Description: Automatic reload option. | LOADUPDATE | BOOLEAN | AUTOMATION | ORG |
| AutoReloadTimeOfDay Default Value: PT0H Description: Automatic reload time of day. | LOADUPDATE | TIMESPAN | AUTOMATION | ORG |
| AutoRestartServices Default Value: False Description: Scheduling Administration Service automatically restarts selected services | RESTARTUPDATE | BOOLEAN | ADMIN | SYS |
| CheckForChangesSeconds Default Value: 10 Description: The frequency of Scheduling Administration Service checks for changes to datasets | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| CheckForDatasetsSeconds Default Value: 5 Description: The frequency of Scheduling Administration Service checks for new datasets | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| CheckForEventsSeconds Default Value: 600 Description: The frequency of Scheduling Administration Service checks for system changes to the database | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| CheckForNewApplicationsSeconds Default Value: 20 Description: The frequency of Scheduling Administration Service checks for new applications to monitor | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| CheckForOldFilesSeconds Default Value: 1800 Description: The frequency of Scheduling Administration Service checks for old files to delete | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| CheckForUserXmlSeconds Default Value: 60 Description: The frequency the Scheduling Administration Service checks for new User XML entries. | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| CheckInExpiredTime Default Value: PT2M Description: Defines the amount of time that must have passed since a service has checked in for the service to be deemed inactive | DYNAMICUPDATE | TIMESPAN | ADMIN | SYS |
| CheckLicenceFrequency Default Value: PT1H Description: Frequency of licence limit checks | DYNAMICUPDATE | TIMESPAN | ADMIN | SYS |
| CheckRequiredServices Default Value: false Description: Check that the required services are active. | DYNAMICUPDATE | BOOLEAN | ADMIN | SYS |
| CheckRequiredServicesFrequency Default Value: PT10M Description: The frequency at which the service check will run. | DYNAMICUPDATE | TIMESPAN | ADMIN | SYS |
| DailyCheckTimeOfDay Default Value: PT3H Description: The time of day for the admin service to carry out any daily checks. | RESTARTUPDATE | TIMESPAN | ADMIN | SYS |
| DataCacheRowsPerDeleteTransaction Default Value: 20 Description: The number of rows to delete per transaction when deleting from the Data_Cache table. | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| DeleteDatasetStatusSeconds Default Value: 3600 Description: Dataset_Status records older than this will be deleted | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| DeleteFileMask Description: Comma separated list of masks for deletion. | DYNAMICUPDATE | STRING | ADMIN | SYS |
| DeleteFolderList Description: Comma separated list of directories with full UNC path names. | DYNAMICUPDATE | STRING | ADMIN | SYS |
| DeleteInactiveOrganisationsPeriod Default Value: P14610D Description: Amount of time before deleting inactive organisations | DYNAMICUPDATE | TIMESPAN | ADMIN | SYS |
| DeleteOrganisationGracePeriod Default Value: PT1H Description: The grace period after an organisation has been marked for deletion before which deletion will not commence. | DYNAMICUPDATE | TIMESPAN | ADMIN | SYS |
| DeleteStatisticsAfter Default Value: PT1H Description: Delete monitoring statistics after this time | DYNAMICUPDATE | TIMESPAN | ADMIN | SYS |
| ExpiredDatasetRetentionSeconds Default Value: 172800 Description: Datasets expired for longer than this are deleted | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| ExpirePausedDatasetSeconds Default Value: 86400 Description: Datasets paused for longer than this are expired | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| FailLoadingInputSeconds Default Value: 300 Description: Inputs loading for longer than this are failed | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| FailLoadingPlanSeconds Default Value: 300 Description: Plans loading for longer than this are failed | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| FileRetentionDays Default Value: 30 Description: Files older than this number of days will be deleted. | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| InactiveSessionLogoutSeconds Default Value: 3600 Description: The Scheduling Administration Service logs out Sessions that have not been accessed for longer than this | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| InputRetentionSeconds Default Value: 86400 Description: Age of input (before latest initial load) to retain. | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| LicenceNotificationEmailAddresses Description: Comma-separated list of email addresses for licence limit notifications | DYNAMICUPDATE | STRING | SECURITY | ORG |
| LicenceNotificationEmails Default Value: false Description: Email notifications sent when licence limits are exceeded | DYNAMICUPDATE | BOOLEAN | SECURITY | ORG |
| LicenceNotificationLanguageId Default Value: en Description: The language used when sending licence email notifications | DYNAMICUPDATE | STRING | SECURITY | ORG |
| LicenceNotificationSMTPAddress Description: SMTP client address for licence notifications | DYNAMICUPDATE | STRING | SECURITY | ORG |
| LicenceNotificationSMTPHost Description: SMTP host server for licence notifications | DYNAMICUPDATE | STRING | SECURITY | ORG |
| LicenceNotificationSMTPName Description: SMTP client name for licence notifications | DYNAMICUPDATE | STRING | SECURITY | ORG |
| LicenceNotificationSMTPPassword Description: SMTP password for licence notifications | DYNAMICUPDATE | MASKED | SECURITY | ORG |
| LicenceNotificationSMTPUserId Description: SMTP user id for licence notifications | DYNAMICUPDATE | STRING | SECURITY | ORG |
| LogAdditionalEvents Default Value: False Description: Admin service logs additional diagnostic events if true | RESTARTUPDATE | BOOLEAN | ADMIN | SYS |
| OutputRetentionSeconds Default Value: 86400 Description: Age of output (before latest complete plan) to retain. | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| PauseInactiveDatasetSeconds Default Value: 86400 Description: Datasets inactive for longer than this are paused | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| Port Default Value: 1372 Description: The port to use for remoting. | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| RowsPerDeleteTransaction Default Value: 10000 Description: Maximum number of rows to delete from a table in one transaction | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| RunSystemTest Default Value: False Description: Determines whether a regular system test should be run by the Scheduling Administration Service. | DYNAMICUPDATE | BOOLEAN | ADMIN | SYS |
| RunSystemTestSeconds Default Value: 3600 Description: Determines the frequency with which the system test will be run. | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| ServerRequestRetentionSeconds Default Value: 604800 Description: Age of Server_Request row to retain. | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| SessionRetentionSeconds Default Value: 86400 Description: The Scheduling Administration Service deletes logged-out Sessions older than this | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| SMSAddress Default Value: http://{0}:8001/ThreeSixty.ServiceManagement/ServiceManager/ Description: The Scheduling Service Manager address to use when restarting services. | RESTARTUPDATE | STRING | ADMIN | SYS |
| SMSBinding Default Value: BINDING_WS_HTTP_SECURITY_NONE Description: The Scheduling Service Manager binding to use when restarting services. | RESTARTUPDATE | STRING | ADMIN | SYS |
| SystemAccessHistoryRetention Default Value: P6M Description: Determines how long system access history records are kept before being deleted. | DYNAMICUPDATE | TIMESPAN | ADMIN | SYS |
| SystemDataCacheRetention Default Value: P7D Description: Determines how long system data cache records are kept before being deleted. | DYNAMICUPDATE | TIMESPAN | ADMIN | SYS |
| SystemEventRetentionSeconds Default Value: 604800 Description: Age of System_Event row to retain. | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| SystemHistoryRetentionSeconds Default Value: 604800 Description: Age of system history data row to retain. | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| SystemStatusEventWindow Default Value: PT10M Description: Determines the window to include system events from (before the current time) when broadcasting system status and system events. | RESTARTUPDATE | TIMESPAN | ADMIN | SYS |
| SystemStatusRetentionSeconds Default Value: 86400 Description: Determines how long system status records are kept before being deleted. | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| SystemStatusUpdateFrequency Default Value: PT2M Description: How frequently the system status and related data is updated. | DYNAMICUPDATE | TIMESPAN | ADMIN | SYS |
| SystemTestAllocationTypes Default Value: 27 Allowed Values: 1 = DSE Plan; 2 = Appointment Offers; 8 = Dispatch Suggestions; 16 = Travel Detail Description: The allocation types to expect output for | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| SystemTestDatasetId Default Value: SystemSmokeTest Description: The dataset ID to run the system test against. | DYNAMICUPDATE | STRING | ADMIN | SYS |
| SystemTestTimeLimit Default Value: PT2M Description: The maximum time to allow for the system test to complete with all broadcasts received. | DYNAMICUPDATE | TIMESPAN | ADMIN | SYS |
| UnregisterApplicationOnFailCount Default Value: 3 Description: Number of consecutive ping failures before unregistering monitored apps | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| UsageCounterRetentionDays Default Value: 50 Description: The number of days after which individual usage counter rows should be deleted. | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| UserXmlFolder Description: Folder to write User XML entries out to. | DYNAMICUPDATE | STRING | ADMIN | SYS |
Application: ALL¶
| Parameter ID | Access | Data Type | Group | Class |
|---|---|---|---|---|
| ActiveDirectoryDomain Description: If specified Active Directory is used to authenticate accounts for this domain. | DYNAMICUPDATE | STRING | ADMIN | SYS |
| AddSLTravelToNode Default Value: True Description: Add Straight Line travel from location to node to database travel. | LOADUPDATE | BOOLEAN | TRAVEL | ORG |
| AllowAuthenticationGateway Default Value: False Description: Authentication gateway allowed flag | DYNAMICUPDATE | BOOLEAN | SECURITY | ORG |
| AllowLocationlessActivities Default Value: False Description: Whether to allow locationless activities that are not fixed to a specific resource. | LOADUPDATE | BOOLEAN | CONFIG | ORG |
| BulkInsert Default Value: True Description: A folder on the database server in which bulk insert files may be created. | RESTARTUPDATE | BOOLEAN | ADMIN | SYS |
| CapabilityUpdateFrequency Default Value: PT10M Description: Frequency for updating the capability of an instance | DYNAMICUPDATE | TIMESPAN | ADMIN | SYS |
| CapabilityUpdateLeeway Default Value: 0.05 Description: Percentage leeway when updating an instance capability | DYNAMICUPDATE | DOUBLE | ADMIN | SYS |
| CheckForSoftRestartSeconds Default Value: 10 Description: Frequency for checking for soft restart requests | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| CloseMetresAbsolute Default Value: 0 Description: DB/SL comparison allowed metre difference. | LOADUPDATE | DOUBLE | TRAVEL | ORG |
| CloseMetresRatio Default Value: 0.25 Description: DB/SL comparison allowed metre difference in ratio to SL distance. | LOADUPDATE | DOUBLE | TRAVEL | ORG |
| CloseSecondsAbsolute Default Value: 0 Description: DB/SL comparison allowed seconds difference. | LOADUPDATE | DOUBLE | TRAVEL | ORG |
| CloseSecondsRatio Default Value: 0.05 Description: DB/SL comparison allowed seconds difference in ratio to SL time. | LOADUPDATE | DOUBLE | TRAVEL | ORG |
| CommitToAvailabilityWindow Default Value: False Description: Determines whether activities should be kept in the availability window they are allocated in when manually committing. | DYNAMICUPDATE | BOOLEAN | WORKBENCH | ORG |
| DatasetAvailability Default Value: 1 Description: The target dataset availability when load balancing. | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| DefaultBroadcastAuthentication Default Value: Basic Allowed Values: Basic; Windows Description: Defines the default broadcast authentication type | LOADUPDATE | STRING | SECURITY | ORG |
| EstimateMissingTravels Default Value: False Description: If true then missing travels are estimated as the crow flies. | LOADUPDATE | BOOLEAN | TRAVEL | ORG |
| EventLogThrottle Default Value: 10 Description: Limit for the number of events of the same type that are logged within a minute. | LOADUPDATE | INTEGER | ADMIN | SYS |
| EventPublishApiId Description: The Azure Log Analytics Workspace identifier. This defines where Event Logs are published when EventPublishMode is AzureMonitor. | DYNAMICUPDATE | STRING | ADMIN | SYS |
| EventPublishApiKey Description: The Azure Log Analytics Workspace primary key. This defines where Event Logs are published when EventPublishMode is AzureMonitor. | DYNAMICUPDATE | STRING | ADMIN | SYS |
| EventPublishLoggingLevel Default Value: Warning Allowed Values: Information = Log events of severity Information and above; Warning = Log events of severity Warning and above; Error = Log events of severity Error and above Description: Defines the minimum severity of system Events to publish | DYNAMICUPDATE | STRING | ADMIN | SYS |
| EventPublishMode Default Value: WindowsEventLog Allowed Values: WindowsEventLog = Specifies that events are published to the Windows Event Log; AzureMonitor = Specifies that events are published to the Azure Event Monitor Description: Defines the location that log events are published to | DYNAMICUPDATE | STRING | ADMIN | SYS |
| Features Description: Organisation-scoped feature flags. Comma-separated list of flag IDs; prefix with - to explicitly disable. | DYNAMICUPDATE | STRING | ADMIN | ORG |
| HashingMethod Default Value: 4 Allowed Values: 1 = MD5 algorithm; 2 = SHA1 algorithm; 3 = SHA256 algorithm; 4 = SHA512 algorithm Description: Hashing method for new password. | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| HierarchicalDatabaseMatrixId Description: The identifier of the matrix you wish to use | LOADUPDATE | STRING | TRAVEL | ORG |
| HTMDiagnosticsPath Description: Hierarchal Travel Matrix diagnostics path | RESTARTUPDATE | STRING | ADMIN | SYS |
| HTMTimingDiagsPath Description: Hierarchical Travel Matrix timings diagnostics path | LOADUPDATE | STRING | ADMIN | SYS |
| IgnoreSpatialKeyLevel Default Value: 11 Description: The SpatialKeyLevel at which snapping stops. | LOADUPDATE | INTEGER | TRAVEL | ORG |
| InitialSpatialKeyLevel Default Value: 5 Description: SpatialKeyLevel at which the snap algorithm starts. | LOADUPDATE | INTEGER | TRAVEL | ORG |
| InitialWindiness Default Value: 1.5 Description: Windiness to apply at MaxWindinesMetres | LOADUPDATE | DOUBLE | TRAVEL | ORG |
| KeepCacheRatio Default Value: 4.5 Description: Ratio of new/additional travels to add to the current cache | LOADUPDATE | DOUBLE | TRAVEL | ORG |
| LicenceKey Description: Scheduling Products licence key | RESTARTUPDATE | STRING | SECURITY | ORG |
| LoadBalancingExclusionEnd Default Value: PT0H Description: The time of day (based on server time) after which load balancing may resume. | DYNAMICUPDATE | TIMESPAN | ADMIN | SYS |
| LoadBalancingExclusionStart Default Value: PT0H Description: The time of day (based on server time) from which no load balancing will take place. | DYNAMICUPDATE | TIMESPAN | ADMIN | SYS |
| LoadBalancingSensitivityFactor Default Value: 1.3 Description: Higher values will discourage datasets from being moved for load balancing purposes. | DYNAMICUPDATE | DOUBLE | ADMIN | SYS |
| LoadBalancingWaitingOverloadFactor Default Value: 2.2 Description: Used in the Schedule Distribution Service when determining whether a WAITING dataset should be set to RUNNING, to limit how much each DSE can be overloaded. Use -1 to turn off waiting functionality. | DYNAMICUPDATE | DOUBLE | ADMIN | SYS |
| LocationAddTime Default Value: PT0S Description: All travel times between different locations have this buffer added | LOADUPDATE | TIMESPAN | TRAVEL | ORG |
| LogStatistics Default Value: False Description: Log system and service statistics | DYNAMICUPDATE | BOOLEAN | ADMIN | SYS |
| LogStatisticsFrequency Default Value: PT5M Description: Set how often statistics are logged. | DYNAMICUPDATE | TIMESPAN | ADMIN | SYS |
| LoseCacheRatio Default Value: 1.5 Description: Ratio of lost/additional travels to replace the current cache | LOADUPDATE | DOUBLE | TRAVEL | ORG |
| MachineIdFormat Default Value: 0 Allowed Values: 0 = Machine Name; 1 = Internal IP Address; 2 = Azure Machine Name Description: The machine id format to use when registering and in remoting strings. | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| MaxCacheSizeForAdvanceGetTravels Default Value: -1 Description: Sets a maximum number of travels to be stored in the travel cache when fetching HTM travels in advance. When the limit is reached, travels will instead be fetched on demand. | LOADUPDATE | INTEGER | TRAVEL | ORG |
| MaxDistanceMetres Default Value: 600 Description: Maximum distance for short (crow flies) travel calculation. Max distance for high density hierarchy levels are adjusted automatically. | LOADUPDATE | DOUBLE | TRAVEL | ORG |
| MaxLogonFailures Default Value: 5 Description: Number of consecutive logon failures before user disabled. | DYNAMICUPDATE | INTEGER | SECURITY | ORG |
| MaxPossibleSpeedMPS Default Value: 40 Description: Maximum possible speed in metres per second. Used when accessing if a resource could be sent to an activity. | LOADUPDATE | DOUBLE | TRAVEL | ORG |
| MaxRetainedPasswords Default Value: 0 Description: Maximum number of old passwords to retain. | DYNAMICUPDATE | INTEGER | SECURITY | ORG |
| MaxSpeedMPS Default Value: 26 Description: Maximum speed in metres per second. Used when calculating the duration of a travel. | RESTARTUPDATE | DOUBLE | TRAVEL | ORG |
| MaxUserSessions Default Value: -1 Description: The maximum allowed sessions per user before existing sessions are closed; both Workbench and Gateway sessions count towards this value. -1 means unlimited. | DYNAMICUPDATE | INTEGER | CONFIG | ORG |
| MaxWindinessMetres Default Value: 2000 Description: Distance where InitialWindiness applies | LOADUPDATE | DOUBLE | TRAVEL | ORG |
| MetricSources Default Value: Microsoft.AspNetCore.Hosting,Ifs. Description:* The metric sources captured | DYNAMICUPDATE | STRING | ADMIN | SYS |
| MinimumTravelSeconds Default Value: 0 Description: Minimum travel time in seconds. | LOADUPDATE | DOUBLE | TRAVEL | ORG |
| MinimumWindiness Default Value: 1.178 Description: Minimum windiness to apply | LOADUPDATE | DOUBLE | TRAVEL | ORG |
| MinPasswordCharacterCategories Default Value: 3 Description: Minimum number of character categories in a new password. | DYNAMICUPDATE | INTEGER | SECURITY | ORG |
| MinPasswordLength Default Value: 8 Description: Minimum number of characters in a new password. | DYNAMICUPDATE | INTEGER | SECURITY | ORG |
| MinSpeedMPS Default Value: 12.35 Description: Initial speed for Straight Line travel. | LOADUPDATE | DOUBLE | TRAVEL | ORG |
| OldPasswordRetention Default Value: P0D Description: Duration to retain old passwords. | DYNAMICUPDATE | TIMESPAN | SECURITY | ORG |
| OpenIdAuthority Description: OpenID Connect Authority URI | DYNAMICUPDATE | STRING | CONFIG | ORG |
| OpenIdAuthorityThumbprint Description: OpenID Connect Authority certificate thumbprint | DYNAMICUPDATE | STRING | CONFIG | ORG |
| OpenIdCacheDuration Default Value: PT10M Description: The length of time to keep OpenId parameters cached before fetching again | DYNAMICUPDATE | TIMESPAN | CONFIG | ORG |
| OpenIdClientId Description: OpenID Connect registered Client ID | DYNAMICUPDATE | STRING | CONFIG | ORG |
| OpenIdClientSecret Description: OpenID Client Secret | DYNAMICUPDATE | STRING | CONFIG | ORG |
| OpenIdResourceId Description: OpenID Connect registered Resource ID | DYNAMICUPDATE | STRING | CONFIG | ORG |
| OpenIdScope Default Value: openid Description: OpenID Connect Scope | DYNAMICUPDATE | STRING | CONFIG | ORG |
| ParameterUpdateFrequency Default Value: PT1M Description: Frequency for updating the parameters in a service | DYNAMICUPDATE | TIMESPAN | ADMIN | SYS |
| PasswordCannotContainId Default Value: False Description: Password cannot contain user id flag. | DYNAMICUPDATE | BOOLEAN | SECURITY | ORG |
| PasswordCannotContainNamePart Default Value: False Description: Password cannot contain 3 consecutive characters from user name flag. | DYNAMICUPDATE | BOOLEAN | SECURITY | ORG |
| PasswordExpiryWarningPeriod Default Value: P0D Description: Duration before password expiry when logon returns warning. | DYNAMICUPDATE | TIMESPAN | SECURITY | ORG |
| PasswordValidityPeriod Default Value: P0D Description: Duration before password expires. | DYNAMICUPDATE | TIMESPAN | SECURITY | ORG |
| PickupPartsAtEndOfActivity Default Value: True Description: Determines whether or not a part pickup should occur at the end of an activity or at the start. | LOADUPDATE | BOOLEAN | CONFIG | ORG |
| RateOfSpeedIncrease Default Value: 0.0000188 Description: Straight Line speed increase over distance. | LOADUPDATE | DOUBLE | TRAVEL | ORG |
| RealTimeTravelAvoidHighways Default Value: False Description: Specify whether to avoid highways | LOADUPDATE | BOOLEAN | TRAVEL | ORG |
| RealTimeTravelAvoidTolls Default Value: False Description: Specify whether to avoid tolls | LOADUPDATE | BOOLEAN | TRAVEL | ORG |
| RealTimeTravelCacheGranularity Default Value: PT5M Description: The granularity used for the travel start time when looking up cached real time travels. | LOADUPDATE | TIMESPAN | TRAVEL | ORG |
| RealTimeTravelMaxCallsPerSecond Default Value: -1 Description: Maximum number of calls per second for Real Time Travel calculations | LOADUPDATE | INTEGER | CONFIG | ORG |
| RealTimeTravelProvider Default Value: NONE Allowed Values: TOMTOM = TOMTOM; NONE = NONE Description: Specifies the provider for RealTimeTravel | LOADUPDATE | STRING | TRAVEL | ORG |
| RealTimeTravelRefreshCacheFrequency Default Value: PT10M Description: Rate at which the cache of real time travels is refreshed | LOADUPDATE | TIMESPAN | TRAVEL | ORG |
| ReportTravelStatistics Default Value: False Description: Diagnostic use only. | LOADUPDATE | BOOLEAN | TRAVEL | ORG |
| RoundTravelsToSecondAndMetre Default Value: true Description: Whether or not to round travel values to the nearest metre and second. | LOADUPDATE | BOOLEAN | TRAVEL | ORG |
| RoutingApiKey Description: The Api key required for making routing calls | LOADUPDATE | STRING | TRAVEL | ORG |
| RoutingCalculator Default Value: TravelAnalyser Allowed Values: InProcess = In Process; TravelAnalyser = Scheduling Travel Analyser Description: Routing travel calculator | LOADUPDATE | STRING | ADMIN | SYS |
| RoutingMaximumDistanceMeters Default Value: 4000 Description: Only change this when advised to do so by IFS. | LOADUPDATE | DOUBLE | SUPPORT | ORG |
| RoutingMaximumSearchMetersMultiplier Default Value: 2.0 Description: Only change this when advised to do so by IFS. | LOADUPDATE | DOUBLE | SUPPORT | ORG |
| RoutingRestrictedPenaltySeconds Default Value: 1800 Description: Amount of penalty for entering a restricted road | LOADUPDATE | INTEGER | CONFIG | ORG |
| ServiceCheckInTime Default Value: PT10S Description: Defines how often a service checks in with the database, updating last_checked_in in the Application_Instance table | DYNAMICUPDATE | TIMESPAN | ADMIN | SYS |
| SortValuePrecedenceMaximumStatus Default Value: 30 Allowed Values: 30 = Committed; 32 = Sent; 35 = Downloaded; 40 = Accepted Description: The maximum status for which commit sort value takes precedence over status on committed calls | LOADUPDATE | INTEGER | CONFIG | ORG |
| SpeedFactor Default Value: 1 Description: All travel times are multiplied by this factor. | LOADUPDATE | DOUBLE | TRAVEL | ORG |
| StraightLineOnError Default Value: False Description: If true then StraightLine estimate is used if error detected. | LOADUPDATE | BOOLEAN | TRAVEL | ORG |
| SystemFeatures Description: System-wide feature flags. Comma-separated list of flag IDs; prefix with - to explicitly disable. | DYNAMICUPDATE | STRING | ADMIN | SYS |
| TokenMaximumAge Default Value: P1D Description: Maximum age of an OpenID token | RESTARTUPDATE | TIMESPAN | ADMIN | SYS |
| TokenSkew Default Value: PT2M Description: Allowed leeway in Token time comparisons | RESTARTUPDATE | TIMESPAN | ADMIN | SYS |
| TracingEndpoint Description: The endpoint used for tracing | DYNAMICUPDATE | STRING | ADMIN | SYS |
| TracingSources Description: The sources captured when tracing | DYNAMICUPDATE | STRING | ADMIN | SYS |
| TravelCalculationOption Default Value: StraightLine Allowed Values: StraightLine; HierarchicalTravelMatrix; FlatEarth; RealTimeTravel Description: The method of computing travel times and distances. | LOADUPDATE | STRING | TRAVEL | ORG |
| TravelClientDiagnosticsPath Description: Travel Client diagnostics path | LOADUPDATE | STRING | ADMIN | SYS |
| TravelHierarchyLevelsToUse Description: Do not change this parameter unless IFS advise you to do so. | LOADUPDATE | STRING | TRAVEL | ORG |
| TravelQueriesRunInParallel Default Value: true Description: Whether or not to run travel database queries in parallel | LOADUPDATE | BOOLEAN | ADMIN | SYS |
| TravelRegionHierarchyLevelThresholds Default Value: 3,500;5,5000;10,30000;20,75000;30,500000;16,30000;34,75000;73,500000 Description: Travel threshold in metres for each hierarchy level when creating a travel region. String format is: "hierarchy level, max distance" with a semicolon separator if more hierarchy levels specified. | LOADUPDATE | STRING | TRAVEL | ORG |
| TravelTimeProfileId Default Value: DEFAULT Description: Time-dependent weightings to apply to travel times. | LOADUPDATE | STRING | TRAVEL | ORG |
| UpdatesCheckLockTimeLimit Default Value: PT15M Description: Sets the time limit for an update check to run for before automated service recovery is triggered. | DYNAMICUPDATE | TIMESPAN | ADMIN | SYS |
| UserIgnorePrefix Description: Prefix to remove from User claim value | DYNAMICUPDATE | STRING | CONFIG | ORG |
| UserIgnoreSuffix Description: Suffix to remove from User claim value | DYNAMICUPDATE | STRING | CONFIG | ORG |
| UserNameClaim Default Value: unique_name Description: OpenID Claim used to identify the User | DYNAMICUPDATE | STRING | CONFIG | ORG |
| WaitingStatusForUnknownDatasets Default Value: False Description: Determines whether to set the state of new datasets to Waiting | DYNAMICUPDATE | BOOLEAN | ADMIN | SYS |
| WarnOnMissingTravel Default Value: True Description: Determines whether a warning will be reported if travels cannot be found. | LOADUPDATE | BOOLEAN | TRAVEL | ORG |
| WindinessDecrease Default Value: 0.0005 Description: Windiness reduction per metre | LOADUPDATE | DOUBLE | TRAVEL | ORG |
Application: ARC¶
| Parameter ID | Access | Data Type | Group | Class |
|---|---|---|---|---|
| ArchiveDefaultTimeZone Description: Default time zone. | RESTARTUPDATE | STRING | CONFIG | ORG |
| ArchiveStandardLabelFormat Default Value: {description} Description: Standard Label Format | DYNAMICUPDATE | STRING | LABEL | ORG |
| AuditRetentionDays Default Value: 30 Description: The number of days audits are retained by the Schedule Archiving Service before they are deleted. | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| AutomatedSnapshotExpiryPeriod Default Value: P7D Description: The expiry period to use when automated snapshots are generated. | DYNAMICUPDATE | TIMESPAN | AUTOMATION | ORG |
| CheckForChangesSeconds Default Value: 300 Description: How often the Schedule Archiving Service checks for changes on datasets it is already processing. | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| CheckForDatasetsSeconds Default Value: 5 Description: The frequency of Schedule Archiving Service checks for new datasets. | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| CheckForExpiredSeconds Default Value: 600 Description: How often the Schedule Archiving Service checks for expired snapshots. | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| CheckForRequestsSeconds Default Value: 60 Description: How often the Schedule Archiving Service checks to see if a snapshot is needed. | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| CheckForSnapshotSeconds Default Value: 60 Description: How often the Schedule Archiving Service checks to see if a snapshot is needed. | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| CheckForUpdateSeconds Default Value: 600 Description: How often the Schedule Archiving Service checks for changes to the snapshot schedule. | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| DeleteExpiredAuditsBatchSize Default Value: 1000 Description: The maximum number of rows to delete in a single batch. | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| DeleteExpiredReportingBatchSize Default Value: 500 Description: The maximum number of rows to delete in a single batch. | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| DeleteExpiredSnapshotsBatchSize Default Value: 50 Description: The maximum number of rows to delete in a single batch. | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| LocationDescriptionFormat Default Value: {Location.name} [{Location.id}] Description: The description format of a ARC_Location row based on columns from Location table in the Scheduling Database. | DYNAMICUPDATE | STRING | CONFIG | ORG |
| LogAdditionalEvents Default Value: False Description: Schedule Archiving Service logs additional diagnostic events if true | RESTARTUPDATE | BOOLEAN | ADMIN | SYS |
| MinimumNumberOfSamplesForActivityDurationEstimate Default Value: 25 Description: Minimum number of samples for activity duration estimate to be calculated | DYNAMICUPDATE | INTEGER | CONFIG | ORG |
| Port Default Value: 8745 Description: The port to use for remoting. | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| ReportingRetentionDays Default Value: 90 Description: The number of days reporting data is retained before it is deleted. | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| ResourceDescriptionFormat Default Value: {Resources.first_name} {Resources.surname} [{Resources.id}] Description: The description format of a ARC_Resource row based on columns from Resources table in the Scheduling Database. | DYNAMICUPDATE | STRING | CONFIG | ORG |
Application: DSE¶
| Parameter ID | Access | Data Type | Group | Class |
|---|---|---|---|---|
| AgeingFactorGranularity Default Value: PT1H Description: The granularity to use when applying ageing factor to activity base values. | LOADUPDATE | TIMESPAN | CONFIG | ORG |
| AllowAllocateBeforeCommitted Default Value: False Description: Permit activities to be scheduled before a committed activity, if possible | LOADUPDATE | BOOLEAN | CONFIG | ORG |
| AllowAllocateWithParallelCommits Default Value: true Description: Whether schedulable activities may be scheduled in parallel with committed activities (to a parallel resource). | LOADUPDATE | BOOLEAN | CONFIG | ORG |
| AllowPartiallyCommittedBucketRoutes Default Value: False Description: Determines whether or not the DSE may schedule further activities into a bucket shift that already contains committed activities. | LOADUPDATE | BOOLEAN | CONFIG | ORG |
| AllowSplitTravel Default Value: True Description: Whether or not travel to an activity can be split either side of a break or PA. | LOADUPDATE | BOOLEAN | CONFIG | ORG |
| AlwaysRaiseUnallocatedException Default Value: False Description: Should unallocated exceptions be raised if unallocation is expected | LOADUPDATE | BOOLEAN | CONFIG | ORG |
| AutoProcessToQuality Default Value: 100 Description: The DSE will process any data until it achieves this plan quality. | LOADUPDATE | DOUBLE | AUTOMATION | ORG |
| BackgroundOptimiseAppointmentWindow Default Value: True Description: When using an appointment window, once the DSE has met all broadcast targets it will also optimise the schedule in the appointment window. | LOADUPDATE | BOOLEAN | CONFIG | ORG |
| BackgroundProcessReactiveTasks Default Value: True Description: If true the DSE will continue to process REACTIVE tasks even after all targets have been reached if it would otherwise be idle. | DYNAMICUPDATE | BOOLEAN | ADMIN | SYS |
| CheckForChangesSeconds Default Value: 1 Description: How often the DSE checks for changes on datasets it is already processing. | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| CheckForDatasetsSeconds Default Value: 5 Description: The frequency of DSE checks for new datasets. | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| CheckLicenceKeyOnServiceStart Default Value: True Description: Whether or not to check the scheduling licence key when the DSE service starts. | RESTARTUPDATE | BOOLEAN | ADMIN | SYS |
| CommittedActivitiesConstraintsOption Default Value: 1 Allowed Values: 0 = No activity time constraints applied.; 1 = All time constraints applied. Description: Determines which constraints are applied to committed activities. | LOADUPDATE | INTEGER | CONFIG | ORG |
| CommittedActivitiesProfileId Description: The profile id to be used for committed activities | LOADUPDATE | STRING | CONFIG | ORG |
| CommittedActivitiesProfileThreshold Default Value: PT1H Description: Timespan over which the CommittedActivitiesProfile is used, measured from the start of the scheduling window | LOADUPDATE | TIMESPAN | CONFIG | ORG |
| CommittedForcedDoOnLocationIncentive Default Value: 10000 Description: Incentive for scheduling an activity with either a hard do on location or do in locality constraint immediately after a committed activity at the same location or locality. | LOADUPDATE | INTEGER | CONFIG | ORG |
| DatasetTypesToProcess Default Value: COMPLETE Allowed Values: COMPLETE; SEGMENT Description: Whether to process complete or segmented datasets. | DYNAMICUPDATE | STRING | ADMIN | SYS |
| DeferAffectedRouteRebuild Default Value: false Description: If set to true, the rebuilding of routes after a change is deferred to the optimisation algorithm. | LOADUPDATE | BOOLEAN | CONFIG | ORG |
| DelayActivityIncrement Default Value: PT5M Description: The increment that is used when attempting to delay an activity | LOADUPDATE | TIMESPAN | CONFIG | ORG |
| DoOnLocationAllowRevisits Default Value: True Description: Can a forced do on location activity be scheduled later when the first visit is unsuitable? | LOADUPDATE | BOOLEAN | CONFIG | ORG |
| DoOnLocationCheckSingleLocation Default Value: False Description: Determines whether the DSE will check the single route location exception condition when applying hard do on location constraints. | LOADUPDATE | BOOLEAN | CONFIG | ORG |
| DSEDiagnosticOptions Default Value: QUALITY=10 Description: DSE diagnostic options. Set to TEXTPLAN=text plans,QUALITY=10. | RESTARTUPDATE | STRING | ADMIN | SYS |
| EarlySLABenefit Default Value: 0 Description: Prefer to schedule a call early (if using SLAs) | LOADUPDATE | DOUBLE | CONFIG | ORG |
| EmptyRoutesExceptionStart Default Value: PT12H Description: The period before the start of a shift which will generate empty route exceptions | LOADUPDATE | TIMESPAN | CONFIG | ORG |
| EnforceConstraintsOnCallEnd Default Value: False Description: Determines whether time constraints should be applied to the activity end time. Applies to activity availabilities, not to SLAs | LOADUPDATE | BOOLEAN | CONFIG | ORG |
| FilterAllocationAttemptsOnUpdate Default Value: True Description: Only change this when advised to do so by IFS. | LOADUPDATE | BOOLEAN | SUPPORT | ORG |
| FixedActivityAfterShiftBuffer Default Value: PT1H Description: The period of time after a shift ends where a fixed activity starting within this period will be considered as belonging to the shift. | DYNAMICUPDATE | TIMESPAN | CONFIG | ORG |
| GpsFrequency Default Value: PT0H5M0S Description: Minimum time between GPS fixes. | LOADUPDATE | TIMESPAN | CONFIG | ORG |
| ImplicitBreaksOnOffEventsRequired Default Value: False Description: If set to true then break on and break off events must be sent to indicate that implicit breaks are being taken. Otherwise the DSE will assume that a break is being taken when the resource is idle in the break window. | DYNAMICUPDATE | BOOLEAN | CONFIG | ORG |
| IncrementalProcessingLeeway Default Value: PT0S Description: The amount of time between the end of two activity pools for them to both be considered to be completed when using incremental processing. | LOADUPDATE | TIMESPAN | CONFIG | ORG |
| LogonMaxAdvance Default Value: P1D Description: Limits the lead time the shift start can be moved if early logon. | LOADUPDATE | TIMESPAN | CONFIG | ORG |
| MaximumIndirectActivityLinksToProcess Default Value: 50 Description: Only change this when advised to do so by IFS. | DYNAMICUPDATE | INTEGER | SUPPORT | ORG |
| MaximumLoadBalancingDelay Default Value: PT30S Description: Small or 100% quality datasets may not be suspended for longer than this | RESTARTUPDATE | TIMESPAN | ADMIN | SYS |
| MaximumThreadsPerDataset Default Value: PF Description:* Maximum number of threads to create for each dataset the DSE is processing. | LOADUPDATE | STRING | ADMIN | SYS |
| MaxTravelAppliesToAllJourneys Default Value: True Description: Whether to apply max travel constraint to individual journeys. | LOADUPDATE | BOOLEAN | CONFIG | ORG |
| MinimumClustersPerActivity Default Value: 3 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | SYS |
| MinimumStepInterval Default Value: PT0H1M0S Description: Minimum interval between writing plans to database. | LOADUPDATE | TIMESPAN | ADMIN | SYS |
| NotLoggedOnDelayPeriod Default Value: PT0M Description: Not Logged On Delay Period | LOADUPDATE | TIMESPAN | CONFIG | ORG |
| OptimisationAlgorithm Default Value: 0 Allowed Values: 0 = Automatically select the best optimisation algorithm; 2 = Single-threaded quantum scheduling; 8 = Multi-threaded quantum scheduling; 18 = Genetic scheduling; 15 = Quick intelligent scheduling; 23 = Non-clustered scheduling; 21 = Bee scheduling; 13 = Manual scheduling; 25 = Multi-threaded clustered scheduling; 34 = Clustered scheduling Description: The algorithm to be used for scheduling. Zero means the DSE chooses. | LOADUPDATE | INTEGER | CONFIG | ORG |
| OptimiserAdvancedOptions Default Value: 6 Allowed Values: 1 = Hyper-heuristic; 2 = Predictive laziness; 4 = Probabilistic change types Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserAllocateMoveWeight Default Value: 500 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserAllocationWeight Default Value: 500 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserAPMCheckForNearbyHotSpotsRadius Default Value: 5 Description: Only change this when advised to do so by IFS. | LOADUPDATE | DOUBLE | SUPPORT | ORG |
| OptimiserAPMHotSpotRadius Default Value: 5 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserAPMHotSpotsToReturn Default Value: 100 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserAPMMaxAgentsToAddPerCycle Default Value: 100 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserAPMMaxAgentsToRemovePerCycle Default Value: 10 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserAPMMetresPerHotspotGridPoint Default Value: 10000 Description: Only change this when advised to do so by IFS. | LOADUPDATE | DOUBLE | SUPPORT | ORG |
| OptimiserAPMMinHotspotGridPoints Default Value: 50 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserAPMPlanQuality Default Value: 70 Description: The plan quality to wait for from the scheduling algorithm when using the WISE or Cyclic Scheduling. | LOADUPDATE | DOUBLE | CONFIG | ORG |
| OptimiserAPMRandomnessProportionChoosingAgentType Default Value: 0.2 Description: Only change this when advised to do so by IFS. | LOADUPDATE | DOUBLE | SUPPORT | ORG |
| OptimiserAPMTimeLimit Default Value: P7D Description: The default maximum time to wait for a WISE cycle or Cyclic Scheduling schedule to complete. | LOADUPDATE | TIMESPAN | CONFIG | ORG |
| OptimiserBeesMistakeRate Default Value: 0.01 Description: Only change this when advised to do so by IFS. | LOADUPDATE | DOUBLE | SUPPORT | ORG |
| OptimiserBeesUnconvincedRate Default Value: 0.1 Description: Only change this when advised to do so by IFS. | LOADUPDATE | DOUBLE | SUPPORT | ORG |
| OptimiserChangeDepotVisitWeight Default Value: 500 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserChangesSampleLength Default Value: 100 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserChangeWeight Default Value: 1000 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserClusterAllocationWeight Default Value: 500 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserClusteringMethod Default Value: 0 Allowed Values: 0 = Chosen automatically; 1 = Spatial; 2 = Constraints; 4 = Temporal; 255 = Combined Description: The method used to create clusters. | LOADUPDATE | INTEGER | CONFIG | ORG |
| OptimiserClusteringOptions Default Value: 15 Allowed Values: 1 = Balanced; 2 = Population-based; 4 = Condensed; 8 = Regenerate every time Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserClusterReallocationWeight Default Value: 2000 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserClusterSizeIncreaseQualityThreshold Default Value: 40 Description: Only change this when advised to do so by IFS. | LOADUPDATE | DOUBLE | SUPPORT | ORG |
| OptimiserCombinedTrySplitLargeClusters Default Value: True Description: Only change this when advised to do so by IFS. | LOADUPDATE | BOOLEAN | SUPPORT | ORG |
| OptimiserCoolingRate Default Value: 0.99 Description: Only change this when advised to do so by IFS. | LOADUPDATE | DOUBLE | SUPPORT | ORG |
| OptimiserDeallocationWeight Default Value: 50 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserDefaultIntelligenceFactor Default Value: 2.5 Description: Only change this when advised to do so by IFS. | LOADUPDATE | DOUBLE | SUPPORT | ORG |
| OptimiserDelayOperationWeight Default Value: 500 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserDelayVisitWeight Default Value: 500 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserDeleteriousChangesThreshold Default Value: 200 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserDiagnosticOptions Description: A filename in which to hold optimiser diagnostic information. Blank=none. | LOADUPDATE | STRING | ADMIN | SYS |
| OptimiserFillRouteByPreferredTimeWeight Default Value: 0 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserFillRouteWeight Default Value: 500 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserFlexibleChangeDetails Description: Configurable details of the Flexible change type. Only change this when advised to do so by IFS. | LOADUPDATE | STRING | SUPPORT | ORG |
| OptimiserFlexibleChangeWeight Default Value: 0 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserForcedDeallocationWeight Default Value: 10 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserForcedMaxCallsForForcedUnallocation Default Value: 10 Description: Only change this when advised to do so by IFS. | LOADUPDATE | DOUBLE | SUPPORT | ORG |
| OptimiserForcedRouteClearWeight Default Value: 10 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserForcedStickyDeallocationStickiness Default Value: 500 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserForcedStickyDeallocationWeight Default Value: 10 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserGeneticCallBombWeight Default Value: 20 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserGeneticChangeProbability Default Value: 0.5 Description: Only change this when advised to do so by IFS. | LOADUPDATE | DOUBLE | SUPPORT | ORG |
| OptimiserGeneticCrossOverWeight Default Value: 20 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserGeneticMaxBombSize Default Value: 40 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserGeneticMaxRoutesToClear Default Value: 12 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserGeneticMinimumPopulation Default Value: 6 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserGeneticNearbyRouteClearWeight Default Value: 10 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserGeneticPartialRouteClearWeight Default Value: 10 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserGeneticRouteClearWeight Default Value: 10 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserGeneticThreshold Default Value: 10 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserGeneticTimeBombWeight Default Value: 20 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserGeographicSwapWeight Default Value: 2000 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserImproveParallelOptimisationsWeight Default Value: 500 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserIncrementalTimeLimit Default Value: P7D Description: The default maximum time to wait for an incremental schedule to complete. | LOADUPDATE | TIMESPAN | CONFIG | ORG |
| OptimiserInitialResourcesPerCluster Default Value: 1 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserIntelligentAllocationWeight Default Value: 2000 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserInterRouteSwapWeight Default Value: 1000 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserIntraRouteSwapWeight Default Value: 1000 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserIterationsPerStep Default Value: 3000 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserMaximumAllocateMoves Default Value: 1 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserMaximumAllocations Default Value: 1 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserMaximumChanges Default Value: 1 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserMaximumClustersPerActivity Default Value: 3 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserMaximumGeographicSwaps Default Value: 1 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserMaximumImproveParallelOptimisations Default Value: 1 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserMaximumIntelligentAllocations Default Value: 1 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserMaximumInterRouteSwaps Default Value: 1 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserMaximumIntraRouteSwaps Default Value: 1 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserMaximumMoveChunks Default Value: 1 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserMaximumMoveEarliests Default Value: 1 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserMaximumMovesWithinBlock Default Value: 1 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserMaximumMovesWithinRoute Default Value: 1 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserMaximumPushes Default Value: 1 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserMaximumResourcesPerCluster Default Value: 15 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserMaximumReversals Default Value: 1 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserMaximumSameRouteMoves Default Value: 1 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserMaximumSimpleMoves Default Value: 1 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserMaximumTargetActivitiesPerCluster Default Value: 3000 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserMaximumTransfers Default Value: 1 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserMaximumTravelWithAllocations Default Value: 1 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserMaximumUnallocations Default Value: 1 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserMaximumUncrossRoutes Default Value: 1 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserMaxNumberOfRoutesToClear Default Value: 6 Description: Only change this when advised to do so by IFS. | LOADUPDATE | DOUBLE | SUPPORT | ORG |
| OptimiserMaxProportionOfRoutesToClear Default Value: 1 Description: Only change this when advised to do so by IFS. | LOADUPDATE | DOUBLE | SUPPORT | ORG |
| OptimiserMinimumTargetActivitiesPerCluster Default Value: 25 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserMoveChunkWeight Default Value: 3000 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserMoveDepotVisitsWeight Default Value: 100 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserMoveEarliestWeight Default Value: 500 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserMoveToEarlierRouteWeight Default Value: 500 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | CONFIG | ORG |
| OptimiserMoveWithinBlockWeight Default Value: 500 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserMoveWithinRouteWeight Default Value: 1000 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserNumberOfChangesPerIteration Default Value: 2 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserPreCoReqAvoidPush Default Value: True Description: Only change this when advised to do so by IFS. | LOADUPDATE | BOOLEAN | SUPPORT | ORG |
| OptimiserPreCoReqMaxPreviousPositionFailures Default Value: 5 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserPreCoReqMaxResourceAttempts Default Value: 5 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserPreCoReqMaxRouteAttempts Default Value: 2 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserPreCoReqMaxTotalAttempts Default Value: 8 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserPredictiveLazinessThreshold Default Value: 1000 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserProbabilisticMaxRangeMinAttempts Default Value: 10000 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserProbabilisticMaxRangeMultiplier Default Value: 3 Description: Only change this when advised to do so by IFS. | LOADUPDATE | DOUBLE | SUPPORT | ORG |
| OptimiserProbabilisticSuccessToScoreWeighting Default Value: 2 Description: Only change this when advised to do so by IFS. | LOADUPDATE | DOUBLE | SUPPORT | ORG |
| OptimiserPushWeight Default Value: 3000 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserRegionSizeMultiplier Default Value: 1.2 Description: Only change this when advised to do so by IFS. | LOADUPDATE | DOUBLE | SUPPORT | ORG |
| OptimiserReverseWeight Default Value: 1000 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserSameRouteMoveWeight Default Value: 1000 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserSecondaryAlgorithm Default Value: 0 Allowed Values: 0 = Automatically select the best secondary algorithm; 1 = Simulated annealing; 2 = Single-threaded quantum scheduling; 8 = Multi-threaded quantum scheduling; 15 = Quick intelligent scheduling; 23 = Non-clustered scheduling; 34 = Clustered scheduling Description: A secondary algorithm to be used by some primary algorithms. | LOADUPDATE | INTEGER | CONFIG | ORG |
| OptimiserSecondaryClusteringMethods Default Value: 7 Allowed Values: 1 = Spatial; 2 = Constraints; 4 = Temporal Description: The permitted secondary clustering methods when using combined clustering. | LOADUPDATE | INTEGER | CONFIG | ORG |
| OptimiserSelectiveRouteClearMaxWindow Default Value: P2D Description: Only change this when advised to do so by IFS. | LOADUPDATE | TIMESPAN | SUPPORT | ORG |
| OptimiserSelectiveRouteClearWeight Default Value: 0 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserShuffleRoutesWeight Default Value: 500 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserSimpleMoveWeight Default Value: 1000 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserStartCallsInRouteProportionForRouteClear Default Value: -1 Description: Only change this when advised to do so by IFS. | LOADUPDATE | DOUBLE | SUPPORT | ORG |
| OptimiserStarterAlgorithm Default Value: 15 Allowed Values: 0 = None; 15 = Choose the most suitable starter algorithm automatically; 26 = Over-resourced; 27 = Spatial; 28 = Spatial High Priority; 29 = Multiple Resources At Location; 30 = Linked Activity Clusters; 31 = Tight SLAs; 32 = Balanced Nearest Resource Description: An algorithm to use to create a quick initial schedule before optimising. | LOADUPDATE | INTEGER | CONFIG | ORG |
| OptimiserStarterMultipleAttempts Default Value: 1 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserStarterProblemType Default Value: 0 Allowed Values: 0 = Chosen automatically; 1 = Dispersed similar value calls; 2 = Dispersed with some high value calls; 3 = Tight SLAs; 4 = Complex; 5 = Dispersed calls multiple resources at locations; 6 = Chains of prerequisites; 7 = Territory Balancing; 8 = Start and End Location Different Description: The type of scheduling problem. Used by the starter algorithm. | LOADUPDATE | INTEGER | CONFIG | ORG |
| OptimiserStarterResourcingLevel Default Value: 0 Allowed Values: 0 = Chosen automatically; 1 = Under-resourced; 2 = Correctly resourced; 3 = Over-resourced Description: The resourcing level of the scheduling problem. Used by the starter algorithm. | LOADUPDATE | INTEGER | CONFIG | ORG |
| OptimiserStarterTargetResourcesPerCluster Default Value: 50 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserTBSAllowedChangeTypes Default Value: 255 Allowed Values: 1 = Updating Activity Base Values; 2 = Altering SLA Drops; 4 = Changing SLA Slopes; 8 = Changing Resource Costs; 16 = Updating Overtime; 32 = Changing Shift Times Description: Determines which changes the TBS is allowed to use to make improvements. | LOADUPDATE | INTEGER | CONFIG | ORG |
| OptimiserTBSMaxConsecutiveFailedTries Default Value: 5 Description: The maximum consecutive failed tries in TBS before moving on to the next possibility. Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | CONFIG | ORG |
| OptimiserTBSMaximumOvertimePerShift Default Value: PT2H Description: The maximum amount of possible overtime to be added to any shift | LOADUPDATE | TIMESPAN | CONFIG | ORG |
| OptimiserTBSOvertimeGranularity Default Value: PT30M Description: The minimum period of time by which to adjust overtime | LOADUPDATE | TIMESPAN | CONFIG | ORG |
| OptimiserTBSShiftMoveGranularity Default Value: PT1H Description: The minimum period of time by which to move shifts | LOADUPDATE | TIMESPAN | CONFIG | ORG |
| OptimiserTBSStepsInQualityCalculation Default Value: 20 Description: The number of steps in the TBS quality calculation. Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | CONFIG | ORG |
| OptimiserTemporalClusterOverlapThreshold Default Value: 0.9 Description: Only change this when advised to do so by IFS. | LOADUPDATE | DOUBLE | SUPPORT | ORG |
| OptimiserTransferWeight Default Value: 500 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserTravelWithAllocationWeight Default Value: 200 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptimiserUncrossRoutesWeight Default Value: 2000 Description: Only change this when advised to do so by IFS. | LOADUPDATE | INTEGER | SUPPORT | ORG |
| OptmiserApptLongAvailabilityThreshold Default Value: P10D Description: Activities with availability longer than the threshold are initially scheduled using a standard starter algorithm instead of the appointment algorithm. | LOADUPDATE | TIMESPAN | CONFIG | ORG |
| Port Default Value: 1362 Description: The port to use for remoting. | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| RecordDatasetStatus Default Value: False Description: Whether or not to record scheduling progress in the Dataset_Status table | RESTARTUPDATE | BOOLEAN | ADMIN | SYS |
| ReloadLastPlan Default Value: False Description: On restart, the schedule will be seeded from the last known plan, if present | LOADUPDATE | BOOLEAN | CONFIG | ORG_INHERIT |
| ReloadLastPlanSinceLoad Default Value: True Description: Whether to restart processing from the latest saved plan since the last LOAD | LOADUPDATE | BOOLEAN | CONFIG | ORG |
| ScheduleCommittedActivitiesInActiveShift Default Value: True Description: If true then committed activities will only be placed in their 'active' shift. | LOADUPDATE | BOOLEAN | CONFIG | ORG |
| ScheduleExceptionUseActivationDateTime Default Value: True Description: If set to true, the DSE will set the activation_datetime instead of the value on any Schedule_Exception_Data records which record an amount of time. | DYNAMICUPDATE | BOOLEAN | CONFIG | ORG |
| ScheduleExceptionUseActivationDateTimeForDates Default Value: True Description: If set to true, the DSE will set the activation_datetime instead of the value on any Schedule_Exception_Data records which record an exact date and time. | DYNAMICUPDATE | BOOLEAN | CONFIG | ORG |
| SchedulingWindowEndsAtMidnight Default Value: True Description: Whether to truncate the scheduling window at midnight on the final day. | LOADUPDATE | BOOLEAN | CONFIG | ORG |
| SchedulingWindowLength Default Value: P2D Description: Specifies the size of the scheduling window. | LOADUPDATE | TIMESPAN | CONFIG | ORG |
| TraceFolder Description: Specifies trace folder when recording or replaying traces | RESTARTUPDATE | STRING | ADMIN | SYS |
| TraceOption Default Value: none Description: Specifies trace recording and/or replaying | RESTARTUPDATE | STRING | ADMIN | SYS |
| TravelToAndFromChargeable Default Value: True Description: Whether first/last travel is chargeable if travel before/after shift permitted. | LOADUPDATE | BOOLEAN | CONFIG | ORG |
| TravelWithSkillsInherited Default Value: False Description: If true, the main resource inherits the skills of travelling with resources | LOADUPDATE | BOOLEAN | CONFIG | ORG |
| TryDelayingActivities Default Value: True Description: Determines whether the DSE should attempt to delay activities | LOADUPDATE | BOOLEAN | CONFIG | ORG |
| UnloadReactiveDatasetsAfter Default Value: PT5M Description: REACTIVE datasets will be unloaded from the DSE after this time, if no updates have been received. | LOADUPDATE | TIMESPAN | ADMIN | SYS |
| UpdateDatasetFootprint Default Value: True Description: Should the DSE update the dataset footprint after saving a plan? | RESTARTUPDATE | BOOLEAN | ADMIN | SYS |
| UseLateAsPossibleScheduling Default Value: False Description: Determines whether late as possible scheduling should be used (only applies to relevant activities when on) | LOADUPDATE | BOOLEAN | CONFIG | ORG |
| UseLatestUpdateForStatusTime Default Value: False Description: If several activity travelling or on site status updates are sent consecutively for the same activity and status, then this parameter determines whether the first or most recent update is used to set the status start time. | DYNAMICUPDATE | BOOLEAN | CONFIG | ORG |
Application: DSP¶
| Parameter ID | Access | Data Type | Group | Class |
|---|---|---|---|---|
| CheckForChangesSeconds Default Value: 5 Description: The frequency of Schedule Dispatch Service checks for changes on datasets it is already processing. | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| CheckForDatasetsSeconds Default Value: 5 Description: The frequency of Schedule Dispatch Service checks for new datasets. | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| ConfirmationTime Default Value: PT15M Description: The Schedule Dispatch Service expects its decisions to be acted on within this time. | LOADUPDATE | TIMESPAN | CONFIG | ORG |
| DefaultIgnoreBreakTime Default Value: True Description: The default value used for the IgnoreBreakTime rule if not explicitly specified. | LOADUPDATE | BOOLEAN | CONFIG | ORG |
| DefaultTimeBeforeShiftStart Default Value: PT30M Description: The default value used for the TimeBeforeShiftStart rule if not explicitly specified. | LOADUPDATE | TIMESPAN | CONFIG | ORG |
| MaximumDecisionFrequency Default Value: PT30S Description: The Schedule Dispatch Service will not make commit decisions more frequently than this. | LOADUPDATE | TIMESPAN | CONFIG | ORG |
| Port Default Value: 1371 Description: The port to use for remoting. | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| SDSDiagnosticOptions Description: Schedule Dispatch Service diagnostic options. For future use. | RESTARTUPDATE | STRING | ADMIN | SYS |
| UncommitIgnoreFutureShifts Default Value: True Description: If true then any activities specifically committed to future shifts will be ignored when suggesting activities to uncommit. | LOADUPDATE | BOOLEAN | CONFIG | ORG |
Application: DST¶
| Parameter ID | Access | Data Type | Group | Class |
|---|---|---|---|---|
| AggregationInitialRequiredQuality Default Value: 80 Description: When aggregating, the initial DSE plan quality required before updating the aggregation. | LOADUPDATE | DOUBLE | CONFIG | ORG |
| AggregationMaximumActivityDuration Default Value: PT2H Description: The maximum duration of aggregated activities. | LOADUPDATE | TIMESPAN | CONFIG | ORG |
| AggregationMaximumMergeDistanceMetres Default Value: 2000 Description: The maximum distance in metres between activities to be merged into the same aggregated activity. | LOADUPDATE | INTEGER | CONFIG | ORG |
| AggregationTargetActivityCount Default Value: 10000 Description: The target number of activities in the segment dataset when using aggregation. | LOADUPDATE | INTEGER | CONFIG | ORG |
| CheckForChangesSeconds Default Value: 1 Description: How often the Schedule Distribution Service checks for changes on datasets it is already processing. | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| CheckForDatasetsSeconds Default Value: 5 Description: The frequency of Schedule Distribution Service checks for new datasets. | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| FeedActivitiesMultiplier Default Value: 0.5 Description: Number of activities to include in active dataset multiplier | LOADUPDATE | DOUBLE | CONFIG | ORG |
| FeedActivityInJeopardyThreshold Default Value: PT4H Description: Activity SLA jeopardy threshold | LOADUPDATE | TIMESPAN | CONFIG | ORG |
| FeedDynamicDatasetOption Default Value: False Description: Enables the static data feeding of the dynamic dataset. | LOADUPDATE | BOOLEAN | CONFIG | ORG |
| FeederActivityValueImportanceWeighting Default Value: 1 Description: The weighting applied to the maximum possible value of an activity in determining its importance. | LOADUPDATE | DOUBLE | CONFIG | ORG |
| FeederInternalBroadcastPlanQuality Default Value: 50 Description: The internal plan quality used when reviewing which activities to feed. | LOADUPDATE | INTEGER | CONFIG | ORG |
| FeederMaximumInitialActivities Default Value: 10000 Description: Limits the maximum number of activities initially included in the feeder dataset. | LOADUPDATE | INTEGER | CONFIG | ORG |
| FeederMechanism Default Value: 1 Allowed Values: 1 = EXCLUSION; 2 = AGGREGATION Description: The mechanism to use to feed activities to the DSE. | LOADUPDATE | INTEGER | CONFIG | ORG |
| FeederMinimumActivities Default Value: 1000 Description: Minimum number of activities in schedule to start filtering out. | LOADUPDATE | INTEGER | CONFIG | ORG |
| FeederProximityImportanceWeighting Default Value: 1 Description: The weighting applied to the proximity of an activity to other allocated activities in determining its importance. | LOADUPDATE | DOUBLE | CONFIG | ORG |
| FeederValuePerHourImportanceWeighting Default Value: 1 Description: The weighting applied to the value per hour of an activity in determining its importance. | LOADUPDATE | DOUBLE | CONFIG | ORG |
| PermittedSegmentation Default Value: 15 Allowed Values: 1 = Temporal; 2 = Spatial; 4 = Constraint based Description: The types of segmentation to be considered. | RESTARTUPDATE | INTEGER | CONFIG | ORG |
| Port Default Value: 1369 Description: The port to use for remoting. | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| RaiseExceptionsForNonReactiveActivities Default Value: True Description: Raise an exception for each non-reactive activity not considered for scheduling. | LOADUPDATE | BOOLEAN | CONFIG | ORG |
| ResegmentationFactor Default Value: 50 Description: The percentage change in dataset size necessary to trigger re-segmentation. | LOADUPDATE | INTEGER | CONFIG | ORG |
| SegmentDatasetOption Default Value: False Description: Enables segmenting datasets. | LOADUPDATE | BOOLEAN | CONFIG | ORG |
| SegmentDatasetSizeThreshold Default Value: 1.4 Description: Used in combination with the TargetSegmentSize to determine a preferred maximum cluster size. | LOADUPDATE | DOUBLE | CONFIG | ORG |
| SegmentMinimumActivities Default Value: 50 Description: Defines the minimum number of calls for a segment dataset. | LOADUPDATE | INTEGER | CONFIG | ORG |
| TargetSegmentSize Default Value: 10000 Description: The approximate number of activities per segment dataset. | RESTARTUPDATE | INTEGER | ADMIN | SYS |
Application: GWY¶
| Parameter ID | Access | Data Type | Group | Class |
|---|---|---|---|---|
| AppointmentRequestPollingTimeout Default Value: PT30S Description: The maximum time to wait for an appointment, when using Gateway with polling for appointment requests | DYNAMICUPDATE | TIMESPAN | CONFIG | ORG |
| OpenIdAllowLegacyAuthentication Default Value: False Description: If OpenID enabled, allow username and password authentication flag | DYNAMICUPDATE | BOOLEAN | SECURITY | ORG |
| PermittedBroadcastTypes Default Value: ALL Description: The permitted broadcast types that the Gateway will allow through in input data | DYNAMICUPDATE | STRING | ADMIN | SYS |
| Port Default Value: 8744 Description: The port to use for remoting. | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| ScheduleQualityCalculationMode Default Value: RECOMMENDED Description: The mode to use when determining the required schedule quality | RESTARTUPDATE | STRING | ADMIN | SYS |
| ScheduleQualitySetValue Default Value: 80 Description: The schedule quality value to use if calculation mode is SETVALUE | RESTARTUPDATE | DOUBLE | ADMIN | SYS |
| TransportProtocol Default Value: HTTP Description: The method to use for remoting. | RESTARTUPDATE | STRING | ADMIN | SYS |
Application: PSW¶
| Parameter ID | Access | Data Type | Group | Class |
|---|---|---|---|---|
| ActivityBaseLabel Default Value: {Activity.id} Description: The label used to identify an activity without reference to the allocation of the activity. | DYNAMICUPDATE | STRING | LABEL | ORG |
| AddHstsHeader Default Value: False Description: Use HTTP Strict Transport Security | DYNAMICUPDATE | BOOLEAN | ADMIN | SYS |
| AnonymousAndWindowsAuthentication Default Value: False Description: Set true if IIS is configured to allow both Anonymous and Windows Authentication (Active Directory Login) | DYNAMICUPDATE | BOOLEAN | ADMIN | SYS |
| ARPActivityTemplateLabelFormat Default Value: {description|id} Description: Label format for activity templates | DYNAMICUPDATE | STRING | LABEL | ORG |
| ARPActivityTypeLabelFormat Default Value: {description|id} Description: Label format for activity types | DYNAMICUPDATE | STRING | LABEL | ORG |
| ARPCapacityLabelFormat Default Value: {description|id} Description: Label format for capacities | DYNAMICUPDATE | STRING | LABEL | ORG |
| ARPDivisionLabelFormat Default Value: {description|id} Description: Label format for divisions | DYNAMICUPDATE | STRING | LABEL | ORG |
| ARPLocationLabelFormat Default Value: {name|id} Description: Label format for locations | DYNAMICUPDATE | STRING | LABEL | ORG |
| ARPPartLabelFormat Default Value: {description|id} Description: Label format for parts | DYNAMICUPDATE | STRING | LABEL | ORG |
| ARPPositionLabelFormat Default Value: {description|id} Description: Label format for positions | DYNAMICUPDATE | STRING | LABEL | ORG |
| ARPResourceLabelFormat Default Value: {first_name|surname|id} Description: Label format for resources | DYNAMICUPDATE | STRING | LABEL | ORG |
| ARPRuleLabelFormat Default Value: {description|id} Description: Label format for rules | DYNAMICUPDATE | STRING | LABEL | ORG |
| ARPShiftTemplateLabelFormat Default Value: {description|id} Description: Label format for shift templates | DYNAMICUPDATE | STRING | LABEL | ORG |
| BaseHref Description: The base href used when loading workbench assets | DYNAMICUPDATE | STRING | ADMIN | SYS |
| BookmarkMenuBackgroundColour Default Value: #3b5059 Description: Defines the bookmark menu background colour | DYNAMICUPDATE | STRING | THEME | ORG |
| BookmarkMenuBorderColour Default Value: #4b6571 Description: Defines the bookmark menu border colour | DYNAMICUPDATE | STRING | THEME | ORG |
| BookmarkMenuHoverColour Default Value: #0d709a Description: Defines the bookmark menu hover colour | DYNAMICUPDATE | STRING | THEME | ORG |
| BookmarkMenuIconColour Default Value: #e6f3f9 Description: Defines the bookmark menu icon colour | DYNAMICUPDATE | STRING | THEME | ORG |
| BrowserTabIcon Description: Defines the browser tab icon | DYNAMICUPDATE | STRING | THEME | ORG |
| BrowserTabName Description: Defines the browser tab name | DYNAMICUPDATE | STRING | THEME | ORG |
| ClusterMaximumEntities Default Value: 100 Description: The maximum number of entities in a cluster the context menu will display. | DYNAMICUPDATE | INTEGER | WORKBENCH | ORG |
| CustomURLsSingleDefaultWindow Default Value: False Description: If true, all custom urls that do not specify a 'navigable target name' will open in the same window. | DYNAMICUPDATE | BOOLEAN | CONFIG | ORG |
| DataGridBodyRowHoverColour Default Value: #F5F5F5 Description: Defines the datagrid body row hover colour | DYNAMICUPDATE | STRING | THEME | ORG |
| DataGridBodyRowSelectedColour Default Value: #EBEBEB Description: Defines the datagrid body row selected colour | DYNAMICUPDATE | STRING | THEME | ORG |
| DataGridBodyTextColour Default Value: #333333 Description: Defines the datagrid body text colour | DYNAMICUPDATE | STRING | THEME | ORG |
| DataGridHeaderBackgroundColour Default Value: #F5F5F5 Description: Defines the data grid header background colour | DYNAMICUPDATE | STRING | THEME | ORG |
| DataGridHeaderDivideColour Default Value: #CCCCCC Description: Defines the data grid header divide colour | DYNAMICUPDATE | STRING | THEME | ORG |
| DataGridHeaderDivideHoverColour Default Value: #0087C1 Description: Defines the data grid header divide hover colour | DYNAMICUPDATE | STRING | THEME | ORG |
| DataGridHeaderHoverColour Default Value: #EBEBEB Description: Defines the data grid header hover colour | DYNAMICUPDATE | STRING | THEME | ORG |
| DataGridHeaderTextColour Default Value: #333333 Description: Defines the data grid text colour | DYNAMICUPDATE | STRING | THEME | ORG |
| DefaultLoginAccount Default Value: Default Description: Default Login Account | DYNAMICUPDATE | STRING | ADMIN | SYS |
| DefaultPlanningWindowDays Default Value: 28 Description: The default planning window length for the rota selector | DYNAMICUPDATE | INTEGER | WORKBENCH | ORG |
| DragAndDropDraggedBackgroundColour Default Value: #EBEBEB Description: Defines the drag and drop background colour | DYNAMICUPDATE | STRING | THEME | ORG |
| ErrorStatusBackgroundColour Default Value: #FFECEC Description: Defines the error status background colour | DYNAMICUPDATE | STRING | THEME | ORG |
| ErrorStatusBackgroundSelectedColour Default Value: #F9CDC9 Description: Defines the error status background selected colour | DYNAMICUPDATE | STRING | THEME | ORG |
| ErrorStatusBorderColour Default Value: #F29A93 Description: Defines the error status border colour | DYNAMICUPDATE | STRING | THEME | ORG |
| ErrorStatusColour Default Value: #E53527 Description: Defines the error status colour | DYNAMICUPDATE | STRING | THEME | ORG |
| ErrorStatusIconColour Default Value: #AC281D Description: Defines the error status icon colour | DYNAMICUPDATE | STRING | THEME | ORG |
| ErrorStatusTextColour Default Value: #AC281D Description: Defines the error status text colour | DYNAMICUPDATE | STRING | THEME | ORG |
| GanttDragOverlayBackgroundColour Default Value: #FFFFFF Description: Defines the Gantt drag overlay background colour. | DYNAMICUPDATE | STRING | THEME | ORG |
| GanttDragOverlayBodyBackgroundColour Default Value: #0087C1 Description: Defines the Gantt drag overlay body background colour. | DYNAMICUPDATE | STRING | THEME | ORG |
| GanttHeaderBackgroundColour Default Value: #F5F5F5 Description: Defines the Gantt header background colour. | DYNAMICUPDATE | STRING | THEME | ORG |
| GanttHeaderBorderColour Default Value: #CCCCCC Description: Defines the Gantt header border colour. | DYNAMICUPDATE | STRING | THEME | ORG |
| GanttHeaderTextColour Default Value: #333333 Description: Defines the Gantt header text colour. | DYNAMICUPDATE | STRING | THEME | ORG |
| GanttRowAltBackgroundColour Default Value: #FFFFFF Description: Defines the Gantt row alt background colour. | DYNAMICUPDATE | STRING | THEME | ORG |
| GanttRowBackgroundColour Default Value: #FFFFFF Description: Defines the Gantt row background colour. | DYNAMICUPDATE | STRING | THEME | ORG |
| GanttRowHoverBackgroundColour Default Value: #F5F5F5 Description: Defines the Gantt row hover background colour. | DYNAMICUPDATE | STRING | THEME | ORG |
| GanttRowSelectedBackgroundColour Default Value: #EBEBEB Description: Defines the Gantt row selected background colour. | DYNAMICUPDATE | STRING | THEME | ORG |
| GanttShowRegions Default Value: False Description: Whether or not to show regions on the Gantt. | DYNAMICUPDATE | BOOLEAN | WORKBENCH | ORG |
| HideResourcesWithNoFilteredAllocations Default Value: True Description: Whether to show a resource if none of its allocations are included in a filter | DYNAMICUPDATE | BOOLEAN | WORKBENCH | ORG |
| HistoricalPlanningDataThreshold Default Value: P0D Description: Duration to fetch the old rota data before current day | DYNAMICUPDATE | TIMESPAN | CONFIG | ORG |
| HstsIncludeSubdomains Default Value: False Description: HSTS Include Subdomains flag | DYNAMICUPDATE | BOOLEAN | ADMIN | SYS |
| HstsMaxAge Default Value: P365D Description: HSTS Maximum Age | DYNAMICUPDATE | TIMESPAN | ADMIN | SYS |
| HstsPreload Default Value: False Description: HSTS Preload flag | DYNAMICUPDATE | BOOLEAN | ADMIN | SYS |
| InfoStatusBackgroundColour Default Value: #E6F3F9 Description: Defines the info status background colour | DYNAMICUPDATE | STRING | THEME | ORG |
| InfoStatusBackgroundSelectedColour Default Value: #BFE1F0 Description: Defines the info status background selected colour | DYNAMICUPDATE | STRING | THEME | ORG |
| InfoStatusBorderColour Default Value: #80C3E0 Description: Defines the info status border colour | DYNAMICUPDATE | STRING | THEME | ORG |
| InfoStatusColour Default Value: #0087C1 Description: Defines the info status colour | DYNAMICUPDATE | STRING | THEME | ORG |
| InfoStatusIconColour Default Value: #006591 Description: Defines the info status icon colour | DYNAMICUPDATE | STRING | THEME | ORG |
| InfoStatusTextColour Default Value: #006591 Description: Defines the info status text colour | DYNAMICUPDATE | STRING | THEME | ORG |
| InstallId Description: Set on first install. | DYNAMICUPDATE | STRING | ADMIN | SYS |
| IsochroneCompareStraight Default Value: False Description: Show straight line isochrones compared to real isochrones | DYNAMICUPDATE | BOOLEAN | CONFIG | ORG |
| JwtExpiryDays Default Value: 1.0 Description: Number of days before a PSO Workbench token expires | DYNAMICUPDATE | DOUBLE | ADMIN | SYS |
| JwtLogoutHours Default Value: 2.0 Description: Leeway to allow expired tokens to logout | DYNAMICUPDATE | DOUBLE | ADMIN | SYS |
| LayerNavigationActiveColour Default Value: #156181 Description: Defines the layer navigation active colour | DYNAMICUPDATE | STRING | THEME | ORG |
| LayerNavigationBackgroundColour Default Value: #2b3a41 Description: Defines the layer navigation background colour | DYNAMICUPDATE | STRING | THEME | ORG |
| LayerNavigationButtonBorderColour Default Value: #002230 Description: Defines the layer navigation button border colour | DYNAMICUPDATE | STRING | THEME | ORG |
| LayerNavigationHoverColour Default Value: #0d709a Description: Defines the layer navigation hover colour | DYNAMICUPDATE | STRING | THEME | ORG |
| LayerNavigationScrollbarThumbColour Default Value: #0d709a Description: Defines the layer navigation scrollbar thumb colour | DYNAMICUPDATE | STRING | THEME | ORG |
| LayerNavigationScrollbarTrackColour Default Value: #E6F3F9 Description: Defines the layer navigation scrollbar track colour | DYNAMICUPDATE | STRING | THEME | ORG |
| LayerNavigationTextColour Default Value: #E6F3F9 Description: Defines the layer navigation text colour | DYNAMICUPDATE | STRING | THEME | ORG |
| LoginScreenApplicationName Description: Defines the application name | DYNAMICUPDATE | STRING | THEME | ORG |
| LoginScreenIcon Description: Defines the login screen icon | DYNAMICUPDATE | STRING | THEME | ORG |
| LoginScreenImage Description: Defines the login screen image | DYNAMICUPDATE | STRING | THEME | ORG |
| MapKey Description: The key used for viewing maps with the selected provider. | DYNAMICUPDATE | STRING | WORKBENCH | ORG |
| MapProvider Description: The provider for tiles used when viewing maps on the workbench. | DYNAMICUPDATE | STRING | WORKBENCH | ORG |
| MaxVisibleExternalPendingChanges Default Value: 500 Description: Defines the maximum number of external pending changes the workbench will show in the Gantt. | RESTARTUPDATE | INTEGER | WORKBENCH | ORG |
| MinimumScreenWidthForMenu Default Value: 900 Description: The minimum screen width for which the navigation menu will stay open by default. | DYNAMICUPDATE | INTEGER | WORKBENCH | ORG |
| NewResourceTimeZone Description: The time zone for a new resource created by the Scheduling Simulation Service. | DYNAMICUPDATE | STRING | CONFIG | ORG |
| OpenIdRedirectRoot Description: Root URI for PSO Workbench | DYNAMICUPDATE | STRING | ADMIN | SYS |
| PartsPickupColour Default Value: #F4A8A8 Description: Defines the colour to display picked up parts on the parts usage graph | DYNAMICUPDATE | STRING | THEME | ORG |
| PartsReusableUsageColour Default Value: #D4C0FF Description: Defines the colour to display usage of reusable parts on the parts usage graph | DYNAMICUPDATE | STRING | THEME | ORG |
| PartsTotalStockColour Default Value: #56C5E8 Description: Defines the colour to display total part stock on the parts usage graph | DYNAMICUPDATE | STRING | THEME | ORG |
| PartsUsedColour Default Value: #9FE6A0 Description: Defines the colour to display used parts on the parts usage graph | DYNAMICUPDATE | STRING | THEME | ORG |
| PendingChangeExpiryPeriod Default Value: PT5M Description: The elapsed schedule time from which pending manual changes will stop being shown on the workbench, even if the change does not appear to have been confirmed. | DYNAMICUPDATE | TIMESPAN | CONFIG | ORG |
| PendingChangePollingIntervalSeconds Default Value: 0.5 Description: Polling interval to use when checking for pending changes. | DYNAMICUPDATE | DOUBLE | ADMIN | SYS |
| PendingExternalChangeIconColour Default Value: #cccccc Description: Sets the colour of the pending external change icon. | DYNAMICUPDATE | STRING | THEME | ORG |
| PendingManualChangeIconColour Default Value: #f7ac00 Description: Sets the colour of the pending manual change icon. | DYNAMICUPDATE | STRING | THEME | ORG |
| PreviewChangesIconColour Default Value: #fbd680 Description: Sets the colour of the preview changes icon. | DYNAMICUPDATE | STRING | THEME | ORG |
| PreviewManualChanges Default Value: True Description: If this is set then the workbench will show a preview of the schedule with the manual changes incorporated while the changes are still pending. | DYNAMICUPDATE | BOOLEAN | CONFIG | ORG |
| PSWActivityAcceptedColour1 Default Value: #369B30 Description: Primary colour for accepted activities. | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWActivityAcceptedColour2 Default Value: #ebf5ea Description: Secondary colour for accepted activities. | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWActivityAllocatedColour1 Default Value: #0087C1 Description: Primary colour for allocated activities. | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWActivityAllocatedColour2 Default Value: #e6f3f9 Description: Secondary colour for allocated activities. | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWActivityCommittedColour1 Default Value: #369B30 Description: Primary colour for committed activities. | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWActivityCommittedColour2 Default Value: #ebf5ea Description: Secondary colour for committed activities. | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWActivityCompletedColour1 Default Value: #873E8D Description: Primary colour for completed activities. | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWActivityCompletedColour2 Default Value: #f3ecf4 Description: Secondary colour for completed activities. | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWActivityDoNotScheduleColour1 Default Value: #333333 Description: Primary colour for do not schedule activities. | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWActivityDoNotScheduleColour2 Default Value: #cccccc Description: Secondary colour for do not schedule activities. | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWActivityDownloadedColour1 Default Value: #369B30 Description: Primary colour for downloaded activities. | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWActivityDownloadedColour2 Default Value: #ebf5ea Description: Secondary colour for downloaded activities. | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWActivityFollowOnColour1 Default Value: #0087C1 Description: Primary colour for follow-on activities. | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWActivityFollowOnColour2 Default Value: #e6f3f9 Description: Secondary colour for follow-on activities. | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWActivityIncompleteColour1 Default Value: #873E8D Description: Primary colour for incomplete activities. | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWActivityIncompleteColour2 Default Value: #F9CDC9 Description: Secondary colour for incomplete activities. | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWActivityOnSiteColour1 Default Value: #C20069 Description: Primary colour for on-site activities. | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWActivityOnSiteColour2 Default Value: #f9e6f0 Description: Secondary colour for on-site activities. | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWActivityPendingCompletionColour1 Default Value: C20069 Description: Primary colour for pending completion activities. | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWActivityPendingCompletionColour2 Default Value: #f9e6f0 Description: Secondary colour for pending completion activities. | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWActivitySentColour1 Default Value: #369B30 Description: Primary colour for sent activities. | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWActivitySentColour2 Default Value: #ebf5ea Description: Secondary colour for sent activities. | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWActivityTravellingColour1 Default Value: #F7AC00 Description: Primary colour for travelling activities. | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWActivityTravellingColour2 Default Value: #fef7e6 Description: Secondary colour for travelling activities. | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWActivityUnallocatedColour1 Default Value: #E53527 Description: Primary colour for unallocated activities. | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWActivityUnallocatedColour2 Default Value: #fcebe9 Description: Secondary colour for unallocated activities. | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWActivityVisitCompleteColour1 Default Value: #873E8D Description: Primary colour for visit complete activities. | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWActivityVisitCompleteColour2 Default Value: #f3ecf4 Description: Secondary colour for visit complete activities. | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWActivityWaitingColour1 Default Value: #F7AC00 Description: Primary colour for waiting activities. | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWActivityWaitingColour2 Default Value: #fef7e6 Description: Secondary colour for waiting activities. | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWBreakDefaultColourExplicit Default Value: #ffffff Description: Default colour for explicit breaks | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWBreakDefaultColourImplicit Default Value: #f4f4f4 Description: Default colour for implicit breaks | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWBreakOffColour Default Value: #e6cfe8 Description: Colour for Break OFF event | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWBreakOnColour Default Value: #f7cce0 Description: Colour for Break ON event | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWBucketCommittedColour Default Value: #369B30 Description: Colour for a Committed Bucket | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWBucketCompletedColour Default Value: #873E8D Description: Colour for a Completed Bucket | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWBucketDefaultColour Default Value: #0087C1 Description: Default Colour for a Bucket | DYNAMICUPDATE | STRING | THEME | ORG |
| PSWCommittedBreakColour Default Value: #c9e6c7 Description: Colour for Committed Break status | DYNAMICUPDATE | STRING | THEME | ORG |
| ScenarioVisualizerCustomers Default Value: ACME|Globex Description: A parameter to configure customers for OSV | DYNAMICUPDATE | STRING | CONFIG | ORG |
| ScenarioVisualizerMapCentre Default Value: 52.9594|-1.3085 Description: A parameter to configure the centre of the OSV map. Enter Latitude|Longitude | DYNAMICUPDATE | STRING | CONFIG | ORG |
| ScenarioVisualizerPartLabel Default Value: Widget Description: A parameter to configure the name of a part for OSV | DYNAMICUPDATE | STRING | LABEL | ORG |
| ScenarioVisualizerRegions Default Value: North West|North East|South East|South West Description: A parameter to configure regions for OSV. Enter up to 4 values for 'Top Left', 'Top Right', 'Bottom Right', and 'Bottom Left' respectively, each separated by '|'. | DYNAMICUPDATE | STRING | CONFIG | ORG |
| ScenarioVisualizerSkills Default Value: Electrician|Plumber Description: A parameter to configure skills for OSV. Enter up to 5 skills only, each separated by '|'. | DYNAMICUPDATE | STRING | CONFIG | ORG |
| ScenarioVisualizerTravelPartLabel Default Value: Vehicle Range (Km) Description: The description for the travel part used in the Operational Scenario Visualizer (OSV) | RESTARTUPDATE | STRING | LABEL | ORG |
| SelectableCommittedActStatuses Default Value: 3 Allowed Values: 1 = Do Not Schedule; 2 = Schedulable; 4 = Committed; 8 = Sent; 16 = Downloaded; 32 = Accepted; 64 = Travelling; 128 = Waiting at location; 256 = On Site; 512 = Pending Completion Description: Specifies which activity status an activity can be returned to after it has been committed. | DYNAMICUPDATE | INTEGER | WORKBENCH | ORG |
| SessionValidityVerificationTimer Default Value: P1M Description: How often the workbench will check that active sessions are valid and have the correct permissions. | DYNAMICUPDATE | TIMESPAN | ADMIN | SYS |
| ShiftImportCheckExistingCharacter Default Value: Description:* Defines the character used to request keeping existing shifts in an Excel rota import. | DYNAMICUPDATE | STRING | WORKBENCH | ORG |
| ShiftImportColumnsStart Default Value: C Description: Defines the column to begin reading shift data from in an Excel rota import. | DYNAMICUPDATE | STRING | WORKBENCH | ORG |
| ShiftImportDatesRow Default Value: 1 Description: Defines the row containing the dates in an Excel rota import. | DYNAMICUPDATE | INTEGER | WORKBENCH | ORG |
| ShiftImportDivisionIdColumn Default Value: B Description: Defines the column containing the division ids in an Excel rota import. | DYNAMICUPDATE | STRING | WORKBENCH | ORG |
| ShiftImportResourceIdColumn Default Value: A Description: Defines the column containing the resource ids in an Excel rota import. | DYNAMICUPDATE | STRING | WORKBENCH | ORG |
| ShiftImportRowsStart Default Value: 2 Description: Defines the row to begin reading shift data from in an Excel rota import. | DYNAMICUPDATE | INTEGER | WORKBENCH | ORG |
| ShiftImportSeparatorCharacter Default Value: , Description: Defines the character used to seperate items in a list in an Excel rota import. | DYNAMICUPDATE | STRING | WORKBENCH | ORG |
| ShiftImportSheetName Description: Defines the sheet name containing the shift data in an Excel rota import. | DYNAMICUPDATE | STRING | WORKBENCH | ORG |
| ShowExternalPendingStatusChanges Default Value: False Description: If true, the user will be shown pending status changes that have entered the system but have not yet been included in the latest plan. | RESTARTUPDATE | BOOLEAN | CONFIG | ORG |
| ShowGanttActivityConnections Default Value: True Description: Whether or not to show connections between activities on the Gantt chart. | DYNAMICUPDATE | BOOLEAN | WORKBENCH | ORG |
| StandardSendScheduleAttentionChange Default Value: false Description: Should the workbench send changes for resource attention directly to PSO even if a WORKBENCH broadcast type is specified | DYNAMICUPDATE | BOOLEAN | CONFIG | ORG |
| SuccessStatusBackgroundColour Default Value: #EBF5EA Description: Defines the success status background colour | DYNAMICUPDATE | STRING | THEME | ORG |
| SuccessStatusBackgroundSelectedColour Default Value: #CDE6CB Description: Defines the success status background selected colour | DYNAMICUPDATE | STRING | THEME | ORG |
| SuccessStatusBorderColour Default Value: #9BCD98 Description: Defines the success status border colour | DYNAMICUPDATE | STRING | THEME | ORG |
| SuccessStatusColour Default Value: #369B30 Description: Defines the success status colour | DYNAMICUPDATE | STRING | THEME | ORG |
| SuccessStatusIconColour Default Value: #297424 Description: Defines the success status icon colour | DYNAMICUPDATE | STRING | THEME | ORG |
| SuccessStatusTextColour Default Value: #297424 Description: Defines the success status text colour | DYNAMICUPDATE | STRING | THEME | ORG |
| TestFeatureFlagParameter Default Value: false Description: Test feature flag parameter used only for testing purposes | DYNAMICUPDATE | BOOLEAN | WORKBENCH | ORG |
| TimeSpanLabelPrecision Default Value: 0 Description: Defines the max decimal places for seconds in time span labels. Default behaviour will only show milliseconds for time spans up to 1 minute with 3 decimal places. | DYNAMICUPDATE | INTEGER | WORKBENCH | ORG |
| TopNavigationActiveColour Default Value: #D2D2D2 Description: Defines the top navigation active colour | DYNAMICUPDATE | STRING | THEME | ORG |
| TopNavigationBackgroundColour Default Value: #FAFAFA Description: Defines the top navigation background colour | DYNAMICUPDATE | STRING | THEME | ORG |
| TopNavigationHoverColour Default Value: #D2D2D2 Description: Defines the top navigation hover colour | DYNAMICUPDATE | STRING | THEME | ORG |
| TopNavigationTextColour Default Value: #2B363C Description: Defines the top navigation text colour | DYNAMICUPDATE | STRING | THEME | ORG |
| TopNavigatorIcon Description: Defines the top navigator icon | DYNAMICUPDATE | STRING | THEME | ORG |
| TranslateLabelFormats Default Value: True Description: View and edit label formats in the current language | DYNAMICUPDATE | BOOLEAN | LABEL | ORG |
| UseTranslatedHelpIfAvailable Default Value: False Description: Determines if the help documentation on the workbench will be shown in the user language (provided it is available in that language), or in English. | DYNAMICUPDATE | BOOLEAN | CONFIG | ORG |
| WarningStatusBackgroundColour Default Value: #FEF7E6 Description: Defines the warning status background colour | DYNAMICUPDATE | STRING | THEME | ORG |
| WarningStatusBackgroundSelectedColour Default Value: #FDEABF Description: Defines the warning status background selected colour | DYNAMICUPDATE | STRING | THEME | ORG |
| WarningStatusBorderColour Default Value: #FBD680 Description: Defines the warning status border colour | DYNAMICUPDATE | STRING | THEME | ORG |
| WarningStatusColour Default Value: #F7AC00 Description: Defines the warning status colour | DYNAMICUPDATE | STRING | THEME | ORG |
| WarningStatusIconColour Default Value: #B98100 Description: Defines the warning status icon colour | DYNAMICUPDATE | STRING | THEME | ORG |
| WarningStatusTextColour Default Value: #B98100 Description: Defines the warning status text colour | DYNAMICUPDATE | STRING | THEME | ORG |
| WorkbenchHostURL Description: Space separated list of host servers which are allowed to embed PSO Workbench in a frame. | DYNAMICUPDATE | STRING | ADMIN | ORG_INHERIT |
Application: RPL¶
| Parameter ID | Access | Data Type | Group | Class |
|---|---|---|---|---|
| AdditionalEventLogging Default Value: False Description: If true the Resource Planning Service will output additional event information to the logs. | RESTARTUPDATE | BOOLEAN | ADMIN | SYS |
| ARPAccessHistoryRetention Default Value: P6M Description: Determines how long ARP access history records are kept before being deleted. | RESTARTUPDATE | TIMESPAN | ADMIN | SYS |
| BackgroundRotaGenerationDays Default Value: 28 Description: The number of days into the future for which shifts should be generated when background rota generation is enabled. | LOADUPDATE | INTEGER | CONFIG | ORG |
| BroadcastARPDataContinuously Default Value: False Description: Should the Resource Planning Service broadcast updated data each time it detects a change, or once per day? | LOADUPDATE | BOOLEAN | CONFIG | ORG |
| BroadcastARPDataOptions Default Value: NONE Allowed Values: NONE = None; FILE = Write to a file; WEBSERVICE = Send to a web service; DATABASE = Call a database procedure Description: The method to use when sending the current ARP data to an external source | LOADUPDATE | STRING | CONFIG | ORG |
| BroadcastARPDataTimeOfDay Default Value: PT3H Description: The time of day to broadcast the latest ARP data (if not broadcasting continuously). | LOADUPDATE | TIMESPAN | CONFIG | ORG |
| BroadcastARPDataType Default Value: COMPLETE Allowed Values: COMPLETE = Send the latest complete dataset; CHANGE = Send details of changes since the previous output.; CHANGE_WITH_DAILY_COMPLETE = Send changes as they happen, plus a daily complete output. Description: The type of data to be broadcast | LOADUPDATE | STRING | CONFIG | ORG |
| BroadcastDirectory Description: The folder to use when writing ARP data to a file. | LOADUPDATE | STRING | CONFIG | ORG |
| CancelRoleOverrides Default Value: False Description: If true then the service will regularly check for role overrides that are no longer required and remove them. | LOADUPDATE | BOOLEAN | CONFIG | ORG |
| CheckForChangesSeconds Default Value: 1 Description: How often the Resource Planning Service checks for changes on datasets it is already processing. | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| CheckForDatasetsSeconds Default Value: 5 Description: The frequency the Resource Planning Service checks for new datasets. | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| CheckForRequestsSeconds Default Value: 1 Description: How often the Resource Planning Service checks for work to do | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| CheckForUpdatesSeconds Default Value: 5 Description: Frequency of Resource Planning Service checks for updates to the Resource Planning database. | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| ClearRotaOnRetentionUpdate Default Value: False Description: If set to true, the Resource Planning Service will automatically check for updates to resource retentions and clear the rota where the resource is no longer retained. | LOADUPDATE | BOOLEAN | CONFIG | ORG |
| DeleteDataBatchSize Default Value: 10000 Description: The maximum number of rows to delete in a single batch. | LOADUPDATE | INTEGER | ADMIN | SYS |
| ExcessResourcesConsidered Default Value: 2 Description: The number of excess resources to consider planning automatically | RESTARTUPDATE | INTEGER | CONFIG | ORG |
| ExternalDbName Description: Connection Name for External Database | LOADUPDATE | STRING | CONFIG | ORG |
| ExternalParameterType Default Value: XML Allowed Values: XML; STRING; BYTES Description: Parameter type for data to External Procedure | LOADUPDATE | STRING | CONFIG | ORG |
| ExternalProcedureName Default Value: SetARPXml Description: Procedure Name to execute in External Database | LOADUPDATE | STRING | CONFIG | ORG |
| InactivePlanningDatasetPeriod Default Value: P1D Description: Amount of time before inactive planning datasets are unloaded | DYNAMICUPDATE | TIMESPAN | ADMIN | SYS |
| KeepDeletedARPDataHours Default Value: 168 Description: Hours to keep deleted ARP data before removing, default is 168 hours (1 Week) | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| KeepHistoricalARPDataHours Default Value: 4320 Description: Hours to keep historical rota data before removing, default is 4320 hours (180 days) | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| ManageARPDataOptions Default Value: 1 Allowed Values: 1 = Clear deleted ARP data; 2 = Clear historical ARP data; 4 = Clean invalid rota data; 8 = Background shift generation Description: ARP clearing out rota data options. | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| ManageARPDataTimeOfDay Default Value: PT4H Description: Time of day to manage old or deleted ARP data. | RESTARTUPDATE | TIMESPAN | ADMIN | SYS |
| Port Default Value: 1375 Description: The port to use for remoting. | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| UpdateTransferredResources Default Value: False Description: If true all updates made to resources in their original dataset will be copied through to datasets they have been transferred to. | LOADUPDATE | BOOLEAN | CONFIG | ORG |
| WebServiceID Description: The web service ID (WSID) to use when sending ARP data to a web service. | LOADUPDATE | STRING | CONFIG | ORG |
| WebServicePassword Description: The password to use when sending ARP data to a web service. | LOADUPDATE | MASKED | SECURITY | ORG |
| WebServiceURL Description: The url to use when sending ARP data to a web service. | LOADUPDATE | STRING | CONFIG | ORG |
| WebServiceUsername Description: The user name to use when sending ARP data to a web service. | LOADUPDATE | STRING | SECURITY | ORG |
Application: SBM¶
| Parameter ID | Access | Data Type | Group | Class |
|---|---|---|---|---|
| CheckForChangesSeconds Default Value: 1 Description: How often the Schedule Broadcast Manager checks for changes on datasets it is already processing. | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| CheckForDatasetsSeconds Default Value: 5 Description: The frequency of Schedule Broadcast Manager checks for new datasets. | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| JsonFormatVersion Default Value: 2 Allowed Values: 1 = Version 1; 2 = Version 2 Description: The DataSet JSON format when sending or receiving data. | LOADUPDATE | INTEGER | CONFIG | ORG |
| Port Default Value: 1364 Description: The port to use for remoting. | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| ProcessOnceOnlyBroadcastsOnRestart Default Value: True Description: Whether existing once only broadcasts should be processed on Schedule Broadcast Manager start. | RESTARTUPDATE | BOOLEAN | ADMIN | SYS |
Application: SES¶
| Parameter ID | Access | Data Type | Group | Class |
|---|---|---|---|---|
| ExplanationCacheDeleteAfter Default Value: PT10M Description: The amount of time to keep an unused schedule in the cache. | LOADUPDATE | TIMESPAN | CONFIG | ORG |
Application: SIM¶
| Parameter ID | Access | Data Type | Group | Class |
|---|---|---|---|---|
| ARPBreakPriority Default Value: -1 Description: Sets the value of the priority attribute on breaks created within the ARP. | DYNAMICUPDATE | INTEGER | CONFIG | ORG |
| AutoDurationConfidenceLevelThreshold Default Value: 80 Description: Threshold of confidence level for using duration estimate as auto duration | DYNAMICUPDATE | INTEGER | AUTOMATION | ORG |
| AutoDurationEnabledByDefault Default Value: False Description: Should activity auto durations be used by default. | DYNAMICUPDATE | BOOLEAN | AUTOMATION | ORG |
| AutoDurationReloadEstimatesPeriod Default Value: P1DT1H Description: How often duration estimates are reloaded when using auto durations. | DYNAMICUPDATE | TIMESPAN | AUTOMATION | ORG |
| AutoUpdateInputDateTime Default Value: False Description: Should the Schedule Input Manager periodically send Input References with the datetime advanced. This functionality is deprecated. | LOADUPDATE | BOOLEAN | AUTOMATION | ORG |
| AutoUpdateInputFrequency Default Value: PT1M Description: If auto-updating, frequency of update | LOADUPDATE | TIMESPAN | AUTOMATION | ORG |
| BroadcastToFileLocation Description: A file location to which the output plan should be broadcast | RESTARTUPDATE | STRING | ADMIN | SYS |
| CascadeSchedulingObjectDeletions Default Value: true Description: When an object deletion request has no specified value in the cascade column, this parameter value will be used instead. | DYNAMICUPDATE | BOOLEAN | CONFIG | ORG |
| DefaultDatasetId Default Value: Default Description: Default dataset id to be used when dataset is not specified | RESTARTUPDATE | STRING | ADMIN | SYS |
| ErrorDirectoryName Default Value: Errors Description: The subdirectory to write files to if there is an error | RESTARTUPDATE | STRING | ADMIN | SYS |
| HomeDirectory Default Value: C:\IFS\Scheduling Description: The location of the Schedule Input Manager home directory. | RESTARTUPDATE | STRING | ADMIN | SYS |
| InputDirectoryName Default Value: Input Description: The subfolder from which to pick input files up. | RESTARTUPDATE | STRING | ADMIN | SYS |
| InputHistoryDirectoryName Default Value: Input History Description: The subfolder to copy input files up to after processing | RESTARTUPDATE | STRING | ADMIN | SYS |
| InputHistoryUseDatasetSubfolders Default Value: False Description: If true the input history will be written to subfolders named after the dataset | RESTARTUPDATE | BOOLEAN | ADMIN | SYS |
| InputTriggerFileName Description: A trigger file to look for before processing new data. | RESTARTUPDATE | STRING | ADMIN | SYS |
| MaximumPooledTasks Default Value: 16 Description: A positive value limits the number of tasks (updates) that the Schedule Input Manager will process simultaneously. | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| Port Default Value: 1368 Description: The port to use for remoting. | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| RemotingWaitTimeout Default Value: PT30S Description: The maximum time to wait for data to be processed on a remoting call | DYNAMICUPDATE | TIMESPAN | ADMIN | SYS |
| SetDatasetsToReactiveOnInput Default Value: false Description: Determines if dynamic scheduling datasets are set to reactive on input | RESTARTUPDATE | BOOLEAN | ADMIN | SYS |
| StandbyEnabled Default Value: False Description: If true, Schedule Input Manager sends data to StandbyHost | RESTARTUPDATE | BOOLEAN | ADMIN | SYS |
| StandbyHostRemotingString Description: Secondary Schedule Input Manager for standby/failover | RESTARTUPDATE | STRING | ADMIN | SYS |
| SynchronousMode Default Value: False Description: Whether to ensure synchronicity when running the Schedule Input Manager | RESTARTUPDATE | BOOLEAN | ADMIN | SYS |
| UpdateFootprintOnLoad Default Value: True Description: Should the Schedule Input Manager update the dataset footprint when processing a LOAD? | RESTARTUPDATE | BOOLEAN | ADMIN | SYS |
| WriteInputHistoryToDisk Default Value: True Description: Whether, or not, the Schedule Input Manager should write the input history to a file on the host machine disk | RESTARTUPDATE | BOOLEAN | ADMIN | SYS |
Application: SML¶
| Parameter ID | Access | Data Type | Group | Class |
|---|---|---|---|---|
| AutoGenerateResourceTypes Default Value: False Description: When running an automatic test using resource types, this determines whether additional resource types are created automatically to match skill profiles. | DYNAMICUPDATE | BOOLEAN | ADMIN | ORG |
| CheckForRequestsSeconds Default Value: 1 Description: How often the Scheduling Simulation Service checks for work to do. | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| KeepDeletedSimulationDataHours Default Value: 168 Description: Hours to keep deleted simulation data before removing, default is 168 hours (1 Week). | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| ManageSimulationDataTimeOfDay Default Value: PT4H Description: Time of day to manage old or deleted simulation data. | RESTARTUPDATE | TIMESPAN | ADMIN | SYS |
| Port Default Value: 1376 Description: The port to use for remoting. | RESTARTUPDATE | INTEGER | ADMIN | SYS |
Application: SMM¶
| Parameter ID | Access | Data Type | Group | Class |
|---|---|---|---|---|
| AutoScale Default Value: False Description: Determines whether to set auto-scale for the deployment | RESTARTUPDATE | BOOLEAN | ADMIN | SYS |
| CheckForRequestsSeconds Default Value: 10 Description: The frequency to check for new requests | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| DatabaseScaleTimeout Default Value: PT1H Description: Timeout period for scaling the database performance level | RESTARTUPDATE | TIMESPAN | ADMIN | SYS |
| DbDTUScaleDownThreshold Default Value: 0.2 Description: Threshold DTU usage to scale down the database | RESTARTUPDATE | DOUBLE | ADMIN | SYS |
| DbDTUScaleUpThreshold Default Value: 0.8 Description: Threshold DTU usage to scale up the database | RESTARTUPDATE | DOUBLE | ADMIN | SYS |
| DbStorageScaleDownThreshold Default Value: 0.2 Description: Threshold storage usage to scale down the database | RESTARTUPDATE | DOUBLE | ADMIN | SYS |
| DbStorageScaleUpThreshold Default Value: 0.8 Description: Threshold storage usage to scale up the database | RESTARTUPDATE | DOUBLE | ADMIN | SYS |
| DbUsageCheckPeriod Default Value: PT10M Description: Time period to check database usage over | RESTARTUPDATE | TIMESPAN | ADMIN | SYS |
| DeploymentMode Default Value: standard Allowed Values: standard = standard; multi_role = multi role; portal = portal Description: The deployment mode being used, e.g. standard, portal, multi role | RESTARTUPDATE | STRING | ADMIN | SYS |
| InstanceBootTimeoutPeriod Default Value: PT10M Description: Instance bootup timeout period | DYNAMICUPDATE | TIMESPAN | ADMIN | SYS |
| InstanceManagementHandlingMethod Default Value: None Description: The method to use to add or remove server instances | RESTARTUPDATE | STRING | ADMIN | SYS |
| InterfaceToDSERatio Default Value: 0.5 Description: Ratio of Interface machines to DSE machines | DYNAMICUPDATE | DOUBLE | ADMIN | SYS |
| ManageWorkloadFrequency Default Value: PT1M Description: Frequency for workload management and auto-scaling checks | DYNAMICUPDATE | TIMESPAN | ADMIN | SYS |
| Port Default Value: 8746 Description: Scheduling Machine Manager port | RESTARTUPDATE | INTEGER | ADMIN | SYS |
Application: SQM¶
| Parameter ID | Access | Data Type | Group | Class |
|---|---|---|---|---|
| AllowMultipleInstancesPerDataset Default Value: True Description: Allow multiple Schedule Query Manager instances to process the same dataset. | DYNAMICUPDATE | BOOLEAN | ADMIN | SYS |
| AllowMultipleReplicaDatasetsPerInstance Default Value: True Description: If set to false, an instance will only run a replica dataset if it would othewise by unused. | DYNAMICUPDATE | BOOLEAN | ADMIN | SYS |
| CheckForChangesSeconds Default Value: 1 Description: How often the Schedule Query Manager checks for changes on datasets it is already processing. | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| CheckForDatasetsSeconds Default Value: 5 Description: The frequency of Schedule Query Manager checks for new datasets. | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| OnDemandScheduleCacheDeleteAfter Default Value: PT10M Description: The amount of time to keep an unused on demand schedule in the cache. | LOADUPDATE | TIMESPAN | ADMIN | SYS |
| Port Default Value: 8733 Description: The port to use for remoting. | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| ScheduleCacheDeleteAfter Default Value: PT1H Description: The amount of time to keep an unused schedule in the cache. | RESTARTUPDATE | TIMESPAN | ADMIN | SYS |
| ScheduleCacheMaxRows Default Value: 3000000 Description: The maximum number of rows to keep in the schedule cache. | RESTARTUPDATE | INTEGER | ADMIN | SYS |
Application: SRG¶
| Parameter ID | Access | Data Type | Group | Class |
|---|---|---|---|---|
| BaseHref Description: The base href used when loading gateway assets | RESTARTUPDATE | STRING | ADMIN | SYS |
| EnableSwaggerUI Default Value: False Description: Enables the Swagger UI for the Scheduling RESTful Gateway | DYNAMICUPDATE | BOOLEAN | ADMIN | SYS |
| GetUsageLegacyResponse Default Value: False Description: If set to true the Usage endpoint will return an old structured response. This can be used for backwards compatability. | DYNAMICUPDATE | BOOLEAN | CONFIG | ORG |
| JsonFormatVersion Default Value: 2 Allowed Values: 1 = Version 1; 2 = Version 2 Description: The DataSet JSON format when sending or receiving data. | DYNAMICUPDATE | INTEGER | CONFIG | ORG |
| MaximumODataRecords Default Value: 100000 Description: The maximum number of records to return from the OData APIs | DYNAMICUPDATE | INTEGER | ADMIN | SYS |
| McpRateLimitRequestsPerMinute Default Value: 120 Description: Maximum MCP requests per service instance per minute. 0 disables rate limiting. | RESTARTUPDATE | INTEGER | CONFIG | SYS |
Application: SSM¶
| Parameter ID | Access | Data Type | Group | Class |
|---|---|---|---|---|
| CheckForRequestsSeconds Default Value: 10 Description: Frequency for checking for requests | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| CheckServiceResilienceSeconds Default Value: 20 Description: Relates to stop/start of required services to ensure that a Role configuration is satisfied | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| DeploymentMode Default Value: standard Allowed Values: standard = standard; multi_role = multi role; portal = portal Description: The deployment mode for the system | RESTARTUPDATE | STRING | ADMIN | SYS |
| MonitorServiceResilience Default Value: False Description: Whether, or not, to monitor the role configuration for the deployment and take action if required (e.g. stop/starting services to satisfy resiliency checks) | RESTARTUPDATE | BOOLEAN | ADMIN | SYS |
| Port Default Value: 8001 Description: Scheduling Service Manager port number | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| ReassignRoleIfRequiredSeconds Default Value: 60 Description: How often to check if role reassignment is required | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| RoleBasedDeployment Default Value: False Description: Indicates whether role-based deployment of applications is in use | RESTARTUPDATE | BOOLEAN | ADMIN | SYS |
Application: SWB¶
| Parameter ID | Access | Data Type | Group | Class |
|---|---|---|---|---|
| ActivityAvailabilityLeeway Default Value: PT12H Description: The amount of leeway when deciding if an activity is available. | DYNAMICUPDATE | TIMESPAN | WORKBENCH | ORG |
| ActivityLabel Default Value: {Activity.#label} Description: The label used to identify allocations. | DYNAMICUPDATE | STRING | LABEL | ORG |
| ActivitySubtext Default Value: {#status} Description: The text to show in the second line on activities in the Scheduling Workbench Gantt. | DYNAMICUPDATE | STRING | LABEL | ORG |
| ActivityText Default Value: {#label} Description: The text to show on activities in the Scheduling Workbench Gantt. | DYNAMICUPDATE | STRING | LABEL | ORG |
| AllowCompleteWithoutOnSite Default Value: False Description: Allow activity status to be set Completed without first setting on site. | DYNAMICUPDATE | BOOLEAN | WORKBENCH | ORG |
| AppointmentOffersRetentionPeriodSeconds Default Value: 180 Description: Appointment booking offers retention period in seconds | DYNAMICUPDATE | INTEGER | WORKBENCH | ORG |
| ARPAppointmentTemplateItemLabelFormat Default Value: {AppointmentTemplate.#label} {slot_start_time}-{slot_end_time} Description: Label format for appointment template items | DYNAMICUPDATE | STRING | LABEL | ORG |
| ARPAttributeAllowedValueLabelFormat Default Value: {Attribute.#label} {description} Description: Label format for attribute allowed values | DYNAMICUPDATE | STRING | LABEL | ORG |
| ARPCapacityPartLabelFormat Default Value: {Capacity.#label} {Part.#label} Description: Label format for capacity parts | DYNAMICUPDATE | STRING | LABEL | ORG |
| ARPShiftTemplateSetItemLabelFormat Default Value: {ShiftTemplateSet.#label} {ShiftTemplate.#label} Description: Label format for shift template set items | DYNAMICUPDATE | STRING | LABEL | ORG |
| ARPTravelPenaltyLabelFormat Default Value: {TravelCostModel.#label} {TravelPenaltyType.#label} Description: Label format for travel penalties | DYNAMICUPDATE | STRING | LABEL | ORG |
| ARPUtilisationTemplateItemLabelFormat Default Value: {UtilisationTemplate.#label} {applicable_from} Description: Label format for utilisation template items | DYNAMICUPDATE | STRING | LABEL | ORG |
| AutoResultsDisplay Default Value: 1 Description: Controls whether to do nothing (0), prompt the user (1) or automatically display (2) automatic results | DYNAMICUPDATE | INTEGER | AUTOMATION | ORG |
| CommitToAllocatedShift Default Value: False Description: Determines whether activities should be kept in the shift they are allocated in when manually committing | DYNAMICUPDATE | BOOLEAN | WORKBENCH | ORG |
| CSVseparator Default Value: , Description: The single character used to separate values in a CSV file. | DYNAMICUPDATE | STRING | WORKBENCH | ORG |
| DefaultCost_km Default Value: 0.25 Description: The default cost per kilometre's travel for a new resource | DYNAMICUPDATE | DOUBLE | WORKBENCH | ORG |
| DefaultCost_ph Default Value: 20 Description: The default cost per hour for a new resource | DYNAMICUPDATE | DOUBLE | WORKBENCH | ORG |
| DefaultCost_ph_ot Default Value: 30 Description: The default cost per hour's overtime for a new resource | DYNAMICUPDATE | DOUBLE | WORKBENCH | ORG |
| DefaultHireCost Default Value: 4000 Description: The default cost of hiring a resource | DYNAMICUPDATE | DOUBLE | WORKBENCH | ORG |
| DefaultReleaseCost Default Value: -1 Description: The default cost of releasing a resource | DYNAMICUPDATE | DOUBLE | WORKBENCH | ORG |
| DefaultRelocationCost Default Value: 2000 Description: The default cost of relocating a resource | DYNAMICUPDATE | DOUBLE | WORKBENCH | ORG |
| DefaultShiftDurationHours Default Value: 8 Description: The default duration of a new shift | DYNAMICUPDATE | DOUBLE | WORKBENCH | ORG |
| DefaultShiftPatternIncludeWeekends Default Value: False Description: Whether new shift patterns should include weekends by default | DYNAMICUPDATE | BOOLEAN | WORKBENCH | ORG |
| DefaultShiftStartHour Default Value: 9 Description: The default start hour of a new shift | DYNAMICUPDATE | DOUBLE | WORKBENCH | ORG |
| DefaultUtilisation Default Value: 100 Description: The default utilisation of a new resource | DYNAMICUPDATE | INTEGER | WORKBENCH | ORG |
| DragAndDropCommitOption Default Value: OpenManualChanges Allowed Values: OpenManualChanges = Open Manual Changes; CommitToResource = Commit To Resource; ValidateAndCommitToResource = Validate And Commit To Resource Description: Defines activity scheduling options via drag and drop | DYNAMICUPDATE | STRING | WORKBENCH | ORG |
| EnableDragDrop Default Value: False Description: Enables drag and drop on the Scheduling Workbench | DYNAMICUPDATE | BOOLEAN | WORKBENCH | ORG |
| ExternalSystemAccountId Description: The account id for an external system that is being used to remotely run scheduling calculations | DYNAMICUPDATE | STRING | WORKBENCH | ORG |
| ExternalSystemGatewayURL Description: The URL for contacting a Gateway that resides on an external system | DYNAMICUPDATE | STRING | WORKBENCH | ORG |
| ExternalSystemOrganisationId Default Value: 1 Description: The Organisation ID used when contacting an external system | DYNAMICUPDATE | INTEGER | WORKBENCH | ORG |
| ExternalSystemRemotingType Default Value: BINDING_WS_HTTP_SECURITY_NONE Description: The remoting type used for external system binding | DYNAMICUPDATE | STRING | WORKBENCH | ORG |
| ExternalSystemUserId Description: The User ID used when contacting an external system | DYNAMICUPDATE | STRING | SECURITY | ORG |
| ExternalSystemUserPassword Description: Password for an external user | DYNAMICUPDATE | MASKED | SECURITY | ORG |
| GanttColourDataTableRowBackgroundHighlight Default Value: FFFFC080 Description: The Gantt data table row highlight background colour. | DYNAMICUPDATE | STRING | THEME | ORG |
| GanttHideUninterestingTimes Default Value: True Description: Whether or not to collapse unused time on the Gantt. | DYNAMICUPDATE | BOOLEAN | WORKBENCH | ORG |
| GanttInitialDisplayDuration Default Value: P1D Description: The approximate schedule duration displayed initially | DYNAMICUPDATE | TIMESPAN | WORKBENCH | ORG |
| IgnoreZeroLengthShifts Default Value: True Description: If true then any zero length shifts found in a shift template will be ignored. | DYNAMICUPDATE | BOOLEAN | WORKBENCH | ORG |
| IsochroneTravelTimes Default Value: 30,60,120 Description: Default values for isochrone travel times. | DYNAMICUPDATE | STRING | WORKBENCH | ORG |
| iSWBDistanceUnit Default Value: 0 Allowed Values: 0 = Use system default; 1 = Metric (km); 2 = Imperial (miles) Description: The units of distance displayed within the Scheduling Workbench | DYNAMICUPDATE | INTEGER | WORKBENCH | ORG |
| iSWBMapKey Description: The key used for viewing maps on the ISWB | DYNAMICUPDATE | STRING | WORKBENCH | ORG |
| iSWBMapType Description: The map type used when viewing maps on the ISWB | DYNAMICUPDATE | STRING | WORKBENCH | ORG |
| LocationLabel Default Value: {Location.name} {Location.id} Description: The label used to identify locations. | DYNAMICUPDATE | STRING | LABEL | ORG |
| ManualSnapshotExpiryPeriod Default Value: P7D Description: The expiry period to use when manually creating a snapshot on the data capture screen. | DYNAMICUPDATE | TIMESPAN | WORKBENCH | ORG |
| MassFixActivityStatuses Default Value: 10,30,32,35,40 Description: Specifies which activity statuses are affected by mass fixing. | DYNAMICUPDATE | STRING | WORKBENCH | ORG |
| MassUnfixActivityStatuses Default Value: 30,32,35,40 Description: Specifies which activity statuses are affected by mass unfixing. | DYNAMICUPDATE | STRING | WORKBENCH | ORG |
| MaximumSavedSchedules Default Value: 10 Description: The maximum number of schedules a user can save. | DYNAMICUPDATE | INTEGER | WORKBENCH | ORG |
| NoActivityChangesFromStatus Description: Manual changes are not allowed to an activity when it has reached this status. | DYNAMICUPDATE | STRING | WORKBENCH | ORG |
| NoStatusChangesFromStatus Description: Manual changes are not allowed to an activity's status when it has reached this status. | DYNAMICUPDATE | STRING | WORKBENCH | ORG |
| PrivateActivityLabel Default Value: {Activity.description} Description: The label used to identify private activities. | DYNAMICUPDATE | STRING | LABEL | ORG |
| PrivateActivityText Default Value: {Activity.description} Description: The text to show on private activities. | DYNAMICUPDATE | STRING | LABEL | ORG |
| ReasonRequired Default Value: False Description: Whether to ask for a reason when making SWB changes to activities. | DYNAMICUPDATE | BOOLEAN | WORKBENCH | ORG |
| ResourceAvailabilityLeeway Default Value: PT30M Description: The amount of leeway when deciding if a resource is available for work. | DYNAMICUPDATE | TIMESPAN | WORKBENCH | ORG |
| ResourceLabel Default Value: {Resources.first_name} {Resources.surname} [{Resources.id}] {time_zone_if_offset} Description: The label used to identify resources. | DYNAMICUPDATE | STRING | LABEL | ORG |
| ResourceSubtext Default Value: {Resource.first_name} {Resource.surname} Description: The text to show in the second line on the resource column. | DYNAMICUPDATE | STRING | LABEL | ORG |
| ResourceText Default Value: {id} {time_zone_if_offset} Description: The main text to show on the resource column. | DYNAMICUPDATE | STRING | LABEL | ORG |
| SelectableActivityStatuses Default Value: -1,0,10,30,32,35,40,50,55,60,65,70,80 Description: Specifies which activity statuses can be selected for manual changes. | DYNAMICUPDATE | STRING | WORKBENCH | ORG |
| ShowOvertime Default Value: True Description: Whether or not to show shift overtime on the Scheduling Workbench. | DYNAMICUPDATE | BOOLEAN | WORKBENCH | ORG |
| ShowSeparationConstraints Default Value: False Description: Whether or not to show activity separation constraints on the Scheduling Workbench. | DYNAMICUPDATE | BOOLEAN | WORKBENCH | ORG |
| ShowSnapTime Default Value: True Description: Whether or not to show shift snap time on the Scheduling Workbench. | DYNAMICUPDATE | BOOLEAN | WORKBENCH | ORG |
| ShowUnusedDetailsTabs Default Value: False Description: Show unused tabs on Activity and Resource Details | DYNAMICUPDATE | BOOLEAN | WORKBENCH | ORG |
| SLAActivityAgeingFactor Default Value: 3 Description: SLA activity ageing factor | DYNAMICUPDATE | INTEGER | WORKBENCH | ORG |
| StandardSendScheduleExceptionAccepts Default Value: false Description: Should the SWB send accepts for schedule exceptions directly to PSO even if a WORKBENCH broadcast type is specified | DYNAMICUPDATE | BOOLEAN | WORKBENCH | ORG |
| TargetImportance Default Value: 33 Description: The importance given to meeting targets when running tests | DYNAMICUPDATE | DOUBLE | WORKBENCH | ORG |
| TargetImportanceSoftMultiplier Default Value: 0.5 Description: The multiplier for the importance of soft constraints in relation to hard constraints | DYNAMICUPDATE | DOUBLE | WORKBENCH | ORG |
| ThemeProfileID Description: Profile used for applying theme parameters | DYNAMICUPDATE | STRING | WORKBENCH | ORG |
| TrafficLight_AmberMinutes Default Value: 3 Description: Number of minutes before the traffic light goes amber. | DYNAMICUPDATE | DOUBLE | WORKBENCH | ORG |
| TrafficLight_RedMinutes Default Value: 5 Description: Number of minutes before the traffic light goes red. | DYNAMICUPDATE | DOUBLE | WORKBENCH | ORG |
| TreatMembershipWithNoCategoryAsUtilised Default Value: True Description: If this is set to false, then the utilisation bar on the resource pool display will only show rota membership as utilised if it is associated to a membership category. | DYNAMICUPDATE | BOOLEAN | WORKBENCH | ORG |
| TurnByTurnDirectionsKey Description: The access key corresponding to the provider used to fetch turn-by-turn directions | DYNAMICUPDATE | STRING | WORKBENCH | ORG |
| TurnByTurnDirectionsProvider Description: The provider used to fetch turn-by-turn directions | DYNAMICUPDATE | STRING | WORKBENCH | ORG |
| UpdateFrequency Default Value: PT30S Description: How often to refresh the schedule on the Scheduling Workbench. | DYNAMICUPDATE | TIMESPAN | WORKBENCH | ORG |
Application: TRA¶
| Parameter ID | Access | Data Type | Group | Class |
|---|---|---|---|---|
| EnvelopMaxDistanceLarge Default Value: 4000 Description: Large max distance to look for the next point of the envelope. | RESTARTUPDATE | DOUBLE | TRAVEL | ORG |
| EnvelopMaxDistanceSmall Default Value: 3000 Description: Small max distance to look for the next point of the envelope. | RESTARTUPDATE | DOUBLE | TRAVEL | ORG |
| GridMetresForSLTravel Default Value: 1000 Description: Default value for grid size(in metres) when using SL calculation. | LOADUPDATE | DOUBLE | TRAVEL | ORG |
| MaxIsochroneCalculationThreads Default Value: 1 Description: Maximum number of threads to calculate isochrones. | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| Port Default Value: 1374 Description: The port to use for remoting. | RESTARTUPDATE | INTEGER | ADMIN | SYS |
| PostProcessEnvelopeMetres Default Value: 300 Description: Distance (in metres) to move a node when splitting it. | RESTARTUPDATE | DOUBLE | TRAVEL | ORG |
| RoutingCacheExpiryDuration Default Value: P1DT12H Description: Period after which an area in the routing cache will be removed if not used. | DYNAMICUPDATE | TIMESPAN | ADMIN | SYS |
| TravelAnalysisDiagnosticsPath Description: Scheduling Travel Analyser Diagnostics Path. | LOADUPDATE | STRING | ADMIN | SYS |