List of Preferences
general (35)
interface (71)
constraints (40)
algorithms (45)
gantt (41)
calendar (14)
geography (56)
map (17)
workflow (1)
other (18)
geocoder (15)
tables (22)
windows (19)
none (24)
web (3)
Total number of preferences: 421
general
| Id | Description | Datatype | Default |
|---|---|---|---|
| BatchAlgorithm | Indicates the algorithm to be used in batch mode. | | |
| BatchAlgorithms | Indicates the list of algorithms that are used in batch mode. | | |
| CheckWorkingDay | Indicates whether to check for a working day when running in batch mode. In case a batch is started on a public holiday or weekend, it will not be executed. A warning is written to the log. | | |
| MaxWarnings | The maximum number of warnings that may occur before stopping the batch process. | | |
| KeepDays | The number of days that should be kept after applying the algorithm(s) when running in batch mode. Only applicable when dayoffset is specified on the command line and does not equal -1. A KeepDays value of -1 keeps every day from dayOffset onwards. A zero value will not keep any data at all, i.e. not the dayOffset data either. | | |
| KeepWithinDayOffset | Whenever planned tasks within the dayoffset are offered as planned to the batch routine, they will be unplanned by default. If this parameter is set, tasks within the dayoffset will not be unplanned for further processing. This parameter is only applicable in batch mode | | |
| OptimizeTripAfterBatch | Optimize trip in batch mode when the trip is kept and saved to output. | | |
| OptimizeTripAfterBatchIncludingDayoffset | Optimize trips including those within the dayoffset | | |
| batchLimitToMidnight | | | |
| batchUseInGUI | If this option is set, the list of algorithms is applied if the user requests automatic planning. | | |
| logLevel | The log level. The logging level can vary from OFF to ALL. Depending on the level, only ceratain messages are logged. All logged messages are written to the log file. | | |
| logFilename | The name of the log file to which all logging messages are written. The log file remains locked until the application has stopped. The file contains in fact an XML document which can be read with a standard browser or XML editors. Reading the log file while it is still accessed by the application will fail due to the fact that the last closing tag is written to the file during shutdown. | | |
| MobileLatency | Latency in minutes that is applicable when sending messages to the field service engineer. The value is used to shift the start of a task to a realistic time when planning is close to the time line. | | |
| MobileLatencyTransactionBuffer | | | |
| LAF | The attribute name for the preferred Look and Feel. Supported look and feels are Metal, Windows, Motif. The System look and feel defaults to the platforms' standard look and feel. | | |
| locale | | | |
| desktopLayout | | | |
| GUILoggingLevel | The logging level that is used while the applicaiton is running | | |
| AdviceOptions | This parameter limits the number of options that are displayed whenever a user requests new planning options for a task. Only the least expensive options are presented, sorted by the individual cost of each option. | | |
| AlgorithmConfirmInsert | Let the user confirm an insert. | | |
| allowWarningConfirmation | Let the user confirm warnings. Confirmed warnings will not appear as an icon on the Gantt chart anymore. | | |
| autoFillRequiredResource | When this option is set, the required resource (if defined) will be automatically filled as the planned resource when opening an unplanned task dialog. | | |
| shiftToTimeLine | Shifts the starting time of a task to the time line plus the travel time. | | |
| alwaysShiftForOptions | Always shift to the time line when calculating insertion options. | | |
| MoveFirstVisitWithTimeline | Do not move first task on the trip with timeline if this option is false. Default is true. | | |
| hasStartedIsFixed | If set to true, visits that are currently performed are not allowed to be moved. | | |
| ExtendExceedingVisits | Extends visits that are exceeding the current timeline. | | |
| ExtendExceedingVisitsAfterMinutes | Extends visits after a specific number of minutes. | | |
| DocumentationURL | Location of documentation. | | |
| GanttSurpressStopIcon | Surpress stop icon if this option is set false. Default is true. | | |
| ShowEndOutsideOpeningHoursIcon | Show warning icon if visit ends outside of the opening hours. Default is true. | | |
| taskIdFormat | A simple format mask used to convert the unique task id into a human-readable format. A X character in the simple format removes the character at that position. A # copies the appropiate character, whereas any other character will be inserted at the specified position. For example, a input text of 00033459600100000000 and a simple format of XXX######-###XXXXXXXX will result in 334596-001. | | |
| ToolTipInitial | The milliseconds to wait before a tooltip pops up. | | |
| ToolTipDismiss | The milliseconds to wait before a tooltip poup disappears. | | |
| ToolTipReshow | The milliseconds to wait before a tooltip reshows after a move. | | |
interface
| Id | Description | Datatype | Default |
|---|---|---|---|
| InterfaceModeRead | The interface read mode. S4 can handle different interface modes for read and write. For example, in a configuration data can be read in SQL mode, but the result of the planning is written to an XML document. | | |
| InterfaceModeWrite | The interface write mode. S4 can handle different interface modes for read and write. For example, in a configuration data can be read in SQL mode, but the result of the planning is written to an XML document. | | |
| connectString | The JDBC connect string, identifying the database URL, for example, jdbc:microsoft:sqlserver://SRV-RKF-10:1433;SelectMethod=Cursor | | |
| JDBCDriverClass | The name of the JDBC driver used during the connection with the database. The class must be accessible through the system's CLASSPATH. | | |
| SQLLanguage | The SQL language, set with the SET LANGUAGE command (not supported by all databases). If the parameter is not defined, the connection language will be the default language. | | |
| organizationId | The id of the organization, used in conjunction with ERP systems that differentiate several organizations in the same database instance. | | |
| username | The name of the database account the SQL interface should connect to. | | |
| password | The password. | | |
| useInitialization | If this flag is set, S4 applies initializationSf in conjunction with the applicationUser and credentials parameters right after the connection is succesfully opened. If this flag is not set, the initialization function is not applied. | | |
| initializationSf | A stored function that initializes the connection. Used in scenarios where the user name is not equal to the application user name or in cases where some initialization needs to be performed before retrieving data from the interface views. S4 calls this function with the parameters applicationUser and credentials. | | |
| applicationUser | The application user name, which may vary from the database username. In case no application user name is used, leave this field blank. | | |
| credentials | The credentials for the application user name. Not required if the back-office system does not make use of application users and credentials/responsabilities. | | |
| territoriesView | The name of the view containing a name, description list of the territories that are available to the user. If this view is specified, the user is asked to choose a selection from the list of available territories before actually loading the data. The selection causes an additional clause to be added to the resource and task queries. If this view is not defined, a pre-selection of territories is not possible. | | |
| tasksView | The name of the tasks view. | | |
| taskDependencyView | Task Dependency View | | |
| resourcesView | The name of resources view. | | |
| skillsView | The name of skills view. | | |
| breaksView | The name of the breaks view. | | |
| workPatternView | A table containing working hours for each day of the week. Working patterns can be assigned to resources to define their standard working hours. | | |
| workingHoursView | A definition of the working hours of a day. It is possible to specify a floating break, i.e. a pauze that needs to be assured between certain hours. | | |
| holidayCalendarsView | A list of dates that form together a set of public holidays are grouped in a HolidayCalendar object. If a resouce is assigned to a HolidayCalendar, the public holidays of that calendar are not considered a working day. If a resource does not have a HolidayCalendar assigned, the standard public holidays as defined in the preferences will be taken into account. Different resources may be assigned to different holiday calendars. | | |
| publicHolidaysView | A day in which the resources that are assigned to a calendar containing the public holiday, are unavailalble. | | |
| resourceTaskWhereClause | A where clause that is to be applied when querying the resources and tasks. For example, the where clause could resrict the territories that are to be retrieved. | | |
| resourceWorkPatternView | This element is used to represent a many-to-many relationship between resources and work patterns. | | |
| systemView | The name of the system view. | | |
| StandardFetchSize | This number specifies the fetch buffer. Change this value with caution. It may have an impact on speed and memory. | | |
| sqlSequenceQuery | The query that retrieves the next possible/available key value. For example, the query is used to retrieve a unique number for a new break. | | |
| taskInsertSf | | | |
| taskUpdateSf | The name of the stored function that allows to update of a task for both date/time and resource assignment. If S4 is used with a non-SQL write mode, this field is not required. If using direct SQL mode, i.e. without stored funtions to update planning data, this field must be empty. | | |
| UseLastUpdate | Use Last Update | | |
| useLocking | Test whether data has changed before posting changes. | | |
| resourceGroupView | | | |
| resourceGroupAssignmentView | | | |
| breakTypeTable | A table containing the types of breaks. If defined, the types are offered for selection when inserting or updating a break. | | |
| breakChargeToTable | A table containing the accounts that breaks are chargeable to. If defined, the accounts are offered for selection when inserting or updating a break. | | |
| connectRetry | The number of times a connection attempt should be repeated before stopping. If 0 is specified, the application will not attempt to reconnect. If -1 is specified, the application will try to reconnect perpertually. | | |
| connectRetryWait | The number of milliseconds the application should wait before attempting to connect again. | | |
| breakDelete | Name of the break delete function. | | |
| breakInsert | Name of the break insert function. | | |
| breakUpdate | Name of the break update function. | | |
| SQLNormalizeAfterRefresh | Normalize the day after each refresh. | | |
| UseRefreshInterval | Use regular Refresh. | | |
| RefreshAskUser | Indicates if the user needs to be asked before refreshing. This option is without meaning in a batch mode environment. | | |
| RefreshInterval | Refresh Interval in seconds. | | |
| InterfaceBackInTime | Time that is looked back to catch formerly open transactions that have been committed after a refresh. | | |
| planAutomatically | Plan unplanned tasks after refreshing. If planAutomatically is set, all batch algorithms will be applied after refresh. This option is only valid in visual mode. In that case, tasks will be checked for the planAutomatically flag is the preference planAll is not set. | | |
| planAllAutomatically | Plan all unplanned tasks after refreshing, regardless of the planAutomatically property of a task. By default, only tasks with the planAutomatically property set will be considered for the automatic planning. This can be overruled by selecting the planAll preference, which will force all unplanned tasks to be added to the plan automatically after the refresh. | | |
| DefaultEstimatedDuration | The default estimated duration of a task that has no duration definition | | |
| DefaultMaximumVolume | The default maximum volume for a resource that has no weight defined | | |
| DefaultMaximumWeight | The default maximum weight for a resource that has no weight defined | | |
| DefaultVolume | Default volume if not defined in task data | | |
| DefaultWeight | Default weight if not defined in task data | | |
| HTTPSecurityPrincipal | The username that is to be used when connecting to the HTTP server. | | |
| HTTPSecurityCredentials | The password that is to be used when connecting to the HTTP server. | | |
| HTTPProviderURL | The URL of the HTTP server | | |
| LoadRecalculate | Recalculate trips after loading. | | |
| LoadOptimize | Optimize trips after loading. Optmization performs a recalculate, so the two options are mutual exclusive. | | |
| Encoding | The attribute name for the codepage during XSL conversion | | |
| FlatFileWaitInterval | Wait interval during the flag mechanism of a flat file interface. | | |
| XMLInputStylesheet | Applied XSL to XML input | | |
| XMLOutputStylesheet | Applied XSL to XML output | | |
| InterpretSkillLevelAsFactor | Some resources may actually terminate a task faster than others. If this parameter is set, the skill level is used as a factor when adjusting the duration of a visit. | | |
| SplitBreaksInDays | Breaks across days are split into breaks per day. | | |
| GoogleUserName | | | |
| GoogleUserPassword | | | |
| MailServer | | | |
| MailProtocol | | | |
| MailPort | | | |
| MailAccount | | | |
| MailPassword | | | |
| MailDomain | | |
constraints
| Id | Description | Datatype | Default |
|---|---|---|---|
| AcceptTerritories | match task territories with resource territories | | |
| AcceptTerritoriesIsHard | match task territories with resource territories is a hard restriction | | |
| UseSkills | match task capability with resource capability | | |
| UseSkillsIsHard | match task capability with resource capability is a hard restriction | | |
| checkRequiredResource | Verify required resource if specified | | |
| UseOpeningHours | use opening hours (if specified). | | |
| AcceptStartOutsideOpeningHours | Indicates whether visits starting outside openings hours is acceptable. The cost parameter startingOutsideOpeningHours is not enough to block a prohibitive planning. | | |
| VolumeWeightIsHard | | | |
| UseVolumeWeight | | | |
| UseTaskGroups | Tasks can be bundled into groups, allowing the planning algorithms to plan the tasks within a single trip, if possible. | | |
| TaskGroupIsServiceStop | | | |
| AllowTaskGroupGaps | Tasks within a group must be planned in sequence without interruption of tasks from other groups. | | |
| IgnoreWeekendTaskGroupGaps | Interruptions across weekends are acceptable, if this option is set. | | |
| OvertimeFactor | The overtime costs are calculated by comparing the (end) time of the arrival to the end time of the second last stop. In case they are subsequent in time, no costs are applied. Otherwise, the time difference (in minutes) is multiplied with the overtime factor. The overtime factor defaults to 1 and can be influenced in the Preferences dialog. | | |
| MaxOvertime | During assignment of a task, overtime is limited by the maximum overtime parameter. If this parameter is exceeded, the task will not be considered as an option. During planning, this parameter is considered a hard restriction. | | |
| MaxWorkload | The amount of time of the available standard working hours of a resource can be limited to a certain percentage. The MaxWorkload parameter indicates this percentage. The value may be higher than 100 to indicate that overtime is accepted. The workload is based on the sum of all stop durations in a trip including travel time. During planning, this parameter is considered a hard restriction. | | |
| TravelTime | In general, each stop adds a cost to the plan that is relative to the travel time (in minutes) to reach the location of the next stop. | | |
| TravelDistance | In general, each stop adds a cost to the plan that is relative to the distance (in kilometers) to reach the location of the next stop. | | |
| LastTravelCostPrecentage | Adaption factor for cost for last travel in percent | | |
| ReturnTripCompensationFactor | cost for the duration of a trip in comparison to the length of the working hours. | | |
| Overlap | A possible time overlap with the next stop (including the second last stop that might overlap with the arrival) results in additional costs. The overlap in (minutes) is multplied with the Overlap factor and is added to the total cost of a trip. | | |
| TaskTooEarly | Different stop types may have different cost parameters. For example, visits are bound to certain time limits, called earliest and latest. S4 tries to place the task between these boundaries. In case this is not possible, the visit will exceed one of these boundaries which will provoke additional costs. | | |
| TaskTooLate | Different stop types may have different cost parameters. For example, visits are bound to certain time limits, called earliest and latest. S4 tries to place the task between these boundaries. In case this is not possible, the visit will exceed one of these boundaries which will provoke additional costs. | | |
| TaskTooEarlyLatePercentage | Points for exceeding earliest or latest are related to the width of the time window (latest - earliest). | | |
| Fixed | fixed cost for a task at it's best age | | |
| BestAge | Whenever a task is plannable between a earliest and latest boundary, there is usually a certain point that would be the best point for insertion. Imagine a regular task that is to be scheduled every seven weeks. Each single task will have an earliest and a latest, but getting close to the boundaries is not favorable, since the repetitive series will result in too short or too long time differences between the tasks. The best option to schedule the task would be at a certain point between earliest and latest, for example, in the sixth week. We herefore define a parameter called best age which is the percentage of the latest-earliest range where the task is preferably planned. In our example above, this would be 6/7 = 86%. Any scheduling before that point would result in larger costs, any schedling beyond this point will also result in additional costs. The absolute cost is called Fixed, representing the cost that is applied whenever the task is scheduled at exacty one of the boundaries. If planned at the best age, the cost is zero. The best starting time for a task is calculated by the following formula: best start(task) = earliest(task) + (latest(task) - earliest(task)) * BestAge/100 Setting best age to 0% indicates that the task should be planned as early as possible. Setting BestAge to 100% indicates that the task should be planned as late as possible. Costs planning outside of the earliest/latest bounderies is reflected by the TaskTooEarly and TaskTooLate parameters. In that case, the BestAge and Fixed parameters are not applied. The BestAge cost is only considered if the Fixed value is not 0. | | |
| TerritoryMismatch | territory mismatch | | |
| SkillMismatch | Whenever a task requires a certain skill, S4 only considers those resources that have this skill assigned. Resources may have different skill levels attached to the skill itself. For example, one resource is an expert for one particular machine. Another resource is recently trained and is only considered as a trainee. It is expected that the trainee will perform the task in a longer time that the expert. A mismatch of skills may result in a very high penalty/cost. A skill level mismatch may result in lower but still considerable costs. skill cost(visit) = skill level cost(visit) + (supports skill(resource, skill(visit))) ? 0 : skillMismatch where skill level cost(visit) = skill level too low cost(visit) + skill level too high cost(visit) and skill level too high cost(visit) = (skill level(resource, skill (visit)) > skill level(visit)) ? skillLevelTooHigh * skill level(resource, skill (visit)) - skill level(visit)) : 0 skill level too low cost(visit) = (skill level(resource, skill (visit)) < skill level(visit)) ? skillLevelTooLow * skill level(resource, skill (visit)) - skill level(visit)) : 0 This parameter is only applicable when the use Skills checkbox is selected. | | |
| SkillLevelTooHigh | Skill level too high | | |
| SkillLevelTooLow | Skill level too low | | |
| PreferredResourceMismatch | Service tasks may have preferred resources assigned. This is to increase the customer royalty towards a constant service representative and to limit costs during the travel to unknown sites. In case the preferred resource is not available or the costs to let this resource perform the task is too high, the backup resource may perform the task. In case the backup resource is not available or the costs are too high, another resource needs to perform the task. The preferred mismatch cost and the backup mismatch cost factors indicate the costs that need to be calculated when a task is not performed by a requested resource. | | |
| BackupResourceMismatch | Service tasks may have preferred resources assigned. This is to increase the customer royalty towards a constant service representative and to limit costs during the travel to unknown sites. In case the preferred resource is not available or the costs to let this resource perform the task is too high, the backup resource may perform the task. In case the backup resource is not available or the costs are too high, another resource needs to perform the task. The preferred mismatch cost and the backup mismatch cost factors indicate the costs that need to be calculated when a task is not performed by a requested resource. | | |
| StartsOutsideOpeningHours | Costs may occur whenever a task is planned outside of the customer's opening hours. Starting the service outside opening hours is prohibitive. Although in some cases the resource may start the task within the opening hours, it may be possible to extend the service beyond the opening hours. The endsOutsideOpeningHours factor and startsOutsideOpeningHours factor reflect the costs that are applied whenever visiting a customer outside the opening hours of that day. | | |
| EndsOutsideOpeningHours | Costs may occur whenever a task is planned outside of the customer's opening hours. Starting the service outside opening hours is prohibitive. Although in some cases the resource may start the task within the opening hours, it may be possible to extend the service beyond the opening hours. The endsOutsideOpeningHours factor and startsOutsideOpeningHours factor reflect the costs that are applied whenever visiting a customer outside the opening hours of that day. | | |
| PlannedShiftDuration | This is particularly useful with opening hours.to plan visits rather in the morning than in the afternoon since the costs for a visit later in the afternoon results in a long shift duration. The planned shift duration is calculated as the amount of minutes from the departure of a trip to the last visit for that day. Each minute of the planned shift duration is multiplied with the PlannedShiftDuration. | | |
| ExcessiveWeight | Each resource has a default maximum weight and volume it can carry (in a car or a truck). Any weight or volume surplus results in additional costs as defined by the ExcessiveWright and ExcessiveVolume parameters. The parameter is only applicable if the use Weight and use Volume preferences are selected. | | |
| ExcessiveVolume | Each resource has a default maximum weight and volume it can carry (in a car or a truck). Any weight or volume surplus results in additional costs as defined by the ExcessiveWright and ExcessiveVolume parameters. The parameter is only applicable if the use Weight and use Volume preferences are selected. | | |
| WaitingTime | Cost for waiting time at a customer. This may occur if the opening hours or latest constraint forces the resource to wait before being able to start with the task. | | |
| UsedTrip | | | |
| AllowOverlapsOfFixedAppointments | | |
algorithms
| Id | Description | Datatype | Default |
|---|---|---|---|
| AbortVisitCostCalculation | This option specifies whether the euclidean distance test during the evaluation of a visit insertion actually calls the getCost() method with parameter abort = true or false. | | |
| CostAcceptEqual | Indicates whether other options with the same cost are considered an option. This may result in the insertion of a task after a planned visit rather than before the visit. | | |
| OptimizeAbortOnEuclidean | Abort an insertion point cost calculation if the cost to travel the euclidean distance exceeds cost of the currently cheapest option. | | |
| OptimizeOfferNearestFirst | Sort list of resources first by nearest before offering a task to the resources for cost caluclation. | | |
| OptimizeOfferNearestInTripLimit | During insertion into a trip, only positions before or after near tasks are considered. The limit is defined by the parameter OptimizeAcrossNeighboursLimit. | | |
| AcceptBeyondLatestDay | Indicates whether the planning algorithms may accept insertion points that are beyond the latest day (and time). | | |
| AdjustToEarliest | Adjust the start time of a visit to the earliest possible time. The adjustment is only applied on the day of the earliest datetime. | | |
| RoundEarliestLatest | Rounds earliest and latest date/times to the beginning and the end of the working hours. This option makes sure that the time of the day is not relevant to the planning. | | |
| FastLaneTimeFrame | Tasks with a latest value that is close to or beyond the current time are considered very urgent and will be planned during the FastLane algorithm. This preference determines the time frame in minutes during which a task is considered urgent, ie. if FAST_LANE_TIME_FRAME equals 1.440, each task with a latest value within a day away from the current time (or beyond) are considered urgent. | | |
| FastLaneUseLocationPlanning | Use Location Planning during FastLane. | | |
| kMeansEpsilon | k-Means clustering epsilon precision. | | |
| kMeansMaxEpochs | k-Means clustering maximum epochs. | | |
| kMeansRadius | k-Means clustering radius precision. | | |
| kMeansXDivisionFactor | k-Means clustering x coordinate division factor. | | |
| kMeansYDivisionFactor | k-Means clustering y coordinate division factor. | | |
| LocationPlanningCheckPreferredResource | Check for the preferred resource during location planning. If a preferred resource is defined, a check is performed. | | |
| LocationPlanningContinueNextDay | Continue with next days if a task is not plannable (anymore) on the current day during location planning. | | |
| LocationPlanningMaxDistance | The number of meters that are accepted during location planning. A value of -1 indicates that all tasks are actually considered local. | | |
| LocationPlanningGroupIsLocation | During the algorithm, a group of tasks are considered a single location. | | |
| OptimizeSwoonAbortWhenNoOption | Abort algorithm when a task is not plannable at all. | | |
| OptimizeSwoonAlwaysOfferToTerritory | This option is used during the Swoon Mix algorithm. If false, the task is only offered to the entire territory if the last trip doesn't provide an option. | | |
| SwoonMixCheckAllStops | If this option is set, all stops of a trip are evaluated for a nearest visit during the SwoonMix algorithm. | | |
| SwoonMixCheckNoOption | If this option is set, the resources that had no option when evaluated are removed from the list of available resources. This option can only be set if there are no constraints such as skills, opening hours or other. It is often used when calculating clusters, avoiding miscalculations when searching for the furthest task to the nearest resource. | | |
| SwoonMixCheckPreferred | Check for preferred resource during the evaluation of near tasks. | | |
| SwoonMixContinueNextDay | Continue with nearest on the next day. | | |
| SwoonMixFurthestOnlyProbability | Applicable if the Swoon Mix algorithm runs in Furthest Only mode, i.e. no other sorting of tasks than furthest/nearest is enabled. In this case, this preference identifies the probaility with which a fiurthest task is chosen as a seed for a new route. If the value is 0, Swoon Mix will always insert the nearest task (nearest to the nearest resource). If the value is 100, Swoon Mix will first seed a route with the task that is furthest to the nearest resource. It will then continue with the neatasks to complete the trip. | | |
| OptimizeSwoonNearestAddLimit | Number of nearest visits that can be added by the SwoonMix algorithm. | | |
| SwoonMixNearestAttempts | The number of attemtps to search for a local neighbouring task that might be added to the trip. | | |
| OptimizeSwoonSortByDuration | Sort by duration during SwoonMix. | | |
| OptimizeSwoonSortByFurthest | Sort by furthest distance to nearest resource. Usually, the task that is located furthest from the nearest resource is a task that is difficult to insert into a plan once it is filled with other tasks. Therefore, this task is planned first. | | |
| OptimizeSwoonSortByLatest | Sort by latest during SwoonMix. | | |
| OptimizeSwoonSortByNumberOfSupportingResources | Sort by number of supporting resources during SwoonMix. | | |
| OptimizeSwoonUseClusters | Use clusters instead of territories. | | |
| SwoonMixUseLocationPlanning | Use Location Planning during SwoonMix. | | |
| OptimizeSwoonSortEuclidean | When sorting the tasks by distance to the current task, SwoonMix will sort by Euclidean distance to avoid expensive routing queries. | | |
| OptimizeTripAfterInsert | Optimize trip after a certain number of inserts. | | |
| OptimizeTripWithTSP | Only minimize travel costs during trip optimization. Any other cost such as response excess costs are not considered. | | |
| OptimizeTSPEuclidean | Optimization of routes with the TSP algorithm considers euclidean distances only if this option is set. Other constaints are not considered. | | |
| OptimizeAcrossNeighboursLimit | Optimization across trips considers a specific number of neighbours. -1 indicates all. | | |
| ExtendedTripOptimize | When selected, trips are re-optimized by inserting most expensive visit first | | |
| splitTasksMaxMinutes | | | |
| splitTasksWithhold | | | |
| splitTasksThreshold | | | |
| closeTasksDays | | | |
| closeTasksCode | | |
gantt
| Id | Description | Datatype | Default |
|---|---|---|---|
| GanttArrivals | gantt arrivals color | | |
| GanttBackground | The background color of a Gantt chart. | | |
| GanttBreaks | breaks color | | |
| GanttDepartures | gantt departure color | | |
| GanttOverdueColor | The color paint for the bar that is used to inicate that a task has surpassed the response time. | | |
| GanttTimeLine | gantt timeline color | | |
| GanttTravel | gantt travel color | | |
| GanttVisits | gantt visits color | | |
| GanttUseGradient | Paint the stops with a gradient color. | | |
| ganttAxisOnTop | Display Gantt axis on top of stops. | | |
| GanttDisplayIcons | Paints plan node icons. | | |
| GanttDisplayOverdue | Paint a bar to indicate that a task has surpassed the response time. | | |
| GanttDisplayStopInfo | Display stop information. | | |
| GanttEndHour | The hour with which the Gantt ends. | | |
| GanttExpandTerritory | If activated a change to the territory triggers the plan tree to expand the according territory node. | | |
| GanttExpandTerritoryAdaptRowHeight | Adapt the height of the plan tree rows when expanding the territory so that all rows are visible. | | |
| GanttExpandTerritorySelectAllResources | Select all territory resources when expanding the territory so that all trips are visible in the map. | | |
| ganttHorizontalLines | Display horizontal lines in the Gantt. | | |
| GanttLeftScrollBar | Display the scroll bar in the main Gantt on the left side. | | |
| GanttMaximumDaysForText | The maximum days that need to be visible for a Gantt stop to display the textual representation of the text. Defaults to 2. | | |
| GanttMinimumPixelForText | The minimal number of pixels that need to be visible for a Gantt stop to display the textual representation of the text. Defaults to 25. | | |
| GanttNoDuplicateIcons | This preference, if set to true, avoids displaying duplicate icons in the stop box. Duplicate may, for example, occur if there are more than one warning. | | |
| GanttOverlapOnArrivalAndDeparture | Paint overlap on departures and arrivals. Default is true. | | |
| GanttRightScrollBar | Display the scroll bar in the main Gantt on the right side. | | |
| GanttRoundedRectangle | If true, stops are displayed with a rounded rectangle. | | |
| GanttSizeSliderValue | The value for the slide bar that reflects the size of the trips in the main Gantt chart. | | |
| GanttStartHour | The hour with which the Gantt starts. | | |
| GanttStopWidth | Paint stops with this percentage of the column | | |
| GanttTimeResource | time/resource or resource/time axis display | | |
| GanttTravelWidth | Paint travel with this percentage of the column | | |
| ganttVerticalLines | Display vertical lines in the Gantt. | | |
| GanttXOffset | x offset in Gantt chart. | | |
| GanttYOffset | y offset in Gantt chart. | | |
| GanttZoom | The number of days that are visible in the main Gantt chart. | | |
| SnapToHour | Check this option if you want popups to show information for all stops in the currently selected hour | | |
| ShowTimeDistanceOnPreviousStop | Show distance/time on previous stop | | |
| DashboardBackground | | | |
| DashboardTitleForeground | | | |
| DashboardValuesForeground | | | |
| GanttAlternateColors | Alternate background color | | |
| GanttCustomTripRenderer | | |
calendar
| Id | Description | Datatype | Default |
|---|---|---|---|
| UseSystemDate | Use System date for planning. | | |
| StartingDate | Starting date for planning. | | |
| PlanScope | Scope of the planning, i.e. show the next x days. | | |
| PlanScopeBackwards | Scope of the backwards planning, i.e. show the last x days. | | |
| PublicHoliday | To remove days, select them and press the DELETE button | | |
| WorkWeekends | Check this box iif resources do not work on weekends generally | | |
| useFloatingBreaks | flaoting breaks are breaks that have are placed in the middle of the resource's trip. They may move if tasks are extended. | | |
| breakDuration | The standard duration of a floating break. | | |
| StandardWorkStart | Standard Working Hours Start | | |
| StandardWorkEnd | Standard Working Hours End | | |
| StartWithWorkingHours | The travel time and distance to the first visit is considered before the start of the working hours if this option is true. | | |
| TripTruncateStopTime | Truncate start and stop time to the minute. | | |
| FloatingBreakStart | Starting time for standard break. | | |
| FloatingBreakEnd | End time for standard break. | | |
geography
| Id | Description | Datatype | Default |
|---|---|---|---|
| Accuracy | Parameter for geocode accuracy when calculating distance. Suppose the route calculations are too time-consuming. In that case, you may want to minimize calculations by reducing accuracy, i.e. whenever a calculation from a coordinate 123456_1234567 is executed, the map service actually reduces the coordinates to 123450_1234560 when accuracy is set to 0.1. In fact, the map service then is based on a grid rather than fine-grained coordinates. This increases the change of having calculated the route in the past and thus reduces the amount of calculations. Under normal circumstances, accuracy should be left unchanged. | | |
| MapUsePostalCodeOnly | Indicates whether the Time Distance Server should only use the postal code for time/distance calculations. In that case, any geocode stored in the cache will be used for all addresses in the same postal code region. | | |
| UsePhoneticMatch | If supported by the Time Distance Server, a match can be based on a phonetic match. By unsetting this option, no phonetic matches will be used during the geocoding of addresses. | | |
| MapPostalCodePositions | Indicates the number of positions used when reducing the geocoding and time/distace calculation to the postal code. This preference is only valid in combination with the MAP_USE_POSTAL_CODE_ONLY preference. | | |
| houseNumberPattern | A regular expression for the extraction of the housenumber in an address. | | |
| TDSType | parameter for type of TDS | | |
| MapSleepOnStartup | Indicates the number of milliseconds to wait before contacting the map service after it has been locally started. | | |
| MAPParam1 | parameter for Time Distance Server | | |
| MAPParam2 | parameter for Time Distance Server | | |
| MAPParam3 | parameter for Time Distance Server | | |
| MAPParam4 | parameter for Time Distance Server | | |
| MAPParam5 | parameter for Time Distance Server | | |
| MAPParam6 | parameter for Time Distance Server | | |
| MAPParam7 | parameter for Time Distance Server | | |
| MAPParam8 | parameter for Time Distance Server | | |
| MAPParam9 | parameter for Time Distance Server | | |
| TraceType | | | |
| TraceParam1 | | | |
| TraceParam2 | | | |
| TraceParam3 | | | |
| TraceParam4 | | | |
| TraceParam5 | | | |
| TraceParam6 | | | |
| TraceParam7 | | | |
| TraceParam8 | | | |
| TraceParam9 | | | |
| MinTime | Minimum Traveltime in minutes | | |
| AlwaysAddMinTime | Always add minimum traveltime. | | |
| minTimeRadius | Parking radius is the max. distance in which the minimal travel time is not applied, unless the always flag is set. This option is useful when parking in a region with many tasks takes time, whereas walking from door to door is neglectible. | | |
| MapDistanceForDeparture | Do not calculate any distance at all for the route between the departure and the first stop. | | |
| MapDistanceForArrival | Do not calculate any distance at all for the route between the last stop and the arrival. | | |
| CountryCode | default country code, used when no country is specified | | |
| DistanceDimension | Distance | | |
| AdhocMatching | Ad-hoc Address matching in popup menu. Whenever the user clicks the right-mouse button on a geocoded plan item, S4 will insert all address matches found by the Time Distance Server. | | |
| AdhocMatchingLimit | The maximum number of matches that are displayed in the popup menu. | | |
| UseEuclideanDistance | tell the Time Distance Server to calculate distances based on euclidean distance. | | |
| UseFastMinimal | Use fast minimal distance calculation instead of the TDS module's algorithm. | | |
| MapSymmetricTimeDistance | Indicates a symmetric time/distance calculation. | | |
| UseCache | Use TDS cache | | |
| CommitSteps | commit steps | | |
| CacheStoreWithGPS | Store geocodes with standard and GPS coordinates | | |
| speedFastMotorway | Average fast speed on motorways in km/h | | |
| speedMediumMotorway | Average medium speed on motorways in km/h | | |
| speedSlowMotorway | Average slow speed on motorways in km/h | | |
| speedFastNationalRoad | Average fast speed on national roads in km/h | | |
| speedMediumNationalRoad | Average medium speed on national roads in km/h | | |
| speedSlowNationalRoad | Average slow speed on national roads in km/h | | |
| speedFastCountryRoad | Average fast speed on country roads in km/h | | |
| speedMediumCountryRoad | Average medium speed on country roads in km/h | | |
| speedSlowCountryRoad | Average slow speed on country roads in km/h | | |
| speedFastUrbanRoad | Average fast speed on urban roads in km/h | | |
| speedMediumUrbanRoad | Average medium speed on urban roads in km/h | | |
| speedSlowUrbanRoad | Average slow speed on urban roads in km/h | | |
| routeTimePreference | The time factor for route calculations, i.e. a value of 100 represents a preference for fastest routes, a value of 0 represents a preference for shortest routes. | | |
| MapUseExactMatchesOnly | | | |
| MapMaxDistance | | |
map
| Id | Description | Datatype | Default |
|---|---|---|---|
| MapBackground | map background color | | |
| MapHomes | map homes color | | |
| MapLegend | map legend color | | |
| PaintClusters | Paint the clusters in different colors. | | |
| PaintResources | Paint Resource Addresses | | |
| PaintClosed | | | |
| PaintMap | | | |
| PaintTrips | Paint Trips | | |
| MapFocusOnTripSelection | | | |
| MapUnplannedTasks | map unplanned tasks color | | |
| NavigatorMondayColor | The color for a route on a Monday. | | |
| NavigatorTuesdayColor | The color for a route on a Tuesday. | | |
| NavigatorWednesdayColor | The color for a route on a Wednesday. | | |
| NavigatorThursdayColor | The color for a route on a Thursday. | | |
| NavigatorFridayColor | The color for a route on a Friday. | | |
| NavigatorSaturdayColor | The color for a route on a Saturday. | | |
| NavigatorSundayColor | The color for a route on a Sunday. | | |
workflow
| Id | Description | Datatype | Default |
|---|---|---|---|
| displayStatusDescription | | |
other
| Id | Description | Datatype | Default |
|---|---|---|---|
| SlideShow | Indicates if the slide show is currently active. The slide show changes the territory selection automatically after a predefined interval. It can be activated and deactivated by choosing the according menu item in the Tools menu. | | |
| SlideShowInterval | The interval in seconds in which the slide show changes the territory. | | |
| WebServerPort | The port that should be used when starting the web server. Only HTTP requests to that port are accepted. | | |
| StartWebServer | Start the web server to allow remote web service calls. | | |
| openTransactionAutoCommit | If this option is set, any change to the planning is instantly committed. In this case, rollback of unwanted changes is not possible. This option is currently supported in SQL mode only. | | |
| openTransactionTimeout | If a transaction is open due to a change in the planning, a timeout can be specified to ensure that the transaction only remains open for a certain time. If the timeout has expired, a dialog will pop up to ask the user if he/she wants to rollback or commit the transaction. If the dialog timeout is expired, the transaction is commited or rolled back automatically, depending on the settings. The value is specified in seconds. | | |
| openTransactionCommit | If a transaction is terminated automatically, a rollback or commit is performed. This preference defines the preferred action. If the value is true, the transaction is committed. | | |
| openTransactionDialogTimeout | If the timeout dialog is shown to the user but no action is received from the user within a certain period of time, the dialog expires automatically. The value is specified in seconds. | | |
| openTransactionUseTransactions | | | |
| userExternalDateFormat | Date Format | | |
| userExternalTimeFormat | Time | | |
| userExternalDayDateFormat | Day and Date | | |
| userExternalDayDateTimeFormat | Day, Date and Time | | |
| userExternalDateTimeFormat | Date and Time | | |
| focusOnResource | Focus on Resource | | |
| focusOnDay | Focus on Day | | |
| breakStartOffset | Offset (min) | | |
| breakUseMaxOvertime | To enter an unavailability for an entire day, the maximum overtime minutes will be added to the starndard working hours end. | | |
geocoder
| Id | Description | Datatype | Default |
|---|---|---|---|
| GeocoderAreaColumnName | Geocoder area column name. | | |
| GeocoderCityColumnName | Geocoder city column name. | | |
| GeocoderCountryColumnName | Geocoder country column name. | | |
| GeocoderGeocodeColumnName | Geocoder geocode column name. | | |
| GeocoderHousenumberColumnName | Geocoder housenumber column name. | | |
| GeocoderKeyColumnName | Geocoder key column name. | | |
| GeocoderMatchColumnName | Geocoder match column name. | | |
| GeocoderPostalCodeColumnName | Geocoder postal code column name. | | |
| GeocoderQualityColumnName | Geocoder quality column name. | | |
| GeocoderSaveExactMatchesOnly | Only save exact matches. | | |
| geocoderExactMatchPostalCode | If this option is set, a match is only interpreted as exact (i.e. street or housenumber match) if and only if the postal codes of the original address and the matched address are identical. | | |
| GeocoderSchemaName | Geocoder schema name. | | |
| GeocoderStreetColumnName | Geocoder street column name. | | |
| GeocoderTableName | Geocoder table name. | | |
| GeocoderWhereClause | Geocoder where clause. | | |
tables
| Id | Description | Datatype | Default |
|---|---|---|---|
| tableClosedTaskColumnOrder | This preference defines the column order of the closed task table. The order is restored during startup. | | |
| tableClosedTaskColumnWidth | This preference defines the column width of the closed task table. The width is restored during startup. | | |
| tableDayColumnOrder | This preference defines the column order of the day table. The order is restored during startup. | | |
| tableDayColumnWidth | This preference defines the column width of the day table. The width is restored during startup. | | |
| tableInsertionOptionsColumnOrder | This preference defines the column order of the insertion options table. The order is restored during startup. | | |
| tableInsertionOptionsColumnWidth | This preference defines the column width of the insertion options table. The width is restored during startup. | | |
| tableCandidateTasksColumnOrder | | | |
| tableCandidateTasksColumnWidth | | | |
| tablePlannedTaskColumnOrder | This preference defines the column order of the planned task table. The order is restored during startup. | | |
| tablePlannedTaskColumnWidth | This preference defines the column width of the planned task table. The width is restored during startup. | | |
| tableResourceColumnOrder | This preference defines the column order of the resource table. The order is restored during startup. | | |
| tableResourceColumnWidth | This preference defines the column width of the resource table. The width is restored during startup. | | |
| tableStopColumnOrder | This preference defines the column order of the stops table. The order is restored during startup. | | |
| tableStopColumnWidth | This preference defines the column width of the stops table. The width is restored during startup. | | |
| tableUnplannedTaskColumnOrder | This preference defines the column order of the unplanned task table. The order is restored during startup. | | |
| tableUnplannedTaskColumnWidth | This preference defines the column width of the unplanned task table. The width is restored during startup. | | |
| tableWaitingListColumnOrder | This preference defines the column order of the waiting list table. The order is restored during startup. | | |
| tableWaitingListColumnWidth | This preference defines the column width of the waiting list table. The width is restored during startup. | | |
| tableWarningColumnOrder | This preference defines the column order of the warning table. The order is restored during startup. | | |
| tableWarningColumnWidth | This preference defines the column width of the warning table. The width is restored during startup. | | |
| tableStatisticsColumnOrder | | | |
| tableStatisticsColumnWidth | | |
windows
| Id | Description | Datatype | Default |
|---|---|---|---|
| TreeDividerLocation | Store the divider location of the tree split pane. | | |
| windowPosSizeData | Position and size of the data window. | | |
| windowPosSizeDesktop | Position and size of the desktop window. | | |
| windowPosSizeInsertionOptions | Position and size of the options dialog. | | |
| windowPosSizeCandidateTasks | | | |
| windowPosSizeLog | Position and size of the log window. | | |
| windowPosSizeMain | Position and size of the main window. | | |
| windowPosSizeMainGantt | Position and size of the main gantt window. | | |
| windowPosSizeMap | Position and size of the map window. | | |
| windowPosSizeStatistics | Position and size of the statistics window. | | |
| windowPosSizeTree | Position and size of the tree window. | | |
| windowPosSizeTaskForm | | | |
| windowPosSizeResourceForm | | | |
| windowPosSizeBreakForm | | | |
| windowPosSizeSkillForm | | | |
| windowPosSizeLoginForm | | | |
| windowPosSizePreferences | | | |
| windowVisibleInternalFrames | Used to identify visible internal frames. | | |
| DashboardTabDividerLocation | | |
none
| Id | Description | Datatype | Default |
|---|---|---|---|
| AllowCreateBreaks | Allows the creation of break data. | | |
| AllowCreateResources | Allows the creation of resource data. | | |
| AllowCreateSkills | Allows the creation of skill data. | | |
| AllowCreateTasks | Allows the creation of task data. | | |
| AllowDeleteBreaks | Allows the deletion of break data. | | |
| AllowDeleteResources | Allows the deletion of resource data. | | |
| AllowDeleteSkills | Allows the deletion of skill data. | | |
| AllowDeleteTasks | Allows the deletion of task data. | | |
| allowTaskSkillUpdate | Allow the user to update the skill. | | |
| allowTaskOpeningHoursUpdate | | | |
| AllowUpdateBreaks | Allows update of break data. | | |
| AllowUpdateResources | Allows update of resource data. | | |
| AllowUpdateSkills | Allows update of skill data. | | |
| AllowUpdateTasks | Allows update of task data. | | |
| AutonomousSchedulingOnStartup | Start in autonomous scheduling mode. | | |
| ExpertMode | In expert mode, S4 enables the extended tool menu, offering functionality that is not available for normal users. | | |
| keyFile | The attribute name for the key file location | | |
| LastPreferenceTab | The last tab that was visible when the preference dialog was last closed. | | |
| ProductName | The full name of the product. | | |
| ProductImage | | | |
| selectedTerritories | The territories that the user has choosen. | | |
| selectedBatch | | | |
| fillTripSortOnLatest | | | |
| fillTripMaxDistance | | |
web
| Id | Description | Datatype | Default |
|---|---|---|---|
| appletSeparateFrame | | | |
| appletAutoStart | | | |
| webAsApplet | | |
