Properties installed with Field Service Management

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 12 minutes to read

    • System properties provided with the Field Service Management application.

    Table 1. Properties installed with Field Service Management
    Property Description
    glide.ui.wm_order_activity.fields Determines which fields are tracked in the activities list for work orders. The system automatically synchronizes the values in this property and the selections made by customizing activities.
    • Type: String
    • Default value: opened_by, work_notes
    • Location: System Properties [sys_properties] table
    glide.ui.wm_task_activity.fields Determines which fields are tracked in the activities list for work order tasks. The system automatically synchronizes the values in this property and the selections made by customizing activities.
    • Type: String
    • Default value: work_notes, assigned_to
    • Location: System Properties [sys_properties] table
    work.management.agent.geo.history.update.duration Set the duration (in minutes) of the latest system update that you want to consider for calculating the agent's geolocation history relative to current time. If the duration of the last geolocation history update is more than the duration set for this property, the system uses the agent's task or home location instead of the geolocation history to determine the agent's current location.
    • Type: Integer
    • Default value: 240
    • Location: System Properties list
    work.management.allow.doublebooking.dynamicscheduling When set to true, dispatchers can double-book agents manually even when dynamic scheduling is enabled.
    • Type: true/false
    • Default value: false
    • Location: System Properties list [sys_properties] table
    work.management.allow.auto.metric_cleanup The frequency in number of days that the metric instance table should be purged of work order task information to avoid an unnecessary amount of data in the table.
    • Type: Integer
    • Default value: 365
    • Location: System Properties list [sys_properties] table
    work.management.default.end.time Default end time for all work agents when no schedule is set, formatted in a 24-hour clock.
    • Type: String
    • Default value: 17:00
    • Location: Field Service > Administration > Properties
    sn_fsm.set_schedule_lock_by_state Determines the state to lock work order task and also prevents from reassignment. For example, you can set the work order tasks to automatically get locked when the state is Assigned and further excludes in automated scheduling mechanisms such as dynamic scheduling, intelligent task recommendations.
    • Type: String
    • Default value: None
    • Location: Field Service > Administration > Properties
    sn_fsm.update_potential_assignment_groups Calculates and automatically populates the potential assignment groups based on the location and assignment groups if there’s more than one that can be serviced for a work order task. Updates the wm_work_order_task_potential_assignment_groups table with potential assignment groups for the work order task.
    • Type: Boolean
    • Default value: No
    • Location: Field Service > Administration > Properties
    work.management.default.start.time Default start time for all work agents when no schedule is set. This value sets the start time for a day other than the current day, when no scheduled task exists or is continued from the previous day. This property uses a 24-hour clock.
    • Type: String
    • Default value: 08:00
    • Location: Field Service > Administration > Properties
    work.management.allow.auto.timecard Automatically create a time card for a work order task when the task is . Every time the task is resumed, the time taken to work on the task is recorded in the time card. The Actual Work Duration field captures the cumulative amount of time worked on the task.
    • Type: true/false
    • Default value: false
    • Location: Field Service > Administration > Properties
    work.management.allow.travel.task.timecard Enables recording the amount of time an agent spent to execute a work order task. The time card is generated when an agent clicks Start work.
    • Type: true/false
    • Default value: false
    • Location: System Properties list [sys_properties] table
    work.management.limit.location By default, the list of available dispatch groups is filtered by their proximity to the work order task location. When this property is set to false, the system displays all dispatch groups for selection without considering location.
    • Type: true/false
    • Default value: true
    • Location: Field Service > Administration > Properties > Dispatch Properties for Field Service
    work.management.max.agents.processed Sets the maximum number of agents processed by auto-dispatch at a time. The system has an absolute limit of 300 agents and sets the value at that level. If you specify more than 300, then the system can’t auto-dispatch a task for a dispatch group that contains more agents than the value configured.
    • Type: Integer
    • Default value: 100
    • Location: Field Service > Administration > Properties
    work.management.work.spacing Amount of time (in minutes) to add between the end of a task and the travel start of the next. An example of a valid time value is 10.
    • Type: Integer
    • Default value: 0
    • Location: Field Service > Administration > Properties
    com.snc.wm.wo.task_window_days Default days for a window of a task.
    • Type: Integer
    • Default value: 14
    • Location: Field Service > Administration > Properties
    work.management.use.mandatory.skills Enables the mandatory skills feature and indicates that the Task Skills [task_m2m_skill] table is being used for work orders and work order tasks.
    • Type: true/false
    • Default value: false
    • Location: System Properties list
    work.management.rejected.technician.duration The number of hours after which a work order task can be dynamically scheduled to the agent who rejected the work order task.
    • Type: Integer
    • Default value: 24
    • Location: System Properties list
    skills_management.migration Lists the task tables to migrate to the Task Skills [task_m2m_skill] table when an admin runs the Migrate Skills to Task Skill M2M script.
    • Type: choice list
    • Default value: wm_task,customerservice_case,wm_order
    • Location: System Property [sys_properties] table
    com.snc.skills_management.task_skill_migrated_tables Contains a list of tables for which the Skills field has already been migrated to the Task Skills [task_m2m_skill] table. If the table name is listed in this property, the data has been migrated and will not be migrated again.
    • Type: choice list
    • Default value: none
    • Location: System Property [sys_properties] table
    work.management.assignment.ignoreTravelTimeCalculation When set to true, ignores the travel calculation check for field service agents.
    • Type: true/false
    • Default value: false
    • Location: System Properties list
    sn_fsm_service_loc.max_new_location_per_day Sets the maximum number of new locations allowed per day for external users.
    • Type: Integer
    • Default value: 10
    • Location: Field Service > Administration > Properties
    sn_fsm_crew.work.management.allow.undersized.crew.taskassignment Enables dispatchers to assign task to a crew manually even when the crew size doesn’t meet the minimum required agents criterion.
    • Type: true/false
    • Default value: false
    • Location: System Properties list
    work.management.optimization.conflict_handling Manages the assignment of tasks scheduled outside the agent working hours when optimizing the task route for agent. Choose any of the following route optimization behaviour to avoid conflicts that may occur due to the overflow tasks:
    • stop_action: Terminate the optimize route action and return the original route status to the agent.
    • unassign_task: Unassign the tasks that are scheduled outside the agent working hours.
    • Extend_tasks: Adjust the unassigned tasks towards the end of the agent schedule when optimizing the route based on tasks.
    • Type: choice list
    • Default value: stop_action
    • Location: System Properties list [sys_properties] table
    sn_fsm_crew.default.duration.in.days.of.crew.member Sets the default number of days that an agent is part of a crew.
    • Type: Integer
    • Default value: 1
    • Location: System Properties list [sys_properties] table
    sn_task_grouping.log.verbosity Logs the details of Dynamic Bundling. Registers information such as how many tasks were bundled, bundle task numbers, subtask numbers, policies, rules, and qualifiers used to created bundles.
    • Type: choice_list
    • Default value: OFF
    • Location: System Properties list [sys_properties] table
    work.management.default.scheduled.start Default scheduled start date added to work order task. If value set to false, then the scheduled start won't populate until tasks enter the scheduled state. If the value is set to true, then the schedule start will populate when tasks enter the pending dispatch state.
    • Type: string
    • Default value: false
    • Location: System Properties list [sys_properties] table
    Enable/Disable Onsite Check-in for Agents Estimated time for agents to arrive at task locations.
    • Type: Choice
    • Default value: Disabled
    • Location: All > Field Service > Administration > Configuration

    If enabled, you can set a value for any work order task.

    Properties for calculating estimated travel time and distance

    Table 2. Properties for calculating estimated travel time and distance with Field Service Management
    Property Description
    work.management.autodispatch.geolocation Requires geolocation to be used to calculate the estimated travel time for dynamic scheduling and auto assignment of tasks.
    • Type: true/false
    • Default value: true
    • Location: Field Service > Administration > Properties > Dispatch Properties for Field Service Management
    Note:
    To use the Google Maps API with dynamic scheduling, you must also enable the Use Google for travel time and traffic data check box on the Dynamic Scheduling Configuration form.
    work.management.travel.calculation.dynamic_scheduling Uses the Google Maps API or straight-line estimates to calculate estimated agent travel time and distance to task locations when agents are assigned tasks using dynamic scheduling.
    • Type: choice list
    • Default value: Use straight line estimate
    • Location: Field Service > Administration > Properties
    work.management.travel.calculation.auto_assignment Uses the Google Maps API or straight-line estimates to calculate estimated agent travel time and distance to task locations when agents are assigned tasks using auto assignment.
    • Type: choice list
    • Default value: Use Google Maps API
    • Location: Field Service > Administration > Properties
    work.management.travel.calculation.manual_assignment Uses the Google Maps API, Beans.AI, or straight-line estimates to calculate estimated agent travel time and distance to task locations when tasks are manually assigned to agents.
    Note:
    Map providers operate on a bring your own license (BYOL) licensing model.
    • Type: choice list
    • Default value: Use straight line estimate
    • Location: Field Service > Administration > Properties
    work.management.travel.calculation.route_optimization Uses the Google Maps API, Beans.AI, or straight-line estimates to calculate estimated agent travel time and distance to task locations when agent route is optimized.
    Note:
    Map providers operate on a bring your own license (BYOL) licensing model.
    • Type: choice list
    • Default value: Use Google Maps API
    • Location: Field Service > Administration > Properties
    work.management.travel.calculation.bundle_route_optimization Enables Route Optimization to optimize the subtasks within work order task bundles.
    • Type: true/false
    • Default value: false
    • Location: Field Service > Administration > Properties
    work.management.travel.calculation.expected_arrival Uses the Google Maps API or straight-line estimates to calculate estimated agent travel time and distance between the task location and the agent's location when agent starts to travel. If an agent leaves before or after the Scheduled travel start time, then the Scheduled travel start, Scheduled start, Estimated end, and Estimated travel duration values for the task are updated.
    • Type: choice list
    • Default value: Use Google Maps API
    • Location: Field Service > Administration > Properties
    Note:
    Select Use Google API real time traffic as the default value to calculate the agent's estimated time of arrival using the real-time traffic data.

    Part sourcing properties

    Table 3. Part sourcing properties for Field Service Management
    Property Description
    Part Search Criteria Sets the criteria to search parts. The stockrooms that contains the parts with the requested quantity appear per the selected search criteria.
    • Type: choice list
    • Default value: No restrictions
      • No Restrictions: Search all warehouse stockrooms and peers' personal stockrooms.
      • Only Assignment Group: Search all stockrooms of the peer agents who are part of the assignment groups of the logged-in field service agent.
      • Only Preferred Stockrooms: Search all preferred stockrooms of all the assignment groups irrespective of the radius mentioned in the logged-in agent's profile.
    • Location: Field Service > Administration > Properties
    Use part request approvals Enables sending and receiving mobile notifications as field service agents request parts from peer agents.
    • Type: Boolean
    • Default value: Yes
    • Location: Field Service > Administration > Properties
    Create part requests for part requirement sourcing Creates a part request when a part is added to the part requirement.
    • Type: Boolean
    • Default value: Yes
    • Location: Field Service > Administration > Properties

    Geolocation properties

    Table 4. Geolocation properties for Field Service Management
    Property Description
    work.management.map.merge.task.agent.markers Merges task and agent markers on geolocation maps with a new purple marker. When this property is true, agent and task markers that are close together are merged into a purple cluster that displays the count of both marker types. The pop-up information window for the purple marker displays the items for all agents and tasks. If this property is false, agents and tasks will only be gathered into their own clusters and not into the single, purple cluster.
    • Type: true/false
    • Default value: false
    • Location: Field Service > Administration > Properties
    work.management.evening.rush.hours Evening rush hour span, formatted as 14:30-16:00. This property uses a 24 hour clock. All times are expressed as a range, separated by a dash with no spaces. Times not using this format are ignored. This property must be used with the work.management.morning.rush.hours and work.management.rush.travel.buffer properties.
    • Type: String
    • Default: 0
    • Location: Field Service > Administration > Properties
    work.management.morning.rush.hours Morning rush hour span, formatted as 06:30-08:00. This property uses a 24 hour clock. All times are expressed as a range, separated by a dash with no spaces. Times not using this format are ignored. This property must be used with the work.management.evening.rush.hours and work.management.rush.travel.buffer properties.
    • Type: String
    • Default: 0
    • Location: Field Service > Administration > Properties
    work.management.rush.travel.buffer Percentage to add to all rush hour travel times. The system uses this percentage to calculate schedules when optimizing task routes for agents. Use this property when both morning and evening rush hour times are defined. An example of a valid time buffer percentage is 15.
    • Type: Integer
    • Default value: 0
    • Location: Field Service > Administration > Properties
    work.management.travel.buffer Percentage to add to all travel times. An example of a valid percentage value is 15.
    • Type: Integer
    • Default value: 0
    • Location: Field Service > Administration > Properties
    work.management.allow.toll.roads Allows the system to use toll roads when auto-routing or optimizing task routes for agents.
    • Type: true/false
    • Default value: true
    • Location: Field Service > Administration > Properties

    Dynamic Scheduling properties

    Table 5. Dynamic scheduling properties for Field Service Management
    Property Description
    work.management.allow.doublebooking.dynamicscheduling Enables dispatchers to double-book agents manually even when dynamic scheduling is enabled.
    • Type: true/false
    • Default value: false
    • Location: Field Service > Dynamic Scheduling Administration > Properties
    com.snc.dynamic.scheduling.ignoreAgentTravelTimeDuringScheduling When this property is set to true, the agent's assigned tasks using dynamic scheduling no longer have an estimated travel time calculated.
    • Type: true/false
    • Default value: false
    • Location: Field Service > Dynamic Scheduling Administration > Properties
    work.management.travel.calculation.dynamic_scheduling Uses the Google Maps API or straight-line estimates to calculate estimated agent travel time and distance to task locations when agents are assigned tasks using dynamic scheduling.
    • Type: choice list
    • Default value: Use straight line estimate
    • Location: Field Service > Dynamic Scheduling Administration > Properties
    com.snc.dynamic.scheduling.optimize_travel_time_rating

    Used to provide a more precise optimization rating for each work block for agents. Property includes work.management.morning.rush.hours and work.management.rush.travel.buffer.

    • Type: Choice list
    • Default: include_all_travel
    • Location: Field Service > Dynamic Scheduling Administration > Properties
    work.management.distance.calculation.dynamic_scheduling Uses Google Maps API or straight line estimates to calculate estimated distance to task locations when agents are assigned tasks using dynamic scheduling.
    • Type: choice list
    • Default value: Use straight line estimate
    • Location: Field Service > Dynamic Scheduling Administration > Properties
    com.snc.dynamic.scheduling.showlogs Enable this property to display recommended eligible agents to the dispatchers while scheduling the tasks using dynamic scheduling.
    • Type: true/false
    • Default value: false
    • Location: Field Service > Dynamic Scheduling Administration > Properties
    com.snc.dynamic.scheduling.bundle_before_scheduling Ensures dynamic bundling runs before dynamic scheduling. Tasks in the Pending Dispatch state are bundled before running dynamic scheduling.
    • Type: true/false
    • Default value: false
    • Location: Field Service > Dynamic Scheduling Administration > Properties
    sn_fsm_multiday.minDurationForFirstWorkSchedule Set minimum work duration to be booked for the first work schedule of the task (in minutes).
    • Type: integer
    • Default value: 60
    • Location: Field Service > Dynamic Scheduling Administration > Properties
    work.management.enable.optimizing.travel Enables dynamic scheduling to reassign work order tasks to the nearest agent regardless of availability.
    • Type: true/false
    • Default value: false
    • Location: Field Service > Dynamic Scheduling Administration > Properties
    work.management.travel.time.threshold.minutes Sets the travel time (in minutes) that assigns a work order task to the nearest agent if they are within the travel distance.
    • Type: integer
    • Default value: 0
    • Location: Field Service > Dynamic Scheduling Administration > Properties

    Database View

    The Field Service Mobile plugin (com.sn_fsm_mobile) adds the Mobile live location database view. The Field Service Mobile plugin is activated when you activate the Field Service Management (com.snc.work_management) plugin.
    Table 6. Database view installed with Field Service Management
    Database view Description
    Mobile live location

    [sn_fsm_mobile_live_location_view​]

    		 Mobile live location of Field Service agents.