Restful Interfaces (RI) Variables
|
Variable |
Description |
|---|---|
|
IP Address of the Virtual Unit |
Virtual IP address, for information only. Address cannot be changed as it is defined when the virtual unit is created. |
|
Use Windows Authentication for Database Connections |
Specify whether Windows authentication should be used for database connections. The selection is on by default, and we recommend using it. With Windows authentication, you can leave database password fields empty. If you de select the option, SQL logon is used, and you must enter database user name and password for each database connection, and they are saved in registry and log files as plain text. |
|
Log File Directory of the Virtual Unit |
Software running in the virtual unit uses this directory for their log files. |
|
Configuration Database Server Address or Name |
By default, the value defined in database installation is used automatically. |
|
Configuration Database Name |
By default, the value defined in database installation is used automatically. |
|
Configuration Database User Name |
By default, the value defined in database installation is used automatically. |
|
Configuration Database Password |
By default, the value defined in database installation is used automatically. |
|
Directory Database Server Address or Name |
By default, the value defined in database installation is used automatically. |
|
Directory Database Name |
By default, the value defined in database installation is used automatically. |
|
Directory Database User Name |
By default, the value defined in database installation is used automatically. |
|
Directory Database Password |
By default, the value defined in database installation is used automatically. |
|
Operative Database Server Address or Name |
By default, the value defined in database installation is used automatically. |
|
Operative Database Name |
By default, the value defined in database installation is used automatically. |
|
Operative Database User Name |
By default, the value defined in database installation is used automatically. |
|
Operative Database Password |
By default, the value defined in database installation is used automatically. |
|
Outbound Database Server Address or Name |
By default, the value defined in database installation is used automatically. |
|
Outbound Database Name |
By default, the value defined in database installation is used automatically. |
|
Outbound Database User Name |
By default, the value defined in database installation is used automatically. |
|
Outbound Database Password |
By default, the value defined in database installation is used automatically. |
|
Monitoring Database Server Address or Name |
By default, the value defined in database installation is used automatically. |
|
Monitoring Database Name |
By default, the value defined in database installation is used automatically. |
|
Monitoring Database User Name |
By default, the value defined in database installation is used automatically. |
|
Monitoring Database Password |
By default, the value defined in database installation is used automatically. |
|
Reporting Database Server Address or Name |
By default, the value defined in database installation is used automatically. |
|
Reporting Database Name |
By default, the value defined in database installation is used automatically. |
|
Reporting Database User Name |
By default, the value defined in database installation is used automatically. |
|
Reporting Database Password |
By default, the value defined in database installation is used automatically. |
|
TCP Port Number for HTTP |
The HTTP port number for Restful Interfaces (Tomcat). |
|
TCP Port Number for HTTPS |
The HTTPS port number for Restful Interfaces (Tomcat). The default value is 443. |
|
Certificate for External Password Encryption |
Enter the name of the certificate used for encrypting passwords for e-mail and SMS. This certificate must be installed on the server(s) where the Agent Server and Restful Interface packages are installed. In the Restful Interfaces package, this variable is only used by Restful Configuration Interface (RCI).Added in 1708. |
|
Tomcat Startup Extra Parameters |
Enter additional Java Virtual Machine parameters and separate them with space. By default there is one that enhances the memory allocation to 512 MB. |
|
Keystore Settings | |
|
Keystore Type |
Choose the type of the options in pull-down menu:
|
|
Define these settings if you have chosen Java Keystore File in Keystore Type. |
|
|
Certificate Name for HTTPS |
Certificate must be for server authentication ([EnhancedKeyUsageExtension] value OID = 1.3.6.1.5.5.7.3.1 must be used in request). When using Java keystore: enter alias. When using Windows Personal Certificate Store: enter Common Name of the certificate, and install the certificate into Personal Certificates of the user who is running HAC services. |
| First Supported Issuer for oAuth, Second Supported Issuer for oAuth, and Third Supported Issuer for oAuth | |
| Issuer | This is the supported oAuth issuer. The URL format of the Cognito user pool
issuer is the following: https://cognito-idp.[region].amazonaws.com/[user pool ID] in which [region] is the Cognito user pool region and [user pool ID] is the cognito user pool. |
| Client IDs | Enter a comma-separated list of supported app client IDs. |
| JSON Web Key Sets (JWKS) Settings for oAuth | |
| Cache Size | Define the size of the JWKS cache. The default value is 10. To disable caching, set the value as 0. |
| Cache Timeout (min) | Define the size of the JWKS cache in minutes. The default value is 120. To disable caching, set the value as 0. |
| Rate Limit Bucket Size | Define the rate limit bucket size for JWKS. The default value is 10. To disable limitation, set the value as 0. |
| Rate Limit Refresh Rate (sec) | Define the rate limit refresh rate in seconds for JWKS. The default value is 60. To disable limitation, set the value as 0. |
| Connection Timeout (msec) | Define connection timeout in milliseconds for loading JWKS. |
| Read Timeout (msec) | Define read timeout in milliseconds for loading JWKS. |
|
Restful Configuration Interface (RCI) | |
|
Enable Restful Configuration Interface (RCI) |
Enable RCI requests. |
|
Allow RCI Requests with Basic Authentication |
Enables using HTTP basic authentication scheme for incoming RCI requests. |
|
RCI Anonymous Access |
Defines whether incoming RCI requests may proceed without authentication. The choices are:
|
|
Logon ID for Anonymous RCI Requests |
Use only when local or remote anonymous requests are allowed. |
|
Allow RCI Requests with oAuth Authentication |
Enables using oAuth authentication scheme for incoming RCI requests. |
|
OAuth Authentication Anonymous Access |
Whether anonymous oAuth access is allowed. Normally when anonymous oAuth access is not allowed, then the oAuth user is used after validating the user certificate subject and issuer in Contact Center system. If anonymous oAuth access is allowed, then the user configured below is used instead. |
|
Realm Name |
The Tomcat’s realm name for identifying the users of RCI. The default value is SAP Contact Center Authentication. |
|
Generate Phone for Users |
By default phone number is not automatically generated for users, but a user is required to have a phone number even if only chat channel is used. To enable the phone number creation, it is possible to give 0 value to phone field (in both POST and PUT to /users). To make the phone number creation completely automatic, this setting can be enabled. Then user will always get an internal phone number in POST to /users and PUT to /users/id. |
|
Default User Settings Template Name for Users |
This is the default User Settings Template name for new and updated users, unless there is ’settings’ field given in POST to /users and PUT to /users/id. The default value is CEC Agent. |
|
Restful Task Interface (RTI) | |
|
Enable Restful Task Interface (RTI) |
Enable RTI requests. Note that this interface requires that the Integration Interfaces package is installed as well and Task Manager Interface (TMI) is enabled. |
|
Allow RTI Requests with Basic Authentication |
Enables using HTTP basic authentication scheme for incoming RTI requests. |
|
RTI Anonymous Access |
Defines whether incoming RTI requests may proceed without authentication. The choices are:
|
|
Logon ID for Anonymous RTI Requests |
Use only when local or remote anonymous requests are allowed. |
|
Allow RTI Requests with oAuth Authentication |
Enables using oAuth authentication scheme for incoming RTI requests. |
|
OAuth Authentication Anonymous Access |
Whether anonymous oAuth access is allowed. Normally, when anonymous oAuth access is not allowed, the oAuth user is used after validating the user certificate subject and issuer in Contact Center system. If anonymous oAuth access is allowed, the user is configured below is used instead. |
|
Realm Name |
The Tomcat’s realm name for identifying the users of RTI. The default value is SAP Contact Center Authentication. |
|
TMI address in Integration Interfaces |
Enter TMI address in Integration Interfaces, for example, http://ip:port/TMI/. |
|
Restful Monitoring Interface (RMI) | |
|
Enable Restful Monitoring Interface (RMI) |
Enable RMI requests. |
|
Allow RMI Requests with Basic Authentication |
Enables using HTTP basic authentication scheme for incoming RMI requests. |
|
RMI Anonymous Access |
Defines whether incoming RMI requests may proceed without authentication. The choices are:
|
|
Logon ID for Anonymous RMI Requests |
Use only when local or remote anonymous requests are allowed. |
|
Allow RMI Requests with oAuth Authentication |
Enables using oAuth authentication scheme for incoming RMI requests. |
|
OAuth Authentication Anonymous Access |
Whether anonymous oAuth access is allowed. Normally when anonymous oAuth access is not allowed, then the oAuth user is used after validating the user certificate subject and issuer in Contact Center system. If anonymous oAuth access is allowed, then the user configured below is used instead. |
|
Realm Name |
The Tomcat’s realm name for identifying the users of RMI. The default value is SAP Contact Center Authentication. |
|
C4C Analytics Upload The following C4C Analytics Upload variables enable uploading monitoring data form Sinch Contact Pro via RMI to SAP Service Cloud (C4C). The sent data set is QUEUE;ABANDONEDCALLRATE;SLA;CONTACTS;SERVING;MAXWAITINGTIME; | |
|
Enable C4C Analytics Upload |
Enable C4C Analytics Upload. Added in 1611 |
|
C4C Analytics URL |
C4C Analytics SOAP URL for uploading monitoring data, for example https://myXXXXXX.crm.ondemand.com/sap/bc/srt/scs/sap/analyticsdatauploadin |
|
C4C Analytics MDAVName |
C4C Analytics Cloud Data Source name |
|
C4C Analytics Delay |
C4C Analytics upload delay in milliseconds. |
|
C4C Analytics Proxy Server |
The proxy server for outgoing C4C Analytics requests. |
|
C4C Analytics Proxy Port |
The proxy port for outgoing C4C Analytics requests. |
|
C4C Analytics User Name |
C4C Analytics user name for basic authentication. |
|
C4C Analytics Password |
C4C Analytics password for basic authentication |
|
License Reporting Interface (LRI) | |
|
Enable License Reporting Interface (LRI) |
Enable LRI requests. |
|
Allow LRI Requests with Basic Authentication |
Enables using HTTP basic authentication scheme for incoming LRI requests. |
|
LRI Anonymous Access |
Defines whether incoming LRI requests may proceed without authentication. The choices are:
|
|
Logon ID for Anonymous LRI Requests |
Use only when local or remote anonymous requests are allowed. |
|
Allow LRI Requests with oAuth Authentication |
Enables using oAuth authentication scheme for incoming LRI requests. |
|
OAuth Authentication Anonymous Access |
Whether anonymous oAuth access is allowed. Normally when anonymous oAuth access is not allowed, then the oAuth user is used after validating the user certificate subject and issuer in Contact Center system. If anonymous oAuth access is allowed, then the user configured below is used instead. |
|
Realm Name |
The Tomcat’s realm name for identifying the users of LRI. The default value is SAP Contact Center Authentication. |
|
Restful Directory and Presence Interface (DPI) Added in 1611. | |
|
Enable Restful Directory and Presence Interface (DPI) |
Enable DPI requests. |
|
Allow DPI Requests with Basic Authentication |
Enables using HTTP basic authentication scheme for incoming DPI requests. |
|
DPI Anonymous Access |
Defines whether incoming DPI requests may proceed without authentication. The choices are:
|
|
Logon ID for Anonymous DPI Requests |
Use only when local or remote anonymous requests are allowed. |
|
Allow DPI Requests with oAuth Authentication |
Enables using oAuth authentication scheme for incoming DPI requests. |
|
OAuth Authentication Anonymous Access |
Whether anonymous oAuth access is allowed. Normally when anonymous oAuth access is not allowed, then the oAuth user is used after validating the user certificate subject and issuer in Contact Center system. If anonymous oAuth access is allowed, then the user configured below is used instead. |
|
Realm Name |
The Tomcat’s realm name for identifying the users of DPI. The default value is SAP Contact Center Authentication. |
|
Restful Contact Management Interface (CMI) | |
|
Enable Restful Contact Management Interface (CMI) |
Enable CMI requests. |
|
Allow CMI Requests with Basic Authentication |
Enables using HTTP basic authentication scheme for incoming CMI requests. |
|
CMI Anonymous Access |
Defines whether incoming CMI requests may proceed without authentication. The choices are:
|
|
Logon ID for Anonymous CMI Requests |
Use only when local or remote anonymous requests are allowed. |
|
Allow CMI Requests with oAuth Authentication |
Enables using oAuth authentication scheme for incoming CMI requests. |
|
OAuth Authentication Anonymous Access |
Whether anonymous oAuth access is allowed. Normally when anonymous oAuth access is not allowed, then the oAuth user is used after validating the user certificate subject and issuer in Contact Center system. If anonymous oAuth access is allowed, then the user configured below is used instead. |
|
Realm Name |
The Tomcat’s realm name for identifying the users of CMI. The default value is SAP Contact Center Authentication. |
|
Cloud Attachments: AWS Region |
The region of the S3 bucket where cloud attachments are stored |
|
Cloud Attachments: AWS Bucket name |
The S3 bucket name where cloud attachments are stored |
|
Cloud Attachments: Url shortener Lambda function ARN |
The ARN of the lambda that is used for creating the cloud attachment short URLs, for example arn:aws:lambda:XXX:NNN:function:YYY |
|
Cloud Synchronization Service (CSS) The variables below are for Engagement Center hybrid systems only, not for Contact Center customers. | |
|
Enable Cloud Synchronization Service (CSS) |
Enables Cloud Synchronization Service (CSS) |
|
oData service URI in the SCP |
Enter the URI of the source oData service (data provider) in the SAP Cloud Platform. |
|
Synchronization Delay (seconds) |
Define the interval of delay between synchronization service calls. The default value is 120 seconds. The minimum value is 60 seconds. |
|
Agent Phone Number Base Value |
This number is added to the agent ID in synchronization. Use the default value 1000. This also means that for queue numbers the range must be below 1000. |
|
Restful Outbound Campaign Interface (OBI) | |
|
Enable Restful Outbound Campaign Interface (OBI) |
Enable OBI requests. |
|
Allow OBI Requests with Basic Authentication |
Enables using HTTP basic authentication scheme for incoming OBI requests. |
|
OBI Anonymous Access |
Defines whether incoming OBI requests may proceed without authentication. The choices are:
|
|
Logon ID for Anonymous OBI Requests |
Use only when local or remote anonymous requests are allowed. |
|
Allow OBI Requests with oAuth Authentication |
Enables using oAuth authentication scheme for incoming OBI requests. |
|
OAuth Authentication Anonymous Access |
Whether anonymous oAuth access is allowed. Normally when anonymous oAuth access is not allowed, then the oAuth user is used after validating the user certificate subject and issuer in Contact Center system. If anonymous oAuth access is allowed, then the user configured below is used instead. |
|
Realm Name |
The Tomcat’s realm name for identifying the users of OBI. The default value is SAP Contact Center Authentication. |