Considerations for creating a CTI adapter for Unified Service Desk

This topic provides information on things to consider while creating a computer telephony integration (CTI) adapter to make it work with Unified Service Desk.

CTI Control (softphone user interface) specification

To ensure that softphone and CTI user interface components will interoperate with Unified Service Desk, make sure of the following:

  • Controls are created using Windows Presentation Foundation (WPF), and are derived from the DynamicsBaseHostedControl class.

  • CTI controls are placed on CtiPanel panel in Unified Service Desk. The height of the control should be 23 to fit in CtiPanel. Larger controls may be used.

  • Multiple CTI control or user interface components can exist on CtiPanel. This is a horizontal stack panel so if you have multiple controls on this panel, they will appear next to each other.

Actions supported for telephony functions

A feature of Unified Service Desk is the ability to configure advanced application designs without programming. This kind of functionality is exposed through the concept of actions in Unified Service Desk. To support the idea of extending telephony control functions to buttons, agent scripts, and links in hosted applications, the system relies on actions being defined for capabilities exposed by the CTI adapter. This is done by exposing UII Actions in the CTI Desktop Manager hosted control of your CTI component. Each of these actions gives the administrator more control over the behavior of the application.

It is recommended that the following actions be defined and implemented in the CTI Desktop Manager hosted control.

Action Description
Dial The number to call. If this parameter is not provided, a dialpad will be displayed for the user to enter digits.

If the call is on an active call, this action would dial digits as if for an IVR.
Transfer This would initiate or complete a transfer. If a transfer has been initiated but not completed, this would transfer the call and ignore the parameter. If an active call is present, it would place the call on hold and make a new call passing the context data.
Conference This would initiate or complete a conference. If a conference has been initiated but not completed, this would conference the call and ignore the parameter. If an active call is present, it would place the call on hold and make a new call passing the context data.
Hangup This ends the current call.

Note

If these actions are supported by the CTI Desktop Manager hosted control, users will be able to trigger this functionality from a wide variety of locations within the application, thus providing a tightly integrated agent experience.

CTI screen pop

You must ensure the following while designing CTI screen pops in Unified Service Desk.

  • The following values must be populated in the CallInfo parameter of the CTIrequest.

    Parameter Description
    direction Specify “inbound” for incoming calls and “outbound” for outgoing calls.

    This is used by the system to allow the admin to specify different behavior depending on the direction of the call.
    Calltype Specify “phonecall” for voicecalls and “chat” for chat sessions..
  • CTI adapters should not automatically create activities in the Common Data Service platform because this is not always the desired behavior. Therefore, this should be left for the system administrators to configure.

    try  
    {  
      FireRequestAction(new RequestActionEventArgs("*", CtiLookuprequest.CTILOOKUPACTIONNAME,GeneralFunctions.Serialize<CtiLookupRequest>(data)));  
    }  
    

    Note

    It is assumed that the CTILOOKUPACTIONNAME be used for calling the CTI action, and that the application name will be "*", as shown in the example code.

Important

It is possible to create CTI adapters for Unified Service Desk that don’t follow the User Interface Integration (UII)CTI framework.

CTI searches are done using FetchXML in the Common Data Service platform. You can search using any data passed in any parameter from CTI against any field in your entity of choice in the Common Data Service platform. Searches are performed one rule at a time until a match is found. Once a match to a window navigation rule in Unified Service Desk is found, it will follow the guidance configured in the navigation rule for the next step. Typically, a rule is set up to open a session around the activity, and optionally display the activity in a tab. For more information about how to configure a window navigation rule to perform a CTIsearch, see Walkthrough: Use generic listener adapter for CTI events.

Let us configure a sample CTI search rule using the window navigation rule in Unified Service Desk. For more information about the window navigation rule, see Use window navigation rules in Unified Service Desk.

  1. Sign in to Unified Service Desk Administrator.

  2. Select Window Navigation Rules under Basic Settings.

  3. Select + New.

  4. Type a name and order for the window navigation rule. In the From box, select your CTI Desktop Manager hosted control.

  5. After you have selected your CTI Desktop Manager, the CTI options will be displayed starting with an initiating activity. The initiating activity field should contain the entity type passed from the CTI adapter. For example, it can be phonecall, chat, email, and so on. One rule only handles one type of activity from the CTI server.

  6. Select Save, and enable the fields required for the next steps.

  7. Under CTI Searches, select the search icon, and then select + New in the search box to define a new search criteria using the FetchXML query.

  8. In the New CTI Search screen, specify a name and order for the CTI search query. The direction field is Inbound or Outbound and is used to search against only a specific direction of CTI event. This direction is passed from the CTI adapter.

    Enter the required FetchXML query for the CTI search. Use the advanced find feature in the Common Data Service platform to create your initial search, and then download the FetchXML. The key field is often not available in the Common Data Service platform Advanced Find search, so you may find that you need to add that condition manually to the XML after you have exported it. You should also select the attributes that you’re interested to show up in the Unified Service Desk context. These show up immediately rather than be populated after pages load in the display like the other types of data parameters. Once you have the FetchXML you want, paste the text into the FetchXML box, and save the CTI search rule.

    New CTI search in Unified Service Desk

  9. The system will search each of your CTI search items for the rule. This can be thought of like a cross entity search. The conditions relate to the final result set and may, in the case of multiple results handling, indicate that one or more records were found from more than one entity type.

    Below the search list are three conditions and selections used to indicate what is to be done in each case.

    Condition Description
    No Matches What should the system do if no matches were found across all the searches specified in the rule.
    Single Match What should the system do when only one record is found as a result of the combined searches.
    Multiple Matches What should the system do if more than one result was found across all the searches.

    For each condition, there is a decision to be made regarding what to do.

    Decision Description
    Create Session then Do Action Creates a new session before firing a configured action. This action will be fired within the context of this new session.
    Create Session, Load Match then Do Action Creates a session, then loads the match into a tab or Entity Search based upon the selection in the Result Tab of the model-driven apps form. Finally, it calls an action. This option is only valid for single match.
    Do Action Tells the system to do nothing with the result, but optionally call a configured action specific to this condition. You can call the FireEvent action on Global Manager hosted control, if you want to call multiple actions in sequence as a result of this. This action will be fired in the context of the current session. No new session will be created.
    Next Rule Tells the system to ignore the rest of the processing of this rule and to look for other rules that may match. New searches will be performed against subsequent rule.

    Important

    Any time the system does not take the “Next Rule” option configured in your navigation rule, it will also execute the configured actions on the navigation rule itself. If you want to execute rules only in specific cases, you should use the action in that section. For general purpose actions, that should execute regardless of which choice is made, you might enter them in the actions list for the navigation rule.

Special features of chat events

When responding to chat events, some special things occur in the system. It is assumed that the CTI event data parameter “CTIDESKTOPMANAGERCONTROL” value is populated with the CTI Desktop Manager hosted control name and it supports the SendIM action. If the CALLTYPE passed into the CtiLookupRequest is “Chat”, Unified Service Desk will show an extra button on the agent scripting user interface. If the agent selects this button, it will attempt to invoke the SendIM action on the CTI Desktop Manager hosted control specified in the CTIDESKTOPMANAGERCONTROL control. It will pass the text of the agent script to this action, and it is assumed that the CTI Desktop Manager hosted control will write this text to the chat output.

See also

UII Computer Telephony Integration (CTI) framework
CTIDESKTOPMANAGERCONTROL
Create a CTI Desktop Manager
Use window navigation rules in Unified Service Desk
Walkthrough: Use generic listener adapter for CTI events