Interact run time

The following are the JVM parameters for Interact run time.

INTERACT_HOME

This property can be defined to specify the Interact installation directory in the system. The path must point to the directory of the system where Interact is installed.

For example: -DINTERACT_HOME=” D:\HCL_12.1.1\Interact”

com.unicacorp.interact.deliver.templateTimeout

Mapping for the outbound gateways can be defined in the Gateway tab under Interactive channel. This property can be used if the user wants to continue using the property files based mapping. If there are more than one gateway, user must add comma separated gateway names.

For example: -DOUTBOUND_GATEWAYS_USING_MAPPING_FROM_PROPERTIES=Email

INBOUND_GATEWAYS_USING_MAPPING_FROM_PROPERTIES

Mapping for the outbound gateways can be defined in the Gateway tab under Interactive channel. This property can be used if the user wants to continue using the property files based mapping. f there are more than one gateway, user must add comma separated gateway names.

For example: -DOUTBOUND_GATEWAYS_USING_MAPPING_FROM_PROPERTIES=Email

com.hcl.interact.http.proxyProtocol

This property can be used to specify the protocol to connect to the proxy server.

For example: -Dcom.hcl.interact.http.proxyProtocol=https

com.hcl.interact.http.proxyHost

This property can be used to specify the IP address of the proxy server.

For example: -Dcom.hcl.interact.http.proxyHost=<IP address of server>

com.hcl.interact.http.proxyPort

This property can be used to specify the listening port of the proxy server.

For example: -Dcom.hcl.interact.http.proxyPort=8080

com.hcl.interact.http.proxyUsername

This property can be used to specify the username to connect to proxy server. It is not used if no authentication is required.

For example: -Dcom.hcl.interact.http.proxyUsername=<Username of proxy server>

com.hcl.interact.http.proxyPassword

This property can be used to specify the password to connect to proxy server. It is not used if no authentication is required.

For example: -Dcom.hcl.interact.http.proxyPassword=<Password of proxy server>

interact.jmx.monitoring.port

This property is used to configure the JMX Monitoring port for Interact. User can also configure this port in Unica Interact | monitoring | port under configuration.

For example -Dinteract.jmx.monitoring.port=<port number>

interact.runtime.instance.name

This property is used to define the runtime instance directory. It can be added to the web application server startup script.

For example: -Dinteract.runtime.instance.name=instance2

interact.offerserving.maxOfferAllocationInMemoryPerInstance

This property is used to define the maximum size of the pool of offers that Unica Interact can keep in memory. This can also be defined from runtime configuration Interact | offerserving | Constraints | maxOfferAllocationInMemoryPerInstance.

For example: -Dinteract.offerserving.maxOfferAllocationInMemoryPerInstance = 100

interact.offerserving.maxDistributionPerIntervalPerInstanceFactor

This property is used to define the constraint percentage for a given offer allocation to support the distribution across runtime servers. This can also be defined from configuration Interact | offerserving | Constraints | maxDistributionPerIntervalPerInstanceFactor. It can be between 0 and 100.

For example: -Dinteract.offerserving.maxDistributionPerIntervalPerInstanceFactor=70

interact.ignitePort

This property is used to define the ignite port used for communication.

For example: -Dinteract.ignitePort=<valid Ignite Port>

com.unicacorp.interact.chDupeCheckLimit

This property is used to define the maximum number of records to be held for enabling duplicate checking of contacts.

For example: -Dcom.unicacorp.interact.chDupeCheckLimit=<max records>

com.unicacorp.interact.rhDupeCheckLimit

This property is used to define the maximum number of records to be held for enabling duplicate checking of responses and cross-session responses.

For example: -Dcom.unicacorp.interact.rhDupeCheckLimit=<max records>

com.unicacorp.interact.chSuppressDupe

This property is used to enable suppression of duplicate contacts.

For example: -Dcom.unicacorp.interact.chSuppressDupe=<true | false>

com.unicacorp.interact.rhSuppressDupe

This property is used to enable suppression of duplicate responses and cross-session responses.

For example: -Dcom.unicacorp.interact.rhSuppressDupe=<true | false>

com.unicacorp.interact.testclient.nullValue

The value defined in this property is treated as NULL when it is passed as a parameter in the Interact API request.

For example: -Dcom.unicacorp.interact.testclient.nullValue=<parameter value>

interact.ehcache.config

This property defines the ehcache configuration file path. The reference is present in the following location: $INTERACT_HOME/samples.

For example: Dinteract.ehcache.config=<configuration file path>

interact.api.dateFormat

This property is used to specify the date format to be used for date type values. The default format is “MM/dd/yyyy HH:mm:ss”.

For example: -Dinteract.api.dateFormat=<Date format>

com.hcl.interact.testrun.rowlimit

This property can be used to specify the number of records to perform test run on an interactive flowchart.

For example: -Dcom.hcl.interact.testrun.rowlimit=<Number of rows>

Interact.DisableExceptionStackTracesInMacros

This property is used to specify whether exception is thrown while evaluating macros.

For example: -DInteract.DisableExceptionStackTraceInMacros=<true | false>

com.unicacorp.interact.enableDetailStats

This property is used to enable the performance and monitoring statistics for specific beans.

For multiple beans, the names must be separated by commas.

For example: -Dcom.unicacorp.interact.enableDetailStats=<Bean name>

com.unica.interact.deployment.timeoutInSecs

This property is used to specify the deployment timeout in secs. The default value is 180 seconds.

For example: -Dcom.unica.interact.deployment.timeoutInSecs=180

com.ibm.interact.instance.name

This property is used to specify the Interact runtime instance name.

For example: -Dcom.ibm.interact.instance.name=<instance name>

com.unicacorp.interact.invalidPaths

This property can be used to specify the invalid paths to load external files. The files from these paths are not picked for processing. Multiple paths can be provided separated by commas.

For example: -Dcom.unicacorp.interact.invalidPaths=<File path>

interact.XSessResponseConsumerManager.generateOnlyOneResponse

This property, when set to true, processes only a single record for xsession data.

For example: -Dinteract.XSessResponseConsumerManager.generateOnlyOneResponse=<true|false>

tryToPreserveInexactFloatValues

This property can be used for preserving original custom numeric offer attribute value.

This parameter can be enabled if the getOffers call does not accurately display numeric offer attributes value specified as decimals.

For example: -DtryToPreserveInexactFloatValues=<true | false>

com.unicacorp.interact.propertyRefreshInterval

This property can be used to specify the time (in seconds) for property files refresh.

The default value is 60 seconds.

For example: -Dcom.unicacorp.interact.propertyRefreshInterval=<duration in seconds>

com.unicacorp.interact.scheduledTasksProcessInterval

This property can be used to specify the sleep time (in milliseconds) for scheduled processing of event and event pattern actions.

The default value is 60 seconds.

For example: -Dcom.unicacorp.scheduledTasksProcessInterval=<duration in milliseconds>

com.unicacorp.interact.eventpatterns.parallelism

This property specifies the number of parallel executions for event pattern processing. The default value is 5

For example: -Dcom.unicacorp.interact.eventpatterns.parallelism=<parallelism>

com.unicacorp.interact.eventpatterns.restartRetries

This property specifies the number of retry attempts made by the job for event pattern processing.The default value is 5.

For example: -Dcom.unicacorp.interact.eventpatterns.restartRetries=<Number of retries>

com.unicacorp.interact.eventpatterns.evaluateTimeoutMilli

This property specifies the timeout in milliseconds for event pattern processing. The default value is 1 second.

For example: -Dcom.unicacorp.interact.eventpatterns.evaluateTimeoutMilli=<timeout in millis>

com.unicacorp.interact.eventpatterns.restartRetryDelayInSec

This property specifies the duration (in seconds) between each retry while processing event patterns. The default value is 5 seconds

For example: -Dcom.unicacorp.interact.eventpatterns.restartRetryDelayInSec =<delay in sec

Interact.advisoryMessageEncodingOverrides

This property allows the encoding of the given locale in Western instead of Unicode. This parameter can be used in case message strings of certain locales (like Japanese) are not properly displayed due to incorrect encoding.

For example: -DInteract.advisoryMessageEncodingOverrides=ja

com.unica.interact.api.insertSessionIDAsCooki

This property is used to place the sessionID as a cookie for API calls. By default, the sessionID is placed into the http header.

For example: -Dcom.unica.interact.api.insertSessionIDAsCookie =<true | false>

com.unica.interact.api.SessionIDCookieName

This property is used to provide the name of the cookie which stores the sessionID. This cookie is sent to all APIs which takes sessionID as argument.

For example: -Dcom.unica.interact.api.SessionIDCookieName =<Name of the cookie>

InteractMsgCode

This property can be used to override the status code returned by the API for a particular advisory message code. Each value is of the format "<api_call>,<message_code>,<status_code>" separated by semicolons.

For example: -DInteractMsgCode=postEvent,18,2

com.ibm.interact.triggeredmessage.enableJMSConsumer

This property can be used to enable the JMS consumer for triggered messages.

For example: -Dcom.ibm.interact.triggeredmessage.enableJMSConsumer=<true | false>

com.unicacorp.interact.maxStringLengthInFormatMacro

This property can be used in FORMAT macro to override the maximum width for Text type input. Default value of this parameter is 255.

For example: -Dcom.unicacorp.interact.maxStringLengthInFormatMacro=300

ContinueEvaluatingBranchAndAdvOptTreatmentLogicDespiteExMessageList

This allows a user to specify a list of exception messages separated by the caret character (ˆ) without spaces. If any exception containing part of any of the messages specified is encountered in the evaluation of a decision process box or treatment advanced options expression, the exception is not thrown and other branches continue to be processed.

For example:-DcontinueEvaluatingBranchAndAdvOptTreatmentLogicDespiteExMessageList

=no˜value˜set˜;index˜out˜of˜bounds;value˜is˜null
Note: Spaces in the message must be specified with tilde characters. Semicolons separate each message snippet to match.

DisableDecisionProcessBoxAndAdvOptTreatmentLogging

This parameter allows the user to disable all error logging in the DecisionProcessBox class and the TreatmentManager.filterRecommendList method.

For example: -DDisableDecisionProcessBoxAndAdvOptTreatmentLogging=<true | false>

TwoDigitYearStartDate

This parameter allows the user to set the range for interpreting two digit years. The default value is 1/1/1920, which means that dates after 1920 and before 2019 will be interpreted correctly.

For example: -DTwoDigitYearStartDate=”1/1/1920”

Interact.enableTwoDigitYearFix

This parameter allows the user to enable 4-digit year processing for dates. This can be used if DATE macro is evaluating year values incorrectly.

For example: -DInteract.enableTwoDigitYearFix =<true | false>

com.ibm.interact.evpatetl.conf

This property defines the path of the configuration file for running Pattern State ETL

For example: -Dcom.ibm.interact.evpatetl.conf=<ETL config file path>

com.unicacorp.interact.minTreatmentsPerThread

This property defines the minimum number of treatment rules to process per thread. The default value is 10.

For example: -Dcom.unicacorp.interact.minTreatmentsPerThread=<Number of treatments>

com.unicacorp.interact.maxTreatmentPoolSize

This property defines the maximum treatment thread pool size.

For example: -Dcom.unicacorp.interact.maxTreatmentPoolSize =<Number of threads>

CircuitBreaker.processTimeoutMillis

This property defines the timeout in milliseconds for communication through gateways.

For example: -DCircuitBreaker.processTimeoutMillis=<timeout in milliseconds>

com.unicacorp.interact.event.asyncTimeoutMSec

This property defines the timeout in milliseconds for asynchronous handling of events. The default value is 1 second.

For example: -Dcom.unicacorp.interact.event.asyncTimeoutMSec=<timeout in milliseconds>

com.unicacorp.interact.eventActionTimeout

This property defines the timeout in milliseconds for processing event actions. The default value is 10 seconds.

For example: -Dcom.unicacorp.interact.eventActionTimeout=<timeout in milliseconds>

Interact.HTMI.Enabled

This property helps the user to enable performance APIs for monitoring each client API thread. This helps to find the root cause in case of unusual transaction times.

For example: -DInteract.HTMI.Enabled=<true | false>

Interact.HTMI.MaxRequestDurationInMs

This property can be defined by the user to set the time (in milliseconds) exceeding which the request timestamp and information is logged to LOG4J by the Performance API. The default value is 1.5 seconds.

For example: -DInteract.HTMI.MaxRequestDurationInMs =<time in milliseconds>

Interact.HTMI.RecordIndividualAPIs

This property, when enabled logs individual APIs (within batch requests) that take longer than the specified duration of time. The default value is false.

For example: -DInteract.HTMI.RecordIndividualAPIs=<true | false>

Interact.HTMI.MaxStartSessionDurationInMs

This property defines the maximum duration (in milliseconds) exceeding which the StartSession API information is logged by the Performance API. The default value is 300 milliseconds.

For example: -DInteract.HTMI.MaxStartSessionDurationInMs=<time in milliseconds>

Interact.HTMI.MaxGetOffersDurationInMs

This property defines the maximum duration (in milliseconds) exceeding which the GetOffers API information is logged by the Performance API. The default value is 750 milliseconds.

For example: -DInteract.HTMI.MaxGetOffersDurationInMs=<time in milliseconds>

Interact.HTMI.MaxPostEventDurationInMs

This property defines the maximum duration (in milliseconds) exceeding which the PostEvent API information is logged by the Performance API. The default value is 750 milliseconds.

For example: -DInteract.HTMI.MaxPostEventDurationInMs=<time in milliseconds>

Interact.HTMI.MaxGetProfileDurationInMs

This property defines the maximum duration (in milliseconds) exceeding which the GetProfile API information is logged by the Performance API. The default value is 300 milliseconds.

For example: -DInteract.HTMI.MaxGetProfileDurationInMs=<time in milliseconds>

Interact.HTMI.LogErrorsEveryNthTime

This property can be used to define N after which the errors or exceptions generated by performance API are logged.

For example: -DInteract.HTMI.LogErrorsEveryNthTime =<N>

Interact.HTMI.UseMillisecondTimers

This property can be set to enable timer in milliseconds internally for performance API. This can be used for some Windows servers, where timer in milliseconds is faster than nanoseconds.

For example: -DInteract.HTMI.UseMillisecondTimers =<true | false>

Interact.HTMI.Debug

This property can be set to enable maximum debugging for internal HTMI issues.

For example: -DInteract.HTMI.Debug =<true | false>

com.unicacorp.interact.suppressWarningOnAnonymousUser

This property can be used to suppress the warnings when audience ID is not found in profile table.

For example: -Dcom.unicacorp.interact.suppressWarningOnAnonymousUser=<true | false>

com.hcl.interact.eventpatterns.printPatternAction

This property can be set to enable logging when the pattern states for an audience ID are written to Interact cache.

For example: -Dcom.hcl.interact.eventpatterns.printPatternAction =<true | false>

com.hcl.interact.eventpatterns.eagerPersist

This property, when enabled, eagerly writes the changed event pattern details to Interact cache.

For example: -Dcom.hcl.interact.eventpatterns.eagerPersist =<true | false>

com.ibm.interact.triggeredmessage.addPerfData

This property is used to enable the performance metrics for triggered messages.

For example: -Dcom.ibm.interact.triggeredmessage.addPerfData=<true | false>

com.unicacorp.interact.learning.disableAggregator

This property is used to disable the learning aggregation of offer stats.

For example: -Dcom.unicacorp.interact.learning.disableAggregator =<true | false>

com.unicacorp.interact.learning.disableDeletion

This property is used to enable or disable the cleanup for learning tables.

For example: -Dcom.unicacorp.interact.learning.disableDeletion=<true | false>

com.unicacorp.interact.learning.ignoreInterval

This property when set is used to force the aggregation of learning data.

For example: -Dcom.unicacorp.interact.learning.ignoreInterval=<true | false>

interact.services.loader.saveLoaderFiles

This property is used to save the loader files after loading the data using external loader. The default value is false

For example: -Dinteract.services.loader.saveLoaderFiles=<true | false>

ConvertEveryNULLAttributeValueToAJEPNullConstant

This property is used to specify whether to use a special value when the variable value is null while evaluating an expression. The default value is false.

For example: -DConvertEveryNULLAttributeToAJEPNullConstant=<true | false>

includeJoinInfo

This parameter is used to specify whether to keep the relationship between the join key and the values in the dimensional tables while loading profile data. The default value is true.

For example: -DincludeJoinInfo=<true | false>

com.unicacorp.interact.deployment.reloadTimeout

The maximum time Interact waits for a new deployment to be reloaded. It is used only when automatic deployment reload notification is used. The default value is 5000.

For example: -Dcom.unicacorp.interact.deployment.reloadTimeou=<timeout in milliseconds>

com.ibm.interact.lockTimeWarningThreshold

This property is used to log a warning if the processing of a session took more than this value. The default value is 5000.

For example: -Dcom.ibm.interact.lockTimeWarningThreshold =<time in milliseconds>

com.unicacorp.interact.cache.maxWaitTime

This property is used to specify the maximum time process waits to get a lock. The default value is 2000 milliseconds.

For example: -Dcom.unicacorp.interact.cache.maxWaitTime =<time in milliseconds>

DEFAULT_PERSISTENCE_PROVIDER

This property is used to override the PersistenceProvider for WAS 8.5.5.x. The default value is true which uses AppServer specified provider.

If IBM WebSphere is used as the application server hosting Interact run time instance, ensure that you set this parameter to false.

For example: -DDEFAULT_PERSISTENCE_PROVIDER =<true | false>

com.unicacorp.interact.triggeredMessage.logging.maxDelayInMin

Thread interval for persisting log data into the database table.

Default value: 15 minutes

For example: -Dcom.unicacorp.interact.triggeredMessage.logging.maxDelayInMin=<time-in-min>

com.unicacorp.interact.triggeredMessage.logging.maxBatchSize

Maximum batch size to maintain in queue.

Default value: 1000

For example: -Dcom.unicacorp.interact.triggeredMessage.logging.maxBatchSize =<positive-number>

com.unicacorp.interact.triggeredMessage.logging.maxNumberOfFailures

Maximum retries if operation fails

Default value: 3

For example: -Dcom.unicacorp.interact.triggeredMessage.logging.maxNumberOfFailures =<positive-number>

com.unicacorp.interact.triggeredMessage.logging.maxDelayInMin

Thread interval for persisting log data into the database table.

Default value: 15 minutes

For example: -Dcom.unicacorp.interact.triggeredMessage.logging.maxDelayInMin=<time-in-min>

com.unicacorp.interact.triggeredMessage.logging.maxBatchSize

Maximum batch size to maintain in queue.

Default value: 1000

For example: -Dcom.unicacorp.interact.triggeredMessage.logging.maxBatchSize =<positive-number>

com.unicacorp.interact.triggeredMessage.logging.maxNumberOfFailures

Maximum retries if operation fails.

Default value: 3

For example: -Dcom.unicacorp.interact.triggeredMessage.logging.maxNumberOfFailures =<positive-number>

com.unicacorp.interact.playback.purgeBatchSize

Number of database transactions that the Playback purge batch should process at once.

Default value: 10000

For example: com.unicacorp.interact.playback.purgeBatchSize=10000

com.hcl.interact.tms.socks.proxyProtocol

This property can be used to specify the protocol to connect to the proxy server for Deliver gateway.

For example: -Dcom.hcl.interact.tms.socks.proxyProtocol=SOCKS

com.hcl.interact.tms.socks.proxyHost

This property can be used to specify the IP address of the proxy server for Deliver gateway.

For example: -Dcom.hcl.interact.tms.socks.proxyHost=<IP address of server>

com.hcl.interact.tms.socks.proxyPort

This property can be used to specify the listening port of the proxy server for Deliver gateway.

For example: -Dcom.hcl.interact.tms.socks.proxyPort=<Port of server>

com.hcl.interact.tms.socks.proxyUsername

This property can be used to specify the username to connect to proxy server for Deliver gateway. It is not used if no authentication is required.

For example: -Dcom.hcl.interact.tms.socks.proxyUsername=<Username for proxy server>

com.hcl.interact.tms.socks.proxyPassword

This property can be used to specify the password to connect to proxy server for Deliver gateway. It is not used if no authentication is required.

For example: -Dcom.hcl.interact.tms.socks.proxyPassword=<Password for proxy server>