Gplus Adapter 8.0 For Siebel CRM Deployment Guide
Gplus Adapter 8.0 For Siebel CRM Deployment Guide
Gplus Adapter 8.0 For Siebel CRM Deployment Guide
Deployment Guide
The information contained herein is proprietary and confidential and cannot be disclosed or duplicated
without the prior written consent of Genesys Telecommunications Laboratories, Inc.
Copyright 20102012 Genesys Telecommunications Laboratories, Inc. All rights reserved.
About Genesys
Genesys is the world's leading provider of customer service and contact center software - with more than 4,000
customers in 80 countries. Drawing on its more than 20 years of customer service innovation and experience,
Genesys is uniquely positioned to help companies bring their people, insights and customer channels together to
effectively drive today's customer conversation. Genesys software directs more than 100 million interactions every day,
maximizing the value of customer engagement and differentiating the experience by driving personalization and multichannel customer service - and extending customer service across the enterprise to optimize processes and the
performance of customer-facing employees. Go to www.genesyslab.com for more information.
Each product has its own documentation for online viewing at the Genesys Technical Support website or on the
Documentation Library DVD, which is available from Genesys upon request. For more information, contact your sales
representative.
Notice
Although reasonable effort is made to ensure that the information in this document is complete and accurate at the
time of release, Genesys Telecommunications Laboratories, Inc., cannot assume responsibility for any existing errors.
Changes and/or corrections to the information contained in this document may be incorporated in future versions.
Trademarks
Genesys and the Genesys logo are registered trademarks of Genesys Telecommunications Laboratories, Inc. All other
company names and logos may be trademarks or registered trademarks of their respective holders. 2012 Genesys
Telecommunications Laboratories, Inc. All rights reserved.
The Crystal monospace font is used by permission of Software Renovation Corporation,
www.SoftwareRenovation.com.
Released by
Genesys Telecommunications Laboratories, Inc. www.genesyslab.com
Document Version: 80gp_dep_slcrm_11-2012_v8.0.101.00
Table of Contents
List of
Procedures
................................................................................................................. 13
Preface
................................................................................................................. 23
About Gplus Adapter 8.0 for Siebel CRM................................................ 23
Intended Audience................................................................................... 24
Making Comments on This Document .................................................... 24
Contacting Genesys Technical Support................................................... 25
Document Change History ...................................................................... 25
New in Document Version v8.0.100.00............................................... 25
New in Document Version v8.0.002.00............................................... 25
Chapter 1
System Requirements.......................................................................... 27
Deployment Options ................................................................................ 27
Installation Options .................................................................................. 28
Universal Definition File........................................................................... 31
Before Importing the Definition File .................................................... 32
System Requirements for Gplus Adapter Components........................... 32
Gplus Communication Server Requirements ..................................... 33
Configuration Synchronization Component Requirements................. 34
Voice Component Requirements ........................................................ 35
Gplus UCS Gateway Requirements ................................................... 37
Multimedia Component Requirements ............................................... 38
Gplus Adapter Media Routing Component Requirements.................. 38
Date and Time Synchronization .............................................................. 39
Chapter 2
Table of Contents
Chapter 3
Chapter 4
Table of Contents
Chapter 5
Table of Contents
Chapter 6
Table of Contents
Chapter 7
Table of Contents
Chapter 8
Chapter 9
Table of Contents
Chapter 10
Table of Contents
Chapter 11
Chapter 12
10
Table of Contents
Appendix
Supplements
Index
............................................................................................................... 653
11
Table of Contents
12
List of Procedures
Communication Server: Importing the Communication Server
Application Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Communication Server: Creating the Communication Server
Application object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Communication Server: Configuring the tabs in the Properties
dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Communication Server: Installing the Gplus Communication Server. . . 56
Configuration Synchronization Component: Importing the
Configuration Synchronization Component Application Template . . 69
Configuration Synchronization Component: Creating the Configuration
Synchronization Component Application object . . . . . . . . . . . . . . . . 70
Configuration Synchronization Component: Configuring the tabs in the
Properties dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Configuration Synchronization Component: Creating a new Person
object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Configuration Synchronization Component: Adding a Person object
to the Super Administrators Access Group . . . . . . . . . . . . . . . . . . . 84
Configuration Synchronization Component: Associating a Person
object account with the Application object . . . . . . . . . . . . . . . . . . . . 85
Configuration Synchronization Component: Installing the Configuration
Synchronization Component in a Windows environment . . . . . . . . . 86
Configuration Synchronization Component: Installing the Configuration
Synchronization Component in a UNIX environment . . . . . . . . . . . . 87
Configuration Synchronization Component: Importing the
GenesysConfigSynchronization.sif archive file for the Configuration
Synchronization Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Configuration Synchronization Component: Checking out an existing
project from the Siebel Repository for the Configuration
Synchronization Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Configuration Synchronization Component: Exporting Siebel extensions
of type S as DNs of type Extensions or ACD Positions in Genesys . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
13
14
15
16
17
18
19
20
21
22
Preface
Welcome to the Gplus Adapter 8.0 for Siebel CRM Deployment Guide. This
document describes how to install and configure the components of the Gplus
Adapter.
This document is valid only for the 8.0 release of this product.
Note: For versions of this document that have been created for other releases
For information about related resources and about the conventions that are
used in this document, see the supplementary material starting on page 649.
23
Intended Audience
Intended Audience
This document is primarily intended for system administrators or other
individuals who install and configure the Gplus Adapter. It has been written
with the assumption that you have a basic understanding of:
Framework
Universal Routing
Outbound Contact
24
25
26
Chapter
System Requirements
This chapter outlines the minimum system and software requirements for the
Gplus Adapter 8.0 for Siebel CRM (Gplus Adapter).
Please review the system requirements before you install the Gplus Adapter.
This chapter provides information on the following topics:
Deployment Options, page 27
Installation Options, page 28
Universal Definition File, page 31
System Requirements for Gplus Adapter Components, page 32
Date and Time Synchronization, page 39
Deployment Options
If you are deploying the Gplus Adapter for the first time, Gplus Adapter
migration issues are not your concern. If your organization has already
deployed an earlier version of the Gplus Adapter, your deployment options
will vary depending on the version of the Gplus Adapter that you use. Table 1
on page 28 describes, at a very high level, where to find the appropriate
instructions for installing the Gplus Adapter 8.0 for Siebel CRM, depending on
whether your organization has a previous version of the Adapter.
Note: In the following table and throughout this document, the Voice,
27
Installation Options
Details
Comments
Follow the installation instructions that New users are those who are
are detailed in the Gplus Adapter 8.0
deploying the Gplus Adapter
for Siebel CRM Deployment Guide.
for Siebel CRM for the first
time.
Installation Options
Some of the features of this release of the Gplus Adapter 8.0 for Siebel CRM
have a dependency upon other Siebel or Genesys products, and some also
depend on other Gplus Adapter components. To use these Gplus Adapter
features, you must implement the requirements.
The standard procedure, which this document assumes you are following, is to
install all of the required external product requirements first, before you start
the installation of the Gplus Adapter.
28
Installation Options
Genesys E-mail
Genesys eServices
Expert Contact
Universal Callback
Media Routing
Outbound Campaign
Siebel Marketing
Genesys Outbound Contact Server
Communication Server
Genesys eServices
UCS Gateway
Configuration Synchronization
Genesys T-Server
Campaign Synchronization
iWD Routing
Fundamental requirements, as
listed previously
Siebel Marketing
29
Installation Options
information about some Gplus Adapter features is only available in the proper
documentation for the integrated software application that powers the feature.
Configuration
No prerequisite Gplus Adapter components.
Synchronization Component No Gplus Adapter components have
dependencies on this component. However,
Configuration Synchronization functionality is
intended for use with the Voice and Multimedia
components.
Campaign Synchronization
Component
30
Multimedia Component
including:
Genesys E-mail
Genesys Chat
Gplus_Universal
31
For more information, see Chapter 6, Deploying the Voice Component and
Chapter 8, Deploying the Multimedia Component.
32
applications, consult the Gplus Adapter for Siebel CRM chapter in the
latest Genesys Interoperability Guide.
The following is a list of the Gplus Adapter components:
Gplus Communication Server Requirements, page 33
Configuration Synchronization Component Requirements, page 34
Voice Component Requirements, page 35
Gplus UCS Gateway Requirements, page 37
Multimedia Component Requirements, page 38
Gplus Adapter Media Routing Component Requirements, page 38
256 MB of RAM
64 MB of disk space
Note: These are minimum hardware requirements. For large call centers
Software Requirements
You need the following software to deploy the Gplus Communication Server.
Genesys Applications
Consult the Gplus Adapter for Siebel CRM chapter in the Genesys
Interoperability Guide.
33
256 MB of RAM
Note: These are the minimum hardware requirements. For large call centers
Software Requirements
You need the following software to deploy the Gplus Adapter for Siebel CRM
Configuration Synchronization Component:
Siebel 7.7/7.8/8.0/8.1 Applications
Siebel Server
Siebel Tools
Genesys Applications
Framework
34
Basic Voice
Expert Contact
Outbound Campaign
Universal Callback
Most of these Voice features can be regarded as options, but to deploy any
feature of the Siebel CRM Voice Component, you must first deploy the
fundamental Basic Voice feature. The system requirements for this feature
appear in the following lists.
Siebel Server
Siebel Tools
Genesys Applications
Framework
Configuration Server
Configuration Manager
T-Server (7.2 or higher is required, if you are using the Two-Step Network
Transfer functionality)
35
Basic Voice
Genesys Applications
Siebel Marketing
Outbound Contact
36
256 MB of RAM
64 MB of disk space
Note: These are minimum hardware requirements. For large call centers
Software Requirements
You need the following software to deploy the Gplus UCS Gateway.
Genesys Applications
Framework
37
Siebel Server
Siebel Tools
Genesys Applications
Framework
Multimedia
Universal Routing
Note: For information about service packs and patches that are required by
Siebel Server
Siebel Tools
Genesys Applications
38
Multimedia
Framework
Universal Routing
As a best practice, all servers that process Genesys and Siebel data should
be synchronized to the second. This synchronization should be maintained
continuously and validated on a regular basis. For security reasons,
Genesys strongly recommends the use and deployment of Network Time
Protocol (NTP), version 4.1 or greater. The full protocol suite should be
deployed, and derivative protocols like DAYTIME, SNTP, or RDATE
should be avoided.
39
40
Manufacturer
Hardware
EndRun Technologies
http://www.endruntechnologies.com
Praecis Cntp
Datum Corporation
http://www.datum.com
Syncserver S100
True Time
http://www.truetime.com
TimeVault
TrueTime
http://www.truetime.com
NTS-200
Lantronix
http://www.lantronix.com
CoBox NTP
Chapter
Overview
Gplus Communication Server for Siebel CRM (the Adapter) reduces
in-process coupling between Genesys and Siebel code and increases the
isolation level among communication components. The result is:
41
driver-based components.
The Adapter is not compatible with the Siebel CTI parameter,
MaxCommToolbar, if the value of that parameter is more than 1. For
more details about this parameter, refer to the Siebel
documentation.
The process of configuring and installing the Adapter consists of:
1. Planning the configuration of the Adapter. See, Planning, page 42.
2. Configuring the Genesys section of the Adapter. See, Configuring
Genesys, page 43.
3. Installing Communication Server. See, Installation, page 56.
4. Deployment of the Communication Driver on a Siebel host. See,
Configuring Siebel, page 64.
5. Configuring Siebel. See, Configuring Siebel, page 64.
Release 8.0.0
Support for the Red Hat Enterprise Linux (RHEL) operating system.
Planning
In planning, you must first answer the following question:
Will the Adapter be deployed on the same host as the Siebel Server, or will it
be deployed on a different host?
42
Configuring Genesys
Configuring Genesys
This section describes how to configure the Genesys section of the Gplus
Communication Server.
43
Configuring Genesys
Recommendations
Genesys recommends using an Application Template when you are
configuring your Adapter. The Application Template for your Adapter contains
the most important configuration options set to the values recommended for
the majority of environments. When modifying configuration options for your
Adapter later in the process, you can change the values inherited from the
template rather than create all the options by yourself.
Procedure:
Communication Server: Importing the Communication
Server Application Template
Purpose: To import the Communication Server Application Template.
Start of procedure
1. In Configuration Manager, under Environment, right-click the Application
Templates folder.
2. Select Import Application Template.
3. Browse to and select the Application Template for the Communication
Server. Depending on the version that you are using, the name of this
template is:
Release 8.0.0: Gplus_Comm_Server_for_SiebelCRM_800.apd
Release 8.0.1: Gplus_Comm_Server_for_SiebelCRM_801.apd
4. Click Open.
The Properties dialog box for the Application Template displays.
5. Optional: Edit the Application Template name.
6. Click OK to accept the default values.
44
Configuring Genesys
Procedure:
Communication Server: Creating the Communication
Server Application object
Purpose: To create the Application object for the Communication Server.
Start of procedure
1. In Configuration Manager, under Environment, right-click the Application
Templates folder.
2. Select New > Application.
3. Select the Application Template that you just created, depending on the
version that you are using:
Release 8.0.0: Gplus_Comm_Server_for_SiebelCRM_800.apd
Release 8.0.1: Gplus_Comm_Server_for_SiebelCRM_801.apd
4. Click OK.The Properties dialog box for the Application object appears.
End of procedure
Next Steps
Configure the tabs in the Properties dialog box for the Communication
Server. See, Procedure: Communication Server: Configuring the tabs in the
Properties dialog box, on page 46.
45
Configuring Genesys
Procedure:
Communication Server: Configuring the tabs in the
Properties dialog box
Purpose: To configure the tabs in the Properties dialog box for the
Communication Server.
Start of procedure
General Tab
1. Click the General tab in the Properties dialog box. See Figure 1.
2. In the Name list, click the name of the Application object you are
configuring.
46
Configuring Genesys
3. In the Template list, click the name of the template you are configuring or
use the Browse button to select the template you are configuring.
4. Click Apply.
5. Next, if you are working in a multi-tenant environment, go to the Tenants
Tab; otherwise, go to the Server Info Tab.
Note: The Tenants tab only displays, if you are working in multi-tenant
environment.
Tenants Tab
6. Select the Tenants tab in the Properties dialog box. See Figure 2 on
page 47.
7. Click Add.
8. Select the Genesys Tenants under which the objects that are exported from
Siebel are created. For example, in Figure 2 above, the MCR tenant has been
added.
Server Info Tab
47
Configuring Genesys
10. In the Host field, use the Browse button to select the host where you are
installing the Gplus Communication Server and click OK.
11. In the Communications Port field, enter any valid port number for the port
with the ID of default. Genesys recommends setting this to 18001, since
this corresponds to the value provided by the installation sample
configuration file for Siebel (the *.def file).
Note: This value determines the HTTP port number used by the Gplus
12. Select the Start Info tab in the Properties dialog box.
13. In the Working Directory field, enter the full name of the Component
installation directory on the host you specified on the Server Info tab. The
value you enter in this field is used as the default destination folder during
installation.
14. Enter any valid value into each of the following fields:
Command Line
Command Line Arguments
The values you enter in these fields are overwritten during installation;
however, the data must be present in these fields during the configuration
process.
15. Leave the default values for the remaining fields.
Connections Tab
48
Configuring Genesys
Options Tab
49
Configuring Genesys
50
Configuring Genesys
Next Steps
Set the configuration options for the Communication Server. See the
section, Setting the Genesys Configuration Options for the
Communication Server on page 51.
Log Section
The Gplus Communication Server supports the unified set of log options
(common log options) to allow precise configuration of the log file output. For
a complete list of unified log options and their descriptions, see the Common
Log Options chapter of the Framework Configuration Options Reference
Manual.
Selective
Protection of
Sensitive Data in
Logs
51
Configuring Genesys
The Log-Filter-Data section defines a list of key-value pairs and specifies the
way of presenting each individual KVList pair defined by the key name in the
log. The key defines the parameter name, while the value (which can be
defined as copy, hide, or skip) specifies how this parameter is presented in the
logfor example, see Figure 6 on page 53.
52
Configuring Genesys
open-media-driver Section
The open-media-driver section has various options that can be configured.
The following section describes the possible options:
internal-port
Default Value: -1
Valid Value: Any positive integer that defines the exact port value
Defines the port number that is used for interthread communications. If the
value of this configuration option is set to -1, this option is disabled. If the
value of this configuration option is set to 0, the port is selected automatically.
on-connect-delay
Default Value: 0
Valid Value: 10000 (10 seconds)
Determines the delay, measured in milliseconds (ms), between connecting to
Interaction Server and registering the first client. This delay is used to allow
53
Configuring Genesys
service-duplicate-overwrite
Default Value: false
Valid Values: true, false
If the value of this option is set to true, subsequent agent sessions with the
same user name are allowed, and the previous agent session are disabled. If the
value of this option is set to false, only one session per agent is allowed. This
option is needed as a workaround when a session is not closed by Siebel, but
when the browser is forcibly closed.
open-media-userdata Section
The open-media-userdata section has the following option that can be
configured:
ThirdPartyId
Default Value: top
Defines how particular user data is sent to Siebel. All data is normally sent
encoded as a single UserData field. It may be convenient to have part of the
user data delivered to Siebel as a top-level key. The user-data key should be
added to the section with the value of top, indicating that the key will be sent
as a top-level key in the data set.
Settings Section
The Settings section has various options that can be configured. The
following section describes the possible options:
ProcessingThreadPoolSize
Default Value: 30
Valid Value: Any positive integers that are greater than or equal to (>=) 4
Provides the value for the maximum number of threads that process tasks per
pool. The following two thread pools are present:
1. The first thread is used for processing incoming requests.
2. The second thread is used for processing responses on outgoing requests.
54
Configuring Genesys
RequestTimeout
Default Value: 30000
Valid Value: Any positive integer that is greater than (>) or equal to (=) 2000.
Provides the timeout value in milliseconds (ms) for handling a request that is
submitted by the Communication Server to the Communication Driver.
ServiceInactivityTimeout
Default Value: 3600000
Valid Value: 0, or any positive integers greater than or equal (>=) 600000. If
ServiceInactivityTimeout equals 0, the lost sessions are removed.
(Optional) Provides the timeout value in milliseconds (ms) for handling an
inactive agent session. If there is no agent activity during the period of the
timeout, the agent's session is treated as lost, and is removed.
Universal Section
The universal section has various options that can be configured. The
following section describes the possible options:
preview-media-type
Default value: outboundpreview
Valid Values: Any non-empty string containing media type for push preview
media.
Defines the media type for push preview media. If the value of the option is
different from the default value (outboundpreview), you must change it before
compiling the *.srf file. In the MCR Session Manager Business Service,
change the following Business Service User Properties value:
OpenMediaReadyCommand_outboundpreview to the following new value:
OpenMediaReadyCommand_<new value>.
preview-park-view
Default value: Empty string
Valid Values: Empty string or name of the view (For more information about
the view name, see the Universal Routing Server documentation.)
Defines the view that is used to transfer push preview interactions. If the value
of this option is an empty string, the transfer of push preview interactions is
performed without the use of the special intermediate queue that goes directly
to the agent.
Note: For the sample strategy (Park Queue Restore) of the park view/queue,
55
Installation
Voice Section
The Voice section has the following option that can be configured:
CheckDNStateOnLogin
Default value: false
Valid Values: TRUE, true, True, FALSE, false, False
Determines whether or not the checking of the DN state is enabled upon agent
login. If the checking of the DN state is enabled, the agent login is rejected, if
that DN is already registered.
Installation
This section describes the installation process for the Gplus Adapter 8.0
Communication Server for Siebel CRM and consists of the following steps:
Installing the Gplus Communication Server, page 56
Configuring the GenCommDrv.ini File (Optional), page 57
For further information about your deployment options, see the section
Planning on page 42.
Procedure:
Communication Server: Installing the Gplus
Communication Server
Purpose: To install the Gplus Communication Server.
56
Installation
Start of procedure
Starting the
Communication
Server Installation
Process
Deploying the
Gplus
Communication
Driver on the
Siebel Host
1. To start the installation process, run the setup.exe file (for Windows), or
install.sh file (for UNIX) from the Gplus Communication Server
installation package.
2. Answer the installation questions according to your selected deployment
scenario.
3. Stop the Siebel Server.
4. Move the files from the Gplus Communication Driver subdirectory of the
target installation directory on the dedicated host to the bin folder (for
Windows), or to the lib folder (for UNIX) in the Siebel directory hierarchy
of the Siebel host.
End of procedure
Next Steps
Configure the GenCommDrv.ini file. This step is optional. See the section,
Configuring the GenCommDrv.ini File (Optional).
57
Installation
Values
Description
General section
CheckServiceTimeout
ClientConnectionsPer
Server
Default Value: 1
Valid Value: An
integer that is greater
than or equal to (>=) 1.
Note: If an invalid
value is applied, the
default value (1) is
used.
NoDataDelay
Note: If an invalid
value is applied, the
default value (200) is
used.
ProcessingThreadPool
Size
Default Value: 30
Valid Value: An
integer that is greater
than or equal to (>=) 4
Note: If an invalid
value is applied, the
default value (30) is
used.
58
Installation
Values
Description
Note: If an invalid
value is applied, the
value is calculated as
defined for the valid
value (it will not be set
as the default value).
SiebelAPI
Default Value: 2
Valid Values: 1, 2
Note: If an invalid
value is applied, the
default value (2) is
used.
Log Subsystem section
LogDir
Default Value: ./
Valid Values: A valid
and accessible
directory path.
Note:
If an empty string is
applied, then the
default (./) is used.
If an invalid directory
path is provided or is
not accessible, then the
file is not created.
59
Installation
Values
Default Value: log
Valid Value: A
non-empty string.
Description
(Optional) This property provides the GenCommDrv
log file name extension.
Note: If an invalid
value is applied, the
default value (log) is
used.
LogFile
Default Value:
GenCommDrv
Default Value: 10
Valid Value: A
positive integer that is
greater than or equal to
(>=) 2
Note: If an invalid
value is applied, the
default value (10) is
used.
LogLevel
60
Installation
Values
Default Value: 10240
Valid Value: A
positive integer that is
greater than or equal to
(>=) 100.
Description
(Optional) This property provides the maximum
GenCommDrv log file size in kilobytes.
Note: If an invalid
value is applied, the
default value (10240)
is used.
HTTP Client Connection section
Default Value: 0
ClientPortRangeStart
ConnectTimeout
Note: If an invalid
value is applied, the
default value (10000)
is used.
61
Installation
Values
Description
Default Value: 1
Certificate
Valid Value:
For Windows this
should be a base 64 or
hex encoded string.
62
Installation
Values
Default Value: (an
empty string)
Description
(Optional) This property identifies the Certificate
Key to be used.
Valid Value:
For Windows, this
property is not used.
Therefore, no valid
values are defined.
(see T-Server
Connections on
page 257 in
Chapter 6).
TrustedCA
(see T-Server
Connections on
page 257 in
Chapter 6). Default
value is (empty
string).
= 2
63
CheckServiceTimeout
= 60000
ProcessingThreadPoolSize
= 30
Configuring Siebel
ClientConnectionsPerServer = 1
NoDataDelay
= 200
RequestTimeout
= 30000
= GenCommDrv
LogDir
= ./
LogExt
= log
MaxLogKB
= 10240
LogFilesCount
= 10
LogLevel
= 2
= 1
ConnectTimeout
= 10000
ClientPortRangeStart = 0
// Security properties of HTTP connection
// (used when https is configured in
PrimaryGenCommServerURL/BackupGenCommServerURL URLs)
Certificate
= ""
CertificateKey
= ""
TrustedCA
= ""
Configuring Siebel
This section describes how to configure the Siebel part of the Gplus
Communication Server for Siebel CRM.
64
Configuring Siebel
PrimaryGenCommServerURL
This parameter should specify the URL of the Gplus Communication Server.
For example:
PrimaryGenCommServerURL=http://cti.mycompany.com:9121
65
66
Configuring Siebel
Chapter
Deploying the
Configuration
Synchronization
Component
This chapter describes how to configure and install the Gplus Adapter for
Siebel CRM Configuration Synchronization Component (the Adapter), which
is a server-based component.
This chapter includes the following sections:
Overview, page 67
New in This Release, page 68
Configuring Genesys, page 68
Configuring the Security Settings, page 83
Installation, page 86
Configuring Siebel, page 89
Business ServiceUser Properties, page 100
Starting the Adapter, page 103
Overview
The Gplus Adapter for Siebel CRM Configuration Synchronization
Component (the Adapter) is a server-based component. The process for
configuring and installing this component is significantly different than the
process for driver-based components.
The process of configuring and installing the Adapter includes three general
procedures:
Configuring Genesys
67
Configuring Siebel
Before importing agent configuration data from Siebel to Genesys, see the
Gplus Adapter 8.0 for Siebel CRM Users Guide and read the section
Synchronizing Siebel Extensions and ACD Queues with Genesys
Configuration.
Release 8.0.0
Support for the Red Hat Enterprise Linux (RHEL) operating system.
Configuring Genesys
This section describes how to configure the Genesys section of the
Configuration Synchronization Component.
Configuring the Genesys section of the Configuration Synchronization
Component consists of the following sections:
Prestart Information, page 68
Importing the Configuration Synchronization Component Application
Template, page 69
Creating the Configuration Synchronization Component Application
Object, page 70
Configuring the Tabs in the Properties Dialog Box, page 71
Setting the Genesys Configuration Options for the Configuration
Synchronization Component, page 75
Prestart Information
Before starting the configuration process you should have the following
Genesys Framework applications running:
68
Configuration Database
Configuration Server
Configuration Manager
Configuring Genesys
Recommendations
Genesys recommends using an Application Template when you are
configuring your Adapter. The Application Template for your Adapter contains
the most important configuration options set to the values recommended for
the majority of environments. When modifying configuration options for your
Adapter later in the process, you can change the values inherited from the
template rather than create all the options by yourself.
Procedure:
Configuration Synchronization Component: Importing
the Configuration Synchronization Component
Application Template
Purpose: To import the Configuration Synchronization Component
Application Template.
Start of procedure
1. In Configuration Manager, under Environment, right-click the Application
Templates folder.
2. Select Import Application Template.
3. Browse to and select the Application Template for the Configuration
Synchronization Component. Depending on the version of Configuration
Manager that you use, this name varies slightly, as follows:
For versions 7.0 and earlier, use the following:
Release 8.0.0:
Gplus_SiebelCRM_Config_Synch_800_for_CL_70.apd
Release 8.0.1:
Gplus_SiebelCRM_Config_Synch_801_for_CL_70.apd
69
Configuring Genesys
Release 8.0.1:
Gplus_SiebelCRM_Config_Synch_801_for_CL_71_and_higher.apd
4. Click Open.
The Properties dialog box for the Application Template object displays.
5. Click OK to accept the default values.
The Application Template object has been imported to the Genesys
Configuration Layer.
End of procedure
Next Steps
Procedure:
Configuration Synchronization Component: Creating
the Configuration Synchronization Component
Application object
Purpose: To create the Application object for the Configuration
Synchronization Component.
Start of procedure
1. In Configuration Manager, under Environment, right-click the Applications
folder.
2. Select New > Application.
Select the Application template that you just created:
Release 8.0.0:
Gplus_SiebelCRM_Config_Synch_800_for_CL_71_and_higher.apd
70
Configuring Genesys
Release 8.0.1:
Gplus_SiebelCRM_Config_Synch_801_for_CL_71_and_higher.apd
or
Release 8.0.0: Gplus_SiebelCRM_Config_Synch_800_for_CL_70.apd
Release 8.0.1: Gplus_SiebelCRM_Config_Synch_801_for_CL_70.apd
3. Click OK.
The Properties dialog box for the Application object appears.
End of procedure
Next Steps
Configure the tabs in the Properties dialog box for the Configuration
Synchronization Component. See, Procedure: Configuration
Synchronization Component: Configuring the tabs in the Properties dialog
box, on page 71.
Procedure:
Configuration Synchronization Component:
Configuring the tabs in the Properties dialog box
Purpose: To configure the tabs in the Properties dialog box for the
Configuration Synchronization Component.
Start of procedure
General Tab
1. Click the General tab in the Properties dialog box (see Figure 7 on
page 72).
71
Configuring Genesys
2. In the Name list, click the name of the Application object that you are
configuring.
3. In the Template list, click the name of the template that you are configuring
or use the Browse button to select the template that you are configuring.
4. Click Apply.
5. Next, if you are working in a multi-tenant environment, go to the Tenants
Tab; otherwise, go to the Server Info Tab.
Note: The Tenants tab only displays, if you are working in a multi-tenant
environment.
Tenants Tab
72
Configuring Genesys
11. In the Port list, add a port with any valid port number.
Note: This option determines the HTTP port number that is used by the
Options Tab
73
Configuring Genesys
74
Configuring Genesys
Next Steps
AgentLoginFolders Section
Each option in the AgentLoginFolders section controls the mapping of a Siebel
User ID to a Configuration Manager folder, where the Siebel user utilizes this
User ID to create an Agent Login object when importing the information from
Siebel.
Example:
AgentLogin
Folders Option
You want the Siebel user with a User ID of user1, to create an Agent
Login object under the Configuration Manager folder, Folder1, which is a
subfolder of the Agent Logins folder under the switch, mySwitch.
Then create a new option in the AgentLoginFolders section with user1 as the
option name and /Agent Logins/Folder1 as the option value.
75
Configuring Genesys
DNFolders Section
Each option in the DNFolders section controls the mapping of a Siebel User ID
to a Configuration Manager folder, where the Siebel user with this User ID
creates a DN object when importing information from Siebel.
Example:
DNFolders Option
You want the Siebel user with the User ID of user1, to create a DN object
under the Configuration Manager folder, Folder1, which is a subfolder of
the DNs folder under the switch, mySwitch.
Then create a new option in the DNFolders section with user1 as the option
name and /DNs/Folder1 as the option value.
All Configuration Manager folders referenced in this section should be created
in Genesys Configuration Manager prior to importing information from Siebel.
76
Configuring Genesys
The ratio of Siebel User IDs to Genesys Configuration Manager folders in this
section is many-to-one.
Note: You can configure the import function, using options in this section to
Genesys Section
The Genesys section has various options that can be configured. The following
section describes the possible options.
password
Default Value: none
Valid Value: none
Specifies the password for the login user name above, for example
GenesysAdapter. This user name should be created in the Siebel environment.
The user must have access to the Siebel database as a Siebel Administrator. For
more information about Siebel user administration, see your Siebel
documentation.
Note: Genesys does not recommend using a common login for this process.
ServerURL
Default Value: none
Valid Value: none
Specifies the URL of the web server that has the Siebel Web Engine installed.
Initially, this option contains the following template string:
ServerURL=<ServerUrl>/<path>/start.swe
where:
<ServerUrl>:
is the first part of the URL that you use to access your Siebel
Server through the Siebel Web Client.
<path>:
77
Configuring Genesys
You must edit this URL template string according to your Siebel Web
Extension configurationfor example:
http://www.myserver.com/eai_enu/start.swe
SkipSkillItemTypeName
Default Value: false
Valid Value: false, true
Specifies how skill names are generated, and specifically if Skill Item Type
names (Skill names) are written or not. By default, this value is set to false,
which means that the Skill Item Type names (Skill names) are written in
Genesys Configuration Manager during synchronization. If you need to omit
Skill Item Type names (Skill names), set the value of this option to true.
SWEExtSource
Default Value: GplusConfSynchExportAlldata
Valid Value: Any valid string value
Refers to an entry in the [HTTP Services] section of the eai.cfg file found
within your Siebel Server installation. This entry provides the mapping to a
Siebel Named Subsystem record, which in turn describes the Business Service
call.
username
Default Value: <required>
Valid Value: A valid username created in a Siebel environment
Specifies a Siebel user name for the Siebel Object Manager login to process a
request from the Adapter, for exampleGenesysAdapter.
This user name must be created in the Siebel environment. The user must have
access to the Siebel database as Siebel Administrator.
Note: Genesys does not recommend using a common login ID for this
process.
For more information about Siebel user administration, refer to your Siebel
documentation.
UseSeparatorsForSkillName
Default Value: false, true
Valid Value: false, true
Specifies how skill names are generated, and specifically how the names are
separated. By default, this value is set to false, signifying that separators are
not used. If you need to generate skill names as they were in version 6.5, set
the value of this option to true.
78
Configuring Genesys
xslTransformer (optional)
Default Value: <optional>
Valid Value: none
This configuration option is optional. Use this option, if you want to customize
the values of the synchronized data, such as Phone number, using your own
rules.
The Adapter provides a mechanism to customize the transformation rules
through an *.xsl file. In this case, you must add this option to the Genesys
section. The value of this option should be equal to the name of the.xsl file.
See the Gplus Adapter 8.0 for Siebel CRM Developers Guide for more
information about this option.
Log Section
The Configuration Synchronization Component supports a common set of Log
options to allow the precise configuration of the log file output. For a complete
list of Common Log options and their descriptions, see the Common Log
Options chapter of the Framework 8.0 Configuration Options Reference
Manual.
Note: If you do not specify any log options, the default values apply.
PersonFolders Section
Each option in the PersonFolders section controls the mapping of a Siebel User
ID to a Configuration Manager folder, where the Siebel user with this User ID
create a Person object when importing information from Siebel.
Example:
PersonFolders
Option
You want the Siebel user with the User ID of user1, to create a Person
object under the Configuration Manager folder, Folder1, which is a
subfolder of the Persons folder under the Tenant, myTenant.
Then create a new option in the PersonFolders section with user1 as the option
name and /Persons/Folder1 as the option value.
Make sure that the Siebel Organization or Division whose objects Siebel user
user1 will import is mapped to the Tenant, myTenant (see Tenants Section on
page 83).
All Configuration Manager folders referenced in this section should be created
in Genesys Configuration Manager prior to importing information from Siebel.
79
Configuring Genesys
The ratio of Siebel User IDs to Genesys Configuration Manager folders in this
section is many-to-one.
Note: You can configure the import function using the options in this
PlaceFolders Section
Each option in the PlaceFolders section controls the mapping of a Siebel User
ID to a Configuration Manager folder, where the Siebel user with this User ID
will create Place objects when importing information from Siebel.
Example:
PlaceFolders
Option
You want the Siebel user with the User ID of user1, to create a Place
object under the Configuration Manager folder, Folder1, which is a
subfolder of the Persons folder under the Tenant, myTenant.
Then create a new option in the PlaceFolders section with user1 as the option
name and /Places/Folder1 as the option value.
Make sure that the Siebel Organization or Division whose objects the Siebel
user user1 will import is mapped to the Tenant, myTenant (see Tenants
Section on page 83).
All Configuration Manager folders referenced in this section should be created
in the Genesys Configuration Manager prior to importing information from
Siebel.
80
Configuring Genesys
The ratio of Siebel User IDs to Genesys Configuration Manager folders in this
section is many-to-one.
Note: You can configure the import function, using the options in this
SkillFolders Section
Note: If the SkillFolders Application option contains an incorrect value
(for examplea folder which does not exist), the Person, even without
any skill, will not be exported from Siebel to Genesys.
Each option in the SkillFolders section controls the mapping of a Siebel User
ID to a Configuration Manager folder, where the Siebel user with this User ID
will create a Skill object when importing information from Siebel.
Example:
SkillFoldersOption
You want the Siebel user with the User ID of user1, to create a Skill
object under the Configuration Manager folder, Folder1, which is a
subfolder of the Skills folder under the Tenant, myTenant.
Then create a new option in the SkillFolders section with user1 as the option
name and /Skills/Folder1 as the option value.
Make sure that the Siebel Organization or Division whose objects Siebel user
user1 will import is mapped to the Tenant, myTenant (see Tenants Section on
page 83).
All Configuration Manager folders referenced in this section should be created
in Genesys Configuration Manager prior to importing information from Siebel.
81
Configuring Genesys
The ratio of Siebel User IDs to Genesys Configuration Manager folders in this
section is many-to-one.
Note: You can configure the import function, using the options in this
SkillLevels Section
Each option in the SkillLevels section define the mapping of Siebel Skill
Expertise values to Genesys Skill Level values. To map a Siebel Skill
Expertise value to a Genesys Skill Level value, create a new option within this
section, where the option name is the value of the Siebel Skill Expertise and
the option value is the value of the Genesys Skill Level. The default mapping
is shown in Figure 9.
82
Tenants Section
Options in the Tenants section define the mapping of Siebel Organizations or
Divisions to Genesys Tenants. To map a Siebel Organization or Division to a
Genesys Tenant, create a new option within this section, where the option
name is the name of the Genesys Tenant and the option value is the name of
the Siebel Organization or Division.
Example:
TenantsOption
contains one option, where the option name is Resources and the
option value is the name of your Siebel Organization or Division.
Saving the
Application Object
After setting the Application options, click OK to save the Application object.
Procedure:
Configuration Synchronization Component: Creating a
new Person object
Purpose: To add a new Person object to the environment.
83
Start of procedure
1. In Configuration Manager:
Right-click the Persons folder under Environment, if you are working in
a multi-tenant environment.
Right-click the Persons folder under Resources, if you are working in a
single-tenant environment.
2. Select New > Person.
The new Person window displays.
3. Select the General tab and enter the following parameters:
Employee ID = siebel7gplus
User Name = siebel7gplus
Is Agent = Clear
4. Click OK.
End of procedure
Next Steps
Procedure:
Configuration Synchronization Component: Adding a
Person object to the Super Administrators Access
Group
Purpose: To add a Person object to the Super Administrators Access Group.
Start of procedure
1. In Configuration Manager, to display the existing Access Groups:
Right-click the Access Groups folder under Environment, if you are
working in a multi-tenant environment.
Right-click the Access Groups folder under Resources, if you are
working in a single-tenant environment.
2. Double-click the Super Administrators Access Group to display its
properties.
3. Click the Add button to add the Person object that you just created to the
Users list.
84
4. Click OK.
End of procedure
Next Steps
Associate the newly created Person object account with the Application
object. See, Procedure: Configuration Synchronization Component:
Associating a Person object account with the Application object.
Procedure:
Configuration Synchronization Component:
Associating a Person object account with the
Application object
Purpose: To associate a Person object account with the Application object.
Start of procedure
In Configuration Manager, under Environment:
1. Click the Applications folder to display the existing applications.
2. Double-click the Application object that you just created to display its
properties.
3. Select the Security tab, in the Log On As section, and select This Account.
The Add User window displays.
4. Select the Person account that you just created and click Add.
5. Click OK to close the Add User window.
6. Click OK to save the Application object.
This completes the Genesys part of the configuration process. Now you are
ready to install the Configuration Synchronization Component.
End of procedure
Next Steps
85
Installation
Installation
This section describes the installation process for the Gplus Adapter 8.0 for the
Siebel CRM Configuration Synchronization Component. Select one of the
following sections, depending on your environment:
Installing the Configuration Synchronization Component in a Windows
Environment, page 86
Installing the Configuration Synchronization Component in an UNIX
Environment, page 87
Procedure:
Configuration Synchronization Component: Installing
the Configuration Synchronization Component in a
Windows environment
Purpose: To install the Configuration Synchronization Component on a
Windows operating system.
Start of procedure
1. To start the installation process, run the setup.exe file from the
Configuration Synchronization Component installation package.
2. In the Welcome window, click Next.
3. In the Configuration Parameters for the Genesys Configuration Server
window, enter the following:
The name of the host on which Configuration Server is running.
The communication port that client applications must use to connect to
Configuration Server.
The user name used to access Configuration Server.
The password used to access Configuration Server.
4. Click Next.
5. In the Select Application window, select the Application object by its
corresponding number that you configured in the previous procedure,
Procedure: Configuration Synchronization Component: Creating the
Configuration Synchronization Component Application object, on page 70.
86
Installation
6. Click Next.
7. In the Choose Destination Location window, click Next to accept the
default destination folder or use the Browse button to select a different
destination folder.
Note: If you want to deploy both the Configuration Synchronization
Procedure:
Configuration Synchronization Component: Installing
the Configuration Synchronization Component in a
UNIX environment
Purpose: To install the Configuration Synchronization Component on an
UNIX system.
87
Installation
Start of procedure
1. In the directory in which the Configuration Synchronization Component
installation package was copied, locate a shell script named: install.sh.
2. Run this script from the command prompt by typing sh and the file name:
sh install.sh
3. When prompted, specify the host name, port, user name, and password of
the computer on which the Component will be installedfor example:
a. Enter the host name of Configuration Server.
b. Enter the port of Configuration Server.
c. Enter the user name for Configuration Server.
d. Enter the password for the user name.
4. Choose the Configuration Server environment by its corresponding
number.
5. Specify the Application object you configured in the previous procedure,
Procedure: Configuration Synchronization Component: Creating the
Configuration Synchronization Component Application object, on page 70.
6. Specify the full path to the destination directory in which you want the
Component to be installed.
Note: If you want to deploy both the Configuration Synchronization
88
Configuring Siebel
Configuring Siebel
This section describes how to configure the Siebel part of the Configuration
Synchronization Component for Siebel CRM.
Configuring the Siebel section of the Configuration Synchronization
Component consists of the following sections:
Prestart Information, page 89
Configuring Siebel Using Siebel Tools, page 89
Configuring the Siebel Server, page 95
Configuring Siebel Using the Siebel Web Client, page 95
Prestart Information
Before starting this part of the configuration process, you must make sure to do
the following:
You should be connected to the local copy of the Siebel Server database.
89
Configuring Siebel
Procedure:
Configuration Synchronization Component: Importing
the GenesysConfigSynchronization.sif archive file for
the Configuration Synchronization Component
Purpose: To import the GenesysConfigSynchronization.sif archive file for the
Configuration Synchronization Component.
Start of procedure
1. In Siebel Tools, select Tools > Import from Archive... .
2. In the Select Archive to Import window, navigate to the
GenesysConfigSynchronization.sif archive file. This file was created by
the installation program in: <target directory>/XXX/tools/objects where
XXX is the subfolder name (7.7, /8.0, or /8.1), depending on the Siebel
version that you use.
3. Click Open.
The Import WizardPreview window displays.
4. In the Import WizardPreview window, in the Conflict Resolution section,
select Overwrite the object definition in the repository.
5. Click Next.
The Import WizardReview Conflicts and Actions window displays.
6. Click Next.
The Do you wish to proceed? window displays.
7. Click Yes.
The objects from the archive are imported into the Siebel repository.
90
Configuring Siebel
Siebel environment after importing the archive. This does not affect
the functionality of the Configuration Synchronization Component in
any way.
End of procedure
Next Steps
Procedure:
Configuration Synchronization Component: Checking
out an existing project from the Siebel Repository for
the Configuration Synchronization Component
Purpose: To check out an existing project from the Siebel repository.
Start of procedure
1. In Siebel Tools, select Tools > Check Out...
The Check Out dialog box displays.
2. Select Project category.
3. In the Projects list, select the Personalizations project.
4. Click Check Out.
End of procedure
91
Configuring Siebel
Next Steps
Procedure:
Configuration Synchronization Component: Exporting
Siebel extensions of type S as DNs of type Extensions
or ACD Positions in Genesys
Purpose: To set up the export of Siebel extensions of type S as DNs of type
Extensions in Genesys.
Start of procedure
1. In Siebel Tools, navigate to Object Explorer \ Business Service
folder/applet.
2. Select <Genesys Config Synchronization> Business Service.
3. For this Business Service, go to the Business Service User Props applet.
4. Select the record with Name <ConvertExt2ACD>.
5. Instead of True (default), set False as a value for this record.
End of procedure
Next Steps
92
Configuring Siebel
Procedure:
Configuration Synchronization Component: Importing
the PersonalizationActionSet.sif archive file into the
Siebel Repository
Purpose: To import the PersonalizationActionSet.sif archive file into the
Siebel repository.
Start of procedure
1. In Siebel Tools, select Tools > Import from Archive... .
2. In the Select Archive to Import window, navigate to the
PersonalizationActionSet.sif archive file. This file was created by the
installation program in: <target directory>/XXX/tools/objects where XXX
is the subfolder name (7.7, /8.0, or /8.1), depending on the Siebel
version that you use.
3. Click Open.
The Import WizardPreview window displays.
4. In the Import WizardPreview window, in the Conflict resolution section,
select Merge the object definition from the archive file with the
definition in the repository.
5. Click Next.
The Do you wish to proceed? window displays.
6. Click Yes.
The objects from the archive are imported into the Siebel repository.
7. Click Finish to complete the Import Wizard.
Note: It is possible for siebel_assert_xxx.txt file(s) to be generated by the
Siebel environment after importing the archive. This does not affect
the functionality of the Component in any way.
End of procedure
93
Configuring Siebel
Next Steps
Procedure:
Configuration Synchronization Component: Compiling
the Siebel Repository File
Purpose: To compile the Siebel repository File.
Start of procedure
1. In Siebel Tools, select Tools > Compile Projects...
2. Select Locked projects.
3. In the Siebel Repository File edit box, enter the name of the repository
file.
4. Click Compile.
The status bar at the bottom of the Object Compiler window indicates
when the compilation is finished.
5. When the compilation is finished, close Siebel Tools.
Note: It is possible for siebel_assert_xxx.txt file(s) to be generated by the
94
Configuring Siebel
Procedure:
Configuration Synchronization Component:
Configuring the Siebel Server
Purpose: To configure the Siebel Server to work with the Configuration
Synchronization Component.
Start of procedure
Updating the
Configuration
Files
1. To update the eai.cfg file in the Siebel Server installation, open the file
and add the following line to the [HTTP Services] section:
GplusConfSynchExportAllData = GplusConfSynchExportAllData.
Configuring the
Siebel Inbound
HTTP Transport
Deploying the
Siebel Repository
File
Configure Siebel using the Siebel Web Client. See the section,
Configuring Siebel Using the Siebel Web Client.
95
Configuring Siebel
Procedure:
Configuration Synchronization Component: Checking
the EAI Server Component Group status
Purpose: To check the status of the EAI Server Component Group on your
Siebel Server.
Start of procedure
1. Navigate through the Site Map to get to the desired applet:
In Siebel 7.7/7.8/8.0/8.1 environments, select Site Map >
Administration - Server Configuration > Component Groups.
2. Select the Siebel Server on which you are working. For the selected server,
locate the Enterprise Application Integration Component Group in the
Server Component Groups applet. Verify that the value for the Enable State
group is Enabled.
End of procedure
Next Steps
96
Configuring Siebel
Procedure:
Configuration Synchronization Component:
Navigating to the Siebel Server configuration
Purpose: To navigate through the site map to get to your Siebel Server
configuration.
Start of procedure
1. Navigate through the site map to get to your Siebel Server configuration:
In Siebel 7.7/7.8/8.0/8.1 environments, select Site Map >
Administration - Server Configuration.
2. Select Profile Configuration in the applet within the view.
3. Complete the process by completing the procedures that follow.
End of procedure
Next Steps
Procedure:
Configuration Synchronization Component: Creating
the EAI Transport Data Handling subsystem
Purpose: To create a EAI Transport Data Handling subsystem.
Start of procedure
1. In the Profile Configuration applet, create a new record.
2. Specify the following parameters for the new record:
Alias in Siebel 7.7/7.8/8.0/8.1: GplusConfSynchExportAllData
Description: Gplus Configuration Synchronization Component:
ExportAllData
97
Configuring Siebel
DispatchMethod: ExportAllData
DispatchService: Genesys Config Synchronization
End of procedure
Next Steps
Procedure:
Configuration Synchronization Component: Creating a
connection subsystem
Purpose: To create and configure one connection subsystem that is used by the
Configuration Synchronization Component.
Start of procedure
Creating a
Connection
Subsystem
98
Configuring Siebel
Procedure:
Configuration Synchronization Component: Creating
the runtime events
Purpose: To create the runtime events that are required by the Campaign
Synchronization Component.
99
Default Value
true
DefaultAgentLoginOverride
100
Comments
Empty string
DefaultAgentLoginState
DefaultAgentLoginSwitchSpecific
Type
DefaultAgentLoginUseOverride
DefaultAgentLoginWrapupTime
CfgObjectState
(1 = Enabled)
CfgFlag
(2 = true)
Default Value
Comments
DefaultDnAssociation
Empty string
DefaultDnLoginID
Empty string
DefaultDnNumberOfTrunks
DefaultDnOverride
Empty string
DefaultDnRegisterAll
CfgDNRegisterFlag
(2 = true)
DefaultDnRouteType
CfgRouteType
(1 = Default)
DefaultDnState
CfgObjectState
(1 = Enabled)
DefaultDnSwitchSpecificType
DefaultDnUseOverride
GplusConfSync
Connection
Primary
GplusConfSync
Connection
Backup
Library Name
GenCommDrv
CfgFlag
(2 = true)
Data-Type Definitions
The following are definitions of data types that are used in Table 6:
CfgObjectState
CfgDNRegisterFlag
CfgRouteType
CfgObjectState
0 - No Object State/CFGNoObjectState
1 - Enabled/CFGEnabled
2 - Disabled/CFGDisabled
101
3 - Deleted/CFGDeleted
CfgDNRegisterFlag
0
1
2
3
Unknown/CFGDRUnknown
False/CFGDRFalse
True/CFGDRTrue
OnDemand/CFGDROnDemand
CfgRouteType
0 - Unknown/CFGNoRoute
1 - Default/CFGDefault
2 - Label/CFGLabel
3 - Overwrite DNIS /CFGOverwriteDNIS
4 - DDD/CFGDDD
5 - IDDD/CFGIDDD
6 - Direct/CFGDirect
7 - Reject/CFGReject
8 - Announcement/CFGAnnouncement
9 - Post feature/CFGPostFeature
10 - Direct Agent/CFGDirectAgent
11 - Use external protocol/CFGUseExternalProtocol
12 - Get from DN/CFGGetFromDN
13 - Default/CFGXRouteTypeDefault
14 - Route/CFGXRouteTypeRoute
15 - Direct/CFGXRouteTypeDirect
16 - Reroute/CFGXRouteTypeReroute
17 - Direct UUI/CFGXRouteTypeDirectUUI
18 - Direct ANI/CFGXRouteTypeDirectANI
19 - Direct No Token/CFGXRouteTypeDirectNoToken
20 - DNIS pooling/CFGXRouteTypeDNISPooling
21 - Direct DNISn ANI/CFGXRouteTypeDirectDNISnANI
22 - Ext protocol/CFGXRouteTypeExtProtocol
23 - Direct digits/CFGXRouteTypeDirectDigits
24 - Forbidden/CFGXRouteTypeForbidden
25 - ISCC protocol/CFGXRouteTypeISCCProtocol
26 - Pullback/CFGXRouteTypePullBack
For more detailed information about these data types, see the Genesys
Framework 8.1 Deployment Guide.
102
GplusConfSynch.exe
UNIX
GplusConfSynch
where:
<host> is the name of the host on which the Genesys Configuration Server is
running.
<port> is the port of the Genesys Configuration Server.
<application> is the name of the Configuration Synchronization Component
application.
The -batch option should be used to synchronize Siebel and Genesys agent
data when the Configuration Synchronization Component is started for the first
time. To remove all of the agent data from the Configuration Synchronization
Component folders in Configuration Manager and then export agent data from
Siebel, use the -clean_batch option.
If you are using Windows, you can also start the Configuration
Synchronization Component from the Start menu by going to Programs >
Genesys Solutions > Gplus Adapter for Siebel CRM and selecting the
components shortcut (the shortcut has the same name as the Configuration
Synchronization Component Application object). This starts the component
with the default command line options (without the -batch and -clean_batch
options).
103
104
Chapter
Overview
The Gplus Adapter for Siebel CRM Campaign Synchronization Component is
a server-based component. The process for configuring and installing this
component is significantly different than the process for driver-based
components.
The process of configuring and installing the Campaign Synchronization
Component includes the following general procedures:
Configuring Genesys
105
Configuring Siebel.
Release 8.0.0
Support for the Red Hat Enterprise Linux (RHEL) operating system.
Configuring Genesys
This section describes how to configure the Genesys section of the Campaign
Synchronization Component.
Configuring the Genesys side of the Configuration Synchronization
Component consists of the following sections:
Prestart Information, page 106
Importing the Campaign Synchronization Server Application Template,
page 107
Configuring the Tabs in the Properties Dialog Box, page 109
Setting the Genesys Configuration Options for the Campaign
Synchronization Server, page 112
Configuring the Security Settings, page 120
Creating the List Import Format Object, page 122
Prestart Information
Before starting the configuration process you should have the following
Genesys Framework applications running:
106
Configuration Database
Configuration Server
Configuring Genesys
Configuration Manager
Recommendations
Genesys recommends using an Application Template when you are
configuring your Adapter. The Application Template for your Adapter contains
the most important configuration options set to the values recommended for
the majority of environments. When modifying configuration options for your
Adapter later in the process, you can change the values inherited from the
template rather than create all the options by yourself.
Procedure:
Campaign Synchronization Component: Importing the
Application Template
Purpose: To import the Campaign Synchronization Server Application
Template.
Start of procedure
1. In Configuration Manager, under Environment, right-click the Application
Templates folder.
2. Select Import Application Template.
3. Browse to select the Application Template for the Campaign
Synchronization Server.
4. Select the proper template based on the version of Configuration Server
used in your environment. Depending on the version of Configuration
Manager that you use, this name varies slightly, as follows:
For versions 7.0 and earlier, use the following:
Gplus_SiebelCRM_Camp_Synch_800_for_CL_70.apd
For versions 7.1 and later, use the following:
Gplus_SiebelCRM_Camp_Synch_800_for_CL_71_and_higher.apd
5. Click Open.
The Properties dialog box for the Application Template object displays.
107
Configuring Genesys
Procedure:
Campaign Synchronization Component: Creating the
Application object
Purpose: To create the Application object for the Campaign Synchronization
Server.
Start of procedure
1. In Configuration Manager, under Environment, right-click the
Applications folder.
2. Select New > Application.
3. Select the Application template that you just created.
4. Click OK.
The Properties dialog box for the Application displays.
End of procedure
Next Steps
108
Configure the tabs in the Properties dialog box for the Configuration
Synchronization Server. See, Procedure: Campaign Synchronization
Component: Configuring the tabs in the Properties dialog box.
Configuring Genesys
Procedure:
Campaign Synchronization Component: Configuring
the tabs in the Properties dialog box
Purpose: To configure the tabs in the Properties dialog box for the Campaign
Synchronization Server.
Start of procedure
General Tab
1. Click the General tab in the Properties dialog box (see Figure 10).
2. In the Name field, enter the name of the Application object you are
configuring.
109
Configuring Genesys
3. In the Template field, enter the name of the template that you are
configuring or use the Browse button to select the template that you are
configuring.
4. Click Apply.
5. Next, if you are working in a multi-tenant environment, go to the Tenants
Tab; otherwise, go to the Server Info Tab.
Note: The Tenants tab only displays if you are working in a multi-tenant
environment.
Tenants Tab
Connections Tab
110
Options Tab
Configuring Genesys
Gplus Adapter, you must map the Siebel User IDs (the login
names) of the users who created campaigns in the Siebel
environment to the DatabaseAccessPoints, TableAccessFolders,
CallingListFolders, and CampaignFolders.
111
Configuring Genesys
End of procedure
Next Steps
112
Configuring Genesys
CallingListFolders Section
Each option in this section controls the mapping of a Siebel User ID to a
Configuration Manager folder, where the Siebel user with this User ID creates
the Calling List objects when importing the information from Siebel.
To provide Campaign Synchronization functionality, the Siebel login names of
the users who created campaigns in the Siebel environment must be mapped to
the CallingListFolders section. These login names are the User IDs stored in
the Created By field of the corresponding campaigns. You can find these login
names in the Campaign List applet. In any supported Siebel version, you can
find these login names by querying the Siebel database. The following
example is a sample database query that you could use in this scenario:
Example of a
Database Query
Example of a
CallingListFolders
Option
You want the Siebel user (who created the relevant campaigns) with a User
ID of user1, to create a Calling List object under the Configuration
Manager folder, Folder1, which is a subfolder of the Calling Lists folder
under the Tenant, myTenant.
Then create a new option in the CallingListFolders section with user1 as the
option name and /Calling Lists/Folder1 as the option value. Make sure that
the Siebel Organization or Division whose objects the Siebel user, user1
imports is mapped to the Tenant, myTenant (see Tenants Section on
page 119).
Prior to importing information from Siebel, you must use Genesys
Configuration Manager to create the Configuration Manager folders referenced
in this section.
The relationship of Siebel User IDs to Genesys Configuration Manager folders
in this section is many-to-one.
113
Configuring Genesys
Note: You can configure the import function using the options in this
CampaignFolders Section
Each option in this section controls the mapping of a Siebel User ID to a
Configuration Manager folder, where the Siebel user with this User ID creates
Campaign objects when importing information from Siebel.
To provide Campaign Synchronization functionality, the Siebel Login Names
of the users who created campaigns in the Siebel environment must be mapped
to the CampaignFolders section. You can find these login names in the Campaign
List applet. In any Siebel version, you can find these login names by querying
the Siebel database. The following example is a sample database query that
you could use in this scenario:
Example of a
Database Query
Example of a
CampaignFolders
Option
You want the Siebel user (who created the relevant campaigns) with a User
ID of user1, to create a Campaign object under the Configuration Manager
folder, Folder1, which is a subfolder of the Calling Lists folder under the
Tenant, myTenant.
Then create a new option in the CampaignFolders section with user1 as the
option name and /Campaigns/Folder1 as the option value. Make sure that the
Siebel Organization or Division whose objects the Siebel user, user1 imports is
mapped to the Tenant, myTenant (see Tenants Section on page 119).
Prior to importing information from Siebel, you must use Genesys
Configuration Manager to create the Configuration Manager folders
referenced in this section.
The relationship of Siebel User IDs to Genesys Configuration Manager folders
in this section is many-to-one.
114
Configuring Genesys
Note: You can configure the import function using the options in this
DatabaseAccessPoints Section
The options in this section allow you to designate where selected Siebel users
can create Genesys calling list tables when exporting campaigns from Siebel to
Genesys.
To provide Campaign Synchronization functionality, the Siebel Login Names
of the users who created campaigns in the Siebel environment must be mapped
to the DatabaseAccessPoints section. These login names are the User IDs
stored in the Created By field of corresponding campaigns. In Siebel versions
7.7, 7.8, 8.0, and 8.1, you can find these login names in the Campaign List
applet. In any Siebel version, you can find these login names by querying the
Siebel database. The following example is a sample database query that you
could use in this scenario:
Example of a
Database Query
Example of a
DatabaseAccess
Points Option
You want the Siebel user (who created the relevant campaigns) with a User
ID of user1, to create calling list tables in a database defined by the
Database Access Point, DAP1.
115
Configuring Genesys
Genesys Section
The Genesys section has various options that can be configured. The following
section describes the possible options.
communicationDN
Default Value: <required>
Valid Value: Any string value containing the correct Communication DN
Determines the name of a communication DN, which is used for interactions
with the Outbound Contact Server, and specifically for the Do Not Call option.
DNCUpdateTimeout
Default Value: 5000
Valid Value: Any positive integer
Specifies the time interval (in milliseconds) that the Campaign
Synchronization Component waits for a response about a DoNotCall list
update.
format
Default Value: GplusCampSynch
Valid Value: Any string value containing a Format object name
Determines the name of a list import Format object in Genesys Configuration
Layer, which is used by the Campaign Synchronization Component to create
Genesys calling list tables. The default value for this option is GplusCampSynch.
Note: Leave the default value unchanged at the time of deployment. For
more information about this option, see the Gplus Adapter 8.0 for
Siebel CRM Developers Guide.
password
Default Value: <required>
Valid Value: Any character string
Specifies the password for the login user name, which is the User ID stored in
the Created By field of corresponding campaignsfor example,
GenesysAdapter. This user name should be created in the Siebel environment.
The user must have access to the Siebel database as a Siebel Administrator.
Warning! Genesys does not recommend the use of a common login name for
116
Configuring Genesys
pullDataTimeout
Default Value: 15000
Valid Value: Any positive integer
Specifies the time interval (in milliseconds) that the Campaign
Synchronization Component waits to reconnect to the Siebel Server before
sending a request for Synchronization data.
pushDataTimeout
Default Value: 11000
Valid Value: Any positive integer
Specifies the time interval (in milliseconds) that the Campaign
Synchronization Component waits to reconnect and send to the Siebel Server
all of the Call Results Data received by the Adapter from Outbound Contact
Server during this interval (backward synchronization in real-time mode).
ServerURL
Default Value: <ServerUrl>/eai_enu/start.swe
Valid Value: <AnyValidUrl>/eai_enu/start.swe
Specifies the URL of the web server upon which the Siebel Web Engine is
installed. Initially, this option contains the following template string:
ServerURL=<ServerUrl>/<path>/start.swe?SWEExtSource=GplusCampSynch&SWEE
xtCmd=Execute&UserName=<userName>&Password=<password>
where:
<ServerUrl> is the first part of the URL you use to access your Siebel
<path> specifies a virtual path on the server referring to the specific Siebel
Web Extension configuration. The default value for this option is eai_enu.
You have to edit this URL template string according to your Siebel Web
Extension configuration. The following is an example of an edited URL:
http://www.myserver.com/eai_enu/start.swe?SWEExtSource=GplusCampSynch&S
WEExtCmd=Execute&UserName=<userName>&Password=<password>
Note: For security reasons, you do not need to put <userName> and
<password> directly into the URL string. Use the username and
password options instead.
synchCallResults
Default Value: true
Valid Values: true, false
Synchronizes the Call Results from Genesys to Siebel in real-time mode. If
you set the value of this option to true, it enables this synchronization.
117
Configuring Genesys
synchSummary
Default Value: true
Valid Values: true, false
Collects the synchronization summary information. If you set the value of this
option to true, it enables this collection. See the Gplus Adapter 8.0 for Siebel
CRM Developer's Guide for more information about synchronization summary
usage.
username
Default Value: <required>
Valid Value: Any character string
Specifies a Siebel user name for the Siebel Object Manager login to process a
request from the Gplus Adapterfor example, GenesysAdapter. This user name
must be created in the Siebel environment. The user must have access to the
Siebel database as Siebel Administrator.
Warning! Genesys does not recommend using a common login ID for this
xslTransformer (Optional)
Default Value: <optional>
Valid Value: A string value containing the *.xsl file name
This configuration option is optional. Transforms the values of various
synchronized data (for examplephone number) using your own customized
rules. The Adapter provides a mechanism to customize the transformation
rules through an *.xsl file. The value of this option should be equal to the
name of the *.xsl file.
Log Section
The Campaign Synchronization Server supports a common set of Log options
to allow the precise configuration of the log file output. For a complete list of
Common Log options and their descriptions, see the Common Log Options
chapter of the Framework 8.0 Configuration Options Reference Manual.
Note: If you do not specify any log options, the default values apply.
TableAccessFolders Section
Each option in this section controls the mapping of a Siebel User ID to a
Configuration Manager folder, where the Siebel user with this User ID creates
a Table Access object when importing information from Siebel.
118
Configuring Genesys
You want the Siebel user (who created the relevant campaigns) with a User
ID of user1, to create a Table Access object under the Configuration
Manager folder, Folder1, which is a subfolder of the Table Access folder
under the Tenant, myTenant.
Then create a new option in the TableAccessFolders section with user1 as the
option name and /Table Access/Folder1 as the option value.
The Siebel Organization or Division, whose objects the Siebel user, user1
imports, must be mapped to the Tenant, myTenant. For information about
Tenants, see Tenants Section on page 119.
Prior to importing information from Siebel, you must use Genesys
Configuration Manager to create the Configuration Manager folders referenced
in this section.
The relationship of Siebel User IDs to Genesys Configuration Manager folders
in this section is many-to-one.
Note: You can configure the import function using the options in this
Tenants Section
Options in this section define the mapping of Siebel Organizations or
Divisions to Genesys Tenants. To map a Siebel Organization or Division to a
Genesys Tenant, create a new option within this section, where the option
name is the name of the Genesys Tenant and the option value is the name of
the Siebel Organization or Division.
119
Example of a
TenantsOption
Configuring Genesys
contain one option, where the option name is Resources and the option
value is the name of your Siebel Organization or Division.
Saving the
Application Object
After setting the Application options, click OK to save the Application object.
Procedure:
Campaign Synchronization Component: Creating a
new Person object
Purpose: To add a new Person object to the environment.
Start of procedure
1. In Configuration Manager:
Right-click the Persons folder under Environment, if you are working in
a multi-tenant environment.
Right-click the Persons folder under Resources, if you are working in a
single-tenant environment.
2. Select New > Person.
The new Person window displays.
3. Select the General tab and enter the following parameters:
Employee ID = siebel7gplus
120
Configuring Genesys
4. Click OK.
End of procedure
Next Steps
Procedure:
Campaign Synchronization Component: Adding a
Person object to the Super Administrators Access
Group
Purpose: To add a Person object to the Super Administrators Access Group.
Start of procedure
1. In Configuration Manager, to display the existing Access Groups:
Right-click the Access Groups folder under Environment, if you are
working in a multi-tenant environment.
Right-click the Access Groups folder under Resources, if you are
working in a single-tenant environment.
2. Double-click the Super Administrators Access Group to display its
properties.
3. Click the Add button to add the Person object that you just created to the
Users list.
4. Click OK.
End of procedure
Next Steps
Associate the newly created Person object account with the Application
object. See, Procedure: Campaign Synchronization Component:
Associating a Person object account with the Application object.
121
Configuring Genesys
Procedure:
Campaign Synchronization Component: Associating a
Person object account with the Application object
Purpose: To associate a Person object account with the Application object.
Start of procedure
1. In Configuration Manager, under Environment, click the Applications
folder to display existing applications.
2. Double-click the Application object you just created to display its
properties.
3. Select the Security tab, in the Log On As section, and select This Account.
The Add User window displays.
4. Select the Person account you just created and click Add.
5. Click OK to close the Add User window.
6. Click OK to save the Application object.
End of procedure
Next Steps
Create the list import Format object by following the procedures in the
section, Creating the List Import Format Object on page 122.
The first step of the process is to create several Field objects (which are
mandatory) for each List Import Format object.
122
Displaying the
Annex Tab
Configuring Genesys
However, before you create the Field objects, ensure that the Annex tab is
displayed in the Configuration Object properties window: See, Procedure:
Campaign Synchronization Component: Configuring the Annex tab to display
in object properties.
Procedure:
Campaign Synchronization Component: Configuring
the Annex tab to display in object properties
Purpose: To ensure the Annex tab is displayed in the object properties.
Start of procedure
1. In Configuration Manager, from the View menu, select Options.
2. In the Object Properties dialog box, select the Show Annex tab.
3. To close the window, click OK.
End of procedure
Next Steps
Procedure:
Campaign Synchronization Component: Creating the
Field objects
Purpose: To create a new Field object in Configuration Manager.
Start of procedure
1. In Configuration Manager:
Right-click the Fields folder under Environment, if you are working in
a multi-tenant environment.
Right-click the Fields folder under Resources, if you are working in a
single-tenant environment.
The new Field Properties window appears.
2. Select New > Field.
The new Field window appears.
123
Configuring Genesys
3. On the General tab for the Field you are creating, enter the Name field
value from Table 7, Field Object Properties, on page 125. For example,
to complete the first instance, enter crm_campaign_id (see Figure 12).
4. On the Annex tab, create a new section called default (see Figure 13 on
page 125).
124
Configuring Genesys
Data
Type
Description
Length
Field Type
Primary
Key
Nullable
crm_campaign_id
varchar
Campaign ID
20
User-Defined
Cleared
Cleared
crm_camp_con_id
varchar
Campaign List
Contact ID
20
User-Defined
Selected
Cleared
crm_contact_id
varchar
Contact ID
20
User-Defined
Cleared
Cleared
125
Configuring Genesys
Table 8 shows the values for the send_attribute option, which you use when
creating Field objects.
Table 8: Values for send_attribute Option
Field Name
crm_campaign_id
CRM_CAMPAIGN_ID
crm_camp_con_id
CRM_CAMP_CON_ID
crm_contact_id
GSW_CUSTOMER_ID
End of procedure
Next Steps
Procedure:
Campaign Synchronization Component: Updating the
Field object
Purpose: To update the Field object.
Start of procedure
1. If you need to synchronize the call results from Genesys to Siebel in
real-time mode, update the following Field objects:
call_result
call_time
attempt
crm_campaign_id
crm_camp_con_id
crm_contact_id
2. Add the new option, icon_attribute to the default section of all of the
Fields, and set the value of the option to 1 (see Figure 14 on page 127).
126
Configuring Genesys
End of procedure
Next Steps
Procedure:
Campaign Synchronization Component: Creating the
Format object
Purpose: To create the Format object.
Start of procedure
1. In Configuration Manager:
Right-click the Format folder under Environment, if you are working in
a multi-tenant environment.
127
Configuring Genesys
128
Procedure:
Campaign Synchronization Component: Copying the
Format object to a Tenant
Purpose: To create a copy of the List Import Format object under each Tenant
that is mapped to a Siebel Organization or Division.
Note: Complete this procedure only if you work in a multi-tenant
environment
Start of procedure
1. In Configuration Manager, under a Tenant that is mapped to a Siebel
Organization or Division, right-click the Formats folder.
2. Select New > Copy of existing Format.
The Browse window displays.
3. Select the Format object you just created.
4. Click OK.
The Properties dialog box appears for the Format copy that you are about
to create.
5. Click OK to copy the Format object.
End of procedure
Next Steps
129
Procedure:
Campaign Synchronization Component: Defining the
time zones for a Tenant
Purpose: To define the time zones for a Tenant.
Note: It is also possible to modify the names of the time zones in the Siebel
environment, so that they match the time zone names in the Genesys
environment. The instructions above assume that the Siebel time
zones have been defined first.
If the time zones have been imported into the Genesys environment
while the Genesys Adapter is running (that is, after the deployment of
this Adapter), then you must restart the Genesys Adapter to accept
these changes.
For more information about Time Zone Administration in Siebel, see
your Siebel documentation.
Start of procedure
1. Open both the Siebel and Configuration Manager applications.
2. In Configuration Manager, under a Tenant that is mapped to a Siebel
Organization or Division, right-click the Time Zones folder.
3. Select New > Time Zone.
The new Time Zone window displays.
4. In Siebel, navigate through the Site Map to get to Time Zone
administration, as follows:
In a Siebel 7.7/7.8/8.0/8.1 environment, select the following:
Administration - Data > Time Zone Administration
5. In Configuration Manager, select the General tab and enter the values for
the parameters listed below: (To minimize errors, use a cut-and-paste
approach.)
a. In the Name field, enter the exact name of the time zone from the Siebel
environment.
b. In the Description field, enter a brief description of the time zone.
c. In the Offset field, enter the time difference between the local time
and Greenwich Mean Time (GMT).
d. In the Specific Zone Name in Netscape field, enter the time zone name
used by the Netscape Navigator browser.
e. In the Specific Zone Name in Microsoft Explorer field, enter the time
zone name used by Microsoft Explorer.
130
Installation
6. Click OK.
End of procedure
Next Steps
Installation
This section describes the installation process for the Gplus Adapter 8.0 for the
Siebel CRM Campaign Synchronization Component. Select one of the
following sections, depending on your environment:
Installing the Campaign Synchronization Component in a Windows
Environment, page 131
Installing the Campaign Synchronization Component in an UNIX
Environment, page 132
Procedure:
Campaign Synchronization Component: Installing the
Component in a Windows environment
Purpose: To install the Campaign Synchronization Component on a Windows
operating system.
Start of procedure
1. To start the installation process, run the setup.exe file from the Campaign
Synchronization Component installation package.
2. In the Welcome window, click Next.
3. In the Configuration Parameters to the Genesys Configuration Server
window, enter the following:
a. The name of the host on which Configuration Server is running.
b. The communication port that client applications must use to connect to
Configuration Server.
c. The user name used to access Configuration Server.
131
Installation
132
Installation
Procedure:
Campaign Synchronization Component: Installing the
Component in an UNIX environment
Purpose: To install the Campaign Synchronization Component on a UNIX
system.
Note: Do not use special symbols in any destination directory name when
3. When prompted, specify the host name, port, user name, and password of
the computer on which the Component will be installedfor example:
a. Enter the host name of Configuration Server.
b. Enter the port of Configuration Server.
c. Enter the user name for Configuration Server.
d. Enter the password for the user name.
4. Choose the Configuration Server environment by its corresponding
number.
5. Specify the Application object that you configured in the previous
procedure, Procedure: Campaign Synchronization Component: Creating
the Application object, on page 108.
6. Specify the full path to the destination directory where you want the
Component to be installed.
133
Configuring Siebel
Configuring Siebel
This section describes how to configure the Siebel part of the Campaign
Synchronization Component.
Configuring the Siebel section of the Campaign Synchronization Component
consists of the following sub-sections:
Prestart Information, page 134
Configuring Siebel Using the Siebel Tools, page 135
Configuring the Siebel Server, page 144
Configuring Siebel Using the Siebel Web Client, page 147
Prestart Information
Before starting this part of the configuration process, you must make sure to do
the following:
134
You should be connected to the local copy of the Siebel Server database.
Configuring Siebel
135
Configuring Siebel
this object, you must check-out the corresponding project from the Siebel
repository.
Procedure:
Campaign Synchronization Component: Checking Out
Existing Projects from the Siebel Repository for the
Campaign Synchronization Component
Purpose: To check out an existing project from the Siebel repository.
Start of procedure
1. In Siebel Tools, select Tools > Check Out...
The Check Out dialog box displays.
2. Select Project category.
3. In the Projects list, select the following projects:
Campaign
Personalization
4. Click Check Out.
End of procedure
Next Steps
Procedure:
Campaign Synchronization Component: Importing the
Campaign.sif Archive File
Purpose: To import the Campaign.sif archive file.
Start of procedure
1. In Siebel Tools, select Tools > Import from Archive...
2. In the Select Archive to Import window, navigate to the Campaign.sif
archive file.
This file was created by the installation program in: <target
directory>/XXX/tools/objects where XXX is the subfolder name (/7.7,
/8.0, or /8.1), depending on the Siebel version you use.
136
Configuring Siebel
3. Click Open.
The Import WizardPreview window displays.
4. In the Import WizardPreview window, in the Conflict resolution
section, select Merge the object definition from the archive file with
the definition in the repository.
5. Click Next.
The Import WizardReview Conflicts and Actions window displays.
6. In the Conflicting Objects pane, select the Business Component category.
7. In the Object differences pane, select Campaign if available (there is no
Campaign option in the Object differences pane depending on the Siebel
version you usefor example, 7.7, 7.8, 8.0, and 8.1). If there are any
attributes in the Attribute differences pane, make sure that the
Resolution column for each attribute is set to Repository. To do this:
Right-click on an attribute and select Repository from the drop-down
menu.
8. In the Object differences pane, select Campaign List Contact. If there
are any attributes in the Attribute differences pane, make sure that the
Resolution column for each attribute is set to Repository. To do this:
Right-click on an attribute and select Repository from the drop-down
menu.
9. Click Next.
The Do you wish to proceed? window displays.
10. Click Yes.
The objects from the archive are imported into the Siebel repository.
11. Click Finish to complete the import.
Note: It is possible for siebel_assert_xxx.txt file(s) to be generated by
the Siebel environment after importing the archive. This does not
affect the functionality of the Component in any way.
End of procedure
Next Steps
137
Configuring Siebel
Procedure:
Campaign Synchronization Component: Importing the
PersonalizationActionSet.sif Archive File
Purpose: To import the PersonalizationActionSet.sif archive file.
Start of procedure
1. In Siebel Tools, select Tools > Import from Archive...
2. In the Select Archive to Import window, navigate to the
PersonalizationActionSet.sif archive file.
This file was created by the installation program in: <target
directory>/seaXXX/tools/objects where XXX is the subfolder name (/7.7,
/8.0, or /8.1), depending on the Siebel version you use.
3. Click Open.
The Import WizardPreview window displays.
4. In the Import WizardPreview window, in the Conflict resolution
section, select Merge the object definition from the archive file with
the definition in the repository.
5. Click Next.
The Do you wish to proceed? window displays.
6. Click Yes.
The objects from the archive are imported into the Siebel repository.
7. Click Finish to complete the import.
Note: It is possible for siebel_assert_xxx.txt file(s) to be generated by
the Siebel environment after importing the archive. This does not
affect the functionality of the Component in any way.
End of procedure
Next Steps
Importing the
GenesysCampaign
Synchronization
.sif Archive File
138
During this step, you will import objects into the Siebel repository that are part
of the Siebel implementation of the Configuration Synchronization
Configuring Siebel
If this project does not exist before export, lock it after the export.
Also, the Adapter does not contain limitations for some of the
Adapter's compiled components that work only with the T eScript
Engine (and not the ST eScript Engine). The default value of the
Siebel option should be set to Enable ST Script Engine = true, but
for the Genesys component the value should be set to Enable ST
Script Engine = false.
Procedure:
Campaign Synchronization Component: Importing the
GenesysCampaignSynchronization.sif archive file
Purpose: To import the GenesysCampaignSynchronization.sif archive file for
the Campaign Synchronization Component.
Start of procedure
1. In Siebel Tools, select Tools > Import from Archive...
2. In the Select Archive to Import window, navigate to the
GenesysCampaignSynchronization.sif archive file.
This file was created by the installation program in:
<TargetDirectory>/XXX/tools/objects where XXX is the subfolder name
(/7.7, /8.0, or /8.1), depending on the Siebel version you use.
3. Click Open.
The Import WizardPreview window displays.
4. In the Import WizardPreview window, in the Conflict resolution
section, select Overwrite the object definition in the repository.
5. Click Next.
The Import WizardReview Conflicts and Actions window displays.
6. Click Next.
The Do you wish to proceed? window displays.
7. Click Yes.
The objects from the archive are imported into the Siebel repository.
139
Configuring Siebel
the Siebel environment after importing the archive. This does not
affect the functionality of the component in any way.
End of procedure
Next Steps
Setting up the correct path to the Siebel File System directory. See,
Procedure: Campaign Synchronization Component: Selecting the correct
path to the Siebel File System directory.
Procedure:
Campaign Synchronization Component: Selecting the
correct path to the Siebel File System directory
Purpose: To provide the proper path to your Siebel File System directory in
the user property named FileSystem of the Genesys Campaign Synchronization
Business Service.
Start of procedure
1. In Siebel Tools, in the Project field of the Object Explorer, select
Genesys Campaign Synchronization.
140
Configuring Siebel
4. Using the Types tab of the Object Explorer, select the Business Service
User Prop folder under the Business Service folder.
The Business Service User Props window displays.
5. Select the FileSystem Business Service User Property.
6. In the Value column, enter the correct path to the Siebel File System
directory as it is defined in your Siebel environmentfor example:
For Unix: /siebel/filesystem/
For Windows: C:\sea\filesystem\
value, keep in mind that the HTTPSleepTime Siebel parameter for the
Genesys HTTP connection, with a default value of 120000
milliseconds (ms), should be enough for processing any requests on
the Genesys side. Practically speaking, if a message contains more
then 500 records, it could take a longer time for processing, and in this
scenario, the HTTPSleepTime parameter size should be increased as
well.
141
Configuring Siebel
Procedure:
Campaign Synchronization Component: Selecting the
Campaign Mapping mode
Purpose: To select one of two supported Campaign Mapping modes.
Start of procedure
1. In Siebel Tools, in the Project field of the Object Explorer, select
Genesys Campaign Synchronization.
Procedure:
Campaign Synchronization Component: Selecting the
Genesys DoNotCall Field
Purpose: To configure whether IDs or phone numbers are used to update the
Do Not Call list in the Genesys environment.
142
Configuring Siebel
Start of procedure
1. In Siebel Tools, in the Project field of the Object Explorer, select
Genesys Campaign Synchronization.
an appropriate field. You must ensure that after importing any new
toolbar items there are no conflicts for the position field that appears.
Siebel does not check this and conflicts may cause issues with the
appearance of the Communications Toolbar.
Procedure:
Campaign Synchronization Component: Compiling the
Siebel Repository File
Purpose: To compile the Siebel repository file.
143
Configuring Siebel
Start of procedure
1. In Siebel Tools, select Tools > Compile Projects...
2. Select Locked projects.
3. In the Siebel Repository File edit box, enter the name of the repository
file.
4. Click Compile.
The status bar at the bottom of the Object Compiler window indicates
when the compilation is finished.
5. When the compilation is finished, close Siebel Tools.
Note: It is possible for siebel_assert_xxx.txt file(s) to be generated by
Configure the Siebel Server. See the section, Configuring the Siebel
Server.
Procedure:
Campaign Synchronization Component: Configuring
the Siebel Server
Purpose: To configure the Siebel Server to work with the Campaign
Synchronization Component.
Start of procedure
Updating the
Configuration
Files
1. To update the eai.cfg file in the Siebel Server installation, open it and add
the following line to the [HTTP Services] section:
GplusCampSynch = GplusCampSynchDispatch
144
Configuring Siebel
Creating Genesys
Project Table on
the Siebel Server
Database
145
Deploying the
Repository File
Configuring Siebel
End of procedure
146
Configuring Siebel
Next Steps
Configure Siebel using the Siebel Web Client. See the section,
Configuring Siebel Using the Siebel Web Client on page 147.
Procedure:
Campaign Synchronization Component: Checking the
EAI Server Component Group Status
Purpose: To check the status of the EAI (Enterprise Application Integration)
Server Component Group on the Siebel Server.
Summary
There are slight variations in the navigation required by this process,
depending on the version of Siebel with which you are working.
Start of procedure
1. Navigate through the Site Map to get to the desired applet.
2. Select Site Map > Administration - Server Configuration > Component
Groups.
147
Configuring Siebel
3. Select the Siebel Server you are working on. For the selected server, locate
the Enterprise Application Integration Component Group in the Server
Component Groups applet. The group Enable State attribute should have
the value Enabled.
End of procedure
Next Steps
Procedure:
Campaign Synchronization Component: Navigating to
the Siebel Server configuration
Purpose: To navigate through the site map to get to your Siebel Server
configuration.
Start of procedure
1. Navigate through the site map to get to your Siebel Server configuration:
In Siebel 7.7/7.8/8.0/8.1 environments, select Site Map >
Administration - Server Configuration.
2. Select Profile Configuration applet within the view.
3. Complete the process by completing the procedures that follow.
End of procedure
Next Steps
148
Configuring Siebel
Procedure:
Campaign Synchronization Component: Creating
a connection subsystem
Purpose: To create and configure one connection subsystem that is used by the
Campaign Synchronization Component.
Creating a
Connection
Subsystem
Component.
<port> is the port you specified in the Communication Port field in the
Configuration Manager Server Info Tab of the Campaign Synchronization
Component Application object.
Creating a Backup
Connection
Subsystem
149
Configuring Siebel
HTTPRequestURLTemplate: http://<host>:<port>
where:
<host> is the host where you installed the Campaign Synchronization
Component.
<port> is the port you specified in the Communication Port field in the
Configuration Manager Server Info Tab of the Campaign Synchronization
Component Application object.
Creating a
Transport
Subsystem
available from the applets (GUI). In this case, you have to set it
through the Siebel Server Manager (srvrmgr) using the following
command:
change parameter CharSetConversion = UTF-8 for named
subsystem GplusCampSynchDispatch
150
Configuring Siebel
Procedure:
Campaign Synchronization Component: Creating the
Genesys Campaign Export Position record
Purpose: To perform the campaign export function to create a special position
record within the Siebel division.
Start of procedure
1. Select Site Map > Group Administration > Positions.
2. Click New on the Positions applet to create a new record.
3. Specify the following parameters for the new record:
Division: Select the division to which this position belongs
Position: Genesys Campaign Export
4. Save the new record.
To assign one or more employees to the position record that you just
created, use the Last Name field of the position. For further information
about how to add positions and assign employees to positions, see the
Siebel documentation.
You have completed the configuration and installation of the Gplus
Adapter 8.0 for Siebel CRM Campaign Synchronization Component.
End of procedure
Next Steps
151
Configuring Siebel
Procedure:
Campaign Synchronization Component: Creating the
runtime events
Purpose: To create the runtime events that are required by the Campaign
Synchronization Component.
Start of procedure
1. Navigate through the Site Map to Business Service Administration >
Business Service Simulator.
2. In the Service Methods applet, create a new record.
3. Specify the following parameters for the new record:
Service Name: Genesys Campaign Synchronization
Method Name: InstallRunTimeEvents
4. Click the Run button.
5. After running the method, in the Siebel client, navigate to Administration
> Runtime Events >Events.
6. Select Reload Runtime Events system menu item.
End of procedure
Next Steps
152
Chapter
Overview
The 8.0.1 version of the Gplus Adapter for Siebel CRM Campaign
Synchronization Component is a new product in comparison to the earlier
versions (7.5 and 8.0) of the Campaign Synchronization Component.
The major new features and enhancements are:
Support for the Siebel waves campaign management feature, which means
that instead of mapping (synchronizing) the Siebel calling lists to the
Genesys calling lists, the Siebel campaign waves are now mapped to the
Genesys calling lists.
153
See the Gplus Adapter for Siebel CRM Users Guide for further details about
how to directly manage the campaign synchronization. Also, refer to the Gplus
Adapter for Siebel CRM Developers Guide for details on customizable
solutions.
The 8.0.1 version of the Gplus Adapter for Siebel CRM Campaign
Synchronization Component is a new product in comparison to the earlier
versions (7.5 and 8.0) of the Campaign Synchronization Component.
The major new features and enhancements are:
Support for the Siebel waves campaign management feature.
Support for the synchronization of multiple parallel campaigns,
including single or multiple-tenants.
Improved synchronization algorithms to achieve better performance.
The communication between Siebel and the Gplus Adapter Campaign
Synchronization Server is now unidirectional.
The implementation of a Siebel GUI to simplify the configuration and
synchronization procedures.
See the Gplus Adapter for Siebel CRM Users Guide for further details about
how to manage campaign synchronization with the new approach. Also, refer
to the Gplus Adapter for Siebel CRM Developers Guide for details on
customizable solutions.
Configuring Genesys
This chapter describes how to configure and install the 8.0.1 version of the
Genesys part of the Campaign Synchronization Component.
Configuring the 8.0.1 version of the Genesys side of the Campaign
Synchronization Component consists of the following sections:
154
Configuring Genesys
Prestart Information
Before starting the configuration process you should have the following
Genesys Framework applications running:
Configuration Database
Configuration Server
Configuration Manager
Recommendations
Genesys recommends using an Application Template when you are
configuring your Adapter. The Application Template for your Adapter contains
the most important configuration options set to the values recommended for
the majority of environments. When modifying configuration options for your
Adapter later in the process, you can change the values inherited from the
template rather than create all the options by yourself.
155
Configuring Genesys
Procedure:
Campaign Synchronization Component 8.0.1:
Importing the Campaign Synchronization Server
Application Template
Purpose: To import the Campaign Synchronization Server Application
Template.
Start of procedure
1. In Configuration Manager, under Environment, right-click the Application
Templates folder.
2. Select Import Application Template.
3. Browse to select the Application Template for the Campaign
Synchronization Server.
4. Select the proper template based on the version of Configuration Server
used in your environment. Depending on the version of Configuration
Manager that you use, this name varies slightly, as follows:
For versions 7.0 and earlier, use the following:
Gplus_SiebelCRM_Camp_Synch_801_for_CL_70.apd
5. Click Open.
The Properties dialog box for the Application Template object displays.
6. Optional: Edit the Application Template name.
7. Click OK to accept the default values.
The Application Template object has been imported to Genesys
Configuration Layer.
End of procedure
Next Steps
156
Configuring Genesys
Procedure:
Campaign Synchronization Component 8.0.1: Creating
the Application object
Purpose: To create the Application object for the Campaign Synchronization
Server.
Start of procedure
1. In Configuration Manager, under Environment, right-click the
Applications folder.
2. Select New > Application.
3. Select the Application template that you just created.
4. Click OK.
The Properties dialog box for the Application displays.
End of procedure
Next Steps
Configure the tabs in the Properties dialog box for the Campaign
Synchronization Server. See, Procedure: Campaign Synchronization
Component 8.0.1: Configuring the tabs in the Properties dialog box, on
page 157.
Procedure:
Campaign Synchronization Component 8.0.1:
Configuring the tabs in the Properties dialog box
Purpose: To configure the tabs in the Properties dialog box for the Campaign
Synchronization Server.
157
Configuring Genesys
Start of procedure
General Tab
1. Click the General tab in the Properties dialog box (see Figure 16).
2. In the Name field, enter the name of the Application object you are
configuring.
3. In the Template field, enter the name of the template that you are
configuring or use the Browse button to select the template that you are
configuring.
4. Click Apply.
5. Next, if you are working in a multi-tenant environment, go to the Tenants
Tab; otherwise, go to the Server Info Tab.
Note: The Tenants tab only displays if you are working in a multi-tenant
environment.
Tenants Tab
158
Configuring Genesys
8. Click Add.
Server Info Tab
Connections Tab
159
Options Tab
Configuring Genesys
160
Configuring Genesys
Next Steps
do-not-call Section
The do-not-call section has the following option that can be configured:
communication-dn
Default Value: <optional>
Valid Value: Any string value containing the correct Communication DN
Determines the name of the Communication DN that is used for interactions
with the Outbound Contact Server, and specifically for the Do Not Call option.
log Section
The Campaign Synchronization Server supports a common set of Log options
to allow the precise configuration of the log file output. For a complete list of
Common Log options and their descriptions, see the Common Log Options
chapter of the Framework 8.0 Configuration Options Reference Manual.
Note: If you do not specify any log options, the default values apply.
161
Configuring Genesys
outbound Section
The outbound section has various options that can be configured. The
following section describes the possible options:
format
Default Value: GplusCampSynch
Valid Value: Any string value containing a Format object name
Specifies the name of a list import Format object in the Genesys Configuration
Layer that is used by the Campaign Synchronization Server to create Genesys
Calling List tables. The default value for this option is GplusCampSynch.
ocs-request-timeout
Default Value: 10
Valid Value: Any positive numeric value
Specifies the time interval (in seconds) that the Adapter waits for a reply from
Outbound Contact Server for a Do Not Call request.
xml Section
The xml section has the following option that can be configured:
xslTransformer (Optional)
Default Value: <optional>
Valid Value: A string value containing the *.xsl file name
This configuration option is optional. Transforms the values of various
synchronized data (for examplephone number) using your own customized
rules. The Adapter provides a mechanism to customize the transformation
rules through an *.xsl file. The value of this option should be equal to the
name of the *.xsl file.
162
Configuring Genesys
Procedure:
Campaign Synchronization Component 8.0.1: Creating
a new Person object
Purpose: To add a new Person object to the environment.
Start of procedure
1. In Configuration Manager:
Right-click the Persons folder under Environment, if you are working in
a multi-tenant environment.
Right-click the Persons folder under Resources, if you are working in a
single-tenant environment.
2. Select New > Person.
The new Person window displays.
3. Select the General tab and enter the following parameters:
Employee ID = siebel7gplus
User Name = siebel7gplus
Is Agent = Clear
4. Click OK.
End of procedure
Next Steps
Procedure:
Campaign Synchronization Component 8.0.1: Adding
a Person object to the Super Administrators Access
Group
Purpose: To add a Person object to the Super Administrators Access Group.
Start of procedure
1. In Configuration Manager, to display the existing Access Groups:
Right-click the Access Groups folder under Environment, if you are
working in a multi-tenant environment.
163
Configuring Genesys
Associate the newly created Person object account with the Application
object. See, Procedure: Campaign Synchronization Component 8.0.1:
Associating a Person object account with the Application object.
Procedure:
Campaign Synchronization Component 8.0.1:
Associating a Person object account with the
Application object
Purpose: To associate a Person object account with the Application object.
Start of procedure
1. In Configuration Manager, under Environment, click the Applications
folder to display existing applications.
2. Double-click the Application object you just created to display its
properties.
3. Select the Security tab, in the Log On As section, and select This Account.
The Add User window displays.
4. Select the Person account you just created and click Add.
5. Click OK to close the Add User window.
6. Click OK to save the Application object.
End of procedure
Next Steps
164
Create the list import Format object by following the procedures in the
section, Creating the List Import Format Object on page 165.
Configuring Genesys
The first step of the process is to create several Field objects (which are
mandatory) for each List Import Format object.
Displaying the
Annex Tab
However, before you create the Field objects, ensure that the Annex tab is
displayed in the Configuration Object properties window: See, Procedure:
Campaign Synchronization Component 8.0.1: Configuring the Annex Tab to
Display in Object Properties.
Procedure:
Campaign Synchronization Component 8.0.1:
Configuring the Annex Tab to Display in Object
Properties
Purpose: To ensure the Annex tab is displayed in the object properties.
Start of procedure
1. In Configuration Manager, from the View menu, select Options.
2. In the Object Properties dialog box, select the Show Annex tab.
3. To close the window, click OK.
End of procedure
Next Steps
165
Configuring Genesys
Procedure:
Campaign Synchronization Component 8.0.1: Creating
Field objects
Purpose: To create a new Field object in Configuration Manager.
Start of procedure
1. In Configuration Manager:
Right-click the Fields folder under Environment, if you are working in
a multi-tenant environment.
Right-click the Fields folder under Resources, if you are working in a
single-tenant environment.
The new Field Properties window appears.
2. Select New > Field.
The new Field window appears.
3. On the General tab for the Field you are creating, enter the Name field
value from Table 9, Field Object Properties, on page 168. For example,
to complete the first instance, enter crm_campaign_id (see Figure 18).
166
Configuring Genesys
4. On the Annex tab, create a new section called default (see Figure 19).
167
Configuring Genesys
Table 9 contains properties you need to enter on the General tab for each Field
object.
Table 9: Field Object Properties
Field Name
Data
Type
Description
Length
Field Type
Primary
Key
Nullable
crm_campaign_id
varchar
Campaign ID
20
User-defined
field
Cleared
Cleared
crm_camp_con_id
varchar
Campaign List
Contact ID
20
User-defined
field
Selected
Cleared
crm_contact_id
varchar
Contact ID
20
User-defined
field
Cleared
Cleared
Table 10 shows the values for the send_attribute option, which you use when
creating Field objects.
Table 10: Values for the send_attribute Option
Field Name
crm_campaign_id
CRM_CAMPAIGN_ID
crm_camp_con_id
CRM_CAMP_CON_ID
crm_contact_id
GSW_CUSTOMER_ID
End of procedure
Next Steps
168
Configuring Genesys
Procedure:
Campaign Synchronization Component 8.0.1:
Updating the Field object
Purpose: To update the Field object.
Start of procedure
1. If you need to synchronize the call results from Genesys to Siebel in
real-time mode, update the following Field objects:
call_result
call_time
attempt
crm_campaign_id
crm_camp_con_id
crm_contact_id
Add the new option, icon_attribute to the default section of all of the
Fields, and set the value of the option to 1 (see Figure 20).
169
Configuring Genesys
End of procedure
Next Steps
Procedure:
Campaign Synchronization Component 8.0.1: Creating
the Format object
Purpose: To create the Format object.
Start of procedure
1. In Configuration Manager:
Right-click the Format folder under Environment, if you are working in
a multi-tenant environment.
170
Configuring Genesys
171
Procedure:
Campaign Synchronization Component 8.0.1: Copying
the Format object to a Tenant
Purpose: To create a copy of the List Import Format object under each Tenant
that is mapped to a Siebel Organization or Division.
Note: Complete this procedure only if you work in a multi-tenant
environment
Start of procedure
1. In Configuration Manager, under a Tenant that is mapped to a Siebel
Organization or Division, right-click the Formats folder.
2. Select New > Copy of existing Format.
The Browse window displays.
3. Select the Format object you just created.
4. Click OK.
The Properties dialog box appears for the Format copy that you are about
to create.
5. Click OK to copy the Format.
End of procedure
Next Steps
172
Procedure:
Campaign Synchronization Component 8.0.1: Defining
the time zones for a Tenant
Purpose: To define the time zones for a Tenant.
Note: It is also possible to modify the names of the time zones in the Siebel
environment, so that they match the time zone names in the Genesys
environment. The instructions above assume that the Siebel time
zones have been defined first.
If the time zones have been imported into the Genesys environment
while the Genesys Adapter is running (that is, after the deployment of
this Adapter), then you must restart the Genesys Adapter to accept
these changes.
For more information about Time Zone Administration in Siebel, see
your Siebel documentation.
Start of procedure
1. Open both the Siebel and Configuration Manager applications.
2. In Configuration Manager, under a Tenant that is mapped to a Siebel
Organization or Division, right-click the Time Zones folder.
3. Select New > Time Zone.
The new Time Zone window displays.
4. In Siebel, navigate through the Site Map to get to Time Zone
administration, as follows:
Administration - Data > Time Zone Administration
5. In Configuration Manager, select the General tab and enter the values for
the parameters listed below: (To minimize errors, use a cut-and-paste
approach.)
a. In the Name field, enter the exact name of the time zone from the Siebel
environment.
b. In the Description field, enter a brief description of the time zone.
c. In the Offset field, enter the time difference between the local time
and Greenwich Mean Time (GMT).
d. In the Specific Zone Name in Netscape field, enter the time zone name
used by the Netscape Navigator browser.
e. In the Specific Zone Name in Microsoft Explorer field, enter the time
zone name used by Microsoft Explorer.
173
Installation
6. Click OK.
End of procedure
Next Steps
Installation
This section describes the installation process for the Gplus Adapter 8.0.1 for
the Siebel CRM Campaign Synchronization Component. Select one of the
following sections, depending on your environment:
Installing the Campaign Synchronization Component in a Windows
Environment, page 174
Installing the Campaign Synchronization Component in an UNIX
Environment, page 175
Procedure:
Campaign Synchronization Component 8.0.1:
Installing the Component in a Windows environment
Purpose: To install the Campaign Synchronization Component on a Windows
operating system.
Start of procedure
1. To start the installation process, run the setup.exe file from the Campaign
Synchronization Component installation package.
2. In the Welcome window, click Next.
3. In the Configuration Parameters to the Genesys Configuration Server
window, enter the following:
a. The name of the host on which Configuration Server is running.
b. The communication port that client applications must use to connect to
Configuration Server.
c. The user name used to access Configuration Server.
174
Installation
175
Installation
Procedure:
Campaign Synchronization Component 8.0.1:
Installing the Component in an UNIX environment
Purpose: To install the Campaign Synchronization Component on a UNIX
system.
Note: Do not use special symbols in any destination directory name when
3. When prompted, specify the host name, port, user name, and password of
the computer on which the Component will be installedfor example:
a. Enter the host name of Configuration Server.
b. Enter the port of Configuration Server.
c. Enter the user name for Configuration Server.
d. Enter the password for the user name.
4. Choose the Configuration Server environment by its corresponding
number.
5. Specify the Application object that you configured in the previous
procedure, Procedure: Campaign Synchronization Component 8.0.1:
Creating the Application object, on page 157.
6. Specify the full path to the destination directory where you want the
Component to be installed.
The Campaign Synchronization Component is now installed.
In the Gplus Adapter for Siebel CRM program folder in the Start menu,
you can see that the installer created a shortcut for the Campaign
Synchronization Component.
End of procedure
Next Steps
176
Configuring Siebel
Configuring Siebel
This section describes how to configure the Siebel part of the Campaign
Synchronization Component.
Configuring the Siebel section of the Campaign Synchronization Component
consists of the following sub-sections:
Prestart Information, page 177
Configuring Siebel Using the Siebel Tools, page 177
Configuring the Siebel Server, page 200
Configuring Siebel Using the Siebel Web Client, page 203
Prestart Information
Before starting this part of the configuration process, you must make sure to do
the following:
You should be connected to the local copy of the Siebel Server database.
177
Configuring Siebel
Checking Out Existing Projects from the Siebel Repository for the
Campaign Synchronization Component, page 178
Importing the GenSymbolicStrings.sif Archive File, page 179
Importing the Campaign.sif Archive File, page 181
Importing the GenesysCampaignSynchronization.sif Archive File,
page 182
Selecting the Correct Path to the Siebel File System Directory, page 183
Selecting the Page Size in XML-Messages, page 184
Selecting the Phones and Their Types to Export During the Wave
Synchronization, page 186
Selecting the Custom Fields to Export During the Wave Synchronization,
page 187
Customizing the Runtime Events, page 188
Configuring the Site Map of the Application Object, page 196
Configuring the Page Tab of the Application Object, page 197
Compiling the Siebel Repository File, page 199
Procedure:
Campaign Synchronization Component 8.0.1:
Checking out existing projects
Purpose: To check-out existing projects from the Siebel repository.
178
Configuring Siebel
Start of procedure
1. In Object Explorer, start Siebel Tools against the local database.
2. In Siebel Tools, select Tools > Check Out...
The Check Out dialog box displays.
3. In the Projects list, select the Campaign project to be checked-out.
Note: When you first open the Projects list, the Genesys Symbolic Strings
179
Configuring Siebel
Procedure:
Campaign Synchronization Component 8.0.1:
Importing the GenSymbolicStrings.sif archive file
Purpose: To import the mandatory archive file with symbolic strings,
GenSymbolicStrings.sif,that is used across the Siebel archive files provider
within the Adapter.
Notes: The GenSymbolicStrings.sif file must be imported first.
5. Click Next.
The Import WizardReview Conflicts and Actions window displays.
6. Click Next.
The Do you wish to proceed? window displays.
7. Merge any conflicts, if they correspond to your needs.
8. Click Yes.
The objects from the archive are imported into the Siebel repository.
9. Click Finish to complete the import.
End of procedure
180
Configuring Siebel
Next Steps
Procedure:
Campaign Synchronization Component 8.0.1:
Importing the Campaign.sif Archive File
Purpose: To import the Campaign.sif archive file.
Start of procedure
1. In Siebel Tools, select Tools > Import from Archive...
2. In the Select Archive to Import window, navigate to the Campaign.sif
archive file.
This file was created by the installation program in: <target directory>/
objects/<Siebel version> where <Siebel version> is the subfolder name
(/7.7, /8.0, or /8.1), depending on the Siebel version you use.
3. Click Open.
The Import WizardPreview window displays.
4. In the Import WizardPreview window, in the Conflict resolution
section, select Merge the object definition from the archive file with
the definition in the repository.
5. Click Next.
The Import WizardReview Conflicts and Actions window displays.
6. In the Conflicting Objects pane, select the Business Component category.
7. In the Object differences pane, select Campaign List Contact. If there are
any attributes in the Attribute differences pane, make sure that the
Resolution column for each attribute is set to Repository. To do this:
right-click on an attribute and select Repository from the drop-down menu.
8. Click Next.
The Do you wish to proceed? window displays.
9. Click Yes.
The objects from the archive are imported into the Siebel repository.
181
Configuring Siebel
the Siebel environment after importing the archive. This does not
affect the functionality of the Component in any way.
End of procedure
Next Steps
If this project does not exist before export, lock it after the export.
Procedure:
Campaign Synchronization Component 8.0.1:
Importing the GenesysCampaignSynchronization.sif
archive file
Purpose: To import the GenesysCampaignSynchronization.sif archive file for
the Campaign Synchronization Component.
Start of procedure
1. In Siebel Tools, select Tools > Import from Archive...
2. In the Select Archive to Import window, navigate to the
GenesysCampaignSynchronization.sif archive file.
This file was created by the installation program in: target directory>/
objects/<Siebel version> where <Siebel version> is the subfolder name
(/7.7, /8.0, or /8.1), depending on the Siebel version you use.
182
Configuring Siebel
3. Click Open.
The Import WizardPreview window displays.
4. In the Import WizardPreview window, in the Conflict resolution
section, select Overwrite the object definition in the repository.
5. Click Next.
The Import WizardReview Conflicts and Actions window displays.
6. Click Next.
The Do you wish to proceed? window displays.
7. Click Yes.
The objects from the archive are imported into the Siebel repository.
8. Click Finish to complete the import.
Note: It is possible for siebel_assert_xxx.txt files to be generated by
the Siebel environment after importing the archive. This does not
affect the functionality of the component in any way.
End of procedure
Next Steps
Select the correct path to the Siebel File System directory. See, Procedure:
Campaign Synchronization Component 8.0.1: Selecting the correct path to
the Siebel File System directory.
183
Configuring Siebel
Procedure:
Campaign Synchronization Component 8.0.1:
Selecting the correct path to the Siebel File System
directory
Purpose: To provide the proper path to your Siebel File System directory in
the user property named FileSystem of the Genesys Campaign Synchronization
Business Service.
Start of procedure
1. In Siebel Tools, in the Project field of the Object Explorer, select
Genesys Campaign Synchronization2.
184
Configuring Siebel
Procedure:
Campaign Synchronization Component 8.0.1:
Selecting the page size in XML-messages
Purpose: To set the page size in XML-messages.
Start of procedure
1. In Siebel Tools, in the Project field of the Object Explorer, select
Genesys Campaign Synchronization2.
keep in mind that the HTTPSleepTime Siebel parameter for the Genesys
HTTP connection, with a default value of 120000 milliseconds (ms),
should be enough for processing any requests on the Genesys side.
Practically speaking, if a message contains more then 500 records, it
could take a longer time for processing, and in this scenario, the
HTTPSleepTime parameter size should be increased as well. See the
Gplus Adapter for Siebel CRM Users Guide for more details on how
to setup the HTTP connections for the Campaign Synchronization
Component.
End of procedure
185
Configuring Siebel
Next Steps
Procedure:
Campaign Synchronization Component 8.0.1:
Selecting the phones and their type to export during
the wave synchronization
Purpose: To provide the contact phone list that is to be exported during the
wave synchronization.
Start of procedure
1. In Siebel Tools, in the Project field of the Object Explorer, select
Genesys Campaign Synchronization2.
186
Configuring Siebel
Procedure:
Campaign Synchronization Component 8.0.1:
Selecting the custom fields to export during the wave
synchronization
Purpose: To select the custom fields to export during the wave
synchronization.
Start of procedure
1. In Siebel Tools, in the Project field of the Object Explorer, select
Genesys Campaign Synchronization2.
187
Configuring Siebel
Procedure:
Campaign Synchronization Component 8.0.1:
Customizing the runtime events
Purpose: To automatically install or uninstall runtime events and generate
requests when the Genesys-side contact data is modified on the Siebel-side.
188
Configuring Siebel
Start of procedure
1. For each PhoneField and CustomField Business Service user property that
you added in Procedure: Campaign Synchronization Component 8.0.1:
Selecting the custom fields to export during the wave synchronization, on
page 187 and Procedure: Campaign Synchronization Component 8.0.1:
Customizing the runtime events, on page 188, you must determine which
fields of which business component object contains the contact data.
These fields are from the Campaign List Contact business component
object that contains references from the Contact, Employee, List Mgmt
Prospective Contact, and other business component objects. For
examplethe Calculated Home Phone # field value is actually stored in
various locations (as shown in bulleted form below) under the following
syntax
<Business Component>:<Field Name>:
Contact: Home Phone #
Consumer: Home Phone #
Employee: Home Phone #
Person: Home Phone #
User: Home Phone #
List Mgmt Prospective Contact: Home Phone #
2. Add the following code lines into the SetupAllRunTimeEvents method of
the Genesys CampSynch Tools Business Service:
xSetupRunTimeEventWithPA(<BusCompName>, "PreSetFieldValue",
<FieldName>, 1, <PrevVarName>, <FieldName>, sMethodName,
bDebugLog);
xSetupRunTimeEventWithPA(<BusCompName>, "SetFieldValue",
<FieldName>, 1, <VarName>, <FieldName>, sMethodName, bDebugLog);
where:
<BusCompName>: is the name of the required business component
<FieldName>: is the name of the required field
<PrevVarName> and <VarName>: are the names of the global variables
where both the previous and the new field values are stored when they
are modified.
3. Add the following code lines into the Contact_WriteRecord method of the
Genesys CampSynch Event Handler Business Service:
var <local_prev_variable_name> =
TheApplication().GetProfileAttr(<PrevVarName>);
var <local_variable_name> =
TheApplication().GetProfileAttr(<VarName>);
189
Configuring Siebel
(sPrevWork != sWork) ||
(<local_prev_variable_name> != <local_variable_name>) ||
(sPrevTZ
!= sTZ) )
Procedure:
Campaign Synchronization Component 8.0.1: Example
of a runtime event customization
Purpose: To illustrate an example of a runtime event customization for the
Campaign List Contact business component Calculated Fax Phone # field.
Start of procedure
1. In Siebel Tools, in the Project field of the Object Explorer, select All
Projects.
190
Configuring Siebel
5. Select the Fax Phone # and Prospect Fax Phone # fields (see Figure 22
and Figure 23).
191
Configuring Siebel
Both Figure 22 and Figure 23 display the Join column. The Join column
displays the foreign key relationship between the joined table and the
business components base table, which means that for every record in the
business component that corresponds to a row in the base table there can
be a corresponding row in the joined table. The Fax Phone # and Prospect
Fax Phone # fields are accessible through this Join columnfor example,
a join uses the foreign key relationship to make the Fax Phone # data in
the Name column available to the S_CONTACT table and to also make the
Prospect Fax Phone # data in the Name column and the FAX_PH_NUM data in
the Column column available to the S_PRSP_CONTACT table.
6. For the Fax Phone # field name, search through the Contact, Consumer,
Employee, Person, and User business components and locate the field names
that use the FAX_PH_NUM table column, which is found under the Column
column.
For example in Figure 24 on page 193, the corresponding field name for
the Contact business component is Fax Phone #. The corresponding field
names for the other business component are listed as follows:
Consumer: Fax Phone #
Employee: Fax #
Person: Fax Phone #
User: Fax #
Note: The field names may vary from one business component to another.
192
Configuring Siebel
7. For the Prospect Fax Phone # field name, search through the List Mgmt
Prospective Contact business component and locate the Fax Phone # field
name that uses the FAX_PH_NUM table column, which is found under the
Column column.
8. Edit the code for the SetupAllRunTimeEvents method of the Genesys
CampSynch Tools Business Service. The new lines of code are highlighted
below as Bold:
function SetupAllRunTimeEvents(sMethodName, bDebugLog)
{
xSetupRunTimeEventWithPA("Contact", "PreSetFieldValue",
Phone #",
1, "paContact_PrevWork", "Work Phone #",
sMethodName, bDebugLog);
xSetupRunTimeEventWithPA("Contact", "SetFieldValue",
Phone #",
1, "paContact_Work",
"Work Phone #",
sMethodName, bDebugLog);
xSetupRunTimeEventWithPA("Contact", "PreSetFieldValue",
Phone #",
1, "paContact_PrevFax", "Fax Phone #",
sMethodName, bDebugLog);
xSetupRunTimeEventWithPA("Contact", "SetFieldValue",
Phone #",
1, "paContact_Fax",
"Fax Phone #",
sMethodName, bDebugLog);
xSetupRunTimeEventWithPA("Contact", "PreSetFieldValue",
Zone Id",
1, "paContact_PrevTZ",
"Time Zone Id",
sMethodName, bDebugLog);
"Work
"Work
"Fax
"Fax
"Time
193
Configuring Siebel
xSetupRunTimeEventWithPA("Contact", "SetFieldValue",
"Time
Zone Id",
1, "paContact_TZ",
"Time Zone Id",
sMethodName, bDebugLog);
.
xSetupRunTimeEventWithPA("Consumer", "PreSetFieldValue", "Work
Phone #",
1, "paContact_PrevWork", "Work Phone #",
sMethodName, bDebugLog);
xSetupRunTimeEventWithPA("Consumer", "SetFieldValue",
"Work
Phone #",
1, "paContact_Work",
"Work Phone #",
sMethodName, bDebugLog);
xSetupRunTimeEventWithPA("Consumer", "PreSetFieldValue", "Fax
Phone #",
1, "paContact_PrevFax", "Fax Phone #",
sMethodName, bDebugLog);
xSetupRunTimeEventWithPA("Consumer", "SetFieldValue",
"Fax
Phone #",
1, "paContact_Fax",
"Fax Phone #",
sMethodName, bDebugLog);
194
Configuring Siebel
xSetupRunTimeEventWithPA("Person", "SetFieldValue",
"Time
Zone Id",
1, "paContact_TZ",
"Time Zone Id",
sMethodName, bDebugLog);
195
Configuring Siebel
var sPrevWork =
TheApplication().GetProfileAttr("paContact_PrevWork");
var sWork
=
TheApplication().GetProfileAttr("paContact_Work");
var sPrevFax =
TheApplication().GetProfileAttr("paContact_PrevFax");
var sFax
= TheApplication().GetProfileAttr("paContact_Fax");
var sPrevTZ
=
TheApplication().GetProfileAttr("paContact_PrevTZ");
var sTZ
= TheApplication().GetProfileAttr("paContact_TZ");
if ( (sPrevDNC != sDNC) ||
(sPrevHome != sHome) ||
(sPrevWork != sWork) ||
(sPrevFax != sFax) ||
(sPrevTZ
!= sTZ) )
TheApplication().SetProfileAttr("paContact_PrevWork","");
TheApplication().SetProfileAttr("paContact_Work","");
TheApplication().SetProfileAttr("paContact_PrevFax","");
TheApplication().SetProfileAttr("paContact_Fax","");
TheApplication().SetProfileAttr("paContact_PrevTZ","");
TheApplication().SetProfileAttr("paContact_TZ","");
End of procedure
Next Steps
Add the Genesys Administration screen to the Page tab of the Application
object that you are using. See, Procedure: Campaign Synchronization
Component 8.0.1: Configuring the Page tab of the Application object.
Procedure:
Campaign Synchronization Component 8.0.1:
Configuring the Site Map of the Application object
Purpose: To configure the Site Map of the Application object.
196
Configuring Siebel
Start of procedure
1. Check-out or lock the project that corresponds to the Application object
that you are using. See, Procedure: Campaign Synchronization Component
8.0.1: Checking out existing projects, on page 178
2. In Siebel Tools, in the Project field of the Object Explorer, select the name
of the project of the Siebel application that you are usingfor example,
Siebel Universal Agent.
3. Select the Application folder.
The Application window displays.
4. Select the Application object that you are using.
5. Using the Types tab of the Object Explorer, select the Screen Menu Item
folder under the Application folder.
The Application Screen Menu Items window displays.
6. Add a new record into the Screen Menu Items table using the following
column values listed in Table 11.
Table 11: The Column Values for the Screen Menu Items Table
Column
Value
Comment
Screen
Genesys Administration
Sequence
<positive number>
Text-String Reference
X_GEN_GENESYS_
ADMINISTRATION
End of procedure
Next Steps
Add the Genesys Administration screen to the Page tab of the Application
object that you are using. This procedure is optional. See, Procedure:
Campaign Synchronization Component 8.0.1: Configuring the Page tab of
the Application object.
197
Configuring Siebel
Procedure:
Campaign Synchronization Component 8.0.1:
Configuring the Page tab of the Application object
Purpose: To configure the Page tab of the Application object, if you need a
permanent Page tab for the Campaign Synchronization administration. This
procedure is optional.
Start of procedure
1. Check-out or lock the project that corresponds to the Application object
that you are using. See, Procedure: Campaign Synchronization Component
8.0.1: Checking out existing projects.
2. In Siebel Tools, in the Project field of the Object Explorer, select the
name of the project of the Siebel application that you are usingfor
example: Siebel Universal Agent.
3. Select the Application folder.
The Application window displays.
4. Select the Application object that you are using.
5. Using the Types tab of the Object Explorer, select the Page Tab folder
under the Application folder.
The Application Page Tabs window displays.
6. Add a new record into the Page Tabs table using the following column
values listed in Table 12:
Table 12: The Column Values for the Page Tabs Table
Column
Value
Comments
Screen
Genesys Administration
Sequence
<positive number>
TextString
Reference
X_GEN_GENESYS_ADMINISTRATION
End of procedure
198
Configuring Siebel
Next Steps
Procedure:
Campaign Synchronization Component 8.0.1:
Compiling the Siebel Repository File
Purpose: To compile the Siebel repository file.
Start of procedure
1. In Siebel Tools, select Tools > Compile Projects...
2. Select Locked projects.
3. In the Siebel Repository File edit box, enter the name of the repository
file.
4. Click Compile.
The status bar at the bottom of the Object Compiler window indicates
when the compilation is finished.
5. When the compilation is finished, close Siebel Tools.
Note: It is possible for siebel_assert_xxx.txt file(s) to be generated by
Configure the Siebel Server. See the section, Configuring the Siebel
Server.
199
Configuring Siebel
Procedure:
Campaign Synchronization Component 8.0.1:
Configuring the Siebel Server
Purpose: To configure the Siebel Server to work with the Campaign
Synchronization Component.
Start of procedure
Deploying the new
Genesys Projects
Creating Genesys
Project Tables on
the Siebel Server
Database
200
Configuring Siebel
g. Click Finish.
h. In Siebel Tools, in the Project field of the Object Explorer, select
Genesys Campaign Synchronization2.
i. Select the Table folder.
The Tables window appears, displaying the four newly added tables.
j. Click Apply.
A pop-up warning appears.
k. Click OK to accept the warning.
l. In the new Apply Schema window, from the Tables drop-down list,
select Current Query.
m. Enter the correct values for the Database user, Database user password
and ODBC data source.
For more information about creating custom tables, see the Siebel
documentation.
n. Click Apply to start the creation process.
The Changes successfully applied message appears, indicating that
the tables were created.
o. Click Activate to activate these tables.
Deploying the
Repository File
201
Configuring Siebel
4. To deploy the new images to the Siebel Server, copy the image files from
the following folder, <target>/objects/IMAGES, to the corresponding
Siebel Web Server extension folder,
(<SWEApp>/public/<language_code>/images).
End of procedure
Next Steps
202
Configure Siebel using the Siebel Web Client. See section, Configuring
Siebel Using the Siebel Web Client on page 203.
Configuring Siebel
Procedure:
Campaign Synchronization Component 8.0.1:
Importing the List of Values and the Application, Views
data
Purpose: To import the List of Values and the Application, Views data for the
Campaign Synchronization Component.
Start of procedure
1. Log in as a Siebel administrator.
2. Select Site Map > Administration > Business Service, Simulator.
3. Create new record and specify Genesys CampSync Tools as the Service
Name.
203
Configuring Siebel
6. In the Input Arguments applet, click the Load From File button, browse for
the following target directory, <target
directory>/objects/<LANG>/GplusCaS_LOV.xml, where <LANG> is the
subfolder name (ENU, by default) depending on the Siebel locale you use.
7. Load the GplusCaS_LOV.xml file.
8. Click the Run on the Service Methods applet.
9. Check the results of the import in the Output Arguments applet.
End of procedure
Next Steps
Procedure:
Campaign Synchronization Component 8.0.1:
Deploying workflow processes on the Siebel Server
Purpose: To deploy the workflow processes on the Siebel Server.
Start of procedure
1. Select Site Map > Administration > Business Process, Workflow
Deployment.
2. In the Active Workflow Processes applet, choose the Import Processes
menu option.
The Workflow Process Import pop-up window displays.
3. In the Workflow Process Import window, select the
Genesys_CaS_Campaign_WF.xml file. This file is created by the installation
program in the following location: <target directory>/ objects/<Siebel
version> where <Siebel version> is the subfolder name (7.7, 8.0, or 8.1),
depending on the Siebel version you use.
204
Configuring Siebel
4. Click Import.
The Genesys CaS Campaign WF process appears in the applet when the
import is finished.
5. Repeat steps 3 and 4 for the Genesys_CaS_CR_WF.xml file. The Genesys CaS
CR WF process appears when the import is finished.
End of procedure
Next Steps
Procedure:
Campaign Synchronization Component 8.0.1: Creating
the runtime events
Purpose: To create the runtime events that are required by the Campaign
Synchronization Component.
Start of procedure
1. Select Site Map > Administration > Business Service, Simulator.
2. In the Service Methods applet, create a new record.
3. Specify the following parameters for the new record:
Service Name: Genesys CampSynch Tools
Method Name: InstallRunTimeEvents
Iterations: 1
205
Configuring Siebel
4. Click Run.
Note: No results are propagated through the Output Arguments applet.
End of procedure
Next Steps
Procedure:
Campaign Synchronization Component 8.0.1:
Assigning the correct responsibility to an agent
Purpose: To assign the correct responsibility to an agent that is dedicated to
managing the campaign synchronization process.
Start of procedure
1. Select Site Map > Administration > Application, Responsibilities.
2. On the Responsibilities applet, select the Genesys CampSynch
Administrator responsibility.
206
Configuring Siebel
3. Add the required agents by using the Users applet on the Responsibilities
tab.
Note: The assigned agents should have permission to access and create
Profile Configurations (Site Map > Administration > Server
Configuration, Profile Configuration). These procedures are
Restart the Siebel Server. See the section, Restarting the Siebel Server.
207
208
Configuring Siebel
Chapter
The Voice Component functionality can be used in any or all of the following
configurations:
209
Overview
See the Gplus Adapter 8.0 for Siebel CRM Users Guide for additional
information about using this component.
Before you add any other driver-based Adapter Components, you must
configure the Voice Component, including all of the Voice features that you
intend to use.
Notes: Server-based components, such as Campaign Synchronization and
Basic Voice
Expert Contact
Outbound Campaign
Overview
The Gplus Adapter 8.0 for Siebel CRM Voice Component provides a single,
consistent user interface for customer relationship management, telephony
control, outbound-campaign calls, expert contact, and voice callback
functionality.
Basic Voice
The Basic Voice feature is intended for call centers that work with inbound
calls. This feature must be imported first, because it defines the Genesys Voice
Project in Siebel.
210
Overview
Expert Contact
The Expert Contact feature serves to establish connections with associates,
known as experts or knowledge workers, who are not regular call center
agents, and whose phones are not directly monitored by T-Server. Usually this
expert is a person who has the advanced skills required to handle specific
customer requests, or to solve customer problems. The expert has the option to
preview data about an incoming call in Preview Interaction mode, and to
manually notify the CTI-less T-Server about an incoming call and the progress
of that call. Because the T-Server has no CTI-link to the switch, it does not
necessarily receive notification of the experts phone interactions, so the expert
must use the Agent Desktop Toolbar to manually update the status of the
interaction.
For additional details about Expert Contact, refer to the Genesys Expert
Contact 7 Getting Started Guide, or the Genesys Expert Contact 7 Deployment
Guide.
Outbound Campaign
The Outbound Campaign feature is intended for call centers that primarily
work with outbound campaign calls. It supports Genesys Outbound Desktop
Protocol version 7.0. The Outbound Campaign feature provides integration of
Siebel CRM with the Genesys Outbound Contact Server capabilities. The
Outbound Campaign feature operates with the Voice Component and
implements full functionality of the Outbound Contact desktop on the Siebel
CRM Communications Toolbar for outbound campaign functionality. For more
information about the Siebel CRM Communications Toolbar, see the Gplus
Adapter 8.0 for Siebel CRM Users Guide.
Universal Callback
The Universal Callback feature is used with the Voice Component to provide
voice and web callback functionality. For exampleusing voice callback
functionality in your company's Call Center IVR, a customer can request that a
representative from your company call the customer back. The customer
simply selects the Call Back option in the IVR menu and then enters a
telephone number with an approximate callback time. In the section titled
Checking the Voice Callback Installation on page 304, Voice Callback
scenarios provide additional details about using this feature.
Each incoming voice callback interaction creates an activity record in the
Siebel application and a new work item on the agent Communications Toolbar.
The Description field from the activity record is used for storing user data
fields passed from the Universal Callback Server. The set of user data fields
that are stored can be modified to meet contact center requirements.
211
Release 8.0.0
Support for the Push Preview dialing mode for Outbound Campaigns.
Support for the Red Hat Enterprise Linux (RHEL) operating system.
Installation
This section describes the installation process for the Gplus Adapter 8.0 for
Siebel CRM Voice Component. The Gplus Adapter can be installed on
Windows or UNIX platforms. On UNIX, you can use either Solaris or AIX.
Select one of the following sections depending on your environment:
Installing the Voice Component in a Windows Environment, page 214
Installing the Voice Component in an UNIX Environment, page 215
Procedure:
Voice Component: Installing the Voice Component
Purpose: To install the Voice Component.
Start of procedure
1. Install the Gplus Adapter from the installation package.
2. Using Genesys Configuration Manager, update the Genesys configuration
and collect the required information.
3. Using Siebel Tools, import the Siebel repository file (*.srf) archive files
from the installation package.
4. Customize the Siebel Communications Toolbar.
5. Recompile the Siebel *.srf file.
6. Deploy the Siebel *.srf file on the Siebel Server.
212
Installation
Install the Gplus Adapter 8.0 for Siebel CRM Voice Component. Select
one of the following sections, depending on your environment:
Installing the Voice Component in a Windows Environment on
page 214
Installing the Voice Component in an UNIX Environment on
page 215
Setup Types
This version of the Adapter is compatible with the following versions of Siebel
CRM Server: 7.7, 7.8, 8.0, and 8.1.
For information about the files that you install and their location, see the
section Target Directory Structure and File Locations.
213
Installation
by the installation script to copy the Adapter for Siebel CRM Voice files.
<Web Server Host> is the Web Server host name where the Siebel Web
images directory.
Communication Server.
Procedure:
Voice Component: Installing the Voice Component in a
Windows environment
Purpose: To install the Voice Component in a Windows environment.
Start of procedure
1. Run the setup.exe file from the installation package (windows\setup.exe).
2. When prompted with the following message, Genesys Installation
Wizard will install the Gplus Adapter for Siebel CRM Voice in the
following Destination Folder, choose the location of this destination
folder.
For example:
C:\Program Files\GCTI\Gplus Adapter for Siebel CRM Voice
4. When the Genesys Installation Wizard completes its execution, you must
manually copy the following files to their proper locations:
214
Installation
Copy the files representing the Siebel icon images from the destination
directory, <Destination Directory>/<Siebel Version>/images/, where
<Siebel Version> is 7.7/8.0/8.1 depending on your version of Siebel
Server, to the following icon images directory, < Web Server
Host>/<SWEIconImages directory>.
Configure the Genesys part of the Voice Component. See the section,
Configuring Genesys on page 218.
215
Installation
libsocket.so
libnsl.so
libdl.so
librt.so
libpthread.so
libm.so
libc.so
libmp.so
libaio.so
libthread.so
libc_psr.so
Follow the instructions under the heading, Running the Installation Shell
Script on page 217 to continue with the installation process.
libpthreads.a
libC.a
libc.a
librtl.a
libcrypt.a
Follow the instructions under the heading, Running the Installation Shell
Script on page 217 to continue with the installation process.
216
libdl.so
libm.so
libgcc_s.so
libc.so
libpthread.so
libstdc++.so
ld-linux.so
Installation
Follow the instructions under the heading, Running the Installation Shell
Script to continue with the installation process.
Procedure:
Voice Component: Running the installation shell script
Purpose: To install the Voice Component in Solaris, AIX, or Linux.
environments.
Start of procedure
1. Stop the Gplus Communication Server.
2. At the Solaris, AIX, or Linux prompt, execute the install.sh file.
3. When prompted with the message, Please enter the full path to your
Gplus Communication Server for Siebel CRM directory =>, enter the full
path to the Gplus Communication Server for Siebel CRM installation
directoryfor example:
/data/GplusCommunicationServerFolder
217
Configuring Genesys
Depending on your version of the Siebel Server, copy the files representing
icon images from <Destination Directory>/<Siebel Version>/images/ to
the following directories:
< Web Server Host>/< SWEIconImages directory >
for the Ready/Not Ready buttons. During the installation process, the
standard Siebel icons for the Not Ready button are overwritten with
new ones from the installation package. To preserve the standard
Siebel icons, Genesys recommends that you back-up the following
image files, icon_notready_enabled.gif and icon_notready_disabled.gif,
in a safe location. These files should be restored manually, if the
Gplus Adapter is uninstalled.
End of procedure
Next Steps
Configure the Genesys part of the Voice Component. See the section,
Configuring Genesys on page 218.
Configuring Genesys
This section describes the configuration of the Genesys requirements of the
Voice Component. It includes information and instructions for configuring the
Voice Component functionality.
Configuring the Genesys section of the Voice Component consists of the
following sections:
Prestart Information, page 218
Modifying Genesys Settings, page 219
Prestart Information
Before starting the configuration process for each Gplus Adapter component or
feature listed below, you must have the listed applications installed and
running:
218
Configuring Genesys
Configuration Database
Configuration Server
Configuration Manager
T-Servers
CTI-Less T-Server
Universal Router
219
Configuring Genesys
Procedure:
Voice Component: Modifying Genesys Outbound
Contact Server settings
Purpose: To modify the Genesys Outbound Contact Server settings.
Start of procedure
1. In Configuration Manager, select Environment > Applications and
right-click the Outbound Contact Server Application.
2. Select Properties.
The Properties dialog box displays.
3. Select Options > OCServer (see Figure 26).
To change the default value of the key, double-click the line you want to
change:
login_action > hard_not_ready
outbound_release_action > hard_not_ready
220
Configuring Genesys
221
Configuring Genesys
222
Configuring Genesys
Procedure:
Voice Component: Setting the GSW_ATTEMPTS
attribute
Purpose: To set the GSW_ATTEMPTS attribute.
Start of procedure
1. In Configuration Manager, select the section Formats, used by your
campaign.
2. Browse to the appropriate Format record.
3. Right-click the Attempt field and select Properties from the shortcut
menu.
4. Select the Annex tab.
5. Create the section default and under this section, create a new record
called send_attribute = GSW_ATTEMPTS (see Setting the Send Attribute
Values in the Calling List Format on page 222).
6. Click OK to save the record.
End of procedure
Next Steps
Gather the Genesys settings. See the section, Gathering the Genesys
Object Settings on page 224.
223
customer ID. The name of the Calling List tables fields that are used for the
customer ID is defined by the configuration option, customer_id (see the
section, Specifying the Do Not Call Command Attribute Keys on
page 294). If this option is not present in the calling list or the Application
object, or if it contains a field name that does not exist in the Calling List
table, by default, Outbound Contact Server uses the phone number to
determine the records that should not be dialed.
installation.
The specific Genesys data that you require depends on the Gplus Adapter
components and features that you plan to implement for your Contact Center.
The data requirements for each configuration are listed as follows under the
corresponding headings below:
Data Required for All Voice Configurations, page 224
Basic Voice Feature Data, page 225
Expert Contact Feature Data, page 226
Outbound Campaign Feature Data, page 226
Outbound Contact Server Configuration Parameters, page 226
Universal Callback Feature Data, page 229
224
Procedure:
Voice Component: Finding the T-Server connection
information
Purpose: To find the T-Server connection information.
Start of procedure
1. In Configuration Manager, open the Environment view and then select the
Applications view.
2. From the toolbar, click New.
3. In the Browse dialog box, select the Application Template for this
application (navigating to the appropriate folder, if necessary), and click
OK.
4. On the Configuration tab, enter the following information for the T-Server
application configured for use with Outbound Contact Server:
Name: Enter the name of the T-Server application.
Connections: Click Add, and then add the T-Server application.
5. Open the T-Server applications Properties dialog box.
6. Click the Server Info tab.
7. In the Server Info section, enter the following T-Server connection
information (which you will need later for the Gplus Outbound Campaign
feature and for configuring the Siebel Call Center application):
Host: Host name
Communication port: Communication port number
End of procedure
Next Steps
225
Procedure:
Voice Component: Finding the ACD Queue/PBX data
information
Purpose: To find the Outbound Contact Server (OCS) ACD (automatic call
distribution) Queue/PBX (switch) information.
226
Start of procedure
1. In Configuration Manager, select Tenant > Agent Groups or Tenant >
Place Groups.
227
5. From the Origination DNs pane, make note of the ACD Queue/PBX
information, which is used later for the Gplus Voice Component
configuration.
For example, in Figure 28 on page 227, the Origination DNs information
required includes: DN Number (8000), Type (ACD Queue), Switch
(SwitchG3). For further information, see Configuring Siebel Using the
Siebel Web Client on page 245 and Procedure: Voice Component:
Associating agents with an existing Communications profile and Genesys
settings, on page 260.
End of procedure
Next Steps
Find and record the current version of Outbound Contact Server (OCS).
See, Procedure: Voice Component: Finding the current version of
Outbound Contact Server (OCS), on page 228.
Procedure:
Voice Component: Finding the current version of
Outbound Contact Server (OCS)
To find and record the current version of Outbound Contact Server (OCS) that
you use:
Start of procedure
1. Start at the command prompt window from Windows, or from a terminal
window in UNIX.
2. Navigate to the OCS installation home folder (for exampleC:\GCTI\OCS
on the Windows platform).
3. Run the Outbound Contact Server executable with the -V switch:
> ocs_server -V
228
Configure the Siebel side of the Voice Component. See the section,
Configuring Siebel on page 229.
Configuring Siebel
Configuring Siebel
This section describes how to configure the Siebel part of the Voice
Component for Siebel CRM.
Configuring the Siebel section of the Voice Component consists of the
following steps:
Prestart Information, page 229
Configuring Siebel Using Siebel Tools, page 230
Configuring Siebel Using the Siebel Web Client, page 245
Prestart Information
Before starting this part of the configuration process, you should have the
following Siebel CRM and Genesys Gplus applications installed and running:
Siebel CRM Applications
You should be connected to the local copy of the Siebel Server database.
229
Configuring Siebel
To use the Outbound Campaign feature and the Outbound Contact Server
product, you must have the Siebel eMarketing application installed.
230
Configuring Siebel
The Voice Component features and their associated *.sif files are listed in
Table 13 on page 231. The *.sif files are provided with the Gplus Adapter
installation disk.
Note: Depending on the Siebel Server version, the appropriate *.sif files
Basic Voice
Genesys Tools
GenesysTools.sif
Expert Contact
GenComm_ECS.sif
Outbound Campaign
GenComm_OCS.sif *
Universal Callback
GenComm_VCB.sif
231
Configuring Siebel
Procedure:
Voice Component: Checking out existing projects
Purpose: To check-out existing projects from the Siebel repository.
Start of procedure
1. In Object Explorer, start Siebel Tools against the local database.
2. In Siebel Tools, select Tools > Check Out...
The Check Out dialog box displays.
3. Select Project category.
4. In the Projects list, select the appropriate projects listed below in Table 14,
Projects for All Supported Siebel Versions - Common for all Components
and Feature-Specific, on page 233.
Select the projects to be locked based on the features you want to
install:
i. Always lock the projects that are common to all components.
ii. In addition, lock any other projects that are specific to the features
you are installing.
Note: When you first open the Projects list, the Genesys Voice, Genesys
Tools, and Genesys Symbolic Strings projects do not yet exist, so are
not available to be checked-out and locked.
The project named Genesys Symbolic Strings is created when you
import the GenSymbolicStrings.sif file, as explained in Procedure:
Voice Component: Importing the GenSymbolicStrings.sif archive
file, on page 234. Lock the project after importing the
GenSymbolicStrings.sif file.
The project named Genesys Voice is created when you import the
GenComm.sif file, as explained in Procedure: Voice Component:
Importing the GenComm.sif archive file, on page 236 below. Lock
the project after importing the GenComm.sif file.
The project named Genesys Tools is created when you import the
GenesysTools.sif file, as explained in Procedure: Voice
Component: Importing the GenesysTools.sif archive file, on
page 237. Lock the project after importing the GenesysTools.sif
file.
232
Configuring Siebel
Table 14: Projects for All Supported Siebel Versions - Common for all Components
and Feature-Specific
Feature
Archive File
Common Projects
(for all components)
Feature-Specific
Projects
Basic Voice
GenSymbolicStrings.sif
Command
Genesys Voice*
GenComm.sif
Communication
Genesys Tools*
GenesysTools.sif
Communication
Administration
Employee*
Expert Contact
GenComm_ECS.sif
Outbound Campaign
GenComm_OCS.sif
Universal Callback
GenComm_VCB.sif
Persistent Customer
Dashboard
Genesys Symbolic
Strings
None
Campaign
Activity
Contact
Contact (SSE)
Table Activity
<Project related to an
application on which
the Adapter is
deployed with the
Universal Callback
feature >**
Import the Voice Component *.sif archive files. See the section,
Importing the Voice Component (*.sif) Archive Files.
233
Deployment Order
Configuring Siebel
There is one limitation on the order in which you deploy the *.sif filesyou
must first install the GenSymbolicStrings.sif file, and then install the
GenComm.sif file. These two files provide the Basic Voice functionality, and are
both mandatory for any and all configurations.
The deployment of the GenesysTools.sif file is mandatory as it used during the
configuration of the Siebel Call Center application.
There are no restrictions on the order in which you deploy the rest of the
archive files. These other files are technically optional, so there is no
restriction on the order of their deployment. Each archive file is responsible for
a particular features functionality.
Before importing the mandatory *.sif files, you must check-out and lock the
existing projects from the Siebel repository. See the section, Checking Out
Existing Projects from the Siebel Repository for the Voice Component.
Procedure:
Voice Component: Importing the
GenSymbolicStrings.sif archive file
Purpose: To import the mandatory archive file with symbolic strings,
GenSymbolicStrings.sif, that is used across the Siebel archive files provider
within the Adapter.
Notes: The GenSymbolicStrings.sif file must be imported first.
234
Configuring Siebel
Note: In the Conflict resolution area, the Merge the object definition
from the archive file with the definition in the repository
235
Configuring Siebel
Procedure:
Voice Component: Importing the GenComm.sif archive
file
Purpose: To import the mandatory GenComm.sif archive file.
Note: If the Genesys Tools project already exists in your Siebel repository
For UNIX:
<Destination directory>/<Siebel Version>
3. Click Open.
The Import WizardPreview window appears (see Figure 29 on page 235).
4. Resolve any Siebel application data conflicts. Refer to Table 15 on
page 239 to see which Voice Component features have conflicts that need
to be resolved. See, Procedure: Voice Component: Resolving the Siebel
application data conflicts, on page 239.
End of procedure
236
Configuring Siebel
Next Steps
Procedure:
Voice Component: Importing the GenesysTools.sif
archive file
Purpose: To import the GenesysTool.sif archive file.
Note: If the Genesys Tools project already exists in your Siebel repository
If you are importing the *.sif files for the selected optional Voice
Component features, see, Procedure: Voice Component: Importing the *.sif
files for the selected optional Voice Component features, on page 238.
If you are not importing anymore optional *.sif files, you must resolve
any outstanding Siebel application data conflicts. See, Procedure: Voice
Component: Resolving the Siebel application data conflicts, on page 239.
237
Configuring Siebel
Procedure:
Voice Component: Importing the *.sif files for the
selected optional Voice Component features
Purpose: To import the *.sif files for the selected optional Voice Component
features.
Note: If you are deploying the Universal (Voice) Callback feature, see for
Resolve the conflicts between the Siebel application for which the *.sif
file was originally prepared and the Siebel application on which the *.sif
file is deployed. See the section, Resolving Siebel Application Data
Conflicts.
238
Configuring Siebel
Conflicts between the Siebel application for which the *.sif file was
originally prepared and the Siebel application on which the *.sif file is
deployed may require resolution. Table 15 displays the Voice Component
features with the conflicts that need to be resolved.
Table 15: Features with Conflicts to be Resolved
Feature
Voice Component
archive (.sif) file
Conflict with
Gplus
Components
Conflict with
Siebel
Applications
New Table
Fields
Basic Voice
GenComm.sif
No
Yes
No
GenesysTools.sif
No
No
No
GenSymbolicStrings.sif
No
No
No
Expert Contact
GenComm_ECS.sif
No
No
No
Outbound Campaign
GenComm_OCS.sif
No
Yes
No
Universal Callback
GenComm_VCB.sif
No
Yes
Yes
Procedure:
Voice Component: Resolving the Siebel application
data conflicts
Purpose: To resolve the Siebel application data conflicts that are created
during *.sif file import process.
Start of procedure
1. Start first with the GenCom.sif file and then each additional Voice
Component feature that you wish to implement. Repeat the conflict
resolution steps below, substituting for the GenComm.sif file, the *.sif file
associated with that optional Voice Component feature that you
implemented. Refer to Table 15 on page 239 to check which Voice
Component features have conflicts.
2. Click Next on the Import WizardPreview window (see Figure 29 on
page 235).
The Review Conflicts and Actions screen displays.
3. In the Review Conflicts and Actions screen, from the Conflicting
Objects panel, navigate to Business Component, and select it so that the list
of business components appears.
239
Configuring Siebel
240
Configuring Siebel
Compile the Siebel repository file. See the section, Compiling the Siebel
Repository File on page 241.
an appropriate field. You must ensure that after importing new toolbar
items there are no conflicts for the position field that appears. Siebel
does not check this, and conflicts may cause issues with the
communications toolbar appearance.
Importing the primary Voice Component file, GenComm.sif, creates the
fundamental Siebel Communications Toolbar. Each of the other Voice
241
Configuring Siebel
Component archive files that you import modifies the toolbar, as applicable,
for the corresponding Voice Component features.
Note: As with the Voice Component archive files, each of the other Gplus
Procedure:
Voice Component: Compiling the Siebel repository file
Purpose: To compile the Siebel repository file.
Start of procedure
1. In Siebel Tools, select Tools > Compile Projects.
2. Select Locked projects.
3. In the Siebel Repository File edit box, select the name of the repository
file.
4. Click Compile.
The status bar at the bottom of the Object Compiler window indicates
when the compilation is finished.
5. When the compilation is finished, close Siebel Tools.
Note: A siebel_assert_xxx.txt file may be generated by the Siebel
242
If you are deploying the Universal Callback feature, update the new tables
in the Genesys project server database. See the section, Updating the
S_EVT_ACT_X Table in the Genesys Project Server Database on
page 243.
If you are not deploying the Universal Callback feature, deploy the Siebel
repository file. See, Deploying the Repository File on page 244.
Configuring Siebel
Procedure:
Voice Component: Checking-in the Table Activity
project changes to the Siebel Server repository
Purpose: To check-in the changes made to the Table Activity project.
Start of procedure
1. In Siebel Tools, select Tools > Check In.
The Check In dialog box displays.
2. In the Projects list, select the following project:
Table Activity
Apply the changes to the Siebel database tables. See, Procedure: Voice
Component: Applying changes to the Siebel database tables.
Procedure:
Voice Component: Applying changes to the Siebel
database tables
Purpose: To update the database table, S_EVT_ACT_X, on the local Siebel
database (or on a Siebel Server database).
Start of procedure
1. Connect Siebel Tools to the server database.
2. In Siebel Tools, in the Object Explorer, navigate to the Table object.
3. Navigate to the List of Tables pane.
4. Locate the S_EVT_ACT_X table.
5. Click Apply.
243
Configuring Siebel
Deploy the Siebel repository file. See the section, Deploying the
Repository File.
Procedure:
Voice Component: Deploying the repository file
Purpose: To deploy the updated *.srf file.
Start of procedure
1. To deploy the *.srf file, stop the Siebel Server.
2. Copy the new repository file to a specific location within the server
installation.
3. Restart the server.
244
Configuring Siebel
4. Additionally, you may have to generate and deploy browser scripts for the
new repository file (see the section, Scripts on page 645).
For further information on deploying an updated repository file to the
Siebel Server, refer to Siebel documentation.
End of procedure
Next Steps
Configure the Siebel Call Center application. See the section, Configuring
Siebel Using the Siebel Web Client.
245
Configuring Siebel
Procedure:
Voice Component: Importing the List of Values table
Purpose: To import the List of Values table for the Voice Component.
Start of procedure
1. Log in as a Siebel administrator.
2. Open the Site Map, then navigate to Administration - Business Service,
Simulator.
3. Specify Genesys Tools as the Service Name.
4. Specify ImportAll as the Method Name.
5. Set Iterations to the value of 1.
6. In the Input Arguments applet, click the Load From File button, browse for
<InsDir>/<Siebel Version>/GenComm_LOV.xml and load this file as shown
in Figure 30.
246
Configuring Siebel
7. Click Run on the Service Methods applet. The import results can be
checked in the Output Arguments applet.
If only the Voice
Component is
Deployed
Create a list of the reason code values for the Basic Voice feature. See,
Procedure: Voice Component: Creating a list of the reason code values for
the Basic Voice feature.
Procedure:
Voice Component: Creating a list of the reason code
values for the Basic Voice feature
Purpose: To create a list of the reason code values for the Basic Voice feature.
Start of procedure
Creating a New
List of Values Type Record
1. Navigate to the List of Values - Type table, using the Siebel Tools,
choose the Screens application menu, choose System Administration, and
then the List of Values menu item.
2. Create a new record in the List of Values - Type applet.
3. Specify the following parameters for the new record:
Type: REASON_CODE
Translate: Selected
Leave the default values for all other fields.
4. Save the new record.
247
Adding Reason
Code Values
Configuring Siebel
5. Add a new item to the List of Values - Type table for each reason code in
your contact center.
6. Select the Item Type: REASON_CODE.
7. Provide the following information for this item:
a. For the Display Value field, provide the string representing the reason
codefor example, Reason: Rest Room; Reason: Lunch; Reason: Gone
for break, and so on. See the note below.
b. For the Language Independent field, provide the positive integer value
for the reason codefor example, 10, 20, 30, and so on.
c. For the Language field, select English-Americanfor other languages,
see the Siebel documentation.
d. Leave the default values for all other fields.
Note: Genesys recommends that in the Display Value field, you use the
To create a list of the Genesys call status values for the Expert Contact
feature. See the section, Procedure: Voice Component: Creating a list of
the Genesys call status values for the Expert Contact feature, on page 248.
Procedure:
Voice Component: Creating a list of the Genesys call
status values for the Expert Contact feature
Purpose: To create a list of Genesys call status values for the Expert Contact
feature.
Start of procedure
Creating the New
List of Values Type Records
1. Navigate to the List of Values - Type table, using the Siebel Tools,
choose the Screens application menu, choose System Administration, and
then the List of Values menu item.
2. Create a new record in the List of Values - Type applet.
3. Specify the following parameters for the new record:
Type: GENESYS_CALL_STATUS
Translate: Selected
248
Configuring Siebel
Specifying
Genesys
Locations
249
Configuring Siebel
Create a list of the Genesys Routing Point values for the Voice Callback
feature. See, Procedure: Voice Component: Creating a list of the Genesys
Routing Point values for the Voice Callback feature.
Procedure:
Voice Component: Creating a list of the Genesys
Routing Point values for the Voice Callback feature
Purpose: To create a list of the Genesys Routing Point values for the Voice
Callback feature.
Start of procedure
Creating the New
List of Values Type Records
1. Navigate to the List of Values - Type table, using the Siebel Tools,
choose the Screens application menu, choose System Administration, and
then the List of Values menu item.
2. Create a new record in the List of Values - Type applet.
3. Specify the following parameters for the new record:
Type: GENESYS_ROUTING_POINT
Translate: Selected
Leave the default values for all other fields.
4. Save the new record.
Adding the
Routing Point
Values
250
Configuring Siebel
8. Complete steps 5 through 7 for all of the Routing Points in the list of
Routing Points that you gathered according to the instructions in the
section, Gathering the Genesys Object Settings on page 224.
End of procedure
Next Steps
Gplus Voice
Gplus OpenMedia.
Before importing the data from the configuration definition file, the sample
configuration parameters defined in this file must be customized to reflect your
actual contact center configuration. Then you can import the edited
configuration definition file. You can selectively import the following data
from the configuration parameters file:
profiles
drivers
commands
events.
Overview
Three procedures are involved in creating a Communication configuration:
1. Editing the configuration definition file. This may include editing to create
additional profiles for the same media type. See, Procedure: Voice
Component: Modifying and preparing the configuration definition file for
import, on page 252.
2. Creating the configuration record in Siebel. See, Procedure: Voice
Component: Creating a new configuration record in Siebel, on page 255.
251
Configuring Siebel
Create additional profiles for the same Media Typefor example, a second
Voice profile.
For UNIX
Procedure:
Voice Component: Modifying and preparing the
configuration definition file for import
Purpose: To modify and prepare the configuration definition file for import.
Start of procedure
1. Locate the appropriate definition file and open it for editing.
2. Make a copy of the definition file.
Note: Always make a copy of the definitions file in case you need to
252
Configuring Siebel
If you plan to use the Push Preview dialing mode of the Outbound
Campaign feature, use "outboundpreview" as the valuefor
example:
Note: You must install the Gplus Multimedia component to use the
Push Preview dialing mode of the Outbound Campaign
feature.
253
Configuring Siebel
switch. For the list of available (supported) values, see The Voice
Component Driver Parameters on page 310.
That approach, however, does not allow usage of the new security features
in Genesys 7.5.
5. For the Expert Contact feature, specify the following parameters:
Service:HasKWProtocol = TRUE.
This enables the protocol support.
6. For the Outbound Campaign feature (with its OSC functionality), specify
the following parameters:
Service:HasOCSProtocol = TRUE
This enables the protocol support.
Note: See, Table 20, The Voice Component Driver Parameters, on
254
Configuring Siebel
Procedure:
Voice Component: Creating a new configuration
record in Siebel
Purpose: To create a new configuration record in Siebel.
Start of procedure
1. Select Site Map > Administration - Communications > All
Configurations.
4. Click Save.
End of procedure
Next Steps
To import the new configuration record into Siebel. See, Procedure: Voice
Component: Importing the new configuration record into Siebel, on
page 255.
Procedure:
Voice Component: Importing the new configuration
record into Siebel
Note: Before importing the new configuration record, see the section
255
Configuring Siebel
4. In the Next window, define the configuration file that you want to import,
and select one, or more, of the four data parts. Your selection depends on
your requirements. Select all of the following data parts for the initial
import:
drivers and profiles
commands
events
configuration parameters
5. Use the Browse button to select the Gplus Adapter configuration file:
GenComm_universal.def, or a customized version of it.
6. Click OK to start importing.
End of procedure
Next Steps
Procedure:
Voice Component: Removing Unused Profiles in the
Configuration
Purpose: To remove the unused profiles and drivers containing insufficient
connection information. It is important to remove the unused profiles and
drivers, if you do not plan to use the full line of the Gplus Components.
Note: Before changing the *.def file, always create and save a backup copy.
Start of procedure
1. Select Site Map > Administration - Communication > All Configurations.
A list of the existing configurations displays.
2. Select a recordfor example, Genesys Configuration.
3. Select the Profiles tab.
4. Remove the unused profiles and drivers.
End of procedure
256
Configuring Siebel
T-Server Connections
A T-Server connection can be made in two different ways:
257
Configuring Siebel
All connection parameters are taken from the Siebel configuration as they
existed in the pre-7.5 versions of the Adapter. In this scenario, the security
settings cannot be defined.
Agent Administration
This section explains the processes involved in creating agents and
agent-related records.
Before using the Voice Component, you must first create the following:
Positions (see the section, Creating Positions, Telesets, and ACD Queues
on page 262.)
Telesets (see the section, Creating Positions, Telesets, and ACD Queues
on page 262.)
ACD Queues (see the section, Creating Positions, Telesets, and ACD
Queues on page 262.)
Creating Agents
To create an agent, you must re-define an existing employee (as defined in
Siebel) to function as an agent with the Gplus Adapter.
To be an agent, the employee must:
258
Configuring Siebel
Procedure:
Voice Component: Assigning the correct
responsibility and position to an existing employee
Purpose: To assign the correct responsibility and position to an employee in
regards to the Adapter.
Start of procedure
1. Select Site Map > Users Administration > Employees.
2. Select an employee who is supposed to function as an agent in regards to
the Adapter.
3. Specify the following parameters for the employee record:
Responsibility:
Click on the field.
Click Add new from the drop-down menu.
Select Universal Agent.
Click OK.
Click OK to return to the main screen.
Position:
Click the field.
Click New from the drop-down menu.
Browse to Telemarketing position.
Click OK.
Mark the position as Primary.
Click OK to return to main screen.
Time Zone:
Click the field.
Browse to desired time zone.
Click OK.
4. Save the record.
End of procedure
Next Steps
259
Configuring Siebel
Procedure:
Voice Component: Associating agents with an existing
Communications profile and Genesys settings
Purpose: To associate agents with an existing Communications profile and
Genesys settings.
Start of procedure
1. In the Siebel Site Map, navigate to All Configurations.
For Siebel 7.7/7.8/8.0/8.1, select Site Map > Administration Communications> All Configurations.
2. On the Configurations applet, locate the Gplus Outbound Contact
configuration.
3. Click the applet to make it active.
4. Select the Agents tab.
5. Click New.
6. On the Add Agents screen, browse to and select an agent.
7. Click OK to add the agent into the profile.
8. Save the agents record.
9. Select Administration - Communications > Agent General Profile.
10. Specify the following values for the record:
Agent Login: Agent login ID into ACD/PBX from Genesys
Password: Agent login password into ACD/PBX
260
Configuring Siebel
Procedure:
Voice Component: Associating an agent to a
campaign
Purpose: To associate an agent to a campaign. Associating an agent to a
campaign is also known as creating a campaign agent.
Note: This procedure is only required, if you use the Outbound Campaign
feature.
Start of procedure
1. Select Site Map > Administration Users > Employees.
2. Select an employee who is supposed to function as a campaign agent in
regards to the Adapter.
3. Click the Responsibility field.
4. On the left side of the pop-up window, select Campaign Agent.
5. Click Add.
6. Click OK to return to the main screen.
End of procedure
Next Steps
261
Configuring Siebel
Procedure:
Voice Component: Creating a Position record
Purpose: To create a new Position record.
Start of procedure
1. Select Site Map > Groups Administration > Positions.
2. Click New on the Positions applet.
3. Specify the following parameters for the new record:
Division: select Default Organization
Position: Telemarketing
4. Save the record.
End of procedure
Next Steps
Procedure:
Voice Component: Adding an ACD Queue
Purpose: To add an ACD Queue. An agent should be associated with an ACD
Queue, which is configured for operations with Outbound Contact Server
(OCS).
Start of procedure
1. Navigate to the List of Values (LOV) table, using one of the following
options:
For Siebel version 7.7/7.8/8.0/8.1, select Site Map >
Administration-Data > LOV Explorer
262
Configuring Siebel
2. For each ACD Queue in your contact center, you must add a new item
from the list of items.
3. Select the Item Type, CTI_ACD_QUEUES.
4. Provide the following information for this item:
For both the Display Value and Language Independent fields, include
the number of the DN of type ACD Queue.
For the Language field, select English-American (for other languages,
see the Siebel documentation).
End of procedure
Next Steps
Procedure:
Voice Component: Creating Telesets
Purpose: To create a Teleset, which is a set of DNs that represent a single
workplace.
Start of procedure
1. In the Siebel Site Map, navigate to All Telesets.
For Siebel 7.7/7.8/8.0/8.1, select Site Map > Administration Communications> All Telesets.
2. For each Teleset, provide the following information:
Create a new Teleset in the Telesets list.
Add your agents Extension.
3. Give the Teleset a unique namefor example, you may want to name the
Teleset based on the cubicle number, or the location of the Teleset.
4. Select the Extensions tab.
5. Add all the Teleset DNs in the list (one, or more DNs). For each DN, you
must define the DN type:
SStandard DN
AACD Position
263
Configuring Siebel
Procedure:
Voice Component: Assigning a default Place object to
a Person object
Purpose: To assign a default Place to a Persons.
264
Configuring Siebel
Start of procedure
1. In Configuration Manager, select Environment > Tenant > Persons.
2. Click Persons.
3. Right-click a specific Person object and select Properties from the
drop-down menu.
The Properties dialog box displays.
4. Select the Agent Info tab.
5. Locate the Default Place drop-down menu.
6. Click Browse.
7. Click Places and select the appropriate place for the Person.
8. Click OK to add the Place.
9. Click Apply to submit changes.
10. Click OK to close the Properties dialog box.
11. Repeat Step 3Step 10 for all agents.
End of procedure
Next Steps
Assign an agent to an Agent Group, if the agents are working with the
Outbound Campaign functionality. See, Procedure: Voice Component:
Assigning an OCS agent to an Agent Group, on page 265.
Procedure:
Voice Component: Assigning an OCS agent to an
Agent Group
Purpose: To assign OCS agents to an Agent Group.
265
Configuring Siebel
Start of procedure
1. In Configuration Manager, select Environment > Tenant > Agent Groups.
2. Right-click a particular Agent Group configured to work with OCS.
3. Select New > Shortcut from the drop-down menu to access an agent.
4. Navigate to the agent entry with which you are working.
5. Click OK to add the agent.
6. Repeat Steps 25 for all agents that must be configured to work with OCS.
End of procedure
Next Steps
If you not working with the Universal Callback component, then there are
no further steps. You have completed the configuration and installation of
the Outbound Campaign feature of the Gplus Adapter 8.0 for Siebel CRM
The configuration steps mentioned above are related to the synchronization
of information between Siebel and Genesys. For more detailed information
about the configuration of the Genesys Outbound Contact Server product,
refer to the Genesys Outbound Contact documentation.
Procedure:
Voice Component: Assigning an Universal Callback
agent to an Agent Group
Purpose: To assign Universal Callback agents to an Agent Group.
Start of procedure
1. In Configuration Manager, select Environment > Tenant > Agent Groups.
2. Right-click a particular Agent Group configured to work with Universal
Callback.
3. Select New > Shortcut from the drop-down menu to access an agent.
266
review the basic deployment procedures for any information that may
apply to the kind of changes you are makingfor example, if your
modification requires changes to the configuration (*.def) file, refer
to the section, Editing the Configuration Definition File on
page 252. The information in this section assumes that you understand
the context of the implementation procedures and any associated
requirements or constraints that may apply.
267
Server. If you are not using Activity records, remove the Activity
Creation code from the event handlers. See the section,
Modifying the Definition File and Resolving Any Related
Performance Issues on page 273, for more information.
This section consists of the following sections:
Creating a Basic Voice Feature Activity Record, page 268
Creating an Expert Contact Feature Activity Record, page 269
Creating an Outbound Campaign Feature Activity Record, page 270
Creating a Universal Callback Feature Activity Record, page 271
Modifying the Definition File and Resolving Any Related Performance
Issues, page 273
Transfer Functionality Restrictions, page 273
Transferring Outbound Calls to Agents Who are Not in a Campaign,
page 274
The log creation logic model and the set of information fields used are defined
in the appropriate event response; the post-call release actions are defined in
the same event response as the After Call Work (ACW) elements.
Inbound Calls
268
Outbound Calls
Multiple contacts
Single contact
No contacts found.
Multiple contacts
Single contact
No contacts found.
The Display = true option must be commented out or removed from the
code, if you want to enable the Contact popup screen.
Scenario 2:
The Previewinteraction mode
is turned on
The Activity records for the inbound and outbound calls are created in the
same manner as for the Basic Voice feature. SeeCreating a Basic Voice
Feature Activity Record on page 268.
The established call reuses both the same work item in the Communication
toolbar and the same Activity record.
The log creation logic model and the set of information fields used are
defined in the following associated event response:
OnEventKwPreviewIntRequest.
The post-call release actions are defined in the same event response as the
After Call Work (ACW) elements.
269
Table 16 displays the name of supported event handlers and the status property
that they set.
Table 16: Supported Event Handlers for the Expert Contact
Feature
Event Handler
Status
EventKwPreviewIntRequest
Requested
OnOCSRecord
OnEventPushPreviewInvited.
The activity creation logic models for the Predictive and Progressive calling
modes are implemented in the OnPredictOCSRecord event response and the
[EventHandler:OutboundOCSCallEstablished] event handler.
The [EventHandler:PreviewOCSCallEstablished] event handler prevents the
duplication of Activity records created for any preview calls. The Preview
records (as well as the scheduled calls and the predictive calls) are incoming
interactions and they create their own activity record.
270
Status
EventPreviewRecord
In Progress
EventScheduledCall
EventEstablished (for Predictive and Progressive
Dialing modes)
EventUpdCallComplStatsAck
OpenMediaOcsCallCompletionSAck
EventRecordRescheduleAck
Scheduled
OpenMediaOcsRecordReschedulAck
EventDoNotCallAck
Declined
EventRecordRejectAck
OpenMediaOcsRecordDoNotCallAck
OpenMediaQueued
EventRecordCancelAck
Canceled
EventRecordCancel
EventRecordRemove
OpenMediaOcsRecordCancelAck
OpenMediaOcsRecordRemovedAck
EventRecordProcessedAck
Completed
OpenMediaOcsRecordProcessedAck
EventReleased
Unassigned
271
Multiple contacts
Single contact
No contacts found.
Also, the event handlers shown in Table 18 update the Activity records
(created in the [EventHandler:EventCallBackRequest] event handler) and must
be commented out or removed from the code, if you want to disable the
creation of the Activity records for the CallBackRequest request.
Table 18 shows a list of supported event handlers and the status that they set.
Table 18: Supported Event Handlers for Universal
Callback
Event Handler
272
Status
EventCallBackRequest
Requested
EventCallBackAccepted
In-Progress
EventCallBackRejected
Declined
EventCallBackCancel
Canceled
EventCallBackDone
Done
EventVCBPreview
Requested
EventAddVCBRequest
Scheduled
EventVCBReject
Declined
EventVCBCancel
Canceled
EventVCBProcessed
Done
End:
Lines above are activity creation code >>>>>>>>>>>>>>>>>>>>>>>>>>>>>
The Siebel Server performance is also affected when you query the Campaign
Business Component record for the Siebel SmartScript. If you are not using the
Siebel SmartScript, the following code, which is related to the Siebel
SmartScript handling, must also be commented out or removed from the
GenComm_universal.def file.
For your convenience, the SmartScript-related code is marked as follows:
Start:
; Lines below are Smart Script related code
<<<<<<<<<<<<<<<<<<<<<<<<<<
End:
; Lines above are Smart Script related code
>>>>>>>>>>>>>>>>>>>>>>>>>>
Only two-step and mute (blind) transfers are allowed from agent-to-agent.
Genesys recommends that when making an agent-to-agent transfer, the
first agent should make a consultation call to the second agent before
making the transfer. If the agent receiving the transfer has a current call
and record on their desktop, the transfer may not be successful.
The user data should be attached to the call after the agent completes a
transfer.
A call transfer is possible to and from agents and also, to agents logged
into a loaded or active campaign group. You can also transfer to agents
who are not participating in the active campaign. This option requires that
you use Outbound Contact 7.x, or higher.
273
Expert Contact
Feature
cancel a record
process a record
274
Alcatel A4400/OXE
The Adapter supports the operation of the T-Server for Alcatel 4400/OXE and
the Alcatel A4400/OXE switch with the Agent Substitute feature set to either
of the following:
on or true
off or false
In either of these two modes, the set of DNs for the agent Teleset in the
configuration must have the following defined:
DNs of type ACD Position, Teleset DNs of type A (ACD Position DN)
When you use the Agent Substitute feature set to on or true, you must define
the following two parameters in the CTI configuration:
Service:AgentSubstitute = TRUE
Service:ACDDNList = {@ACDDNList }
If you use the Agent Substitute feature set to off or false, you must define the
following two parameters in the CTI configuration:
Nortel
Communication
Server 2000/2100
Nortel
Communication
Server 1000
Service:AgentSubstitute = False
Service:ACDDNList = {@AgentID}
The Siebel CRM configuration for Gplus Adapter can define a special DN,
which is called the Communication DN. Third-party applications (for example,
T-Server clients) can communicate with the Gplus Adapter using this
Communication DN to send EventUserEvent messages with an attached
UserData attribute to all agents currently logged into the Adapter. These
third-party applications are defined as any client application other than the
Gplus Voice Component.
The Communication DN for this feature is configured in Siebel by defining the
following communications driver parameter:
Driver:CommunicationDN <DN>
275
276
Broadcasting
EventUserEvent
Messages
Through a
Communication
DN
Figure 32: Data Flow for Broadcasting an EventUserEvent Message through a Communication DN
277
parameter is not defined, or if its value is set to false, then the EventUserEvent
message is delivered by T-Server to the third-party applications only. See,
Figure 33.
Figure 33: Data Flow for Broadcasting User Events to Third-Party Applications Only
278
AdditionParam1/This is Param1
AdditionParam2/This is Param2
[Command:SendUserEventToCommDN]
Description = Send UserData To Comm DN
DeviceCommand = SendUserEventOnCommDN
Hidden = true
Profile =
Comments =
CmdData = ConnDataForSendUserEventToCommDN
[CmdData:ConnDataForSendUserEventToCommDN]
Param.AdditionParam1 = This is Param1
Param.AdditionParam2 = This is Param2
Comments =
When you import the above definitions into the configuration, Siebel can use
the SendUserEventToCommDN command parameter to deliver the EventUserEvent
message (with the following attached UserData attribute as the key-value pair
list: AdditionParam1/This is Param1, AdditionParam2/This is Param2) to
other applications that have been registered to receive the same
Communication DN events.
Value
AttributeExtensions
<NameOfAttributeExtensionsValue>
NameOfAttributeExtensionsValue
279
Example 2 describes how you can define the MakeCallToPhone command with
the AttributeExtensions parameter in the GenComm.def file.
Example 2
[Command:MakeCallToPhone]
DeviceCommand = MakeCall
Description
CmdData
= MakeCallToPhone
OnControl = TRUE
Hidden
= TRUE
[CmdData:MakeCallToPhone]
AttachContext= TRUE
RequiredField.@Phone= ?*
Param.PhoneNumber= {@Phone}
Param.CallNotifyText= Call from {@UserName}...
Param.AttributeExtensions
= GCTI_PARAMETER
Param.GCTI_PARAMETER= 111
280
Example 3
[CmdData:CmdDataExample]
Param.StringAttributeExtensions = "str1 , Str2 ,String3,string4"
Param.str1 = "String_str1"
Param.Str2 = "String_Str2"
Param.String3 = "String_String3"
Param.string4= "String_String4"
Example 4 shows a command that includes the ReasonCode key with a string
value of 7623 in the Extensions attribute of a request to T-Server:
Example 4
[CmdData: NotReadyWithReasonCode]
Param.ReasonCode = "7623"
Param.StringAttributeExtensions = "ReasonCode"
Extensions
Attribute Using the
Value Type Integer
Example 5
; ////////////SendDTM command
[Command:SendDTMFComm]
DeviceCommand = "SendDTMF"
; "Description" is provided by driver
CmdData
= "DTMFData"
Hidden
= "TRUE"
Profile
CmdChannelOnFocus = "TRUE"
281
[CmdData:DTMFData]
Param.Digits
= "12345"
Param.AttributeExtensions = "GCTI_SendDTMF"
Param.GCTI_SendDTMF= "111"
Param.IntAttributeExtensions = "ToneDuration, Int2,PauseDuration"
Param.ToneDuration = "12"
Param.Int2 = "222"
Param.PauseDuration = "8"
[Command:SendDTMFComm]
DeviceCommand = "SendDTMF"
; "Description" is provided by driver
CmdData
= "DTMFData"
Hidden
= "TRUE"
Profile
CmdChannelOnFocus = "TRUE"
[CmdData:DTMFData]
Param.Digits
= "12345"
Param.AttributeExtensions = "GCTI_SendDTMF"
Param.GCTI_SendDTMF= "111"
Param.IntAttributeExtensions = "ToneDuration, Int2,PauseDuration"
Param.ToneDuration = "12"
Param.Int2 = "222"
Param.PauseDuration = "8"
Param.StringAttributeExtensions = "str1 , Str2 ,String3,String4"
Param.str1 = "String_str1"
Param.Str2 = "String_Str2"
Param.String3 = "String_String3"
Param.String4 = "String_String4"
282
The names of the parameters that must be included as Extensions attributes are
provided by the Extensions parameter Extensionsfor example:
Param.Extensions = "Int2, Str4, Str1, reason_i1"
The backslash symbol (\) in the first position of the parameter value is used
to denote an integer type value. Any other symbol in the first position denotes
that this symbol is a string type value. If the string type value needs to have a
backslash in its first position, then use a double backslash as follows:
\\StringValue.
If the value of a parameter, as defined in the Siebel Communications Server
command data, with a Param.* prefix begins with a single \ (backslash), then
this type value is treated as an integer. A single backslash is considered as a
string type value and its value is single backslash ("\").
In the following examples:
Param.res-Bslash
= "\" in [CmdData:NotReadyWithPopup]
\ .
283
Example 7
Param.reasons_i2 = "\i453"
DeviceCommand = "MakeCall"
FilterSpec
Hidden
= "TRUE"
OnEditControl = "TRUE"
Comments
= ""
Profile
CmdData
= "MakeCallToPhone"
[CmdData:MakeCallToPhone]
Param.CallNotifyText
Param.Extensions
Param.Int1
= "\9832"
Param.Int2
= "\12678"
Param.PhoneNumber
reasons_i2,
Str4"
= "{@Phone:PhoneTypeLookup}"
Param.Reasons
= "reason_i1, reason_str1,reasons_i2"
Param.Str1
Param.Str2
= "_Without Backslashes"
Param.Str4
= "\\OneMoreBack"
Param.StringAttributeExtensions = "Int1,Int2,Str1"
Param.reason_i1
= "\8645"
Param.reason_str1
= "qwerty"
Param.reasons_i2
= "\i453"
Param.str3
= "again w\ithout"
RequiredField.@Phone
= "?*"
Comments
= ""
[Command:NotReadyForGVoiceGroup]
Description
DeviceCommand = "NotReady"
FilterSpec
= "[$GetCommandStatus(NotReady)] = 'Enabled'"
Hidden
= "TRUE"
Comments
= ""
Profile
CmdData
= "NotReadyWithPopup"
[CmdData:NotReadyWithPopup]
Param.ReasonCode
= "[Name]"
Param.ReasonValue = "[Value]"
284
Param.Reasons
= "Res1_int, Res3_str,
Param.Res1_int
Res2_str,res-Bslash,
res5"
= "\1237"
Param.Res2_str
= "//r2_str"
Param.Res3_str
= "r3_str"
Param.res-Bslash
= "\"
Param.res5
= "\\with\\baslash"
SelectApplet
SelectBusComp
= "List Of Values"
SelectBusObj
= "List Of Values"
SelectParam
= "TRUE"
SelectQuerySpec
Comments
= ""
;////////////////////////////////////////////////;// "TestAttachData"
would be called from EventResponse
;//of some EventHandler:
;// for test purposes only
[Command:TestAttachData]
Description
; DeviceCommand = "AttachData"
; DeviceCommand = "DeleteUserData"
DeviceCommand = "UpdateUserData"
Hidden
= "true"
Comments
= ""
CmdData
= "AssociateAttachData"
[CmdData:AssociateAttachData]
Param.AdditionParam1 = "This is Param1"
Param.AdditionParam2 = "This is Param2"
Param.AdditionParam3 = "This is Param3"
Comments
= ""
285
For testing purposes, you may create a new button on the Siebel
Communications toolbar and associate this button with the TestAttachData
command as defined above. For detailed information about how to create this
button on the Siebel Communications toolbar, see the Siebel documentation.
The following information is important to remember when working with data
attached to a call:
For incoming calls, the Adapter enables the following device commands
after the EventEstablished event is sent:
AttachData
UpdateUserData
DeleteUserData
For outgoing calls, the same device commands are available after the
EventDialing event is sent
The AttachData device command should not be used to update any already
existing data attached to a call. In this scenario, the command simply adds
the specified parameters, which can lead to duplicated entries in the data
attached to the original call. The UpdateUserData device command creates
a new entry, or updates an existing one. For more information, see the
T-Server documentation related to the switch you are using.
286
When the original calling party has established a connection with an agent
(Agent 1) on Premise A, the network multi-party functionality can be invoked.
In this scenario, Agent 1 can make a request for a consultation with another
agent (Agent 2) on Premise B. The NAT/C request is initiated on Premise A
with the required parameter of the remote location. When this request is
answered on Premise B, the consultation call leg is created on the network.
After the consultation call leg is initiated, Agent 1 is then able to swap voice
connections between Agent 2 and the original calling party. Agent 2 can also
swap the voice connection, but there is a limitation, which is that the voice
connection can only be swapped in one of the following ways:
After the consultation call leg is initiated, an agent can do the following:
Complete the transfer of the network call to a remote location (Premise B).
Both of these parameters are treated the same and must be defined as follows:
287
Command:ConsultativeTransferToEmployee
Command:ConsultativeTransferToPopupEmployee
Command:ConferenceTransferToEmployee
Command:ConferenceTransferToPopupEmployee
288
[Command:ConsultativeTransferToPopupEmployee]
DeviceCommand
Description
popup list"
= "TransferInit"
= "Consultative transfer to employee selected from
Title
= "Consultative Transfer"
CmdData
= "ConsultativeTransferToPopupEmployee"
Hidden
= "TRUE"
CmdChannelOnFocus = "TRUE"
Profile
[CmdData:ConsultativeTransferToPopupEmployee]
AttachContext
= "TRUE"
SelectParam
= "TRUE"
SelectBusObj
= "Employee"
SelectBusComp
= "Employee"
SelectApplet
SelectTitle
Param.PhoneNumber
= "[Phone #:Lookup]"
= "{@SelectedWorkItem:DriverWorkTrackID}"
Param.RemoteConnectStr
= "[$RemoteConnectStr2(Id)]"
289
290
Example 10
[Command: SingleStepTransferCallToNetworkTS]
DeviceCommand
= "TransferSStep"
CmdData = " SingleStepTransferCallToNetworkTS "
Hidden
= "TRUE"
CmdChannelOnFocus = "TRUE"
Profile
= "Profile Name Here"
[CmdData: SingleStepTransferCallToNetworkTS]
Param.RemoteConnectStr = "<AttributeLocation_Value>"
Param.TrackingID =
"{@SelectedWorkItem:DriverWorkTrackID}"
291
Configurations with one OCS, when the primary OCS is down, or not
responding;
Configurations with primary and backup OCSs, both running in the Warm
Standby modefor example, when an agent has records from the primary
OCS, but the backup OCSs role is switched to primary due to the failure
of the primary server.
292
modes)
OCSPartyChanged(for transferred calls)
The following placeholders mark the end of the SmartScript related code:
; Lines above are SmartScript related code
>>>>>>>>>>>>>>>>>>>>>>>>>>
If you are not using the SmartScript functionality, the related code should be
removed from the following event responses: [EventResponse:OnOCSRecord]
and the [EventResponse:OnPredictOCSRecord]. Also, the
[EventHandler:EventCurrentSmartScriptWorkItemChanged] event handler
should be commented out or removed from the universal.def file.
For an example of how to use the SmartScript code in the
EventCurrentSmartScriptWorkItemChanged event handler, see Supported
Event Handlers for the Expert Contact Feature on page 270 and see the
GenComm_universal.def file for details about the current implementation. This
event handler is intended for SmartScript execution when an agent switches
between work items on the Siebel Toolbar. If you are using the SmartScript
code for screen pops, this event handler should be commented out. Also, the
appropriate SmartScript code should be developed and specified for use with a
campaign.
293
USE_RECORD_HANDLE
USE_PHONE
USE_CUSTOMER_ID
The Gplus Adapter sends a request to the Outbound Contact Server to mark a
record as Do Not Call based on the record handle ID. The following additional
attribute keys: GSW_CHAIN_ATTR = RecordOnly or AllChain can be specified
to mark a chain or a record as Do Not Call. The default value for the
USE_RECORD_HANDLE attribute key is specified in the Service:
OCSDoNotCallScope = AllChain service parameter, and is effective for all
agents under a specific profile. This results in a specific phone number from a
record (or all phone numbers from a chain) being marked as Do Not Call and
is then included in the Do Not Call list.
USE_PHONE
The Gplus Adapter sends a request to the Outbound Contact Server to mark a
record as Do Not Call based on the phone number. As a result, the phone
number is included in the Do Not Call list and records, and this phone number
is never called again. See the Outbound Contact Server documentation for
more information.
USE_
CUSTOMER_ID
294
The Gplus Adapter sends a request to the Outbound Contact Server to mark a
record as Do Not Call based on the customer ID. As a result, the customer ID
is included in the Do Not Call list and records, and this customer ID is never
called again. See the Outbound Contact Server documentation for more
information.
The GSW_CHAIN_ATTR attribute key is sent with the Do Not Call request in a
scenario, where the value of the Param.USE_RECORD_HANDLE parameter is
equal to "TRUE", is defined for the Do Not Call device command.
The Do Not Call device command can be invoked with the GSW_CHAIN_ATTR
attribute key values AllChain or RecordOnly, if this command is defined in
the CmdData section of the command, and the value of the
Param.USE_RECORD_HANDLE parameter equals "TRUE".
295
Example 11
;
DoNotCall
[Command:DoNotCall]
Description
= "Mark phone number as Do Not Call"
DeviceCommand = "DoNotCall"
Hidden
= "TRUE"
Profile
= "Gplus Universal Profile"
Comments
= ""
CmdData
= "DoNotCall"
CmdChannelOnFocus = "TRUE"
[CmdData:DoNotCall]
;; Param.USE_CUSTOMER_ID
Param.GSW_CHAIN_ATTR
;; Param.GSW_CHAIN_ATTR
;; Param.USE_PHONE
Param.USE_RECORD_HANDLE
Comments
=
=
=
=
=
=
"TRUE"
"AllChain"
"RecordOnly"
"TRUE"
"TRUE"
"Do Not Call"
296
The Gplus Adapter sends a request to the Outbound Contact Server to mark a
record as Cancel based on the record handle. As a result, the phone number is
marked Cancel in the calling list, and is not called for this campaign. See the
Outbound Contact documentation for more information. An additional
attribute GSW_CHAIN_ATTR with the values of RecordOnly or AllChain can
be specified to mark all records in a chain, or mark a single record as Do Not
Call. The default value for the USE_RECORD_HANDLE attribute is specified in the
OCSCancelScope service parameter and is effective for all agents under a
specific profile. The resulting record (or the whole chain) is marked as
Canceled and is not called within a particular calling list.
USE_PHONE
Use Case
The Gplus Adapter sends a request to the Outbound Contact Server to mark a
record as Cancel based on a contacts phone number. As a result, the phone
number is marked as Cancel in the calling list and is not called for this
campaign. See Outbound Contact documentation for more information.
If neither of the USE_RECORD_HANDLE or USE_PHONE attributes are specified, then
the Gplus Adapter assumes that the Adapter customer manually provided all of
the necessary attributes keys, specified in the command description, and
without modifying the Siebel *.def file, sent them to Outbound Contact Server.
See the Outbound Contact Server Desktop Protocol Cancel command
definition on page 373 for information about the RequestRecordCancel key
attributes.
For example, in the sample GenComm_universal.def file (as shown in Example
12 on page 296):
The Do Not Call device command can be invoked with the GSW_CHAIN_ATTR
attribute key values AllChain or RecordOnly, if this command is defined in
the CmdData section of the command, and the value of the
Param.USE_RECORD_HANDLE parameter equals "TRUE".
297
Example 12
[Command:OCSRequestRecordCancel_]
Description
= "Cancel Interaction"
DeviceCommand = "CancelInteraction"
BusComp
= "Campaign List Contact"
AllViews
= "FALSE"
View
= "Campaign Detail - Position"
Hidden
= "TRUE"
Profile
= "Gplus Universal Profile"
CmdData
= "OCSRequestRecordCancel_"
CmdChannelOnFocus = "TRUE"
[CmdData:OCSRequestRecordCancel_]
Param.USE_RECORD_HANDLE
= "TRUE"
; Param.USE_PHONE
= "TRUE"
Comments = "Request Record Cancel - Cancel Current Work Item"
Param.GSW_CHAIN_ATTR
= "AllChain"
or
Param.GSW_CHAIN_ATTR
= "RecordOnly"
298
299
if (FieldValue == "Y") {
//retVal = CallCommunicationsCommand("RecordProcessed",
"", "");
}
break;
}
if (retVal != ContinueOperation)
{
DisplayGenesysError();
}
return (retVal);
}
300
;;/////////////////////////////////////////////////////////////////
///////
; MakeCall
; CRM_CAMP_CON_ID - Campaign List Contact
; IgnorePhoneNumber - if set to true, ignores PhoneNumber value and
calls number
; from Genesys campaign, otherwise calls PhoneNumber.
; OutsideCallPrefixPrefix to reach outside phone network; if
specified will be
; added to Genesys campaign phone number.
[Command:MakeCallToCampaignContact]
Description = Make call to campaign contact
DeviceCommand = MakeCall
Hidden = TRUE
CmdData = MakeCallToCampaignContact
[CmdData:MakeCallToCampaignContact]
BusComp = Campaign List Contact
Param.CRM_CAMP_CON_ID = {Id}
Param.PhoneNumber = {Work Phone #:Lookup}
Param.IgnorePhoneNumber = TRUE
Param.OutsideCallPrefix =
RequiredField.Work Phone # = ?*
301
Checking Installations
Checking Installations
This section includes the preliminary information and instructions for checking
your implementation of each Voice feature to verify that it is correctly installed
and working. This section includes the following procedures:
Voice Component: Checking the basic Voice feature installation, page 302
Voice Component: Checking the Expert Contact installation, page 303
Voice Component: Checking the Voice Callback installation, page 304
Voice Component: Checking the Outbound Contact installation, page 306
Disclaimer
Only a thorough testing of every possible configuration and variation can
provide a complete software application test. The tests listed below provide
only a suggested starting point. If these tests are acceptable, Genesys
recommends that you test each individual feature and variations by applying
the procedures listed for that feature in the Gplus Adapter 8.0 for Siebel CRM
Users Guide. These preliminary tests are not intended to substitute for a
professionally designed and administered panel of tests.
Procedure:
Voice Component: Checking the basic Voice feature
installation
Purpose: To check the functionality of the Basic Voice feature.
Start of procedure
1. Log in as an agent.
2. If are in the Not Ready state, select the Ready button.
3. Make a direct call to the agent Teleset.
The ringing icon on the Siebel Communication toolbar should start
blinking, indicating that a new call is waiting for the agent to answer.
4. Click the Answer incoming call button to establish a connection.
5. Confirm that the normal telephone or headset operations and the CTI
toolbar buttons are present.
6. Confirm that the basic voice functions are coordinated with the basic voice
controls on the CTI toolbar.
7. After the communication with the caller is completed, click the Hangup
call button to release the call.
302
Checking Installations
8. Type a phone number into the edit field of the Communication toolbar and
click the Make Call to <Phone Number> button and then do one of the
following:
If this outgoing call is answered, then, after the communication is
completed, click the Hangup call button to release the call.
If this call is not answered, click the Hangup call button to release the
call.
9. Try out other call scenariosfor example, a conference and a transfer call.
Refer to the Gplus Adapter 8.0 for Siebel CRM Users Guide for examples
of these scenarios.
End of procedure
Next Steps
Procedure:
Voice Component: Checking the Expert Contact
installation
Purpose: To check the Expert Contact installation feature-enabled Siebel Call
Center.
Start of procedure
1. Log in as an agent and select the Ready button.
2. Click the On Call button on the Siebel Communication toolbar.
A new incoming call from an unknown recipient appears in the work items
list on the CTI toolbar. Proceed with the call as if it were an incoming call
so Genesys can track this call. From this point onward, use the same
checking process applied to the Basic Voice feature, with the exception of
testing of the confirm-status option.
3. If the Confirm-status configuration option is implemented, then a popup
window should appear after the defined time-out period. That is, if an
expert is on the call after the length of time set by the timer, a dialog box
appears asking if the expert is still on the call and if the agent wants to
continue.
303
Checking Installations
End of procedure
Next Steps
Procedure:
Voice Component: Checking the Voice Callback
installation
Purpose: To check the Voice Callback installation by following the agent
workflow scenarios described in the procedure.
Start of procedure
1. To initiate a callback session:
Click the Session start button on the Communication toolbar.
304
Checking Installations
305
Checking Installations
Procedure:
Voice Component: Checking the Outbound Contact
installation
Purpose: To check the Outbound Contact installation.
Start of procedure
1. Log into the Siebel Call Center application as one of the agents that you
created during the Procedure: Voice Component: Assigning the correct
responsibility and position to an existing employee, on page 259
procedure. Scenarios are processed differently, depending on the OCS
campaign mode and are described below. For further information on how
to work with the Genesys Outbound Contact Server, refer to the Genesys
Outbound Contact Getting Started Guide.
Campaign
Running in
Preview Mode
2. When a campaign is running in the Preview mode, log into the Siebel Call
Center, and then log into PBX/ACD on the Communications toolbar.
The Campaign [Campaign_Name] started message appears on the status
line.
3. Click Preview Mode Start, to enable the following campaign control
buttons on the Communications Toolbar: Request Record, Request Chain,
Reject Record, Record Processed, Record Cancel, Mark Phone Do Not
Call, and Preview Mode Stop.
Campaign
Running in Push
Preview Mode
4. When a campaign is running in the Push Preview mode, log into the Siebel
Call Center, then log into PBX/ACD, then log into Interaction Server (the
Gplus Multimedia component must be installed), and set Ready for Push
Preview on the Communications Toolbar.
On every requested preview record, the Campaign Overview screen with a
particular Contact/Prospect, is displayed and the following additional
controls, Make Call, Done Reject, and Do Not Call, are available on the
306
Checking Installations
interface. Also, all changes to the following fields, Call Result, Attempts,
and Schedule Time, are written to the Genesys Outbound Contact Server
and the Siebel database.
The Done control (on the interface) and the Record Processed button (on the
Communications toolbar) write the operation and initiate the final OCS
database update. After this command, the Preview record is removed from
the Communications drop-down Work Items list. An active call
corresponding to this contact remains active and can be finished by
clicking Release Call. Alternatively, the call can be released and the
command, Record Processed, can be issued later.
Figure 34 on page 307 shows an OCS Preview record with an initiated
outbound call. The Preview campaign name also displays.
307
Campaign
Running in
Predictive or
Progressive Mode
Checking Installations
308
Checking Installations
Figure 36 on page 310 shows an outbound call delivered to the agent. The
campaign name also displays.
309
End of procedure
Next Steps
310
Table 20 lists the supported driver parameters for the Gplus Adapter driver for
the Siebel Communications Server. The table indicates which parameters are
required and displays applicable default values. You view and modify these
driver parameters in the Communications Drivers and Profiles view in the
Administration - Communications screen). The channel type for this driver is
Gplus Universal.
Note: A Siebel administrator must configure the Siebel environment to work
Parameters prefaced with Driver: are sent to the driver handle when the
driver is initialized. These parameters are sent to the
CreateISCDriverInstance method.
Parameters prefaced with Service: are sent to the driver handle when it
requests a service (creates the service handle). These parameters are sent to
the RequestService method.
Note: You must change the value of each mandatory parameter with the
Required
Comment
No
The application name that is sent to T-Server when the Adapter opens
a connection to this T-Server.
(For compatibility with the pre-7.5 scheme of connection to T-Server
only.)
No
No
311
Required
Comment
No
Specifies the name of the host machine on which the backup Genesys
T-Server is running.
(For compatibility with the pre-7.5 scheme of connection to T-Server
only.)
No
Specifies the TCP/IP port number the client must use to establish a
connection with the backup Genesys T-Server.
(For compatibility with the pre-7.5 scheme of connection to T-Server
only.)
No
No
No
= TRUE
If the switch configuration does not require you to put the phone on
the hook, then set this parameter to FALSE
Parameter Name: Driver:InboundPartyContainer
empty string ()
312
No
Name of the TEvent attribute for substitution in the work item name
on the Siebel Toolbar for incoming calls
Required
Comment
Yes
Yes, if
Network
Attended
Transfer is
used.
No
No
Name of the TEvent attribute for substitution in the work item name
on the Siebel Toolbar for outgoing calls.
Yes
No
No
313
Required
Comment
No
No
No
Yes
314
Required
Comment
Yes
23Alcatel 4400
29Nortel Meridian Call Center Symposium
31Siemens Realitis DX (iSDX)
49Avaya INDeX (Lucent SDX)
50Siemens Hicom 300H
51Siemens HiPath 4000
52Alcatel A4200 OmniPCX Office (OXO)
58Knowledge Worker Gateway
62Cisco CallManager
67itel
69Siemens HiPath
70eOn eQueue
72SIP Server
Also see the document, Genesys Supported Media Interfaces
Reference Manual, which is available on the Genesys Technical
Support website.
Contact Genesys for a current list of switches and SwitchType values.
(For compatibility with the pre-7.5 scheme of connection to T-Server
only.)
No
Yes
Yes
No
315
Required
Comment
No
No
Applies only to the Predictive dialing mode. When this option is set to
TRUE, the agent logout control functionality is enabled and all agents
requesting logout are notified regarding the time left until actual
logout and upon reaching this time the agents are automatically
logged out from the Communication services.
Yes (when
working
with
Outbound
campaigns in
Preview
mode)
Yes (when
using the
Alcatel
A4400
switch)
For the Alcatel A4400 switch, this option must be set in accordance
with T-Server settings for the Agent Substitute option.
See more details in Switch-Specific Configuration Instructions on
page 274.
No
316
Required
Comment
No
If the value of this parameter is TRUE, when the agent logs out from
Siebel or closes the browser, then first the agent logs out from the
ACD Queue group, and then the agent logs out from Siebel. When the
value of this parameter is FALSE, the agent just logs out from Siebel.
No
Yes
No
No
317
Required
Comment
No
If this option value is populated (not empty), the Adapter tries to read
the corresponding value from the call-attached data (by using the
FrozenTimeInQueue detection mode) with this option value as its
key. After reading the value, the Adapter sends the results to Siebel in
the form of the TimeInQueue attribute for the call.
Definitions:
Compute-TimeInQueue detection modeFrom the CAD, the
Adapter reads a value that is associated with the key that is
provided by the EntranceTimestamp parameter. This value is a
string that must conform to the Coordinated Universal Time
(UTC) format: YYYY-MM-DDThh:mm:ss. The Adapter then calculates
the TimeInQueue attribute (in seconds) for the call (The difference
between the current time, converted to UTC, and the time that the
Adapter read from the CAD.)
FrozenTimeInQueue detection modeFrom the CAD, the
Adapter reads a value that is associated with the key that is
provided by the FrozenTimeInQueue parameter. This value is an
integer (in seconds) that represents the TimeInQueue attribute of
the call, which was calculated by an external application or
software. The Adapter sends this value to Siebel with no changes
(as is).
PBX-TimeInQueue detection modeThe Adapter reads from the
Extensions call attribute to obtain the PBX/switch-specific
TimeInQueue parameter and sends the value to Siebel. (This
attribute is not supported by all PBXs or switches.)
Note: If none of these options is defined, or if there are no keys
related to them in the call attached data, the Adapter uses
PBX-TimeInQueue detection mode (the existing Adapter mode
available prior to this release).
If both of these options are defined, and both have keys present in the
CAD, then the Adapter uses FrozenTimeInQueue detection mode,
which has a higher priority.
Example: If both of the new options are set in Siebel, as in the
following example:
[Driver Parameters:Gplus_Voice]
Required:Name = "Gplus_Voice"
Service:FrozenTimeInQueue = Key1
Service:EntranceTimestamp = Key2
then there are four possible ways in which the Adapter might interpret
this, and determine the TimeInQueue value that is sent to Siebel.
318
Required
Comment
No
For example:
If only the pair with the value of Key1 is present in the CAD, the
Frozen-TimeInQueue detection mode is used.
If only the pair with the value of Key2 is present in the CAD, the
ComputeTimeInQueue detection mode is switched to ON.
If both pairs have their respective values, Key1 and Key2, in the
CAD, the Frozen-TimeInQueue detection mode is used because of
its higher priority.
If both of the Key1 and Key2 values are absent from the pairs in
the CAD, the PBX-TimeInQueue detection mode is used.
No
No
No
For the current active call, if the value of this parameter is TRUE, the
Hang-up call button on the toolbar is available. If the value is FALSE,
this button is unavailable.
No
If both the switch and T-Server support call forwarding, and this value
is set to TRUE, the button on the toolbar that turns call forwarding on or
off is available. If this value is FALSE, this button is unavailable.
No
319
Required
Comment
No
No
No
No
Used by Gplus Adapter when the party status info is missing in the
KwPartyStatusRequest request from Siebel.
No
No
No
320
Required
Comment
No
No
No
No
No
321
Required
Comment
No
When the value of this parameter is set to FALSE, the Adapter will not
release an active call if an agent closes the browser or logs out from
Siebel. If the value of this parameter is TRUE and the option
AutoLogout = TRUE, when the agent logs out from Siebel or closes
the browser, then:
1. The Adapter sends a request to release the call if the ReleaseCall
command is enabled in the current call state;
2. The Adapter sends a request to log out the agent from the ACD
group if the LogOut command is enabled in the current state;
3. Only then does the agent log out from Siebel.
Note: This functionality is switch and T-Server dependent. Some
T-Servers may require changes to options in order to keep an active
call on logout.
No
If the value of this parameter is set to FALSE, the Adapter will not
release an established call if an agent closes the browser or logs out
from Siebel.
If the value of this parameter is TRUE and the option AutoLogout =
TRUE, when the agent logs out from Siebel or closes the browser,
then:
1. The Adapter sends a request to release an established call if the
ReleaseCall command is enabled in the current call state;
2. The Adapter sends a request to log out the agent from the ACD
group if the LogOut command is enabled in the current state;
3. Only then does the agent log out from Siebel.
Note: This functionality is switch and T-Server dependent. Some
T-Servers may require changes to options in order to keep an active
call on logout.
322
No
Required
Comment
No
No
Voice switch name, which Voice Callback Server uses for submitting
the Voice callbacks.
No
No
No
The default Callback Type which the Gplus Adapter uses in case the
Callback type information is missing in the request from Siebel.
No
The default routing point, which the Gplus Adapter uses in case the
routing point information is missing in the request from Siebel.
323
Required
Comment
No
Indicates that the work item is kept on the call release event and the
agent must manually click the Interaction Processed button on the
Communication toolbar. This parameter must be synchronized with
the VCB server option callback_processed.
Spaces are allowed after commas, and before and after a hyphen.
For example:
2201, 2205, 2300 - 2374
A valid value can also be a simple file name, or a path and a file name. In
any environment, you can use a simple filename, such as
SupervisorExtensions.txt, for example. Other examples are:
On a Windows platform - C:\siebsrvr\SupervisorExtensions.txt.
On a UNIX platform - /opt/siebsrvr/SupervisorExtensions.txt
324
The named file itself must contain the set of Supervisor Extensions.
The file must contain a set of DNs separated by commas, or a range of
DNs, or a mix, with valid values as defined in the rules above; and in
addition:
New lines can also serve as separators.
The maximum number of Supervisor Extensions is limited by the
allowed size of the file in the operating system.
For example:
2201,2210
2211, 2212
3
2213-2220,
2303 - 2310
7123
8234
9345
If the file name is provided without a path, then the Gplus Adapter will
search for the file in locations defined by the operating system
environment variable path. If the file is not found, then the Gplus
Adapter will search for the file in the following locations:
On a Windows platform - Siebel Server folder\BIN\
On a UNIX platform - Siebel Server folder/lib/
= TRUE
If the switch configuration does not require the phone to be put on the hook,
then set this parameter to FALSE, as follows:
Driver:HangupOnEventReleased
Note:
= FALSE
325
326
Action
No parameter in the
configuration, or <empty
string>
Driver:OutboundPartyContainer
configuration parameters.
OtherDN, or Native
configuration parameters.
ANI
DNIS
Communications toolbar.
Important note!
327
Example 15
= "Originator"
UserData:
(Int) Destination
43262
(Int) Originator
87654
(Str) Destination
str_43262
(Str) Originator
str_87654
And/or
Important note!
If the modification of the work item name is going to be used and if the DNIS
and ANI attributes are represented in the TEvents, then it is recommended to use
the following values:
InboundPartyContainer
ANI
OutboundPartyContainer
DNIS
It is possible to use the modified appearance of the work item name on the
Communications toolbar with a single command using the command data.
Example 16 is an example of the of Command:ConferenceTransferToPhone
device command.
Example 16
= "Originator"
= "ConferenceInit"
Description
CmdData
= "ConferenceTransferToPhone"
OnEditControl
= "TRUE"
Hidden
= "TRUE"
CmdChannelOnFocus = "TRUE"
Profile
328
[CmdData:ConferenceTransferToPhone]
AttachContext
= "TRUE"
RequiredField.@Phone = "?*"
Param.PhoneNumber
= "{@Phone:PhoneTypeLookup}"
= "{@SelectedWorkItem:DriverWorkTrackID}"
Param.Originator
= "{@SelectedDN}"
Param.Destination
= "{@Phone:PhoneTypeLookup}"
When a conference call is initiated from the Siebel toolbar, then the phone
number from the EditControl box on the toolbar and the SelectedDN is the call
destination and the call originator.
When using parameters in the command data (UserData) as a substitution, the
T-Server consult-user-data configuration option must be set to separate and
not set to joint. If the value is set to separate, it separates the UserData
attached to the call and this attached data is kept separate and not overwritten
by the other data from the consultation calls.
"GP Adapter"
which the Adapter waits for an ADDP response from the T-Server. ADDP
is disabled if this parameter is not defined or if the value is set to 0 (zero).
329
T-Server and/or in Adapter log files. The value of this parameter affects the
log generation only. The ADDP polling messages and the algorithm for the
disconnection detection remain the same, regardless of the value set here.
Warning! To avoid the false detection of the disconnect states that might
330
For the switches that do not support the emulation of the work modes, the
value of the Service:AgentWorkMode configuration parameter must be set to
either CHANGE_ME or AgentWorkModeUnknown. The Ericsson MD-110, the
Siemens HiPath DX [previously known as Siemens Realtis-DX (iSDX)], and
the Aspect Call Center are examples of such switches.
If, before logging into Siebel, an agent has a different Ready states on different
DNs that belong to the same Teleset, then, after logging into Siebel, the agent
can synchronize their state on all Teleset DNs by using the Ready/NotReady
commands on the Communications toolbar, which is generally recommended.
When you perform this synchronization of agent states on different DNs, you
may get an error message such as Set is in target state. This indicates
that you were already in the requested state on some DN or DNs on this
Teleset.
331
If, before logging into Siebel, an agent has a DN forwarding state set on any
DN that belongs to the same Teleset, then the DN forwarding state on all
Teleset DNs can be synchronized, which is generally recommended. After
logging into Siebel, you can do this by invoking the ForwardCall or
CancelForwardCall device commands on the Communications toolbar.
If, before logging into Siebel, an agent has set DoNotDisturb (DND) states on
any DN that belongs to the same Teleset, then the DoNotDisturb (DND) states
on all Teleset DNs can be synchronized, which is generally recommended.
After logging into Siebel, the agent can do this by invoking the SetBusy or
CancelBusy device commands on the Communications toolbar.
332
Component/
Feature
Description
AnswerCall
Voice
ReleaseCall
Voice
Release call.
TransferSStep
Voice
TransferMute
Voice
TransferInit
Voice
TransferComplete
Voice
ReconnectCall (previously,
RetrieveCall)
Voice
HoldCall
Voice
ResumeCall
Voice
ResumeInactiveCall
Voice
MakeCall
Voice
ConferenceSStep
Voice
ConferenceInit
Voice
ConferenceComplete
Voice
DeleteFromConference
Voice
LogIn
Voice
Logs in an agent.
LogOut
Voice
333
Component/
Feature
Description
Ready
Voice
NotReady
Voice
ChangeNotReadyState
Voice
SetActiveCall
Voice
ForwardCall
Voice
CancelForwardCall
Voice
ToggleForward
Voice
SetBusy
Voice
CancelBusy
Voice
ChangeBusyState
Voice
AttachData
Voice
SendUserEvent
Voice
UpdateUserData
Voice
DeleteUserData
Voice
QueryAddress
Voice
SendUserEventOnCommDN
Voice
334
Component/
Feature
Description
CallSupervisor
Voice
EmergencyKey
Voice
Expert Contact
KwPreviewIntReject
Expert Contact
KwPartyStatusResponse
Expert Contact
Outbound Contact
PreviewDialingModeOver
Outbound Contact
PreviewRecordRequest
Outbound Contact
UpdateCallCompletionStats
Outbound Contact
RecordProcessed
Outbound Contact
RecordReject
Outbound Contact
Rejects a record.
RequestRecordCancel
Outbound Contact
RecordReschedule
Outbound Contact
Reschedules a record.
ScheduleRecordReschedule
Outbound Contact
DoNotCall
Outbound Contact
335
Name
Description
ChainedRecordRequest
Outbound Contact
AddRecord
Outbound Contact
Voice Callback
VCBCancel
Voice Callback
VCBReschedule
Voice Callback
VCBAdd
Voice Callback
VCBProcessed
Voice Callback
VCBReject
Voice Callback
Component/Feature
Description
SetActiveCall
Voice
DeselectActiveCall
Voice
336
If the agent releases the call then the call is released from the agent DN.
The call between the contacts and the supervisors phones continues.
The calls through the ACD Queue are not distributed to the agent.
After this call is released, the ACD Queue continues to distribute calls to
the agent DN.
337
[Command:CallSupervisor]
;
= "CallSupervisor"
Description
CmdData
= "CallSupervisor"
Hidden
= "TRUE"
CmdChannelOnFocus = "TRUE"
Profile
If the agent releases the call, then the call is released on the supervisors
phone, the contacts phone, and the agents phone;
[Command:EmergencyKey]
;
For Nortel Meridian CallCenterSymposium ONLY!
DeviceCommand
= "EmergencyKey"
Description
= "Emergency request"
CmdData
= "EmergencyKey"
Hidden
= "TRUE"
CmdChannelOnFocus = "TRUE"
Profile
= "Gplus Universal Profile"
[CmdData:EmergencyKey]
Param.TrackingID
"{@SelectedWorkItem:DriverWorkTrackID}"
338
339
Feature/
Configuration
Description
Voice Component
EventDialing
Voice
EventRinging
Voice
EventEstablished
Voice
EventReleased
Voice
EventHeld
Voice
Call is held.
EventRetrieved
Voice
Call is retrieved.
EventUserDataChanged
Voice
EventRegistered
Voice
DN is registered.
EventUnregistered
Voice
DN is unregistered.
EventCallForwardSet
Voice
EventCallForwardCancel
Voice
EventAgentBusy
Voice
EventAgentNotBusy
Voice
EventAgentLogin
Voice
EventAgentLogout
Voice
EventAgentReady
Voice
EventAgentNotReady
Voice
EventServerConnected
Voice
EventServerDisconnected
Voice
EventError
Voice
340
Feature/
Configuration
Description
EventACK
Voice
EventUserEvent
Voice
EventPartyChanged
Voice
EventPartyAdded
Voice
EventPartyDeleted
Voice
EventPartyInfo
Voice
Expert Contact
EventKwPreviewRequest
Expert Contact
EventKwPreviewIntCancel
Expert Contact
EventKwPreviewIntAccepted
Expert Contact
EventKwPreviewIntRejected
Expert Contact
EventKwError
Expert Contact
EventKwAck
Expert Contact
T-Server response.
EventKwOnCallResponse
Expert Contact
EventKwPartyStatusRequest
Expert Contact
EventKwPartyStatusAck
Expert Contact
Outbound Contact
EventCampaignLoaded
Outbound Contact
341
Feature/
Configuration
Description
EventCampaignModeChanged
Outbound Contact
EventCampaignStarted
Outbound Contact
EventCampaignStopped
Outbound Contact
EventCampaignUnloaded
Outbound Contact
EventChainedRecord
Outbound Contact
EventChainedRecordDataEnd
Outbound Contact
EventChainedWorkItemChanged
Outbound Contact
EventCurrentWorkItemChanged
Outbound Contact
EventOCSError
Outbound Contact
EventScheduleCall
Outbound Contact
EventPreviewModeOverAck
Outbound Contact
EventPreviewModeStartAck
Outbound Contact
EventPreviewRecord
Outbound Contact
EventPreviewRecordEmpty
Outbound Contact
EventRecordProcessedAck
Outbound Contact
EventRecordRejectAck
Outbound Contact
EventRecordCancelAck
Outbound Contact
EventRecordRemove
Outbound Contact
EventRecordRescheduleAck
Outbound Contact
EventSchRecordRescheduleAck
Outbound Contact
EventUpdCallComplStatsAck
Outbound Contact
342
Name
Description
EventLogOutTime
Outbound Contact
EventLogOutAck
Outbound Contact
Type
Description
ConnID
Mandatory
CallType
Mandatory
ThisDN
Optional
OtherDN
Optional
ThirdPartyDN
Optional
ANI
Optional
DNIS
Optional
PreviousConn
ID
Optional
ErrorCode
Optional
ErrorMessage
Optional
343
Table 25: The Parameters Used with the Device Events of the Voice Component
(Continued)
Parameter
Name
Type
Description
AgentID
Optional
ThisQueue
Optional
CollectedDigits
Optional
Server Version
Optional
CustomerID
Optional
HomeLocation
Optional
AccessNumber
Optional
Place
Optional
ReferenceID
Optional
CallState
Optional
WorkMode
Optional
ThisTrunk
Optional
ThisDNRole
Optional
MediaType
Optional
All others
Optional
344
CallTypeExt
Description
Unknown or any other The call type is unknown. The Adapter cannot define the
call type based on the call flow.
CallTypeExt value
1 (for Internal)
InternalTo
1 (for Internal)
InternalFrom
1 (for Internal)
Internal
1 (for Internal)
Conference
2 (for Inbound)
Inbound
2 (for Inbound)
Conference
3 (for Outbound)
Outbound
3 (for Outbound)
Conference
4 (for Consult)
ConsultTransfer
4 (for Consult)
ConsultConference
4 (for Consult)
ConsultTo
4 (for Consult)
ConsultFrom
345
The following commands are implemented in the Gplus Adapter and may be
used in the Siebel Communications configuration as device commands. For
information about Siebel device commands, see the Siebel documentation.
346
stringParam
Not used
datasetParam
TrackingID
Optional
ReleaseCall
Description
stringParam
Not used
datasetParam
TrackingID
Optional
ReasonCode
Optional
Attribute
Extensions
Optional
datasetParam
The AttributeExtensions
Parameter on page 279 and
Sending Extensions Attributes
with String and/or Integer Value
Types (Method 1) on page 280.
347
Description
Either the
stringParam or
PhoneNumber
stringParam
must be defined.
datasetParam
TrackingID
PhoneNumber
Optional
Either
PhoneNumber or
stringParam
must be defined.
ReasonCode
Optional
Attribute
Extensions
Optional
<Other
parameters>
348
Optional
<Other
parameters>
Optional
TransferInit
Description
Initiates a two-step transfer of the selected call. The caller is put on hold, and
the current agent dials another agents extension. The CallNofityText
parameter conveys status information to the second agent. The
RemoteConnectStr parameter is required for transfers to another contact center.
Destination number
Either
stringParam or
PhoneNumber
stringParam
must be defined.
datasetParam
TrackingID
PhoneNumber
Optional
Either
PhoneNumber or
stringParam
parameter must
be defined.
ReasonCode
Optional
Attribute
Extensions
Optional
349
<Other
parameters>
Optional
stringParam
Not used
TrackingID
Optional
datasetParam
ReconnectCall
Description
stringParam
Not used
TrackingID
Optional
datasetParam
HoldCall
Description
stringParam
Not used
TrackingID
datasetParam
350
Optional
stringParam
Not used
TrackingID
Optional
ReasonCode
Optional
Attribute
Extensions
Optional
datasetParam
datasetParam
The AttributeExtensions
Parameter on page 279 and
Sending Extensions Attributes
with String and/or Integer Value
Types (Method 1) on page 280.
ResumeCall
Description
stringParam
Not used
TrackingID
Optional
datasetParam
ResumeInactiveCall
Description
stringParam
Not used
TrackingID
datasetParam
Optional
351
TrackingID
Optional
Either the
PhoneNumber
PhoneNumber or
stringParam
must be defined.
ReasonCode
Optional
Attribute
Extensions
Optional
datasetParam
<Other
parameters>
Optional
352
stringParam
TrackingID
Optional
Either the
datasetParam
PhoneNumber
PhoneNumber or
stringParam
parameter must
be defined.
ReasonCode
Optional
Attribute
Extensions
Optional
<Other
parameters>
Optional
353
Description
stringParam
Initiates a two-step conference. The caller is put on hold, and the current agent
dials another agents extension. The CallNofityText parameter conveys the
status information to the second agent. The RemoteConnectStr parameter is
required for conferences between contact centers.
Destination number
TrackingID
Optional
Either the
datasetParam
PhoneNumber
PhoneNumber or
stringParam
must be defined.
ReasonCode
Optional
Attribute
Extensions
Optional
<Other
parameters>
Optional
354
Completes a two-step conference. The caller and the agents in conference can
now talk to each other at the same time.
stringParam
Not used
TrackingID
Optional
datasetParam
DeleteFromConference
Description
Either the
stringParam or
PhoneNumber
stringParam
parameters must
be defined.
TrackingID
Optional
PhoneNumber
Either the
stringParam or
PhoneNumber
parameters must
be defined.
ReasonCode
Optional
Attribute
Extensions
Optional
datasetParam
The AttributeExtensions
Parameter on page 279 and
Sending Extensions Attributes
with String and/or Integer Value
Types (Method 1) on page 280.
355
stringParam
Not used
datasetParam
ACDQueue
Optional
AgentID
Mandatory
AgentID
AgentPin
Optional
Agent password
AgentWork
Mode
Optional
ReasonCode
Optional
Attribute
Extensions
Optional
LogOut
Description
Logs out an agent from one or all of the queues. If the agents teleset contains
multiple DNs, the agent will only be logged out of the first DN.
stringParam
Not used
ReasonCode
datasetParam
356
Optional
Optional
datasetParam
ACDQueue
Optional
Ready
Description
stringParam
Not used
datasetParam
AgentWork
Mode
Optional
ReasonCode
Optional
Attribute
Extensions
Optional
ACDQueue
Optional
357
datasetParam
Not used
AgentWork
Mode
Optional
ReasonCode
Optional
Attribute
Extensions
Optional
ACDQueue
Optional
ChangeNotReadyState
Description
stringParam
Not used
AgentWork
Mode
Optional
ReasonCode
Optional
datasetParam
358
Optional
datasetParam
ACDQueue
Optional
SetActiveCall
Description
stringParam
Not used
datasetParam
TrackingID
Mandatory
ForwardCall
Description
stringParam
PhoneNumber
Either
The destination number. If not
PhoneNumber or present, the stringParam
stringParam must parameter is used.
be defined.
Mode
Optional
datasetParam
CancelForwardCall
Description
stringParam
Not used
359
Optional
datasetParam
ToggleForward
Description
stringParam
datasetParam
parameter must
be defined.
Mode
Optional
SetBusy
Description
Initiates the Do Not Disturb mode for all DNs an agent is logged into.
stringParam
Not used
datasetParam
Not used
CancelBusy
Description
stringParam
Not used
datasetParam
Not used
ToggleForward
Description
stringParam
Either the
stringParam or
PhoneNumber
parameter must
be defined.
360
PhoneNumber
Either the
PhoneNumber or
stringParam
parameter must
be defined.
Mode
Optional
ChangeBusyState
Description
stringParam
Not used
datasetParam
Not used
AttachData
Description
Attaches the user data to the selected call. Note that the user data name
TrackingID is invalid.
stringParam
N/A
N/A
TrackingID
Optional
<Other
parameters>
Optional
datasetParam
361
[CmdData:SendUserEvent]
AttachContext = "TRUE"
Param.ThisDN = "{@SelectedDN}"
Param.Attribute.AgentID = "Attribute_AgentID"
Param.Attribute.ConnID = "12340d0000000000"
Param.\Attribute.AgentID = "UserData_Attribute.AgentID"
Param.\Attribute.ConnID = "UserData_84321"
Param.\ = "This_Is_\"
Param.AgentID = "UserData_AgentID"
362
This_Is_\
UserData_84321
UserData_Attribute.AgentID
UserData_AgentID
Selected DN (see
Description)
Optional
TrackingID
Optional
<Other
parameters>
Optional
datasetParam
UpdateUserData
Description
stringParam
N/A
N/A
TrackingID
Optional
<Other
parameters>
Optional
datasetParam
PhoneNumber
DeleteUserData
Description
Removes user data, specified by <Other parameters> from the user data
attached to the selected call.
Note: The user data name TrackingID is invalid.
stringParam
N/A
N/A
TrackingID
Optional
<Other
parameters>
Optional
datasetParam
PhoneNumber
CallSupervisor
Description
When the agent is on an ACD call, this command initiates a conference leg to
the agents supervisor. For that call leg to be established, the supervisor must
push the Answer Agent key to complete the call leg to the supervisor. For more
details, see The CallSupervisor DeviceCommand Object on page 337.
stringParam
Not Used
363
TrackingID
must be defined.
Optional
Either
PhoneNumber or
stringParam
<Other parameters>
AttributeExtensions,
StringAttributeExtensions,
IntAttributeExtensions
Description
stringParam
Not Used
datasetParam
TrackingID
<Other parameters>
Optional
364
Description
stringParam
Not Used
datasetParam
ThisDN
Optional
ACDQueue
Optional
AddressType
(AddressType
Position)
Optional
AddressInfo
Type
Optional
Attribute Extensions
Optional
*The QueryAddress device command together with the set of command data parameters that are
defined in a sample GenComm_universal.def file, synchronize the state of the Communications
toolbar and the state of the agent on a Lucent Definity G3 switch. For more information about
other switches and how to define the corresponding command data parameters for the
QueryAddress device command, see the T-Server documentation related to the switch you are
using.
365
stringParam
Destination number
Optional
TrackingID
Optional
<Other
parameters>
Optional
datasetParam
AlternateCall
Description
Places the active call on hold and reconnects the previously held call.
stringParam
ActiveCallID
Optional
HeldCallID
Mandatory
datasetParam
datasetParam
Send DTMF
Description
Sends the digits that are interpreted by an interactive voice response system.
stringParam
TrackingID
Optional
Digits
Mandatory
ReasonCode
Optional
datasetParam
366
Optional
datasetParam
Description
Enables the supervisors monitoring of the next call that comes to the agent.
The supervisors DN is either the currently selected extension in the
Communications view in the User Preferences screen (the selected DN) or
taken from the ThisDN parameter.
Either the
stringParam or
PhoneNumber
stringParam
parameter must
be defined.
TrackingID
Optional
ThisDN
Optional
PhoneNumber
Either
The agents DN that is
PhoneNumber or monitored. If not present, the
stringParam must stringParam is used.
be defined.
Monitor Type
Optional
datasetParam
367
Optional
Attribute Extensions
Optional
datasetParam
The AttributeExtensions
Parameter on page 279 and
Sending Extensions Attributes
with String and/or Integer Value
Types (Method 1) on page 280.
Cancel Monitoring
Description
Cancels the supervisors monitoring of the next call that comes to the agent.
The supervisors DN is either the currently selected extension in the
Communications view in the User Preferences screen (the selected DN) or
taken from the ThisDN parameter.
Either the
stringParam or
PhoneNumber
stringParam
parameter must
be defined.
TrackingID
Optional
ThisDN
Optional
Either the
datasetParam
PhoneNumber
stringParam or
PhoneNumber
parameter must
be defined.
368
Optional
datasetParam
ReasonCode
Optional
Attribute Extensions
Optional
SetActiveCampaign
Description
stringParam
parameter must
be defined.
CampaignName
datasetParam
Either the
stringParam or
PhoneNumber
parameter must
be defined.
369
Notifies the driver that a call has been selected in the Communications
Toolbar. The driver updates all of the command statuses for the newly selected
call.
stringParam
Not used
datasetParam
TrackingID
Mandatory
DeselectActiveCall
Description
Notifies the driver that the recent call has been deselected in the
Communications Toolbar. The driver updates all of the command statuses for
the newly selected call.
stringParam
Not used
datasetParam
SelectedTrackingID
Mandatory
DeselectedTrackingID
Mandatory
KwOnCall
KwPreviewIntReject
KwPartyStatusResponse
370
PreviewDialingModeStar
PreviewDialingModeOver
PreviewRecordRequest
UpdateCallCompletionStats
RecordProcessed
RecordReject
RequestRecordCancel
RecordReschedule
ScheduledRecordReschedule
DoNotCall
ChainedRecordRequest
AddRecord
PreviewDialingModeStart
Description
OCS Action
Mandatory Fields
Additional Fields
GSW_APPLICATION_ID
GSW_CAMPAIGN_NAME
Not specified
PreviewDialingModeOver
Command Name
PreviewDialingModeOver
Description
OCS Action
Mandatory Fields
Additional Fields
GSW_APPLICATION_ID
GSW_CAMPAIGN_NAME
Not specified
371
PreviewRecordRequest
Description
OCS Action
Mandatory Fields
Additional Fields
GSW_APPLICATION_ID
GSW_CAMPAIGN_NAME
Not specified
UpdateCallCompletionStats
Command Name
UpdateCallCompletionStats
Description
OCS Action
Mandatory Fields
GSW_CAMPAIGN_NAME
GSW_RECORD_HANDLE
Additional Fields
RecordProcessed
Command Name
RecordProcessed
Description
OCS Action
372
GSW_CAMPAIGN_NAME
GSW_CALLING_LIST
GSW_RECORD_HANDLE
Additional Fields
RecordReject
Command Name
RecordReject
Description
OCS Action
GSW_APPLICATION_ID
Mandatory Fields
GSW_CAMPAIGN_NAME
GSW_CALLING_LIST
GSW_RECORD_HANDLE
Additional Fields
Not specified
RequestRecordCancel
Command Name
RequestRecordCancel
Description
OCS Action
373
}
else
{
GSW_PHONE
GSW_CAMPAIGN_NAME (optional)
}
GSW_CHAIN_ATTR = AllChain
Additional Fields
Or
GSW_CHAIN_ATTR = RecordOnly
RecordReschedule
Command Name
RecordReschedule
Description
OCS Action
Mandatory Fields
GSW_RECORD_HANDLE
GSW_DATE_TIME
GSW_CALLBACK_TYPE
Additional Fields
Not specified
ScheduledRecordReschedule
Command name
ScheduledRecordReschedule
Description
OCS Action
374
GSW_RECORD_HANDLE
GSW_DATE_TIME
GSW_CALLBACK_TYPE
Additional Fields
Not specified
DoNotCall
Command Name
DoNotCall
Description
OCS Action
Mandatory Fields
else
{
2) GSW_PHONE
}
else
{
3) GSW_CUSTOMER_ID
}
Additional Fields
Not specified
375
1. USE_RECORD_HANDLE
2. USE_PHONE
3. USE_CUSTOMER_ID
Tells the Adapter which set of mandatory fields are
sent to Outbound Contact Server.
ChainedRecordRequest
Command Name
ChainedRecordRequest
Description
OCS Action
Mandatory Fields
GSW_APPLICATION_ID
GSW_CAMPAIGN_NAME
GSW_RECORD_HANDLE
Additional Fields
Not specified
AddRecord
Command Name
AddRecord
Description
OCS Action
376
GSW_CALLING_LIST
GSW_PHONE
GSW_TZ_NAME
Any user-defined fields.
Note: The key in a key-value pair should be equal
to the send_attribute of the field that you are
required to add.
The default field values (if not specified in a
request) are as follows:
GSW_PHONE_TYPE: 2, DirectBusinessPhone
GSW_RECORD_TYPE: 2, General
GSW_RECORD_TYPE: 2, General
Additional Fields
GSW_RECORD_STATUS: 1, Ready
GSW_CALL_RESULT: 28, Unknown
GSW_ATTEMPTS: 0
GSW_DATE_TIME: 0
GSW_CALL_TIME: 0
GSW_FROM: 28800 (8 AM)
GSW_UNTIL: 64800 (6 PM)
GSW_AGENT_ID: 0
VCBServiceStatus
RequestCallbackServiceStatus
VCBQuery
RequestCallbackQuery
VCBQueryResult
RequestCallbackQueryResult
VCBCancel
RequestCallbackCancel
377
VCBReschedule
RequestCallbackReschedule
VCBAdd
RequestCallbackAdd
VCBPreview
RequestCallbackPreview
VCBProcessed
RequestCallbackProcessed
VCBReject
RequestCallbackReject
VCBServiceStatus
(RequestCallbackServiceStatus)
Description
Mandatory Fields
VCB_REFERENCE_ID
VCB_STATUS: 0
Additional Fields
VCB_ROUTING_POINT
VCB_LOCATION
VCBQuery
Command Name
VCBQuery
(RequestCallbackQuery)
Description
378
Additional Fields
VCBQueryResult
Command Name
VCBQueryResult
(RequestCallbackQueryResult)
Description
Mandatory Fields
VCB_TARGET_APPLICATION_ID
VCB_REFERENCE_ID
VCB_QUERY_INDEX
Additional Fields
Not specified
VCBCancel
Command Name
VCBCancel
(RequestCallbackCancel)
Description
379
VCB_TARGET_APPLICATION_ID
VCB_REFERENCE_ID
VCB_RECORD_HANDLE (or VCB_CONTACT)
Additional Fields
Not specified
VCBReschedule
Command Name
VCBReschedule
(RequestCallbackReschedule)
Description
Mandatory Fields
VCB_REFERENCE_ID
VCB_RECORD_HANDLE
VCB_CALL_RESULT
Additional Fields
VCBAdd
Command Name
VCBAdd
(RequestCallbackAdd)
Description
380
VCB_CONTACT
VCB_TYPE: 1, ASAP
VCB_ORIGIN
VCB_ROUTING_POINT
VCB_LOCATION
Additional Fields
VCBPreview
Command Name
VCBPreview
(RequestCallbackPreview)
Description
Desktop Action
Mandatory Fields
VCB_REFERENCE_ID
VCB_RECORD_HANDLE
VCB_CONTACT
VCB_CALL_RESULT
All UserData attributes from Callback Request
Additional Fields
VCBProcessed
Command Name
Description
VCBProcessed
(RequestCallbackProcessed)
The agents desktop submits the record processing
results to the VCB server.
381
Mandatory Fields
VCB_REFERENCE_ID
VCB_RECORD_HANDLE
VCB_CALL_RESULT
Additional Fields
VCBReject
VCBReject
Command Name
(RequestCallbackReject)
Description
Mandatory Fields
VCB_REFERENCE_ID
VCB_RECORD_HANDLE
Additional Fields
382
EventDialing
Desktop Action
TEvent Name
EventDialing
Description
TrackingID
Attributes
EventRinging
Siebel CRM DeviceEvent Name
EventRinging
Desktop Action
TEvent Name
EventRinging
Description
TrackingID
Attributes
EventEstablished
Siebel CRM DeviceEvent Name
EventEstablished
Desktop Action
TEvent Name
EventEstablished
Description
TrackingID
383
EventReleased
Siebel CRM DeviceEvent Name
EventReleased
Desktop Action
TEvent Name
EventReleased
Description
TrackingID
Attributes
EventHeld
Siebel CRM DeviceEvent Name
EventHeld
Desktop Action
TEvent Name
EventHeld
Description
TrackingID
Attributes
EventRetrieved
Siebel CRM DeviceEvent Name
EventRetrieved
Desktop Action
TEvent Name
EventRetrieved
Description
TrackingID
Not applicable.
384
EventUserDataChanged
Siebel CRM DeviceEvent Name
EventUserDataChanged
Desktop Action
N/A
TEvent Name
EventAttachedDataChanged
Description
TrackingID
Attributes
EventRegistered
Siebel CRM DeviceEvent Name
EventRegistered
Desktop Action
N/A
TEvent Name
EventRegistered
Description
TrackingID
Not applicable.
Attributes
EventUnregistered
Siebel CRM DeviceEvent Name
EventUnregistered
Desktop Action
N/A
TEvent Name
EventUnregistered
Description
TrackingID
Not applicable.
Attributes
385
EventCallForwardSet
Desktop Action
TEvent Name
EventForwardSet
Description
TrackingID
Not applicable.
Attributes
EventCallForwardCancel
Siebel CRM DeviceEvent Name
EventCallForwardCancel
Desktop Action
TEvent Name
EventForwardCancel
Description
TrackingID
Not applicable.
Attributes
EventAgentBusy
Siebel CRM DeviceEvent Name
EventAgentBusy
Desktop Action
N/A
TEvent Name
EventDNDOn
Description
TrackingID
Not applicable.
Attributes
386
EventAgentNotBusy
Desktop Action
N/A
TEvent Name
EventDNDOff
Description
TrackingID
Not applicable.
Attributes
EventAgentLogin
Siebel CRM DeviceEvent Name
EventAgentLogin
Desktop Action
TEvent Name
EventAgentLogin
Description
TrackingID
Not applicable.
Attributes
EventAgentLogout
Siebel CRM DeviceEvent Name
EventAgentLogout
Desktop Action
TEvent Name
EventAgentLogout
Description
TrackingID
Not applicable.
Attributes
387
EventAgentReady
Desktop Action
TEvent Name
EventAgentReady
Description
TrackingID
Not applicable.
Attributes
EventAgentNotReady
Siebel CRM DeviceEvent Name
EventAgentNotReady
Desktop Action
TEvent Name
EventAgentNotReady
Description
TrackingID
Not applicable.
Attributes
EventServerConnected
Siebel CRM DeviceEvent Name
EventServerConnected
Desktop Action
TEvent Name
EventLinkConnected
Description
TrackingID
Not applicable.
Attributes
None
388
EventServerDisconnected
Desktop Action
TEvent Name
EventLinkDisconnected
Description
TrackingID
Not applicable.
Attributes
None
EventError
Siebel CRM DeviceEvent Name
EventError
Desktop Action
TEvent Name
EventError
Description
TrackingID
Attributes
ErrorCode
EventUserEvent
Siebel CRM DeviceEvent Name
EventUserEvent
Desktop Action
N/A
TEvent Name
EventUserEvent
Description
TrackingID
Not applicable
Attributes
389
EventPartyChanged
Desktop Action
TEvent Name
EventPartyChanged
Description
TrackingID
Attributes
EventPartyAdded
Siebel CRM DeviceEvent Name
EventPartyAdded
Desktop Action
TEvent Name
EventPartyAdded
Description
TrackingID
Attributes
EventPartyDeleted
Siebel CRM DeviceEvent Name
EventPartyDeleted
Desktop Action
TEvent Name
EventPartyDeleted
Description
390
Attributes
EventKwPreviewIntError
EventKwPreviewRequest
EventKwPreviewIntCancel
EventKwPreviewIntAccepted
EventKwPreviewIntRejected
EventKwError
EventKwAck
EventKwOnCallResponse
EventKwPartyStatusRequest
EventKwPartyStatusAck
For more details about these events, contact Genesys Technical Support.
391
392
EventAddRecordAck
EventCampaignGroupAssigned
EventCampaignLoaded
EventCampaignModeChanged
EventCampaignStarted
EventCampaignStopped
EventCampaignUnloaded
EventChainedRecord
EventChainedRecordDataEnd
EventChainedWorkItemChanged
EventCurrentWorkItemChanged
EventOCSError
EventRecordCancel
EventScheduledCall
EventPreviewModeOverAck
EventPreviewModeStartAck
EventPreviewRecord
EventPreviewRecordEmpty
EventRecordCancelAck
EventRecordRejectAck
EventRecordCancelAck
EventRecordRemove
EventRecordProcessedAck
EventRecordRejectAck
EventRecordRescheduleAck
EventSchRecordRescheduleAck
EventUpdCallComplStatsAckn
EventLogOutTime
EventLogOutAck
EventAddRecordAck
AddRecordAcknowledge
Description
TrackingID
Desktop Action
Continue session.
GSW_APPLICATION_ID
Attributes
GSW_CAMPAIGN_NAME
GSW_CALLING_LIST
EventCampaignGroupAssigned
Siebel CRM DeviceEvent Name:
EventCampaignGroupAssigned
CampaignGroupAssigned
Description
TrackingID
Desktop Action
Attributes
GSW_CAMPAIGN_GROUP_DESCRIPTION
GSW_CAMPAIGN_NAME
GSW_CAMPAIGN_DESCRIPTION
EventCampaignLoaded
Siebel CRM DeviceEvent Name:
EventCampaignLoaded
CampaignLoaded
Description
TrackingID
393
Attributes
GSW_CAMPAIGN_NAME
GSW_CAMPAIGN_DESCRIPTION
EventCampaignModeChanged
Siebel CRM DeviceEvent Name:
EventCampaignModeChanged
CampaignModeChanged
Description
TrackingID
Desktop Action
Attributes
GSW_CAMPAIGN_NAME
GSW_CAMPAIGN_MODE
EventCampaignStarted
Siebel CRM DeviceEvent Name:
EventCampaignStarted
CampaignStarted
Description
TrackingID
Desktop Action
Attributes
GSW_CAMPAIGN_NAME
GSW_CAMPAIGN_MODE
GSW_CAMPAIGN_DESCRIPTION
EventCampaignStopped
Siebel CRM DeviceEvent Name:
EventCampaignStopped
CampaignStopped
394
TrackingID
Desktop Action
Attributes
GSW_APPLICATION_ID
GSW_CAMPAIGN_NAME
EventCampaignUnloaded
Siebel CRM DeviceEvent Name:
EventCampaignUnloaded
CampaignUnloaded
Description
TrackingID
Desktop Action
Attributes
GSW_CAMPAIGN_NAME
GSW_CAMPAIGN_DESCRIPTION
EventChainedRecord
Siebel CRM DeviceEvent Name:
EventChainedRecord
ChainedRecord
Description
TrackingID
Desktop Action
395
GSW_CALLING_LIST
GSW_RECORD_HANDLE
GSW_PHONE
GSW_CALL_RESULT GSW_CHAIN_ID
Genesys and user-defined fields having send attributes.
EventChainedRecordDataEnd
Siebel CRM DeviceEvent Name:
EventChainedRecordDataEnd
ChainedRecordDataEnd
Description
TrackingID
Desktop Action
Attributes
GSW_CALLING_LIST
GSW_RECORD_HANDLE
GSW_CHAIN_ID
EventChainedWorkItemChanged
Siebel CRM DeviceEvent Name:
EventChainedWorkItemChanged
N/A
Description
Gplus Adapter sends notification that the current work item has changed,
and that the previous and the current work items belong to the same chain.
Sent in response to the command, SetActiveCall.
TrackingID
Desktop Action
Attributes
396
N/A
EventCurrentWorkItemChanged
N/A
Description
Gplus Adapter sends notification that the current work item has changed.
Sent in response to the command, SetActiveCall.
TrackingID
Desktop Action
Attributes
N/A
EventOCSError
Siebel CRM DeviceEvent Name:
EventOCSError
Error
Description
TrackingID
Desktop Action
Attributes
GSW_CAMPAIGN_NAME
GSW_CAMPAIGN_NAME
GSW_ERROR_NAME
EventRecordCancel
Siebel CRM DeviceEvent Name:
EventRecordCancel
RecordCancel
Description
OCS sends an event to desktop to indicate that this record should not be
dialed.
Applicable to preview records and scheduled callbacks.
TrackingID
Desktop Action
397
GSW_CAMPAIGN_NAME
GSW_CALLING_LIST
GSW_RECORD_HANDLE
EventScheduledCall
Siebel CRM DeviceEvent Name:
EventScheduledCall
ScheduledCall
Description
TrackingID
Desktop Action
Attributes
GSW_RECORD_HANDLE
GSW_PHONE
GSW_CALL_RESULT
GSW_CALLBACK_TYPE
Genesys and user-defined fields having send attributes.
EventPreviewModeOverAck
Siebel CRM DeviceEvent Name:
EventPreviewModeOverAck
PreviewDialingModeOverAcknowledge
Description
TrackingID
Desktop Action
Desktop is unable to send requests to OCS and receive callbacks (see the
OCS configuration option, agent_preview_mode_start).
398
GSW_APPLICATION_ID
GSW_CAMPAIGN_NAME
EventPreviewModeStartAck
Siebel CRM DeviceEvent Name:
EventPreviewModeStartAck
PreviewDialingModeStartAcknowledge
Description
TrackingID
Desktop Action
Desktop can send requests to OCS and receive callbacks (see the
agent_preview_mode_start configuration option).
Attributes
GSW_APPLICATION_ID
GSW_CAMPAIGN_NAME
EventPreviewRecord
Siebel CRM DeviceEvent Name:
EventPreviewRecord
PreviewRecord
Description
TrackingID
Desktop Action
Attributes
GSW_CALLING_LIST
GSW_RECORD_HANDLE
GSW_PHONE
GSW_CALL_RESULT
Genesys and user-defined fields having send attributes.
399
EventPreviewRecordEmpty
PreviewRecordEmpty
Description
TrackingID
Desktop Action
Attributes
GSW_APPLICATION_ID
GSW_CAMPAIGN_NAME
EventRecordCancelAck
Siebel CRM DeviceEvent Name:
EventRecordCancelAck
RecordCancelAcknowledge
Description
TrackingID
Desktop Action
Attributes
GSW_RECORD_HANDLE
}
else
{
GSW_PHONE
}
400
EventRecordRejectAck
RecordRejectAcknowledge
Description
TrackingID
Desktop Action
Attributes
GSW_CAMPAIGN_NAME
GSW_CALLING_LIST
GSW_RECORD_HANDLE
EventRecordCancelAck
Siebel CRM DeviceEvent Name:
EventRecordCancelAck
RecordCancelAcknowledge
Description
TrackingID
Desktop Action
Attributes
GSW_RECORD_HANDLE
}
else
{
GSW_PHONE
}
401
EventRecordRemove
N/A
Description
Gplus Adapter sends a request to remove the record from the desktop.
TrackingID
Desktop Action
Attributes
N/A
EventRecordProcessedAck
Siebel CRM DeviceEvent Name:
EventRecordProcessedAck
RecordProcessedAcknowledge
Description
TrackingID
Desktop Action
Attributes
GSW_CAMPAIGN_NAME
GSW_CALLING_LIST
GSW_RECORD_HANDLE
EventRecordRejectAck
Siebel CRM DeviceEvent Name:
EventRecordRejectAck
RecordRejectAcknowledge
Description
TrackingID
Desktop Action
Attributes
GSW_CAMPAIGN_NAME
GSW_CALLING_LIST
GSW_RECORD_HANDLE
402
EventRecordRescheduleAck
RecordRescheduleAcknowledge
Description
TrackingID
Desktop Action
Attributes
GSW_CALLING_LIST
GSW_RECORD_HANDLE
GSW_DATE_TIME
GSW_CALLBACK_TYPE
EventSchRecordRescheduleAck
Siebel CRM DeviceEvent Name:
EventSchRecordRescheduleAck
ScheduledRecordRescheduleAcknowledge
Description
TrackingID
Desktop Action
Attributes
GSW_CALLING_LIST
GSW_RECORD_HANDLE
GSW_DATE_TIME
GSW_CALLBACK_TYPE
EventUpdCallComplStatsAckn
Siebel CRM DeviceEvent Name:
EventUpdCallComplStatsAck
UpdateCallCompletionStatsAcknowledge
Description
TrackingID
403
Attributes
GSW_CAMPAIGN_NAME
GSW_CALLING_LIST
GSW_RECORD_HANDLE
EventLogOutTime
Siebel CRM DeviceEvent Name:
EventLogOutTime
UpdateEventLogOutTime
Description
TrackingID
Desktop Action
Attributes
GSW_CAMPAIGN_NAME
GSW_LOGOUT_TIME
EventLogOutAck
Siebel CRM DeviceEvent Name:
EventLogOutAck
UpdateEventLogOutAcknowledge
Description
TrackingID
Desktop Action
Attributes
404
GSW_APPLICATION_ID
GSW_CAMPAIGN_NAME
EventAddVCBRequestt
RequestCallbackAdd
EventVCBServiceStatus
RequestCallbackServiceStatus
EventVCBQuery
RequestCallbackQuery
RequestCallbackCancel
EventVCBReschedule
RequestCallbackReschedule
EventVCBPreview
RequestCallbackPreview
EventVCBProcessed
RequestCallbackProcessed
EventVCBReject
RequestCallbackReject
EventAddVCBRequest
AddCallbackRequest
Description
The VCB Server sends this response to the VCB Client to confirm
that the request has been processed.
Client Action
Not specified
405
VCB_REFERENCE_ID
VCB_RESPONSE_TYPE = 0 Acknowledge
VCB_ERROR_CODE
VCB_ERROR_NAME
EventVCBServiceStatus
Gplus Adapter Event Name:
EventVCBServiceStatus
RequestCallbackServiceStatus
Description
The VCB Server sends this response to the VCB Client to confirm
the availability of the Voice Callback service.
Client Action
Attributes
VCB_RESPONSE_TYPE = 2 MultipleResult
or
VCB_RESPONSE_TYPE = 3 MultipleResultEnd
VCB_LOCATION
VCB_ROUTING_POINT
VCB_ROUTING_POINT_DESCR
VCB_ERROR_CODE
VCB_ERROR_NAME
406
EventVCBQuery
RequestCallbackQuery
Description
The VCB Server sends this response back to the Client Server to
acknowledge the query execution and to provide the number of
callback requests in a result set.
Client Action
Attributes
VCB_RESPONSE_TYPE = 0 Acknowledge
VCB_QUERY_COUNT
VCB_ERROR_CODE
VCB_ERROR_NAME
EventVCBQueryResult
Gplus Adapter Event Name:
EventVCBQueryResult
RequestCallbackQueryResult
Description
The VCB Server sends to the Client Server the callback request for
the callback query.
Client Action
Collect data.
VCB_ORIGIN_APPLICATION_ID
VCB_TARGET_APPLICATION_ID
VCB_REFERENCE_ID
VCB_RESPONSE_TYPE = 1 SingleResult
Attributes
VCB_RECORD_HANDLE
VCB_CURRENT_DN
VCB_QUERY_INDEX
VCB_ERROR_CODE
VCB_ERROR_NAME
UserData
407
EventVCBCancel
RequestCallbackCancel
Description
The VCB Server sends this request to the VCB Client to confirm the
cancellation of the callback request.
Client Action
Attributes
VCB_RESPONSE_TYPE = 0 Acknowledge
VCB_RECORD_HANDLE (or VCB_CONTACT)
VCB_ERROR_CODE
VCB_ERROR_NAME
EventVCBReschedule
Gplus Adapter Event Name:
EventVCBReschedule
RequestCallbackReschedule
Description
The VCB Server sends this request to the VCB Client to confirm the
rescheduling of the callback request.
Client Action
Attributes
VCB_RESPONSE_TYPE = 0 Acknowledge
VCB_RECORD_HANDLE
VCB_ERROR_CODE
VCB_ERROR_NAME
408
EventVCBPreview
RequestCallbackPreview
Description
Desktop confirms that the callback request has been received and
accepted.
Not specified
VCB_ORIGIN_APPLICATION_ID
VCB_TARGET_APPLICATION_ID
Attributes
VCB_REFERENCE_ID
VCB_RESPONSE_TYPE = 0 Acknowledge
VCB_RECORD_HANDLE
EventVCBProcessed
Gplus Adapter Event Name:
EventVCBProcessed
RequestCallbackProcessed
Description
The VCB Server sends this request to the desktop to confirm that the
corresponding request has been processed.
Desktop Action
Not specified
VCB_ORIGIN_APPLICATION_ID
VCB_TARGET_APPLICATION_ID
Attributes
VCB_REFERENCE_ID
VCB_RESPONSE_TYPE = 0 Acknowledge
VCB_RECORD_HANDLE
409
EventVCBReject
RequestCallbackReject
Description
The VCB Server sends this request to the desktop to confirm that the
corresponding request has been rejected.
Desktop Action
Not specified
VCB_ORIGIN_APPLICATION_ID
VCB_TARGET_APPLICATION_ID
Attributes
VCB_REFERENCE_ID
VCB_RESPONSE_TYPE = 0 Acknowledge
VCB_RECORD_HANDLE
EventVCBError
Gplus Adapter Event Name:
EventVCBError
RequestCallbackError
Description
The VCB Server sends this request to the desktop to inform about an
error condition.
Desktop Action
Removes the work item from the desktop when the value of the ERR#
is {100, 102, 103, 104, 108} and keeps it when the value of the
ERR# is {101, 105, 106 }.
VCB_ERROR
VCB_ ERROR_ NUMBER
Attributes
VCB_ORIGIN_APPLICATION_ID
VCB_TARGET_APPLICATION_ID = 0
VCB_REFERENCE_ID
VCB_ RESPONSE _TYPE= 4 Error
410
VCB_ERROR_ Description
NUMBER
Invalid Request
100
101
102
103
DB Error
105
AddRecordError
106
ScheduleRecordError
108
Value
Type
Description
VCB_USER_EVENT_REQUEST
String
String
Int
Type of response
0, Acknowledge
1, SingleResult
2, MultipleResult
3, MultipleResultEnd
4, Error
411
Value
Type
VCB_TARGET_APPLICATION_ID Application ID
Int
VCB_ORIGIN_APPLICATION_ID
Application ID
Int
VCB_REFERENCE_ID
Session-wide unique
request identifier
Int
VCB_CALL_RESULT
0, "Ok"
Int
3, "General Error"
4, "System Error"
6, "Busy"
7, "No Answer"
8, "SIT Detected"
9, "Answering Machine"
10, "All Trunks Busy"
11, "SIT Invalid Num"
12, "SIT Vacant"
13, "SIT Oper Intercept"
14, "SIT Unknown"
15, "SIT No Circuit"
16, "SIT Reorder"
17, "Fax Detected"
21, "Abandoned"
26, "Dropped"
27, "Dropped No
Answer"
28, "Unknown"
32, "Silence"
33, "Answer"
34, "NuTone"
35, "NoDialTone"
36, "NoProgress"
37, "NoRingBack"
38, "NoEstablishe"
39, "Pager Detected"
40, "Wrong Party"
412
Description
Maintained by requestor
Call result from the previous dial
attempt or the call result that the
agent sends to automatically
change the detected one.
Value
Type
Description
Int
VCB_CALL_RESULT (Continued) 41, "Dial Error"
42, "Call Drop Error"
43, "Switch Error"
44, "No Free Port Error"
45, "Transfer Error"
46, "Stale"
47, "Agent CallBack
Error"
48, "Group CallBack
Error
VCB_ERROR_CODE
VCB_ERROR_NAME
Int
Error Name
String
VCB_RESPONSE_TYPE = 4 Error
VCB_CURRENT_DN
DN Number
String
VCB_CONTACT
String of digits
String
VCB_TYPE
0, Unknown
String
Callback Type
String
Int
1, ASAP
2, Scheduled
VCB_QUEUE
VCB_STAGE
0, Unknown
1, Queued
2, NotQueued
VCB_ROUTING_POINT
413
Value
Type
Description
VCB_LOCATION
Name of Switch
String
VCB_DATE_TIME
MMDDYYYYHHMM String
VCB_EWT
HHMM
VCB_EWT_TIME
MMDDYYYYHHMM String
VCB_ATTEMPTS
0...
Int
VCB_ORIGIN
0, Unknown
String
Callback origination
String
String
String
1, IVR
2, WEB
3, Desktop
VCB_TZ_NAME
VCB_STATUS
0, Unknown
1, Not Available
2, Available
VCB_QUERY_COUNT
0...
Int
VCB_QUERY_INDEX
1...
Int
CRM_RECORD_MODE
"Preview"
String
"Auto"
CRM_REFERENCE_ID
CRM_IS_VCB_VIEW
String
TRUE
String
String
FALSE
CRM_PROTOCOL_EXT
OCS
VCB
414
Chapter
Overview
The Gplus UCS Gateway Server for Siebel CRM is a back-end component
used by the Gplus Adapter for Siebel CRM Multimedia Component to access
the data stored in the Genesys Universal Contact Server.
The process of configuring and installing the Campaign Synchronization
Component includes the following general procedures:
Configuring Genesys
Configuring Siebel.
415
Release 8.0.0
Support for the Red Hat Enterprise Linux (RHEL) operating system.
Configuring Genesys
This chapter describes how to configure and install the Gplus UCS Gateway
Server for Siebel CRM.
Configuring the Genesys side of the Gplus UCS Gateway Server for Siebel
CRM consists of the following sections:
Prestart Information, page 416
Importing the Gplus UCS Gateway Server for Siebel CRM Application
Template, page 416
Creating the Gplus UCS Gateway Server for Siebel CRM Application
Object, page 418
Configuring the Tabs in the Properties Dialog Box, page 418
Setting the Genesys Configuration Options for the Gplus UCS Gateway
Server for Siebel CRM, page 422
Prestart Information
Before starting the configuration process you should have the following
Genesys Framework applications running:
Configuration Database
Configuration Server
Configuration Manager
416
Configuring Genesys
Recommendations
Genesys recommends using an Application Template when you are
configuring your Adapter. The Application Template for your Adapter contains
the most important configuration options set to the values recommended for
the majority of environments. When modifying configuration options for your
Adapter later in the process, you can change the values inherited from the
template rather than create all the options by yourself.
Procedure:
USC Gateway Server: Importing the USC Gateway
Server Application Template
Purpose: To import the Gplus UCS Gateway Server for Siebel CRM
Application Template.
Start of procedure
1. In Configuration Manager, under Environment, right-click the Application
Templates folder.
2. Select Import Application Template.
3. Browse to select the Application Template for the Gplus UCS Gateway
Server for Siebel CRM.
4. Select the following template, as follows:
Release 8.0.0: Gplus_UCS_Gateway_for_SiebelCRM_800.apd
Release 8.0.1: Gplus_UCS_Gateway_for_SiebelCRM_801.apd
5. Click Open.
The Properties dialog box for the Application Template object displays.
6. Optional: Edit the Application Template name.
7. Click OK to accept the default values.
The Application Template object has been imported to Genesys
Configuration Layer.
End of procedure
Next Steps
Create the Configuration Layer Application object for the Gplus UCS
Gateway Server for Siebel CRM. See, Procedure: UCS Gateway Server:
Creating the UCS Gateway Server Application object, on page 418.
417
Configuring Genesys
Procedure:
UCS Gateway Server: Creating the UCS Gateway
Server Application object
Purpose: To create the Application object for the Gplus UCS Gateway Server
for Siebel CRM.
Start of procedure
1. In Configuration Manager, under Environment, right-click the Applications
folder.
2. Select New > Application.
3. Select the Application template that you just created:
Release 8.0.0: Gplus_UCS_Gateway_for_SiebelCRM_800.apd
Release 8.0.1: Gplus_UCS_Gateway_for_SiebelCRM_801.apd
4. Click OK.
The Properties dialog box for the Application object appears.
End of procedure
Next Steps
Configure the tabs in the Properties dialog box for the UCS Gateway
Server. See, Configuring the Tabs in the Properties Dialog Box.
Procedure:
UCS Gateway Server: Configuring the tabs in the
Properties dialog box
Purpose: To configure the tabs in the Properties dialog box for the Gplus
UCS Gateway Server for Siebel CRM.
418
Configuring Genesys
Start of procedure
General Tab
1. Click the General tab in the Properties dialog box (see Figure 37 on
page 419).
2. In the Name list, click the name of the Application object that you are
configuring.
3. In the Template list, click the name of the template that you are configuring
or use the Browse button to select the template that you are configuring.
4. Click Apply.
5. Next, if you are working in a multi-tenant environment, go to the Tenants
Tab; otherwise, go to the Server Info Tab.
Note: The Tenants tab only displays, if you are working in a multi-tenant
environment.
419
Tenants Tab
Configuring Genesys
Gateway Server to receive HTTP packets from Siebel. Use the value
that you enter for this option when you configure the Siebel part of the
UCS Gateway Server.
Start Info Tab
Connections Tab
Options Tab
420
Configuring Genesys
Set the Gplus UCS Gateway Server for Siebel CRMs configuration
option. See, Procedure: UCS Gateway Server: Configuring the tabs in the
Properties dialog box, on page 418.
421
Installation
Installation
This section describes the installation process for the Gplus UCS Gateway
Server for Siebel CRM.
422
Installation
Procedure:
UCS Gateway Server: Installing the UCS Gateway
Server in a Windows environment
Purpose: To install the Gplus UCS Gateway Server for Siebel CRM in a
Windows environment.
Start of procedure
1. To start the installation process, run the setup.exe file from the Gplus UCS
Gateway Server for Siebel CRM installation package.
2. In the Welcome window, click Next.
3. In the Configuration Parameters for the Genesys Configuration Server
window, enter the following:
The name of the host on which Configuration Server is running.
The communication port that client applications must use to connect to
Configuration Server.
The user name used to access Configuration Server.
The password used to access Configuration Server.
4. Click Next.
5. In the Select Application window, select the Application object by its
corresponding number that you configured in the previous procedure,
Procedure: UCS Gateway Server: Creating the UCS Gateway Server
Application object, on page 418.
6. Click Next.
7. In the Choose Destination Location window, click Next to accept the
default destination folder or use the Browse button to select a different
destination folder.
8. In the Ready to Install window, click Install.
9. In the Setup Complete window, click Finish.
The Gplus UCS Gateway Server for Siebel CRM is now installed.
423
Installation
In the Gplus Adapter for Siebel CRM program folder in the Start menu, you
can see that the installer created a shortcut for the Gplus UCS Gateway Server
for Siebel CRM.
End of procedure
Next Steps
Configure the Siebel part of the Gplus UCS Gateway Server for Siebel
CRM. See, Configuring Siebel on page 425.
Procedure:
USC Gateway Server: Installing the USC Gateway
Server in a UNIX environment
Purpose: To install the Gplus UCS Gateway Server for Siebel CRM in an
UNIX environment.
Start of procedure
1. In the directory in which the USC Gateway Server installation package
was copied, locate a shell script named: install.sh.
2. Run this script from the command prompt by typing sh and the file name:
sh install.sh
3. When prompted, specify the host name, port, user name, and password of
the computer on which the USC Gateway Server will be installedfor
example:
a. Enter the host name of Configuration Server.
b. Enter the port of Configuration Server.
c. Enter the user name for Configuration Server.
d. Enter the password for the user name.
4. Choose the Configuration Server environment by its corresponding
number.
424
Configuring Siebel
Configuring Siebel
For the description of how to configure Siebel for the Gplus UCS Gateway
Server for Siebel CRM, please see Configuring the UCS Gateway Definition
in Siebel on page 451.
425
426
Configuring Siebel
Chapter
Overview
The process of configuring and installing the Gplus Adapter for Siebel CRM
Multimedia Component includes the following general procedures:
Configuring Siebel.
See the Gplus Adapter 8.0 for Siebel CRM Users Guide for additional
information about using this component.
427
Release 8.0.0
Support for the Push Preview dialing mode for Outbound Campaigns.
Support for the Red Hat Enterprise Linux (RHEL) operating system.
Support for the Multimedia Session Failover Handling. (See Chapter 11,
Deploying the Multimedia Session Failover Handling, on page 565).
Installation Prerequisites
The prerequisites for the installation of the Gplus Adapter for Siebel CRM
Multimedia Component are as follows:
Back up the Siebel database and the Siebel repository (*.srf) file.
Install the Gplus UCS Gateway (see Chapter 7, Deploying the UCS
Gateway Server, on page 415).
428
icon_notready_enabled.gif
icon_notready_disabled.gif
If you uninstall the Gplus Adapter, you can manually restore the original
buttons with these files.
Note: Genesys recommends backing up the Siebel web template file,
CCHtmlType.swf, before starting the installation procedure.
Installation
This section describes how to install the Gplus Adapter for Siebel CRM
Multimedia Component on either a Windows or a Linux operating systems:
Note: Do not use special symbols in any destination directory name when
Procedure:
Multimedia Component: Installing the Gplus Adapter
for Siebel CRM Multimedia Component
Purpose: To install the Gplus Adapter for Siebel CRM Multimedia
Component on either a Windows or a Linux operating system.
429
Start of procedure
1. To start the installation process, run the setup.exe file (for Windows) or
run the install.sh file (for UNIX) from the Gplus Adapter for Siebel
CRM Multimedia Component installation package on the host where the
Gplus Communication Server is installed.
Note: For the Windows installation, skip to step 3.
Linux
Windows
2. Enter the correct path to the Gplus Communication Server, so that the
installation file has the correct folder location to place the files necessary
for running the Open Media Communication Driver (itx_scdrv).
3. Enter the path to the main installation directory, so that the installation
program has the correct folder location to place the Siebel archive (*.sif)
files, the Siebel SmartScripts, the Siebel image files, and the general
product information.
Note: If the Voice Component is not installed, you must manually copy the
430
Configure the Siebel part of the Gplus Adapter for Siebel CRM
Multimedia Component. See the section, Configuring Siebel.
Configuring Siebel
Configuring Siebel
This section describes how to configure the Siebel part of the Gplus Adapter
for Siebel CRM Multimedia Component.
Configuring the Siebel section of the Gplus Adapter for Siebel CRM
Multimedia Component consists of the following sub-sections:
Prestart Information, page 431
Configuring Siebel Using the Siebel Tools, page 431
Configuring the Siebel Server, page 439
Configuring Siebel Using the Siebel Web Client, page 444
Workbin Parameters, page 450
Prestart Information
Before starting this part of the configuration process, you must make sure to do
the following:
You should be connected to the local copy of the Siebel Server database.
431
Configuring Siebel
Procedure:
Multimedia Component: Updating the Siebel
repository file
Purpose: To update the Siebel repository file.
Start of procedure
1. Start Siebel Tools.
2. If you did not previously import the *.sif archive files for the Voice
Component, then import the import the following archive files:
GenSymbolicStrings.sif (for Siebel 7.8 and higher)
GenComm.sif
GenesysTools.sif
from the following folder, <Installation Directory>/<Siebel Version> ,
where <Siebel Version> equals 7.7, 8.0, or 8.1 depending on your version
of the Siebel Server.
Create the
Genesys
Multimedia Project
page 230 for more information on how to import the *.sif archive
files and how to create and lock a project.
5. In Siebel Tools, in the Project field of the Object Explorer, select All
Projects.
6. Select the Business Component folder.
The Business Component window displays.
432
Configuring Siebel
7. Select one of the Action-related Siebel business components (BC) that you
use and that corresponds to the following two conditions:
a. The business component must have the following fields:
Attachment Flag
Attachment Id
Call Id
Comment
Description
Email BCC Line
Email Body
Email CC Line
Email Sender Address
Email To Line
Parent Activity Id
Primary Contact Id
Short Comment
Started
Status
Type
b. The business component should not have the following fields:
Attachment File Name
Attachment Flag 2
Interaction Id
For example, you might use the Action Home Page business component
or Action business component.
8. Make three copies of the chosen business components and name them as
follows:
Action - Genesys MCR.
Action - Genesys MCR(EmailOut).
Genesys Action(Chat).
9. Copy the newly-named business components into the Genesys Multimedia
project folder.
10. Make a copy of the Action Attachment business component and name it
Action Attachment - MCR EmailOut.
433
Configuring Siebel
First Name
Job Title
Last Name
Login Name
Status
b. The business component should not have the following fields:
IsBCC
IsCC
IsTo
For example, you might use the Contact(All) business component.
13. Make three copies of the chosen business component and name them as
follows:
Contact - Genesys MCR(EmailOut)
Inbound Interaction Contact List
Outbound Interaction Contact List
14. Copy the newly-named business components into the Genesys Multimedia
project.
Importing the
GplusMCR_Email_
Chat_nested.sif
Archive File
434
Configuring Siebel
Object Name
Resolution
BC Attribute
INACTIVE
File
BC Attribute
NO_DELETE
File
BC Attribute
NO_INSERT
File
BC Attribute
NO_MERGE
File
BC Attribute
NO_UPDATE
File
BC Attribute
SCRIPTED
File
Server Script
BindActivityContacts
File
Server Script
BusComp_PreWriteRecord
File
Server Script
BusComp_SetFieldValue
File
Server Script
UpdateEmailInfo
File
Field
File
Field
Interaction Id
File
Attachment
File
Object Name
Resolution
BC Attribute
INACTIVE
File
BC Attribute
NO_DELETE
File
BC Attribute
NO_INSERT
File
BC Attribute
NO_MERGE
File
BC Attribute
NO_UPDATE
File
BC Attribute
SCRIPTED
File
Server Script
BindActivityContacts
File
Server Script
BusComp_PreWriteRecord
File
435
Configuring Siebel
Object Name
Resolution
Server Script
BusComp_SetFieldValue
File
Server Script
PrintPropertySet
File
Server Script
SkipMETA
File
Server Script
UpdateEmailInfo
File
Field
File
Field
Attachment Flag 2
File
Field
Interaction Id
File
Attachment
File
Object Name
Resolution
BC Attribute
INACTIVE
File
BC Attribute
NO_DELETE
File
BC Attribute
NO_INSERT
File
BC Attribute
NO_MERGE
File
BC Attribute
NO_UPDATE
File
Field
Type
File
436
Object Type
Object Name
Resolution
BC Attribute
INACTIVE
File
BC Attribute
NO_DELETE
File
BC Attribute
NO_INSERT
File
BC Attribute
NO_MERGE
File
BC Attribute
NO_UPDATE
File
Configuring Siebel
Object Name
Resolution
BC Attribute
SCRIPTED
File
Server Script
BusComp_NewRecord
File
Server Script
BusComp_PreDeleteRecord
File
Server Script
BusComp_PreInvokeRecord
File
Server Script
BusComp_WriteRecord
File
Field
ActivityIsNew
File
Object Name
Resolution
BC Attribute
INACTIVE
File
BC Attribute
NO_UPDATE
File
BC Attribute
SCRIPTED
File
Server Script
(declarations)
File
Server Script
BusComp_PreGetFieldValue
File
Server Script
BusComp_PreInvokeRecord
File
Server Script
BusComp_PreSetFieldValue
File
Server Script
ClearIntArrays
File
Field
IsBCC
File
Field
IsCC
File
Field
IsTo
File
21. For the Action - Genesys MCR and Action - Genesys MCR(EmailOut)
business components, set the Force Active field attribute to the checked
state (or true in the Property window) for the following fields:
Email Sender Address
Email To Line
Email BCC Line
Email CC Line
437
Configuring Siebel
Description
Email Body
Interaction Id
Type
Started
Status
22. For the Action Attachment - MCR EmailOut business components, set the
Force Active field attribute to the checked state (or true in the Property
window) for the following fields:
Activity Id
ActivityFileExt
ActivityFileName
ActivityFileSize
23. For the Inbound Interaction Contact List and Outbound Interaction
Contact List business components, set the attribute No Update to the
unchecked state (or false in the Property window).
24. Import the GplusMCR_Email_Chat.sif archive file from the following
directory, <Installation Directory>/<Siebel Version>/, where <Siebel
Version> is 7.7, 8.0, or 8.1.
25. Click Open.
The Import Wizard-Preview window displays.
26. In the Import Wizard-Preview window, locate the Conflict resolution
section, and select Merge the object definition from the archive file
with the definition in the repository.
27. Click Next.
The Import Wizard Review Conflicts and Actions window displays.
28. In the Conflicting Objects pane, select the Business Component category.
29. In the Object differences pane, select the Attribute differences pane. If
there are any attributes in the Attribute differences pane, make sure that
the Resolution column for each attribute is set to Repository. To do this:
right-click on an attribute and select Repository from the drop-down menu.
30. Click Next.
The Do you wish to proceed? window displays.
31. Click Yes.
The objects from the archive are imported into the Siebel repository.
32. Click Finish to complete the import
End of procedure
438
Configuring Siebel
Next Steps
Configure the Siebel Tools for the repository file deployment. See the
section, Configuring the Siebel Server.
Procedure:
Multimedia Component: Configuring Siebel Tools for
the repository file deployment
Purpose: To configure Siebel Tools for the repository file deployment.
Start of procedure
Applying Changes
to the Siebel
Database Tables
439
Configuring Siebel
9. Enter the correct values for the Database user, Database user password,
and ODBC data source fields.
You must enter the user name and password for a Database user who has
administrator's privileges in the Siebel environment.
See the Siebel documentation for more information about creating custom
tables.
10. Click Apply.
The message Changes successfully applied appears, indicating that the
tables were created.
11. Click the Activate button to propagate the database changes and make
them available to all users.
Creating the Web
Templates
14. If there is no gridlayout.sif file available, create the following two web
templates:
a. <Name = Applet Form Grid Layout, Type = Applet Template - Grid
Layout, Project = <Any Locked Project>
then create the following new record on the Web Template Files applet:
filename=CCAppletFormGridLayout.swt, Name = Generic Form Applet
(Base)
b. <Name = Applet Popup Form Grid Layout, Type = Applet Template Grid Layout, Project = <Any Locked Project>
then create the following new record on the Web Template Files applet:
filename=CCAppletPopupFormGridLayout.swt, Name = Generic Form
Applet (Base)
Adding the
Genesys Tab to
the Siebel
Application
15. Add the Genesys tab (screen = Genesys) to the Siebel application that is
being usedfor example, Siebel Universal Agent (for the Siebel
Horizontal version) or Siebel Financial Services (for the Siebel Vertical
version).
For Siebel Servers 7.7/7.8/8.0/8.1, when inserting the Genesys tab in
addition to adding the Screen column, you also need to define the Text String Override field or provide the Text - String Reference reference.
440
Configuring Siebel
Creating Symbolic
String References
16. If you want to use the Text - String Reference reference, then you must
first create a symbolic string for the Genesys display name and then enter it
into the text field. Symbolic strings provide a centralized mechanism for
storing and managing repository text strings.
a. Click Symbolic String in the Object Explorer view.
b. Click on the Symbolic String view and press Ctrl+N to create a new
record.
c. Set the Name field to a X_Genesys value.
d. Set the Current String Value field to a Genesys name.
e. Set Project Field to any locked project.
f. Set the Type field to a Conversion value.
Adding or
Modifying the
Siebel Server
Script Event
Handler
17. Add or modify (if it already exists) the Siebel Server script event handler
for the Application_PreNavigate event of the Siebel application being
used. The content of the script event handler is provided in the
<InsDir>/<Siebel Version>/ Application_PreNavigate.es file.
a. Refer to Updating the Application's Application_PreNavigate Event
Server Script on page 646 in the Appendix for general instructions.
b. Select the Application object, open the context menu by clicking the
right mouse button, and choose Edit Server Scripts. If there are no
server scripts associated with the Application object, you are prompted
to select the scripting language. Select eScript in this case.
c. Double-click the Application_PreNavigate event. Siebel Tools displays
the content of the corresponding event handler.
d. If the content of the corresponding event handler consists only of
return (ContinueOperation), replace this information with the content
of the <InsDir>/<Siebel Version>/Application_PreNavigate.es file.
e. If the Universal Callback feature of the Voice Component was
deployed, then the Application_PreNavigate event handler has already
been modified, and now needs to be merged with the
Application_PreNavigate.es file.
f. If Application_PreNavigate is already customized, you will need to
merge the Application_PreNavigate.es file with your customized
code, depending on your original customization logic.
g. Save the changes in the server script and close the script window.
18. For users of Siebel 8.0, and higher:
Allow access to the Genesys Chat and Communications Client business
services from the browser script by adding the following user properties to
the application you use:
ClientBusinessServiceN = Genesys Chat
ClientBusinessServiceM = Communications Client where N and M must
be sequential integers, starting at 0 and incrementing by one. These
integers should be different from the existing integers.
441
Configuring Siebel
Deploy the Siebel repository file, the browser scripts, the web templates,
and change the Siebel Server configuration. See, Procedure: Multimedia
Component: Deploying the Siebel repository file, browser scripts, web
templates, and changing the Siebel Server configuration.
Procedure:
Multimedia Component: Deploying the Siebel
repository file, browser scripts, web templates, and
changing the Siebel Server configuration
Purpose: To deploy the Siebel repository file and to change the Siebel Server
configuration.
Start of procedure
1. Stop the Siebel Server.
2. Back up the original Siebel repository file.
3. Copy the compiled repository file instead of the original Siebel repository
file.
4. Deploy (copy) the browser scripts from the <Browser script compilation
folder> as set in Siebel Tools to the corresponding Siebel Web Server
extension folder (<SWEApp>/public/language_code).
5. Deploy (copy) the content of <Installation Directory>/<Siebel
Version>/WEBTEMPL/ folder into the Siebel Server WEBTEMPL directory, where
<Siebel Version> is 7.7, 8.0, or 8.1.
6. Add the content of the <Installation Directory>/<Siebel
Version>/WEBTEMPL/ToMerge/GenesysHtmlType.swf file to the
CCHtmlType.swf from the Siebel Server WEBTEMPL directory.
7. Deploy (or merge, if the file was customized) the commToolbar_shared.js
file from the <Installation Directory>/<Siebel Version>/SCRIPTS/
folder with the Siebel Server commToolbar_shared.js file, which should be
located in the corresponding Siebel Web Server extension folder,
(<SWEApp>/public/language_code\latest system browser folder (the
folder with the name = largest number)\scripts) where <Siebel
Version> is 7.7, 8.0, or 8.1.
8. For Siebel versions prior to 8.0:
442
Configuring Siebel
Allow access to the Genesys Chat Business Service from the browser
script:
a. Open the application configuration file with a text editorfor
example, for the Siebel Horizontal version of the Siebel Universal
Agent, use the uagent.cfg file, or for the Siebel Vertical version of the
Siebel Financial Services, use the fins.cfg file.
b. Find the [SWE] section.
c. Add the following lines:
ClientBusinessServiceN = Genesys Chat
ClientBusinessServiceM = Communications Client
443
Configuring Siebel
Procedure:
Multimedia Component: Updating the associated List
of Values (LOV) tables
Purpose: To import the List of Values table for the Multimedia Component.
1. Log in as Siebel administrator.
2. Open the Site Map, then navigate to Administration - Business Service,
Simulator.
3. Specify Genesys Tools as the Service Name.
4. Specify ImportAll as the Method Name.
5. Set Iterations to 1.
444
Configuring Siebel
6. In the Input Arguments applet, click Load From File, browse for
<InsDir>/<Siebel Version>/GplusMCR_LOV.xml and load this file as shown
in Figure 39 on page 445.
Procedure:
Multimedia Component: Setting up the agent
responsibilities
Purpose: To set up the agent responsibilities.
445
Configuring Siebel
Start of procedure
1. Log in as Siebel administrator.
2. Navigate to Application Administration, Responsibilities.
3. Find the Genesys Multimedia Agent responsibility.
4. Use the Users applet to add agents who will use Multimedia views.
5. Log out.
End of procedure
Next Steps
Procedure:
Multimedia Component: Creating a customized
configuration file
Purpose: To create a new configuration file.
Start of procedure
1. Log in as Siebel administrator.
2. Navigate to Communication Administration, All Configurations view.
3. Create a new configuration import <Siebel
Version>/GenComm_universal.def from the installation directory.
For more information, refer to the section Universal Definition File on
page 31 in Chapter 5, System Requirements.
End of procedure
Next Steps
446
Configuring Siebel
Procedure:
Multimedia Component: Configuring the CTI
connection
Purpose: To configure the CTI connection.
Start of procedure
Using the Siebel Web Client:
1. Log in as a Siebel administrator.
2. Navigate to the Communication Administration, All Configurations
view.
3. Find the target configuration.
4. Click the Profiles tab, then click on the Gplus_Universal driver.
5. Specify the Driver:PrimaryGenCommServerURL parameter, by providing the
location of the Gplus Communication Server.
For example, if the Gplus Communication Server is installed on the cti
host, and port 18000 is specified in the Genesys Configuration Layer as the
Server port, then specify the following parameter:
Driver:PrimaryGenCommServerURL= http://cti:18000
Note: The specified name must be resolvable from the host where the
8. Log out.
End of procedure
Next Steps
447
Configuring Siebel
Procedure:
Multimedia Component: Assigning the correct
responsibility to an agent
Purpose: To assign the correct responsibility to an agent.
Start of procedure
1. Log in as a Siebel administrator.
2. Select Site Map > Administration > Application, Responsibilities.
3. On the Responsibilities applet, select the Genesys Multimedia Agent
responsibility.
4. Add the required agents who will use the Multimedia view by using the
Users applet on the Responsibilities tab.
End of procedure
Next Steps
Procedure:
Multimedia Component: Configuring or creating
Telesets
Purpose: To configure or create a Teleset, which is a set of DNs that represent
a single workplace.
448
Configuring Siebel
Start of procedure
1. In the Siebel Site map, navigate to All Telesets.
For Siebel 7.7/7.8/8.0/8.1, select Site Map > Administration Communications > All Telesets.
2. Find the Teleset that the agent already uses, or create a new one for the new
agent. For each Teleset, provide the following information:
Create a new Teleset in the Telesets list.
Add your agents Extension.
For a new agent, add the agent on the Agents tab
3. Give the Teleset a unique namefor example, you may want the Teleset
based on the cubicle number, or the location of the Teleset.
4. Select the Extensions tab.
5. Add all the Teleset DNs in the list (one, or more DNs) with a Place name
of <Genesys Place>@GP. For each DN, you must you must define the DN
type:
SStandard DN
AACD Position
then the Genesys Place name is the same as the name of the
Teleset in Siebelfor example:
Teleset Name= T_CUBE_0001
If a Teleset has only DNs of type ACD Position, then you must
configure at least one of these DNs as a DN of type S in Siebel.
Table 43 shows how an example Teleset configuration scenario could be
defined.
Table 43: Siebel Telesets
Genesys
Object Type
Place
Siebel
Name
MyTeleset
Object Type
Name
Teleset
MyTeleset
MyTeleset@GP
Extension
1001
1001
ACD Position
2001
2001
449
Configuring Siebel
Procedure:
Multimedia Component: Assigning agents to a
Multimedia configuration
Purpose: To assign an agent to a Multimedia configuration.
Start of procedure
1. Navigate to the Agent General Profile view.
2. Find the agent, then add the multimedia configuration as the primary
configuration for this agent.
3. If Siebel-Genesys synchronization is not used, then it is necessary to
manually define the Agent Login value the same as the Employee ID
value from the Genesys Configuration layer.
End of procedure
Next Steps
Workbin Parameters
Workbins are available for use by an agent in Siebel defined as a List of
Value table of type MCR_WORKBIN_TYPE, where the Language-Independent Code
field defines the Siebel name of the workbin. The display value should
correspond to the workbin name as defined in Genesys Interaction Workflow
Designer. It may be necessary to change the display value to correlate with a
pre-existing Genesys Multimedia configuration.
450
Procedure:
Multimedia Component: Configuring the UCS Gateway
definition in Siebel
Purpose: To configure the UCS Gateway definition in Siebel.
Start of procedure
1. Log in as a Siebel administrator.
2. Navigate to the Outbound Web Services configuration view (Web Services
administration).
3. Import the <Siebel Version>/Gplus.xml file.
This import creates the Genesys Gplus WebService outbound web service.
4. Configure the Genesys Gplus WebService by changing the URL in the
Address field of the Gplus Service port. The URL should point to the
installed UCS Gatewayfor example:
http://cti-ucs:2006/gateway
End of procedure
Next Steps
451
Default value
Driver:BackupGenCommServerURL
Must be
Comment
defined in
profile?
No
Driver:LibraryName
UniComm
No
Driver:PrimaryGenCommServerURL
CHANGE_ME
Yes
Name
Gplus_Universal
No
Service:AgentId
{@AgentID}
No
452
Default value
Must be
Comment
defined in
profile?
Service:ConnectionName
CHANGE_ME
Yes
Service:DNList
{@DNList}
Yes
Default value
Required
Comment
Channel Type
Gplus_Universal
Yes
Inbound Flag
True
Yes
Outbound Flag
True
Yes
Interactive
True
Yes
453
Default value
Required
Comment
Channel String
voice,
outboundpreview,
email, chat,
SiebelEmail,
BackgroundEmail
Yes
Specifies a
comma-separated list of
supported Genesys media
types.
Library Name
GenCommDrv
Yes
Default Value
Required Comment
ChatTranscriptDirection
TopToBottom
No
CheckPopupBeforeExecute
FALSE
Yes
454
Default Value
Required Comment
EmailInboundDoneQueue
__STOP__
Yes
EmailOutboundDoneQueue
__STOP__
Yes
455
Default Value
Required Comment
ExceptionLogPrefix
exclog_
No
CHANGE_ME
Yes
MediaRoutingDefaultQueue
No
MediaRoutingDoneQueue
__STOP__
No
456
Default Value
Required Comment
NewOutboundEmailQueue
Yes
NoteEmailBodyTruncated
OpenMediaSessionRecovery
TRUE
Yes
ReplyOutboundEmailQueue
Yes
RecoveryPullViewUserDataKey
Yes
457
Default Value
Required Comment
RecoveryPullViewUserDataKey
Yes
(Continued)
The key
RecoveryPullViewSystem is
458
Default Value
Required Comment
SendEmailNewDefaultQueue
Outbound queue
Yes
SendEmailReplyDefaultQueue
Outbound queue
Yes
OpenMediaLogin
OpenMediaLogout
@some-media@OpenMediaReady
@some-media@OpenMediaNotReady
@some-media@OpenMediaChangeMediaStateReason
OpenMediaAccept
OpenMediaReject
OpenMediaPlaceInQueue
OpenMediaLeave
OpenMediaSelect
OpenMediaDeselect
OpenMediaSubmit
OpenMediaReply
OpenMediaChangeProperties
OpenMediaPlaceInWorkbin
OpenMediaPullInteractionById
OpenMediaTransfer
ChatSend
ChatReleaseParty
459
460
stringParam
Not Used
datasetParam
Reason
Optional
Optional
(ReasonCode)
Description
(ReasonValue)
OpenMediaLogout
Description
stringParam
Not Used
datasetParam
Reason
Optional
Optional
(ReasonCode)
Description
(ReasonValue)
@some-media@OpenMediaReady
Description
stringParam
Not Used
datasetParam
Reason
Optional
(ReasonCode)
Description
(ReasonValue)
needed.
Optional
The human-readable
description of the
specified reason.
461
stringParam
Not Used
datasetParam
Reason
Optional
Optional
The human-readable
description of specified
reason
(ReasonCode)
Description
(ReasonValue)
@some-media@OpenMediaChangeMediaStateReason
Description
Changes the agent media state reason for some-media media types at any time
while the agent is logged in.
stringParam
Not Used
datasetParam
Reason
Optional
Optional
The human-readable
description of the
specified reason.
(ReasonCode)
Description
(ReasonValue)
OpenMediaAccept
Description
stringParam
Not Used
datasetParam
TrackingID
462
Optional
ChatUsrNickName
Optional
TimeZoneOffset
Optional
TrackingID
Optional
ChatUsrNickName
Optional
TimeZoneOffset
Optional
OpenMediaReject
Description
Rejects (declines) the offered, but not accepted, interaction back to the router.
stringParam
Not Used
463
TrackingID
Optional
Reason
Optional
Optional
Human-readable
description of specified
reason
(ReasonCode)
Description
(ReasonValue)
OpenMediaPlaceInQueue
Description
Places the interaction handled by the agent into the specified queue and
removes it from the desktop. If the queue name is __STOP__, then this
command will completely stop the processing of the interaction.
stringParam
Not Used
datasetParam
TrackingID
Optional
Reason
Optional
Optional
The human-readable
description of the
specified reason.
(ReasonCode)
Description
(ReasonValue)
OpenMediaLeave
Description
stringParam
464
Not Used
TrackingID
Optional
Reason
Optional
Optional
The human-readable
description of the
specified reason.
(ReasonCode)
Description
(ReasonValue)
OpenMediaSelect
Description
stringParam
Not Used
datasetParam
TrackingID
Mandatory
OpenMediaDeselect
Description
stringParam
Not Used
datasetParam
TrackingID
Mandatory
OpenMediaSubmit
Description
Creates a new interaction with the specified attributes in the specified queue.
stringParam
Not Used
465
InteractionId
Mandatory
InteractionSubtype
Mandatory
InteractionType
Mandatory
An interaction type,
such as Outbound or
Inbound.
A list of possible
attribute values is
defined in Genesys
Configuration under the
corresponding business
attribute.
466
MediaType
Mandatory
SubmitQueue
Mandatory
Properties
Optional
ParentId
Optional
stringParam
Not Used
datasetParam
TrackingID
Mandatory
Queue
Mandatory
Reason
Optional
Optional
The human-readable
description of the
specified reason.
InteractionId
Mandatory
InteractionSubtype
Mandatory
The interaction
subtypefor example,
OutboundNew or
OutboundReply.
(ReasonCode)
Description
(ReasonValue)
A list of possible
attribute values is
defined in Genesys
Configuration under the
corresponding business
attribute.
InteractionType
Mandatory
467
MediaType
Mandatory
SubmitQueue
Mandatory
Properties
Optional
ParentId
Optional
OpenMediaChangeProperties
Description
stringParam
Not Used
datasetParam
TrackingID
Optional
Properties
Optional
The properties to be
updated.
DeletedProperties
Optional
The properties to be
removed from the
interaction.
<Unrecognized>
Optional
468
stringParam
Not Used
datasetParam
TrackingID
Optional
Workbin
Mandatory
WorkbinAgentId
WorkbinPlaceId
WorkbinPlaceGroupId
WorkbinAgentGroupId
Reason
Optional
Optional
(ReasonCode)
Description
(ReasonValue)
OpenMediaPullInteractionById
Description
stringParam
Not Used
datasetParam
InteractionId
Mandatory
Reason
Optional
Optional
(ReasonCode)
Description
(ReasonValue)
469
stringParam
Not Used
datasetParam
TrackingID
Optional
WorkinAgentId
Mandatory
ChatSend
Description
stringParam
Not Used
datasetParam
TrackingID
Optional
ChatMsgText
Mandatory
ChatReleaseParty
Description
stringParam
Not Used
datasetParam
TrackingID
470
Optional
ChatAfterAction
Optional
The action to be
performed with the chat
session after removing
the specified party.
These actions can be:
KEEP_ALIVE
CLOSE_IF_NO_AGENTS
FORCE_CLOSE
ChatAfterAction
Optional
ChatUsrId
Optional
ChatMsgText
Optional
OpenMediaDeselect
Note: This set of Interaction Server device commands is different than those
471
Table 48: The Interaction Server Driver Device Command Changes for 8.0.1
OpenMediaDeselect
Description
stringParam
Not Used
datasetParam
SelectedTrackingID
Mandatory
DeselectedTrackingID
Mandatory
OpenMediaOcsCallCompletionStats
OpenMediaOcsRecordProcessed
OpenMediaOcsRecordReject
OpenMediaOcsRecordCancel
OpenMediaOcsRecordReschedule
OpenMediaOcsRecordDoNotCall
OpenMediaOcsChainedRecordReqst
OpenMediaOcsCallCompletionStats
Description
OCS Action
472
GSW_APPLICATION_ID
GSW_CAMPAIGN_NAME
GSW_RECORD_HANDLE
Additional Fields
OpenMediaOcsRecordProcessed
Command Name
OpenMediaOcsRecordProcessed
Description
OCS Action
Mandatory Fields
GSW_APPLICATION_ID
GSW_CAMPAIGN_NAME
GSW_CALLING_LIST
GSW_RECORD_HANDLE
OpenMediaOcsRecordReject
Command Name
OpenMediaOcsRecordReject
Description
OpenMediaOcsRecordReject (Continued)
OCS Action
Mandatory Fields
TrackingID
Additional Fields
Not specified
473
OpenMediaOcsRecordCancel
Description
OCS Action
Mandatory Fields
GSW_APPLICATION_ID
if (GSW_RECORD_HANDLE is specified){
GSW_CAMPAIGN_NAME
GSW_CALLING_LIST
}
else
{
GSW_PHONE
GSW_CAMPAIGN_NAME (optional)
}
TrackingID
Additional Fields
GSW_CHAIN_ATTR = "AllChain"
Or
GSW_CHAIN_ATTR = "RecordOnly"
OpenMediaOcsRecordReschedule
Command Name
OpenMediaOcsRecordReschedule
Description
OCS Action
Mandatory Fields
GSW_APPLICATION_ID
GSW_CAMPAIGN_NAME
GSW_RECORD_HANDLE
GSW_DATE_TIME
GSW_CALLBACK_TYPE
TrackingID
Additional Fields
474
Not specified
OpenMediaOcsRecordDoNotCall
Description
OCS Action
Mandatory Fields
GSW_APPLICATION_ID
1) if (GSW_RECORD_HANDLE is specified){
GSW_CAMPAIGN_NAME
GSW_CALLING_LIST
}
else
{
2) GSW_PHONE
}
else
{
3) GSW_CUSTOMER_ID
}
TrackingID
Additional Fields
Not specified
Comments
475
OpenMediaOcsChainedRecordReqst
Description
OCS Action
Mandatory Fields
GSW_AGENT_REQ_TYPE
GSW_APPLICATION_ID
GSW_CAMPAIGN_NAME
GSW_RECORD_HANDLE
TrackingID
Additional Fields
Not specified
476
Logged in
Logged out
Invited
OpenMedia in service
Selected
Deselected
Released
Accepted
Submitted
Pulled
Workbin Content
Chat Re Enter
Chat Message
Command Status
For information about the use and the syntax of these device events, refer to
the Siebel Communications Server Administration Guide for your version of
the Siebel Server.
Table 50 provides the details for each of these device commands:
Table 50: The Multimedia Component Device Events
Communication Server is in service
Device Event
GCSInService
Description
TrackingID
Not applicable
Attributes
Not applicable
GCSOutOfService
Description
TrackingID
Not applicable
Attributes
Not applicable
Logged in
Device Event
OpenMediaLoggedIn
Description
TrackingID
Not applicable
Attributes
TenantId
Logged out
Device Event
OpenMediaLoggedOut
Description
TrackingID
Not applicable
Attributes
Not applicable
477
OpenMediaInvited
Description
TrackingID
Attributes
Interaction properties
OpenMedia in service
Device Event
OpenMediaInService
Description
TrackingID
Not applicable
Attributes
Not applicable
OpenMediaOutOfService
Description
TrackingID
Not applicable
Attributes
Not applicable
Selected
Device Event
OpenMediaSelected
Description
Event sent when the driver changes the internally-selected work item,
and is usually sent as a result of a successfully completed
OpenMediaSelect command.
Attributes
Deselected
Device Event
OpenMediaDeselected
Description
Event sent when the driver deselects a work item when another
interaction is selected, and is usually sent as a result of successfully
completed OpenMediaSelect and OpenMediaDeselect commands.
478
Released
Device Event
OpenMediaReleased
Description
Attributes
Interaction properties
Accepted
Device Event
OpenMediaAccepted
Description
Attributes
Submitted
Device Event
OpenMediaSubmitted
Description
Attributes
Pulled
Device Event
OpenMediaPulled
Description
Attributes
Workbin Content
Device Event
OpenMediaWorkbinContent
Description
Attributes
WorkbinId
Workbin identifier
Content
Content of workbin
OpenMediaWorkbinChanged
Description
479
WorkbinId
Workbin identifier
InteractionId
ID of the interaction
InteractionType
InteractionSubtype
MediaType
Parent Id
Operation
UserData
User data
ChatNewParty
Description
Attributes
ChatUsrId
Chat user ID
ChatUsrType
ChatMsgType
ChatUsrNick
ChatSerialNumber
ChatTimeshift
ChatVisibility
ChatStartedAt
Attributes
480
ChatReEnter
Description
Attributes
ChatUsrId
Chat user ID
ChatUsrType
ChatMsgType
ChatUsrNick
ChatSerialNumber
ChatTimeshift
ChatVisibility
ChatStartedAt
ChatPartyLeft
Description
Attributes
ChatUsrId
Chat user ID
ChatUsrType
ChatMsgType
ChatUsrNick
ChatSerialNumber
ChatTimeshift
ChatVisibility
ChatStartedAt
481
ChatMessage
Description
Attributes
ChatUsrId
ChatUsrType
ChatMsgType
ChatMsgText
ChatUsrNick
ChatSerialNumber
ChatTimeshift
ChatVisibility
ChatStartedAt
Command Status
Device Event
OpenMediaCommandStatus
Description
Commands
The string describing the difference between the current and the
previous command status.
482
OpenMediaOcsRecordDoNotCallAck
OpenMediaOcsRecordCancelAck
OpenMediaOcsRecordProcessedAck
OpenMediaOcsRecordRejectAck
OpenMediaOcsRecordReschdulAck
Table 51 describes the available OCS device events for the Gplus Outbound
Campaign feature:
Table 51: The Outbound Campaign/Outbound Contact Server Device Commands
OpenMediaOcsRecordDoNotCallAck
Siebel CRM DeviceEvent Name
OpenMediaOcsRecordDoNotCallAck
DoNotCallAcknowledge
Description
TrackingID
Desktop Action
Attributes
GSW_APPLICATION_ID
if (GSW_RECORD_HANDLE is specified){
GSW_CAMPAIGN_NAME
GSW_CALLING_LIST
GSW_RECORD_HANDLE
}
else
{
GSW_PHONE
else
{
GSW_CONTCT_ID
}
OpenMediaOcsRecordCancelAck
Siebel CRM DeviceEvent Name:
OpenMediaOcsRecordCancelAck
RecordCancelAcknowledge
Description
TrackingID
Desktop Action
483
GSW_APPLICATION_ID
if (GSW_RECORD_HANDLE is specified) {
GSW_CAMPAIGN_NAME
GSW_CALLING_LIST
GSW_RECORD_HANDLE
}
else
{
GSW_PHONE
}
OpenMediaOcsRecordProcessedAck
Siebel CRM DeviceEvent Name:
OpenMediaOcsRecordProcessedAck
RecordProcessedAcknowledge
Description
TrackingID
Desktop Action
Attributes
GSW_APPLICATION_ID
GSW_CAMPAIGN_NAME
GSW_CALLING_LIST
GSW_RECORD_HANDLE
OpenMediaOcsRecordRejectAck
Siebel CRM DeviceEvent Name:
OpenMediaOcsRecordRejectAck
N/A
Description
TrackingID
Desktop Action
484
GSW_APPLICATION_ID
GSW_CAMPAIGN_NAME
GSW_CALLING_LIST
GSW_RECORD_HANDLE
OpenMediaOcsRecordReschdulAck
Siebel CRM DeviceEvent Name:
OpenMediaOcsRecordReschedulAck
RecordRescheduleAcknowledge
Description
TrackingID
Desktop Action
Attributes
GSW_APPLICATION_ID
GSW_CAMPAIGN_NAME
GSW_CALLING_LIST
GSW_RECORD_HANDLE
GSW_DATE_TIME
GSW_CALLBACK_TYPE
485
486
Chapter
Overview
Installation and configuration of the Gplus Adapter for Siebel CRM Media
Routing Component includes:
Configuring Siebel.
487
Release 8.0.0
The Gplus Adapter for Siebel CRM Media Routing Component no longer
uses the Gplus Communication Server to send routing requests to the
Genesys environment, but rather uses the Gplus Open Media Server.
The Gplus Adapter for Siebel CRM Media Routing Component contains a
dedicated server for routing requeststhe Gplus Open Media Server for
Siebel CRM.
Support for the Red Hat Enterprise Linux (RHEL) operating system.
some of the same functionality that the Gplus Adapter for Siebel CRM
Multimedia Component does, so the Gplus Adapter for Siebel CRM
Media Routing Component should be installed after the Gplus
Adapter for Siebel CRM Multimedia Component. The Gplus Adapter
for Siebel CRM Media Routing Component will not function without
the Gplus Adapter for Siebel CRM Media Routing Component.
The Gplus Adapter for Siebel CRM Media Routing Component uses the same
communications driver names and profiles as the Gplus Adapter for Siebel
CRM Multimedia Component. However, if you plan to use the Media Routing
Component for routing Siebel work items in addition to Siebel eMail, you will
need to make some changes in the communication configuration. For more
information, see the section, The Media Routing Component uses the same
driver as the Multimedia Component, so the device commands and events are
the same as for the Multimedia Component. For a list of the device commands
and events, refer to Chapter 8, Deploying the Multimedia Component, on
page 427. on page 526.
488
Installation Prerequisites
The following are prerequisites for installation of the Gplus Adapter for Siebel
CRM Media Routing Component:
Back up the Siebel database and the Siebel repository (*.srf) file.
Installation
This section describes how to install the Gplus Adapter for Siebel CRM Media
Routing Component on either a Windows or a Linux operating systems:
Note: Do not use special symbols in any destination directory name when
Procedure:
Media Routing Component: Installing the Gplus
Adapter for Siebel CRM Media Routing Component
Purpose: To install the Gplus Adapter for Siebel CRM Media Routing
Component on either a Windows or a Linux operating system.
Start of procedure
1. To start the installation process, run the setup.exe file (for Windows) or
run the install.sh file (for UNIX) from the Gplus Adapter for Siebel
CRM Media Routing Component installation package.
2. Enter the path to the destination directory for installation, so that the
installation program installs the Gplus Open Media Server for Siebel CRM
(follow the steps in Procedure: Media Routing Component: Installing the
Open Media Server, on page 500) and has the correct folder location to
place the Siebel archive (*.sif) files, the Siebel SmartScripts, the Siebel
image files, and the general product information.
End of procedure
Next Steps
Configure the Genesys part of the Gplus Adapter for Siebel CRM Media
Routing Component. See the section, Configuring Genesys on page 490.
489
Configuring Genesys
Configuring Genesys
This chapter describes how to configure and install the Gplus Open Media
Server for Siebel CRM and consists of the following sections:
Prestart Information, page 490
Overview, page 490
Importing the Gplus Open Media Server Application Template, page 491
Creating the Gplus Open Media Server for Siebel CRM Application
Object, page 492
Configuring the Tabs in the Properties Dialog Box, page 492
Setting the Genesys Configuration Options for the Gplus Open Media
Server for Siebel CRM, page 498
Prestart Information
Before starting the configuration process you should have the following
Genesys Framework applications running:
Configuration Database
Configuration Server
Configuration Manager
Overview
The Gplus Open Media Server for Siebel CRM implements open media
routing functionality. It acts as a dedicated server that redirects requests from
Siebel CRM to the underlying Genesys communication middlewareOpen
Media Interaction Server. The Gplus Open Media Server for Siebel CRM may
run on different hosts with different platforms and operating systems.
Note: The process of configuring and installing the Gplus Open Media
490
Configuring Genesys
Recommendations
Genesys recommends using an Application Template when you are
configuring your Adapter. The Application Template for your Adapter contains
the most important configuration options set to the values recommended for
the majority of environments. When modifying configuration options for your
Adapter later in the process, you can change the values inherited from the
template rather than create all the options by yourself.
Procedure:
Media Routing Component: Importing the Gplus Open
Media Server for Siebel CRM Application template
Purpose: To import the Gplus Open Media Server for Siebel CRM Application
template.
Start of procedure
1. In Configuration Manager, under Environment, right-click the Application
Templates folder.
2. Select the Import Application template.
3. Browse to and select the Application template for the Gplus Open Media
Server.
4. Select the following template, as follows:
Release 8.0.0: Gplus_OpenMedia_Server_for_SiebelCRM_800.apd
Release 8.0.1: Gplus_OpenMedia_Server_for_SiebelCRM_801.apd
5. Click Open.
The Properties dialog box for the Application Template object displays.
6. Click OK to accept the default values.
The Application Template object has been imported to the Genesys
Configuration Layer.
End of procedure
491
Configuring Genesys
Next Steps
Create the Configuration Layer Application object for the Gplus Open
Media Server for Siebel CRM. See the section, Creating the Gplus Open
Media Server for Siebel CRM Application Object.
Procedure:
Media Routing Component: Creating the Gplus Open
Media Server for Siebel CRM Application object
Purpose: To create the Application object for the Gplus Open Media Server
for Siebel CRM.
Start of procedure
1. In Configuration Manager, under Environment, right-click the Applications
folder.
2. Select New > Application.
3. Select the Application template that you just created:
Release 8.0.0: Gplus_OpenMedia_Server_for_SiebelCRM_800.apd
Release 8.0.1: Gplus_OpenMedia_Server_for_SiebelCRM_801.apd
4. Click OK.
The Properties dialog box for the Application appears.
End of procedure
Next Steps
Configure the tabs in the Properties dialog box for the Gplus Open Media
Server for Siebel CRM. See the section, Configuring the Tabs in the
Properties Dialog Box.
492
Configuring Genesys
Procedure:
Media Routing Component: Configuring the tabs in the
Properties dialog box
Purpose: To configure the tabs in the Properties dialog box for the Gplus
Open Media Server for Siebel CRM.
Start of procedure
General Tab
1. Click the General tab in the Properties dialog box (see Figure 40).
2. In the Name list, click the name of the Application object you are
configuring.
3. In the Template list, click the name of the template you are configuring or
use the Browse button to select the template you are configuring.
4. Click Apply.
493
Configuring Genesys
environment.
Tenants Tab
7. Select the Genesys Tenants under which the objects that are exported from
Siebel are created.
8. Click Add.
Server Info Tab
494
Configuring Genesys
11. In the Communications Port field, enter any valid port number for the port
with the ID of default. Genesys recommends setting this value to18101.
Note: This option determines the HTTP port number used by the Gplus
Open Media Server to receive HTTP packets from Siebel. Use the
value that you enter for this option when you configure the Siebel part
of the Gplus Open Media Server.
Start Info Tab
Connections Tab
This step is mandatory for configuring the Gplus Open Media Server
to work with the Media Routing Component. You may also configure
a connection to the Genesys Message Server.
17. On the Connections tab, click Add to attach a connection to the Interaction
Server (see Figure 42 on page 496).
Optionally, you can add a connection to the Genesys Message Server.
Optionally, you can add a connection to the Genesys Configuration
Server.
495
Configuring Genesys
496
Configuring Genesys
497
Configuring Genesys
Next Steps
Set the Gplus Open Media Server s configuration options. See, Setting the
Genesys Configuration Options for the Gplus Open Media Server for Siebel
CRM.
log Section
The Gplus Open Media Server for Siebel CRM supports a common set of Log
options to allow the precise configuration of the log file output. For a complete
list of Common Log options and their descriptions, see the Common Log
Options chapter of the Framework 8.0 Configuration Options Reference
Manual.
Note: If you do not specify any log options, the default values apply.
Selective
Protection of
Sensitive Data in
Logs
498
Settings Section
The Settings section has the following option that can be configured:
MaxProcessingThreads Option
Default Value: 5
Valid Value: Any positive integer greater than or equal to (>=) 4
Provides the value for the maximum number of allowed threads.
499
Procedure:
Media Routing Component: Installing the Open Media
Server
Purpose: To install the Gplus Adapter Open Media Server for Siebel CRM on
a Windows or a UNIX operating system.
Start of procedure
1. To start the installation process, run the setup.exe file (for Windows), or
the install.sh file (for UNIX) from the Gplus Open Media Server
installation package.
2. Answer the installation questions according to your selected deployment
scenario.
End of procedure
where all files copied by installation are placed. It is the name of the
Application object of the Gplus Open Media Server for Siebel CRM.
500
Configuring Siebel
Configuring Siebel
This section describes how to configure the Siebel part of the Gplus Open
Media Server.
Configuring the Siebel section of the Gplus Open Media Server consists of the
following sub-sections:
Prestart Information, page 501
Configuring Siebel Using the Siebel Tools, page 501
Configuring Siebel Using the Siebel Web Client, page 505
Prestart Information
Before starting this part of the configuration process, you must make sure to do
the following:
You should be connected to the local copy of the Siebel Server database.
501
Configuring Siebel
Procedure:
Media Routing Component: Checking out existing
projects
Purpose: To check-out existing projects from the Siebel repository.
Start of procedure
1. In Object Explorer, start Siebel Tools against the local database.
2. In Siebel Tools, select Tools > Check Out...
The Check Out dialog box displays.
3. In the Projects list, select the GplusMediaRouting project to be
checked-out.
End of procedure
Next Steps
Procedure:
Media Routing Component: Importing the
GplusMediaRouting.sif archive file
Purpose: To import the GplusMediaRouting.sif archive file.
Start of procedure
1. Start Siebel Tools.
2. Lock the Genesys Multimedia project and lock the GplusMediaRouting
project, if it already exists.
3. In Siebel Tools, select Tools > Import from Archive... .
4. In the Select Archive to Import window, browse to one of the following
<Installation Directory> paths, depending on your version of Siebel:
<Installation Directory>/7.7 for Siebel Server versions 7.7/7.8,
<Installation Directory>/8.0 for Siebel Server version 8.0
<Installation Directory>/8.1 for Siebel Server version 8.1.
5. Select the GplusMediaRouting.sif archive file.
6. Click Open.
The Import WizardPreview window displays.
502
Configuring Siebel
8. Click Next.
The Import WizardReview Conflicts and Actions window displays.
9. Click Next.
The Do you wish to proceed? window displays.
10. Merge any conflicts, if they correspond to your needs.
11. Click Yes.
The objects from the archive are imported into the Siebel repository.
12. Click Finish to complete the import.
End of procedure
Next Steps
Compile the Siebel repository file. See the section, Compiling, Updating,
and Deploying the Siebel Repository File.
Procedure:
Media Routing Component: Compiling the Siebel
Repository File
Purpose: To compile the Siebel repository file.
Start of procedure
1. In Siebel Tools, select Tools > Compile Projects...
2. Select Locked projects.
3. In the Siebel Repository File edit box, enter the name of the repository
file.
4. Click Compile.
The status bar at the bottom of the Object Compiler window indicates
when the compilation is finished.
503
Configuring Siebel
Set up the business service query access for the GplusMediaRoute and the
GplusMediaRouteIXN business services. See, Procedure: Media Routing
Component: Setting the business service query access for the
GplusMediaRoute and the GplusMediaRouteIXN business services.
Procedure:
Media Routing Component: Setting the business
service query access for the GplusMediaRoute and the
GplusMediaRouteIXN business services
Purpose: To set up the business service query access for the GplusMediaRoute
and the GplusMediaRouteIXN business services.
Start of procedure
1. Log into the Siebel Server as a Siebel administrator.
2. Navigate to Administration > Server Configuration > Enterprises.
3. On the Component Group tab, select the required componentfor example,
Siebel Financial Services.
504
Configuring Siebel
Procedure:
Media Routing Component: Deploying the Siebel
repository file
Purpose: To deploy the Siebel repository file.
Start of procedure
1. Stop the Siebel Server.
2. Back up the original Siebel repository file.
3. Copy the compiled repository file into the proper location, so that you can
use it instead of the original Siebel repository file.
4. Start the Siebel Server.
End of procedure
Note: You must connect to your Siebel Server using the Siebel Web Client.
505
Configuring Siebel
This procedure is required only if you are using the Gplus Adapter for
Siebel CRM Media Routing Component for the routing of Siebel
eMail.
Use the following steps to make any changes to the Siebel repository
file that are relevant to the Siebel business process:
Procedure:
Media Routing Component: Configuring and importing
a Siebel workflow process
Purpose: To import and configure a Siebel workflow process for a series of
Siebel business services.
Note: When importing a workflow process, if you encounter the following
codeAlert 594.
Start of procedure
Siebel Tools usage:
1. Lock the EMR Workflow project.
2. Using the Object Explorer, choose the Workflow Process tab.
506
Configuring Siebel
4. Define the string values for the following properties according to your
environment (see Figure 45):
ConnectionNameThe ConnectionName value is the Application name
of a Genesys Interaction Server as specified on the Connections tab for
the Gplus Open Media Server.
SubmitQueueThe SubmitQueue value is the name of the queue to
which the interaction should be submitted.
5. Set the value of the RoutingMediaType property to BackgroundEmail, if you
use the nonreal-time (background) mode for e-mail processing. This
property is used as a parameter for the GplusMediaRouteIXN business
507
Configuring Siebel
service. For more information about these properties, see the Media
Routing Component Customization section of the Gplus Adapter 8.0 for
Siebel CRM Developers Guide.
508
Configuring Siebel
Deploy the workflow processes on the Siebel Server. See the section,
Deploying the Workflow Processes on the Siebel Server on page 510.
509
Configuring Siebel
Procedure:
Media Routing Component: Activating the Siebel
Workflow Process
Purpose: To activate the Siebel workflow process.
Start of procedure
1. Log into the Siebel Client as a Siebel Administrator.
2. Import the <SEWorkflow.XML> file exported previously from the Siebel
Tools into the Active Workflow Processes list/set as shown in Figure 47 on
page 510.
510
Configuring Siebel
3. Make sure that the workflow is active. If not, select the workflow process
you want to activate and click Activate.
End of procedure
Next Steps
Procedure:
Media Routing Component: Navigating to the Siebel
Server configuration
Purpose: To navigate through the site map to get to your Siebel Server
configuration.
Start of procedure
1. Navigate through the site map to get to your Siebel Server configuration:
In Siebel 7.7/7.8/8.0/8.1 environments, select Site Map >
Administration - Server Configuration.
2. Select Profile Configuration in the applet within the view.
3. Complete the process by completing the procedures that follow.
End of procedure
Next Steps
511
Configuring Siebel
Procedure:
Media Routing Component: Creating a connection
subsystem
Purpose: To configure a connection subsystem for the Gplus Open Media.
Start of procedure
1. Log in to Siebel Client as a Siebel Administrator.
2. Navigate through the Site Map to Siebel Server configuration:
Select Site Map > Administration - Server Configuration.
Creating a
Connection
Subsystem
512
Configuring Siebel
where <host> and <port> are the host and the port of the Gplus Open
Media Server being used.
Creating a Backup
Connection
Subsystem
513
Configuring Siebel
11. For the backup Named Subsystem record that you just created, enter the
following parameters in the Profile Parameter applet:
Set the HTTP Request Method parameter to POST
Set the HTTP Request URL Template to
http://<host>:<port>/MEDIA_REQUEST#RouteRequest
where <host> and <port> are the host and the port of the Gplus Open
Media Server being used.
Note: After creating or updating a connection subsystem, you might have to
restart your Siebel server to make the changes effective. Refer to your
Siebel server documentation.
End of procedure
Next Steps
Procedure:
Media Routing Component: Setting a value for the
MediaRoutingDefaultQueue configuration parameter
Purpose: To set a value for the MediaRoutingDefaultQueue configuration
parameter. This parameter defines the name of the queue where the Siebel
eMail interactions that are marked as done are placed. No other parameter
configuration is required, except what is used for the Multimedia component.
514
Configuring Siebel
Start of procedure
1. In the Genesys environment, create SiebelEmail and BackgroundEmail
media types. If you use the Media Routing Component for routing Siebel
work items, create a custom media type for each type of work item.
Note: Genesys recommends using different media types for different
515
Configuring Siebel
End of procedure
Next Steps
Configure the Siebel eMail response. See the section, Configuring the
Siebel eMail Response.
516
Configuring Siebel
Note: This section is required only if you are using the Media Routing
517
Configuring Siebel
Next Steps
Procedure:
Media Routing Component: Configuring the Siebel
Internet SMTP/POP 3 Server driver profile
Purpose: To configure the Siebel Internet SMTP/POP3 Server driver profile.
Start of procedure
1. In the Siebel Site Map, select Site Map > Administration Communications > Communications Driver and Profiles.
2. Select the record for the Internet SMTP/POP3 Server communication
driver.
3. Select the Profile tab.
4. Click New on the Profiles form and set the name of the profile to the value
of the e-mail address.
5. Click New to create the following necessary parameter value overrides:
From Address: the value must be the same as the e-mail address that
the profile works with, or the profile name, which is the same.
Incoming E-mail Directory: the directory where the incoming e-mails
are saved.
POP3 Account Name: the name of the POP account.
POP3 Account Password: the POP3 account password string.
POP3 Server: the name of the POP Server.
POP3 Server Port: the POP3 Server Port value (this value is usually
110).
Siebel Server: the name of the Siebel Server on which the eMail
Response works.
SMTP Server: the name of the SMTP Server.
SMTP Server Port: the SMTP Server Port value (this value is usually
25).
SMTP Account Name: the name of the SMTP account.
SMTP Account Password: the SMTP account password string.
6. Set the responsibilities of the created Server Driver Profile to Universal
Agent.
End of procedure
518
Configuring Siebel
Next Steps
Procedure:
Media Routing Component: Creating a response group
Purpose: To create a response group that determines the behavior for inbound
email.
Start of procedure
1. In the Siebel Site Map, select Site Map > Administration Communications > All Response Groups.
The Response Groups list appears.
2. Click New on the Response Groups form.
3. Set the name of the response group to the exact value of the Internet
SMTP/POP3 driver profile name, with which the response group works.
4. Set the administrator e-mail address to an e-mail address in which you
want to direct undeliverable e-mail that is sent to profiles in each response
group.
5. Set the Server option to the value of the Siebel Server that is used for the
eMail Response processing.
6. Set the value of the Startup option to Active.
7. Select the Profiles tab.
8. Click New and select the previously created profile for the Internet
SMTP/POP3 driver from the list of profiles.
9. Select the Input Arguments tab and click Generate Defaults.
10. Rename the ProcessName argument to
GplusMediaRouting-ProcessMessage. (See Figure 50 on page 520.)
519
End of procedure
Next Steps
520
The Communications Inbound Receiver (CIR) transfers these files into the
Siebel File System. The Siebel File System is a shared file system
directory.
The native Siebel eMail Response application uses the Siebel Universal Queue
(UQ) to route the e-mails and to generate a @HandleNonRealtimeWorkItem Siebel
special event. In the Genesys-adapted Siebel eMail Response application, the
Genesys Universal Router (UR) functionality is used for e-mail routing,
therefore the @HandleNonRealtimeWorkItem Siebel event is not generated.
The Media Routing Component uses workbins for background e-mail
interactions. Genesys recommends using the same agent workbin for the Siebel
background e-mail as for the Multimedia Component inbound e-mail. The
mode of interaction processing is defined by a Genesys routing strategyfor
example, the background interaction should be placed into the agent workbin,
but the real-time interactions should be placed into the inbound queue. By
default, the Media Routing Component uses different media types to instruct
the Genesys Universal Router on how to process the e-mail call on the agent
sidefor example, refer to the provided strategy sample in the installation
directory <Siebel Version>\GplusMediaRoutingSample.zcf file.
The SiebelEmail media type is used for the real-time e-mail processing mode,
and the BackgroundEmail media type is used for nonreal-time e-mail processing
mode. The media type is set as an input argument of the GplusMediaRoute
business service in the GplusMediaRouting-ProcessMessage business process.
You may add an attributes value in an interactions attached data as an
indicator of the processing mode to be applied to an interaction, and update a
strategy to check this attributes value.
The nonreal-time (background) mode may be used for routing any Siebel work
items. The mode of processing is defined by the strategy used, which is the
same as for Siebel eMail.
521
Add a button into one of the activity applets to invoke the command.
Set the Hidden parameter of the command to True. The agent should locate
the appropriate Siebel record and invoke a command.
522
Procedure:
Media Routing Component: Configuring the Media
Routing Component in a Genesys environment
Purpose: To configure the Media Routing Component in a Genesys
environment.
Start of procedure
1. Create a new custom media type, making sure to use different media types
for different Siebel work item typesfor example, create the
ServiceRequest and ServiceOrder media types to use the provided samples.
2. Add the newly-created media types to the agent capacity rules.
3. Configure the Genesys routing strategy for routing the newly-created
media type interactions for example, see the <Siebel
Version>\GplusMediaRoutingSample.zcf file in the installation directory as
a sample strategy.
End of procedure
Next Steps
Procedure:
Media Routing Component: Configuring the Media
Routing Component in a Siebel environment
Purpose: To configure the Media Routing Component in a Siebel
environment.
Start of procedure
1. Add the newly-created media types into the Driver.Channel string.
2. Create Ready and NotReady commands for the newly-created media types.
A sample of this command is provided in the <Siebel
Version>/GenComm_universal.def file located in the installation directory.
The ReadyForSiebelSRGroup and NotReadyForSiebelSR commands are
located at the end of the file.
523
Add the new commands into the proper group commands. To use the
provided samples, add the ReadyForSiebelSRGroup command into the
ReadyGroup command group, and the NotReadyForSiebelSR command
into the NotReadyGroup command group.
3. Create an event handler for the OpenMediaAccepted event for each of the
newly-created media typesfor example, refer to the sample event
handler, OpenMediaAcceptedSR.
Set the proper Filter and Event Response parameters for the event
handler.
4. Create an event handler for the OpenMediaSelected event for each of the
custom media types for example, refer to the sample event handlers,
OpenMediaSelectedSR and OpenMediaSelectedOrder.
a. Set the proper FilterSpec and Event Response parameters for the event
handler.
b. Set a Siebel view that is used for editing a routed work item as a
SingleView parameter in the event response.
c. Set the QuerySpec parameter to the FieldName='{ThirdPartyId} value,
where FieldName is the field ID for a Siebel work itemfor example,
refer to the sample OpenMediaSelectedSR and OpenMediaSelectedSO
event responses located at the end of the <Siebel
Version>/GenComm_universal.def file.
5. Create event handlers for the OnOpenMediaPulledSR and OpenMediaAccepted
events for each of the custom media types.
Set the proper Filter, MediaType, and Event Response parameters for
the event handlerfor example, refer to the sample
OnOpenMediaPulledSR and OpenMediaAcceptedSR event handlers.
6. Create the commands to send a routing request.
Set the ServiceParam.ThirdPartyId command parameter to the ID field
for a Siebel work itemthe ID field should be the same field as in a
proper event handler. You may also send a routing request from a
workflow by calling the routing method of a GplusMediaRouteIXN
business servicefor example, see the SendRouteSR sample command
to route Siebel service requests in real-time mode, and see the sample
SendRouteSO command to route service orders in nonreal-time
(background) mode. Both of these sample commands are located at the
end of the <Siebel Version>/GenComm_universal.def file.
For more information please refer to the Media Routing Component
Customization section of the Gplus Adapter 8.0 for Siebel CRM
Developers Guide.
7. Configure the MarkWorkItemDone command to support your media types
for example, adding the newly-created media types into the
FilterMediaType parameter. This parameter contains a list of media types
separated by commasfor example,
For a ServiceOrder media type, you may use a MarkDoneSO command.
524
For more information please refer to the Gplus Adapter 8.0 for Siebel CRM
Developers Guide.
8. Assign the correct responsibilities to the agents, to make sure that they
have enough responsibilities to access to the appropriate views. For the
provided samples, the agent should have access to the following views:
Service Request Detail Personal Service Request List
Service Order-Browse Catalog
Order Entry - Line Items
Order Entry - My Orders.
Notes: The provided samples show how to route Siebel service requests in
525
Default Value
Required
Comment
MediaRoutingDoneQueue
__STOP__
Yes
Yes
526
Chapter
10
Overview
The process of configuring and installing the Gplus iWD Routing for Siebel
CRM Component includes the following general procedures:
Configuring Genesys
Configuring Siebel
527
Release 8.0.0
Configuring Genesys
This section describes how to configure the Genesys section of the Gplus iWD
Routing for Siebel CRM Component.
It is assumed that the iWD solution is properly configured to accept
interactions from the Siebel side. If required, the iWD Departments and
Processes have to be configured to apply the special rulesfor example,
different media types. See the intelligent Workload Distribution 8.0.
Deployment Guide for details.
Procedure:
iWD Routing: Configuring the intelligent Workload
Distribution solution
Purpose: To configure the intelligent Workload Distribution (iWD) solution.
Start of procedure
1. For each media type that you need to route through iWD, create a
Webservice Capture Point by doing the following:
a. Run the iWD Manager.
b. Log in and select an appropriate Tenant.
c. Select the Services view.
d. Select an appropriate iWD Solution and open the Services section (see
Figure 51 on page 529).
528
Configuring Genesys
529
Configuring Genesys
530
Install the iWD Routing for Siebel CRM Component. See the section,
Installing the iWD Routing for Siebel CRM Component on page 531.
Notes: The Gplus iWD Routing for Siebel CRM Component uses some of
Installation Prerequisites
The following are prerequisites for installation of the Gplus iWD Routing for
Siebel CRM Component:
Back up the Siebel database and the Siebel repository (*.srf) file.
Install the Gplus Adapter for Siebel CRM Multimedia Component (see
Chapter 8, Deploying the Multimedia Component, on page 427).
Installation
This section describes how to install the Gplus iWD Routing for Siebel CRM
Component on either a Windows or a Linux operating systems:
Note: Do not use any special symbols in the destination directory name
when installing the Gplus iWD Routing for Siebel CRM Component
in a UNIX environment.
531
Procedure:
iWD Routing: installing the Gplus iWD Routing for
Siebel CRM Component
Purpose: To install the Gplus iWD Routing for Siebel CRM Component on
either a Windows or a Linux operating system.
Start of procedure
1. To start the installation process, run the setup.exe file (for Windows) or
run the install.sh file (for UNIX) from the Gplus Adapter for Siebel
CRM Multimedia Component installation package on the host where the
Gplus Communication Server is installed
2. Enter the installation destination directory.
The installation program will place the Siebel archive, scripts, and general
production information in this folder.
End of procedure
Next Steps
by the installation script to copy the Adapter for Siebel CRM iWD Routing
files.
532
Configuring Siebel
Configuring Siebel
This section describes how to configure the Siebel part of the Gplus iWD
Routing for Siebel CRM and is divided into the following sub-sections:
Prestart Information, page 533
Configuring Siebel Using the Siebel Tools, page 533
Siebel Repository File Preparation, page 533
Configuring the Siebel Workflow Process, page 535
Prestart Information
Before starting this part of the configuration process, you must make sure to do
the following:
You should be connected to the local copy of the Siebel Server database.
Procedure:
iWD Routing: Compiling and Deploying the
Purpose: To import the necessary Siebel repository (*.srf) files and prepare
the Siebel repository file for compiling.
Start of procedure
1. Start Siebel Tools against the local database.
2. Lock the GplusMediaRouting project.
533
Configuring Siebel
5. Click Next.
534
Configuring Siebel
6. Click Finish.
During Web Service creation, Siebel creates a number of Integration
Objects and only one business service. By default, this business service is
named <mediaURLMapping>PortTypefor example, refer to this business
service name as <mediaBusService>.
End of procedure
Next Steps
Procedure:
iWD Routing: Configuring a Siebel workflow process
Purpose: To configure a Siebel workflow process for a series of Siebel
business services.
Start of procedure
1. Lock the EMR Workflow (or the GplusMediaRouting) project.
2. Using the Object Explorer, choose the Workflow Process tab.
3. Import the GplusMediaRoutingiWD-ProcessMessage.xml file.
4. Define the string values for the following properties according to your
environment (for mandatory properties values in the
GplusMediaRoutingiWD-ProcessMessage.xml file, preset the values to the
CHANGE_ME string):
535
Configuring Siebel
PrimaryOutboundDispatcherBS (mandatory)
BackupOutboundDispatcherBS (optional)
BusinessValue (mandatory)
Priority (mandatory)
536
Configuring Siebel
Procedure:
iWD Routing: Activating the Siebel Workflow Process
Note: This procedure is required only if you are using the iWD Routing
Procedure:
iWD Routing: Configuring the Siebel Web Services
Purpose: To configure the Siebel Web Services.
Start of procedure
1. Navigate through the Site Map to the Web Services configuration:
Select Site Map -> Administration - Web Services -> Outbound Web
Services.
537
3. For each imported Web Service, ensure that the Address value of the record
in the Service Ports applet (located below the Web Services applet) is
correctfor example, the value contains the correct URL pointed to the
corresponding Webservice Capture Point.
4. Restart the Siebel Server.
End of procedure
Next Steps
538
createTask Method
updateTaskByCaptureId Method
restartTaskByCaptureId Method
cancelTaskByCaptureId Method
completeTaskByCaptureId Method
getTaskByCaptureId Method
holdTaskByCaptureId Method
ping Method
resumeTaskByCaptureId Method
For a detailed description of these iWD methods, see the intelligent Workload
Distribution 8.0. Deployment Guide for details.
The following tables describe the available methods and their arguments:
The following symbols, found in the tables listed above, represent the different
methods and arguments:
M:
M*:
Represents parameters that must either be passed as an argument or have a default value set in the Business Service user
properties.
M**:
O:
For all arguments with descriptions that start with iWD, refer to the iWD
documentation for details, if necessary.
539
createTask Method
The createTask method is used to send a createTask request to the Genesys
iWD. This method submits an interaction into a routing process.
For a list of input parameters and their descriptions, see Table 53.
Table 53: createTask Input Parameters
Argument Name
Description
ThirdPartyId
PrimaryOutboundDispatcherBS
PrimaryOutbound
DispatcherBS
BackupOutbound
DispatcherBS
540
Description
Actor
defaultActor
BusinessValue
M*
defaultBusiness
Value
Category
Channel
DueDateTime
ExpirationDateTime
Hold
M*
defaultHold
Priority
M*
defaultPriority
541
Description
ProcessId
defaultProcessId
Reason
defaultReason
iWD
BusObject
M**
BusComp
M**
RecIdField
M**
InteractionField
M**
StatusField
M**
SubStatusField
542
Description
SuccessStatus
SuccessSubStatus
FailedStatus
FailedSubStatus
UserField
UserName
543
updateTaskByCaptureId Method
The updateTaskByCaptureId method is used to send an updateTaskByCaptureId
request to the Genesys iWD. This method updates interaction information.
For a list of input parameters and their descriptions, see Table 54.
Table 54: updateTaskByCaptureId Input Parameters
Argument Name
Description
ThirdPartyId
PrimaryOutboundDispatcherBS
PrimaryOutbound
DispatcherBS
BackupOutbound
DispatcherBS
544
Description
Actor
defaultActor
BusinessValue
M*
defaultBusinessV
alue
Category
Channel
DueDateTime
ExpirationDateTime
Hold
M*
defaultHold
Priority
M*
defaultPriority
545
Description
ProcessId
defaultProcessId
Reason
defaultReason
iWD
BusObject
M**
BusComp
M**
RecIdField
M**
InteractionField
M**
StatusField
M**
SubStatusField
546
restartTaskByCaptureId Method
The restartTaskByCaptureId method is used to send a restartTaskByCaptureId
request to the Genesys iWD. This method restarts the routing process for an
interaction.
For a list of input parameters and their descriptions, see Table 55.
Table 55: restartTaskByCaptureId Input Parameters
Argument Name
Description
ThirdPartyId
PrimaryOutboundDispatcherBS
PrimaryOutbound
DispatcherBS
BackupOutbound
DispatcherBS
defaultActor
547
Description
Hold
M*
defaultHold
Reason
defaultReason
iWD
BusObject
M**
BusComp
M**
RecIdField
M**
InteractionField
M**
StatusField
M**
548
Description
SubStatusField
SuccessStatus
SuccessSubStatus
FailedStatus
FailedSubStatus
UserField
UserName
549
cancelTaskByCaptureId Method
The cancelTaskByCaptureId method is used to send a cancelTaskByCaptureId
request to the Genesys iWD. This method cancels an interaction from routing.
For a list of input parameters and their descriptions, see Table 56.
Table 56: cancelTaskByCaptureId Input Parameters
Argument Name
Description
ThirdPartyId
PrimaryOutboundDispatcherBS
PrimaryOutbound
DispatcherBS
BackupOutbound
DispatcherBS
defaultActor
Reason
defaultReason
iWD
550
Description
BusObject
M**
BusComp
M**
RecIdField
M**
InteractionField
M**
StatusField
M**
SubStatusField
SuccessStatus
551
Description
SuccessSubStatus
FailedStatus
FailedSubStatus
UserField
UserName
552
completeTaskByCaptureId Method
The completeTaskByCaptureId method is used to send a
completeTaskByCaptureId request to the Genesys iWD. This method completes
an interaction routing process.
For a list of input parameters and their descriptions, see Table 57 on page 553.
Table 57: completeTaskByCaptureId Input Parameters
Argument Name
Description
ThirdPartyId
PrimaryOutboundDispatcherBS
PrimaryOutbound
DispatcherBS
BackupOutbound
DispatcherBS
defaultActor
553
Description
completedDateTime
Reason
BusObject
M**
defaultReason
iWD
The Siebel business object
name.
* If provided, an attempt to
update the record status (for
example, activity) is made.
There is no default value.
BusComp
M**
RecIdField
M**
InteractionField
M**
StatusField
M**
SubStatusField
554
Description
SuccessStatus
SuccessSubStatus
FailedStatus
FailedSubStatus
UserField
UserName
555
getTaskByCaptureId Method
The getTaskByCaptureId method is used to send a getTaskByCaptureId request
to the Genesys iWD. This method is used to request current information about
the interaction.
For a list of input parameters and their descriptions, see Table 58 on page 556.
Table 58: getTaskByCaptureId Input Parameters
Argument Name
Description
ThirdPartyId
PrimaryOutboundDispatcherBS
PrimaryOutbound
DispatcherBS
BackupOutbound
DispatcherBS
556
holdTaskByCaptureId Method
The holdTaskByCaptureId method is used to send a holdTaskByCaptureId
request to the Genesys iWD. This method puts an interaction on hold.
For a list of input parameters and their descriptions, see Table 59 on page 557.
Table 59: holdTaskByCaptureId Input Parameters
Argument Name
Description
ThirdPartyId
PrimaryOutboundDispatcherBS
PrimaryOutbound
DispatcherBS
BackupOutbound
DispatcherBS
defaultActor
Reason
defaultReason
iWD
557
Description
BusObject
M**
BusComp
M**
RecIdField
M**
InteractionField
M**
StatusField
M**
SubStatusField
SuccessStatus
558
Description
SuccessSubStatus
FailedStatus
FailedSubStatus
UserField
UserName
559
ping Method
The ping method is used to send a ping request to the Genesys iWD. This
method checks if iWD Web Service Capture Point is alive or not.
For a list of input parameters and their descriptions, see Table 60 on page 560.
Table 60: ping Input Parameters
Argument Name
Description
PrimaryOutboundDispatcherBS
PrimaryOutbound
DispatcherBS
CSSWSOutboundDispatcher
BackupOutbound
DispatcherBS
560
resumeTaskByCaptureId Method
The resumeTaskByCaptureId method is used to send a resumeTaskByCaptureId
request to Genesys iWD. This method resumes an interaction routing after it
was held.
For a list of input parameters and their descriptions, see Table 61 on page 561.
Table 61: resumeTaskByCaptureId Input Parameters
Argument Name
Description
ThirdPartyId
PrimaryOutboundDispatcherBS
PrimaryOutbound
DispatcherBS
BackupOutbound
DispatcherBS
defaultActor
Reason
defaultReason
iWD
561
Description
BusObject
M**
BusComp
M**
RecIdField
M**
InteractionField
M**
StatusField
M**
SubStatusField
SuccessStatus
562
Description
SuccessSubStatus
FailedStatus
FailedSubStatus
UserField
UserName
563
564
Chapter
11
Overview
The Multimedia Session Failover Handling feature has been introduced to
fully recover from short-term system failovers (an order of magnitude of x10
secondsfor example, Interaction Server switchover/unexpected
termination/restart and temporal network disconnect), while providing an
alternative recovery from longer periods of service unavailability.
The process of configuring the Multimedia Session Failover Handling consists
of the following items:
The used business processes that must be modified in order to postpone the
further routing of interactions that are recovered after a failure to give a
chance to the clients to pull back those interactions. Also, the information
about where to pull the interaction from (<queue name>/<view name>) must
be attached, as well as the interactions User Data.
565
The Siebel side of the Gplus Adapter for Siebel CRM Multimedia must
store the agents state (logged in/out, Ready/Not Ready) and interactions list
as well as recover a session after a failure, if possible.
The Adapter only restores the agent state and pull interactions that were
processed by the current agent session. If an agent session is closed, the
Adapter does not restore the agent session state and does not pull
interactions from the queue.
The Adapter restores the agent state and the pull interactions upon
receiving notification that the failed link has been restored.
The Adapter restores the agent state and pull interactions, whether or not a
timeout has expired. The pull interaction is executed when the connection
is restored. To prevent this scenario from happening, the agent must close
the browser and then reopen it.
The Adapter restores the agent state and pull interaction only once after the
connection is restored. Therefore, if the pull interaction fails for any
reason, the session is not completely restored.
This feature is not available for Genesys chat.
566
Procedure:
Multimedia Session Failover Handling: Configuring
the AgentProcessing interaction property
Purpose: To define the AgentProcessing interaction property by using
Configuration Manager.
Start of procedure
1. In Configuration Manager, click the Business Attributes folder.
2. In the Business Attributes folder, create an attribute that is called
InteractionCustomProperties (type="Custom").
3. Create an AgentProcessing attribute under the Attribute Values folder.
4. Create a translation section under the Annex tab and add the translate-to
configuration option with either of the following values:
CustomString<X>" (if you use Interaction Server version 7.6.0 or
lower) where <X> corresponds to any unused custom field.
agent_processing (if you use Interaction Server version than 7.6.0 or
higher). You must create this field in the Interaction Server table. See
Figure 54 on page 568.
567
End of procedure
Next Steps
Procedure:
Multimedia Session Failover Handling: Configuring
the Interaction Server application
Purpose: To configure the Interaction Server application.
568
Start of procedure
1. In Configuration Manager, under the Options tab, set the value of the
delay-updates configuration option to false in the settings section of the
Interaction Server application. See Figure 55.
Note: Setting this configuration option value to false might hinder the
569
Notes:
This procedure must be performed for each queue from which the
interactions are restored.
The current views existing before starting this procedure are known as
pre-existing views.
Procedure:
Multimedia Session Failover Handling: Modifying the
existing business processes
Purpose: To modify the existing business processes.
Start of procedure
1. Start the Genesys Interaction Routing Designer application.
2. In the Login dialog box:
a. Enter a user name.
b. Enter a user password.
c. Click either Details or More options to display additional input login
fields.
d. Enter the application name, which is the instance of the application to
which you are logging in.
e. Enter a host name, which is the name of the computer on which
Configuration Server runs.
f. Enter a port number, which is the number of the communication port
that client applications use to connect to Configuration Server.
3. For the pre-existing views, add the following condition:
AgentProcessing is NULL OR (AgentProcessing!='yes' AND
AgentProcessing!='pending' ) OR
(AgentProcessing='pending' AND (placed_in_queue_at <
_timestampadd(_current_time(), - ###)))
570
5. Add a unique strategy Prepare for Hold for MM recovery which sets the
condition AgentProcessing='pending' and places the interaction into the
original queue (see Figure 57).
571
strategy.
8. Set the freeze-interval value to 10 for all views.
The number value should be less than the number (###) of seconds in the
condition. Setting the freeze-interval value can be done in the following
two ways:
a. In Configuration Manager, by setting the Interaction Server
configuration option, default-view-freeze-interval.
b. By setting the Interaction Server configuration option,
default-view-freeze-interval, under the General tab of the View
Properties window in the Check Interval (sec) field.
This method is applicable only for versions of Interaction Server that
are earlier than 7.6.0.
9. Modify the strategies, which are connected to the pre-existing views. The
very first step must be to alter the User Data as follows:
a. Set the value of the RecoveryPullViewSystem key to <queue
name>/<view name>.
572
End of procedure
Next Steps
Configure the Gplus Adapter for Siebel CRM Multimedia Component. See
the section, Configuring the Gplus Communication Server on page 574.
For all of the view conditions, the value ### should be the same and should
correspond to a time interval that is measured in seconds (s) during which
interactions can be pulled. The default value to is 300 (seconds or 5 minutes).
Note: The actual period of time during which interactions can be pulled is
not very specific, and can be as much as the doubled value of the
specified number of seconds.
Example of a
Sample Business
Process
The installation package for Gplus Adapter for Siebel CRM Multimedia
contains a sample of a business process (SampleBPforMMrecovery.wie). See
Figure 59 on page 574 for an example of the sample business process:
573
574
Procedure:
Multimedia Session Failover Handling: Configuring
the Gplus Adapter for Siebel CRM Multimedia
Component
Purpose: To configure the Gplus Adapter for Siebel CRM Multimedia.
Component to use the Multimedia Session Failover Handling Feature.
Start of procedure
1. Using the Siebel Web Client, log in as a Siebel administrator.
2. Navigate to the Communication Administration, All Configurations view.
3. Find the target configuration.
4. Set the OpenMediaSessionRecovery configurations parameter value to TRUE
to turn on the failure-recovery mechanism.
5. Set an appropriate value for the RecoveryPullViewUserDataKey
configuration's parameter (see Table 46, The Multimedia Component
Configuration Parameters, on page 454 for details).
End of procedure
Next Steps
575
576
Chapter
12
Uninstallation Instructions
This chapter provides uninstallation instructions for the Gplus Adapter 8.0 for
Siebel CRM.
This chapter includes the following sections:
Overview, page 577
Uninstalling the Gplus Communication Server for Siebel CRM, page 578
Uninstalling the Configuration Synchronization Component, page 579
Uninstalling the Campaign Synchronization Component, page 588
Uninstalling the Campaign Synchronization Component 8.0.1, page 597
Uninstalling the Gplus Adapter for Siebel CRM Voice Component,
page 609
Uninstalling the Gplus Adapter for Siebel CRM UCS Gateway
Component, page 636
Uninstalling the Gplus Adapter for Siebel CRM Media Routing
Component, page 636
Uninstalling the Multimedia Component, page 639
Overview
This chapter describes how to uninstall the Gplus Adapter 8.0 for Siebel CRM.
The Adapter must be uninstalled one component at a time. To uninstall a
component, refer to the corresponding section in this chapter.
Uninstallation is typically performed for the following reasons:
577
Note: Some Gplus Adapter 8.0 for Siebel CRM components share common
Procedure:
Uninstallation: Deleting the files installed by the Gplus
Communication Server for Siebel CRM
Purpose: To delete the files installed by the Gplus Communication Server for
Siebel CRM during deployment.
Start of procedure
For Windows
Users
For UNIX Users
578
Next Steps
Delete the files installed by the Gplus Communication Server for Siebel
CRM from the Siebel Server directory. See, Procedure: Uninstallation:
Deleting the files installed by the Gplus Communication Server for Siebel
CRM from the Siebel Server directory.
Procedure:
Uninstallation: Deleting the files installed by the Gplus
Communication Server for Siebel CRM from the Siebel
Server directory
Purpose: To delete the files installed by the Gplus Communication Server for
Siebel CRM from the Siebel Server directory.
Start of procedure
For Windows
Users
For UNIX Users
579
Prestart Information
Before changing the configuration process, you should have the following
Genesys Framework applications running:
Configuration Database
Configuration Server
Configuration Manager
Procedure:
Uninstallation: Deleting the objects and template in
the Genesys configuration for the Configuration
Synchronization Component
Purpose: To change the Genesys configuration by deleting the Application
object, the Application template, and the Person object to uninstall the
Configuration Synchronization Component.
Start of procedure
Deleting the
Application Object
Deleting the
Application
Template
580
Gplus_SiebelCRM_Config_Synch_800_for_CL_71_and_higher.apd
4. Select Delete.
The Delete dialog box displays.
5. Click Yes to delete the Application template.
Deleting the
Person Object
Prestart Information
Before starting this part of the configuration process you must have the Siebel
Tools application running.
You should be connected to the local copy of the Siebel Server database and
have sufficient privileges to modify the Siebel Server repository.
581
Procedure:
Uninstallation: Deleting the Configuration
Synchronization Component Runtime Events in the
Siebel Configuration
Purpose: To delete the runtime events in the Siebel Configuration in order to
uninstall the Campaign Synchronization Component.
Start of procedure
1. Navigate through the Site Map to Business Service Administration >
Business Service Simulator.
2. In the Service Methods applet, create a new record.
3. Specify the following parameters for the new record:
Service Name: Genesys Config Synchronization
Method Name: UninstallRunTimeEvents
4. Click the Run button.
Note: After running this method, you should navigate in the Siebel client to
Administration Runtime Events > Events, and select the system menu
item Reload Runtime Events.
End of procedure
Next Steps
Use the Siebel Tools to change the Siebel configuration. See the section,
Using Siebel Tools to Change the Siebel Configuration for the
Configuration Synchronization Component.
582
Procedure:
Uninstallation: Checking out the existing
Configuration Synchronization Component projects
Purpose: To check out the Genesys Configuration Synchronization and
Personalization projects from the Siebel repository.
Start of procedure
1. In Siebel Tools, select Tools > Check Out...
The Check Out dialog box displays.
2. In the Projects list, select the projects to be checked out.
3. Click Check Out.
Note: Make sure that the following projects are checked out from the Siebel
repository:
Personalization
Next Steps
Procedure:
Uninstallation: Deleting the objects from the
Configuration Synchronization Component project in
the Siebel repository
Purpose: To delete the objects from the projects in the Siebel repository.
Start of procedure
1. In Siebel Tools, in the Project field of the Object Explorer, select All
Projects.
2. From the Object Explorer, select the Business Component folder.
The Business Components window displays.
3. Select the Genesys CommSvr CM Agents / ACD Queues business component.
4. Right-click the selected record.
583
Name
Business Component
Business Component
Business Component
Business Component
Business Component
Business Object
Business Object
Business Service
Integration Object
Genesys Agent
Link
End of procedure
Next Steps
Procedure:
Uninstallation: Changing the Personalization Action
Set business component
Purpose: To delete modifications that were made to the Personalization
Action Set business component during deployment.
584
Start of procedure
1. From the Object Explorer, select the Business Component folder and
navigate to the Personalization Action Set business component.
2. Using the Types tab of the Object Explorer, select the Field folder under
the Business Component folder.
The Fields window displays.
3. Select the Action Set ID field.
4. Right-click the selected record.
4. Select Delete Record from the drop-down menu.
5. When prompted, Are you sure you want to delete the current
record?, click Yes to delete the record.
6. Select the Actions field.
7. Right-click the selected record.
8. Select Delete Record from the drop-down menu.
9. When prompted, Are you sure you want to delete the current
record?, click Yes to delete the record.
10. Using the Types tab of the Object Explorer, select the Multi Value Field
folder under the Business Component folder.
11. The Multi Value Fields window displays.
12. Make sure the Actions field is deleted.
End of procedure
Next Steps
Procedure:
Uninstallation: Compiling the Siebel repository file
Purpose: To compile the Siebel repository file.
Start of procedure
1. In Siebel Tools, select Tools > Compile Projects...
2. Select Locked projects.
3. In the Siebel Repository File edit box, enter the name of the repository
file.
585
4. Click Compile.
The status bar at the bottom of the Object Compiler window indicates
when the compilation is finished.
5. When the compilation is finished, close Siebel Tools.
Note: It is possible for siebel_assert_xxx.txt file(s) to be generated by the
Procedure:
Uninstallation: Deleting the Configuration
Synchronization Component from the Siebel Server
Purpose: To change the Siebel configuration by deleting the Configuration
Synchronization Component implementation from the Siebel Server.
Start of procedure
Deploying the
Repository File
586
Updating the
Configuration
Files
Deleting the
Genesys Tables
4. To update the eai.cfg file in the Siebel Server installation, open it and
delete the following line from the [HTTP Services] section:
GplusConfSynchExportAllData = GplusConfSynchExportAllData.
them from the Siebel database. You must delete them manually.
The Genesys Campaign Synchronization project contains two
tables: CX_GEN_QUEUE_ITM and CX_GEN_SYN_SUM. You can use any
database tool (such as, Microsoft SQL Enterprise Manager or
Oracle Enterprise Manager) to drop these tables.
End of procedure
Next Steps
587
Prestart Information
Before starting the configuration process you should have the following
Genesys Framework applications running:
Configuration Database
Configuration Server
Configuration Manager
Synchronization Component.
Procedure:
Uninstallation: Deleting the Application object,
Application template, and the Person object in the
588
Deleting the
Application
Template
or
Gplus_SiebelCRM_Camp_Synch_800_for_CL_71_and_higher.apd
7. Select Delete.
The Delete dialog box displays.
8. Click Yes to delete the Application template.
Deleting the
Person Object
Change the Siebel configuration. See the section, Changing the Siebel
Configuration to Uninstall the Campaign Synchronization Component.
589
Prestart Information
Before starting this part of the configuration process, you must have the Siebel
Tools application running.
You must be connected to the local copy of the Siebel Server database and
have sufficient privileges to modify the Siebel Server repository.
Procedure:
Uninstallation: Deleting the Campaign
Synchronization Component runtime events in the
Siebel configuration
Purpose: To delete the runtime events in the Siebel Configuration in order to
uninstall the Campaign Synchronization Component.
Summary
In this procedure, you will run the UninstallRunTimeEvents method of the
Genesys Campaign Synchronization Siebel Business Service once by using the
Siebel Business Service Simulator applet.
Start of procedure
1. Navigate through the Site Map to Business Service Administration >
Business Service Simulator.
2. In the Service Methods applet, create a new record.
3. Specify the following parameters for the new record:
Service Name: Genesys Campaign Synchronization
Method Name: UninstallRunTimeEvents
4. Click the Run button.
After running the method, navigate in Siebel client to Administration >
Runtime Events > Events, and select the Reload Runtime Events system
menu item.
End of procedure
590
Next Steps
Use the Siebel Tools to change the Siebel configuration. See the section,
Using Siebel Tools to Change the Siebel Configuration for the Campaign
Synchronization Component.
Procedure:
Uninstallation: Checking out the existing Campaign
Synchronization Component projects
Purpose: To check out the Genesys Campaign Synchronization and
Personalization projects from the Siebel repository.
Start of procedure
1. In Siebel Tools, select Tools > Check Out...
The Check Out dialog box displays.
2. In the Projects list, select the projects to be checked out. For example
Campaign.
591
Procedure:
Uninstallation: Deleting the Campaign
Synchronization Component objects from the projects
in the Siebel repository
Purpose: To delete the Campaign Synchronization Component objects from
the projects in the Siebel repository.
Start of procedure
1. In Siebel Tools, in the Project field of the Object Explorer, select All
Projects.
2. From the Object Explorer, select the Business Component folder.
The Business Components window displays.
3. Select the Genesys Campaign List business component.
4. Right-click the selected record.
5. Select Delete Record from the drop-down menu.
6. When you see the prompt, Are you sure you want to delete the current
record?, click Yes to delete the record.
7. Repeat Steps 2 6 for all Siebel repository elements referenced
in Table 63 on page 593.
592
Name
Business Component
Business Component
Business Component
Business Component
Business Object
Business Object
Business Object
Business Object
Genesys Queue
Business Object
Business Object
Business Service
Integration Object
Link
Link
Link
Link
Link
Link
Link
Table
CX_GEN_QUEUE_ITM
Table
CX_GEN_SYN_SUM
End of procedure
593
Next Steps
Procedure:
Uninstallation: Changing the Campaign List Contact
Business Component
Purpose: To delete the modifications that were made to the Campaign List
Contact business component during deployment.
Start of procedure.
1. In Siebel Tools, in the Project field of the Object Explorer, select
Campaign.
594
Name
Field
Field
Time Zone Id
Field
Join
S_TIMEZONE
End of procedure
Next Steps
Procedure:
Uninstallation: Compiling the Siebel repository file for
the Campaign Synchronization Component
Purpose: To compile the Siebel repository file.
Start of procedure
1. In Siebel Tools, select Tools > Compile Projects...
2. Select Locked projects.
3. In the Siebel Repository File edit box, enter the name of the repository
file.
4. Click Compile.
The status bar at the bottom of the Object Compiler window indicates
when the compilation is finished.
5. When the compilation is finished, close Siebel Tools.
Note: It is possible for the siebel_assert_xxx.txt file(s) to be generated by
595
Next Steps
Procedure:
Uninstallation: Deleting the Campaign
Synchronization Component implementations from
the Siebel Server
Purpose: To change the Siebel configuration by deleting the Campaign
Synchronization Component implementation from the Siebel Server.
Start of procedure
Deploying the
Repository File
Deleting the
Subsystems
Also, you may need to generate and deploy browser scripts for
the new repository file. For further information about how to
deploy an updated repository file to the Siebel Server, refer to the
Siebel documentation.
Updating the
Configuration
Files
596
4. To update the eai.cfg file in the Siebel Server installation, open it and
delete the following line from the [HTTP Services] section:
GplusCampSynch = GplusCampSynchDispatch.
Deleting the
Genesys Tables
them from the Siebel database. You must delete them manually.
The Genesys Campaign Synchronization project contains the
following two tables: CX_GEN_QUEUE_ITM and CX_GEN_SYN_SUM. You
can use any database tool (such as, Microsoft SQL Enterprise
Manager or Oracle Enterprise Manager) to delete these tables.
End of procedure
Next Steps
597
Synchronization Component.
Prestart Information
Before starting the configuration process you should have the following
Genesys Framework applications running:
Configuration Database
Configuration Server
Configuration Manager
Procedure:
Uninstallation: Deleting the Application object,
Application template, and the Person object in the
Genesys Configuration for the Campaign
Synchronization Component 8.0.1
Purpose: To change the Genesys configuration by deleting the Application
object, the Application template, and the Person object to uninstall the
Campaign Synchronization Component 8.0.1.
Start of procedure
Deleting the
Application Object
598
Deleting the
Application
Template
6. Select Delete.
The Delete dialog box displays.
7. Click Yes to delete the Application template.
Deleting the
Person Object
Change the Siebel configuration. See the section, Changing the Siebel
Configuration to Uninstall the Campaign Synchronization Component.
Prestart Information
Before starting this part of the configuration process, you must have the Siebel
Tools application running.
You must be connected to the local copy of the Siebel Server database and
have sufficient privileges to modify the Siebel Server repository.
599
Procedure:
Uninstallation: Deleting the Campaign
Synchronization Component runtime events in the
Siebel configuration
Purpose: To delete the runtime events in the Siebel Configuration in order to
uninstall the Campaign Synchronization Component.
Summary
In this procedure, you will run the UninstallRunTimeEvents method of the
Genesys CampSynch Tools Siebel Business Service once by using the Siebel
Business Service Simulator applet.
Start of procedure
1. Log into Siebel as an administrator.
2. Navigate through the Site Map to Business Service Administration >
Business Service Simulator.
3. In the Service Methods applet, create a new record.
4. Specify the following parameters for the new record:
Service Name: Genesys CampSynch Tools
Method Name: UninstallRunTimeEvents
5. Click the Run button.
After running the method, navigate in Siebel client to Administration >
Runtime Events > Events, and select the Reload Runtime Events system
menu item.
End of procedure
Next Steps
Delete the workflow processes from the Siebel Server. See the section,
Deleting the Workflow Processes from the Siebel Server on page 600.
600
Procedure:
Uninstallation: Deleting the workflow processes from
the Siebel Server
Purpose: To delete the workflow processes on the Siebel Server.
Start of procedure
1. Select Site Map > Administration > Business Process, Workflow
Deployment.
2. In the Active Workflow Processes applet, select the Genesys CaS Campaign
WF workflow process.
3. Choose the Delete Process menu option.
The Genesys CaS Campaign WF workflow process is removed.
4. Repeat steps Steps 3 and 4 for the Genesys CaS CR WF workflow process.
The Genesys CaS CR WF workflow process is removed.
End of procedure
Next Steps
Procedure:
Uninstallation: Checking out the existing Campaign
Synchronization Component projects
Purpose: To check out the Genesys Campaign Synchronization and
Personalization projects from the Siebel repository.
601
Start of procedure
1. In Siebel Tools, select Tools > Check Out...
The Check Out dialog box displays.
2. In the Projects list, select the projects to be checked out. For example
Campaign.
Procedure:
Uninstallation: Deleting the Campaign
Synchronization Component objects from the projects
in the Siebel repository
Purpose: To delete the Campaign Synchronization Component objects from
the projects in the Siebel repository.
Start of procedure
1. In Siebel Tools, in the Project field of the Object Explorer, select the
Campaign Synchronization2 project.
2. Delete all of the objects related to the selected project using the Object
Explorer.
End of procedure
Next Steps
602
Procedure:
Uninstallation: Changing the Campaign List Contact
Business Component
Purpose: To delete the modifications that were made to the Campaign List
Contact business component during the deployment.
Start of procedure
1. In Siebel Tools, in the Project field of the Object Explorer, select
Campaign.
2. From the Object Explorer, select the Business Component folder.
The Business Components window displays.
3. Select the Campaign List Contact business component.
4. Using the Types tab of the Object Explorer, select the Field folder under
the Business Component folder.
The Fields window displays.
5. Select the Calculated Contact Id field.
6. Right-click the selected record.
7. Select Delete Record from the drop-down menu.
8. When you see the prompt, Are you sure you want to delete the current
record?, click Yes to delete the record.
9. Repeat Steps 2 6 for all elements of the Campaign List Contact business
component referenced in .
Table 65: Elements to Delete from the Campaign List Contact
Business Component
Type
Name
Field
Field
Field
Field
Status LIC
Field
Time Zone Id
Field
603
Name
Join
S_PRSP_TIMEZONE
Join
S_TIMEZONE
Procedure:
Uninstallation: Removing the link to the
Administration - Campaign Synchronization screen
from the Site Map of the Application object
Purpose: To remove the link to the Administration - Campaign
Synchronization screen from the Site Map of the Application object.
Start of procedure
1. Check-out or lock the project that corresponds to the Application object
that you are using. See, Procedure: Campaign Synchronization Component
8.0.1: Checking out existing projects, on page 178.
2. In Siebel Tools, in the Project field of the Object Explorer, select the name
of the project of the Siebel application that you are usingfor example:
Siebel Universal Agent.
3. Select the Application folder.
The Application window displays.
4. Select the Application object that you are using.
5. Using the Types tab of the Object Explorer, select the Screen Menu Item
folder under the Application folder.
The Application Screen Menu Items window displays.
604
Procedure:
Uninstallation: Removing the Administration Campaign Synchronization screen from the Page tab
of the Application Object
Purpose: To remove the Administration - Campaign Synchronization screen
from the Page tab of the Application object.
Start of procedure
1. Check-out or lock the project that corresponds to the Application object
that you are using. See, Procedure: Campaign Synchronization Component
8.0.1: Checking out existing projects, on page 178.
2. In Siebel Tools, in the Project field of the Object Explorer, select the name
of the project of the Siebel application that you are usingfor example:
Siebel Universal Agent.
3. Select the Application folder.
The Application window displays.
4. Select the Application object that you are using.
5. Using the Types tab of the Object Explorer, select the Page Tab folder
under the Application folder.
The Application Page Tabs window displays.
6. Remove the record related to the Administration - Campaign
Synchronization screen from the Page Tabs table.
End of procedure
605
Next Steps
Procedure:
Uninstallation: Compiling the Siebel repository file for
the Campaign Synchronization Component
Purpose: To compile the Siebel repository file.
Start of procedure
1. In Siebel Tools, select Tools > Compile Projects...
2. Select Locked projects.
3. In the Siebel Repository File edit box, enter the name of the repository
file.
4. Click Compile.
The status bar at the bottom of the Object Compiler window indicates
when the compilation is finished.
5. When the compilation is finished, close Siebel Tools.
Note: It is possible for the siebel_assert_xxx.txt file(s) to be generated by
Procedure:
Uninstallation: Deleting the Campaign
Synchronization Component implementations from
the Siebel Server
Purpose: To change the Siebel configuration by deleting the Campaign
Synchronization Component implementation from the Siebel Server.
606
Start of procedure
Deploying the
Repository File
Deleting the
Subsystems
Deleting the
Genesys Tables
Also, you may need to generate and deploy browser scripts for
the new repository file. For further information about how to
deploy an updated repository file to the Siebel Server, refer to the
Siebel documentation.
them from the Siebel database. You must delete them manually.
The Genesys Campaign Synchronization2 project contains the
following tables: CX_GCAS_ASSIGN, CX_GCAS_CFG_OBJ,
CX_GCAS_QUEUE_ITM, and CX_GCAS_SUMMARY. You can use any
database tool (such as, Microsoft SQL Enterprise Manager or
Oracle Enterprise Manager) to delete these tables.
End of procedure
Next Steps
Procedure:
Uninstallation: Deleting the Campaign
Synchronization Component-specific values from the
Siebel Server
Purpose: To delete Campaign Synchronization Component-specific List of
Values from the Siebel Server.
607
Start of procedure
1. Delete the values of the following types from the List of Values:
GENESYS_SYNCH_ORDER
GENESYS_SYNCH_MODE
GENESYS_SBL_SYNCH_STATUS
End of procedure
Next Steps
Remove the responsibilities and the view definitions for the Campaign
Synchronization Component. See the section, Procedure: Removing the
Responsibilities and the View Definitions for the Campaign
Synchronization Component.
Procedure:
Uninstallation: Removing the responsibilities and the
view definitions for the Campaign Synchronization
Component
Purpose: To remove the responsibilities and the view definitions f for the
Campaign Synchronization Component.
Start of procedure
1. Log in as a Siebel administrator.
2. Select Site Map > Administration > Application, Responsibilities and
delete the following record identified by their name:
Genesys CampSynch Administrator
3. Select Site Map > Administration > Application, Views and delete the
following records identified by their name:
Genesys CaS Config View
Genesys CaS Assign View
Genesys CaS Siebel Monitor View Status
Genesys CaS Siebel Monitor View Queue
608
End of procedure
Next Steps
609
1. Deleting the Voice Component-specific values and settings from the Siebel
application.
You use the Siebel Administration application to complete these related
tasks.
2. Deleting the Voice Component drivers and the configurations from the
Siebel application.
3. Deleting the Voice Component objects from the Siebel application using
the Siebel Tools and compiling a new *.srf archive file.
Note: The Basic Voice Siebel objects from the GenComm.sif file may be
The Siebel CRM Server platform with the Gplus Adapter 8.0 for Siebel
CRM should be installed and deployed.
You should have administrator rights for accessing the Siebel application.
You should have sufficient administrator privileges when logging into the
operating system.
610
Start of procedure
1. Before you delete these values, read Configuring Siebel Using the Siebel
Web Client on page 245.
2. For the Voice Component features, delete the values of the following types
from the List of Values (LOV):
Basic Voice
AGENT_WORK_MODE
REASON_CODE
Expert Contact
GENESYS_CALL_STATUS
GENESYS_LOCATION
Outbound Campaign
GENESYS_CALL_RESULT
GENESYS_TREATMENT_TYPE
GENESYS_CALLBACK_TYPE
Voice Callback
GENESYS_ROUTING_POINT
End of procedure
Next Steps
Delete the Voice Component drivers and configurations from the Siebel
application. See section Deleting the Voice Component-Specific Values
and Settings from Siebel.
Procedure:
Uninstallation: Deleting the Voice Component drivers
and configurations from the Siebel application
Purpose: To delete the Voice Component drivers and configurations from the
Siebel application.
611
Start of procedure
1. Log into Siebel as an administrator.
2. In the Siebel Site Map, navigate to Communications Drivers and Profiles.
Select Site Map > Administration - Communications> Communications
Drivers and Profiles.
3. Navigate to the Gplus driver record and delete it.
4. In the Siebel Site Map, navigate to All Configurations.
5. Select Site Map > Administration - Communications> All
Configurations.
6. Navigate to any unused profiles associated with the Gplus driver and delete
them.
End of procedure
Next Steps
Delete the Siebel components and objects from Siebel. See the section,
Deleting the Voice Components Objects from Siebel.
Bitmap
Command
HTML Comm *
Toolbar Communication
Expert Contact
Toolbar Items
Toolbar Communication
Universal Callback
Toolbar Items
612
Server script
Control
Field
Field
Pick List
Command
Toolbar Communication
Toolbar Items
Table S_EVT_ACT_X
Outbound
Campaign
Fields
Server script
Control
Control
Field
Command
Pick List
Toolbar Communication
613
Toolbar Items
Toolbar Dashboard
Check out and lock the existing Voice Component projects. See,
Procedure: Uninstallation: Checking out and locking existing Voice
Component projects.
Procedure:
Uninstallation: Checking out and locking existing
Voice Component projects
Purpose: To check out and lock the existing Voice Component projects from
the Siebel repository.
Start of procedure
1. In Siebel Tools, select Tools > Check Out...
The Check Out dialog box displays.
2. In the Projects list, select the projects to be locked as selected from
Table 66 on page 615.
3. Click Check Out.
614
Table 66: Projects for All Supported Siebel Versions - Common for All Components
and Feature-Specific Projects
Feature
Archive File
Common Projects
(for all components)
Feature-Specific
Projects
Basic Voice
GenComm.sif
Command
None
Expert Contact
GenComm_ECS.sif
Outbound Campaign
GenComm_OCS.sif
Universal Callback
GenComm_VCB
Communication
Communication
Administration
Persistent Customer
Dashboard
None
Campaign
Activity
Contact
Contact (SSE)
Table Activity
Genesys Voice
<Project related to an
application on which
the Adapter is
deployed with the
Universal Callback
feature >*
Delete the Gplus customizations from the Siebel repository. See the
section, Deleting the Gplus Customizations from the Siebel Repository
on page 616.
615
Procedure:
Uninstallation: Changing the Bitmap Category HTML
Command Icons records
Purpose: To delete the modifications made during deployment to the Bitmap
Category HTML Command Icons records.
Start of procedure
1. In Siebel Tools, from the Object Explorer, select the Bitmap Objects
folder.
The Bitmap Category window displays.
2. In the Bitmap Category window, select the Bitmap Category HTML Command
Icons folder.
The Bitmaps Objects window appears.
3. Delete the following records in the Bitmaps Objects window:
a. Basic Voice Feature
Comm Do Not Disturb
Comm Do Not Disturb On
Comm Ready
Comm Ready Disabled
b. Expert Contact Feature
Comm Accept Callback Enabled
Comm Accept Callback Disabled
Comm Reject Callback Enabled
Comm Reject Callback Disabled
c. Outbound Campaign Feature
Comm OB Add Disabled
Comm OB Add Enabled
Comm OB Cancel Disabled
Comm OB Cancel Enabled
616
617
f.
End of procedure
Next Steps
Delete the Gplus customizations made to the Command object records in the
Siebel repository. See, Procedure: Uninstallation: Changing the Command
object records.
Procedure:
Uninstallation: Changing the Command object records
Purpose: To delete the modifications that were made to the Command object
records located in the Siebel repository.
Start of procedure
1. In Siebel Tools, from the Object Explorer, select the Command Objects
folder.
The Commands window displays.
2. Delete the following records in the Commands window:
a. Basic Voice Feature
HTML Comm AcceptGVoice
HTML Comm Alternate Call
HTML Comm Cancel Monitoring
HTML Comm Delete From Conf
HTML Comm Do Not Disturb
HTML Comm InitiateGVoice
HTML Comm LoginToGVoice
HTML Comm LogoutFromGVoice
HTML Comm Monitor Next Call
HTML Comm NotReadyGVoice
HTML Comm Query Address
HTML Comm ReadyGVoice
HTML Comm Send DTMF
b. Outbound Campaign Feature
HTML Comm OB Add
HTML Comm OB Chain Request
618
619
Delete the Gplus customizations for the Genesys Voice Business Service.
See, Procedure: Uninstallation: Changing the Genesys Voice Business
Service.
Procedure:
Uninstallation: Changing the Genesys Voice Business
Service
Purpose: To delete modifications that were made to the Genesys Voice
Business Service during deployment.
Start of procedure
1. In Siebel Tools, from the Object Explorer, select the Business Service
Objects folder.
2. Select the Genesys Voice Business Service record from the list of
Business Services.
3. Delete the record.
End of procedure
Next Steps
Delete the Expert Contact Feature items. See the section, Deleting the
Gplus Adapter Customizations Made to the Expert Contact Feature Items.
620
Toolbar items
Procedure:
Uninstallation: Changing the Expert Contact Feature
items
Purpose: To delete the modifications that were made to the Expert Contact
Feature items during deployment.
Start of procedure
Command object
records
1. In Siebel Tools, from the Object Explorer, select the Command objects
folder.
The Commands window displays.
2. Delete the following records in the Commands window:
HTML Comm KwCallStatusResponse
HTML Comm KwOnCall
Toolbar items
3. In Siebel Tools, from the Object Explorer, select the Toolbar objects
folder.
The Toolbars window opens.
4. Select Toolbar Communication in the Toolbars window.
5. From the Object Explorer, select the Toolbar Item folder.
6. Select the Kw On Call record.
7. Right-click the selected record and click delete.
End of procedure
Next Steps
Delete the changes made to the Outbound Campaign Feature items during
deployment. See the section, Deleting the Gplus Adapter Customizations
Made to the Outbound Campaign Feature Items on page 621.
621
Procedure:
Uninstallation: Changing the Campaign
Contact/Prospect Form applet
Purpose: To remove the modifications that were made to the Campaign
Contact/Prospect Form applet during deployment.
Start of procedure
1. In Siebel Tools, from the Object Explorer, select the Applet Objects folder.
2. Select the Campaign Contact/Prospect Form Applet on the list of applets.
3. Expand the Applet Objects folder in Object Explorer.
4. Next, follow the steps below to process these categories:
Server Script
Applet Web Template
Control
a. On the List of Applets window, right-click on the record and select
Edit Server Scripts from the drop down menu.
b. Navigate to the WebApplet_PreCanInvokeMethod.
c. If this method contains only Gplus-related modifications, then replace
the complete source code between the braces with the statement:
Server Script
return (ContinueOperations) ;
Applet Web
Template
Control
RescheduleTime
End of procedure
Next Steps
622
Procedure:
Uninstallation: Changing the Campaign List Contact
business component
Purpose: To delete the modifications that were made to the Campaign List
Contact business component during deployment.
Start of procedure
1. In Siebel Tools, from the Object Explorer, select and expand the Business
Component Objects folder.
The Business Components window displays.
2. Select the Campaign List Contact business component in the Business
Components window.
3. Next, follow the steps below to process the following categories:
BusComp Server Scripts
Field
Pick List
PickList Genesys Call Result
BusComp Server
Scripts
623
i.
Field
Pick List
PickList Genesys
Call Result
End of procedure
Next Steps
624
Procedure:
Uninstallation: Changing the Siebel Financial Services
application
Purpose: To delete the modifications made to the Siebel Financial Services
application during deployment.
Start of procedure
1. In Siebel Tools, from the Object Explorer, go to the Applications objects.
The Applications list window displays.
2. On the Applications list window, select the application on which the
Gplus Adapter was deployed (for exampleSiebel Financial Services),
then right-click the record and select Edit Server Scripts from the dropdown menu.
3. Under the Application category, navigate to the Application_PreNavigate
method.
4. If this method contains only Gplus-related modifications, then replace the
complete source code between the braces with the statement:
return (ContinueOperations) ;
Procedure:
Uninstallation: Changing the Contact Activity List
applet
Purpose: To delete the modifications made to the Contact Activity List
applet.
625
Start of procedure
1. In Siebel Tools, from the Object Explorer, select the Applet Object folder.
2. Select the Contact Activity List applet on the list of applets.
3. Expand the Applet Object folder in Object Explorer.
4. Next, follow the steps below to process the following categories:
Applet Web Template
List
Business Component Action
Pick List
PickList Genesys Routing Point
Command
Applet Web
Template
List
Business
Component Action
Pick List
626
From the Object Explorer, navigate to and expand the List category.
Select then List Column item
Navigate to the List Columns window.
Delete the following record:
Genesys RoutPoint
Command
End of procedure
Next Steps
To restore the S_EVT_ACT_X table structure in the local Siebel database. See
the section, Restoring the S_EVT_ACT_X Table Structure in the Local
Siebel Database or in the Siebel Server Database on page 627.
Procedure:
Uninstallation: Changing the S_EVT_ACT_X Table
Structure
Purpose: To update the S_EVT_ACT_X table in the local Siebel database (or in the
Siebel server database).
627
Start of procedure
1. Connect Siebel Tools to the server database.
2. In Siebel Tools, from the Object Explorer, navigate and expand the Table
Object folder.
3. Navigate to the List of Tables window.
4. Locate the S_EVT_ACT_X table.
5. In the Object Explorer window, select the Columns category.
6. Locate and remove the following records:
X_ATTRIB_51
X_ATTRIB_52
7. Click Apply.
A pop-up warning window appears.
8. Click OK to accept the warning.
9. In the new Apply Schema window, from the Tables drop down list, select
Current Row.
10. Enter the correct values for the Database user, the Database user password,
and the ODBC data source.
You must enter the user name and password for a Database user who has
an administrator's privileges in the Siebel environment.
See the Siebel documentation for more information about creating custom
tables.
11. Click Apply.
The message Changes successfully applied appears, indicating that the
tables were successfully created.
12. Click the Activate button to propagate the database changes and make
them available to all users.
Note: It may be necessary to create new fields in the local database. Refer to
628
Update the S_EVT_ACT_X table changes in the Siebel server repository. See,
Procedure: Uninstallation: Updating the S_EVT_ACT_X table changes in
the Siebel Server repository, on page 629.
Procedure:
Uninstallation: Updating the S_EVT_ACT_X table
changes in the Siebel Server repository
Purpose: To update the S_EVT_ACT_X table changes in the Siebel Server
repository.
Start of procedure
1. In Siebel Tools, select Tools > Check In....
The Check In dialog box displays.
2. In the Projects list, select the following projects:
Table Activity.
3. Click Check In.
To apply changes to Siebel databases, follow the steps described in the
section Updating the S_EVT_ACT_X Table in the Genesys Project
Server Database on page 243.
End of procedure
Next Steps
629
Procedure:
Uninstallation: Changing the Communication Toolbar
items
Purpose: To delete the modifications that were made to the Communication
Toolbar items during deployment.
Start of procedure
1. In Siebel Tools, from the Object Explorer, navigate to and expand the
Toolbar Object folder.
The Toolbar window displays.
2. Select the Communication Toolbar folder in the Toolbar window.
3. Process the following actions for the Communication Toolbar items.
a. From the Object Explorer, navigate to the Toolbar Item category.
b. Delete the records as shown in Table 67 on page 631.
630
Records
KW on Call
Accept GChat
LogIn GChat
LogOut GChat
Not Ready GChat
Ready GChat
Accept GEmail
Initiate GEmail
LogIn GEmail
LogOut GEmail
Not Ready GEmail
Ready GEmail
631
Records
Accept Email
Initiate Email
LogIn SEmail
LogOut SEmail
Not Ready Email
Ready SEmail
Add Interaction
Reject Interaction
Cancel Interaction
Reschedule Interaction
Interaction Done
End of procedure
Next Steps
Procedure:
Uninstallation: Compiling the Siebel repository file
Purpose: To compile the Siebel repository file.
Start of procedure
1. In Siebel Tools, select Tools > Compile Projects...
2. Select Locked projects.
3. In the Siebel Repository File edit box, enter the name of the repository
file.
4. Click Compile.
The status bar at the bottom of the Object Compiler window indicates
when the compilation is finished.
632
Delete the files installed by the Voice Component installation. See the
section, Deleting the Files Installed by the Voice Component Installation.
Procedure:
5. To complete uninstallation, remove the icons from the web server images
directory.
For a UNIX
Environment
633
10. Remove all of the files and subdirectories in the <Destination Directory>
folder, which is the destination directory for installation that is used by the
installation script to copy the Gplus Adapter for Siebel CRM Voice files).
11. To complete uninstallation, remove the icons from the web server images
directory.
Note: Make sure to restore the original Siebel icons for the Ready/Not Ready
Obtain the server script source codes. See the section, Obtaining the
Server Script Source Codes Included in the Gplus Adapter Installation
Package.
Procedure:
Uninstallation: Obtaining the server script source
codes
Purpose: To obtain the Campaign List Contact business component server
script source code, the Campaign Contact/Prospect Form applet server script,
and the Universal Callback server script.
634
Start of procedure
Campaign List
Contact Business
Component
Campaign
Contact/Prospect
Form applet
Universal Callback
635
Uninstalling the Gplus Adapter for Siebel CRM UCS Gateway Component
Procedure:
Uninstallation: Deleting the files installed by the Gplus
Adapter for Siebel CRM UCS Gateway Component
Purpose: To delete the files installed by the Gplus Adapter for Siebel
CRMUCS Gateway Component based on your platform.
Start of procedure
Windows
UNIX
2. Delete the UCS Gateway Components files by removing the directory that
was used as the destination directory during installation.
End of procedure
Next Steps
636
Uninstalling the Gplus Adapter for Siebel CRM Media Routing Component
The Siebel CRM Server platform with the Gplus Adapter 8.0 for Siebel
CRM should be installed and deployed.
You should have administrator rights for accessing the Siebel application.
You should have sufficient administrator privileges when logging into the
operating system.
Procedure:
Uninstallation: Removing the Siebel objects (Media
Routing Component)
Purpose: To remove the Siebel objects.
637
Uninstalling the Gplus Adapter for Siebel CRM Media Routing Component
Start of procedure
1. Remove the GplusMediaRoute and GplusMediaRouteIXN Business Services.
a. Lock the GplusMediaRoute and GplusMediaRouteIXN projects.
b. From the Object Explorer, browse to the GplusMediaRoute and
GplusMediaRouteIXN projects and select the Business Service tab.
c. In the Business Services window, right-click the GplusMediaRoute and
GplusMediaRouteIXN Business Services and select Delete from the
drop-down menu.
2. Remove the MediaRouting Communication Detail View.
a. From the Object Explorer, select the View tab.
b. Click the New Query button on the toolbar.
c. Set the Name to MediaRouting Communication Detail View, and click the
Execute Query button.
d. From the Views window, right-click the MediaRouting Communication
Detail View record and select Delete from the drop-down menu.
3. Remove the MediaRouting Comm Inbound Item Form applet and
MediaRouting Comm Outbound Item applet.
a. From the Object Explorer, select the Applet tab.
b. Click the New Query button on the toolbar.
c. Set the Project to GplusMediaRouting, and click the Execute Query
button.
d. From the Applets window, right-click the MediaRouting Comm Inbound
Item Form Applet record and select Delete from the drop-down menu.
e. From the Applets window, right-click the MediaRouting Comm Outbound
Item Applet record and select Delete from the drop-down menu.
4. Recompile the project.
Siebel
Administration
Application
638
Remove the Siebel objects that were installed during the Gplus Adapter for
Siebel CRM Multimedia Component installation.
UNIX
Procedure:
Uninstallation: Removing the Siebel objects
(Multimedia Component)
Purpose: To remove the Siebel objects for the Multimedia Component.
Start of procedure
1. Start Siebel Tools.
2. Select the Genesys Multimedia project in the top drop-down combo box of
the Object Explorer.
639
3. Go to the following folders and remove all of the objects belonging to the
Genesys Multimedia project:
Applet
Business Component
Business Object
Business Service
Integration Object
Link
Screen
Symbolic Strings
View
Web Template
4. Remove the Page Tab record created during the deployment.
5. Compile a new *.srf archive file.
End of procedure
Next Steps
Procedure:
Uninstallation: Updating the Siebel configuration for
the Multimedia Component
Purpose: To remove the drivers and the configurations from the Siebel
application.
Start of procedure
1. Log into Siebel as an administrator.
2. In the Siebel Site Map, navigate to Communications Drivers and Profiles:
Select Site Map > Administration -Communications > Communications
Drivers and Profiles.
3. Navigate to the Gplus_OpenMedia record and delete it.
640
Procedure:
Uninstallation: Removing the List of Values associated
with the Multimedia Component
Purpose: To remove the List of Values associated with the Multimedia
Component.
Start of procedure
1. Log into Siebel as an administrator.
2. In the Siebel Site Map, navigate to the List of Values administration
applet and delete the following records identified by Type and Display
value:
CHANNEL_TYPE, Gplus Universal
REPOSITORY_HTML_CTRL_TYPE, GChatControl
COMM_MEDIA_TYPE, Gplus Universal
TODO_TYPE, Email - Outbound (MCR)\
TODO_TYPE, Email - Inbound (MCR)
LOV_TYPE, MCR_WORKBIN_TYPE
MCR_WORKBIN_TYPE,*
EVENT_STATUS,Completed
641
EVENT_STATUS, NotQueued
End of procedure
Next Steps
Procedure:
Uninstallation: Removing the responsibilities and the
view definitions for the Multimedia Component
Purpose: To remove the responsibilities and the view definitions.
Start of procedure
1. Log into Siebel as an administrator.
2. In the Siebel Site Map, navigate to the Responsibilities administration
view and delete the following record identified by Name:
Genesys Multimedia Agent
642
3. In the Siebel Site Map, navigate to the View administration view and
delete the following records identified by Name:
MCR Chat plus Knowledge Manager
MCR Reply Email plus InAttachments
MCR Reply Email plus Knowledge Manager
MCR Reply Email plus OutAttachments
MCR Reply Email with Suggestion
MCR Reply Email plus InAttachments T
MCR Reply Email plus Knowledge Manager T
MCR Reply Email plus OutAttachments T
MCR Reply Email with Suggestion T
MCR Workbin View
MCR dummy 1
MCR dummy 2
MediaRouting Communication Detail View
End of procedure
Next Steps
Procedure:
Uninstallation: Removing the Outbound web service
definition
Purpose: To remove the Outbound Web Service definition.
Start of procedure
1. Log into Siebel as an administrator.
2. In the Siebel Site Map, navigate to the Outbound Web Service
administration view and delete the following record identified by Name:
Genesys Gplus WebService
End of procedure
643
Next Steps
644
Appendix
Scripts
This appendix describes how to generate and deploy the browser and server
scripts and includes the following sections:
Generating and Deploying Browser Scripts, page 645
Updating the Application's Application_PreNavigate Event Server Script,
page 646
Server
For further information about browser script generation and deployment, see
Siebel Tools Reference and Alert 365: Browser Script Generation in Siebel
v7 on the Siebel support website.
645
Appendix : Scripts
where <function body> is the eScript code designed for the appropriate
component.
If the original Application_PreNavigate event script consists only of a
return(ContinueOperation) call, change the structure of the resulting eScript
code as follows:
function Application_PreNavigate (DestViewName, DestBusObjName)
{
<VOICE function body>
<MULTIMEDIA function body>
return (ContinueOperation);
}
Therefore, just copy the <function body> code from the appropriate files for
each component into the Application_PreNavigate event script body and then
finalize them by a return(ContinueOperation) call.
646
Appendix :
647
Appendix :
648
Supplements
Related Documentation
Resources
The following resources provide additional information that is relevant to this
software. Consult these additional resources as necessary.
Gplus Adapter 8.0 for Siebel CRM Users Guide. Explains how to use the
Adapter in your contact center environment. Introduces the Gplus Adapter
and highlights new features in the current release.
Gplus Adapter 8.0 for Siebel CRM Developers Guide. Describes the API
(application programming interface) with which you can customize the
export of campaigns, campaign contacts, and Do Not Call requests from
Siebel to Genesys software.
Genesys
Release Notes and Product Advisories for this product, which are available
on the Genesys Technical Support website at
http://genesyslab.com/support.
649
650
Document Conventions
Document Conventions
This document uses certain stylistic and typographical conventions
introduced herethat serve as shorthands for particular kinds of information.
You will need this number when you are talking with Genesys Technical
Support about this product.
Type Styles
Table 68 describes and illustrates the type conventions that are used in this
document.
Table 68: Type Styles
Type Style Used For
Examples
Italic
Document titles
Emphasis
Definitions of (or first references to)
unfamiliar terms
Mathematical variables
651
Document Conventions
Examples
Monospace
font
(Looks like
teletype or
typewriter
text)
Square
A particular parameter or value that is optional smcp_server -host [/flags]
brackets ([ ]) within a logical argument, a command, or
some programming syntax. That is, the
presence of the parameter or value is not
required to resolve the argument, command, or
block of code. The user decides whether to
include this optional information.
Angle
brackets
(< >)
652
Index
Symbols
[] (square brackets). . . . . . . . . . . . . . 652
< > (angle brackets) . . . . . . . . . . . . . 652
A
ACD position DNs . . . . . . . . . . . . . . 264
activity creation. . . . . . . . . . . . . . . . 268
agentloginfolders section
Configuration Synchronization Component
AgentLogin . . . . . . . . . . . . . . . 75
AgentLogout Control . . . . . . . . . . . . . 292
agent-to-agent transfers . . . . . . . . . . . 273
angle brackets . . . . . . . . . . . . . . . . 652
application object
Gplus Communication Server . . . . . . . . 45
application object, creating
Campaign Synchronization component . . . . .
. . . . . . . . . . . . . . . . . . .108, 157
Configuration Synchronization Component
. . . . . . . . . . . . . . . . . . . 70, 418
application template, importing
Campaign Synchronization component
. . . . . . . . . . . . . . . . 107, 156, 417
Application_PreNavigate
updating . . . . . . . . . . . . . . . . . . 646
audience, for document . . . . . . . . . . . 24
B
Basic Voice . . . . . . . . . . . . . . . . . . 29
brackets
angle. . . . . . . . . . . . . . . . . . . . 652
square . . . . . . . . . . . . . . . . . . . 652
C
Campaign Synchronization. . . . . . . . . . 29
653
Index
Communication Server . . . . . . . . . . . . 29
internal-port . . . . . . . . . . . . 53, 161, 162
ProcessingThreadPoolSize . . . . . . . . . 54
RequestTimeout . . . . . . . . . . . . . . . 55
service-duplicate-overwrite . . . . . . . . . 54
ServiceInactivityTimeout. . . . . . . . . . . 55
ThirdPartyId . . . . . . . . . . . . . . . . . 54
configuration
Configuration Synchronization Component
agentloginfolders section . . . . . . . 75
application object, creating. . . . . . . 70
application template . . . . . . . . . . 69
dnfolders section . . . . . . . . . . . . 76
Genesys . . . . . . . . . . . . . . .68, 75
log section . . . . . . . . . . . . . . . 79
new person. . . . . . . . . . . . . . . 83
personfolders section . . . . . . . . . 79
placefolders section . . . . . . . . . . 80
security settings . . . . . . . . . . . . 83
skillfolders section . . . . . . . . . . . 81
skilllevels section. . . . . . . . . . . . 82
tenants section . . . . . . . . . . . . . 83
eMail response . . . . . . . . . . . . . . 538
Gplus Communication Server . . . . . . . . 41
application object . . . . . . . . . . . 45
GenCommDrv.ini. . . . . . . . . . . . 57
open-media-drive section . . 53, 161, 162
open-media-userdata section . . . . . 54
planning . . . . . . . . . . . . . . . . 42
properties . . . . . . . . . . . . . . . 46
Siebel . . . . . . . . . . . . . . . . . 64
voice section . . . . . . . . . . . . . . 56
multimedia agents . . . . . . . . . . . . . 538
configuration options
Open Media Server
HTTP section . . . . . . . . . . . . . 499
password . . . . . . . . . . . . . . . . . . 77
ServerURL. . . . . . . . . . . . . . . . . . 77
SkipSkillItemTypeName . . . . . . . . . . . 78
username . . . . . . . . . . . . . . . . . . 78
UseSeparatorsForSkillName . . . . . . . . 78
xslTransformer . . . . . . . . . . . . . . . 79
Configuration Synchronization Component . 29
application object, creating . . . . . . . . 418
installation . . . . . . . . . . . . . 56, 86, 422
Person, adding . . . . . . . . . . . . . . . 84
Person, creating new . . . . . . . 84, 120, 163
security settings . . . . . . . . . . . . . . . 83
Siebel Tools, configuring . . 89, 135, 177, 501
Windows, installation . . 86, 87, 214, 423, 424
configure
Open Media Server
application object . . . . . . . . . . . 492
General tab . . . . . . . . . . . . . . 492
654
connection
subsystem
creating . . . . . . . . . . . . . . . .
T-Server . . . . . . . . . . . . . . . . . .
conventions
in document . . . . . . . . . . . . . . . .
type styles. . . . . . . . . . . . . . . . .
creating
tables, server database . . . . . . . . . .
CTI-Less T-Server . . . . . . . . . . . . . .
511
257
651
651
243
. 29
D
database
server . . . . . . . . . . . . . . . . . . . 243
definition file . . . . . . . . . . . . . . . . . 310
editing . . . . . . . . . . . . . . . . . . . 252
migrating, upgrading . . . . . . . . . . . . 32
modifying . . . . . . . . . . . . . . . . . 273
deployment
system requirements . . . . . . . . . . . . 29
destination phone number, setting alternative . .
. . . . . . . . . . . . . . . . . . . 300
device commands, Voice Component
AlternateCall . . . . . . . . . . . . . . . 366
AnswerCall . . . . . . . . . . . . . . . . 347
AttachData . . . . . . . . . . . . . . . . 361
Cancel Monitoring. . . . . . . . . . . 368, 369
CancelBusy . . . . . . . . . . . . . . . . 360
CancelForwardCall . . . . . . . . . . 359, 360
ChangeBusyState. . . . . . . . . . . . . 361
ChangeNotReadyState . . . . . . . . 358, 359
ConferenceComplete . . . . . . . . . . . 355
ConferenceInit . . . . . . . . . . . . . . 354
ConferenceSStep . . . . . . . . . . . . . 353
DeleteFromConference . . . . . . . . . . 355
DeleteUserData . . . . . . . . . . . . . . 363
ForwardCall . . . . . . . . . . . . . . . . 359
HoldCall . . . . . . . . . . . . . . . . . . 350
LogIn . . . . . . . . . . . . . . . . . . . 356
LogOut . . . . . . . . . . . . . . . . 356, 357
MakeCall . . . . . . . . . . . . . . . . . 352
Monitor Next Call . . . . . . . . . . . 367, 368
NotReady . . . . . . . . . . . . . . . . . 358
QueryAddress. . . . . . . . . . . . . . . 365
Ready . . . . . . . . . . . . . . . . . . . 357
ReconnectCall . . . . . . . . . . . . . . 350
ReleaseCall . . . . . . . . . . . . . . 347, 351
ResumeCall . . . . . . . . . . . . . . . . 351
ResumeInactiveCall. . . . . . . . . . . . 351
Send DTMF . . . . . . . . . . . . . . 366, 367
SendUserEvent . . . . . . . . . . . . 362, 363
SendUserEventOnCommDN . . . . . . . 366
SetActiveCall . . . . . . . . . . . . . . . 359
SetActiveCampaign . . . . . . . . . . . . 369
Index
SetBusy . . . . . . . . . . . . . . . . . . 360
ToggleForward. . . . . . . . . . . . . . . 360
TransferComplete . . . . . . . . . . . . . 350
TransferInit . . . . . . . . . . . . . .349, 350
TransferMute . . . . . . . . . . . . .348, 349
UpdateUserData. . . . . . . . . . . . . . 363
DN types, defining . . . . . . . . . . . 263, 449
dnfolders section
Configuration Synchronization . . . . . . . 76
document
audience. . . . . . . . . . . . . . . . . . . 24
change history . . . . . . . . . . . . . . . . 25
conventions . . . . . . . . . . . . . . . . 651
errors, commenting on . . . . . . . . . . . 24
version number . . . . . . . . . . . . . . 651
DoNotCall, setting . . . . . . . . . . . . . . 223
driver parameters, Voice Component . . . . 311
E
EAI Server Component Group status
Campaign Synchronization component . . 147
EAI Server Component Group, status . . . . 96
eServices. . . . . . . . . . . . . . . . . . . 24
Expert Contact . . . . . . . . . . . . . . . . 29
F
Field object, creating
Campaign Synchronization Component
. . . . . . . . . . . . . . . . . . .123, 166
font styles
italic . . . . . . . . . . . . . . . . . . . . 651
monospace . . . . . . . . . . . . . . . . 652
Format object, copying
Campaign Synchronization Component. . 129
Campaign Synchronization component . . 172
Format object, creating
Campaign Synchronization Component
. . . . . . . . . . . . . . . . . . .127, 170
Framework . . . . . . . . . . . . . . . . .24, 29
G
GenComm_universal.def. . . . . . . . . . . 278
GenComm7_universal.def
GenCommDrv.ini
Certificate . . . . . . . . . . . . . . . . . . 62
CertificateKey . . . . . . . . . . . . . . . . 63
CheckServiceTimeout . . . . . . . . . . . . 58
ClientConnectionPerServer . . . . . . . . . 58
ClientPortRangeStart . . . . . . . . . . . . 61
ConnectTimeout . . . . . . . . . . . . . . . 61
Gplus Communication Server . . . . . . . . 57
LogDir . . . . . . . . . . . . . . . . . . . . 59
LogExt . . . . . . . . . . . . . . . . . . . 60
LogFile . . . . . . . . . . . . . . . . . . . 60
LogFilesCount . . . . . . . . . . . . . . . 60
LogLevel . . . . . . . . . . . . . . . . . . 60
MaxLogKB . . . . . . . . . . . . . . . . . 61
NoDataDelay . . . . . . . . . . . . . . . . 58
ProcessingThreadPoolSize . . . . . . . . . 58
RequestTimeout . . . . . . . . . . . . . . 59
RetryAttempts . . . . . . . . . . . . . . . . 62
SiebelAPI . . . . . . . . . . . . . . . . . . 59
TrustedCA. . . . . . . . . . . . . . . . . . 63
General tab
Campaign Synchronization Component
. . . . . . . . . . . . . . . . . . . 109, 158
Genesys
Configuration Synchronization Component
. . . . . . . . . . . . . . . . . . . . 68, 75
Framework . . . . . . . . . . . . . . . . . 29
Multimedia . . . . . . . . . . . . . . . . . 29
multimedia component . . . . . . . . . . . 29
Outbound Contact . . . . . . . . . . . . . 29
Genesys Chat . . . . . . . . . . . . . . . . . 29
Genesys CTI-Less T-Server . . . . . . . . . . 29
Genesys E-mail . . . . . . . . . . . . . . . . 29
Genesys products . . . . . . . . . . . . . . . 29
Genesys project . . . . . . . . . . . . . . . 243
Genesys section
Campaign Synchronization Component . 116
Gplus Adapter for Siebel
deployment options . . . . . . . . . . . . . 27
Gplus Communication Server
configuration . . . . . . . . . . . . . . 41, 43
installation. . . . . . . . . . . . . . . . 41, 43
Gplus Open Media Server . . . . . . . . . . 490
GplusMediaRouteiWD
method
cancelTaskByCaptureId . . . . . . . . 550
completeTaskByCaptureId . . . . . . 553
createTask. . . . . . . . . . . . . . . 540
getTaskByCaptureId. . . . . . . . . . 556
holdTaskByCaptureId . . . . . . . . . 557
ping . . . . . . . . . . . . . . . . . . 560
restartTaskByCaptureId . . . . . . . . 547
resumeTaskByCaptureId . . . . . . . 561
updateTaskByCaptureId. . . . . . . . 544
GplusMediaRouting-ProcessMessage
Business Process . . . . . . . . . . 514
GSW_ATTEMPTS attribute . . . . . . . . . 223
I
import
Application template . . . . . . . . . . . 491
inbound voice configuration . . . . . . . . . 268
655
Index
installation
Gplus Communication Server . . . . . . . . 41
Gplus iWD Routing Component . . . . . . 531
Open Media Server . . . . . . . . . . . . 500
intended audience . . . . . . . . . . . . . . 24
italics . . . . . . . . . . . . . . . . . . . . . 651
iWD Routing . . . . . . . . . . . . . . . . . 29
L
log section
Configuration Synchronization Component
. . . . . . . . . . . . . . . . . . . . . . 79
M
Media Routing . . . . . . . . . . . . . . . . 29
Media Routing Component
. . . . . . . 487, 488, 489, 506, 510, 531
uninstallation . . . . . . . . . . . . . . . 636
migrating
definition file . . . . . . . . . . . . . . . . . 32
migration . . . . . . . . . . . . . . . . . . . 32
monospace font . . . . . . . . . . . . . . . 652
multimedia . . . . . . . . . . . . . . . . . . 29
Multimedia Component
uninstallation . . . . . . . . . . . . . . . 639
multi-tenant environment
. . 84, 110, 120, 121, 123, 127, 129, 158,
163, 166, 170, 172
N
Network Attended Transfer. . . . . . . . . . 286
Network Transfer Optional Automatic
Reconnection . . . . . . . . . . . . 289
new person
Configuration Synchronization . . . . . . . 83
O
open-media-drive section
Gplus Communication Server . . . 53, 161, 162
OpenMediaOcsCallCompletionStats . . . . . 472
OpenMediaOcsRecordCancel . . . . . . . . 474
OpenMediaOcsRecordCancelAck . . . 483, 484
OpenMediaOcsRecordDoNotCall . . . . . . 475
OpenMediaOcsRecordDoNotCallAck . . . . 483
OpenMediaOcsRecordProcessed . . . . . . 473
OpenMediaOcsRecordProcessedAck . . . . 484
OpenMediaOcsRecordReject . . . . . . . . 473
OpenMediaOcsRecordRejectAck . . . 484, 485
OpenMediaOcsRecordReqst. . . . . . . . . 476
OpenMediaOcsRecordReschedule . . . . . 474
656
open-media-userdata section
Gplus Communication Server. . . . . . . . 54
options
AgentLogoutControl. . . . . . . . . . . . 292
system requirements . . . . . . . . . . . . 29
Options tab
Campaign Synchronization Component
. . . . . . . . . . . . . . . . . . . 111, 160
options, Campaign Synchronization Component
format . . . . . . . . . . . . . . . . . . . 116
synchsummary . . . . . . . . . . . . . . 118
options, Communication Server
internal-port . . . . . . . . . . . . 53, 161, 162
ProcessingThreadPoolSize . . . . . . . . . 54
RequestTimeout . . . . . . . . . . . . . . 55
service-duplicate-overwrite . . . . . . . . . 54
ServiceInactivityTimeout . . . . . . . . . . 55
ThirdPartyId . . . . . . . . . . . . . . . . . 54
Outbound Campaign. . . . . . . . . . . . . . 29
device event . . . . . . . . . . . . . . . 482
Outbound Campaign feature. . . . . . . . . 270
Cancel command attributes . . . . . . . . 296
DoNotCall command attributes . . . . . . 294
Siebel Repository File, compiling . . . . . 242
Siebel Repository File, deploying . . . . . 244
telesets, creating . . . . . . . . . . . . . 263
Outbound Contact . . . . . . . . . . . . . 24, 29
device command
OpenMediaOcsCallCompletionStats . 472
OpenMediaOcsRecordCancel. . . . . 474
OpenMediaOcsRecordDoNotCall . . . 475
OpenMediaOcsRecordProcessed . . . 473
OpenMediaOcsRecordReject . . . . . 473
OpenMediaOcsRecordReqst . . . . . 476
OpenMediaOcsRecordReschedule . . 474
device events
OpenMediaOcsRecordCancelAck
. . . . . . . . . . . . . . . . 483, 484
OpenMediaOcsRecordDoNotCallAck
. . . . . . . . . . . . . . . . . . . 483
OpenMediaOcsRecordProcessedAck
. . . . . . . . . . . . . . . . . . . 484
OpenMediaOcsRecordRejectAck
. . . . . . . . . . . . . . . . 484, 485
Outbound Contact Multiple Campaigns Agents
. . . . . . . . . . . . . . . . . . . 301
overview . . . . . . . . . . . . . . . . . . . 490
P
parameters, GenCommDrv.ini
Certificate . . . . . . . . . . . . . . . . . . 62
CertificateKey . . . . . . . . . . . . . . . . 63
CheckServiceTimeout. . . . . . . . . . . . 58
Index
ClientConnectionPerServer . . . . . . . . . 58
ClientPortRangeStart . . . . . . . . . . . . 61
ConnectTimeout . . . . . . . . . . . . . . . 61
LogDir . . . . . . . . . . . . . . . . . . . . 59
LogExt . . . . . . . . . . . . . . . . . . . . 60
LogFile. . . . . . . . . . . . . . . . . . . . 60
LogFilesCount . . . . . . . . . . . . . . . . 60
LogLevel. . . . . . . . . . . . . . . . . . . 60
MaxLogKB. . . . . . . . . . . . . . . . . . 61
NoDataDelay . . . . . . . . . . . . . . . . 58
ProcessingThreadPoolSize . . . . . . . . . 58
RequestTimeout . . . . . . . . . . . . . . . 59
RetryAttempts . . . . . . . . . . . . . . . . 62
SiebelAPI . . . . . . . . . . . . . . . . . . 59
TrustedCA . . . . . . . . . . . . . . . . . . 63
parameters, Voice Component
AccessNumber . . . . . . . . . . . . . . 344
AgentID . . . . . . . . . . . . . . . . . . 344
All others . . . . . . . . . . . . . . . . . 344
ANI . . . . . . . . . . . . . . . . . . . . 343
AttributeExtensions . . . . . . . . . . . . 279
CallState. . . . . . . . . . . . . . . . . . 344
CallType . . . . . . . . . . . . . . . . . . 343
CollectedDigits . . . . . . . . . . . . . . 344
ConnID . . . . . . . . . . . . . . . . . . 343
CustomerID . . . . . . . . . . . . . . . . 344
DNIS. . . . . . . . . . . . . . . . . . . . 343
Driver:AdapterAppName . . . . . . . . . 311
Driver:AnswerCallDelay . . . . . . . . . . 311
Driver:BackupGenCommServerURL . . . 311
Driver:BackupServerHost . . . . . . . . . 312
Driver:BackupServerPort . . . . . . . . . 312
Driver:BroadcastCommdnUserEvents2Agents
. . . . . . . . . . . . . . . . . . . . . 312
Driver:CommunicationDN . . . . . . . . . 312
Driver:HangupOnEventReleased . . . . . 312
Driver:InboundPartyContainer. . . . . . . 312
Driver:LibraryName . . . . . . . . . . . . 313
Driver:LocalConnString . . . . . . . . . . 313
Driver:NtwkReconnectTimeout . . . . . . 313
Driver:OutboundPartyContainer . . . . . . 313
Driver:PrimaryGenCommServerURL . . . 313
Driver:ReconnectTimeout . . . . . . . . . 313
Driver:ServerHost . . . . . . . . . . . . . 314
Driver:ServerPort . . . . . . . . . . . . . 314
Driver:SupervisorExtensions . . . . . . . 314
Driver:SwitchType . . . . . . . . . . .314, 315
Driver:TServerAppName . . . . . . . . . 315
ErrorCode . . . . . . . . . . . . . . . . . 343
ErrorMessage . . . . . . . . . . . . . . . 343
HomeLocation . . . . . . . . . . . . . . . 344
MediaType. . . . . . . . . . . . . . . . . 344
Name . . . . . . . . . . . . . . . . . . . 315
OtherDN . . . . . . . . . . . . . . . . . . 343
Place . . . . . . . . . . . . . . . . . . . 344
PreviousConnID . . . . . . . . . . . . . . 343
ReferenceID . . . . . . . . . . . . . . . 344
Server Version . . . . . . . . . . . . . . 344
Service:ACCDNList . . . . . . . . . . . . 315
Service:AgentId . . . . . . . . . . . . . . 316
Service:AgentLogOutControl . . . . . . . 316
Service:AgentPreviewModeStart . . . . . 316
Service:AgentSubstitute . . . . . . . . . 316
Service:AgentWorkMode . . . . . . . . . 316
Service:AutoLogout . . . . . . . . . . . . 317
Service:AutoRejectRecords. . . . . . . . 317
Service:DNList . . . . . . . . . . . . . . 317
Service:HasAgentBusy . . . . . . . . . . 319
Service:HasAnswer . . . . . . . . . . . . 319
Service:HasDisconnect . . . . . . . . . . 319
Service:HasForward . . . . . . . . . . . 319
Service:HasHold . . . . . . . . . . . . . 319
Service:HasKWProtocol . . . . . . . . . 320
Service:HasOCSProtocol . . . . . . . . . 320
Service:NetworkCallTransferMode . . . . 320
Service:OCSCallBackType . . . . . . . . 321
Service:OCSCancelScope . . . . . . . . 321
Service:OCSDoNotCallScope . . . . . . 321
Service:OCSEnableCustomerId . . . . . 321
Service:OCSTreatement . . . . . . . . . 321
Service:ReleaseCallOnAutoLogout . . . . 322
Service:ReleaseEstablishedCallOnAutoLogout
. . . . . . . . . . . . . . . . . . . . . 322
Service:RequestTimeOut . . . . . . . . . 322
Service:SelectDN . . . . . . . . . . . . . 323
ThirdPartyDN . . . . . . . . . . . . . . . 343
ThisDN . . . . . . . . . . . . . . . . . . 343
ThisDNRole . . . . . . . . . . . . . . . . 344
ThisQueue . . . . . . . . . . . . . . . . 344
ThisTrunk . . . . . . . . . . . . . . . . . 344
WorkMode . . . . . . . . . . . . . . . . 344
password
configuration options . . . . . . . . . . . . 77
Person, adding
Configuration Synchronization Component
. . . . . . . . . . . . . . . . . . . . . . 84
Person, creating new . . . . . . . . . 120, 163
Campaign Synchronization Component
. . . . . . . . . . . . . . . . . . . 120, 163
Configuration Synchronization Component
. . . . . . . . . . . . . . . . . 84, 120, 163
personfolders section
Configuration Synchronization Component . 79
placefolders section
Configuration Synchronization Component . 80
planning
Gplus Communication Server. . . . . . . . 42
properties
Gplus Communication Server. . . . . . . . 46
pulling
Siebel eMail interactions . . . . . . . . . 521
657
Index
R
Removing List of Values . . . . . . . . . . . 641
Removing Outbound Web Service Definition
. . . . . . . . . . . . . . . . . . . . 643
Removing Responsibilities and View Definitions
. . . . . . . . . . . . . . . . . . . . 642
Removing Siebel Objects . . . . . . . . . . 639
S
sections, Campaign Synchronization Component
CallingListFolders . . . . . . . . . . . . . 113
CampaignFolders . . . . . . . . . . . . . 114
DatabaseAccessPoints . . . . . . . . . . 115
Genesys . . . . . . . . . . . . . . . . . . 116
TableAccessFolders . . . . . . . . . . . . 118
Tenants . . . . . . . . . . . . . . . . . . 119
security settings
Campaign Synchronization Component
. . . . . . . . . . . . . . . . . . .120, 162
Configuration Synchronization . . . . . . . 83
Configuration Synchronization Component . 83
See definition file . . . . . . . . . . . . . . . 310
SendUserEventOnCommDN. . . . . . . . . 278
server database
tables, creating new . . . . . . . . . . . . 243
Server Info tab
Campaign Synchronization Component
. . . . . . . . . . . . . . . . . . .110, 159
ServerURL
configuration options . . . . . . . . . . . . 77
Siebel
Call Center . . . . . . . . . . . . . . . . . 29
Gplus Communication Server . . . . . . . . 64
Marketing . . . . . . . . . . . . . . . . . . 29
Siebel Call Center application . . . . . . . . 35
Siebel eMail interactions
pulling/stopping . . . . . . . . . . . . . . 521
Siebel Repository File, compiling
Outbound Campaign feature . . . . . . . 242
Siebel Repository File, deploying
Campaign Synchronization Component. . 146
Outbound Campaign feature . . . . . . . 244
Siebel Tools, configuring
Configuration Synchronization Component
. . . . . . . . . . . . . . 89, 135, 177, 501
Siebel Web Client . . . . . . . . . . . . . . 95
Campaign Synchronization Component,
configuring. . . . . . . . . . . 147, 203, 245
skillfolders section
Configuration Synchronization . . . . . . . 81
skilllevels section
Configuration Synchronization . . . . . . . 82
SkipSkillItemTypeName
configuration options . . . . . . . . . . . . 78
658
T
tables
creating new . . . . . . . . . . . . . . . 243
Genesys project on server database . . . 243
telesets, creating
Outbound Campaign feature . . . . . . . 263
tenants section
Configuration Synchronization . . . . . . . 83
Tenants tab
Campaign Synchronization Component
. . . . . . . . . . . . . . . . . . . 110, 158
Configuration Synchronization Component . 69
transfers
agents not in campaign . . . . . . . . . . 274
agent-to-agent . . . . . . . . . . . . . . 273
type styles
conventions . . . . . . . . . . . . . . . . 651
italic . . . . . . . . . . . . . . . . . . . . 651
monospace . . . . . . . . . . . . . . . . 652
typographical styles . . . . . . . . . . . . . 651
U
UCS Gateway . . . . . . . . . . . . . . . . . 29
Universal Callback . . . . . . . . . . . . . . . 29
Universal Callback configuration. . . . . . . 266
Universal Callback server . . . . . . . . . . . 29
Universal Routing . . . . . . . . . . . . . . . 24
Updating Siebel Configuration . . . . . . . . 640
upgrading . . . . . . . . . . . . . . . . . . . 32
definition file. . . . . . . . . . . . . . . . . 32
username
configuration options . . . . . . . . . . . . 78
UseSeparatorsForSkillName
configuration options . . . . . . . . . . . . 78
V
version numbering, document . . . . . . . . 651
Voice . . . . . . . . . . . . . . . . . . . . . 355
Index
Voice Component
definition . . . . . . . . . . . . . . . . . . 210
Driver Commands . . . . . . . . . . . . . 333
driver parameters . . . . . . . . . . . . . 311
inbound voice configuration
. . . . . . . . . . . 219, 225, 226, 251, 268
inbound voice configuration device events 382
OCS device events . . . . . . . . . . . . 392
Outbound Campaign feature . . 220, 226, 270
device commands . . . . . . . . . . . 370
outbound campaign feature device events 392
parameters . . . . . . . . . . . . . . . . 343
uninstallation . . . . . . . . . . . . . . . 609
Voice Component, device commands
AlternateCall. . . . . . . . . . . . . . . . 366
AnswerCall . . . . . . . . . . . . . . . . 347
AttachData. . . . . . . . . . . . . . . . . 361
Cancel Monitoring . . . . . . . . . . .368, 369
CancelBusy . . . . . . . . . . . . . . . . 360
CancelForwardCall . . . . . . . . . .359, 360
ChangeBusyState . . . . . . . . . . . . . 361
ChangeNotReadyState . . . . . . . .358, 359
ConferenceComplete . . . . . . . . . . . 355
ConferenceInit . . . . . . . . . . . . . . . 354
ConferenceSStep . . . . . . . . . . . . . 353
DeleteFromConference . . . . . . . . . . 355
DeleteUserData . . . . . . . . . . . . . . 363
ForwardCall . . . . . . . . . . . . . . . . 359
HoldCall . . . . . . . . . . . . . . . . . . 350
LogIn . . . . . . . . . . . . . . . . . . . 356
LogOut. . . . . . . . . . . . . . . . .356, 357
MakeCall . . . . . . . . . . . . . . . . . 352
Monitor Next Call . . . . . . . . . . .367, 368
NotReady . . . . . . . . . . . . . . . . . 358
QueryAddress . . . . . . . . . . . . . . . 365
Ready . . . . . . . . . . . . . . . . . . . 357
ReconnectCall . . . . . . . . . . . . . . . 350
ReleaseCall . . . . . . . . . . . . . .347, 351
ResumeCall . . . . . . . . . . . . . . . . 351
ResumeInactiveCall . . . . . . . . . . . . 351
Send DTMF . . . . . . . . . . . . . .366, 367
SendUserEvent . . . . . . . . . . . .362, 363
SendUserEventOnCommDN . . . . . . . 366
SetActiveCall . . . . . . . . . . . . . . . 359
SetActiveCampaign . . . . . . . . . . . . 369
SetBusy . . . . . . . . . . . . . . . . . . 360
ToggleForward. . . . . . . . . . . . . . . 360
TransferComplete . . . . . . . . . . . . . 350
TransferInit . . . . . . . . . . . . . .349, 350
TransferMute . . . . . . . . . . . . .348, 349
UpdateUserData. . . . . . . . . . . . . . 363
Voice Component, device events
EventAgentBusy. . . . . . . . . . . . . . 386
EventAgentLogin . . . . . . . . . . . . . 387
EventAgentLogout. . . . . . . . . . . . . 387
EventAgentNotBusy . . . . . . . . . . . . 387
EventAgentNotReady . . . . . . . . . . . 388
EventAgentReady. . . . . . . . . . . . . 388
EventCallForwardCancel . . . . . . . . . 386
EventCallForwardSet . . . . . . . . . . . 386
EventDialing . . . . . . . . . . . . . . . 383
EventError . . . . . . . . . . . . . . . . 389
EventEstablished . . . . . . . . . . . . . 383
EventHeld . . . . . . . . . . . . . . . . . 384
EventPartyAdded . . . . . . . . . . . . . 390
EventPartyChanged . . . . . . . . . . . 390
EventPartyDeleted . . . . . . . . . . 390, 391
EventRegistered . . . . . . . . . . . . . 385
EventReleased . . . . . . . . . . . . . . 384
EventRetrieved . . . . . . . . . . . . . . 384
EventRinging . . . . . . . . . . . . . . . 383
EventServerConnected . . . . . . . . . . 388
EventServerDisconnected . . . . . . . . 389
EventUnregistered . . . . . . . . . . . . 385
EventUserDataChanged . . . . . . . . . 385
EventUserEvent. . . . . . . . . . . . . . 389
Voice Component, options
nrdy-after-login . . . . . . . . . . . . . . 275
Voice Component, parameters
AccessNumber . . . . . . . . . . . . . . 344
AgentID . . . . . . . . . . . . . . . . . . 344
All others . . . . . . . . . . . . . . . . . 344
ANI . . . . . . . . . . . . . . . . . . . . 343
AttributeExtensions . . . . . . . . . . . . 279
CallState . . . . . . . . . . . . . . . . . 344
CallType. . . . . . . . . . . . . . . . . . 343
CollectedDigits . . . . . . . . . . . . . . 344
ConnID . . . . . . . . . . . . . . . . . . 343
CustomerID . . . . . . . . . . . . . . . . 344
DNIS . . . . . . . . . . . . . . . . . . . 343
Driver: prefix, defined . . . . . . . . . . . 311
Driver:AdapterAppName . . . . . . . . . 311
Driver:AnswerCallDelay. . . . . . . . . . 311
Driver:BackupGenCommServerURL . . . 311
Driver:BackupServerHost . . . . . . . . . 312
Driver:BackupServerPort . . . . . . . . . 312
Driver:BroadcastCommdnUserEvents2Agents
. . . . . . . . . . . . . . . . . . . . . 312
Driver:CommunicationDN . . . . . . . . . 312
Driver:HangupOnEventReleased . . . . . 312
Driver:InboundPartyContainer . . . . . . 312
Driver:LibraryName . . . . . . . . . . . . 313
Driver:LocalConnString . . . . . . . . . . 313
Driver:NtwkReconnectTimeout . . . . . . 313
Driver:OutboundPartyContainer . . . . . 313
Driver:PrimaryGenCommServerURL . . . 313
Driver:ReconnectTimeout . . . . . . . . . 313
Driver:ServerHost . . . . . . . . . . . . . 314
Driver:ServerPort . . . . . . . . . . . . . 314
Driver:SupervisorExtensions . . . . . . . 314
Driver:SwitchType. . . . . . . . . . . 314, 315
Driver:TServerAppName . . . . . . . . . 315
659
Index
ErrorCode . . . . . . . . . . . . . . . . . 343
ErrorMessage . . . . . . . . . . . . . . . 343
HomeLocation . . . . . . . . . . . . . . . 344
MediaType. . . . . . . . . . . . . . . . . 344
Name . . . . . . . . . . . . . . . . . . . 315
OtherDN . . . . . . . . . . . . . . . . . . 343
Place . . . . . . . . . . . . . . . . . . . 344
PreviousConnID . . . . . . . . . . . . . . 343
ReferenceID . . . . . . . . . . . . . . . . 344
Server Version. . . . . . . . . . . . . . . 344
Service: prefix, defined . . . . . . . . . . 311
Service:ACCDNList . . . . . . . . . . . . 315
Service:AgentId . . . . . . . . . . . . . . 316
Service:AgentLogOutControl . . . . . . . 316
Service:AgentPreviewModeStart . . . . . 316
Service:AgentSubstitute . . . . . . . . . . 316
Service:AgentWorkMode . . . . . . . . . 316
Service:AutoLogout . . . . . . . . . . . . 317
Service:AutoRejectRecords . . . . . . . . 317
Service:DNList. . . . . . . . . . . . . . . 317
Service:HasAgentBusy . . . . . . . . . . 319
Service:HasAnswer . . . . . . . . . . . . 319
Service:HasDisconnect . . . . . . . . . . 319
Service:HasForward. . . . . . . . . . . . 319
Service:HasHold. . . . . . . . . . . . . . 319
Service:HasKWProtocol . . . . . . . . . . 320
Service:HasOCSProtocol . . . . . . . . . 320
Service:NetworkCallTransferMode . . . . 320
Service:OCSCallBackType . . . . . . . . 321
Service:OCSCancelScope . . . . . . . . 321
Service:OCSDoNotCallScope . . . . . . . 321
Service:OCSEnableCustomerId. . . . . . 321
Service:OCSTreatment . . . . . . . . . . 321
Service:ReleaseCallOnAutoLogout . . . . 322
Service:ReleaseEstablishedCallOnAutoLogout
. . . . . . . . . . . . . . . . . . . . . 322
Service:RequestTimeOut . . . . . . . . . 322
Service:SelectDN . . . . . . . . . . . . . 323
ThirdPartyDN . . . . . . . . . . . . . . . 343
ThisDN . . . . . . . . . . . . . . . . . . 343
ThisDNRole . . . . . . . . . . . . . . . . 344
ThisQueue. . . . . . . . . . . . . . . . . 344
ThisTrunk . . . . . . . . . . . . . . . . . 344
WorkMode . . . . . . . . . . . . . . . . . 344
voice section
Gplus Communication Server . . . . . . . . 56
X
xslTransformer
configuration options . . . . . . . . . . . . 79
W
Windows, installation
Campaign Synchronization Component
. . . . . . 86, 131, 174, 423, 430, 489, 532
Configuration Synchronization Component
. . . . . . . . . . . . 86, 87, 214, 423, 424
660