When downloading content, you may encounter issues that are easily resolved. If these tips don't help, please Contact Us, and we will try to send you the file directly.
Downloading Help files
Save the Help file to your local hard drive, and uncompress (extract) it to an empty folder. To open the Help file, open the folder into which the .zip file was extracted, then do one of the following:
- If there is only one file in the folder, click that file.
- If there is more than one file in the folder, click the <name of compressed file>.htm file.
Viewing Help files
If, when you open the Help file, the contents do not display in the right window, consider the following:
- Are you trying to open the file on a remote computer? If so, copy it to your local machine. Due to a Microsoft security update, you cannot properly view a HTML-based (CHM) Help if it is located on another machine on your network.
- What is your permissions setting? Right-click the file, select Properties from the context menu, look for an Unblock button, and click it.
When downloading content, you may encounter issues that are easily resolved. If these tips don't help, please Contact Us, and we will try to send you the file directly.
Downloading Help files
Save the Help file to your local hard drive, and uncompress (extract) it to an empty folder. To open the Help file, open the folder into which the .zip file was extracted, then do one of the following:
- If there is only one file in the folder, click that file.
- If there is more than one file in the folder, click the <name of compressed file>.htm file.
Viewing Help files
If, when you open the Help file, the contents do not display in the right window, consider the following:
- Are you trying to open the file on a remote computer? If so, copy it to your local machine. Due to a Microsoft security update, you cannot properly view a HTML-based (CHM) Help if it is located on another machine on your network.
- What is your permissions setting? Right-click the file, select Properties from the context menu, look for an Unblock button, and click it.
When downloading content, you may encounter issues that are easily resolved. If these tips don't help, please Contact Us, and we will try to send you the file directly.
Downloading Help files
Save the Help file to your local hard drive, and uncompress (extract) it to an empty folder. To open the Help file, open the folder into which the .zip file was extracted, then do one of the following:
- If there is only one file in the folder, click that file.
- If there is more than one file in the folder, click the <name of compressed file>.htm file.
Viewing Help files
If, when you open the Help file, the contents do not display in the right window, consider the following:
- Are you trying to open the file on a remote computer? If so, copy it to your local machine. Due to a Microsoft security update, you cannot properly view a HTML-based (CHM) Help if it is located on another machine on your network.
- What is your permissions setting? Right-click the file, select Properties from the context menu, look for an Unblock button, and click it.
tzdb
Section: Server
Default Value: 1, 0 (see description)
Valid Values: 1, 0
Changes Take Effect: Immediately
Dependencies: [auth] configuration
Introduced: 8.5.214.08
Specifies whether or not WFM time zones are converted to standard IANA time zones.
The default value for this option depends on the [auth] configuration:
- If [auth] is not configured, the default value is 0.
- If [auth] is configured the default value is 1. If you want to keep using Genesys time zones in this configuration, value should be explicitly set to 0.
When this option default is 1 (enabled), WFM time zones (and time zone assignments for business units, sites, etc.), are automatically converted to Internet Assigned Numbers Authority (IANA) time zones, and no longer synchronize with Genesys time zones. When this option default is 0 (disabled), WFM time zones are not converted to IANA time zones.
Time zone conversion is done by using a JSON mapping file (tzmap.json) that can be modified, if necessary.
provider
Section: auth
Default Value: ""
Valid Values: "", wfm
Changes Take Effect: After restart
Dependencies: [Server] tzdb. See Important note in this option
Introduced: 8.5.214.08
Specifies the provider that performs WFM user authentication.
If this option value is set to:
- "" (empty string)—WFM Server SOAP API authenticates WFM users.
- wfm—WFM Server REST API (on-premises) authenticates WFM users. Such configuration influences default value of tzdb option which controls time zones usage.
PreventFraming
Section: Functionality
Default Value: true
Valid Values: true, false
Changes Take Effect: Immediately
Dependencies: None
Specifies whether the HTTP header X-Frame-Options is added to all JSP pages served by WFM Web.
If this option value is set to true, the header is added and prevents WFM Web pages from loading in the frame being used by the site and served from another domain. WFM Web pages served from the same domain as the one in the frame are allowed.
Use this option as protection from clickjacking.
PreventFraming
Section: Functionality
Default Value: true
Valid Values: true, false
Changes Take Effect: Immediately
Dependencies: None
Specifies whether the HTTP header X-Frame-Options is added to all JSP pages served by WFM Web.
If this option value is set to true, the header is added and prevents WFM Web pages from loading in the frame being used by the site and served from another domain. WFM Web pages served from the same domain as the one in the frame are allowed.
Use this option as protection from clickjacking.
LimitScheduleDetails
Section: AgentSchedule
Default Value: false
Valid Values: true, false
Changes Take Effect: Immediately
Dependencies: None
Specifies whether or not WFM replaces the actual names of non-tradeable Exceptions and Time-Off items with generic names in the Web for Agents Other Schedules view. Administrators use this feature to hide sensitive information, if required.
If this option value is set to true, WFM replaces the actual names of non-tradeable Exceptions and Time-Off items with generic names in the Web for Agents. If this option value is set to false, WFM displays the actual names of Exception and Time-Off.
ServiceLevelMethod
Section: ForecastService
Default Value: 0
Valid Values: 0, 1
Changes Take Effect:
Dependencies: None
Introduced: 8.5.207
Specifies whether Service Level should be calculated from the number of interactions distributed or from the number of interactions offered, taking into account abandoned interactions.
The default value 0 indicates that Service Level is calculated, based on the number of interactions distributed. To include abandoned interactions, set the value to 1.
MonitorStatThreadActivityTimeout
Section: Options
Default Value: 0
Valid Values: 0, any integer greater than 20
Changes Take Effect: Immediately
Dependencies: None
Introduced: 8.5.208.01
Specifies the timeout interval (in minutes) after which Data Aggregator shuts down if it does not detect Statistics thread activity.
If this option value is set to 0 (default), Data Aggregator does not shut down. The minimum timeout is 20, minutes.
connectiontimeout
Section: SMTP
Default Value: 60 seconds
Valid Values: Any positive integer
Changes Take Effect: Immediately
Dependencies: None
Introduced: 8.5.210.00
Specifies the time interval (in seconds) after which the connection between WFM Daemon and the SMTP server times out.
timeout
Section: SMTP
Default Value: 60 seconds
Valid Values: Any positive integer
Changes Take Effect: Immediately
Dependencies: None
Introduced: 8.5.210.00
Specifies the time interval (in seconds) after which communication between WFM Daemon and the SMTP server times out.
keep-startup-file
Section: Log
Default Value: false
Valid Values: true, false
Changes Take Effect: After restart
Dependencies: None
Introduced: 8.5.210
Specifies whether WFM Data Aggregator keeps or deletes a startup segment of the log containing the initial configuration options when it reaches the value in the expire option.
If this option value is set to false, WFM Data Aggregator does not keep the startup segment of the log.
If this option value is set to true, WFM Data Aggregator keeps a startup segment of the log. The size of the segment equals the value of the segment option. The value <number> KB (kilobytes) or <number> MB (megabytes) sets the maximum size for a startup segment of the log.
If this option value is set to true, the size of the initial segment is equal to the size of the regular log segment, as defined by the segment option. The value of this option is ignored if segmentation is turned off (that is, if the segment option value is set to false).
keep-startup-file
Section: Log
Default Value: false
Valid Values: true, false
Changes Take Effect: After restart
Dependencies: None
Introduced: 8.5.210
Specifies whether WFM Builder keeps or deletes a startup segment of the log containing the initial configuration options when it reaches the value in the expire option.
If this option value is set to false, WFM Builder does not keep the startup segment of the log.
If this option value is set to true, WFM Builder keeps a startup segment of the log. The size of the segment equals the value of the segment option. The value <number> KB (kilobytes) or <number> MB (megabytes) sets the maximum size for a startup segment of the log.
If this option value is set to true, the size of the initial segment is equal to the size of the regular log segment, as defined by the segment option. The value of this option is ignored if segmentation is turned off (that is, if the segment option value is set to false).
keep-startup-file
Section: Log
Default Value: false
Valid Values: true, false
Changes Take Effect: After restart
Dependencies: None
Introduced: 8.5.210
Specifies whether WFM Server keeps or deletes a startup segment of the log containing the initial configuration options when it reaches the value in the expire option.
If this option value is set to false, WFM Server ignores this option and does not keep the startup segment of the log.
If this option value is set to true, WFM Server keeps a startup segment of the log. The size of the segment equals the value of the segment option. The value <number> KB (kilobytes) or <number> MB (megabytes) sets the maximum size for a startup segment of the log.
If this option value is set to true, the size of the initial segment is equal to the size of the regular log segment, as defined by the segment option. The value of this option is ignored if segmentation is turned off (that is, if the segment option value is set to false).
RestoreMode
Section: ScheduleService
Default Value: 0
Valid Values: 0, 1
Changes Take Effect: Immediately
Dependencies: None
Introduced: 8.5.210
Specifies the schedule that will be restored from the Schedule Audit log when an existing full-day Time-Off or Exception schedule is deleted.
If this option value is set to 0 (default), WFM restores the Baseline Schedule from the log. If its value is set to 1, WFM restores the Most Recent Schedule.
If this option is not specified, the current functionality is maintained.
ShowAllActivities
Section: Options
Default Value: false
Valid Values: true, false
Changes Take Effect: Immediately
Dependencies: None
Specifies how the Daily Schedule view is displayed in Web for Agents.
If this option value is set to true WFM displays all possible activities for that agent, whether scheduled or not. If set to false, WFM displays only the agent’s scheduled activities.
See the CustomActivities configuration option for related functionality and find out how the ShowAllActivities option settings affect the it.
CustomActivities
Section: Options
Default Value: " " (string)
Valid Values: Any text string up to 255 characters
Changes Take Effect: Immediately
Dependencies: The ShowAllActivities option value must be set to false
Specifies how WFM displays schedule details for selected agents in all views.
If this option is enabled, the custom value is displayed against the agents schedule, rather than any of the activities for which they are scheduled. This value can be set to null, which displays nothing in Web for Agents.
- If this option value is not defined or its value is empty (no text), then WFM Web displays a list of all activities for which the agent is scheduled.
- If this option value is a text string, WFM Web displays that text string.
- If the ShowAllActivities option value is set to true, this option has no effect; WFM Web displays a list of all activities for which the agent has skills.
- If the ShowAllActivities option value is set to false, the value replaces the list of all activities, for which the agent has skills.
ProcessOvertimeTimeout
Section: ScheduleService
Default Value: 0
Valid Values: Any positive integer
Changes Take Effect: Immediately
Dependencies: None
Introduced: 8.5.212
Specifies the timeout or interval between overtime bidding processes.
For example, if this option value is set to 1 (minimum acceptable value), automatic processing is enabled and bids in the queue are processed every minute. If this option value is set to 0, automatic processing of overtime bids is disabled.
InsertPayback
Section: Functionality
Default Value: false
Valid Values: true, false
Changes Take Effect: Immediately
Dependencies: InsertPaybackException
Introduced: 8.5.212.13
Specifies whether or not agents can insert Payback into schedules without adding an Exception to make up for lost work time.
If this option value is set to true this functionality is enabled and agents can insert Payback without adding an Exception. If this option value is set to false this functionality is disabled and agents cannot insert Payback without adding an Exception.
This option takes effect only if the InsertPaybackException is set to true. If InsertPaybackException is disabled (set to false), then InsertPayback is disabled (set to false).
provider
Section: auth
Default Value: " "
Valid Values: " ", wfm
Changes Take Effect: After restart
Dependencies: See Important note in this option
Introduced: 8.5.214.14
Specifies the provider that performs authentication when users log in to WFM.
If this option value is set to:
- " " (empty string)—A legacy, WFM proprietary mechanism is used to authenticate user access to the WFM Web for Supervisors (Classic) interface.
- wfm—An internal WFM implementation of authentication is used to provide user access to the WFM Supervisor interface.
ClassicAgent
Section: Functionality
Default Value: true
Valid Values: true, false
Changes Take Effect: Immediately
Dependencies: NewAgent
Introduced: 8.5.214.14
In coordination with the NewAgent option, specifies whether the Classic WFM Agent interface is available.
This option combines with the setting for the NewAgent option in the following ways:
- NewAgent = true, ClassicAgent = false
- After an agent logs in, only the Agent UI is available. The option enabling agents to switch to the Classic UI is absent in the Log off drop-down menu.
- NewAgent = false, ClassicAgent = false
- After an agent logs in, only the Agent UI is available. The option enabling agents to switch to the Classic UI is absent in the Log off drop-down menu.
- NewAgent = false, ClassicAgent = true
- After an agent logs in, only the Classic Agent UI is available.
- NewAgent = true, ClassicAgent = true
- After an agent logs in, the Agent UI opens but the option enabling agents to switch to the Classic UI is present in the Log off drop-down menu.
NewSupervisor
Section: Functionality
Default Value: false
Valid Values: true, false
Changes Take Effect: Immediately
Dependencies: [auth] provider configuration
Introduced: 8.5.214.14
Specifies whether or not the New UI setting displays in the WFM Web for Supervisors (Classic) interface, providing user access to the latest Forecast user interface (UI).
If this option value is set to true, the New UI setting displays in the Supervisors (Classic) UI. If this option value is set to false, the New UI setting is not visible in the Supervisors (classic) UI.
tzdb
Section: Server
Default Value: 1, 0 (see description)
Valid Values: 1, 0
Changes Take Effect: Immediately
Dependencies: [auth] configuration
Introduced: 8.5.214.08
Specifies whether or not WFM time zones are converted to standard IANA time zones.
The default value for this option depends on the [auth] configuration:
- If [auth] is not configured, the default value is 0.
- If [auth] is configured the default value is 1. If you want to keep using Genesys time zones in this configuration, value should be explicitly set to 0.
When this option default is 1 (enabled), WFM time zones (and time zone assignments for business units, sites, etc.), are automatically converted to Internet Assigned Numbers Authority (IANA) time zones, and no longer synchronize with Genesys time zones. When this option default is 0 (disabled), WFM time zones are not converted to IANA time zones.
Time zone conversion is done by using a JSON mapping file (tzmap.json) that can be modified, if necessary.
RestoreTerminatedAgents
Section: ConfigService
Default Value: true
Valid Values: true, false
Changes Take Effect: Immediately
Dependencies: None
Introduced: 8.5.215.09
Modified: 8.5.219.11
Specifies whether WFM prevents creating duplicate agents when they are deleted and then recreated in Genesys Administrator.
If this option value is set to true, WFM does not create duplicate agents in the WFM Database, but recreates these agents by associating them with their previously deleted employee ID.
This option value is set to true, by default.
AppletFont
Section: Options
Default Value: " " (string)
Valid Values: A font name
Changes Take Effect: Immediately
Dependencies: None
Introduced: 8.5.215.10
Specifies the font that WFM Web will use in the JAVA subsystem.
SupervisorSessionInactiveTimeout
Section: Options
Default Value: 15
Valid Values: Any positive integer
Changes Take Effect: At next login
Dependencies: Server/SessionTimeout, auth/provider
Specifies the inactivity interval for WFM Web for Supervisors before sessions time out.
When this option value is set to 0, WFM keeps the session active indefinitely. When this option is set to a positive integer greater than 0, the session expires after that duration of inactivity.
When this option is not set, the session expires after the 15 minutes of inactivity.
OvertimeMode
Section: ScheduleService
Default Value: 0
Valid Values: 0,1
Changes Take Effect: Immediately
Dependencies: None
Introduced: 8.5.219.17
Enables the ability to accommodate added overtime for a scheduled shift substitution by preserving the paid hours of the original shift plus any added overtime.
NewSupervisor
Section: Functionality
Default Value: false
Valid Values: true, false
Changes Take Effect: Immediately
Dependencies: [auth] provider configuration
Introduced: 8.5.214.14
Specifies whether or not the New UI setting displays in the WFM Web for Supervisors (Classic) interface, providing user access to the latest Forecast user interface (UI).
If this option value is set to true, the New UI setting displays in the Supervisors (Classic) UI. If this option value is set to false, the New UI setting is not visible in the Supervisors (classic) UI.
tz_mode
Section: Server
Default Value: iana
Valid Values: iana, posix
Changes Take Effect: After restart
Dependencies: tzdb
Introduced: 8.5.220.06
When the iana mode is set, WFM Server will send a time zone description according to https://www.iana.org/time-zones in response to the request to provide time zones, indicating the IANA/Olson time zone.
When the posix mode is set, WFM API (used by WFM Web) will not use the built-in Java API for the IANA time zones, instead it will use the time zone information returned by the WFM Server to calculate DST times. It is a workaround for the situation when WFM Server was updated to use the latest time zone database but the WFM Web or Java on the client side was not updated to use the latest time zone information.
When downloading content, you may encounter issues that are easily resolved. If these tips don't help, please Contact Us, and we will try to send you the file directly.
Downloading Help files
Save the Help file to your local hard drive, and uncompress (extract) it to an empty folder. To open the Help file, open the folder into which the .zip file was extracted, then do one of the following:
- If there is only one file in the folder, click that file.
- If there is more than one file in the folder, click the <name of compressed file>.htm file.
Viewing Help files
If, when you open the Help file, the contents do not display in the right window, consider the following:
- Are you trying to open the file on a remote computer? If so, copy it to your local machine. Due to a Microsoft security update, you cannot properly view a HTML-based (CHM) Help if it is located on another machine on your network.
- What is your permissions setting? Right-click the file, select Properties from the context menu, look for an Unblock button, and click it.
Workforce Management
Workforce Management (WFM) provides the tools that enable contact center managers to better manage their workforce. WFM enables managers to create accurate staffing plans that take into account projected contact volumes and average handle times, as well as the various skills and skill levels of the agent population. Contact center managers can achieve these goals, by using WFM's advanced forecasting, scheduling, and real-time adherence capabilities.
Release Notes
Documentation
Administrator's Guide
Use this guide to learn about WFM architecture, functionality, deployment, integration, high availability, and new features.
Web for Supervisors Help (latest)
Use this online Help as site supervisor to use a web browser to manage workforce schedules and policies.
8.5.1 Web for Supervisors Help"> 8.5.1 Web for Supervisors Help
Use this downloadable .ZIP file as site supervisor to use a web browser to manage workforce schedules and policies.
Web for Agents Help (latest)
Use this online Help as an agent to use a web browser to view and manage your schedules and shifts.
8.5.0 Web for Agents Help"> 8.5.0 Web for Agents Help
Use this downloadable .ZIP file as an agent to use a web browser to view and manage your schedules and shifts.
Workforce Management Migration
Use this content to find out about WFM migration prerequisites, procedures, changes between releases, and new features.
ETL Database Reference
Use this reference to learn about WFM's Extract, Transform, and Load (ETL) database schema.
International Release Notes, Help
Workforce Management 8.5 Release Information
Click below to see New in This Release, Readme, and Product Alerts information for 8.5 releases.
[+] Show release information
Release Notes
Documentation
Adminstrator's Guide
Use this guide to learn about WFM architecture, functionality, deployment, integration, high availability, and new features.
Web for Supervisors Help"> Web for Supervisors Help
Use this downloadable .ZIP file as site supervisor to use a web browser to manage workforce schedules and policies.
Web for Agents Help"> Web for Agents Help
Use this downloadable .ZIP file as an agent to use a web browser to view and manage your schedules and shifts.
Configuration Utility Help"> Configuration Utility Help
Use this downloadable ZIP file to configure the WFM Database used by Web for Supervisors and Agents.
ETL Database Reference
Use this reference to learn about WFM's Extract, Transform, and Load (ETL) database schema.
International Release Notes, Help
Product Advisories
Workforce Management 8.1 Release Information
Click below to see New in This Release and Readme information for 8.1 releases.
[+] Show release information
Release Notes
Documentation
Administrator's Guide"> Administrator's Guide
Use this downloadable PDF to deploy WFM and enable its features.
Web for Supervisors Help"> Web for Supervisors Help
Use this downloadable .ZIP file as site supervisor to use a web browser to manage workforce schedules and policies.
Web for Agents Help"> Web for Agents Help
Use this downloadable .ZIP file as an agent and use a web browser to view/manage your schedules and shifts.
Configuration Utility Help"> Configuration Utility Help
Use this downloadable ZIP file to configure the WFM Database used by Web for Supervisors and Agents.
International Release Notes, Help
Helpful Links
Release Notes
Documentation
Note: Workforce Management 7.5 reached End of Support. However, there may be some links to 7.5 documents contained in these documents. If there isn't a 7.6 version of the document and you need it for your 7.6 release, contact Customer Care.
Administrator's Guide"> Administrator's Guide
Use this downloadable PDF to deploy WFM and enable its features.
Integration API Developer's Guide"> Integration API Developer's Guide
Use this downloadable PDF to deploy WFM server-side integration between Genesys software and third-party software.
Supervisor User's Guide"> Supervisor User's Guide
Use this downloadable PDF as a Supervisor to learn how to plan, forecast, and monitor schedules and time-off requests.
Agent User's Guide"> Agent User's Guide
Use this downloadable PDF as an agent to learn how to view and change your schedule and time off requests.
Configuration Utility User's Guide"> Configuration Utility User's Guide
Use this downloadable PDF as an Administrator to learn how to configure agents, schedules, reports, and time-off requests.
Configuration Utility Help"> Configuration Utility Help
Use this downloadable ZIP file to configure the WFM Database used by Web for Supervisors and Agents.
Web for Supervisors Help"> Web for Supervisors Help
Use this downloadable .ZIP file as site supervisor to use a web browser to manage workforce schedules and policies.
Web for Agents Help"> Web for Agents Help
Use this downloadable .ZIP file as an agent and use a web browser to view/manage your schedules and shifts.

