| Excerpt |
|---|
The Data Connector applet retrieves data from or sends data to Salesforce, an external web service, or a client's bespoke system. This data is then available in the form of a Data Source for use in subsequent applets in the interaction plan:
|
Data retrieved by Data Connector applets is also available for use by Data Source Mappings. For information about Data Source Mappings, see Data Source Mappings. Data Source Mappings can subsequently make data available to Dashboards. For information about viewing mapped data source data in Dashboards, see Viewing mapped data source data in DashboardsReal-time Analytics.
| Info |
|---|
Vonage Contact Center uses account feature toggles to enable reading and writing of data in external sources other than Salesforce. This page describes the functionality available using the Salesforce and Web Service interfaces. For information about how to use the Data Connector with custom interfaces, please contact support. |
...
| Expand | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Using the standard Salesforce interface, the Data Connector applet compares a single value that you specify—CLID, value in a previously found data source, or value entered in an IVR slot—to the value of a specified field of a specified object in Salesforce. If a match or matches are found, the applet retrieves the values of selected fields from the record or records and makes them available as Data Sources in the form Object Name | Field Name n. For example, you can configure the applet to use an account number stored in a data source to compare to the Account Number field of an Account object in Salesforce and find one or more records. If there is a match or matches, you can specify that the applet must retrieve data from the Customer Type field on the found record or records in Salesforce. For more information about retrieving data from Salesforce, see Retrieving data from Salesforce. If enabled for your Vonage Contact Center account, you can also create and update object records in Salesforce using the Data Connector applet—the applet uses the values you specify to populate the fields you choose, on the record you want to create or update. After a successful creation or update the applet makes the ID of the created or updated record available for subsequent applets in a data source. For information about creating or updating Salesforce records, see Creating a Salesforce record and Updating a Salesforce record. Salesforce Object Query Language (SOQL)Using the Salesforce interface you can use Salesforce Object Query Language (SOQL) to perform more complex queries to retrieve data from multiple objects, using multiple search criteria. You can retrieve almost any Salesforce data using any SOQL query that you can use in Salesforce itself. For information about using the advanced Salesforce interface, see Retrieving data from Salesforce using Salesforce Object Query Language (SOQL). You cannot create Salesforce records using SOQL. |
...
| Expand | ||
|---|---|---|
| ||
Using the standard Dynamics 365 interface, the Data Connector applet compares a value in a previously found data source to the value of a specified field of a specified object in Dynamics 365. If a match or matches are found, the applet retrieves the values of selected fields from the record or records and makes them available as Data Sources in the form Object Name | Field Name n. For example, you can configure the applet to use an account number stored in a data source to compare to the Account Number field of an Account object in Dynamics 365 and find one or more records. If there is a match or matches, you can specify that the applet must retrieve data from the Customer Type field on the found record or records in Dynamics 365. For more information about retrieving data from Dynamics 365, see Retrieving data from Microsoft Dynamics 365an integrated and linked CRM system. If enabled for your Vonage Contact Center account, you can also create and update object records in Dynamics 365 using the Data Connector applet—the applet uses the values you specify to populate the fields you choose, on the record you want to create or update. After a successful creation or update the applet makes the ID of the created or updated record available for subsequent applets in a data source. For information about creating or updating Dynamics 365 records, see Creating a Microsoft Dynamics 365 recordrecord in an integrated and linked CRM system and Updating a Microsoft Dynamics 365 recordrecord in an integrated and linked CRM system. |
Omni-Channel flows for SCV
...
| Field | Options | Description |
|---|---|---|
| Interface | List of available interfaces (in most cases just Salesforce and Web Service) | The interface to use to retrieve or send data. To interact with Salesforce, select Salesforce.
|
| Interface Failure | List of available applets | The For most interfaces, the applet that the call is routed to if the applet cannot connect to the interface or the interface returns an error. |
Action
...
For the Web Service interface, the applet that the call is routed to if the applet cannot connect to the external API. The Data Connector applet will try to connect to the API for 10 seconds before timing out. |
Action
(The availability and content of this section is determined by which interface you choose and the features enabled for your account.)
| Field | Options | Description | |||
|---|---|---|---|---|---|
| Action | List of operations available in the selected interface | Only available if you select Salesforce in the Based on the interface, available actions to perform. Subsequent sections' content depends on the operation you choose. In the case of Salesforce or Dynamics 365, if record creation and update are available for your account, you can switch between data retrieval, data sending, and record creation and update. To get Salesforce Data, select Get Salesforce Data. The Salesforce Match and Fields to Retrieve sections appear. To create a Salesforce record, select Create Salesforce Record. The Create Salesforce Record section appears. To update a Salesforce record, select Update Salesforce Record. The Update Salesforce Record section appears. To call a web service, select Call Web Service or one of any available templates for your account. To get Salesforce Data, select Get MS Dynamics Data. The MS Dynamics Match and Fields to Retrieve sections appear. To create a Salesforce record, select Create MS Dynamics Record. The Create MS Dynamics Record section appears. To update a Salesforce record, select Update MS Dynamics Record. The Update MS Dynamics Record section appears. To trigger get the target interaction plan name from a Salesforce Omni-Channel flow, select Trigger Get interaction plan name from Omni-Channel flow. The Data sourcesources, Omni-Channel flow settings, and Omni-Channel flow properties sections appear. | Use SOQL | Select, clear | To get the ID of the target agent from a Salesforce Omni-Channel flow, select Get agent ID from Omni-Channel flow. The Data sources, Omni-Channel flow settings, and Omni-Channel flow properties sections appear. |
| Use SOQL | Select, clear | Only available if you select Salesforce in the Interface list and if enabled for your account. Select Use SOQL to use SOQL to retrieve the required Salesforce data. For more information, see Retrieving data from Salesforce using Salesforce Object Query Language (SOQL). | |||
| Interface specific fields | Varies | Use custom fields to identify the value or values that the applet must use to identify the appropriate record or records. |
Record Match
...
Salesforce
| Info | ||
|---|---|---|
| ||
|
...
| Field | Options | Description | ||
|---|---|---|---|---|
| Salesforce Object | List of available Salesforce objects | The Salesforce object containing the field you are comparing to and the fields you want to retrieve. | ||
| *Find Salesforce Object Using | CLID, Data Source, IVR Slot | The source of the data to use to locate the appropriate Salesforce object record. Select CLID to use the caller's phone number to compare all phone number fields in the selected Salesforce object to find a match. Select Data Source to use a data source to find a match in a specific Salesforce field.
Select IVR Slot to use the value stored in an IVR Slot to find a match in a specific Salesforce field. | ||
| Match Data Source or IVR Slot | List of available Data Sources or IVR Slots | The specific Data Source or IVR Slot that contains the value you want to use to locate the appropriate Salesforce record. | ||
| against Salesforce Field | List of available Salesforce fields | The Salesforce field to use to match with the specified value to identify the required record. |
*If you select Data Source in the Find Salesforce Object Using field, the list in the Match Data Source or IVR Slot field, in which you select the actual data source to use, contains both IVR slot and data source names. IVR slot names are prefixed with 'IVR Slot|'. If you want to use an IVR slot value, we recommend that you select Data Source in the Find Salesforce Object Using field and then select the IVR slot name in the Match Data Source or IVR Slot field.
MS Dynamics
| Info | ||
|---|---|---|
| ||
|
| Field | Options | Description |
|---|---|---|
| Object | List of available Dynamics 365 objects | The Dynamics 365 object containing the field you are comparing to and the fields you want to retrieve. |
| Match Data Source | List of available Data Sources | The specific Data Source that contains the value you want to use to locate the appropriate Dynamics 365 record. |
| against Field | List of available Dynamics 365 fields | The Dynamics 365 field to use to match with the specified value to identify the required record |
Fields to Retrieve
...
| . |
Fields to Retrieve
| Info | ||
|---|---|---|
| ||
|
...
|
...
| Field | Options | Description | ||
|---|---|---|---|---|
| Retrieve Multiple Records | Select, clear | Determines whether or not to retrieve multiple records if multiple records are matched. For more information about retrieving multiple records, see the Retrieving multiple records section below. Select Retrieve Multiple Records to retrieve multiple records. | ||
| Maximum Number to Retrieve | Number | The maximum number of records to retrieve. This field only appears if you select the Retrieve Multiple Records check box.
| ||
| Add Field to Retrieve | List of available fields | Select a field or fields to retrieve from the matched record or records. |
| Anchor | ||||
|---|---|---|---|---|
|
| Expand | ||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||
The following table shows the next applet that the call is routed to at runtime as determined by multiple record settings.
The next table shows the data sources made available by this applet to subsequent applets. In this example, this applet retrieves Account ID and Contact ID.
|
Create Record
(Only available if you select the Salesforce interface and the Create Salesforce Record action or MS Dynamics interface and the Create MS Dynamics Record action. Salesforce
| Info | ||
|---|---|---|
| ||
You must also have this feature enabled for your account. |
...
For information about creating
...
Salesforce
...
records,
...
see Creating a
...
Salesforce
| Field | Options | Description | ||
|---|---|---|---|---|
| Object | List of available Salesforce objects | The Salesforce object that you want to create. Select the name of the object to create. Add Field appears. | ||
| Add Field | List of fields available for the selected object | The field in the Salesforce object that you want to populate. Select the name of the field. The field is added to a table. Source Type and Source appear.
Use Add Field to add as many fields as you want to populate. Each time you select the name of a field a new row is added to the table with corresponding Source Type and Source fields. | ||
| Source Type | Data Source, IVR Slot | The type of the source that contains the information you want to populate the field with. Select Data Source to get the information from the data source that you select in Source.
Select IVR Slot to get the information from the IVR Slot that you select in Source. | ||
| Source | List of available data sources or IVR Slots | The specific source of the information you want to populate the field with. Select the data source or IVR Slot. |
*If you select Data Source in the Source Type field, the list in the Source field, in which you select the actual data source to use, contains both IVR slot and data source names. IVR slot names are prefixed with 'IVR Slot|'. If you want to use an IVR slot value, we recommend that you select Data Source in the Source Type field and then select the IVR slot name in the Source field.MS Dynamicsuse an IVR slot value, we recommend that you select Data Source in the Source Type field and then select the IVR slot name in the Source field.
MS Dynamics
| Info | ||
|---|---|---|
| ||
You must also have this feature enabled for your account. |
For information about creating Dynamics 365 records, see Creating a record in an integrated and linked CRM system.
| Field | Options | Description | ||
|---|---|---|---|---|
| Object | List of available Dynamics 365 objects | The Dynamics 365 object that you want to create. Select the name of the object to create. Add Field appears. | ||
| Add Field | List of fields available for the selected object | The field in the Dynamics 365 object that you want to populate. Select the name of the field. The field is added to a table. Source appear.
Use Add Field to add as many fields as you want to populate. Each time you select the name of a field a new row is added to the table with corresponding Source field. | ||
| Source | List of available data sources | The specific source of the information you want to populate the field with. Select the data source. |
Update Record
...
Salesforce
| Info | ||
|---|---|---|
| ||
You must also have this feature enabled for your account. |
...
For information about updating Salesforce records,
...
...
...
| Section | Field | Options | Description | ||
|---|---|---|---|---|---|
| Object | List of available Salesforce objects | The Salesforce object that you want to update. Select the name of the object to update. The Object ID Field and Add Field list appear. | |||
Object ID Field
| |||||
| Field Name | Static text | Salesforce records store their unique IDs in a field. Field Name is the name of the ID field for the selected Salesforce object. Use the next two fields to identify the source of the data for this field. | |||
| Source Type | Data Source, IVR Slot | The type of source that the data you want to use is contained in. Click either IVR Slot or Data Source. The Source list is populated with sources of the selected type. | |||
| Source | List of available data sources or IVR Slots | The specific source of the information you want to update the field with. Select the data source or IVR Slot. | |||
| Add Field | |||||
| List of fields available for the selected object | The Add Field list contains the fields available on the selected object. Click the field you want to update. Use Add Field to add and update as many fields on the selected Salesforce object as you want. Each time you select the name of a field a new row is added to the table with corresponding Source Type and Source fields.
| ||||
| Fields to Update | |||||
Field Name | Static text | Contains the selected field. Use the next two fields to identify the source of the data for this field. | |||
| Source Type | Data Source, IVR Slot | The type of source that the data you want to use is contained in. Click either IVR Slot or Data Source. The Source list is populated with sources of the selected type. | |||
| Source | List of available data sources or IVR Slots | The source of the data. Click the source that contains the data for the field. | |||
*If you select Data Source in the Source Type field, the list in the Source field, in which you select the actual data source to use, contains both IVR slot and data source names. IVR slot names are prefixed with 'IVR Slot|'. If you want to use an IVR slot value, we recommend that you select Data Source in the Source Type field and then select the IVR slot name in the Source field.
MS Dynamics
| Info | ||
|---|---|---|
| ||
You must also have this feature enabled for your account. |
For information about updating MS Dynamics records, see Updating a record in an integrated and linked CRM system.
| Section | Field | Description | ||
|---|---|---|---|---|
| Object | The Object list contains the available Dynamics 365 objects. Click the object you want to update. The ID Field and Add Field list appears. | |||
Object ID Field
| ||||
| Field Name | Field Name is ID. Use the Source field to identify the source of the data for this field. | |||
| Source | The source of the data. Click the data source that contains the data for the field. | |||
| Add Field | The Add Field list contains the fields available on the selected object. Click the field you want to populate. The Fields to Populate section appears. Use Add Field to add and populate as many fields on the selected Dynamics 365 object as you want. | |||
| Fields to Populate | ||||
| Field Name | Contains the selected field. Use the Source field to identify the source of the data for this field. | |||
| Source | The source of the data. Click the data source that contains the data for the field. | |||
SOQL Editor
...
| Info | ||
|---|---|---|
| ||
You must also have this feature enabled for your account. |
...
| Field | Options | Description |
|---|---|---|
| Query | The SOQL query that describes what data to retrieve from Salesforce. For information about using SOQL to retrieve data from Salesforce using the Data Connector applet, see Retrieving data from Salesforce using Salesforce Object Query Language (SOQL). |
Web Service Interaction
| Info | ||
|---|---|---|
| ||
You must also have this feature enabled for your account. |
(Only available if you select the Web Service interface and the Call Web Service action. You must also have this feature enabled for your account.)
...
Request/Response Definition
...
| Info | ||
|---|---|---|
| ||
You must also have this feature enabled for your account. |
...
| Field | Description |
|---|---|
| Request | If present, the request area contains one or more request parameters. Specify a value for each of the available parameters. You can include placeholders to insert Data Source or custom configuration values into the request parameters. For more information, see Retrieving data from and sending data to a Web Service. |
| Response | If present, the response area contains one or more response values that the web service returns. Specify the locator for each of the response values. The value or values are stored in Data Sources for use later, if required, in your interaction plan. The names of the Data Sources are defined in the template. You will need to know the names of the Data Sources to use them. |
| Resulting Data Sources | If the web service returns one or more response values, the Resulting Data Sources section appears. Resulting Data Sources displays the created data sources and the data type. |
Data
...
sources
| Info | ||
|---|---|---|
| ||
|
...
You must also have this feature enabled for your account. |
...
| Field | Description |
|---|---|
| Interaction plan name | Type the name of an existing or new data source. This data source will contain the interaction plan that the Salesforce Omni-Channel flow returns. For more information, see Configuring Vonage Contact Center to use Salesforce Omni-Channel flows. |
| Agent ID | Type the name of an existing or new data source. This data source will contain the |
agent ID that the Salesforce Omni-Channel flow returns. For more information, see Configuring Vonage Contact Center to use Salesforce Omni-Channel flows. |
Omni-Channel flow settings
...
| Info | ||
|---|---|---|
| ||
|
...
You must also have this feature enabled for your account. |
...
| Field | Description |
|---|---|
| Dialed number | The original number that the caller dialed. Salesforce will use this to determine the Omni-Channel flow to use and the fallback queue if you do not specify them in Flow and Fallback queue. For more information, see Configuring Vonage Contact Center to use Salesforce Omni-Channel flows. |
| Flow | Optional. The developer name in Salesforce of an existing Omni-Channel flow that you want to route the inbound call to. If you don't already have a flow that you want to use, provide the name when you have created it. You need to provide a Flow if you have not created a channel in your call center, or if you want to override the Omni-Channel flow used for the dialed number. For more information, see Configuring Vonage Contact Center to use Salesforce Omni-Channel flows. |
| Fallback queue | Optional. The developer name or ID in Salesforce of the queue to use in case the Omni-Channel flow fails. You need to provide a Fallback queue if you have not created a channel in your call center, or if you want to override the Omni-Channel flow used for the dialed number. For more information, see Configuring Vonage Contact Center to use Salesforce Omni-Channel flows. |
Omni-Channel flow properties
...
| Info | ||
|---|---|---|
| ||
|
...
You must also have this feature enabled for your account. |
...
| Field | Description |
|---|---|
| Property name | Provide additional properties that the Omni-Channel flow can use in determining the target interaction plan. Click Add Row to add more properties. For more information, see Configuring Vonage Contact Center to use Salesforce Omni-Channel flows. |
| Value |
Routing
| Field | Options | Description |
|---|---|---|
| Successful Action | List of available applets | The applet that the call is routed to if the Data Connector is successful:
|
| Multiple Salesforce Matches / Multiple Matches | List of available applets | The applet that the call is routed to if the applet finds multiple matches for the chosen object in Salesforce or Dynamics 365. This field is only available if you select the Salesforce or MS Dynamics interface and is unavailable if you select Retrieve Multiple Records. |
| No Salesforce Match / No Match | List of available applets | The applet that the call is routed to if the applet finds no match for the chosen object in Salesforce or Dynamics 365. This field is only available if you select the Salesforce or MS Dynamics interface. |
...