Requirements #
To use ~.UcClient.~ for Salesforce Lightning, the following requirements must be met:
~.Dimensions.~ #
Users must be assigned the following roles/permissions:
- Essential User
- CRM User
- Website Access
info
Both of these features are billable items on the ~.Dimensions.~ system. Please contact your reseller for information on pricing.
Browser #
~.UcClient.~ for Salesforce Lightning is supported on the following browsers:
- Chrome
- Firefox
- Edge (New Chromium version)
- Safari
Network Port Requirements #
The following network ports are used by the solution:
| Area | Port | Protocol | Description |
|---|---|---|---|
*.myreports.cloud |
443 | HTTPS | Standard HTTPS connection for all user sessions. |
Salesforce #
~.UcClient.~ can be used in the following versions of Salesforce:
- Essentials
- Professional
- Enterprise
- Unlimited
At the time of writing, the OpenCTI API does not use API request credits on Salesforce accounts. For reference purposes, details of the API calls made by the ~.UcClient.~ client are listed below.
~.UcClient.~ for Salesforce Lightning uses the OpenCTI API of Salesforce to provide the phone interface. Through this API, the following API calls are made by the application for each call:
| API Calls | Description | Usage |
|---|---|---|
| enableClickToDial | Used to allow users to dial from within Salesforce records | On startup |
| getCallCenterSettings | Used to query the softphone settings | On startup |
| isSoftphonePanelVisible | Used to identify softphone panel visibility | Before/after calls |
| notifyInitializationComplete | Used to notify Salesforce that ~.UcClient.~ is ready | On startup |
| refreshView | Used to show newly created 'Phone Call' tasks on screen | After calls |
| saveLog | Used to create 'Phone Call' tasks | After calls |
| screenPop | Used to pop a previously identified record | During calls or manually |
| searchAndScreenPop | Used to search for records to screen pop and display on the banner | During calls |
| setSoftphoneItemIcon | Used to set the phone icon | On startup |
| setSoftphonePanelLabel | Used to set the phone label | On startup |
| setSoftphonePanelVisibility | Used to update the phone panel visibility | Before/after calls |
Ensure that your Salesforce implementation has enough API calls to handle any extra load from the ~.UcClient.~ for Salesforce Lightning requests.
The following table outlines the expected number of API calls for each telephone call a user handles:
| Screen Pop Setting | Task Creation Setting | Estimated API Requests / Call |
|---|---|---|
| Enabled | Enabled | ~ 10 |
| Disabled | Enabled | ~ 9 |
| Enabled | Disabled | ~ 8 |
| Disabled | Disabled | ~ 7 |
warning
API requests per call are estimated and will be affected by manual user requests for popping records.