Key questions about this property
The answers below summarize the purpose, scope, default effect, and review scenarios for this property.
| What does it do? |
In Dispatcher Workspace, this setting filters off-shift agents from the agent list when enabled. |
| What area does it affect? |
Field Service Dispatcher Workspace |
| What does the default mean? |
No out of the box record exists and the scripts that read it pass no fallback value. |
| When should you review it? |
When dispatchers need to see off-shift agents in the agent list or limit the list to on-shift agents |
Property record
No out of the box record exists. ServiceNow scripts read this property; create it to change the behavior.
| Property name |
sn_fsm_disp_wrkspc.dispatcher_workspace.hideOffShiftAgents |
| Type |
Not stated |
| Application |
Not stated |
| Default value |
Not set |
| Description |
Not stated |
Sources
Official references and nearby text excerpts where this property appears.
Context preview
Snippet 1
... company names, product names, and logos may be trademarks of the respective companies with which they are associated. 996 Dispatcher Workspace system properties for Field Service Management (continued) Property Description sn_fsm_disp_wrkspc.dispatcher_workspace.hideOffShiftAgents Enable hiding off shift agents • Type: true/false • Default value: true • Location: System Properties list [sys_properties] table sn_fsm_disp_wrkspc.dispatcher_workspace.hideOffShiftAgents Enable hiding off shift agents • Type: true/ false • ...
Used in
Out of the box artefacts that read this property. Append the path to your instance URL to open the record and see how the value is used.
Script include: AgentScheduleUtil
When the dispatcher workspace is installed, the setting controls whether the agent list includes all active users with the required roles or only those who also match the true-valued user preference. The code supplies no default, so if the setting is unset, the preference filter is used.
/sys_script_include.do?sys_id=e67a5510c37312001c845cb981d3aee5
Scheduled Job: Populate Agents Daily Schedule Table
When offline scheduling is disabled and the dispatcher workspace is active, the job checks whether this setting is exactly “true”; that value enables hiding off-shift agents from users in the workspace. No default value is supplied in the code.
/sysauto.do?sys_id=c396087d73030010f84de1d28bf6a750
More in sn_fsm_disp_wrkspc
Other properties in the same namespace.
All 3 properties in sn_fsm_disp_wrkspc →