Web Connector Configuration Options

In general, you can use a graphical Web Connector interface to configure your Web Connector settings. All of the settings you specify are also stored in a file called jsconnector.xml, found in your jsconnector/conf directory. Each of the parameters that are saved in the jsconnector.xml configuration file is described here.

Parameters and their descriptions

The following parameters are stored in the jsconnector.xml file and are used for Web Connector interactions. There are two ways to modify these settings:

Using the Web Connector Configuration web page that is automatically available after you have deployed and started the Web Connector application. To use the Configuration web page, use your web browser to open a URL similar to the following: http://<host>:<port>/interact/jsp/WebConnector.jsp.

The changes you make on the Administration web page are stored in the jsconnector.xml file on the server where the Web Connector is deployed.

Edit the jsconnector.xml file directly using any text editor or XML editor. Be sure that you are comfortable editing XML tags and values before using this method.

Any time you edit the jsconnector.xml file manually, you can reload those settings by opening the Web Connector Administration Page (found at http://<host>:<port>/interact/jsp/jsconnector.jsp) and clicking Reload Configuration.

The following table describes the configuration options you can set as they appear in the jsconnector.xml file.

Web Connector configuration options

A human-readable identifier for the URL Pattern for display on the Web Connector's web configuration page.

interactURL

The base URL of the Interact runtime server. Note: You need to set this parameter only if the Web Connector (jsconnector) service is running as a deployed web application. You do not need to set this parameter if the WebConnector is running automatically as part of the Interact runtime server.

jsConnectorURL

The base URL used to generate the click-through URL, such as http://host:port/jsconnector/clickThru

interactiveChannel

Name of the interactive channel that represents this page mapping.

sessionIdCookie

Name of the cookie that contains the session ID that is used in the API calls to Interact.

visitorIdCookie

Name of the cookie to contain the audience ID.

audienceLevel

The campaign audience level for the inbound visitor, used in the API call to the Interact runtime.

audienceIdField

Name of the audienceId field used in the API call to the Interact runtime.

Note: There is currently no support for multi-field audience identifiers.

audienceIdFieldType

The datatype of the audience ID field [numeric | string] used in the API call to the Interact runtime

audienceLevelCookie

Name of the cookie that to contain the audience level. This is optional. If you do not set this parameter, the system uses what is defined for audienceLevel.

relyOnExistingSession

Used in the API call to the Interact runtime. In general, this parameter is set to "true".

enableInteractAPIDebug

Used in the API call to the Interact runtime to enable debugging output to the log files.

pageLoadEvents

The event that will be posted once this particular page is loaded. Specify one or more events within this tag, in the format similar to <event>event1</event>.

interactionPointValues

All items in this category act as default values for missing values in the IP specific categories.

interactionPointValuescontactEvent

Default name of contact event to be posted for this particular interaction point.

interactionPointValuesacceptEvent

Default name of accept event to be posted for this particular interaction point.

interactionPointValuesrejectEvent

Default name of the reject event to be posted for this particular interaction point. (Note: at this time, this feature is not used.)

interactionPointValueshtmlSnippet

Default name of HTML template to be served for this interaction point.

interactionPointValuesmaxNumberOfOffers

Default max number of offers to be retrieved from Interact for this interaction point.

interactionPointValueshtmlElementId

Default name of HTML element to receive the content for this interaction point.

interactionPoints

This category contains the configuration for each interaction point. For any missing properties the system will rely on what's configured under the interactionPointValues category.

interactionPointname

Name of the Interaction Point (IP).

interactionPointcontactEvent

Name of contact event to be posted for this particular IP.

interactionPointacceptEvent

Name of accept event to be posted for this particular IP.

interactionPointrejectEvent

Name of the reject event to be posted for this particular IP. (Note that this feature is not yet in use.)

interactionPointhtmlSnippet

Name of the HTML template to be served for this IP.

interactionPointmaxNumberOfOffers

Max number of offers to be retrieved from Interactfor this IP

interactionPointhtmlElementId

Name of the HTML element to receive the content for this interaction point.

enableDebugMode

Boolean flag (acceptable values: true or false) to turn on special debug mode. If you set this to true, the content returned from the Web Connector includes a JavaScript™ call to 'alert' informing the client of the particular page mapping that just occurred. The client must have an entry in the authorizedDebugClients file to generate the alert.

authorizedDebugClients

A file used by the special debug mode that contains the list of host names or Internet Protocol (IP) addresses that qualify for debug mode.

enableRawDataReturn

A Boolean flag (acceptable values: true or false) to determine whether the Web Connector attaches the raw offer data in JSON format at the tail end of the content.

enableNetInsightTagging

A Boolean flag (acceptable values: true or false) to determine whether the Web Connector attaches a Digital Analytics for On Premises tag at the end of the content.

apiSequence

Represents an implementation of the APISequence interface, which dictates the sequence of API calls made by the Web Connector when a pageTag is called. By default, the implementation uses a sequence of StartSession, pageLoadEvents, getOffers, and logContact, where the last two are specific to each Interaction Point.

clickThruApiSequence

Represents an implementation of the APISequence interface, which dictates the sequence of API calls made by the Web Connector when a clickThru is called. By default, the implementation uses a sequence of StartSession and logAccept.

netInsightTag

Represents the HTML and JavaScript™ template used to integrate a call to the Digital Analytics for On Premises tag. In general, you should not need to change this option.