Agent Vacation Summary Export Module

At-A-Glance

Category: Agent-related

Export file type: Pipe-delimited (|) or XML

File Naming Convention: agentVacationSummary_mmddyy_hhmm.txt or .xml

This export module provides a summary of scheduled and taken vacation time for agents, based on time off groups and rules. Agents who belong to a selected time off group must have at least one time off record to be included in the export. Agent Vacation Summary does not support time off rules with a calculation unit of days.

You can choose to receive this export in either a pipe-delimited or XML format. If you choose XML:

  • The output file looks different.
  • You cannot exclude fields from the export. All fields listed in the next section are included.
  • All of the agent summary records for a time off group and rule are grouped together in the same agentVacation element.
  • The agentID element is the agent's IEX WFM Integrated agent ID.

Output File: Fields and Descriptions

During your Professional Services engagement, you can choose which of the following fields to include in your export. Make sure you include every field you think you might need; you'll need a change request if you want to add fields after the export is configured. If you don't select specific fields, your export will include all the fields described here.

Field Description Values
custID

Customer ID

  
muID

MU ID

  
tvID

Agent's IEX WFM Integrated ID

  
acdID

ID of the CXone ACD or multimedia server on the specified date.

  
logonID

Logon for the agent associated with the acdID.

 

This field can be blank.
ssn

Agent's personal ID number

This field is blank if no personal ID number is assigned to or available for the agent.
agentData

Value assigned to the agent for the specified agent data group. You can include as many agentData elements as you want. The export file contains one field for each agentData element you specify. You can also specify the same agent data group more than once.

Agent data group values are stored by date range. They are not dependent on the agent's MU assignment.

If you don't select any agent data group, this field is omitted from the export.

This field is blank if the agent wasn't assigned a value for the specified agent data group for the date.
agentName

Agent's name, formatted as <last><first><suffix>

  
vacGroup ID of the agent’s Time Off Group. A record must exist for the agent in AgentMap whose vac_group_id field matches this ID. 1-2147483647
vacYear The time off rule for which data are being reported. This must be a time off rule with a calculation unit of HH:MM.  
vacType

The earnings type name.

The export includes all earnings types for which the agent has Vacation Summary data for the time off rule. There is a separate record for each type.

Vacation Summary records use the code -1 for the Wait List earnings type.

  
modify Last date and time the record was modified, formatted as a UNIX timestamp.  
from

Earliest date for which the agent may select an activity code. This is the earliest From Date for all the codes associated with the same earnings type.

  
to

Latest date for which the agent may select an activity code. This is the latest To Date for all codes associated with the same earnings type.

 
earned

Amount of time, in minutes, the agent has earned for the earnings type in the time off rule.

 
debited Amount of time, in minutes, debited for the earnings type.  
coFrom Amount of time, in minutes, the agent carried over from the previous year for the earnings type.  
coTo Amount of time, in minutes, the agent carried over into the next year for the earnings type.  
selected

Amount of time, in minutes, the agent has selected for the earnings type within the time off rule. The export includes only the vacation selections made for dates on and after the time off rule’s Master From Date. It doesn't use the date range specified when you set up the export.

This field is calculated at the time the export is run. You can find more information about these calculations in the help guides for the IEX WFM Rich Client Platform (RCP).

 This value is not stored in the database. It is the sum of selected time for all the codes associated with the same earnings type.
taken

Amount of time, in minutes, the agent has taken for the earnings type within the time off rule. The export includes only the vacation taken on agent schedules for dates before the time off rule’s Master From Date.

This field is calculated at the time the export is run. You can find more information about these calculations in the help guides for the IEX WFM Rich Client Platform (RCP).

 This value is not stored in the database. It is the sum of taken time for all codes associated with the same earnings type.
credited Amount of time, in minutes, added to the agent’s earned amount.  
minFullWeeks Number of weeks the agent must take in full week increments.  
maxPartialHours Maximum amount of time, in minutes, the agent is allowed to take in partial-day increments.  
externalID

If your company has configured Agent WebStation to use external IDs, the value is that ID for this agent.

If the agent's externalID field is blank, this field is also blank.

Pipe-Delimited Output File: Sample

The following shows a sample file generated for a customer, based on their custom parameters. It also shows the data values rather than field names. It's meant only to give you an idea of what your export might look like.

#fields:custID|muID|tvID|acdID|logonID|ssn|TeamLdr|agentName|vacGroup|vacYear|vacType|modify|earned|debited|coFrom|coTo| selected|taken|credited
#sort:custID,muID,vacGroup,vacYear,tvID,vacType
1|20|12345|27|12345||MDS|Meghan Barni|10|2020|Personal Time|1047802660|960|0|0|0|960|0|0
1|20|12345|27|12345||MDS|Meghan Barni|10|2020|Vacation|1047802660|7200|0|1440|0|4800|3360|0
1|20|54321|27|54321||MDS|John Sarlay|10|2020|Personal Time|1047802660|960|0|0|0|480|480|0
1|20|54321|27|54321||MDS|John Sarlay|10|2020|Vacation|1047802660|9600|0|4800|0|3840|5760|0
1|20|12345|27|12345||MDS|Meghan Barni|10|2021|Personal Time|1047802660|960|0|0|0|0|0|0
1|20|12345|27|12345||MDS|Meghan Barni|10|2021|Vacation|1047802660|7200|0|0|0|0|0|0
1|20|54321|27|54321||MDS|John Sarlay|10|2021|Personal Time|1047802660|960|0|0|0|0|0|0
1|20|54321|27|54321||MDS|John Sarlay|10|2021|Vacation|1047802660|9600|0|0|0|0|0|0

XML Output File: Sample

The following shows a sample file generated for a customer, based on their custom parameters. It also shows the data values rather than field names. It's meant only to give you an idea of what your export might look like.

<?xml version="1.0"?>
<agentVacationSummary>
  <agentVacation>
    <agent>
      <agentID>270</agentID>
      <vacGroup>10</vacGroup>
      <vacYear>2020</vacYear>
    </agent>
    <vacation type=”PTO”>
      <from><day>1</day><month>1</month><year>2020</year></from>
      <to><day>29</day><month>3</month><year>2021</year></to>
      <earned>2400</earned>
      <debited>0</debited>
      <credited>480</credited>   
      <selected>0</selected>
      <taken>0</taken>
      <minFullWeeks>0</minFullWeeks>
      <maxPartialHours>3840</maxPartialHours>
      <coFrom>1440</coFrom>
      <coTo>0</coTo>
    </vacation>
    <vacation type=”Personal Time”>
      <from><day>1</day><month>1</month><year>2020</year></from>
      <to><day>29</day><month>3</month><year>2021</year></to>
      <earned>480</earned>
      <debited>0</debited>
      <credited>0</credited>
      <selected>0</selected>
      <taken>0</taken>
      <minFullWeeks>0</minFullWeeks>
      <maxPartialHours>0</maxPartialHours>
      <coFrom>0</coFrom>
      <coTo>0</coTo>
    </vacation>
    <vacation type=”Wait List”>
      <from><day>1</day><month>1</month><year>2020</year></from>
      <to><day>29</day><month>3</month><year>2021</year></to>
      <earned>2400</earned>
      <debited>0</debited>
      <credited>0</credited>
      <selected>0</selected> 
      <taken>0</taken>
      <minFullWeeks>0</minFullWeeks>
      <maxPartialHours>2400</maxPartialHours>
      <coFrom>0</coFrom> 
      <coTo>0</coTo>
    </vacation>
  </agentVacation>
  <agentVacation>
    <agent>
      <agentID>275</agentID>
      <vacGroup>10</vacGroup>
      <vacYear>2020</vacYear>
    </agent>
  ...
  </agentVacation>
...
</agentVacationSummary>