Outbound Gateway Service

The Outbound Gateway service checks INTERACTION_X_MESSAGE for new messages. When the service finds a new message, it processes it as an outbound email, SMS, or printed letter as appropriate and then moves the record to the INTERACTION_X_MESSAGE table.

The AppSettings.Config file for the Outbound Gateway service defines the configuration for this service. It contains the following application settings.

Setting Description
AllowedExt

Defines the file name extensions that are allowed for agent email attachments. Type a comma-separated list. For example:

.doc,.docx,.docm,.pdf,.rtf
AsyncExchangeAccess

Defines whether the INTERACTION_X_NEWMESSAGE database table is polled asynchronously. Possible values are true and false.

Note: We recommend that this setting is set to false unless the polling of this database table is time critical.
ConvertAutoReplyToFrench

This setting enables localization of Syntelate XA auto-reply emails for customers in Québec, Canada.

Determines whether an auto-reply email sent from Syntelate XA to a Microsoft 365 email account will be automatically translated into Canadian French (fr-CA) and will convert its date and time details in the header to the original timezone.

Valid values: true | false

Default value: false
ConvertHTMLToPlainTextOldWords

Required. The HTML entities specified here will be converted into the Unicode characters listed in ConvertHTMLToPlainTextNewWords.

Use the following:

Copy 
value="’, ,&,",<,
>,®,©,•,™,'"
ConvertHTMLToPlainTextNewWords

Required. This key specifies the Unicode characters that will be converted from the HTML entities listed in ConvertHTMLToPlainTextNewWords.

Use the following:

Copy 
value="’, ,&,",<,>,®,©,•,™,'"
DatabaseConnectionTimeoutInMins

Defines the time period (in minutes) during which the Outbound Gateway service attempts to reconnect to the Syntelate XA database if the connection is lost.

Valid values: A positive integer, for example, 20.

Default value: 20
ExchangeVersion Defines the Microsoft Exchange version, for example Exchange2010.
FetchTimeSeconds Defines how frequently to check the INTERACTION_X_NEWMESSAGE database table. Type a number of seconds.
sqlConnectionString Defines the SQL Server connection string.
ErrorEmailTo Defines the email address to which the daily error log report should be sent.
ErrorEmailTime Defines the time at which the daily error log report email should be sent. Enter the time in the format hh:mm, using the 24-hour clock. For example, to send the email just before midnight, enter 23:55.
ErrorEmailActive Defines whether the daily error log report email should be sent. Possible values are true and false.
ErrorLogToSend Defines the full path of the log file to attach to the daily error log report email.
ErrorEmailSubject Defines the subject of the daily error log report email.
ErrorEmailBody

Defines the body text of the daily error log report email. Type \n for a new line. For example:

Copy 
Please find attached the daily log of errors from the  .\n\n Regards,\n\n The  Team
DontSendEmail

Defines whether the Outbound Gateway service should send emails/SMS. If set to false, the service will still process messages (move them from the INTERACTION_X_NEWMESSAGE table to the INTERACTION_X_NEWMESSAGE table). However, emails and SMS will not be sent.

Possible values are true and false. In a live environment, this should be false.
SnippetsDateTimeFormat

Defines the date/time format for snippets, for example dd/MM/yyyy HH:mm:ss.
SnippetsDateFormat Defines the date format for snippets, for example dd/MM/yyyy.
SnippetsTimeFormat

Defines the time format for snippets, for example HH:mm tt.
MaxRetries

We recommend setting this value to “2”.

Defines the maximum number of send attempts permitted before the outbound message is ignored. This setting is also used by the inbound gateway for receive attempts; both gateways need to be set to the same value, which should be “2”.
ZangAPIURL

Defines the REST base URL required by the Avaya Communications API. The base URL that you'll need depends on your geographic region. You can find Avaya's list of base URLs by region in Avaya's documentation at: https://docs.avayacloud.com/aspx/rest#base-url.

Date and Time Notation

You can use the following notation when specifying a date and time in Syntelate XA.

Format specifier Description
d The day of the month, from 1 through to 31.
dd The day of the month, from 01 through to 31.
ddd The abbreviated name of the day of the week, for example “Mon”.
dddd The full name of the day of the week, for example “Monday”.
h The hour, using the 12-hour clock from 1 to 12.
hh The hour, using the 12-hour clock from 01 to 12.
H The hour, using the 24-hour clock from 0 to 23.
HH The hour, using the 24-hour clock from 00 to 23.
m The minute, from 0 through to 59.
mm The minute, from 00 through to 59.
M The month, from 1 through to 12.
MM The month, from 01 through to 12.
MMM The abbreviated name of the month, for example “Jan”.
MMMM The full name of the month, for example “January”.
tt The AM/PM designator.
yy The year, from 00 to 99.
yyyy The year, from 0000 to 9999.