GENERAL
The GENERAL database table defines various general settings for Syntelate XA. Values are stored in the INFORMATION field for each setting, and you can edit the values if required.
Note: After updating this database table, you must refresh Redis for your changes to take effect at runtime.
| Setting | Description |
|---|---|
| AgentDesktopUrl |
Valid values: A string that is a URL. Defines the URL for the Agent Desktop of the current instance of Syntelate XA. |
| AgentDesktopUrlLive |
Valid values: A string that is a URL. Defines the live URL (also known as the production URL) to use when transferring Syntelate XA desktops from design to live. |
| AIKey |
Valid values: A string. Defines the API key for Syntelate XA's integration with Azure OpenAI API. See Channels for information about Syntelate XA's connectors to the Azure OpenAI API. |
| AIReportSummaryURL |
Valid values: A string that is a URL. Defines the location of the API for Report Summarizer in Syntelate XA. See Channels for information about Syntelate XA's connectors to the Azure OpenAI API. |
| AIRewrite |
Valid values: true | false Default value: false Determines whether the Rewriter Azure OpenAI API connector is on or off. See Channels for information about Syntelate XA's connectors to the Azure OpenAI API. |
| AIURL |
Valid values: A string that is a URL. Defines the location of the API for Rewriter in Syntelate XA. See Channels for information about Syntelate XA's connectors to the Azure OpenAI API. |
| AllowGenReportBtn |
Valid values: true | false Default value: false Determines whether the Report Summarizer Azure OpenAI API connector is on or off. See Channels for information about Syntelate XA's connectors to the Azure OpenAI API. |
| DesignerIsReadOnly |
Valid values: true | false Default value: false Determines whether or not Syntelate Designer is read-only. If true, no user will be able to make changes to desktops, scripts, grids, etc. |
| EmailWebApiToken |
Valid values: A string. Defines the access key to the Syntelate XA Email Web API. |
| EmailWebApiUrl |
Valid values: A string that is a URL. Defines the URL of the Email Web API on Syntelate XA. |
| EncryptionKey |
Valid values: A string. Defines the encryption key for the Fulfillment Service Encryption that encrypts the Voice of the Customer URL data. |
| HelpSiteUrl |
Valid values: A string that is a URL. Defines the website address of the documentation site for Syntelate XA. The URL is used in the menus of the Syntelate XA desktops and Syntelate XA Designer to provide users with a link to the Help site. |
| InvalidCharsRegex |
Valid values: A string. Defines the regular expression for preventing invalid characters being input by users in Studio. |
| SentimentAnalysis |
Valid value: true | false Default value: false Determines whether the Sentiment Analysis Azure OpenAI API connector is on or off. See Channels for information about Syntelate XA's connectors to the Azure OpenAI API. |
| VOCServer |
Valid value: A string that is a URL. Defines the publicly available URL of the Voice of the Customer web application. The VOCServer setting is used to provide the post-chat survey screen with the URL that takes customers to the survey. |
| WebChatApiQInfoRate |
Valid values: A whole number that represents a number of minutes. Default value: 5 minutes Defines the refresh rate in minutes of the WebChat GetQueueInfo API call (how often the length of the web chat queue is checked). This value is used by the pre-chat survey to display the average wait time for the queue. |
| WebChatClearDown |
Valid values: A time expressed in HH:MM:ss format. Default value: 03:00:00 Defines the time of day that web chat data is cleared from Redis. We recommend setting this to be a time in the middle of the night. |
| WebChatConfigRefresh |
Valid values: A whole number representing a number of minutes. Default value: 720 minutes Defines the refresh rate in minutes of the web chat configuration. |
| WebChatMaxInQueue |
Valid values: A whole number. Default value: 10 Defines the maximum number of chats allowed in the queue before switching to leave a message mode. This is only used if a value is not specified at web chat topic level in the web chat configuration. |
| WebChatServer |
Valid values: A string that is a URL. Defines the URL of the Web Chat Message Host application. |
| WebChatServerExt |
Valid values: A string that is a URL. Defines the URL of your public-facing (external) Web Chat Message Host application. This URL only needs to be specified if it is different from the URL that agents will use to access the server. |
| WebChatTopicRefresh |
Valid values: A whole number representing a number of minutes. Default value: 60 Defines the refresh rate in minutes for web chat topic configuration. |
| WebChatUnesCharRegex |
Valid values: A string that is a regular expression. Defines the regular expression that will remove unnecessary characters from the user-entered custom CSS in Studio. The regex is called from the code that generates the JSON sent to the web pages used for web chat. |
| WebChatUrlRegex |
Valid values: A string that is a regular expression. Defines the regular expression that is used to identify URLs in chat messages that do not contain [url] [/url] tokens. |
| WebChatVoc |
Valid value: A whole number. Defines the ID number of the Voice of the Customer survey to use for web chat. Only required if Voice of the Customer surveys are used. |