References

Configuration parameters

General

Configuration parameter

Description

WfmStartOfEra

The beginning of the year count for rotation application purposes.

  • Optional.

  • The default value is 01.01.2018 (1 January 2018).

WfmTimeGranularity

The smallest time interval for which you want to schedule activities.

  • In minutes.

  • Optional.

  • The default value is 15.

WfmStandByAgentsCount

When the stand-by mode is applied, then the stand-by mode is set for the indicated number of agents .

  • Optional

  • The default value is 1.

XssWfmDisp

Filter the HTML display on the Info editor tab of the agent inserted using BodyHtmlWfmAgentMeta the parameter.

  • Possible values are: None – no restrictions; Filter – remove the script, iframe, object, embed, link, head, style and meta elements from HTML; Protect – use HtmlSanitizer including styles; Strict – AntiXSS 4.3; Text – HtmlStrip + HtmlEncode.

  • Optional.

  • The default value is Filter.

Shift editor

Note

The following configuration parameters have no value by default. The below values marked as default are actually set by executing Model.Sql\Admin-Standard\Standard-Wfm.sql. This script also creates a DQ with an ID to which the following configuration parameters refer.

Configuration parameter

Description

WfmRealPlanAgentsQueryId

An ID of the DQ used to display agents in the reality plan. The source DQ for populating the agent list in the reality plan. It is used to customize the displayed columns in the shift editor, highlight and sort them, and possibly to exclude agents from the list.

  • Optional.

  • The default value is be63ed12-8ad6-4042-8891-540a6e6187a1.

The first column must be named AgentId, the second column Color.

#

Name

Model

Meaning

1.

AgentId

GUID

Agent ID. Since it is of the GUID type, this column does not appear in the query columns; instead, SELECT ... AS AgentId must appear.

2.

Color

Text

A valid HTML color notation (#hex, name, rgb() or rgba ()) for the line background.

Any other columns that you create will appear in the list as columns in the shift editor with the following rules:

  • If the model is Text, the filter in the shift editor header is displayed as an input box.

  • If the model is Select, the filter in the shift editor header is displayed as a drop-down box. It also appears as a column in the main section.

  • If the width is blank and the model is Integer, the column appears as a sort button in the header and does not appear as a column.

WfmDraftPlanAgentsQueryId

An ID of the DQ used to display agents in the reality plan. The source DQ for populating the agent list in the reality plan. It is used to customize the displayed columns in the shift editor, highlight and sort them, and possibly to exclude agents from the list.

  • Optional.

  • The default value is 7e9ab883-2ece-4ee7-bfc5-3dee80e8b725.

The expected DQ structure is the same as for WfmRealPlanAgentsQueryId.

WfmRotationValidationUrl

A URL for rotation validation. It allows customizable rotation control prior to approval. The value is the URL to the service that checks the rotation and stores any errors in the database. The value of {0} is replaced with the rotation ID, ##LSN## with LocalServerName from the Web.config file of ReactClient.

  • Optional.

  • The default value is http://##LSN##:60600/Cezweb/api/wfmplanvalidation/validaterotation/{0}.

WfmPlanNext7DaysUrl

A click-through URL in the shift editor to the agent’s schedule for the next seven days.

  • Optional.

  • The default value is wfmplaneditor.html?Id=c9890f0f-6298-48ac-a8bd-8a51b5332b51&NumberOfDays=7&WfmAgentId={0}.

DropDownWfmAgentsDataQueryId

An ID of the DQ to populate the agent drop-down list in the shift editor in the “next 7 days” mode.

  • Optional.

  • The default value is 0a8dcb0a-dbeb-4a80-b77a-fdfd39a98735.

The query must return the columns of Id, DisplayName, SpecificName (a grouping column, such as Crew.Name or Agent.TeamName), Glyph. The query parameters are AgentId and TeamName.

WfmCreateDraftDialogOnlyDate

Show only date or date and time in the dialog when creating an alternative schedule for the start and end of a period.

  • Optional.

  • Possible values: true – only date, false – date and time.

  • The default value is false.

ExportWfmPlanNavigationGroup

The name of the group in the Navigation table, which will be used in the shift editor to display export and print icons and actions.

  • Optional.

  • The default value is ExportWfmPlan.

Agent editor

Note

The following configuration parameters have no value by default. The below values marked as default are actually set by executing Model.Sql\Admin-Standard\Standard-Wfm.sql.

Configuration parameter

Description

WfmAgentMetaBodyHtmlUrl

A URL that returns any HTML that is to be displayed on the Info tab of the agent editor after the Vacation used [days] field.

  • Optional.

  • The default value is ../../Cezweb/api/wfmplanvalidation/wfmagentmetabodyhtml.

BodyHtmlWfmAgentMeta

HTML that the default application of App.Web returns when the WfmAgentMetaBodyHtmlUrl endpoint is called.

The HTML can contain the following macro expansions that replace the endpoint with the actual value:

  • {Agent.SystemName} – column Agent.SystemName

  • {Agent.PersonalEmail} – column Agent.PersonalEmail

  • {Agent.RemainingVacancy} – the calculated remaining vacation days

WfmAgentFormScenarioId

An ID of the scenario for entering agent data affecting shift scheduling (pregnant, youth, allowed overtime, night time, etc.) and displayed in the agent editor.

  • Optional.

  • The default value is 9870236d-4785-4e51-ac2d-874992953340.

Note

The scenario elements must correspond to how the validation is programmed and, therefore, this setting is usually adjusted by the vendor when implementing WFM.

WfmAgentXxxUsedCalculationUrl

A URL called when publishing an alternate schedule to the real one. The value of {0} is replaced with the agent ID, ##LSN## with LocalServerName from the Web.config file of ReactClient.

  • Optional.

  • The default value is http://##LSN##:60600/Cezweb/api/wfmplanvalidation/xxxusedcalculation/{0}.

The endpoint of the App.Web default application writes values to the WfmAgent table in the VacancyUsed, YearWorkUsed, YearOvertimeUsed and YearStandByUsed columns.

WfmVacationFactor

Indicates in how many fractions of the day a vacation can be split for WFM purposes. For example, 2 means that half a day of vacation can be taken, 1 means only full days.

  • Optional.

  • The default value is 2.

ExportCrewNavigationGroup

The group name in the Navigation table that will be used in the crew editor to display the buttons.

  • Optional.

  • The default value is ExportCrew.

ExportWfmPlanNavigationGroup

The group name in the Navigation table that will be used in the shift editor to display the buttons.

The user must still have the ExportWfmPlan right for it to be actually displayed.

  • Optional.

  • The default value is ExportWfmPlan.

ExportWfmAgentNavigationGroup

The group name in the Navigation table that will be used in the shift editor to display the buttons.

The user must still have the ExportWfmPlan right for it to be actually displayed.

  • Optional.

  • The default value is ExportWfmAgent.

Traffic models

Configuration parameter

Description

TrafficWfmSlotsCountsDataQueryId

An ID of the DQ used to display columns in the Editor of planned and estimated figures, or the number of slots in each half-hour of the day of the traffic model.

  • Optional.

  • The default value is ee56e927-160f-46cd-90df-69db95758052.

A required column in DQ:

#

Name

Model

Meaning

1.

TimeUtc

DateTimeUtc

Time on the X axis. The start of the period.

And then any number of columns with the Integer model, indicating the number of agents with a particular activity group (WfmActivity.GroupName). You can use any column name. The column color in the DQ definition is used as the chart bar color.

For example, the second one groups all work activities, the third one groups all breaks:

#

Name

Model

Color

2.

Servants

Integer

#b38867

3.

Total

Integer

#337ab7

TrafficSlotsDataQueryId

An ID of the DQ used to display the connector in Editor of planned and estimated figures, or the number of traffic model agents needed.

  • Optional.

  • The default value is 9c7ce524-1209-485a-a4ad-7c3434bddd24.

Excpected DQ structure:

#

Name

Model

Meaning

1.

TimeUtc

DateTimeUtc

Time on the X axis. The start of the period.

2.

Servants

Integer

The number of agents required.

TrafficSlotTotalDataQueryId

An ID of the DQ used to display columns and connectors in the Traffic Editor, or traffic model event counts.

  • Optional.

  • The default value is 7f487747-fa36-4fa1-ac16-0133cb04a4a3.

Excpected DQ structure:

#

Name

Model

Meaning

1.

TimeUtc

DateTimeUtc

Time on the X axis. The start of the period.

2.

Total

Integer

The number of communications per given period.

3.

Servants

Integer

The number of agents required.

DropDownTrafficModelsDataQueryId

An ID of the DQ that provides a list of traffic models for drop-down lists in the Comparison Editor.

  • Optional.

  • The default value is 1b819fe9-4860-4f1b-8ec4-6708764ca511.

The expected DQ structure is a common drop-down list with the Id, DisplayName, SpecificName and Glyph columns.

Integration

Configuration parameter

Description

WfmSapH5ExceptionRegiCodes

(In the case of integration with SAP H5.) The region codes sent to SAP H5 as an export of non-working agent slots within WFM.

  • Optional.

  • The default value is 0100,0110,0299,Z021.

Shift editor tasks

Note

The supplied Model.Sql\Admin-Standard\Standard-Wfm.sql script will prepare usual editor tasks for the Shift Editor in the administration environment in the Portal/Editors/Jobs section.

Button type

Description

DialogStartEndAndNewHeader

Opens a dialog for getting the Start/End parameters and creates a new WfmPlan entry with Start/End according to the dialog where it sets Progress=0, and passes the new entry ID to the URL.

The parameter influencing program behavior can take one of the following values and influence the default values of the from and/or to fields in the dialog.

  • TwoWeeksAgoMonth – “From” will be two weeks ago, “To” will be in one month

  • WeekHalfYear– “From” will be Monday of the current week + 28 days (it will be a Monday); “To” will be Monday of the current week + 24 weeks.

  • TodayMonth – “From” will be 0:00 today; “To” will be 0:00 today + one month

  • TodayWeek – “From” will be 0:00 today; “To” will be 0:00 today + one week

  • WeekMonth – “From” will be from Monday of the current week + 14 days; “To” will be Monday of the current week + 6 weeks

  • WeekNoEnd – “From” will be Monday of the current week + 14 days; “To” will not appear in the dialog

DialogStartEndAndReference

Opens a dialog to get the Start/End parameters, sets Progress=0 for the current record and passes the parameters along with the current record ID to the URL.

The parameter influencing program behavior can take one of the following values and influence the default values of the from and/or to fields in the dialog.

  • TwoWeeksAgoMonth – “From” will be two weeks ago, “To” will be in one month

  • WeekHalfYear– “From” will be Monday of the current week + 28 days (it will be a Monday); “To” will be Monday of the current week + 24 weeks.

  • TodayMonth – “From” will be 0:00 today; “To” will be 0:00 today + one month

  • TodayWeek – “From” will be 0:00 today; “To” will be 0:00 today + one week

  • WeekMonth – “From” will be from Monday of the current week + 14 days; “To” will be Monday of the current week + 6 weeks

  • WeekNoEnd – “From” will be Monday of the current week + 14 days; “To” will not appear in the dialog

Reference

Sets Progress=0 on the current record and passes the current record ID to URL.

It has no Parameters influencing program behavior.

Roles and permissions

Roles

Description

WfmPlanApproval

Indicates which operations a user can perform with alternative plans: create a draft (AllowRead), submit a draft plan for approval (AllowWrite), publish to the actual plan (AllowFull).

EditWfmAgent

View (AllowRead) or edit (AllowWrite) the agent in the Agent Editor.

EditWfmPlan

Just display (AllowRead) or also save (AllowWrite) the schedule in the Shift Editor.

EditWfmWorkplace

Just view (AllowRead) or also edit (AllowWrite) the scheduled workplace.

WfmPlanApproval

Create a draft (AllowRead), submit a draft plan for approval (AllowWrite), or publish to the actual plan (AllowFull).

ExportWfmPlan

Show navigation buttons in the Shift Editor (AllowRead). The navigation buttons for the Shift Editor must have a group defined by the ExportWfmPlanNavigationGroup parameter.

ExportWfmAgent

Show navigation buttons in the Agent Editor (AllowRead). The navigation buttons for the Agent Editor must have a group defined by the ExportWfmAgentNavigationGroup parameter.