Manage Bulk Jobs

Manage Bulk Jobs

Bulk jobs are a fast and efficient way to enter data at initial setup and to incorporate large-scale changes, such as changing agent skill groups between shifts and incorporating a new contact center with multiple new agents.

Changes to an individual record are made directly to that record, using the appropriate tool (Agent, Dialed Number, and so on).

Although bulk job content files create records explicitly, they also implicitly create related records, as follows:

  • An agent bulk job content file contains cells for agent team, skill groups, and attributes. Entering content in those cells creates those objects if they do not exist.

  • A dialed number bulk job content file contains cells for call type. Entering content in those cells creates those objects if they do not exist.


Important

Run bulk jobs:

  • Only during off-peak hours. Do not run bulk jobs during heavy call load.


Supervisors have no access to the Bulk Jobs tool.

Download Bulk Job Content File Template

Bulk jobs apply changes entered in content file templates. Content file templates are in .csv format.

The content file is syntactically validated before the bulk job is created. Database-related errors and conflicts are reported during execution of the job.


Note

If you are using the Packaged CCE Lab deployment, you can download the Inventory content file. Use this file to enable the System Inventory and certain features, by providing machine information and credentials.


Procedure


Step 1

Navigate to Unified CCE Administration > Manage > Bulk Jobs to open the List of Bulk Jobs page.

Step 2

Click Templates.

The Download Templates popup window opens.

Step 3

Click the Download icon for the template you want to use.

Step 4

Click OK to close the Download Templates popup window.

Step 5

Open the template in Microsoft Excel.

Step 6

Populate the file.

Step 7

Save the populated file locally.


Content File Rules


Note

The rules in this section do not apply to the SSO Migration content file.

For more information about using the SSO Migration content file, see the Cisco Packaged Contact Center Enterprise Features Guide at https://www.cisco.com/c/en/us/support/customer-collaboration/packaged-contact-center-enterprise/products-maintenance-guides-list.html.


Content File Create Operations

The content file spreadsheets follow these CREATE rules:

  • All columns in the spreadsheet must be present, but the cells for optional fields can be left blank.

  • Rows in the file are processed sequentially. It is possible for a content file to fail at any point (at any row), in which case objects up to but not including that row are added or updated.

    If a row fails, all additions or updates before that row succeed, but all subsequent create and update operations fail.

  • Agent: Creating an agent with the following cells populated implicitly creates the objects if they do not exist: agent team, skill group, attributes, supervisor team, and department.

  • Dialed number: Creating a dialed number with the call type and department populated implicitly creates those objects, if they do not already exist.

Content File Update Operations

The Content file spreadsheets follow these UPDATE rules:

  • Enter a value in a field to change the existing value.

  • Leave a field blank to keep the existing value.

  • Enter ~ in a field to clear the value in the existing value.

Bulk Agent Content File

The content file for the agent bulk job contains the fields detailed in the table below.

Field

Required?

Description

operation

yes

Enter one of the following (case-insensitive):

  • CREATE

  • UPDATE

agentID

no

Enter a unique string of up to 11 digits. AgentID is automatically generated if you leave the field blank.

In an UPDATE operation:

  • You cannot change agentID

  • If you leave the field blank, the userName must reference an existing agent

userName

yes

Enter up to 255 ASCII characters. The login name supports the use of all characters from 33 to 126 in the ASCII character set, except for the following: double quotation mark ("), forward slash (/), backward slash (\), square brackets ([ ]), colon (:), semicolon (;), pipe (|), equal to (=), comma (,), plus sign (+), asterisk (*), question mark (?), angle brackets (< >), hash (#), percent (%), and SPACE.

For supervisors and for agents with single sign-on (SSO) enabled, the username is the user's Active Directory or SSO account username.

For supervisors who are not enabled for single sign-on (SSO), the Active Directory username must be in the user@domain format.

firstName

yes

Enter a maximum of 32 characters.

lastName

yes

Enter a maximum of 32 characters.

password

no

Enter a maximum of 256 ASCII characters. Password is case-sensitive.

If SSO is enabled, the password is not saved.

loginEnabled

no

Indicates whether the agent is able to log in to the agent desktop. If not specified, defaults to True.

ssoEnabled

no

Indicates whether single-sign on is supported at the agent level. This field takes effect only when the global level of SSO is mixed.

description

no

Enter up to 255 characters to describe the agent. If description is left blank during a CREATE operation, it is set to the ID of the bulk job performing the CREATE operation.

agentStateTrace

no

Indicates whether agent state trace is enabled for this agent. Defaults to False.

agentDeskSettingsName

no

Enter the desk settings associated with this agent.

In a CREATE operation, your entry of agentDeskSettingsName generates an error when there is no desk settings with that name.

Leaving this blank applies the System Default Desk Settings.

agentTeamName

no

Enter the team in which this agent is a member.

In a CREATE operation, your entry of agentTeamName creates that team if it does not already exist. It appears in the List of Teams with the description BulkJob ID ####, where #### is the number of the bulk job.

skillgroup(s)

no

Enter the skill groups with which this agent is associated, delimited by the ";" character. For example: sales;billing;support.

In a CREATE operation, your entry of skillgroup creates that skill group if it does not already exist. It appears in the List of Skill Groups with the description BulkJob ID ####, where #### is the number of the bulk job.

defaultSkillGroup

no

Enter the default skill group associated with this agent. If the field is specified, it must reference a skill group defined for the agent.

In an UPDATE operation, an error is generated if the value is no longer one of the agent's skill groups.

attributes

no

These fields are name = value pairs delimited by the ";" character, where = value is optional for existing attributes. For example, english=true;sales=7.

Adding an attribute with a data type (Boolean or Proficiency) and a value (true or 9), either directly in the Attributes tool or with a bulk job, defines and protects the data type and establishes that value as the default.

If an attribute does not yet exist in the Attributes tool, entering an attribute name without a value generates an error. For example if english is not yet an attribute, then english returns an error.

You cannot change the data type, but you can change the value. If english was created as True, entering english retains the True value in a bulk update. You can also enter english=false, which sets the agent attribute value to False, leaving the attribute default value at True. You cannot enter english=10.

To clear an agent's attribute value and reestablish the attribute default on a bulk update, just specify the attribute name, for example, english.

In a CREATE operation, your entry of attribute creates that attribute if it does not already exist. It appears in the List of Attributes with the description BulkJob ID ####, where #### is the number of the bulk job.

supervisor

no

Indicates whether the agent is a supervisor. Defaults to False.

supervisorTeams

no

Enter names of teams that will be supervised by this supervisor, delimited by the ";" character. For example: team1;team2;team3. Populating this field but leaving supervisorUserName blank generates an error.

In a CREATE operation, your entry of supervisorTeams creates that team if it does not already exist. It appears in the List of Teams with the description Bulk Job ID: ####, showing the number of the bulk job.

siteName

no

The site name for this dialed number.

If specified, the value must match an existing site name.

If not specified, this field is set to default Main site.

Bulk Dialed Number Content File for 2000 Agent Deployments

The content file for the dialed number bulk job contains these fields:

Field

Required?

Description

operation

yes

Enter one of the following (case-insensitive):

  • CREATE

  • UPDATE

  • DELETE

dialedNumberString

yes

The dialedNumberString for this dialed number.

Enter a string value that is unique for the routing type, maximum of 25 characters.

Valid values are alphanumeric, +, and @.

Note 

You cannot update dialedNumberString.

routingType

yes

The routing type for this dialed number. Values are 1 to 7.

  • 1 (External Voice): Dialed number strings that apply to voice calls coming from Cisco Unified Customer Voice Portal (CVP).

  • 2 (Internal Voice): Dialed number strings that can be called from a Cisco Unified Communications Manager phone.

  • 3 (Outbound Voice): Dialed number strings that are used by the Cisco Outbound Option Dialer.

  • 4 (Multichannel 1). Requests that come from Enterprise Chat and Email, SocialMiner, or third party.

  • 5 (Multichannel 2). Requests that come from Enterprise Chat and Email, SocialMiner, or third party.

  • 6 (Multichannel 3). Requests that come from Enterprise Chat and Email, SocialMiner, or third party.

Multichannel routing types are available only if you have configured the peripherals for Enterprise Chat and Email, SocialMiner, and/or Third Party Multichannel using Peripheral Gateway Setup tool, and added external multichannel machines to the System Inventory.

The order in which the peripherals for these machines appear on the System Information > Peripheral Gateway tab determines the routingType number (4, 5, or 6) for the machine. For example, if the SocialMiner peripheral appears first on the tab, it is routingType 4.

See the Cisco Packaged Contact Center Enterprise Features Guide at https://www.cisco.com/c/en/us/support/customer-collaboration/packaged-contact-center-enterprise/tsd-products-support-series-home.html for information about configuring the peripherals using Peripheral Gateway Setup.

description

no

The description for this dialedNumberString. Enter a maximum of 255 characters. If the description field is left blank in a CREATE operation, it is set to the ID of the bulk job performing the CREATE operation.

callTypeName

no

Enter a name for the call type using a maximum of 32 characters. Valid characters are period(.), underscore (_), and alphanumeric. The first character must be alphanumeric.

In a CREATE operation, your entry of callTypeName creates that call type if it does not already exist. It appears in the List of Call Types with the description BulkJob ID ####, where #### is the number of the bulk job.

mediaRoutingDomainName

yes, for routingType 4, 5, and 6

Optional for routingTypes 1, 2, and 3. If supplied, must be Cisco_Voice.

Required for routingTypes 4, 5, and 6. The value must be Cisco_Voice or match an existing Media Routing Domain name.

departmentName

no

The department for this dialed number.

A global administrator's entry of department creates that department if it does not already exist. It appears in the List of Departments with the description BulkJob ID ####, where #### is the number of the bulk job.

If the department already exists, then that department can be entered by a global administrator or by an administrator who administers that department.

siteName

no

The site name for this dialed number.

If specified, the value must match an existing site name.

If not specified, this field is set to default Main site.

Bulk Call Type Content File

The content file for the call type bulk job contains these fields:

Field

Required?

Description

operation

yes

Enter one of the following (case-insensitive):

  • CREATE

  • UPDATE

  • DELETE

name

yes

Enter a name for the call type using a maximum of 32 characters. Valid characters are period(.), underscore (_), and alphanumeric. The first character must be alphanumeric.

description

no

The description for this call type. Enter a maximum of 255 characters. There is no restriction on characters. If the description field is left blank in a CREATE operation, it is set to the ID of the bulk job performing the CREATE operation.

serviceLevelThreshold

no

Maximum time in seconds that a caller should wait before being connected with an agent.

Enter a value in seconds, using positive 32-bit integers only.

serviceLevelType

no

Indicates how the system calculates the service level:

  • 1 = Ignore Abandoned Calls

  • 2 = Abandoned Calls have Negative Impact

  • 3= Abandoned Calls have Positive Impact

If not specified, this field is set to the system default.

bucketIntervalName

no

Identifier of the bucket interval, used for reporting.

If specified, the value must match an existing bucket interval.

If not specified, this field is set to the system default.

departmentName

no

The department for this call type.

A global administrator's entry of department creates that department if it does not already exist. It appears in the List of Departments with the description BulkJob ID ####, where #### is the number of the bulk job.

If the department already exists, then that department can be entered by a global administrator or by an administrator who administers that department.

Bulk Skill Group Content File

The content file for the skill group bulk job contains these fields:

Field

Required?

Description

operation

yes

Enter one of the following (case-insensitive):

  • CREATE

  • UPDATE

  • DELETE

name

yes

Enter a name for the skill group using a maximum of 32 characters. Valid characters are period(.), underscore (_), and alphanumeric. The first character must be alphanumeric.

description

no

The description for this skill group. Enter a maximum of 255 characters. There is no restriction on characters. If the description field is left blank in a CREATE operation, it is set to the ID of the bulk job performing the CREATE operation.

serviceLevelThreshold

no

Maximum time in seconds that a caller should wait before being connected with an agent.

Enter a value in seconds, using positive 32-bit integers only.

serviceLevelType

no

Indicates how the system calculates the service level:

  • 1 = Ignore Abandoned Calls

  • 2 = Abandoned Calls have Negative Impact

  • 3= Abandoned Calls have Positive Impact

If not specified, this field is set to the system default.

bucketIntervalName

no

Identifier of the bucket interval, used for reporting.

If specified, the value must match an existing bucket interval.

If not specified, this field is set to the system default.

mediaRoutingDomainName

no

Enter a name for the Media Routing Domain using a maximum of 32 characters. Valid characters are period(.), underscore (_), and alphanumeric. The first character must be alphanumeric.

If specified, the value must match an existing Media Routing Domain name.

If not specified, this field is set to Cisco_Voice.

You cannot change the mediaRoutingDomainName in an UPDATE operation. You must either leave this field blank or enter the existing mediaRoutingDomainName value.

departmentName

no

The department for this skill group.

A global administrator's entry of department creates that department if it does not already exist. It appears in the List of Departments with the description BulkJob ID ####, where #### is the number of the bulk job.

If the department already exists, then that department can be entered by a global administrator or by an administrator who administers that department.

siteName

no

The site name for this dialed number.

If specified, the value must match an existing site name.

If not specified, this field is set to default Main site.

Add and Maintain Bulk Jobs

Procedure


Step 1

Navigate to the Unified CCE Administration > Manage > Bulk Jobs to maintain (Add, Review, and Delete) bulk jobs.

Step 2

Click New to open the New Bulk Job window.

Step 3

In the optional Description fields, enter up to 255 characters to describe the bulk job. See Native Character Sets.

Step 4

In the required Content File field, browse to the content file you have completed for this bulk job. The content file is validated before the bulk job is created.

Step 5

Click Save.


Review Bulk Job Details

To review the details for a bulk job, click the bulk job row on the List of Bulk Jobs page. Fields on the page are display-only.

Field Description

ID, Description, and Type

Show the ID, description entered and type of bulk job selected when the bulk job was created.

State

Shows one of:

  • Queued: The bulk job has been queued and will process when any jobs submitted ahead of it have completed. When multiple bulk jobs are submitted, they are run in the order they are created.

  • Processing: The bulk job is being processed. To view the progress, click Log File Download to monitor the log file.

  • Succeeded: All operations in the bulk job were successful.

  • Partially Succeeded: Some operations were successful, and some were unsuccessful.

  • Failed: All operations were unsuccessful.

  • Cancelled: A bulk job is canceled when the preceding bulk job is terminated due to unrecoverable error while this job was in the queued state.

Host

The hostname of the AW server where the bulk job was initiated and will be stored. When deleted, bulk job content files and log files will be deleted from this host.

Created

The time the bulk job was submitted.

Started

The time the bulk job entered the processing state.

Finished

The time the bulk job completed or failed (left the processing state).

Total Time

The time the bulk job spent in the processing state. This is calculated as Finished - Started.

Content File

Click Download to open the Content .csv file that was submitted for this bulk job. You must authenticate to open or save this file. If your deployment includes two AW hosts, this button is disabled if the bulk job was created using Unified Web Administration on a host that is different from the host on which the job is being viewed.

Log File

Click Download to open the log file for this bulk job. If the job is still processing, click Download again to the review updates the job progresses. You must authenticate to open or save this file. If your deployment includes two AW server hosts, this button is disabled if the bulk job was created using Unified CCE Administration on a host that is different from the host on which the job is being viewed.

A log file is generated for each bulk job. The log file is retained until the bulk job is deleted and contains detail of each operation that was executed, as well as a summary indicating if the bulk job completed successfully or had failures.