TelephoneIntegration Client for MS CRM 2013 - mscrm

TelephoneIntegration Client for MS CRM 2013 - mscrm
TelephoneIntegration Client
for MS CRM 2013
Version 6.16 – October 2014
Client Installation and User Guide
(How to install and work with TelephoneIntegration Client for MS CRM 2013)
The content of this document is subject to change without notice.
“Microsoft”
and
“Microsoft
CRM”
are
registered
trademarks
of
Microsoft
All other product- and company names mentioned are trademarks of their respectful owners.
Inc.
Client Installation and User Guide
Table of Contents
1
USER GUIDE ........................................................................................................................................4
2
INTRODUCTION ................................................................................................................................4
3
INSTALLING THE TI-CLIENT FOR MS CRM 2013 ...................................................................5
3.1
Prerequisites .......................................................................................................................................................................5
3.2
Introduction........................................................................................................................................................................5
3.3
EULA (End User License Agreement) ........................................................................................................................6
3.4
Folder Selection ................................................................................................................................................................6
3.5
Start Options ......................................................................................................................................................................7
3.6
Confirm Installation .........................................................................................................................................................7
3.7
Install Windows Identity Foundation .......................................................................................................................8
3.8
Configure CRM-Connection ........................................................................................................................................8
3.9
Configure Integrations ................................................................................................................................................ 10
3.9.1
TAPI ........................................................................................................................................................................... 10
3.9.2
Skype ........................................................................................................................................................................ 10
3.9.3
OCS ............................................................................................................................................................................ 10
3.9.4
Lync2010 ................................................................................................................................................................. 10
3.9.5
Lync2013 ................................................................................................................................................................. 10
3.9.6
Simulation ............................................................................................................................................................... 10
3.9.7
RingCentral ...................................................................................................................................... 10
3.9.8
SDK API Plugin ...................................................................................................................................................... 11
3.9.9
InIn Wrapper: ......................................................................................................................................................... 11
3.10
4
4.1
5
Finish Installation .......................................................................................................................................................... 11
GETTING STARTED......................................................................................................................... 12
Starting the TelephoneIntegration Client ............................................................................................................ 12
THE USER INTERFACE ................................................................................................................... 13
5.1
How to enable or disable the DFR (dialing from relationship) ................................................................... 13
5.2
The TI Balloon ................................................................................................................................................................. 17
5.3
Integrated Search .......................................................................................................................................................... 18
5.4
The Context Menu ........................................................................................................................................................ 19
5.5
The Application Menu ................................................................................................................................................. 20
5.6
History Window ............................................................................................................................................................. 21
5.7
Personal Phone Book Window ................................................................................................................................ 21
6
MS CRM 2013 INTEGRATION .................................................................................................... 22
TelephoneIntegration for MS CRM 2013
Page 2
Client Installation and User Guide
6.1
Start an outgoing Call from MS CRM 2013 ........................................................................................................ 22
6.2
How to assign unresolved numbers to existing CRM records .................................................................... 25
6.3
How to set restrictions for dialing from a related CRM-record .................................................................. 27
7
USE TELEPHONEINTEGRATION WITH MS OUTLOOK ....................................................... 31
8
LOCALIZATION/CUSTOM LANGUAGE PACKS..................................................................... 34
9
CONFIGURATION SETUP ............................................................................................................. 35
9.1
Balloon Settings ............................................................................................................................................................. 41
9.2
TAPI..................................................................................................................................................................................... 42
9.3
Skype Wrapper ............................................................................................................................................................... 43
9.3.1
Skype Plugin Authorization ............................................................................................................................. 44
9.4
OSC Wrapper .................................................................................................................................................................. 48
9.4.1
OCS Transfer Call ................................................................................................................................................. 51
9.5
Lync2010 Wrapper ........................................................................................................................................................ 53
9.5.1
Lynch Transfer Call .............................................................................................................................................. 55
9.5.2
LyncChat .................................................................................................................................................................. 56
9.6
Lync2013 Wrapper ........................................................................................................................................................ 57
9.7
Simulation ........................................................................................................................................................................ 59
9.8
RingCentral Wrapper ................................................................................................................................................... 61
9.9
SDK API Plugin ............................................................................................................................................................... 64
9.10
Interactive Intelligence ................................................................................................................................................ 71
10 SETUP CONNECTION ................................................................................................................. 72
11 REPORTING AND POSSIBLE SYNCING ................................................................................... 73
12 POWER DIALER ............................................................................................................................... 74
12.1 Server-side Requirements ......................................................................................................................................... 77
12.1.1 Extended Phone Call Entity .............................................................................................................................. 79
12.2
Starting of Power Dialer ............................................................................................................................................. 79
12.3
Closing of Power Dialer Workplace ....................................................................................................................... 82
13 TROUBLESHOOTING ..................................................................................................................... 83
14 TELEPHONEINTEGRATION OVERVIEW .................................................................................. 84
15 CONTACT .......................................................................................................................................... 85
TelephoneIntegration for MS CRM 2013
Page 3
Client Installation and User Guide
1
User Guide
This guide gives detailed explanations of all functionalities provided by TelephoneIntegration for MS
CRM 2013.
If you need to reach us, see the Contact page.
2
Introduction
TelephoneIntegration for Microsoft CRM 2013 (TI) is a CRM Add On which enables you to connect
your Telephone System (CTI) to Microsoft CRM 2013.
This Guide contains important information about:

Installing the Client

The capabilities of the Balloon

Configuring the Client
TelephoneIntegration for MS CRM 2013
Page 4
Client Installation and User Guide
3
Installing the TI-Client for MS CRM 2013
3.1
Prerequisites
3.2
Introduction
Run the TelephoneIntegration Client for MS CRM 2013 Setup file. The following window will appear:
Click [Next] to proceed.
INFORMATION: If an upgrade is detected, a message will be shown and the setup will go to chapter
3.6 directly after accepting the EULA.
TelephoneIntegration for MS CRM 2013
Page 5
Client Installation and User Guide
3.3
EULA (End User License Agreement)
Click [Next] to proceed.
3.4
Folder Selection
Click [Change] to specify a different installation path
Click [Next] to proceed
TelephoneIntegration for MS CRM 2013
Page 6
Client Installation and User Guide
3.5
Start Options
Configure the start options and proceed with a click on [Next]
3.6
Confirm Installation
To start the installation, click on [Install].
To change the settings, click on [Back].
TelephoneIntegration for MS CRM 2013
Page 7
Client Installation and User Guide
3.7
Install Windows Identity Foundation
In order to use TI-Client for MS CRM 2013 you first have to install Windows Identity Foundation.
3.8
Configure CRM-Connection
To configure your CRM Server, select your Profile or create a new profile and select your CRM Server
type:
Choose the server path and add your login credentials by filling in the field’s username, password and
domain or choose the default credentials.
TelephoneIntegration for MS CRM 2013
Page 8
Client Installation and User Guide
As soon as the organizations are retrieved, press the “OK”-button.
If you save a new profile following window appears:
Click on [Save] to save your profile.
Click on Cancel if you don’t want to save the profile.
TelephoneIntegration for MS CRM 2013
Page 9
Client Installation and User Guide
3.9
Configure Integrations
There are seven possible interfaces that can be used with the TelephoneIntegration-Client:
3.9.1
TAPI:
direct connection via your telephone system. If an adequate driver is
installed, your phone-line will appear in the “Select Line”-list. For
configuration details see chapter 9.3
3.9.2
Skype:
allows using your Skype-account to handle calls. For configuration details,
see chapter 9.1.1
3.9.3
OCS:
allows using the OCS Wrapper to handle calls. For configuration details see
chapter 9.4
3.9.4
Lync2010:
allows using the Lync2010 Wrapper to handle calls. For configuration
details see chapter 9.5
3.9.5
Lync2013:
allows using the Lync2013 Wrapper to handle calls. For configuration
details see chapter 9.6
3.9.6
Simulation:
allows simulating an incoming and outgoing call. For configuration details
see chapter 9.7
3.9.7
RingCentral:
the RingCentral Wrapper provides a way for 3 Party tools to control TI
client behavior by incoming calls. For details see chapter 9.8
TelephoneIntegration for MS CRM 2013
rd
Page 10
Client Installation and User Guide
3.9.8
SDK API Plugin:
enables the connection between TelephoneIntegration Client and a .NET
application that can communicate with a specific phone device based on its
specific SDK with basic phone commands. (dialing/answering/ending the
call). For details see chapter 9.9.
3.9.9
InIn Wrapper:
enables the connection between TelephoneIntegration Client and the
Interactive Intelligence phone system. This plugin supports outgoing call.
Incoming calls are not yet supported. For details see chapter 9.10.
3.10 Finish Installation
Depending on the options defined in chapter 3.5 the Client will start automatically or can be started as
described in chapter 4.
Click on [Finish] to complete the installation.
TelephoneIntegration for MS CRM 2013
Page 11
Client Installation and User Guide
4
Getting Started
4.1
Starting the TelephoneIntegration Client
The application can be started via the windows-menu  All Programs  www.MSCRM-ADDONS.com
 TelephoneIntegration Client for MS CRM 2013 or from the Installation Directory.
It is possible to configure the TelephoneIntegration-client to automatically start on windows-startup.
Once started, an icon appears in the taskbar:
This gray icon with the
until the icon is colorized:
sign means that the application is loading/connecting to CRM. Please wait
The client is ready to use. Click on the icon to open the TI Balloon. See chapter 5.2
TelephoneIntegration for MS CRM 2013
Page 12
Client Installation and User Guide
5
The User Interface
5.1
How to enable or disable the DFR (dialing from relationship)
from TI
In general, TelephoneIntegration (TI) allows users to dial from related CRM-records. This means, that
they have the possibility, to choose from a list of records related to the initially opened one when
dialing out from CRM (e.g. from related leads, contacts, etc.). In regards to this you have now the
possibility to disable this feature.
There are two options, to enable or disable this feature on CRM:
Server-side or Client-side:
 Server-side means, that the whole TelephoneIntegrationServer-users could be set enable or
disable. If server-side is set disabled, no server-user could set his TI client enable.
 Client-side means, that just the TelephoneIntegration user could set his own TI client enable or
disable.
How to enable/disable DFR by Server-side:
 If you set this setting on "false", then the whole TelephoneIntegration server-users would be set
disabled from DFR.
 If you set this setting on "true", then all users of TelephoneIntegration are able to use DFR.
Server-side settings are overruling the client-side settings.
Client or Server setting are using the same key name: UseDFR
TelephoneIntegration for MS CRM 2013
Page 13
Client Installation and User Guide
Follow the steps below to to enable/disable DFR by Server-side:
Open CRM – go to “Microsoft Dynamics CRM” Logo on the left corner – click on settings
Click again on “SETTINGS” - go to the “Extensions Area” and click on “MSCRM-ADDONS.com
Products”.
This action will open following window:
Choose TelephoneIntegration and click on the dropdown button next to “TelephoneIntegration” in the
ribbon and open “MSCRM-ADDONS.COM SETTINGSKEYS”. See next screenshots:
TelephoneIntegration for MS CRM 2013
Page 14
Client Installation and User Guide
Click on “+ ADD NEW MSCRM-ADDONS.com Settingskeys”. See screenshot above.


Name: Type in “UseDFR” to enable or disable DFR.
KeyValue: If you set this setting on “false” the whole server-users, would be set disable.
If you set this setting on “true”, then all users are able to use this feature.
Click on [SAVE]
TelephoneIntegration for MS CRM 2013
Page 15
Client Installation and User Guide
How to enable/disable DFR by Client-side:
Open your TI client. Now you can create a new string. Name the new string “UseDFR”, then click twice
on your new string, after this, you have the change to set DFR enable or disable by “true” or “false”.
 If you set this setting on "false", then you will not be able to use DFR.
 If you set this setting on "true", then you will be able to use DFR.
000
TelephoneIntegration for MS CRM 2013
Page 16
Client Installation and User Guide
5.2
The TI Balloon
The “balloon” provides the main user-interface. It contains all client-side functionalities.
Open TI Setup
[number_textfield]
Shows
All/Answered/Dialed/Missed
calls …
Call status information
Phone number
Drag & Drop
Balloon
Close the Balloon
Find Entities in CRM or
Call the inserted number
[Ctrl] + [Enter]
CRM find results from the
search above.
Open the Context Menu
CRM data records details
Duration of the call
Called out from CRM site
Shows call status, incoming,
outgoing, missed calls
The Call-button, selects
your desired call-plugin
like OCS, TAPI, Skype or
Lync and press the Button
to call.
How to initiate an outgoing call?
 A call can be started by simply selecting the item (contact, account…) in the list and double click on
it. The “CRM” tab shows the search-results from CRM.
 Additionally, you can just type the number you want to call into the [number_textfield] and press
Ctrl+Enter or click on the Call button.
TelephoneIntegration for MS CRM 2013
Page 17
Client Installation and User Guide
5.3
Integrated Search
By using the Find button, it is possible to search for CRM-records from within the balloon. Therefore
there is no need to open CRM in order to call a contact, account, lead etc.
You can search it by name or by phone numbers.
TelephoneIntegration for MS CRM 2013
Page 18
Client Installation and User Guide
5.4
The Context Menu
Several CRM-functionalities are available in the context menu of a phone call:
If the user has no sufficient CRM-rights to create those records, these functionalities are automatically
disabled.
TelephoneIntegration for MS CRM 2013
Page 19
Client Installation and User Guide
5.5
The Application Menu
Right-click on the TI toolbar icon to open the Application-Menu. It provides the possibility to:

Open the balloon

Call the number that is saved in the clipboard (see screenshot)

Open Call-History (see chapter 5.6)

Open Personal Phone Book (see chapter 5.7)

Open Power Dialer (see chapter 11)

Show info (license state)

Drop call and reset (see screenshot)

Open Setup

Exit (shutdown the CTI client)
Quick-Call/Clipboard-Action:
The number saved in the clipboard
can be called from this menu directly.
Drop calls and reset:
The CTI will be restarted. In case of
any communication issues with the
connected call-info provider, chose
this functionality.
Setup the TelephoneIntegration
Configuration (chapter 9)
TelephoneIntegration for MS CRM 2013
Page 20
Client Installation and User Guide
5.6
History Window
The History provides an overview of all of your calls. It is accessible via the application menu (see
chapter 5.5). Those records are stored on the CRM server and cannot be deleted by the user.
You can also use redialing in History window by selecting the phone call record and pressing the [Call]
button.
5.7
Personal Phone Book Window
The Personal Phone Book is not part of the CRM. It helps you store information of any person that is
not in the CRM system, but you want to be resolved.
TelephoneIntegration for MS CRM 2013
Page 21
Client Installation and User Guide
6
MS CRM 2013 Integration
6.1
Start an outgoing Call from MS CRM 2013
By pressing on the [Call Number] button, the TI Clients balloon pops up with the available phone
numbers of the originated CRM data record, as well as with phone numbers of all related data records.
TelephoneIntegration for MS CRM 2013
Page 22
Client Installation and User Guide
If no related CRM-records are found and the originated CRM record has only one phone number, this
number will be immediately called.
Per default TI Client always search for related CRM-records if you do not set it otherwise.
You can disable searching for related CRM-records at server-side or on client-side layer.
Originated CRM data record, where we
pressed the [Call-Number] button
Available phone numbers from the
originated data record.
Look-ups of the originated data record.
Related data records with their phone
number lists.
TelephoneIntegration for MS CRM 2013
Page 23
Client Installation and User Guide
Search for related CRM-records is per default always enabled for all users.
However there are possibilities to completely enable or disable this feature on CRM server side or
locally on the client side.
Server-side "UseDFR" setting:
 If you set this setting on "false", then none of TI users will be able to use this.
 If you set this setting on "true", then all of TI users will use this feature.
If you did not set this setting on server-side layer, then per default every TI user will use it, except
those who will disable it locally. Server-side setting are overruling the client-side settings.
Client-side "UseDFR" setting in the local registry:
HKEY_CURRENT_USER\Software\PTM EDV-Systeme\TelephoneIntegrationclient2013
 If you set this setting on "false", then the local TI user will not be able to use this feature.
 If you set this setting on "true", then the local TI user will be able to use this feature.
Not setting this feature at all, is same as you would set it with "true".
If TI User is using DFR feature, then he can set additional restrictions for it server-side. (For more
information, please read our blog article)
TelephoneIntegration for MS CRM 2013
Page 24
Client Installation and User Guide
6.2
How to assign unresolved numbers to existing CRM records
TelephoneIntegration provides the possibility to assign unresolved numbers to already existing CRM
records (accounts, contacts and leads). To do so, you just have to right-click on the number to open
the context-menu. Then, chose “Add to Existing Entity” (see screenshot below).
TelephoneIntegration for MS CRM 2013
Page 25
Client Installation and User Guide
A search window will open in which you could search for and select the required CRM record (see
screenshot below). Afterwards, close the window and the number will be automatically added to one
of the CRM record’s phone fields.
IMPORTANT: These phone fields have to be configured as “search fields” in the TI Server configuration
tool.
Furthermore, you also have the possibility to create a new CRM record with the unresolved number
assigned to (see first screenshot).
TelephoneIntegration for MS CRM 2013
Page 26
Client Installation and User Guide
6.3
How to set restrictions for dialing from a related CRM-record
This means that they have the possibility to choose from a list of records related to the initially opened
one when dialing out from CRM (e.g. from related leads, contacts, etc.).
In regards to this, you have the possibility to set restrictions for the related records to be displayed in
the TelephoneIntegration balloon (e.g. In case of dialing out starting from an opportunity, you want
accounts and to be displayed, but not the related contacts and leads). In order to do so, you have to
create a new settings key.
Follow the steps below:
1. Open CRM – go to “Microsoft Dynamics CRM” Logo on the left corner – click on settings
2. Click again on “SETTINGS” - go to the “Extensions Area” and click on “MSCRM-ADDONS.com
Products”.
This action will open following window:
TelephoneIntegration for MS CRM 2013
Page 27
Client Installation and User Guide
3. (1) Click the checkbox in front of ‘TelephoneIntegration’ and then (2) click on ‘Edit’.
Screenshot: Edit TelephoneIntegration in the CRM Settings
4. A new CRM window will open:
TelephoneIntegration for MS CRM 2013
Page 28
Client Installation and User Guide
Within this window, (1) click on the dropdown-button next to TelephoneIntegration on the Top of the
window and navigate to ‘MSCRM-ADDONS.com Settingskeys’ on the top and (2) click on ‘Add New
MSCRM-ADDONS.com Settingskeys’.
This action will open following window:
Within this window click on “+ADD NEW MSCRM-ADDONS.com Settingskey”.
TelephoneIntegration for MS CRM 2013
Page 29
Client Installation and User Guide
5. A new window will open. Within this window, put a name and a KeyValue with the following
structure:
name: DFR_Disable_{entity name}
cached value: entity name1;entity name2; entity name3
Furthermore, set ‘IsCached’ as ‘yes’.
In our example (dialing out starting from an opportunity, accounts should be displayed, but not the
related contacts and leads), we have to type in the following (see screenshot below):
< "DFR_Disable_opportunity", "contact;lead" >
If you want to disable all subrelated data records (meaning that you do not want any related record to
be displayed), you have to set "*" within the ‘KeyValue’-field and ‘DFR_Disable_opportunity’ within the
‘Name’-field.
TelephoneIntegration for MS CRM 2013
Page 30
Client Installation and User Guide
7
Use TelephoneIntegration with MS Outlook
Users have the possibility to use TelephoneIntegration without a browser, but with Outlook only,
meaning that TelephoneIntegration will open all windows (e.g. the CRM-call-activity, etc.) in Outlook
and not in an internet browser window. For being able to use TelephoneIntegration with Outlook only,
you have to install TelephoneIntegration Client v.5.54 or higher and create a new settingskey.
Please follow the steps below to do so:
1. Open CRM – go to “Microsoft Dynamics CRM” Logo on the left corner – click on settings
2. Click again on “SETTINGS” - go to the “Extensions Area” and click on “MSCRM-ADDONS.com
Products”.
This action will open following window:
TelephoneIntegration for MS CRM 2013
Page 31
Client Installation and User Guide
3. (1) Click the checkbox in front of ‘TelephoneIntegration’ and then (2) click on ‘Edit’.
Screenshot: Edit TelephoneIntegration in the CRM Settings
4. A new CRM window will open:
5. Within this window, (1) click on the dropdown-button next to TelephoneIntegration on the Top of
the window and navigate to ‘MSCRM-ADDONS.com Settingskeys’ on the top and (2) click on ‘Add
New MSCRM-ADDONS.com Settingskeys’.
TelephoneIntegration for MS CRM 2013
Page 32
Client Installation and User Guide
This action will open following window:
6. Again, a new window will open. Within this window, put the name ‘UseOutlookOnly’ and
KeyValue ‘true’. Furthermore, set ‘IsCached’ as ‘yes’. (see screenshot below)
the
Restart the client. TelephoneIntegration will open all windows in Outlook instead of an internet
browser.
TelephoneIntegration for MS CRM 2013
Page 33
Client Installation and User Guide
8
Localization/Custom Language packs
To select another language pack, go into your installation path and search for the “Localization”Folder. You can install language files (XML-documents) here or change already existing language file.
To change values inside of the file open the XML-file and change the following Values and save the file
by closing it. You should make a backup-file of the file you are editing.
Important: Never change the Key attributes! Only change the values!
TelephoneIntegration for MS CRM 2013
Page 34
Client Installation and User Guide
9
Configuration Setup
To change the configuration start TelephoneIntegration Setup via the Application Menu
(chapter 5.5).
TelephoneIntegration for MS CRM 2013
Page 35
Client Installation and User Guide
Balloon general:
TI client distinguish between internal calls and external calls. Regarding on those two types, TI client
can determine if the phone call with that number should be processed or not. By processed it is meant:

Should the number be recognized (resolved) as a CRM record?

Should corresponded CRM entity open for that call?

Should Call Phone activity open for that call?
Internal calls are determined with the number length or with the domain name in case of SIP numbers.
In the figure below, internal calls are determined as those, who have a number length less than 4
digits, or who have a domain ptm-edv.at or mscrm-addons.com in their SIP numbers.
Below a sample is shown that by an incoming internal phone call the balloon should popup and the
number will be resolved with the exact match. By outgoing internal calls, only the balloon should
popup.
Minimum number digits length to define extern calls: Defines the minimum number length, which
has to be inserted to begin call processing. Calls that have less than the desired amount of digits will
not be checked in CRM for caller-information unless we explicitly allow it.
Internal Domains: Contains the internal domains for sip numbers you do not want to check in CRM
for additional information. For example:
On an incoming/outgoing call with the caller having a sip address sip:username@mscrm.addons.com
and you don’t want that this address to be resolved, you need to add “mscrm-addons.com” domain
into the text field.
Multiple domains are separated with semicolon “;”.
Show balloon popup: Defines should the TI Balloon popup by internal incoming or internal outgoing
calls.
Lookup number in CRM: Defines should the TI client search in CRM for record that matches this
phone number by incoming or outgoing calls.
Only exact matches: Shows only those records that are equal to the phone number. Otherwise it
shows
also
those
who
ends
with
the
searched
phone
number
digits.
Open internet explorer windows: Defines, should the general action settings for opening CRM
entities and Phone Call activities by also applied for internal incoming or internal outgoing calls.
TelephoneIntegration for MS CRM 2013
Page 36
Client Installation and User Guide
EXTERNAL INCOMING CALLS:
 Open Entity: Open the Entity in CRM that contains incoming caller data.
 Open Contact/Account on call: Defines whether a CRM record that contains the number that is
calling in should be opened automatically or not.
 Open phone call activity: if you are called and you lift the handset TI will create a Phone Call
Activity…
-
Generate new phone call activity (and always store it): stores it and opens
it for you.
-
Only show phone call activity: generates a new phone call activity without
storing.
-
For unrecognized: Phone Call Activity will open always when the incoming call is from an
unknown number, which is not stored under any contact in our CRM.
-
For personal numbers: Phone Call Activity will open always when the incoming call
from a known contact in our CRM.
comes
EXTERNAL OUTGOING CALLS:
 Open
Entity:
Open
the
Entity
in
CRM
that
contains
data
from
called
target.
 Open phone call activity: if you are caller and the called participant lift the handset TI will create a
Phone Call Activity…
-
Generate new phone call activity (and always store it): stores it and opens it for you
-
Only show phone call activity: generates a new phone call activity without storing.
TelephoneIntegration for MS CRM 2013
Page 37
Client Installation and User Guide
 For personal numbers: Phone Call Activity will open always when the outgoing call goes to a
known contact in our CRM.
INTERNAL BROWSER POPUP STYLE
TelephoneIntegration provides the possibility to automatically open CRM records and a new phonecall activity in separate Internet Explorer windows. Users can define the order and position of the CRM
record-window and the phone-call-activity-window.
Open the TelephoneIntegration setup with a right-click on the TI-icon located in the taskbar on the
bottom of your desktop. Within the setup, chose the “Behavior”-tab and go to the “Internet Browser
Popup Style”-section (see screenshot below).
Here you have several positioning-options (left to right, up to down, overlapping) and order-options
(show entity first, show phone call activity first). Select your favorite positioning- and order-option.
Changes are adopted immediately with the next call.
Screenshot: “Internet Browser Popup Style”-section within TelephoneIntegration setup
Screenshot: CRM record-window and phone-call-activity-window shown left to right
TelephoneIntegration for MS CRM 2013
Page 38
Client Installation and User Guide
Screenshot: CRM record-window and phone-call-activity-window shown up to down
Screenshot: CRM record-window and phone-call-activity-window shown overlapping

Show entity first: Internet Explorer window will shop up first with the displayed entity.

Show phone call activity first: Internet Explorer window will show up first with the phone call
activity
TelephoneIntegration for MS CRM 2013
Page 39
Client Installation and User Guide
OTHERS:

Activate Debugging: You find the log file under: C:\Programme (x86)\PTM EDV-Systeme
GmbH\Telephone Integration Client for MS CRM 2011\log\.

Removing leading Zero when calling

Launch CTI on system startup: Start TI automatically, as soon as computer boots.

Prevent outgoing call popup: When choosing this field, Popup-Balloon will not show up by
outgoing calls.

Prevent incoming call popup: When choosing this field, Popup-Balloon will not show up by
incoming calls.
TelephoneIntegration for MS CRM 2013
Page 40
Client Installation and User Guide
9.1
Balloon Settings
Balloon section

Maximum number of displayed call items.

Auto close balloon after inactive timeout: in minutes. If 0 then this feature is disabled.

Font size for displaying the CRM main value by incoming or outgoing call.

Font size for displaying the CRM result values by incoming our outgoing call.

AutoClose balloon after ending the call.
Search section

Return also entities that do not contain a phone number.
Position section

Horizontal offset (Default 0): Spacing between the CTI balloon and the right screen edge.

Vertical offset (Default 0): Spacing between the CTI balloon and the bottom screen edge.

[Check Position] use this button to see the final position of CTI balloon.

In case of using LyncWrapper, 100 is a minimum recommended value, otherwise the balloon and
the Lync client notification popup overlap.
Power Dialing Frequency

Time interval of refreshing the power dialer lists.
TelephoneIntegration for MS CRM 2013
Page 41
Client Installation and User Guide
9.2
TAPI
For using this layer, you need to have a valid TAPI driver installed on your computer. TAPI drivers are
PBX dependent, so please contact your PBX vendor for help. Before you proceed to
TelephoneIntegration Client setup, please check the installed TAPI driver with our TAPI Test Tool,
which can be found on our mscrm-addons.com web page under Download / TelephoneIntegration for
MS CRM 2011 section.
To be sure, you can also check by calling out over with the windows dialer.exe. If all goes well, then the
TAPI driver is working properly and the TelephoneIntegration Client will work fine with it. For users
who can access 2 TAPI lines at the same time, they can activate TAPI2 Wrapper.
TelephoneIntegration for MS CRM 2013
Page 42
Client Installation and User Guide
Settings

Activate: here you can activate/deactivate TAPI.

Default plugin: make TAPI default plugin (you can only have one default plugin)

TAPI Status: displays status of the TAPI-connection

Status: displays status of the TAPI-plugin
9.3
Skype Wrapper
PLUGIN CONFIGURTION
Settings section

Activate: Here you can enable/disable the Skype Plugin. This requires a restart of the application.

Default plugin: Make Skype Plugin to your Default Plugin. Checking this checkbox checks the
“Activate”-checkbox. Only one plugin can be the default plugin.
Skype Status section: Shows the current status of the Skype Plugin.

Status: Shows the current status of the Skype Plugin.
TelephoneIntegration for MS CRM 2013
Page 43
Client Installation and User Guide
9.3.1
Skype Plugin Authorization
Starting TelephoneIntegration
After starting TelephoneIntegration you will get an Authorization Request message from your SkypeClient (only for the first time):
Click on [allow Access] to proceed
TelephoneIntegration for MS CRM 2013
Page 44
Client Installation and User Guide
Manually Manage API Access Control
You have the opportunity to manually control the access of programs to the Skype client. The setting
can be found in “tools”  ”Options”  ”Advanced”:
1.
Click on “Manage other programs’ access to Skype”.
TelephoneIntegration for MS CRM 2013
Page 45
Client Installation and User Guide
2.
“Manually Manage API Access Control” pops up. Click on “Change” button:
TelephoneIntegration for MS CRM 2013
Page 46
Client Installation and User Guide
3. Choose if you want to allow the program access to the Skype Client.
TelephoneIntegration for MS CRM 2013
Page 47
Client Installation and User Guide
9.4
OSC Wrapper
TelephoneIntegration for MS CRM 2013
Page 48
Client Installation and User Guide
All fields marked with an asterisk ( * ) must be provided with the correct information, otherwise the
wrapper will not be able to sign into the OCS system properly.
A corresponding error message is shown if you are missing some values.
The login information should be provided as follows:

Active Directory Logon Name
o
Regular Active Directory username

Active Directory Password
o
Regular Active Directory user password

Domain
o
The Active Directory domain (e.g. mydomain.com)

Communications Server or Pool
o
OCS Frontend server name (e.g. ocs.mydomain.com)

Transport Type
o
Type of connection used by OCS system

User SIP URI
o
The SIP URI for that user.
(e.g. ‘sip:myFirstname.MySecondName@myDomain.com’)

Mediation/Remote Call Control Server
o
Mediation or telephone control
server
name
(e.g.
callcontrol.mydomain.com)

Enterprise Voice
o
A checkbox indicating if the Enterprise Voice configuration is configured for the OCS users. If
this is left unchecked, a Remote Call Control scenario is assumed to be set up.

Line URI
o
The Line URI from the telephony settings of the communications tab in the Active Directory
user configuration. Usually formatted similar to this: “tel:+43316123456123” or
“tel:+43316123456123;ext=123”.

Phone Number (w/o Extension)
o
The basic telephone number without extension (e.g. +43316123456). The extension is
usually a user’s internal telephone number.

Extension
o
The extension of the telephone or internal number that should be used to route calls to/from

Audio Input/output Devices
o
When using the Enterprise Voice feature of OCS, these fields can be used to select the audio
devices. This means it is possible to carry out an audio session from TI without having the
Office Communicator Client installed. However, this will only work for the OCS calls within
the Enterprise Voice environment. The Remote Call Control audio sessions use the
configured telephone.
TelephoneIntegration for MS CRM 2013
Page 49
Client Installation and User Guide
The “Load parameters from AD” button attempts to populate the fields from the Active Directory,
making the initial configuration easier. The values obtained from the Active Directory should be
checked before saving as this feature only provides a “best-effort” result. The Transport Type and
Enterprise Voice configuration are not read from the Active Directory.
The “Test” button allows you to test the connection using the newly entered credentials. It will take a
short while to complete the test and will give a success or failure message. During this test, the OCS
Wrapper will provide output on the “Log” tab. Any errors or problems that make the connection test
fail are reported here (the log is cleared before each test).
Per default the OCS Wrapper is not activated. Activating it will register UccApi.dll and this can
potentially cause conflicts with your Lync 2013 clients. Activate this only if you are sure that you do not
have Lync2013 client installed on your PC.
TelephoneIntegration for MS CRM 2013
Page 50
Client Installation and User Guide
9.4.1
OCS Transfer Call
Transferring the call
After accepting or initiating an audio call, you have the possibility, to transfer the existing active call to
a third party.
Type in a phone number and a new button will become visible in the bottom-right corner.
Request Transfer to
+4367684629071
By clicking on the button, a new call is being established from you to the third participant
+4367684629071. After the third party participant accepts your consulting call, you receive notification
about it and a new visible button (see next page). You can use that functionality for incoming and
outgoing calls.
TelephoneIntegration for MS CRM 2013
Page 51
Client Installation and User Guide
Connect Button
After the third party has agreed to accept the original call, press the Connect button to transfer the
initial call to the third party.
TelephoneIntegration for MS CRM 2013
Page 52
Client Installation and User Guide
9.5
Lync2010 Wrapper
For using the Lync2010 Wrapper, the user has to be logged in in Lync2010 or Lync2013 client.
Lync2013 Wrapper works only with Lync2013 clients. Both Lync Wrapper must not be activated at the
same time!!!
After that you can activate the Lynch2010 Wrapper
TelephoneIntegration for MS CRM 2013
Page 53
Client Installation and User Guide
Settings (Section)

Activate: Here you can activate/deactivate the Lync2010 Wrapper plugin that has a reference to
your installed and signed-in Microsoft Lync client. This requires a restart of the application.

Default plugin: Make Lync2010 Wrapper plugin to your default plugin. Checking this checkbox
checks the “Activate”-checkbox. Only one plugin can be the default plugin.
Lync Status (Section)

Status: Shows the current status of the Lync Plugin.
Lync Chat Integration (Section)

Activate: Here you can activate/deactivate LyncChat window where all InstantMessage
conversations are tabbed. LyncChat window cannot be closed unless you deactivate it.

Time delay for docking: Sometimes the Lync conversation window is not yet ready to be docked
into our LyncChat window and the conversation window appears as minimized. For that purpose a
user can set an amount of milliseconds to delay that action.
TelephoneIntegration for MS CRM 2013
Page 54
Client Installation and User Guide
9.5.1
Lynch Transfer Call
Having a connected call, you can transfer that call to a third party. For this you use the Transfer Call
button (see picture)
The third party to whom we
want to transfer the current
active session.
Current active call we want to
transfer on.
Transfer call button
After pressing the [Transfer Call] button, you are no longer in the call session.
The original call was transferred to the third party participant +4331668088037.
TelephoneIntegration for MS CRM 2013
Page 55
Client Installation and User Guide
9.5.2
LyncChat
The Lync Chat functionality allows you to have all your InstantMessage conversations collected on one
tab. Based on the sip address of the remote participant you can see its correspondent CRM record
(Contact, Lead, Account…)
The LyncChat window is divided into five logical sections.
First section represents Lync client control.
Second section shows all conversations tabs.
Third section shows CRM information for this lync contact.
Fourth section contains CRM related operations like:







Open CRM record in IE browser
Create new Contact, Lead or Account based on this lync contact.
Create new Case based on this lync contact.
Create new Letter activity based on this lync contact and the chat content.
Create new Chat activity based on this CRM record and the chat content.
Chat activity entity is generated with TI Server part v5.28 upwards.
Copy chat content to clipboard.
Fifth section contains a docked lync conversation window.
TelephoneIntegration for MS CRM 2013
Page 56
Client Installation and User Guide
9.6
Lync2013 Wrapper
For using the Lync2013 Wrapper, the user has to be logged in Lync2013 client. Lync2013 Wrapper
works only with Lync2013 clients. Both Lync Wrapper must not be activated at the same time!!!
After that you can activate the Lync2013 Wrapper:
Settings (Section)

Activate: Here you can activate/deactivate the Lync2013 Wrapper plugin that has a reference to
your installed and signed-in Microsoft Lync2013 client. This requires a restart of the application.

Default plugin: Make Lync2013 Wrapper plugin to your default plugin. Checking this checkbox
checks the “Activate”-checkbox. Only one plugin can be the default plugin.
TelephoneIntegration for MS CRM 2013
Page 57
Client Installation and User Guide
Lync Status (Section)

Status: Shows the current status of the Lync Plugin.
Lync Chat Integration (Section)

Activate: always activated.
Lync2013 Wrapper keeps track of every Lync2013 conversation window, where every Lync participant is
linked with the correspondent CRM record, based on its Lync SIP address. CRM field that contains Lync
SIP address needs to be configured as phone field.
TelephoneIntegration for MS CRM 2013
Page 58
Client Installation and User Guide
9.7
Simulation
To simulate an incoming call to CTI client, you can use the Simulation Wrapper by pressing the
Simulator button. For a simulation purposes you do not need to have any other wrapper activated.
Enter a phone number to simulate an incoming call.
TelephoneIntegration for MS CRM 2013
Page 59
Client Installation and User Guide
You can also simulate an outgoing call through our CTI client. Press the Simulation call button for this
purpose.
TelephoneIntegration for MS CRM 2013
Page 60
Client Installation and User Guide
9.8
RingCentral Wrapper
rd
RingCentral Wrapper provides a way for 3 Party tools to control TI client behavior by incoming calls.
The control is proceeding with calling the SoftPhoneAPI.exe with the proper parameters. The
SoftPhoneAPI.exe is a part of our TI client solution and is placed in the installation path of TI client.
rd
By 3 Party tool we refer to phone specific softphone that has direct access to user’s phone system
and is able to monitor the phone call state (offering, connected, disconnected) and to fetch the caller
number.
TI client
rd
Phone
System
observes
3 Party Tool
specific for target
phone system
TelephoneIntegration for MS CRM 2013
calls with
parameter
p#1 state
p#2 number
Soft Phone APi.exe
Page 61
Client Installation and User Guide
rd
The 3 party controller can be a softphone which extended configuration can call external applications
rd
with parameters. We don’t offer 3 party controller for your phone system. We just provide a possible
way to connect your phone system with our TI client addon.
This RingCentral Wrapper is suitable for scenario where you have a XY phone system that offers no
suitable TAPI driver, but it offers a customizable softphone that is able to call external applications.
The external call is done like following:
SoftPhoneApi.exe [paramValue1] [paramValue2]
paramValue1 presents the state of the call and paramValue2 the phone number.
The state is represent as
0 … for disconnected
1 … for connected
6 … for offering
Based on these simple values, combinations are possible as well:
60 ... for offered call that was disconnected right after
61 … for offered call that was connected immediately after
610 … for offered call that was connected and disconnected right after.
Let’s assume that you got an incoming call with a number 123456. Your softphone application will
recognize incoming offering state from a number 123456. At his point it should call the
SoftPhoneApi.exe with parameter 6 and parameter tel:123456. The prefix tel: can be omitted.
TI client will then try to resolve the number 123456.
If the user accepts the call, the phone controller should call the SoftPhoneApi.exe with parameter 1,,
that indicates the connected state. TI client will show the 123456 call as connected call.
If the user agents the call, the phone controller should call the SoftPhoneApi.exe with parameter 0, that
indicates the disconnected state. TI client will show the 123456 call as disconnected.
TelephoneIntegration for MS CRM 2013
Page 62
Client Installation and User Guide
Phone
Phone Controller
Incoming call notification
SoftPhoneApi.exe
Retrieve state of call and
number
exec SoftPhoneApi.exe 6 tel:123456
User accepts the call
Recognize param value 6 as incoming call state
and 123456 as a caller number
Connected event
User ends the call
exec SoftPhoneApi.exe 1 tel:123456
Recognize param value 1 as connected state and
opens IE CRM record that contains the 123456
telephone number
Disconnected event
exec SoftPhoneApi.exe 0 tel:123456
Recognize param value 0 as disconnected call state
Phone
TelephoneIntegration for MS CRM 2013
Phone Controller
SoftPhoneApi.exe
Page 64
Client Installation and User Guide
Restrictions:

RingCentralWrapper is not able to see outgoing calls that are being made from RingCentral
softphone.

RingCentralWrapper is able to initial outgoing calls over TI client balloon.

RingCentralWrapper is able to end outgoing calls that was made over the TI client balloon.

RingCentralWraper is not able to end outgoing calls that was not made over the TI client
balloon.
9.9
SDK API Plugin
SDK API plugin enables the connection between TelephoneIntegration client and a .NET application
that can communicate with a specific phone device based on its specific SDK with basic phone
commands:



dialing
answering
ending the call
It allows third-party agents to interact with TelephoneIntegration Client.
This plugin addresses the following question from users:
“I have a phone system for which there are no TAPI drivers, but I have a SDK .net API that enables me to
connect to my phone device and control it. Is there a way that I can connect it to your
TelephoneIntegration Client?”
And the answer is yes, but a small amount of programming skills is required.
TelephoneIntegration for MS CRM 2013
Page 72
Page 65
Client Installation and User Guide
The Phone API (left) component is not a part of TelephoneIntegration Client. It is phone specific
application that must be able of two things:

to control state of phone calls on the specific phone and pass it to TI client.
o Over SoftPhoneAPI.exe with proper parameters

to observe which commands the user triggers over the TI client and pass those to the specific
phones
o Over .net RegAPIObserver.dll library
Whatever happens on the phone device (ringing, dialing, connected or disconnected state), the Phone
API recognizes it and pass this information through SoftPhoneAPI.exe to TelephoneIntegration client.
Whatever command (dial, answer or hang up) the user presses on the TelephoneIntegration Clients
surface, Phone API can observe over the RegAPIObserver.dll library. The RegAPIObserver.dll library
contains CTICommandEvent that hold an information about a command that was executed on the TI
client.
Below is a code sample that needs to be integrated into Phone API application to observe commands
on TI client side. This is addressed also as a direction from TI client to the specific phone.
First a reference to RegAPIObserver.dll needs to be added. This DLL library remains in the
INSTALLATION path of TI client.
Then we can register to CTICommandEvents.
PTM.RegAPIObserver.Observer.SingeInstance.CTICommandEvent += CTICommandEventHandler;
And the handler method that should contain proper actions based on the command info.
TelephoneIntegration for MS CRM 2013
Page 65
Client Installation and User Guide
static void CTICommandEventHandler(object sender, TICommandEvent data)
{
System.Console.WriteLine(sender.ToString() + ": command: "
+ data.RequestedCommand.ToString() + " " + data.RequestedData);
switch(data.RequestedCommand)
{
case EnumCommand.Answer:
// happens when user wants to answer incomiong call over TI client
// call Answer command your specific phone device
// .....
break;
case EnumCommand.Dial:
string number = data.RequestedData;
// happens when user wants to dial out over TI client
// dial number on your specific phone device
// .....
break;
case EnumCommand.Drop:
// happens when user wants to drop or cancel the call over TI client
// call Drop call command on your specific phone device
// .....
break;
case EnumCommand.None:
break;
default:
break;
}
}
This covers the direction from TelephoneIntegration client to the specific phone device.
Now the sample of code for the direction from specific phone device to TI client.
Phone API should import he phone specific DLL that enables the application to work with the specific
phone device. After it connects to the phone device, the Phone API application should be able to catch
the following state events:




Dialing
Offering
Connected
Disconnected
TelephoneIntegration for MS CRM 2013
Page 66
Client Installation and User Guide
Based on the state of the phone device, the Phone API should pass this information on by executing
the SoftPhoneAPI.exe with following 3 parameters:
SoftPhoneAPI.exe /reg /state:state /tel:number
The parameter /reg is indicating that the ThirdPartyReg plugin is working with this call and not with
the RingCentral plugin.
The parameter number is the number that is being dialed or offered. It is mandatory
The parameter state can be:
 0 - for disconnected state
 1 - for connected state
 6 - for offering state
 3 - for dialing state
Also can there be combinations of it like:
 61 – for offered call that is immediately accepted
 60 – for offered call that is immediately rejected
 610 - for offered calls that is immediately accepted and ended.
 31 – for dialed call that is immediately answered
 30 – for dialed call that is immediately rejected
 310 – for dialed call that is immediately answered and dropped.
Let assume we have a XYZ phone system and a XYZ SDK API that enables us to write a XYZ Phone
Connector.
TelephoneIntegration for MS CRM 2013
Page 67
Client Installation and User Guide
In case XYZ phone device rings and the caller number is +43.316.680880-28, the XYZ Phone Connector
application should execute the SoftPhoneAPI.exe as
The TI client will show the offering state
When pressing the [ANSWER] button, the TelephoneIntegration Client would trigger the event
CTICommandEvent of class Observer in RegAPIObserver.dll which XYZ Phone connector can catch and
pass the ANSWER command to the XZY phone device.
If the user would press the [DECLINE] button, the TelephoneIntegration Client would trigger another
CTICommandEvent with command “DROP” and the XYZ Phone connector would catch this and pass it
on to XYZ phone device.
rd
If the user wants to dial over 3 Reg plugin, the TelephoneIntegration Client would trigger the
CTICommand Event of class Observer in RegAPIObserver.dll, which the XYZ Phone connector can catch
and pass the DIAL command with the number to the XYZ phone device.
TelephoneIntegration for MS CRM 2013
Page 68
Client Installation and User Guide
Below is a sequence diagram for an incoming call that is accepted and then ended through TI client balloon.
The red arrows are XYZ API specific.
The blue arrows indicate the connection between the XYZ Phone device and the TI Client.
TelephoneIntegration for MS CRM 2013
Page 72
Page 70
Client Installation and User Guide
Below is a sequence diagram for an outgoing call that is dialed from TI client balloon and then ended through XYZ phone device.
TelephoneIntegration for MS CRM 2013
Page 70
Client Installation and User Guide
9.10 Interactive Intelligence
InInWrapper enables dial out functionality for Interactive Intelligence phone system. The user needs to
configure its Interactive Intelligence profile:
 Username and password
 Server name
 Station Type and Name
 Phone number extension
TelephoneIntegration for MS CRM 2013
Page 72
Client Installation and User Guide
10
Setup Connection
In this section it is possible to change/alter the connection to the CRM server. Note, that in a “CRM
Server-Url” field you put in only a server name:port, without an organization name.
TelephoneIntegration for MS CRM 2013
Page 72
Client Installation and User Guide
11
Reporting and possible Syncing
All data for reporting and syncing is stored in the entity "MSCRM-ADDONS.com CTI Call History Entry".
Always available data:
ptm_duration: Duration of the phonecall in seconds
ptm_outboundcall: Flag indicating if the call is outbound. “True” on outbound, “False” on inbound
calls
ptm_phonenumber: Saves the phone number as delivered by the TAPI driver! It might not match the
formatting of the number saved with the entity referenced by ptm_entityid & ptm_entitytypecode.
ptm_startdatetime: UTC time of the start of the call, this is the time when the call was initiated.
ptm_userid: CRM User ID of the logged on user on the CTI.
ptm_wasconnected: True if the call was picked up on both end, false if the call as either denied or not
picked up at all.
Optional data:
ptm_entityid: If a crm entity is resolved, this field is storing the unique ID for the entity
ptm_entitytypecode: If a crm entity is resolved, this field is storing the typecode for the entity,
identifying the entitytype as defined in CRM (e.g. 1 for account) ptm_entityid & ptm_entitytypecode
always exists as a pair.
ptm_linkedactivityid: This field is holding the uniqueID of the CRM phone call activity, if the CTI client
is setup to always store a phonecall activity. This field is NOT available if you setup the CTI Client to
leave the choice of saving a phonecall to the user. This is the only definitive link between the phonecall
activity and the CTI Call history item.
Field Templates for internal use:
ptm_lastsyncdatetime: Unused by CTI, offers a standardized field for saving timestamps for syncing
operations you might want to do in your CRM. (Sync between the CTI Call History and the actual
phone calls is not part of CTI Product, as it is heavily depending on your own demands and workflows)
For synchronizing the phone-call duration with the actual duration as recorded in the
TelephoneIntegration
history
please
read
our
blog
article:
http://blogs.mscrm-
addons.com/post/2013/09/19/Synchronizing-Telephone-Integration-history-with-actualphonecalls.aspx
TelephoneIntegration for MS CRM 2013
Page 73
Client Installation and User Guide
12
Power Dialer
Power dialing is offering semi-automated call queues for CTI 2013.
Power dialing is based on CRM Campaign Activities or on a custom power dialer list entity.
Figure: campaign-activity based power dialing.
Figure: power dialer list based power dialing.
A server-side integration allows to mark CRM Campaign/Campaign Activities as power dialer lists. The
TI client can attach to and process the calls attached to these power dialing lists.
The base for the Power Dialer is the extended CRM Campaign/Campaign Activity entity. The Power
Dialer processes the phone calls created in the CRM call-campaign-activity. The term “Power dialing
list” refers to a CRM call-campaign-activity, marked as Power Dialing list.
Users participating in the Power Dialer are defined via the ownership of the created phone calls of a
CRM call-campaign-activity. This is either a specific user or a team. To assign multiple persons to a
Power Dialer, the creation of a team in CRM settings-area is mandatory.
TelephoneIntegration for MS CRM 2013
Page 74
Client Installation and User Guide
Creating a campaign activity based Power dialer list consists of following steps:
 Crate a marketing list of selected contacts, leads or accounts.
 Create a campaign and add the previously created marketing list.
 Create a campaign activity and distribute it to marketing list members by using the phone
channel.
Creating a Power dialer list based on custom power dialer list entity consists of following steps:
 Select contacts, accounts and lead in CRM view and press Creating Dialing Lists button in the
ribbon.

Fill out the form and press Create New or Add to existing.
TelephoneIntegration for MS CRM 2013
Page 75
Client Installation and User Guide

A new power dialer list record

User has to change adopt fields to its needs and then save the changes. Power dialer list
record is now ready for using it in clients Power Dialer.
Now the Power Dialing functionality must be enabled in the TI Server Configuration. For details please
read the next chapter.
TelephoneIntegration for MS CRM 2013
Page 76
Client Installation and User Guide
12.1 Server-side Requirements
For using the Power Dialing functionality, the Power Dialing functionality must be enabled in the TI
Server configuration. Changing this setting requires a restart of the client application.
The entity type of the recipient of the planned phone call must be included in the settings of
Telephone Integration Server Configuration. CTI ignores all entity types that are not enabled in the
Telephone Server Configuration.
TelephoneIntegration for MS CRM 2013
Page 77
Client Installation and User Guide
When creating a call-campaign-activity, we have to set following settings:
MSCRM-Addons Power Dialing
Please note, that the view shown in the screenshot above is only visible if you use the campaignactivity information form. See next example screenshot:

Active: The campaign-activity is enabled as Power Dialing list

PD List Name: The name of power dialing list. If none is set, the name of the campaign-activity is
taken.

Owner: The user or team who owns the campaign-activity.

Enable Automatic Dialing: The user gets a predefined amount of time for pre-processing the
call. When time runs low, the timer blinks red for alerting the user to act. In this preprocessing
state, the number is automatically dialing after the predefined time runs out.

Display CRM Forms: The user has access to the CRM phone-call activity form inside Power Dialer
window.

PreProcessing Time in seconds: Set a span in which the user can prepare for the next phone call.
If automatic dialing has been enabled, a call will be started after this time has run out.

PostProcessing Time in seconds: Set a span in which the user can finish the post-processing of a
call (Writing a summary, triggering further actions).
TI client periodically checks for changes in the CRM campaign-activities and applies the changes to the
CTI Client.
TelephoneIntegration for MS CRM 2013
Page 78
Client Installation and User Guide
12.1.1 Extended Phone Call Entity
New attributes are added to phone-call entity.


PDState: Collection of state values referring to power dialing.
-
Unprocessed
-
Claimed
-
Successful
-
Failed
-
Rescheduled
Reschedule: Define a date and time for the rescheduled phone-call.
12.2 Starting of Power Dialer
TI Client retrieves the server-side setting “UsePowerDialing” on StartUp. If power dialing is enabled, the
client checks for updates every minute. If any updates apply to the logged on user, a notification
window is displayed.
You can open the Power Dialer overview window by choosing “Power Dialer” in the Application Menu.
TelephoneIntegration for MS CRM 2013
Page 79
Client Installation and User Guide
A new window with a list of active campaign-activities appears with details for each campaign-activity.
This window is referred to as “Available Dialer Preview List”.

Name: The name of the campaign activity

Parent campaign: The name of the parent campaign

Owner: The owner of the campaign activity

All: The number of all planned phone calls that belong to the campaign-activity.

Processed: The number of all completed phone calls.

Rescheduled: The number of all rescheduled phone calls. These phone calls are still open.

Left: The number of all phone calls which have not been completed in this campaign-activity.

Claimed: The number of all claimed phone calls. Claimed means that somebody is processing this
phone call in this moment.

Automatic: If automatic dialing is enabled, the presets of preprocessing and postprocessing time
are handled via a countdown.

CRM Interaction: If activated, users can directly interact with the planned CRM phone-call
activity-form over embedded web controller.

First possible Call: Date of first possible call within a power dialer list. If we have only rescheduled
calls, then we take the earliest rescheduled date.

Is attached: Is the user executing this campaign-activity in this moment.
TelephoneIntegration for MS CRM 2013
Page 80
Client Installation and User Guide
Users can start (attach) to execute only one campaign activity at time. During that time, the default TI
balloon is disabled. The calls of a power dialer list are processed in a separate window, known as
“Power Dialer Workplace”. The window is divided into 4 sections (See image below)
Detaching is possible only if the PDL client is in Pause mode. User can only activate Pause mode in
preprocessing state.
A
C
B
D
Section A shows CRM information about the recipient of the planned phone call activity.
Section B shows the state of processing the phone call. Possible states are



Pre-processing (user can prepare for the call)
Active Conversation (during dialing and connected call)
Post-processing (after ending the call)
Preprocessing state
represents the state before the recipient is called. This time span is used to prepare for that call.
Preprocessing state can be attached to a timer.
Active Conversation state
represents the timespan from dialing to finishing the call.
Postprocessing state
represents the state where the call is summarized, e.g. defining the claimed call as successful, failed or
reschedule the call to another date. Setting the call as successful or failed, marks the call as completed.
TelephoneIntegration for MS CRM 2013
Page 81
Client Installation and User Guide
After you have selected one of the three options power dialer saves all user input into the existing call
activity, speaks to another, unfinished call as in the preparatory state of the next call.
The time required that a user needs for pre-and post-processing phase of a call will be stored in
'Actual preparation time "or" Actual work time ".
Section C shows statistics about the power dialing list, like the name of power dialing list, the total
number of all planned phone calls, the number of still open calls and the number of claimed phone
calls.
Section D shows the current call or a feedback option. If “Display CRM Forms” is disabled, the CRM
call-form will be replaced by a text-editor, which can be filled in by the users and which is saved as the
description of the phone-call activity associated with the actual call.
12.3 Closing of Power Dialer Workplace
For closing (detaching from) the Power Dialer Workplace window, the Power Dialer needs to be in
preprocessing state. Closing the window during an active conversation or postprocessing phase is not
possible.
After closing the window, the CTI balloon is enabled again.
TelephoneIntegration for MS CRM 2013
Page 82
Client Installation and User Guide
13
Troubleshooting
Blogs about troubleshooting TI client problems can be found here:
Q: How to generate debug log files?
http://blogs.mscrm-addons.com/post/2011/04/04/How-to-activate-debugging-for-TelephoneIntegration-for-MS-CRM-2011.aspx
Q: The TAPI wrapper makes no outgoing / incoming calls
http://blogs.mscrm-addons.com/post/2011/11/28/The-TAPI-wrapper-is-not-working-properly.aspx
Q: The Lync / OCS wrapper stop making outgoing calls.
http://blogs.mscrm-addons.com/post/2011/11/25/The-Lync-OCS-wrapper-stop-making-outgoingcalls.aspx
Q: How to find fields.xml settings?
http://blogs.mscrm-addons.com/post/2011/11/25/How-to-find-the-fieldsxml-settings.aspx
Q: The phone call activity or entity does not open.
http://blogs.mscrm-addons.com/post/2011/11/28/By-outgoing-calls-the-Entity-or-PhoneCall-activitywill-not-open-sometimes.aspx
Q: The CTI does not resolve the incoming / outgoing numbers correctly.
http://blogs.mscrm-addons.com/post/2012/03/02/CTI-does-not-resolve-phone-number.aspx
Q: Calling out from CRM by pressing Call Number button, does not react.
http://blogs.mscrm-addons.com/post/2011/11/28/Calling-out-from-CRM-Entity-by-pressing-CallNumber-button-triggers-no-reaction.aspx
Q: How to use TAPI Test Tool?
http://blogs.mscrm-addons.com/post/2012/03/12/TAPI-Test-Tool.aspx
Q: How does dialing the related CRM-Record work?
http://blogs.mscrm-addons.com/post/2013/03/25/Setting-restrictions-by-dialing-fromrelationships.aspx
Q: How to set restrictions for dialing from a related CRM-record?
http://blogs.mscrm-addons.com/post/2013/03/27/How-to-set-restrictions-for-dialing-from-a-relatedCRM-record.aspx
Q: How to rebuild the phone number index table?
http://blogs.mscrm-addons.com/post/2013/07/03/How-to-rebuild-phone-number-index-table.aspx
Q: How to synchronize phone-call duration
http://blogs.mscrm-addons.com/post/2013/09/19/Synchronizing-Telephone-Integration-history-withactual-phonecalls.aspx
TelephoneIntegration for MS CRM 2013
Page 83
Client Installation and User Guide
14
TelephoneIntegration Overview
TelephoneIntegration for MS CRM 2013
Page 85
Client Installation and User Guide
15
Contact
If you have questions to the product send an email to
support@mscrm-addons.com
or visit our blog
http://blogs.mscrm-addons.com
For shorten the time for solving the problem, it would be most helpful if you provide us with the
following information when sending an email.

The version number of your CTI client. Is it updated with the latest version?

Which communication layer you use? TAPI, Skype, OCS or Lync?

The content of file fields.xml.

The debug log file.
PTM EDV-Systeme GmbH,
Bahnhofgürtel 59,
A-8020 Graz, Austria
Tel US +1 404.720.6066
Tel Austria +43 316 680-880-0
Fax +43 316 680-880-25
www.ptm-edv.at
www.mscrm-addons.com
TelephoneIntegration for MS CRM 2013
Page 86
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertising