Message Connector Configuration Settings

To configure the Message Connector, you can modify the XML file called MessageConnectorConfig.xml found in your Message Connector directory on the Unica Interact runtime server, usually <Unica Interact_home>/msgconnector/config/MessageConnectorConfig.xml. Each of the configurations in this XML file are described here. Be aware that if you modify this file after the Message Connector is deployed and running, be sure to undeploy and redeploy the Message Connector or restart the application server to reload these settings after you are done modifying the file.

General Settings

The following table contains a list of the optional and required settings contained in the generalSettings section of the MessageConnectorConfig.xml file.

Table 1. Message Connector General Settings

A list of the optional and required settings on the generalSettings section of the Message Connector configuration file
<interactURL> The URL of Unica Interact runtime server, which handle the calls from the Message Connector page tags, such as the runtime server on which the Message Connector runs. This element is required. http://localhost:7001/interact
<interactUsername> The Unica Interact username authenticates Message Connector with Unica Interact runtime. It is required when Unica Interact API authentication (Affinium|interact|general|API) is set to True.
<interactPassword> The Unica Interact password authenticates Message Connector with Unica Interact runtime. It is required when Unica Interact API authentication (Affinium|interact|general|API) is set to True. Only the passwords, encrypted using the Platform’s encryptPasswords utility are valid. Plain text passwords are not allowed.
<defaultDateTimeFormat> The default date format. MM/dd/yyyy
<log4jConfigFileLocation> The location of the Log4j property file. It is relative to $MESSAGE_CONNECTOR_HOME environment variable if it is set; otherwise, this value is relative to the root path of Message Connector web application. config/MessageConnectorLog4j.properties

Default Parameter Values

The following table contains a list of the optional and required settings contained in the defaultParameterValues section of the MessageConnectorConfig.xml file.

Table 2. Message Connector Default Parameter Settings

Elements contained in the defaultParameterValues section of the MessageConnectorConfig.xml file.
Element Description Default Value
<interactiveChannel> The name of the default interactive channel.
<interactionPoint> The name of the default interaction point.
<debugFlag> Determines whether debugging is enabled. The allowed values are true and false. false
<contactEventName> The default name of the contact event that is posted.
<acceptEventName> The default name of the accept event that is posted.
<imageUrlAttribute> The default offer attribute name that contains the URL for the offer image, if none is specified in the Message Connector link.
<landingPageUrlAttribute> The default URL for the click-through landing page if none is specified in the Message Connector link.

Behavior Settings

The following table contains a list of the optional and required settings contained in the behaviorSettings section of the MessageConnectorConfig.xml file.
Table 3. Message Connector Behavior Settings

Elements contained in the behaviorSettings section of the MessageConnectorConfig.xml file.
Element Description Default Value
<imageErrorLink> The URL to which the connector redirects if an error occurs while processing a request for an offer image. This setting is required. /images/default.jpg
<landingPageErrorLink> The URL to which the connector redirects if an error occurs while processing a request for a click-through landing page. This setting is required. /jsp/default.jsp
<alwaysUseExistingOffer> Determines whether the cached offer should be returned, even if it already expired. The allowed values are true and false. false
<offerExpireAction> The action to take if the original offer is found, but is already expired. Allowed values are:
  • GetNewOffer
  • RedirectToErrorPage
  • ReturnExpiredOffer
 RedirectToErrorPage

Storage Settings

The following table contains a list of the optional and required settings contained in the storageSettings section of the MessageConnectorConfig.xml file.
Table 4. MessageConnector Storage Settings

Elements contained in the storageSettings section of the MessageConnectorConfig.xml file.
Element Description Default Value
<persistenceMode> When the cache persists new entries into the database. The allowed values are WRITE-BEHIND (where data is written to the cache initially, and updated to the database at a later time) and WRITE-THROUGH (where data is written to the cache and to the database at the same time). WRITE-THROUGH
<maxCacheSize> The maximum number of entries in the memory cache. 5000
<maxPersistenceBatchSize> The maximum batch size while persisting entries into the database. 200
<macCachePersistInterval> The maximum time in seconds an entry stays in the cache before it is persisted into the database. 3
<maxelementondisk> The maximum number of entries in the disk cache. 5000
<cacheEntryTimeToExpireInSeconds> The maximum amount of time for the entries in the disk cache to persist before expiring. 60000
<jdbcSettings> A section of the XML file containing specific information if a JDBC connection is used. It is mutually exclusive with the <dataSourceSettings> section. Configured by default to connect to a SQLServer database configured on the local server, but if you enable this section you must provide the actual JDBC settings and credentials to log in.
<dataSourceSettings> A section of the XML file containing specific information if a data source connection is used. It is mutually exclusive with the <jdbcSettings> section. Configured by default to connect to the InteractDS data source defined on the local web application server.

Audience Levels

The following table contains a list of the optional and required settings contained in the audienceLevels section of the MessageConnectorConfig.xml file.

Note that the audienceLevels element is optionally used to specify the default audience level to use if none is specified in the Message Connector link, as in the following example:

<audienceLevels default="Customer">

In this example, the value for the default attribute matches the name of an audienceLevel defined in this section. There must be at least one audience level defined in this configuration file.

Table 5. MessageConnector Audience Level Settings

A list of optional and required settings contained in the audienceLevels section of the MessageConnectorConfig.xml file.
Element Element Description Default Value
<audienceLevel> The element containing the audience level configuration. Provide a name attribute, as in <audienceLevel name="Customer">
<messageLogTable> The name of the log table. This value is required. UACI_MESSAGE_CONNECTOR_LOG
<fields> <field> The definition of one or more audience ID fields for this audienceLevel.
<name> The name of the audience ID field, as specified in the Interact runtime.
<httpParameterName> The corresponding parameter name for this audience ID field.
<dbColumnName> The corresponding column name in the database for this audience ID field.
<type> The type of the audience ID field, as specified in the Interact runtime. Values can be string or numeric.