Chat
Chat
Chat Guide
January 2020
Siebel
Chat Guide
January 2020
This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected
by intellectual property laws. Except as expressly permied in your license agreement or allowed by law, you may not use, copy, reproduce, translate,
broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display in any part, in any form, or by any means. Reverse engineering,
disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.
The information contained herein is subject to change without notice and is not warranted to be error-free. If you nd any errors, please report
them to us in writing.
If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the
following notice is applicable:
U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware,
and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition
Regulation and agency-specic supplemental regulations. As such, use, duplication, disclosure, modication, and adaptation of the programs,
including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license
terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.
This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for
use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware
in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe
use. Oracle Corporation and its aliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.
Oracle and Java are registered trademarks of Oracle Corporation and/or its aliates. Other names may be trademarks of their respective owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or
registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks
of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.
This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle
Corporation and its aliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and
services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its aliates will not be responsible
for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable
agreement between you and Oracle.
The business names used in this documentation are ctitious, and are not intended to identify any real companies currently or previously in existence.
Siebel
Chat Guide
Contents
Preface .................................................................................................................................. i
Preface
This preface introduces information sources that can help you use the application and this guide.
Documentation Accessibility
For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website.
Contacting Oracle
Access to Oracle Support
Oracle customers that have purchased support have access to electronic support through My Oracle Support. For
information, visit My Oracle Support or visit Accessible Oracle Support if you are hearing impaired.
i
Siebel Preface
Chat Guide
ii
Siebel Chapter 1
Chat Guide What's New in This Release
No new features have been added to this guide for this release. This guide has been updated to reect only product
name changes.
No new features have been added to this guide for this release. This guide has been updated to reect only product
name changes.
1
Siebel Chapter 1
Chat Guide What's New in This Release
2
Siebel Chapter 2
Chat Guide Overview of Siebel Chat
Siebel Chat is a Web-based application for handling secure chat communications, including the following:
• Handling Siebel Chat interactions using chat-related buons on the communications toolbar of the Siebel Call
Center application.
• Conducting Siebel Chat conversations with a customer by using frequently used text, the URL library, smart
share, and by searching the knowledge base and sharing resolutions.
• Creating activities and service requests from Siebel Chat interactions.
• Transferring Siebel Chat interactions to workgroups and agents.
• Terminating Siebel Chat sessions.
Note: The procedures in this guide assume that you do not use the Tree navigation control option to
access screens and views. However, you can choose to use the Tree navigation control if required. For more
information about seing navigation options, see Siebel Fundamentals for Siebel Open UI.
No programming experience is required to set up and use Siebel Chat. However, basic Siebel application navigation
knowledge is required to eectively use the Siebel Chat client. Some planning and information gathering are necessary
to set up your Siebel Chat application and have it running quickly and smoothly.
3
Siebel Chapter 2
Chat Guide Overview of Siebel Chat
• Communications Toolbar Enhancements. Using the communications toolbar, agents can sign in to Siebel Chat
and make themselves available for incoming chat requests, put chats on hold, transfer chats, release chat
sessions, and close chat interactions.
• Customer Dashboard Enhancement. The customer dashboard alerts the agent if a customer requesting a chat
provides prole information that does not match the contact record.
• Siebel Chat Interaction Tracking. Every incoming chat interaction is tracked as an Activity under either a Contact
or Service Request record. The chat transcript is also aached to the Activity record.
• Workspace Persistence. During multiple simultaneous Siebel Chat sessions where the agent can switch between
chat sessions, the application holds the context for each customer. In addition, the customer dashboard persists
with the chat session.
• Agent Anonymity. This feature enables agents to have an alias (or use a dierent rst name).
• Anonymous Chat. This feature allows a customer to chat with an agent anonymously.
• Smart Knowledge Management Integration. Siebel Chat is integrated with Oracle’s Siebel Knowledge Base
system (such as, solutions). The customer-facing application (for example, any self-service Web application)
remembers the knowledge base articles that the customer reviews and uses this information when suggesting
further articles (Have you tried this?) to review. The knowledge base visited (KB Visited) feature, available in
the Siebel Chat dashboard, allows the agent to view the list of knowledge base articles that the customer has
already viewed.
• Quick Actions. Agents can perform popular actions quickly (for example, create and view service requests,
view activities and contacts) by selecting them from the Action drop-down menu in the Siebel Chat dashboard.
Actions performed this way are contextual and smart.
4
Siebel Chapter 2
Chat Guide Overview of Siebel Chat
Other Features
Other features available for Siebel Chat include the following:
• Business Intelligence. Supervisors and agents can use Oracle Business Intelligence (formerly known as Siebel
Business Analytics), if installed, against the Siebel Chat data.
• Third-Party Chat Integration. Siebel Chat can be fully integrated with the communications technology of a
third-party chat solution.
5
Siebel Chapter 2
Chat Guide Overview of Siebel Chat
Agent-facing interactions are conducted using the Siebel Chat application that is embedded inside the Siebel Call
Center application. The agent-facing Siebel Chat interface is the means through which an agent accepts and conducts a
chat conversation with a customer. Through the agent-facing Siebel Chat interface, the agent can send and receive text,
push URLs to, and select frequently used text to send to the customer.
For more information about the chat process ows for the customer and the agent, see the following:
• Agent-Facing Chat Process Flow describes a typical chat process ow for an agent.
• Customer-Facing Chat Process Flow describes a typical chat process ow for a customer.
6
Siebel Chapter 2
Chat Guide Overview of Siebel Chat
The steps involved in a typical agent-facing chat process ow, shown in this image, are as follows:
1. The agent logs in to the Siebel Call Center application.
2. The agent logs in to Siebel Chat by clicking the Log in buon on the communications toolbar.
To use Siebel Chat, agents must be set up for the application, as follows:
a. A user account must be set up for each agent in the third-party chat server.
For information about seing up user accounts for agents, see the documentation provided by the third-
party chat vendor.
b. Each agent must be added to at least one chat communications conguration.
For more information, see Conguring Communications in Siebel Call Center for Siebel Chat and Adding
Agents to the Communications Conguration for Siebel Chat. For information about conguring agents
after an agent has been added to a communications conguration, see Siebel CTI Administration Guide .
3. The agent clicks the ashing Accept Work Item buon on the communications toolbar to accept an incoming
chat request.
For more information about accepting a chat, see Accepting an Incoming Chat.
4. Siebel Call Center aempts to identify the customer requesting a chat using the information provided on the
chat request form.
The information on the chat request form determines whether an activity event or a service request is created,
and consequently the application view that the agent is directed to in the Siebel Call Center application. For
example, if the customer provides only a Contact ID on the chat request form, then the agent is directed to the
Contact screen in Siebel Call Center. However, if the customer provides a valid Service Request ID that Siebel
Call Center can identify, then the agent is directed to the Service Requests screen in Siebel Call Center. For more
information about how Siebel Call Center identies the customer requesting a chat, see Chat Standard Accept
Process Workow.
5. The agent is directed to an appropriate application view in Siebel Call Center and engages in a chat
conversation with the customer.
For more information about how an agent handles a chat, review the following:
7
Siebel Chapter 2
Chat Guide Overview of Siebel Chat
6. The agent releases the chat session, see Releasing Chat Sessions.
1. Prole information. The rst name, last name, phone number, and email address information is prepopulated if
the user is logged in to the self-service Web application.
2. Service request information. The service request number, product name, problem summary, and problem
description information is prepopulated if the chat is requested from a Service Request Detail page.
8
Siebel Chapter 2
Chat Guide Overview of Siebel Chat
The steps involved in a typical customer-facing chat process ow, shown in this image, are as follows:
1. A customer, looking for an answer to a problem, requests a chat with an agent from any non-Siebel self-service
Web application.
The customer can request a chat as an anonymous user, or can log in to the self-service Web application rst
and then request a chat (for example, as a follow up to a service request). In both cases, the customer can do
one of the following to request a chat:
◦ Click Contact Us, then Chat (or navigate to Support, Contact Us, and then Chat).
◦ Click the Chat with a Live Agent shortcut in the Need more Help? frame.
2. The customer lls out the chat request form by entering personal information (name or user ID, email
address, address), product type details (product name or product category), problem summary, problem
description, then clicks Submit and waits in the queue. For identied customers, the self-service Web
application prepopulates as many of these values as possible. An example chat request form is shown in the
image in Chat Request Form.
3. Using the information on the chat request form as search parameters, the self-service Web application executes
a search against the Oracle Knowledge Base, and returns a list of suggested knowledge base articles and
solutions for the customer to review.
Customers can review these articles without losing their position in the queue.
4. If still not satised, then the customer clicks Chat and waits to be connected to an agent.
Based on conguration, pushed URLs are visible to the customer in one of the following ways:
◦ In a frame alongside the customer’s chat UI in the same browser, or
◦ In a new browser window
For more information about push URL conguration and chat project setup, see Conguring the Behavior of the
Push URL Functionality.
5. When the customer is connected to an agent, the customer engages in a chat conversation with the agent.
6. The customer releases the chat session.
If congured for Siebel Chat, then when a customer releases a chat session, the customer can:
9
Siebel Chapter 2
Chat Guide Overview of Siebel Chat
10
Siebel Chapter 3
Chat Guide Seing Up Siebel Chat
After you have installed your self-service Web application, you must set it up for Siebel Chat. For more information
about seing up Siebel Chat for non-Siebel self-service Web applications, see the documentation that accompanies that
product.
11
Siebel Chapter 3
Chat Guide Seing Up Siebel Chat
This task is a step in Roadmap for Conguring Siebel Call Center for Siebel Chat.
This task is a step in Roadmap for Conguring Siebel Call Center for Siebel Chat.
To set up agent responsibilities and views in Siebel Call Center for Siebel Chat
1. Navigate to the Administration - Application screen, then the Responsibilities view.
A list of responsibilities displays with the responsibilities tab open.
2. Click New to create a new universal agent responsibility, and complete the elds as described in the following
table.
Responsibility Enter a name for the universal agent responsibility that Universal Agent B2B+B2C
you want to create.
12
Siebel Chapter 3
Chat Guide Seing Up Siebel Chat
Organization Click the single select buon, and select the Active Systems
organization to which the responsibility belongs.
3. In the Views section of the page, click Add and add the following views to your agent responsibility:
◦ Chat View
◦ Chat Activity View
◦ Chat Language Mapping View
◦ Chat Parameter and Routing Administration View
◦ Chat Popup Base View
◦ Service Request Detail View
◦ All Service Requests List View
◦ Persistent Customer Dashboard View
◦ Contact Details View
◦ Contact Details View, Detail Tab
◦ Visible Contact List View
◦ Solution Resolution Documents View
◦ Activity Aachment View
◦ Search View
◦ Basic Search View
◦ Basic Search Results View
◦ Advanced Search View
◦ Advanced Search Results View
◦ Search Selection View
◦ Search Looking View
4. In the Users section of the page, click Add and add your chat users to the agent responsibility.
For third-party chat integrations, you must congure a custom communications driver for the third-party chat solution.
The purpose of this driver is to provide a mechanism through which chat messages are exchanged with the third-party
chat server. For more information about how to create and congure a custom driver for third-party products using the
Adaptive Communications API, see Siebel CTI Administration Guide.
This task is a step in Roadmap for Conguring Siebel Call Center for Siebel Chat.
13
Siebel Chapter 3
Chat Guide Seing Up Siebel Chat
You must use the multichannel_enhanced_chat.def le if you are using the default workow to handle incoming
chat requests. For more information, see Chat Standard Accept Process Workow.
The communication le is delivered with your Siebel Call Center software, and it denes all the conguration
details (parameters, proles, commands, event handlers) for your application. Communication les are usually
located in the following directory:
SIEBSRVR_ROOT\bin\language_code
If you cannot locate the communication le, then contact your system administrator or Oracle account support
representative.
Note: You can optionally make a copy of multichannel_enhanced_chat.def and modify it using a text
editor before importing it into your communications conguration record.
a. Navigate to the Administration - Communications screen, then the All Congurations view.
b. Click New to set up a new conguration record, enter a name for the record, enter a comment (this is
optional), then save the record by clicking Ctrl+S.
c. Import the congurations dened in the multichannel_enhanced_chat.def le:
- Select the conguration record that you created, click Import Conguration, then Next.
- On the Import Conguration window, specify the communications conguration elements to
import. Choose all of the following options: Conguration Parameters, Drivers and Proles,
Commands, and Events.
- Browse to the location of your multichannel_enhanced_chat.def le, and click OK.
When the import process is complete, the Import Conguration window closes, and the
Parameters, Proles, Commands, and Event Handlers tabs are now populated with communication
conguration information. For example, clicking the Event Handlers tab displays a list of available
chat-related event handlers (such as, ChatAccepted, ChatMessageReceived, ChatSuspended, and
so on). You can add or delete Parameters, Proles, Commands, and Event Handlers, as required.
d. Congure a driver for your company to communicate with the third-party chat server:
- Select the conguration record that you created, and click the Proles tab.
- Click the Driver name.
Note: If you want to congure a new driver to communicate with the third-party chat
server, then click New, select a communication prole from the list that is displayed, and
then click Driver name.
- On the Communications Drivers screen, use the vertical navigation buons to navigate to the
Prole Parameter Overrides section, and set the driver parameters, as required.
14
Siebel Chapter 3
Chat Guide Seing Up Siebel Chat
Note: If no prole exists for the driver, then one must be created. If one does exist, but it is
not the prole that you want to congure, then add a new prole now.
The following table briey describes some important driver parameters that can be congured. For more
information about all driver parameters that can be congured, see Siebel CTI Administration Guide.
Driver:URL Required. Set to the location of the third-party chat services, for example, as
follows:
http://east/<tp_chat_server>/services/
Driver:ProxySupport Optional. Set to script if you want to use wpad.dat to access third-party chat
services using an HTTP proxy. Set to Disabled if you do not want to use a
proxy.
Driver:ProxyScriptLocation Optional. If Driver:ProxySupport is set to script, then set this parameter to the
location of the script, for example, as follows:
http://wpad.us.oracle.com/wpad.dat
Driver:EnableSOAPTrace Optional. Set to True to log all communications between the driver and the
third-party chat server, and set to False to ignore all communications.
Driver:LogSOAPFile Optional. Specify a name for the log le, into which all messages between the
driver and the third-party chat server are wrien.
15
Siebel Chapter 3
Chat Guide Seing Up Siebel Chat
5. (Optional) If changes have been made to the conguration, driver parameters, or prole parameters, then save
the communications conguration to another le as follows:
a. Navigate to the Administration - Communications screen, then the All Congurations view.
b. Select the chat conguration record that you want to save, and click Export Conguration.
c. On the Export Conguration window, specify the communications conguration elements to export.
Choose from the following options:
- Conguration Parameters
- Drivers and Proles
- Commands
- Events
d. When prompted, save the communications conguration le to a suitable location.
6. Congure chat routing parameters.
This step involves conguring the routing for chat data, see Seing Up an Alias for Siebel Chat Users in Siebel
Call Center.
7. Congure an email prole for chat communications, see Seing Up Outbound Email Communications in Siebel
Call Center.
To add agents to the communications conguration set up in Siebel Call Center, complete the steps in the following
procedure. This task is a step in Roadmap for Conguring Siebel Call Center for Siebel Chat.
To add agents to the Siebel Chat communications conguration in Siebel Call Center
1. Navigate to the Administration - Communications screen, then the All Congurations view.
2. Select the (chat) communications conguration record for which you want to add agents, and click the Agents
tab.
3. Click New to add an agent.
4. On the Add Agents window, select or query for the agent that you want to add, and then click OK.
5. Specify the Agent Login and Password that the agent must use to log in to the third-party chat server:
a. Click on the agent name to go to the Agent General Prole page.
b. Enter the Login and Password in the Agent Login and Password elds respectively.
6. Assign a teleset to each agent:
a. Click an Agent, then the Telesets tab, then New.
b. On the Add Telesets window, select or query for the teleset that you want to assign, and click OK.
For information about conguring agents after an agent has been added to a communications conguration, see Siebel
CTI Administration Guide.
16
Siebel Chapter 3
Chat Guide Seing Up Siebel Chat
This task is a step in Roadmap for Conguring Siebel Call Center for Siebel Chat.
Note: The alias value that you enter in this eld for the user must correspond to the First Name value
that is dened for the user account in the third-party chat server.
To set up predened message responses for chat in Siebel Call Center, complete the steps in the following procedure.
This task is a step in Roadmap for Conguring Siebel Call Center for Siebel Chat.
To set up a library of frequently used text templates in Siebel Call Center for Siebel
Chat
1. Navigate to the Administration - Communications screen, then the All Templates view.
2. Click New to create a FUT template and on the Simple tab, specify the following:
Field Description
Channel Type Select Chat as the channel type from the drop-down list.
17
Siebel Chapter 3
Chat Guide Seing Up Siebel Chat
Field Description
Public (Optional) Select this check box if you want the template to be made available to everyone outside
the creator’s organization.
Pick Available Substitutions Select the Chat UI substitution object from the object drop-down list if you want to use
(Optional) any of the available Chat UI data substitutions when composing your text response. The
available Chat UI data substitutions are:
◦ [Chat UI.InputText]
3. Enter the text for your template into the message input area; the subject line is not used for templates.
18
Siebel Chapter 3
Chat Guide Seing Up Siebel Chat
For information about modifying the communications toolbar, including modifying the appearance of existing toolbar
buons, and moving, adding, or removing a toolbar buon, see Siebel CTI Administration Guide .
To set up a URL library for chat in Siebel Call Center, complete the steps in the following procedure. This task is a step in
Roadmap for Conguring Siebel Call Center for Siebel Chat.
CAUTION: Ensure that URLs can be reached by users who are outside your company rewall.
a. In the File Name eld, click the single select buon to add a resolution aachment.
b. Enter the URL address (starting with hp://) of the URL that you want to share with customers.
c. Click Add.
When handling chat interactions, agents can access a list of available URLs. For more information, see Accepting an
Incoming Chat and Responding to an Incoming Chat.
If the RedoPopupInMenu command does not exist, then click New to add it, and then click Save.
4. Drill down on the RedoPopupInMenu command by clicking the RedoPopupInMenu link and congure the
command parameters as follows:
19
Siebel Chapter 3
Chat Guide Seing Up Siebel Chat
Name Value
HotKey Shift+Alt+R
Note: Make sure that the keyboard shortcut does not conict with
any keyboard shortcuts that are dened already.
MenuPosition 15
5. Navigate to WINDOWS\Downloaded Program Files, and clear the Internet Explorer cache.
6. Log in to Siebel Call Center again, and test your conguration.
Use the following procedure to set up outbound email communications in Siebel Call Center. This task is a step in
Roadmap for Conguring Siebel Call Center for Siebel Chat.
To set up outbound email communications in Siebel Call Center for Siebel Chat
1. Navigate to the User Preferences screen, then the Outbound Communications view.
2. Set up outbound communications as follows:
- Default Prole
- Default Recipient Class
20
Siebel Chapter 3
Chat Guide Seing Up Siebel Chat
- Email Client
- Siebel/Outlook Form
- Siebel/Lotus Form
- Default Message Format
Note: Default Prole must be set to the email prole that is used to send emails to users (for
example, when users release a chat session). You must set up this email prole rst. For more
information about email prole setup, see Siebel Email Administration Guide.
- Default Greeting Template: Options include Formal Greeting, and Informal Greeting.
- Default Closing Template: Options include Address Verication Closing, Formal Info Closing,
Formal Support Closing, Informal Info Closing, and Informal Support Closing.
- Default Message Format
- Include Original Message in Reply
- Remain on Same View After Send (Cancel)
c. In the Advanced Features section, set the following options, as required:
- Language
- Locale
d. Set the following system preferences as shown in Seing Up System Preferences in Siebel Call Center for
Siebel Chat:
- Chat: Default Email Template. Set this to the name of the (chat) email prole that you set up in
Siebel Call Center.
- Chat: Auto Email Mode. Set this to POPUP, SEND, or NONE.
For more information about each of these options, about seing up outbound email communications, and conguring
the Internet SMTP/POP3 server driver, see Siebel Email Administration Guide.
Note: Remove the run-time event record only. Do not remove the Action Sets record.
21
Siebel Chapter 3
Chat Guide Seing Up Siebel Chat
Now when an agent accepts a chat and starts exchanging chat messages with a customer, the chat pane and
service request view are open, and if the agent then selects F5 on the keyboard or Refresh on the browser
toolbar, the Siebel application refreshes. But after the refresh, the Siebel application remains the same, the chat
session is still connected, the chat pane and service request view are open, and the agent can continue the chat
conversation with the customer.
There are a number of system preferences that you can optionally set in Siebel Call Center for Siebel Chat. The following
procedure describes these system preferences and how to set them. This task is a step in Roadmap for Conguring
Siebel Call Center for Siebel Chat.
To set the system preferences in Siebel Call Center for Siebel Chat
1. Navigate to the Administration - Application screen, then the System Preferences view.
2. Query for *Chat* to get a list of all the chat-related system preferences that can be set up.
For each Siebel Chat system preference that you want to set up, specify the system preference name, value, and
description, as dened in the following table.
Chat: Default Email Template Note: You must dene the Name of the default email template
default email template rst, used to automatically generate the
and then specify it in this email that is sent when a user releases a
eld. For more information, chat session.
see Seing Up Outbound
Email Communications in
Siebel Call Center.
Chat: AutoCreate Service Req FALSE Flag that determines whether a service
request is created automatically when
agents accept a chat request. Valid
values are TRUE or FALSE.
Chat: Auto Email Mode SEND Determines the mode used for
automatically sending an email when
22
Siebel Chapter 3
Chat Guide Seing Up Siebel Chat
23
Siebel Chapter 3
Chat Guide Seing Up Siebel Chat
CommSessionMgr CommSessionMgr
GatewayAddress [Gateway address of the computer where CommMgmt is running : gateway port]
EnterpriseServer [Siebel]
24
Siebel Chapter 4
Chat Guide Working with Siebel Chat
You access the communications panel by clicking Communications on the menu toolbar in your client application. The
communications panel contains the following elements: a header area, the communications toolbar, the customer
dashboard, and the chat pane. Depending on the deployment of your client application, the communications panel
might not contain all of these elements.
The communications panel appears on either side of your Siebel Call Center application, depending on conguration.
The main Siebel Call Center application area appears next to the communications panel.
The communications panel, which includes the Siebel Chat pane, can appear in a docked position or as a oating pane
in your client application. You can dock or undock the panel by clicking Dock or Undock. When the communications
panel is oating (undocked), you can move and position it anywhere within the connes of the main application client
area. In addition, you can do the following:
• Control the size of the communications panel by choosing a wide or a narrow display for the panel.
• Modify the display of the communications toolbar by choosing to display more or less of the toolbar.
• Customize the appearance of the communications toolbar.
25
Siebel Chapter 4
Chat Guide Working with Siebel Chat
To do this, customers must create their own customized CSS le in which custom icons are specied and then
associate this CSS le to the application theme for which these customizations are to be enabled. For more
information about performing this type of customization, see Conguring Siebel Open UI .
• Developers can modify the display of the communications panel and its elements.
For example, by modifying the applicable style sheet, developers can modify which items appear when an
agent displays more or less of the toolbar. Or, by modifying the Siebel Web template le CCFrameContentHI in
the database, developers can modify the order of the elements within the communications panel.
• Close the communications panel by clicking Close (X).
For more information about the communications panel and the communications toolbar, see Siebel CTI Administration
Guide . For more information about the chat pane and customer dashboard, see Accessing Siebel Chat in Siebel Call
Center and About the Chat Dashboard.
Agents can engage in multiple chat sessions with many users simultaneously. If more than one chat session is open, the
chat sessions are represented by tabs in the chat pane. For more information, see Handling Multiple Simultaneous Chat
Sessions.
The following image shows the Siebel Chat interface or chat pane.
• Dashboard. The dashboard displays details about the problem that the customer is having. Agents can carry
out a number of popular actions quickly using the chat dashboard. For more information about the chat
dashboard, see About the Chat Dashboard.
26
Siebel Chapter 4
Chat Guide Working with Siebel Chat
• Transcript area. This is where agents can view the transcript of the chat conversation so far. Each part of the
chat conversation is clearly labelled with either the agent’s or the customer’s name, is dated, and time stamped.
When a chat session ends, the chat transcript is aached to an activity. For more information about accessing
chat transcripts and aachments, see Reviewing Inbound Siebel Chat Activities.
• Input text box. This text box is where an agent enters the responses to a chat request, executes a search,
and smart shares service request and solution information. For more information about these tasks, see
Responding to an Incoming Chat.
• URL area. This is where an agent can enter a Web URL to share with a customer, which is then automatically
displayed in the customer’s browser. To do this, enter the URL, and then press enter to push the URL to the
customer. This eliminates the need for the customer to manually copy and paste the URL into a browser
window. Agents can also click the URL Library buon to access a global list of predened URLs, which they can
push to customers as required. For more information about push URL, see Pushing a Web URL.
The Chat Standard Accept Process workow provides the following enhanced chat functionality to handle incoming
chat requests:
• Conguring which parameters to pass from the chat request page
• Conguring the chat accept process using Siebel Workow
• Conguring the RedoPopupInMenu command
• Siebel Chat transfer to agent and workgroup
• Siebel Chat bookmark transfer
• Siebel Chat auto answer for agents
• Conguring the display name for Siebel Chat sessions
For more information about how to congure and set up this enhanced chat functionality, see the following:
• Conguring Siebel Chat Auto Answer
27
Siebel Chapter 4
Chat Guide Working with Siebel Chat
1. When an agent accepts a chat, the chat UI business service does one of the following:
28
Siebel Chapter 4
Chat Guide Working with Siebel Chat
◦ Identies the account or contact if the customer provides a valid contact name or user ID and account
name, then it creates a new service request.
2. The chat UI business service opens the chat pane.
3. The chat UI business service directs the agent to the appropriate view (service request detail view or bookmark
view) in the Siebel Call Center application, and the chat display name is updated accordingly in the chat pane.
For example:
◦ If bookmark is enabled, then the customer dashboard is updated, the bookmarked view opens, and the
chat display name is updated in the chat pane.
◦ If bookmark is disabled, then the customer dashboard updates, the service request detail view opens,
and the chat display name updates accordingly in the chat pane.
The tables in this topic summarize the default workow for accepting Siebel Chat requests by describing what happens
in Siebel Call Center when various conditions are met (or not, as the case might be). Depending on the information
that the customer provides on the chat request form, and the ability of Siebel Call Center to identify that customer, the
workow for accepting an incoming chat can vary.
The following table describes what happens in Siebel Call Center when the user’s contact ID only is identied, along with
the presence or absence of various other conditions.
No Yes Yes Yes Yes Creates a new service Populates the Creates a new
request using the customer dashboard activity with the
contact ID and other using the contact ID, contact ID.
No Yes Yes No Yes chat data present, and identify chat
such as, area, data (if any), such as, Updates the
subarea, or problem contact rst name, activity with the
description. contact last name, service request ID
email address, or when the service
Shows the service phone number. request is created.
request detail view.
29
Siebel Chapter 4
Chat Guide Working with Siebel Chat
No Yes No Yes Yes Shows the contact Populates the Creates a new
detail view. customer dashboard activity with the
using the contact ID, contact ID.
No Yes No No Yes Opens the search and identify chat
frame and searches data (if any), such as,
using other chat data contact rst name,
present. contact last name,
email address, or
phone number.
No Yes No Yes No Shows the contact
detail view.
The following table describes what happens in Siebel Call Center when the user’s service request ID and contact ID are
both identied, along with the presence or absence of various other conditions.
SR ID Contact Auto Identify Other Actions in Siebel Actions in Siebel Actions in Siebel
Present ID Create Chat Data Chat Call Center Call Center Call Center
Present Service Present Data Application (1) Application (2) Application (3)
Request Present
On
Yes Yes Yes Yes Yes Shows the service Populates Creates a new
request detail view. the customer activity with the
dashboard using service request ID,
the contact ID, and and contact ID.
identify chat data
(if any), such as,
contact rst name,
contact last name,
email address, or
phone number.
Yes Yes Yes Yes No Shows the service Populates Creates a new
request detail view. the customer activity with the
dashboard using service request ID,
the contact ID, and and contact ID.
identify chat data
(if any), such as,
contact rst name,
contact last name,
email address, or
phone number.
Yes Yes Yes No Yes Shows the service Populates Creates a new
request detail view. the customer activity with the
30
Siebel Chapter 4
Chat Guide Working with Siebel Chat
SR ID Contact Auto Identify Other Actions in Siebel Actions in Siebel Actions in Siebel
Present ID Create Chat Data Chat Call Center Call Center Call Center
Present Service Present Data Application (1) Application (2) Application (3)
Request Present
On
Yes Yes No Yes Yes Shows the service Populates Creates a new
request detail view. the customer activity with the
dashboard using service request ID,
the contact ID, and and contact ID.
identify chat data
(if any), such as,
contact rst name,
contact last name,
email address, or
phone number.
31
Siebel Chapter 4
Chat Guide Working with Siebel Chat
SR ID Contact Auto Identify Other Actions in Siebel Actions in Siebel Actions in Siebel
Present ID Create Chat Data Chat Call Center Call Center Call Center
Present Service Present Data Application (1) Application (2) Application (3)
Request Present
On
The following table describes what happens in Siebel Call Center when the user’s service request ID only is identied,
along with the presence or absence of various other conditions.
SR ID Contact Auto Identify Chat Other Actions in Siebel Actions in Siebel Actions in Siebel
Present ID Create Data Present Chat Call Center Call Center Call Center
Present Service Data Application (1) Application (2) Application (3)
Request Present
On
Yes No No Yes Yes Shows the service Searches for the Creates a new
request detail view. contact using the activity with the
service request service request ID.
ID and identify
chat data (if any), Updates the activity
such as, problem with the contact ID
description or when the contact is
product category. determined.
Populates
the customer
dashboard.
Yes No No Yes No Shows the service Searches for the Creates a new
request detail view. contact using the activity with the
service request service request ID.
ID and identify
chat data (if any), Updates the activity
such as, problem with the contact ID
description or when the contact is
product category. determined.
Populates
the customer
dashboard.
Yes No No Yes Yes Shows the service Searches for the Creates a new
request detail view. contact using the activity with the
service request service request ID.
ID and identify
chat data (if any), Updates the activity
such as, problem with the contact ID
32
Siebel Chapter 4
Chat Guide Working with Siebel Chat
SR ID Contact Auto Identify Chat Other Actions in Siebel Actions in Siebel Actions in Siebel
Present ID Create Data Present Chat Call Center Call Center Call Center
Present Service Data Application (1) Application (2) Application (3)
Request Present
On
Populates
the customer
dashboard.
Yes No No Yes No Shows the service Searches for the Creates a new
request detail view. contact using the activity with the
service request service request ID.
ID and identify
chat data (if any), Updates the activity
such as, problem with the contact ID
description or when the contact is
product category. determined.
Populates
the customer
dashboard.
Yes No Yes No Yes Shows the service Searches for the Creates a new
request detail view. contact using the activity with the
service request ID. service request ID.
Yes No Yes No No Shows the service Searches for the Creates a new
request detail view. contact using the activity with the
service request ID. service request ID.
Yes No No No Yes Shows the service Searches for the Creates a new
request detail view. contact using the activity with the
service request ID. service request ID.
33
Siebel Chapter 4
Chat Guide Working with Siebel Chat
SR ID Contact Auto Identify Chat Other Actions in Siebel Actions in Siebel Actions in Siebel
Present ID Create Data Present Chat Call Center Call Center Call Center
Present Service Data Application (1) Application (2) Application (3)
Request Present
On
The following table describes what happens in Siebel Call Center when neither the user’s service request ID nor the
contact ID are identied, but various other conditions are either present or absent.
SR ID Contact Auto Identify Other Actions in Siebel Call Actions in Siebel Call Actions in Siebel
Present ID Create Chat Data Chat Center Application Center Application Call Center
Present Service Present Data (1) (2) Application (3)
Request Present
On
No No Yes Yes Yes Opens the search If one contact is Creates a new
frame and searches found, populates the activity with the
using other chat data customer dashboard service request ID
present, such as, using the contact and contact ID (if
problem description information and found).
or product category. identifying chat data.
34
Siebel Chapter 4
Chat Guide Working with Siebel Chat
SR ID Contact Auto Identify Other Actions in Siebel Call Actions in Siebel Call Actions in Siebel
Present ID Create Chat Data Chat Center Application Center Application Call Center
Present Service Present Data (1) (2) Application (3)
Request Present
On
found, or without a
contact).
35
Siebel Chapter 4
Chat Guide Working with Siebel Chat
SR ID Contact Auto Identify Other Actions in Siebel Call Actions in Siebel Call Actions in Siebel
Present ID Create Chat Data Chat Center Application Center Application Call Center
Present Service Present Data (1) (2) Application (3)
Request Present
On
• Set the system preference Chat: AutoCreate Service Req to TRUE to automatically create a new service request
for every incoming chat request that is accepted by an agent.
For more information about system preference setup for chat, see Seing Up System Preferences in Siebel Call Center
for Siebel Chat.
36
Siebel Chapter 4
Chat Guide Working with Siebel Chat
Checking That All Server Component Groups are Started for Siebel
Call Center
To enable agents to receive inbound chats, administrators must ensure that all relevant server component groups are
up and running for Siebel Call Center. If server component groups are not started, then administrators must start them
from either Siebel Call Center or the command line, as described in the following procedures.
37
Siebel Chapter 4
Chat Guide Working with Siebel Chat
Note: Without enabling the Communication Management, Workow Management, and EAI
component groups, Siebel Chat agents are not able to receive inbound chats.
SIEBSRVR_ROOT\bin >smgr
srvrmgr> exit
For information about seing environment parameters in Windows and UNIX, see Siebel System
Administration Guide .
3. Connect back to the application database:
SIEBSRVR_ROOT\bin>smgr
4. To synchronize:
srvrmgr>sync
38
Siebel Chapter 4
Chat Guide Working with Siebel Chat
• To review cached chat response messages, see Replaying Cached Chat Response Messages.
a. Go to the Chat Info tab, and review the chat-related information associated with the inbound chat activity.
The following table describes the elds within the Chat Info tab.
SR Number The service request number associated with this inbound chat activity, if any.
Click SR Number to drill down on a detailed view of the service request.
SR Description A brief description of the service request associated with this inbound chat
activity.
b. Go to the Aachments tab and click the chat_transcript le to open and review the entire transcript of the
inbound chat activity.
Click any other le aachment to open up, and review the solution content.
39
Siebel Chapter 4
Chat Guide Working with Siebel Chat
Agents can review inbound chat activities and solutions associated with individual contacts. To review inbound chat
activities associated with a contact, complete the steps in the following procedure.
40
Siebel Chapter 4
Chat Guide Working with Siebel Chat
Related Topic
Conguring the RedoPopupInMenu Command
The communications toolbar is dened and congured in Siebel Tools, like other toolbars in Siebel applications.
For more information about conguring the communications toolbar and about the functions available on the
communications toolbar, see Siebel CTI Administration Guide .
Using the communications toolbar, agents can sign in to the Siebel Chat channel and make themselves available for
incoming chat requests, put chats on hold, transfer, and release chats. For more information about these tasks, see the
following:
• Logging in to Siebel Chat
• Receiving a New Chat
• Accepting an Incoming Chat
• Responding to an Incoming Chat
• Handling Siebel Chat Sessions
Note: Most functions available on the communications toolbar support voice, email, and chat.
41
Siebel Chapter 4
Chat Guide Working with Siebel Chat
When an agent (using the Siebel Call Center application) receives a new chat:
• Either the Accept Work Item buon on the communications toolbar ashes to notify that a chat request has
been queued, or the chat tab ashes to indicate that a new chat has been automatically accepted and queued
to the agent.
• At the same time, the communications toolbar displays a message to identify the user requesting a chat, for
example, as follows:
Chat Request from [email protected]
• When the agent accepts the chat, the customer dashboard automatically prepopulates with the following
information, if provided by the customer on the chat request form:
Customer Name
Phone Number
Email Address
For anonymous chat users, the customer dashboard remains blank. For more information about the customer
dashboard, see About the Customer Dashboard.
42
Siebel Chapter 4
Chat Guide Working with Siebel Chat
agents in Siebel Call Center, then agents do not need to manually accept the incoming chat as the chat either opens up
automatically on the agent’s screen or the chat tab ashes to indicate that a new chat has been automatically accepted
and queued.
By default, when an agent accepts a chat, the agent automatically becomes not ready or unavailable for other channels.
If an agent does not accept an incoming chat:
• The status of that agent automatically changes to not ready, and no further incoming chats are queued to that
agent until that agent changes the status back to ready. Agent status is indicated by the status buon (State:
ready or State: not ready) on the communications toolbar.
If chat auto answer is enabled and the agent is congured to accept a maximum number of chats at the same
time in the third-party chat server, then chat auto answer accepts incoming chats, up to the maximum number
of chats allowed. For more information about agent status, see Changing Agent Status.
A chat pane opens in an action pane of your Siebel Call Center application. The chat dashboard is prepopulated
with the information provided by the user on the chat request form. The customer dashboard also opens,
showing customer information.
2. Respond to the incoming chat as described in Responding to an Incoming Chat.
Note: If there are no other active chat sessions or the agent is not working on an existing chat, then there is
no need to do anything to open the incoming chat as the chat pane opens up automatically.
For more information about chat auto answer, see Roadmap for Conguring Siebel Chat Auto Answer for Agents.
The chat tab stops ashing and a chat pane opens in an action pane of your Siebel Call Center application.
The chat dashboard is prepopulated with the information provided by the user on the chat request form. The
customer dashboard also opens, showing customer information.
2. Respond to the incoming chat as described in Responding to an Incoming Chat.
43
Siebel Chapter 4
Chat Guide Working with Siebel Chat
For anonymous chats, a service request is always created and also a corresponding activity. An activity
is created either under a Service Request or a Contact record. For more information about activities, see
Reviewing Inbound Siebel Chat Activities. For more information about manually creating a service request, see
Creating a Service Request Manually.
4. Release the chat as described in Releasing Chat Sessions.
Sending a Message
Agents have a global list of predened message responses at their disposal to send to customers, as required, when
handling chat interactions. In responding to chat requests, agents can type a message response or they can send a
predened message response, as described in the following procedure. Note the following about using frequently used
text (FUT) and composing a message response:
• You can formulate a message response using any combination of FUT and typed in text.
• You can manually edit the FUT before sending the message response.
• All responses that you send to a customer appear in the transcript area of the chat pane.
To use predened message responses, you must set up FUT for Siebel Chat rst, see Seing Up Frequently Used Text in
Siebel Call Center for Siebel Chat.
To send a message
1. In the message input area of the chat pane, type in the message response, then click Send.
2. If required, send a message response using FUT matching as follows:
a. On the text buon bar, click the Toggle FUT buon to enable FUT matching.
After FUT matching is enabled, matching is based on input text by default, but you can change this to
lter on a dierent match eld as shown in a later step in this procedure.
44
Siebel Chapter 4
Chat Guide Working with Siebel Chat
Note: The keyboard shortcut to enable or disable FUT matching is Ctrl+Shift+F. FUT matching is
disabled by default.
While typing in your message, any matches found appear directly in a drop-down list and any matched
words show in bold.
c. Click a suggested match to select and use that option.
3. If required, lter FUT matching on a dierent match eld as follows:
a. On the text buon bar, click the Change FUT Match Field buon and then select one of the following:
Note: The keyboard shortcut to change the FUT match eld is Ctrl+Shift+U. FUT matching is
based on input text by default.
While typing in your message, any matches found appear directly in a drop-down list and any matched
words show in bold.
c. Click a suggested match to select and use that option.
In responding to an incoming chat, agents can type the URL address of a page that they want to share or they can push
a predened URL, as described in the following procedure. All URLs that you send to a customer appear in the transcript
area of the chat pane.
To push predened Web URLs, you must set up a global URL library for Siebel Chat rst. For more information about
URL library setup, see Seing Up a Global URL Library in Siebel Call Center for Siebel Chat.
45
Siebel Chapter 4
Chat Guide Working with Siebel Chat
Note: Pushed URLs can either appear in a frame within the customer’s chat window, or in a
completely new browser window, depending on conguration. Where a new browser window is
launched, subsequent URL pushes simply refresh the same window. For more information about
push URL conguration, see Conguring the Behavior of the Push URL Functionality.
46
Siebel Chapter 4
Chat Guide Working with Siebel Chat
Note: To close the chat pane, agents can also click the Close (or X) buon in the corner of the chat
pane. For more information, see Closing Chat Sessions.
Where multiple chat sessions are ongoing, agents can move between each chat session without losing context. If
multiple chat sessions are open, they are represented by tabs in the chat pane where:
Note: It is recommended that you use chat tabs to switch between chat sessions and avoid using the
communications toolbar, which is less ecient and prone to error.
Where all chat sessions are on hold and an agent manually accepts a new incoming chat, then that new chat becomes
the active chat session and all other chat sessions remain on hold.
47
Siebel Chapter 4
Chat Guide Working with Siebel Chat
When a chat is transferred, the chat transferred activity created by the transferring agent is updated to associate the
receiving agent with the activity, and the chat transcript is aached to the activity. While a chat is being transferred, the
customer is not able to submit any messages to the agent until the (new) receiving agent accepts the transferred chat.
Note: Any messages that the customer sends while the agent is transferring a chat are lost; that is, they are
not captured in the chat window or transcript.
48
Siebel Chapter 4
Chat Guide Working with Siebel Chat
The chat is transferred to the selected agent. The chat transcript includes all previous conversations and
interactions that the previous agent had with the customer.
You cannot transfer a chat to an agent that has a status of Busy, On Break, or Logged Out.
Note: Any messages that the customer sends while the agent is transferring a chat are lost; that is, they are
not captured in the chat window or transcript.
◦ Click the ashing chat tab to open the chat session (when chat auto answer is enabled).
◦ Click the Accept Work Item buon on the communications toolbar to open the chat session (when chat
auto answer is disabled).
2. Review the chat transcript (if there is one) in the transcript area of the chat pane.
For more information about how agents review chat activities and transcripts, including inbound chat activities
associated with service requests and contacts, see Reviewing Inbound Siebel Chat Activities.
3. Respond to the transferred chat, see Responding to an Incoming Chat.
When an agent or customer releases a chat session, a follow-up email is sent to the customer with a transcript of
the chat session aached provided the system preference Chat: Auto Email Mode is set, and that outbound email
communications and an email prole are set up in Siebel Call Center. In the case where a chat is transferred several
times, the follow-up email is sent only upon nal release of the chat session.
• For information about email prole setup in Siebel Call Center, see Siebel Email Administration Guide .
• For information about outbound email communications setup in Siebel Call Center, see Seing Up Outbound
Email Communications in Siebel Call Center.
49
Siebel Chapter 4
Chat Guide Working with Siebel Chat
50
Siebel Chapter 4
Chat Guide Working with Siebel Chat
Related Topics
About the Customer Dashboard
The purpose of the customer dashboard is to alert the agent if the customer requesting a chat provides prole
information which does not match the contact record. For example, if the phone number or email address provided by
a known customer does not match the contact record on le, then an exclamation mark appears next to these elds
indicating to the agent that this information is new. For more information about conguring the customer dashboard,
see Conguring Siebel Business Applications .
Note: An activity can be linked to only one service request at any given time.
If this is the rst service request that is created for the chat, then the inbound chat activity is associated with it.
If this is not the rst service request, then this subsequent service request is regarded as standalone - which
means that the inbound chat activity is not associated (or linked) to this service request.
51
Siebel Chapter 4
Chat Guide Working with Siebel Chat
Note: Once a new service request is created, the agent can associate it with the current chat activity
record by navigating to Tools, then Communications in Siebel Call Center, and clicking the Associate
buon.
By default, the Create Service Request action is contextually smart. It prepopulates the new service request
form with data displayed in the customer dashboard and chat dashboard.
To view service requests, activities, and contacts using the chat dashboard
1. Click the Action drop-down menu in the chat dashboard.
2. Select one of the following, as required:
a. Select View Service Requests to view the service requests linked to the current chat, or the service
request detail screen for the contact.
b. Select View Activities to view the activities linked to the contact.
c. Select View Contact to view the contact details for the contact. This option applies to existing contacts
only, not to anonymous chat users.
After you have minimized the chat dashboard, use the following procedure to show the chat dashboard again.
52
Siebel Chapter 4
Chat Guide Working with Siebel Chat
State: ready (available) to State: not ready (unavailable), then they must click the status buon on the communications
toolbar.
Notice that your status, as indicated by the status buon on the communication toolbar, is set to State: ready by
default.
3. Click the status buon on the toolbar to change your status from State: ready to State: not ready (and
conversely).
Interaction State Description and Siebel Call Center Behavior Automatic or Manual?
Active The chat session is currently active, whereby the agent is Automatic.
actively chaing with the customer.
Transferred The chat has been transferred. Manual. Agents must click the
Get Transfer List buon on the
• When the chat is accepted by another agent, the communications toolbar to
interaction state changes to In Progress. transfer a chat interaction that
they are currently working on to
• The transferring agent's chat tab is removed once the another workgroup. For more
agent moves onto another chat, or closes the chat pane. information, see Transferring
Chat Interactions to Others.
• The Chat Activity has a status of Transferred.
• When the transferred chat is accepted by the receiving
agent, a new activity is created with a status of In Progress.
53
Siebel Chapter 4
Chat Guide Working with Siebel Chat
Interaction State Description and Siebel Call Center Behavior Automatic or Manual?
Idle There has been no activity within a chat session from either the Automatic.
agent or the customer for over two minutes.
Aborted Either the agent or customer ends the chat session by means Automatic.
other than clicking the Release Work Item or Terminate
buons (for example, a browser is killed or a network mains is
unplugged).
The following table lists the dierent agent states that exist for Siebel Chat agents. Some of these states are
automatically forced by Siebel Chat and others are manually triggered by the agent.
Chaing The agent is engaged, or actively chaing, in at least one chat Automatic.
session.
Working The agent is available to handle chat requests. Manual. Agents must click
the Status buon on the
communications toolbar to set
their status to available (State:
Ready). For more information
about agent status, see Changing
Agent Status.
On Break The agent is currently unavailable to handle chat requests. Manual. Agents must click
the Status buon on the
communications toolbar to set
their status to unavailable (State:
Not Ready). For more information
about agent status, see Changing
Agent Status.
54
Siebel Chapter 4
Chat Guide Working with Siebel Chat
For more information, see Logging for the Communications Management Component Group.
Note: The Communications Management component group includes the following server
components: Communications Session Manager, Communications Conguration Manager,
Communications Inbound Receiver, Communications Inbound Processor, Communications Outbound
Manager, Page Manager, and Email Manager. For more information about the Communications
Management component group, see Siebel CTI Administration Guide .
• Siebel Server
Logging for the Communications Management component group is carried out using the following mechanisms:
• Communications Session Logging. Logs information and errors related to the processing of chat interactions in
the Communications Management component group.
Communications session logging can be turned on by seing the LogFile and LogDebug parameters in the
Communication Session Manager server component.
All Chat UI Business Service messages (for example, in relation to Siebel Chat commands and events) are
logged to this le.
• Driver Logging. Logs any third-party chat driver-specic information and errors.
Driver logging can be turned on during driver conguration, using the Driver:LogFile parameter at the Prole
Parameter Override level. For more information about driver conguration, see Conguring Communications in
Siebel Call Center for Siebel Chat.
For more information about session communications and communications drivers, see Siebel CTI Administration Guide
.
55
Siebel Chapter 4
Chat Guide Working with Siebel Chat
Parameter Value
Log Level Set to a value between 1 and 5, where 1 represents the least logging and 5 the most
logging (debug).
SEBLCL_TRACEMODE Controls the log mode/device choice. Set this variable to 2 to log to le.
SEBLCL_TRACEUNICODE Enables tracing in Unicode mode. This variable is useful for tracing international language data, and is
disabled by default.
SEBLCL_LOGDIR Species the location on client disk where the log le is created.
56
Siebel Chapter 4
Chat Guide Working with Siebel Chat
Note: This topic is valid for Google Chrome and Mozilla Firefox browsers since they both provide native
support for the Web Notications API. Microsoft IE browsers, however, do not support the Web Notications
API out-of-the-box. The Desktop Integration Siebel Agent (DISA) is provided to support Web notications
functionality in IE browsers. For more information about DISA, see Desktop Integration Siebel Agent Guide.
57
Siebel Chapter 4
Chat Guide Working with Siebel Chat
58
Siebel Chapter 5
Chat Guide Customizing Siebel Chat
Note: The functionality described in this chapter applies only if you are using the default workow to handle
incoming chat requests. For more information about the default workow for Siebel Chat, see Chat Standard
Accept Process Workow.
For more information about the Siebel Chat interface, which is part of the communications panel, see Siebel Chat
Interface. For more information about the communications panel, see Siebel Fundamentals for Siebel Open UI and
Siebel CTI Administration Guide.
For more information about customizing Siebel Chat, see the following:
• Siebel Call Center and Siebel Chat-Related Applets
• Conguring the Appearance of Transcript Aachments
• Conguring the Behavior of the Push URL Functionality
• Customizing the Siebel Chat User Interface
59
Siebel Chapter 5
Chat Guide Customizing Siebel Chat
Chat UI KB Visited Pick Applet Shows a list of the knowledge base items visited Chat UI KB Visited
(by a customer requesting a chat) to the agent.
Chat UI URL Library Pick Applet Shows a list of the available URLs to push to a Chat UI URL Library
customer during a chat.
Chat Web Projects Pick List Applet Shows a list of third-party chat projects to Chat Web Projects Pick List
which a chat interaction can be routed. Applet
SIEBSRVR_ROOT\webtempl
Administrators can congure the appearance of transcript aachments by modifying the chat.xsl le. This le
contains parameters that can be modied to get the required look and feel for transcript aachments. To congure the
appearance of transcript aachments, complete the steps in the following procedure.
SIEBSRVR_ROOT\webtempl
60
Siebel Chapter 5
Chat Guide Customizing Siebel Chat
CAUTION: Some Web sites (for example, hotmail.com) with heavy scripting and other background
processes might prompt the user with something similar to the following:You are about to leave
the application. Clicking OK will take you away from the chat application, and terminate the chat
interaction.
a. Set this option to on if you want pushed content to display in a new browser window.
b. Set this option to o if you want pushed content to display in a frame alongside the customer chat UI.
3. Save the web.xml le.
Note: It is not necessary to shut down and restart the servers for this change to take eect, nor for the cache
to be cleaned.
61
Siebel Chapter 5
Chat Guide Customizing Siebel Chat
62
Siebel Chapter 5
Chat Guide Customizing Siebel Chat
3. In the Object Explorer, go to Applet, and then nd Chat Tab Applet.
4. Drill down on Control, and then select DashboardFields.
5. Drill down on Control User Prop.
6. Congure, for example, the following elds as required:
◦ Column. The column where the eld appears. The value can be either 1 or 2 because each row on the chat
dashboard can be divided into a maximum of two columns.
◦ Length. The width of the eld, which can be either half or full. The length value is case sensitive. A value
of full indicates that the eld width is the entire length of the row; half indicates that the eld width is only
half the length of the row. Any other value is treated as a full value.
◦ Row. The row where the eld is located. The value can be from 1 to MaxRowNum. MaxRowNum
is congured for the DashboardFields control user property. Any value less than 1 or larger than
MaxRowNum is ignored.
◦ Value. Indicates the data source to which the eld belongs. The value can be interaction data or a
business component eld. The format of the value is as follows: {BC Name:eldName} or {CCA-
Data:eldName}.
For example, the user properties for the Area and Product elds are shown in the following table.
User Property Name Values for the Area Field Values for the Product Field
Column 1 1
Row 1 2
63
Siebel Chapter 5
Chat Guide Customizing Siebel Chat
◦
Deselect the Visible property for KB to make the whole eld control invisible on the chat dashboard.
Select the Visible property for KB to make the whole eld control visible.
◦ Set the Visible property for the KBBuon control to False to make only the KB Visited buon invisible on
the chat dashboard. Set it to True to make only the KB Visited buon visible on the chat dashboard.
5. To congure the QuickActionList control:
◦
Set the Visible property for QuickActionList to False to make the whole eld control invisible on the chat
dashboard. Set it to True to make the whole eld control visible.
◦ Set the Visible property for the Go control to False to make only the Action buon invisible on the chat
dashboard. Set it to True to make only the Action buon visible.
6. Publish the repository updates.
7. Restart the Siebel Server.
Field Value
Active Selected
64
Siebel Chapter 5
Chat Guide Customizing Siebel Chat
Field Value
b. Navigate to Administration - Runtime Events, Actions Sets view, select the Personalization Action list
applet, and then add a record with the values shown in the following table.
Field Value
Sequence 1
Active Selected
a. Navigate to Administration - Runtime Events, Event Aliases view, and then add a record with the values
shown in the following table.
Field Value
Event WriteRecordUpdate
65
Siebel Chapter 5
Chat Guide Customizing Siebel Chat
Field Value
b. Navigate to Administration - Runtime Events, Events view, and then add a new event with the values
shown in the following table.
Field Value
After you select the event name from the drop-down list, the Object Type,
Object Name, and Event elds are lled in automatically.
Event WriteRecordUpdated
Sequence Enter a sequence number (for example, 2) that does not conict with the
current event.
4. Restart the Siebel Server for the run-time event to take eect.
Whenever an agent updates a service request, an action is triggered to update all the BC elds (not only the
service request elds) on the chat dashboard.
You can congure more events, as required, using other business components whose elds display on the
chat dashboard to trigger the update dashboard action. For example, you can congure an event triggered by
updating a contact. In this case, all BC elds on the chat dashboard are updated when the agent updates the
contact.
66
Siebel Chapter 5
Chat Guide Customizing Siebel Chat
c. To remove the URL area from the chat pane, set the URLBuonBarHeight and UrlInputHeight properties
to zero, as shown in the following code example:
.chatAxLayout
{
MinAxHeight:400;
MinAxWidth:300;
TitleBarHeight:24;
TabBarHeight:22;
TextButtonBarHeight: 24;
TextInputHeight:75;
URLButtonBarHeight: 0;
UrlInputHeight: 0;
}
3. Save the Siebel CRM cascading style sheet le to the Siebel Application Interface for the changes to take eect.
67
Siebel Chapter 5
Chat Guide Customizing Siebel Chat
2. In the Object Explorer, select Applet, then the Chat Tab Applet.
3. In the Object Explorer, select Control.
4. Congure the Sequence property for the buons on the URL buon bar as follows:
Select the PushUrl or UrlLib control user property as required and congure Sequence as shown in the
following table.
where:
Select the Send, FUT, or SmartShare control user property as required, and congure Sequence as shown in the
following table.
where:
68
Siebel Chapter 5
Chat Guide Customizing Siebel Chat
Business Service Name The business service that this action calls. If the action is Workow Process
a workow, then the value in this eld is Workow Process Manager
Manager. If the action is not a workow, then the value can be
any service.
Business Service Method The business service method that this action calls. If the action RunProcess
is a workow, then the value in this eld is RunProcess. If the
action is not a workow, then the value can be any service.
Process Name If the action is to call a workow, then the value in this eld is View Contact of Current
the workow name. You can ignore this property if the action Chat
does not call a workow.
[Parameters] To pass parameters into the service method or workow, you ServiceRequest:ContactId
must dene the name-value pairs here. Name is the input
For example, ContactId. argument name. For value, two formats are supported:
69
Siebel Chapter 5
Chat Guide Customizing Siebel Chat
- {BC Name:fieldName}
- {CCA-Data:fieldName}
Name ActionItemX, where X represents the order in which the action ActionItem5
appears in the Action menu on the chat dashboard. ActionItem2
indicates that the action appears as the second item on the list.
Value The control name of the action that you are adding to the quick ViewContactSR
action list.
Note: Siebel Chat by default provides a run-time event and the Chat Display Name Update Process workow
for conguring the display name for Siebel Chat sessions. You can modify both the run-time event and the
workow as required.
70
Siebel Chapter 5
Chat Guide Customizing Siebel Chat
b. Query for ChatAcceptedLog, locate ServiceParam.ProcessName, then verify the workow name, and
make sure that it has included the workow step to update the display name for Siebel Chat sessions.
c. Query for ChatTransferAcceptedLog, locate ServiceParam.ProcessName, then verify the workow name,
and make sure that it has included the workow step to update the display name for Siebel Chat sessions.
Note: Siebel Chat provides a default sample workow to handle incoming chat requests called
Chat Standard Accept Process.
2. Verify that the run-time events for updating the chat display name have been added to your Siebel application
and congured appropriately as follows:
a. Navigate to Administration - Runtime Events, Actions Sets view, then select the Personalization Action
Set list applet.
b. Add a record with the values shown in the following table, if a record is not already congured with these
values.
Field Value
Active Selected
c. Navigate to Administration - Runtime Events, Actions Sets view, then select the Personalization Action
list applet.
d. Add a record with the values shown in the following table, if not already congured.
Field Value
Sequence 1
71
Siebel Chapter 5
Chat Guide Customizing Siebel Chat
Field Value
Active Selected
Field Value
Sequence 1
Event WriteRecordUpdated
3. Update the Chat Display Name Update Process workow in Siebel Tools as follows:
Note: Siebel Chat by default provides the Chat Display Name Update Process workow, and you
can modify it as required.
- UpdateChatDataField. This method resets the ChatDisplayName in the Chat Data map to an empty
string.
72
Siebel Chapter 5
Chat Guide Customizing Siebel Chat
- Update ChatDataFieldEx. This method updates the eld in the Chat Data map with the value in a
business component eld.
- UpdateWithBCField. This method updates a eld in the Chat Data map with the value in a business
component eld.
- UpdateWithBCFieldEx. This method updates the eld in the Chat Data map with the value in a
business component eld.
- UpdateWithChatData. This method updates a eld in the Chat Data map with the value in the third-
party Chat Data eld.
- UpdateChatUIField. This method updates the chat display name in the chat pane.
For more information about each of these methods, see Methods for Customizing Siebel Chat Process
Flow and Interface Functionality.
For example, select the FUT buon control user property to congure a keyboard shortcut for the Frequently
Used Text buon.
4. Congure the HotKey user property, for example, as shown in the following table.
Name Value
HotKey <Alt+K>
The value can be a combination of CTRL, ALT, or SHIFT plus a keyboard leer or function key. For more
information about the shortcut key formats that are allowed, see the topic about creating accelerator objects in
Siebel Object Types Reference .
Make sure that your keyboard shortcut key combination does not conict with any command accelerators in
Siebel Tools or with any existing Communication Toolbar keyboard shortcuts already dened. Any command
accelerators in Siebel Tools or existing Communication Toolbar keyboard shortcuts already dened take
precedence over the keyboard shortcuts dened for the chat interface.
73
Siebel Chapter 5
Chat Guide Customizing Siebel Chat
Likewise when customers are typing a response to the agent, the following message appears on the agent’s chat pane,
provided Siebel Chat feedback is congured:
Customer is typing . . .
In both cases, the feedback message appears after the chat transcript area in the chat pane, and it is displayed for
approximately 5 seconds before disappearing.
To congure feedback messages to display during chat sessions between agents and customers, perform the following
tasks. This process is a step in Roadmap for Conguring Siebel Call Center for Siebel Chat.
• Chat: CustomerTypeDisplayTime. Indicates the time in seconds that the following feedback message is
displayed on the agent’s chat screen to indicate that the customer is typing a message response:
Customer is typing
After this time, provided the customer has stopped typing, the feedback message disappears.
• Chat: AgentTypeDetectInterval. Indicates the period in seconds during which to detect the agent’s typing status.
The value must be greater than zero.
• Chat: SendAgentTypeMsgCmd. Indicates the CTI command to call when sending the agent’s feedback message
to a customer. The CTI command must be a valid command used when conguring CTI (Computer Telephony
Integration).
Use the following procedure to congure the user preferences in Siebel Call Center for Siebel Chat feedback. This task is
step in Process of Conguring Siebel Chat Feedback.
74
Siebel Chapter 5
Chat Guide Customizing Siebel Chat
a. Drill down into the SendAgentTypingMsg command, click the Command Parameters tab, and add the
command parameters with the values shown in the following table.
Name Value
CmdData SendAgentTypingMsgCmdData
DeviceCommand SendAgentTyping
b. Click the Command Data Parameters tab, and add the command data parameter with the value shown in
the following table.
Name Value
Param.InteractionId {InteractionId}
75
Siebel Chapter 5
Chat Guide Customizing Siebel Chat
Name Value
For more information about conguring commands and events, see Siebel CTI Administration Guide .
4. For the changes to take eect, log out of the Siebel application, and then log in again.
ChatCustomerTyping Select your communications conguration record. For Add a relevant comment.
example: Devchat_wkow.
3. Click the Event Response Parameters tab, and congure the following records for ChatCustomerTyping with the
values shown in the following table.
Name Value
ServiceParam.InteractioId {InteractionId}
76
Siebel Chapter 5
Chat Guide Customizing Siebel Chat
3. Click the Event Handlers Parameters tab, and congure the following records for ChatCustomerTyping with the
values shown in the following table.
Name Value
Filter.Channel Chat
Filter.MsgType TYPE_CUSTOMER_TYPING
4. Navigate to Administration - Communications screen, Congurations view, and then click the Event Handlers
tab.
5. Select the ChatCustomerTyping record, and congure it as follows:
Comments: Chat
b. In the Event Response eld, click the Look Up icon, and associate the ChatCustomerTyping event
response with the ChatCustomerTyping event handler.
77
Siebel Chapter 5
Chat Guide Customizing Siebel Chat
78
Siebel Chapter 6
Chat Guide Conguring Siebel Chat Auto Answer
Note: The functionality described in this chapter applies only if you are using the default workow to handle
incoming chat requests. For more information about the default workow for Siebel Chat, see Chat Standard
Accept Process Workow.
When chat auto answer is enabled for agents, agents do not have to manually accept chats that are oered to them.
Instead, the chat that is oered automatically becomes the active chat session for the agent by opening on the agent’s
screen, provided that the agent has no other chat sessions assigned. The behavior is dierent if chat auto answer is
enabled and the agent is busy handling one or more chat sessions. In these cases, the behavior is as follows:
• The chat that is oered does not automatically open on the agent’s screen.
• The chat tab ashes to indicate that a new chat has been automatically accepted and queued to the agent.
Administrators can congure the color that is used when the chat tab ashes.
• When the agent clicks the ashing chat tab, the chat session opens, and the chat tab stops ashing.
• If the customer decides to disconnect from the chat before the agent can open the chat session, then the chat
closes as normal.
To congure Siebel Chat auto answer for agents in Siebel Call Center, perform the following tasks and process:
• Conguring the Siebel Chat BlinkTab System Preference
• (Optional) Seing the Color for the Siebel Chat Blinking Tab
• Disabling the Service Integration Inbox Workows
• Process of Conguring Communications for Siebel Chat Auto Answer
79
Siebel Chapter 6
Chat Guide Conguring Siebel Chat Auto Answer
system preference for chat auto answer. This task is a step in Roadmap for Conguring Siebel Chat Auto Answer for
Agents.
80
Siebel Chapter 6
Chat Guide Conguring Siebel Chat Auto Answer
81
Siebel Chapter 6
Chat Guide Conguring Siebel Chat Auto Answer
To congure the Enable Auto Answer user preference at the agent level
1. Select Tools, User Preferences, and then the Communications option.
2. Do one of the following:
◦ Select the Enable AutoAnswer checkbox to enable chat auto answer at the agent level.
◦ Deselect the Enable AutoAnswer checkbox to disable chat auto answer at the agent level.
The Enable AutoAnswer user preference seing is relevant only if the AutoAnswer system parameter is
set to User Preference. If AutoAnswer is not set to User Preference, then Enable AutoAnswer is ignored.
3. Click Save.
Name Conguration
3. Click the Event Log Parameters tab, and add a new record for ChatAcceptedLog with the values shown in the
following table.
Name Value
ServiceParam.WorkID {SiebelWorkItemID}
4. Go back to the Event Logs list, and congure ChatTransferAcceptedLog with the value shown in the following
table.
82
Siebel Chapter 6
Chat Guide Conguring Siebel Chat Auto Answer
Name Conguration
5. Click the Event Log Parameters tab, and add a new record for ChatTransferAcceptedLog with the values shown
in the following table.
Name Value
ServiceParam.WorkID {SiebelWorkItemID}
AcceptChatCmdData Select your communications conguration record. Enter a comment, for example: Add
for chat auto answer.
3. Click the Command Data Parameters tab, and congure the following records for AcceptChatCmdData with the
values shown in the following table.
Name Value
Param.AutoHold FALSE
Param.TrackingID {InteractionId}
4. Navigate to the Administration - Communications screen, then the All Congurations view, select your
communications conguration record from the Congurations list, and then do the following:
83
Siebel Chapter 6
Chat Guide Conguring Siebel Chat Auto Answer
a. Click the Commands tab, and congure the AcceptChatGroup command with the value shown in the
following table.
AcceptChatGroup AcceptChatCmdData
b. Click the Parameters tab, and verify that the command data parameters have the Param.TrackingID that
you congured earlier in this procedure.
OnChatArrived Select your communications conguration record. Enter a comment, for example: Add for
chat auto answer.
3. Click the Event Response Parameters tab, and congure the following records for OnChatArrived with the
values shown in the following table.
Name Value
ServiceParam.Command AcceptChatGroup
ServiceParam.InteractioId {InteractionId}
84
Siebel Chapter 6
Chat Guide Conguring Siebel Chat Auto Answer
3. Click the Event Handlers Parameters tab, and congure the following records for ChatArrived with the values
shown in the following table.
Name Value
Filter.Channel Chat
Filter.MsgType TYPE_NEW
Filter.systemTransfer 0
4. Navigate to Administration - Communications screen, Congurations view, and then click the Event Handlers
tab.
5. Select the ChatArrived record, and congure it as follows:
a. In the Comments eld, modify or enter a comment, for example, as follows:
Comments: Chat
b. In the Event Response eld, click the Look Up icon, and associate the OnChatArrived event response with
the ChatArrived event handler.
85
Siebel Chapter 6
Chat Guide Conguring Siebel Chat Auto Answer
3. Click the Event Handlers Parameters tab, and congure the following records for ChatTransferArrived with the
values shown in the following table.
Name Value
Filter.Channel Chat
Filter.MsgType TYPE_NEW
FilterSpec [systemTransfer]>0
4. Navigate to the Administration - Communications screen, Congurations view, and then click the Event
Handlers tab.
5. Select the ChatTransferArrived record, and congure it as follows:
Comments: Chat
b. In the Event Response eld, click the Look Up icon, and associate the OnChatArrived event response with
the ChatTransferArrived event handler.
86
Siebel Chapter 7
Chat Guide Localizing Siebel Chat
The Chat Language Mapping view in Siebel Call Center is used to map third-party chat language IDs to standard Siebel
Call Center language code values.
To set up Siebel Chat for languages supported by third-party chat solutions, map the correct third-party chat language
ID to the appropriate Siebel Call Center language code, as described in the following procedure.
87
Siebel Chapter 7
Chat Guide Localizing Siebel Chat
For more information about adding an unshipped language to Siebel applications, see the topic about localizing
an unshipped language in Siebel Global Deployment Guide .
2. Localize the Siebel Customer Chat UI in the third-party chat server. This involves the following subtasks:
88
Siebel Chapter 8
Chat Guide Siebel Chat Deployment Using Third-Party Chat Solutions
89
Siebel Chapter 8
Chat Guide Siebel Chat Deployment Using Third-Party Chat Solutions
KBItemVisitedNum1 KBItemVisitedNum1 30
KBItemVisitedNum2 KBItemVisitedNum2 30
KBItemVisitedNum3 KBItemVisitedNum3 30
KBItemVisitedNum4 KBItemVisitedNum4 30
KBItemVisitedNum5 KBItemVisitedNum5 30
KBItemVisitedNum6 KBItemVisitedNum6 30
90
Siebel Chapter 8
Chat Guide Siebel Chat Deployment Using Third-Party Chat Solutions
KBItemVisitedNum7 KBItemVisitedNum7 30
KBItemVisitedNum8 KBItemVisitedNum8 30
KBItemVisitedNum9 KBItemVisitedNum9 30
KBItemVisitedNum10 KBItemVisitedNum10 30
91
Siebel Chapter 8
Chat Guide Siebel Chat Deployment Using Third-Party Chat Solutions
92
Siebel Chapter 9
Chat Guide Methods for Customizing Siebel Chat Process Flow and
Interface Functionality
93
Siebel Chapter 9
Chat Guide Methods for Customizing Siebel Chat Process Flow and
Interface Functionality
• UpdateWithBCField
• UpdateWithBCFieldEx
• UpdateWithChatData
AcceptChatEx
This method contains the update for the input argument. It is a newer version of the existing AcceptChat method. It is
used whenever a new or transferred chat is accepted to open the chat pane and dashboard and to update the activity
information, such as the Contact ID and Service Request ID. The following table shows the input PropertySet arguments
for AcceptChatEx.
ActivityId The row ID of the activity created by the CTI event log.
isTransfer (Optional) A value of 1 indicates a transferred chat. Any value other than 1 indicates a new inbound chat.
The following table shows the output PropertySet argument for AcceptChatEx.
94
Siebel Chapter 9
Chat Guide Methods for Customizing Siebel Chat Process Flow and
Interface Functionality
FindRecord
This method contains the update for the input argument. It is used to query records from a specic business
component according to the search specication. You can dene the business object name, business component name,
query eld value pairs, and value eld list. By default, the row ID of the query results is returned as output, but you can
dene more output by using the input value eld list. The following table shows the input PropertySet arguments for
FindRecord.
QueryFields A comma-separated eld list. This list indicates to use the eld name list to query the business
component. A corresponding key value pair must also be dened for the query search specication.
For example, if you dene Query Fields as follows (QueryFields = First Name, Last Name),
then you also must provide a list of key value pairs:
First Name and Last Name are the query eld names. John and Smith are the corresponding eld
values used for the query.
ValueFields (Optional) A comma-separated eld list, indicating the output eld name list. The default functionality is to
generate the row IDs of the query results, but you use this parameter to generate the other elds as
required.
The following table shows the output PropertySet arguments for FindRecord, which return the row IDs and value elds
dened by the input of the query results.
Id The row ID of the rst query record. You can query for more than one record by using the input
arguments, but this argument saves only the row ID of the rst record.
IsMultipleRecord A value of True indicates that the number of query records is greater than one.
<key, value> pair According to the values in the ValueFields input parameter, this method generates more eld values of
the rst query record.
95
Siebel Chapter 9
Chat Guide Methods for Customizing Siebel Chat Process Flow and
Interface Functionality
Example
If you want to query a contact by contact name and generate the contact row ID and work phone number, then the input
is as follows:
BusObj = Contact
BusComp = Contact
QueryFields = First Name, Last Name, xxx,
First Name = John
Last Name = Smith
Xxxx =
ValueFields = Work Phone #
FindRecordEx
This method contains the update for the input argument. This method is an enhanced version of the FindRecord
method and is used to query for multiple levels of business components. You can use this method to query for the child
business component according to the query results of the parent business components. The following table shows the
input PropertySet arguments for FindRecordEx.
Note: The order is important. The child business component must appear after the parent
business component.
<BusComp>:QueryField:XXX This is the query eld of the specic business component. The business component is listed in the
BusComp parameter. In the query, XXX is the query eld name of the business component. For
example, to query using the row ID of the Business Component Account, the argument values are as
follows:
Account:QueryField:Id
<BusComp>:ValueFields (Optional) A comma-separated eld list indicating the output eld name list of the specic business component.
The default functionality is to generate the row IDs of the query results, but you can use this parameter
to generate the other elds as required.
The output PropertySet for FindRecordEx includes the query results of all the business components dened by the
BusComp parameter. The query result for each business component is organized as a child PropertySet with the type
set to the business component name.
Example
If you want to query for a contact that belongs to a specic Account and the account has many associated contacts,
then you must use the work phone number to query the contact too. In this case, the input is as follows:
BusObj = Account
BusComp = Account, Contact Account:QueryField:Id = 42-FF6I6
96
Siebel Chapter 9
Chat Guide Methods for Customizing Siebel Chat Process Flow and
Interface Functionality
Contact:QueryField: Work Phone # = 123456789
GetActiveChatActId
This method is used to get the action row ID of the current active chat. The following table shows the output argument
for GetActiveChatActId.
GetChatDataByField
This method is used to get the chat data by eld name. The following table shows the input arguments for
GetChatDataByField.
InteractionId If an InteractionId is provided, then it indicates to set data to the related chat. If an InteractionId is not
provided, then it indicates to set data to the current chat.
FieldList The data eld names that you want to get, separated by a comma.
For each eld name in FieldList, there is a corresponding output argument with the same name.
GetLanguageCodeFromMapping
This method is a script method, and it is used to get the language code from the user dened mapping. The following
table shows the input argument for GetLanguageCodeFromMapping.
RequestSiteID The ID for the request site; that is, the customer site requesting to chat to an agent.
Language The language code for the request site. An example of the method code is shown after this table.
97
Siebel Chapter 9
Chat Guide Methods for Customizing Siebel Chat Process Flow and
Interface Functionality
GetSystemPreference
This method is used to query for the system preference. You must insert the system preference name, and
then the value is set to the output argument. The following table shows the input PropertySet arguments for
GetSystemPreference.
The following table shows the output PropertySet argument for GetSystemPreference.
98
Siebel Chapter 9
Chat Guide Methods for Customizing Siebel Chat Process Flow and
Interface Functionality
GetTransferredActivityDataFromDB
This method is used to query the parent activity record. The query is based on the interaction ID, and it applies only
to chat transfers. Generally, this method queries for the service request ID when a second agent accepts a chat. The
following table shows the input PropertySet arguments for GetTransferredActivityDataFromDB.
QuerySpec (Optional) This optional input argument applies if you want to redene your own query specications.
ValueFields This is a comma-separated eld list that indicates the output eld name list. If no Value Fields are
dened, then the default value is Activity SR Id.
The output PropertySet for GetTransferredActivityDataFromDB contains the key value pairs that are dened by the
ValueFields input parameter.
Example
When an agent accepts a transferred chat, the service request ID that Siebel automatically creates must be located. The
Chat Business Service by default uses the interaction to query the activity created by the rst agent (who transferred the
chat), and then to query for that activity to obtain the service request ID. The input is as follows:
InteractionId = 1234423545
ValueFields = Id,Primary Contact Id,Activity SR Id
InsertRecord
This method is used to insert a new record into a specic business component. You can dene the business object
name, business component name, and eld value pairs to be inserted as input. The row ID of the newly created record is
returned as output. The following table shows the input PropertySet arguments for InsertRecord.
Field: XXX The elds to be set. In this argument, you must replace XXX with the eld name.
Use Locale (Optional) A value of True or False indicates whether to format the value or not.
99
Siebel Chapter 9
Chat Guide Methods for Customizing Siebel Chat Process Flow and
Interface Functionality
The following table shows the output PropertySet argument for InsertRecord, which returns the row ID of the newly
created record.
Example
If you want to insert a new service request record with a contact ID of 04-LLSQ5, then the input is as follows:
BusObj = Service Request
BusComp = Service Request
Field: Contact Id = 04-LLSQ5
OpenView
This method is used to open a chat screen pop-up according to the following input information: business component
and view name. This method cannot be used directly and must always be called using the PushToToolbarCallFunction
method. The following table shows the input PropertySet arguments for OpenView.
Note: The ViewName must be associated with the business component dened in
ViewBusComp.
• If the value is set to OFF, then the search center is not populated.
• If the value is set to ON, then the search center is populated when there is no query result
according to the input ID.
• If the value is set to ALL, then the search center is always populated irrespective of whether the
query result is empty or not.
ViewNameEx (Optional) The default view name if AllowEmptyRecord is not set, or if it is set to False when the ID is empty or
invalid. The view must be associated with the business object dened in ViewBusObjEx.
100
Siebel Chapter 9
Chat Guide Methods for Customizing Siebel Chat Process Flow and
Interface Functionality
AllowEmptyRecord (Optional) If set to True when the ID is empty or invalid, then it indicates to go to the same view but with an empty
active record.
If set to False, then it indicates to go to the view according to the values in ViewNameEX,
ViewBusObjEx, and ViewBusCompEx.
Example
If you want to open the service request detail view by using the service request ID 42-DOOTG and the user wants to
open the search center when there is no such service request with ID 42-DOOTG in the database, then the input is as
follows:
ViewBusObj = Service Request
ViewBusComp = Service Request
Id = 42-DOOTG
ViewName = Service Request Detail View
SearchMode = ON
AllowEmptyRecord = FALSE
ViewBusObjEx = Service Request Home
ViewBusCompEx = Public and Private View Link
ViewNameEx = Service Request Screen Homepage View
OpenViewEx
This method is used to obtain the chat screen pop-up according to the following input information: business
component and view name. This method shows the record list, and it can be used to query more than one eld besides
the row ID. The following table shows the input arguments for OpenViewEx.
ViewName The name of the view to be populated. The view must be associated with the dened business
component.
101
Siebel Chapter 9
Chat Guide Methods for Customizing Siebel Chat Process Flow and
Interface Functionality
QueryFields The comma-separated list of eld names, which you want to use to query the view business
component. For each eld, there is an input argument for the query value.
NonEmptyQueryFields The comma-separated list of query eld names for which the query value cannot be empty. If the
query value for one of the elds is set to “ ”, then the query fails and no results are returned.
PostScreenPopRequest
This method is used to carry out the postrequest for the chat screen pop-up. The following table shows the input
PropertySet arguments for PostScreenPopRequest.
PreScreenPopRequest
This method is used to carry out the prerequest for the chat screen pop-up. The following table shows the input
PropertySet arguments for PreScreenPopRequest.
The following table shows the output PropertySet argument for PreScreenPopRequest.
HasBookmark Indicates whether or not a bookmark is enabled for the chat. A value of True indicates that the chat has
the bookmark feature enabled.
PushToToolbarCallFunction
This method is used to call a chat screen pop-up method, such as OpenView or RestoreMainViewFromBookmark.
This method is used, for example, if there are several asynchronous updates that must be made to the UI. By using
102
Siebel Chapter 9
Chat Guide Methods for Customizing Siebel Chat Process Flow and
Interface Functionality
PushToToolbarCallFunction to call chat screen pop-up methods, you ensure that all the methods are called one-by-one.
The following table shows the input PropertySet arguments for PushToToolbarCallFunction.
MethodName The name of the chat screen pop-up method to be called, such as OpenView.
InteractionId (Optional) The interaction ID for the chat. If IsQueued is set to True, then you must provide the InteractionID.
IsQueued (Optional) Indicates whether or not to queue the method. The method name is MethodName.
Except for this parameter, you must also enter all the necessary parameters for the chat screen pop-up method to be
called later.
RefreshChatPaneDashboard
This method is used to refresh the business component elds on the chat dashboard with the latest data. There are no
input or output arguments for RefreshChatPaneDashboard.
RestoreMainViewFromBookmark
This is an existing method that is used to populate screens using bookmarks. No inputs or outputs must be dened for
this method.
UpdateChatDataField
This method is used to update the eld in the Chat Data map with a given value. The following table shows the input
arguments for UpdateChatDataField.
InteractionId (Optional) The value in this argument is the interaction ID that you want to update if IsSingleChat is set to True.
The value in this argument is ignored if IsSingleChat is set to False.
IsSingleChat (Optional) If set to True, then it indicates to update the value provided for InteractionId. If set to False, then it
indicates to update the value for all chats. For new and transferred chats, IsSingleChat is always set to
True.
UpdateField The eld that you want to update in the Chat Data map.
103
Siebel Chapter 9
Chat Guide Methods for Customizing Siebel Chat Process Flow and
Interface Functionality
UpdateValue (Optional) The value that you want to update in the UpdateField. If UpdateValue is not provided, then an empty
string is used by default.
Example
If you want to update the ChatDisplayName eld in the Chat Data map with the default value for all chats, then the input
is as follows:
InteractionId =
IsSingleChat = FALSE
UpdateField = ChatDisplayName
UpdateValue =
UpdateChatDataFieldEx
This method is used to update the eld in the Chat Data map with the value in a business component eld. This method
is typically used as a preceding step for the UpdateWithBCFieldEx method. For example, if QueryField is set to the SR
Number business component eld in UpdateWithBCFieldEx and to the SRNumber value in the Chat Data map, then
the SRNumber value in Chat Data map expires if the agent associates a new service request with the chat activity. As a
result, you must update the SRNumber value in the Chat Data map before SR Number is used in UpdateWithBCFieldEx.
The following table shows the input arguments for UpdateChatDataFieldEx.
InteractionId (Optional) The value in this argument is the interaction ID that you want to update if IsSingleChat is set to True.
The value in this argument is ignored if IsSingleChat is set to False.
IsSingleChat (Optional) If set to True, then it indicates to update the value provided for InteractionId. If set to False, then it
indicates to update the value for all chats. For new and transferred chats, IsSingleChat is always set to
True.
BusComp The business component in the business object, for example, Action.
QueryFields The Query Field list to use to query the value in ValueField (for example, Id). You must provide the
value in Chat Data for the query eld. For example, provide the Activity Id in Chat Data for Id.
The comma-separated eld list indicates the eld name list to use to query the business component.
For query search specication, you must also dene a corresponding key value pair. For example, if
QueryFields is set to Id and Contact First Name, then a list of key value pairs must also be provided as
follows:
Id=Activity Id
104
Siebel Chapter 9
Chat Guide Methods for Customizing Siebel Chat Process Flow and
Interface Functionality
Id and Contact First Name are the query business component eld names. Activity Id and rstname are
the corresponding Chat Data elds.
UpdateField The eld that you want to update in the Chat Data map.
Value Field The business component eld that you want to get the value from.
Example
If you want to update the SRNumber eld in Chat Data map with the SR Number value in the Action business
component, Id is used as the query lter and is set to the value of the ActivityId eld in Chat Data map. That is, the
ActivityId value in Chat Data map is used as the query lter to query the Action business component record to obtain
the SR Number value in the Action business component record. The SR Number value is then used to update the SR
Number eld in Chat Data map, so that it has the latest value if a new service request is associated with the chat activity.
The ActivityId eld value in Chat Data map is not always changed in the chat session, but the SRNumber eld
value in Chat Data map is changed if a new service request is associated with the chat activity. Therefore, the
UpdateChatDataFieldEx method is used to update SRNumber before the SRNumber eld value in Chat Data map is used
in the next workow step. To update SRNumber for all chats, the input is as follows:
InteractionId =
IsSingleChat = FALSE
BusObj = Action
BusComp = Action
QueryFields = Id // the field of Activity Id in Action BC
Id = ActivityId // the field of Activity Id in Chat Data map
UpdateField = SRNumber // the field of SR Number in Chat Data map
ValueField = SR Number // the field of SR Number in Action BC
UpdateChatUIField
This method is used to update a eld in the chat UI with the value in the Chat Data map eld. The following table shows
the input arguments for UpdateChatUIField.
InteractionId (Optional) The value in this argument is the interaction ID that you want to update if IsSingleChat is set to True.
The value in this argument is ignored if IsSingleChat is set to False.
IsSingleChat (Optional) If set to True, then it indicates to update the value provided for InteractionId. False indicates to update
the value for all chats. For new and transferred chats, IsSingleChat is always set to True.
UpdateField This is the eld that you want to get the value from in Chat Data map. For example: ChatDisplayName
in Chat Data map.
105
Siebel Chapter 9
Chat Guide Methods for Customizing Siebel Chat Process Flow and
Interface Functionality
Example
If you want to use the ChatDisplayName eld in the Chat Data map to update the Chat Display Name in the chat UI for all
chats, then the input is as follows. For example, if a user wants to use Chat Data map eld, ChatDisplayName, to update
Chat Display Name in the Chat UI for all chats, then the input is as follows:
InteractionId =
IsSingleChat = FALSE
UpdateField = ChatDisplayName // the field of ChatDisplayName in Chat Data map
UpdateRecord
This method is used to update an existing record and a specic business component. You must provide the row ID as
input and the eld value pairs to be updated. The following table shows the input arguments for UpdateRecord.
Field: XXX The elds to be updated; replace XXX with the eld name.
Use Locale [optional] A value of True or False indicates if the value must be formaed.
The following table shows the output PropertySet argument for UpdateRecord, which returns the row ID of the newly
created record.
UpdateWithBCField
This method is used to update a eld in the Chat Data map with the value in a business component eld. The business
component must be included in the business object component of the Chat Related Data business object. For the
Service Request business component, there must be a link with Action. For other business components, there must be a
link with Service Request. The following table shows the input arguments for UpdateWithBCField.
106
Siebel Chapter 9
Chat Guide Methods for Customizing Siebel Chat Process Flow and
Interface Functionality
InteractionId (Optional) The value in this argument is the interaction ID that you want to update if IsSingleChat is set to True.
The value in this argument is ignored if IsSingleChat is set to False.
IsSingleChat (Optional) If set to True, then it indicates to update the value provided for InteractionId. False indicates to update
the value for all chats. For new and transferred chats, IsSingleChat is always set to True.
BusComp The business component list that is added to the business object component in the Chat Related Data
business object. For example:
UpdateField The eld that you want to update in the Chat Data map.
UpdateValue (Optional) The business component eld that you want to get the value from.
HasSetForAll (Optional) Indicates whether or not to set (or update) the value for all chats. If set to True, then all chats get the
update value.
Example
If you want to update ChatDisplayName in the Chat Data map with the Service Request Business Component Account
eld for all chats, then the Service Request Business Component must be included in the business object component in
the Chat Related Data Business Object, and it must be linked with Action. The input is as follows:
InteractionId =
IsSingleChat = FALSE
BusComp = Service Request
UpdateField = ChatDisplayName
ValueField = Account
UpdateWithBCFieldEx
This method is used to update the eld in the Chat Data map with the value in a business component eld. This
method is typically used together with the UpdateChatDataFieldEx. The following table shows the input arguments for
UpdateWithBCFieldEx.
InteractionId (Optional) The value in this argument is the interaction ID that you want to update if IsSingleChat is set to True.
The value in this argument is ignored if IsSingleChat is set to False.
107
Siebel Chapter 9
Chat Guide Methods for Customizing Siebel Chat Process Flow and
Interface Functionality
IsSingleChat (Optional) If set to True, then it indicates to update the value provided for InteractionId. False indicates to update
the value for all chats. For new and transferred chats, IsSingleChat is always set to True.
BusComp The business component name in the business object, for example, Service Request.
QueryFields The Query Field list that is used to query the value in ValueField (for example, SR Number). You must
provide the value in Chat Data for the query eld. For example, provide the SR Number in Chat Data for
SR Number in the business component eld.
The comma-separated eld list indicates the eld name list to use to query the business component.
For query search specication, you must also dene a corresponding key value pair. For example, if
QueryFields is set to Id and SR Number, then a list of key value pairs must also be provided as follows:
Id=Activity Id
SR Number = SRNumber
Id and SR Number are the query business component eld names. Activity Id and SRNumber are the
corresponding Chat Data elds.
UpdateField The eld that you want to update in the Chat Data map.
Value Field The business component eld that you want to get the value from.
HasSetForAll (Optional) Indicates whether or not to set (or update) the value for all chats. If set to True, then all chats get the
update value.
Example
You want to update ChatDisplayName in Chat Data map with the Service Request Business Component Account eld
for all chats, and you do not want to use the Chat Related Data Business Object in the method. For every business
component eld in QueryFields, you must provide the related Chat Data map eld to give the query value. In this
example, the QueryFields is the SR Number business component eld, so you must provide the related SRNumber
eld in the Chat Data map, so that it can get and use the SRNumber eld value as the QueryField value. The input is as
follows:
InteractionId =
IsSingleChat = FALSE
BusObj = Service Request
BusComp = Service Request
108
Siebel Chapter 9
Chat Guide Methods for Customizing Siebel Chat Process Flow and
Interface Functionality
QueryFields = SR Number // the field of SR Number in Action BC
SR Number = SRNumber // the field of SRNumber in Chat Data map
UpdateField = ChatDisplayName // the field of ChatDisplayName in Chat Data map
ValueField = Account // the field of Account in Action BC
UpdateWithChatData
This method is used to update a eld in the Chat Data map with the value in the (third-party chat) Chat Data eld. The
following table shows the input arguments for UpdateWithChatData.
InteractionId (Optional) The value in this argument is the interaction ID that you want to update if IsSingleChat is set to True.
The value in this argument is ignored if IsSingleChat is set to False.
IsSingleChat (Optional) If set to True, then it indicates to update the value provided for InteractionId. False indicates to update
the value for all chats. For new and transferred chats, IsSingleChat is always set to True.
UpdateField The eld that you want to update in the Chat Data map.
Value Field The business component eld that you want to get the value from.
HasSetForAll (Optional) Indicates whether or not to set (or update) the value for all chats. If set to True, then all chats get the
update value.
Example
If you want to update ChatDisplayName in the Chat Data map with the (third-party chat) rstname eld for all chats,
then the input is as follows:
InteractionId =
IsSingleChat = FALSE
UpdateField = ChatDisplayName // the field of ChatDisplayName in Chat Data map
ValueField = firstname // the field of firstname in Chat Data map
(third--party chat data)
109
Siebel Chapter 9
Chat Guide Methods for Customizing Siebel Chat Process Flow and
Interface Functionality
110