WebAgent for Dynamics365 CIF v1.0 Actions and behaviors

Introduction

The below overview of the CIF v1.0 Entities and Actions available with the WebAgent for Dynamics365.

Dynamics CIF v1.0 entities

Below an overview of the entities that are used in the Dynamics365 CTI plugin:

  • Account
  • Case
  • Contact
  • Lead
  • Opportunity
  • Phonecall
  • Email
  • Task

  • Used for:

    • Search

    • Form

  • Used field(s):

    • telephone1

    • telephone2

    • emailaddress1

  • Used for:

    • Search

    • Create

    • Form

  • Used field(s):

    • description

    • emailaddress

    • caseorigincode

    • title

  • Used for:

    • Search

    • Form

  • Used field(s):

    • telephone1

    • telephone2

    • mobilephone

    • emailaddress1

    • firstname

    • lastname

  • Used for:

    • Search

    • Form

  • Used field(s):

    • telephone1

    • telephone2

    • emailaddress1

    • firstname

    • lastname

  • Used for:

    • Search

    • Form

  • Used field(s):

    • description

    • emailaddress

  • Actions:

    • Create

    • Update

    • Delete

  • Used field(s):

    • subject

    • directioncode

    • phonenumber

    • phonecall_activity_parties

    • statecode

    • actualstart

    • regardingojectid_incident

    • activityadditionalparams

  • Actions:

    • Create

    • Update

    • Delete

  • Used field(s):

    • subject

    • description

    • directioncode

    • email_activity_parties

    • sender

    • torecipients

    • statecode

    • actualstart

    • regardingobjectid_incident

    • actualdurationminutes

    • activityadditionalparams

  • Actions:

    • Create

    • Update

    • Delete

  • Used field(s):

    • subject

    • description

    • task_activity_parties

    • statecode

    • actualstart

    • regardingobjectid_incident

    • actualdurationminutes

    • activityadditionalparams

Search and open form Behavior

When getting a conversation the CTI plugin will search for entities to display.

The entity can be set drop down in the Settings, see: CRM Button bar

When to search

The timing can be configured via the setting "Search after accepting conversation":

  • Enabled = Only search after accepting a hunt.

  • Disabled = Search when a conversation offered. (hunt)

One entity found

When a single contact is found it will automatically populate a page.

The behavior for this can be configured via the setting "Single match: pop":

  • Enabled = When a single contact is found and setting is enabled, you can select which page to open:

    • Detail page

    • Activity page

  • Disabled = Do nothing when single contact is found.

Multiple entities found

When multiple entities are found it will automatically populate the search page with the results. From here you can select the desired entity and link the conversation.

The behavior for this can be configured via the setting "Multiple matches: Pop Details":

  • Enabled = When multiple entities are found, populate the search page.

  • Disabled = Do nothing when multiple entities is found.

No entity found

When no match is found it will automatically open a create new page.

The behavior for this can be configured via the setting "No Match: Pop page to create a new":

  • Enabled = When no match contact is found.

  • Disabled = Do nothing when no contact is found.

Create, link, and open behavior

When handling a conversation the following actions and behaviors are available:

Create Activity

When an entity is linked to the conversation, then an activity would automatically be created.

Based on the type of conversation a different activity will be created:

  • Audio conversation = PhoneCall

  • Email conversation = Email

  • Other conversation = Task

Note

Field that are available will be filled in, see Dynamics CIF v1.0 entities

Create Case

When an entity is linked to the conversation and no case is linked to the conversation, then the create case is available. Clicking on the button will open a "New Case" form.

Note

Field that are available will be filled in, see Dynamics CIF v1.0 entities

The case will automatically become linked to the conversation, this will result in the following behavior changes:

  • Link Case will become disabled.

  • Create Case will become disabled.

  • Open Case will become enabled.

Create Contact

When no entity is linked to the conversation, then the create contact button is available. Clicking on the button will open a "New Contact" form.

Note

Field that are available will be filled in, see Dynamics CIF v1.0 entities

The contact will automatically become linked to the conversation, this will result in the following behavior changes:

  • Create Contact will become disabled.

  • An activity will be created.

Link Case

When an entity is linked to the conversation and a case page is opened in CRM, then you can link the case to the conversation. Linking will result in the following behavior changes:

  • Link Case will become disabled.

  • Create Case will become disabled.

  • Open Case will become enabled.

Link Entity

When an entity is opened in CRM, you can link it. Linking will result in the following behavior changes:

  • Create Contact will become disabled.

  • An activity will be created.

Open Activity

When an entity is linked to the conversation, then an activity would automatically be created and can be opened via the open activity button.

Open Case

When a case is linked to the conversation, then the case can be opened via the open case button. This will open the corresponding page in CRM.

Open Entity

When a entity is linked to the conversation, then the case can be opened via the open entity button. This will open the corresponding page in CRM.

Unlink Case

When a case is linked to the conversation and the case page is opened in Dynamics 365, then you can unlink it. Un-linking will result in the following behavior changes:

  • (If the page is still open or another case is opened) Link Case will become enabled.

  • Create Case will become enabled.

Unlink Entity

When an entity is linked to a conversation, you can unlink it. Un-linking will result in the following behavior changes:

  • Create Contact will become enabled.

  • The created activity will be removed.

Dynamics 365 API methods

The Dynamics 365 CTI plugin, makes use of the following Dynamics 365 API's:

  • Microsoft.CIFramework.getEnvironment

  • Microsoft.CIFramework.setClickToAct

  • Microsoft.CIFramework.addHandler (onclicktoact and onpagenavigate)

  • Microsoft.CIFramework.setMode

  • Microsoft.CIFramework.searchAndOpenRecords

  • Microsoft.CIFramework.createRecord

  • Microsoft.CIFramework.updateRecord

  • Microsoft.CIFramework.deleteRecord

  • Microsoft.CIFramework.openForm

  • Microsoft.CIFramework.setWidth

More information can be found on: