Reserved parameters

There are several reserved parameters used with the Unica Interact API. Some are required for the runtime server, and others you can use for additional features.

API parameters

Feature Parameter Description
Log to custom table (Scope-session) UACICustomLoggerTableName The name of a table in the runtime tables data source. If you provide this parameter with a valid table name, the runtime environment writes all session data to the selected table. All column names in the table that match session data NameValuePair are populated. The runtime environment populates any column that does not match a session name-value pair with a null. You can manage the process which writes to the database with the customLogger configuration properties.
Log to a specific file (Scope-session) UACILogSeparationFileName Custom log filename: This parameter enables the runtime environment to write all logs that belong to this session to the specified log file. The file with the specified name is created at default log location, if not available.

For simulator, the parameter is automatically added. Log file name format is <Simulator-Basic-{scenarioName}.log>, <Simulator-Advanced-{scenarioName}.log>, and <Simulator-Coverage-{scenarioName}.log> for basic, advanced, and coverage scenarios, respectively.

Multiple response types (Scope-invocation) UACILogToLearning An integer with the value 1 or 0. 1 indicates the runtime environment should log the event as an accept to the learning system or enable offer suppression within a session. 0 indicates the runtime environment should not log the event to the learning system or enable offer suppression within a session. This parameter enables you to create several postEvent methods logging different response types without influencing learning. You do not need to define this parameter for events set to log a contact, accept, or reject. You must use this parameter in conjunction with UACIResponseTypeCode. If you do not define UACILOGTOLEARNING, the runtime environment assumes the default value of 0 (unless the event triggers a log contact, accept, or reject).
UACIResponseTypeCode A value representing a response type code. The value must be a valid entry in the UA_UsrResponseType table
Response tracking (Scope-invocation) UACIOfferTrackingCode The treatment code for the offer. You must define this parameter if the event logs to contact or response history. You can only pass one treatment code per event. If you do not pass the treatment code for an offer contact, the runtime environment logs an offer contact for every offer in the last recommended list of offers. If you do not pass the treatment code for a response, the runtime environment returns an error. If you configure the cross-session response tracking, you can use the UACIOfferTrackingcodeType parameter to define what type of tracking code you use other than treatment code.
Cross-session response tracking (Scope-invocation) UACIOfferTrackingCodeType A number which defines the tracking code type. 1 is the default treatment code, and 2 is the offer code. All codes must be valid entries in the UACI_TrackingType table. You can add other, custom codes to this table.
Specific flowchart execution (Scope-invocation) UACIExecuteFlowchartByName If you define this parameter for any method which triggers segmentation (startSession, setAudience, or a postEvent that triggers re-segmentation), instead of running all flowcharts for the current audience level, Unica Interact runs only the named flowcharts. You can provide a list of flowcharts separated by a pipe ( | ) character.
Ability to limit the offer field in getOffers API at Interact RunTime (Scope-Session) UACIOfferFields and UACIExcludeOfferFields You can include/exclude the UACIOfferFields and UACIExcludeOfferFields attributes of an offer by passing these attribute in the parameter of startSession, setAudience, or a postEvent.
Reset Event Pattern (Scope-Invocation)
  • ResetEventPattern. This parameter resets event pattern states for all patterns for the Audience ID.
  • PatternToReset. This parameter resets event pattern states for specific event patterns. Either Pattern ID or Pattern Name can be reset. This parameter can be only passed with ResetEventPattern parameter.
 You can reset the states of a specific pattern or all patterns for a particular audience ID, which is associated to the session. You must post event with a special parameter. The event must not have any associated explicit actions.
Reset offer suppression (Scope-Invocation)
  • ResetOfferSuppression.This parameter resets offer suppression rules for all offers for the Audience ID.
  • OfferToResetSuppression. This parameter resets offer suppression rules for specific offers. Either offer ID or offer code can be reset. To reset offer suppression for offers having offer code with multiple parts, offer code must be separated by commas. For example, offer Code1, offer Code2, offerCode3 and so on. This parameter can be only passed with ResetOfferSuppression parameter.
 You can reset the states of a specific offer suppression rule or all offer suppression rules for a particular audience ID, which is associated to the session. You must post event with a special parameter. The event must not have any associated explicit actions.
Remove session parameter before API call (Scope-Session) UACIPreRemoveParameter. Comma separated names of the parameters that you want to remove from the session before API call. This parameter is helpful when you want to remove some parameters already set in the session by previous API calls. Multiple parameter names can be passed and comma separated.
Remove session parameter after API call (Scope-Session) UACIPostRemoveParameter. Comma separated names of the parameters that you want to remove from the session after the API call is executed. This parameter is helpful when you want to remove some parameters that are not required for further processing. Multiple parameter names can be passed and comma separated.
Synchronous flowchart execution (Scope-Session) UACIWaitForSegmentation If you define this parameter for any method which triggers segmentation (startSession, setAudience, or a postEvent that triggers re-segmentation), flowcharts for the current audience level are executed synchronously. Timeout for this synchronous execution is defined by Platform configuration at path Affinium|interact|offerserving|segmentationMaxWaitTimeInMS

Example : UACIWaitForSegmentation|true|string
Get the cached offers (Scope-Invocation) UACICachedOffers If you define this parameter for getOffers API call, then the offers from previous getOffers call are returned without executing the arbitration logic. If previous list of offers is empty, then offer arbitration takes place and new set of offers are returned. Offer caching feature is enabled when Platform configuration at path Affinium|interact|offerserving|enableOfferCaching is set to True. Example: UACICachedOffers|true|string
Include offers from related audience IDs (Scope-Session) UACISupplementAudience The additional audience IDs whose eligible offers require to be included while getting offers for the session's audience ID. It has the format of audienceLevel1,audienceId1Field1=value1[,audienceId1FieldN=valueN]. Multiple occurrences of this parameter can be used if multiple audience IDs are required for getting offers.
Related Sessions (Scope-Invocation) UACIEmbeddedSession Specifies whether to execute this batch in a separate session. 1 - Yes, 0 - No. It is effective only in startSession and setAudience when this API request is the first command in an executeBatch invocation.
Related Sessions (Scope-Invocation) UACIIncludeArbitration Specifies whether to include offer arbitration summary in the response of getOffers and getOffersForMultipleInteractionPoints request. If API historization is enabled, the same information is saved together with that as well. 1 - Yes, 0 - No.

Contact Tracking (Scope-Invocation)

 UACIContactStatusCode Parameter is a string representing a contact type code. Parameter value must be a valid entry in the UA_ContactStatus table.

Response Tracking (Scope-Invocation)

 UACIResponseTypeCode A value representing a response type code. The value must be a valid entry in the UA_UsrResponseType table.
(Scope-Session) UACIPurgePriorWhiteListOnLoad This parameter when used while calling setAudience method,reloads the white list table in an existing session. If you set UACIPurgePriorWhiteListOnLoad= 1, the previously loaded contents of white list will be removed from this session.
(Scope-Session) UACIPurgePriorBlackListOnLoad This parameter when used while calling setAudience method reloads the black list table in an existing session. If you set UACIPurgePriorWhiteListOnLoad= 1, the previously loaded contents of white list will be removed from this session.
Offer Deduplication (Scope-Session) UACINoAttributeDedupeIfFewerOffer

When you include UACIOfferDedupeAttribute in the startSession call, you can also set UACINoAttributeDedupeIfFewerOffer parameter to specify the behavior in cases where the offer list after deduplication no longer contains enough offers to satisfy the original request.

For example, if you set UACIOfferDedupeAttribute to use the offer category to deduplicate offers and this getOffers call requests that eight offers be returned, deduplication may result in fewer than eight eligible offers. In that case, setting UACINoAttributeDedupeIfFewerOffer parameter to true would result in adding some of the duplicated offers to the eligible list to satisfy the requested number of offers.

UACINoAttributeDedupeIfFewerOffer is set to true by default.
Offer Suppression (Scope-Session) UACIgnoreBlackList

TRUE – When we pass this parameter as true then the contents in Black List table will not be used to suppress otherwise eligible offers.

FALSE – When this is passed as false then all offer available in Black List table will not be displayed/returned to user. This is the default behavior.
Offer Suppression (Scope-Session) UACIIgnoreSuppressionRules

TRUE – When we pass this parameter as true then all real time offer suppressed rules will be skipped during offer arbitration.

FALSE – When we pass this as false then all real time suppressed offer will not be displayed/returned as per rule. This is the default behavior.

Offer Filteration (Scope-Invocation)

 UACIEnableOfferMappingFilter This parameter is defined along with the filter name at runtime during getOffers. The particular filter will be applied to get offers from FlexOffers mapping table.

Offer Filteration (Scope-Invocation)

 UACIDisableOfferMappingFilter This parameter is defined along with the filter name at runtime during getOffers. The particular filter will not be applied while getting offers from the table

Event Pattern States

(Scope-Session)

 UACIMergePatternStates

If this parameter is set with a value of 1, when the audience ID of a session changes from anonymous (not found in the profile) to known (exist in the profile), the event activities happened in the current session will be kept and merged to the existing activities of the known audience ID.

If its value is set to 0 (the default), the event activities of the anonymout audience ID will be discarded.

This parameter, when specified, overrides the configuration setting Affinium|interact|services|eventPattern:mergeUnknownUserInSessionStates.

Event Pattern States (Scope-Session)

 UACISavePatternStates

When this parameter is set with a value of 1, if the audience ID of a session is anonymous (not found in the profile), the states of the event patterns updated in the current session will be saved when this session ends.

When this parameter is set with a value of 0 (the default), if the audience ID of a session is anonymous (not found in the profile), the states of the event patterns updated in the current session will be discarded when this session ends.

This parameter, when specified, overrides the following configuration setting Affinium|interact|services|eventPattern:persistUnknownUserStates.

Event Pattern States (Scope-Session)

 UACIShowPatternStates To include the states of event patterns belonging to the current audience ID in the response of postEvent API call.

Profile Filtering (Scope-Session)

 UACIProfileFields

A pipe (|) separated string with each component being a profile field name. If this parameter is passed and is not empty, only values of the specified fields will be returned on calling getProfile method.

Profile Filtering (Scope-Session)

 UACIGetProfileShowDimFields If this parameter is passed with value equal to 1, the dimensional fields (usually the fields in dimensional profile table(s) will be returned on getProfile call. Otherwise, only the top level fields are returned. The default value is 0.

Offer Filteration (Scope-Session)

 UACIQueryOffersBySQL

To detect whether or not engine should execute the offersBySQL logic on getOffers call. To enable, set Affinium|interact|profile|Audience Levels|Customer|Offers By Raw SQL|enableOffersByRawSQL to true.

Offer Filteration

(Scope-Session)

 UACIOffersBySQLTemplate

To fetch offer sql from configuration (Affinium|interact|profile|Audience Levels|Customer|Offers By Raw SQL|<SQL Template name>).The sql referenced by this parameter overrides the default SQL (Affinium|interact|profile|Audience Levels|Customer|Offers By Raw SQL|defaultSQLTemplate) specified in configuration for the Offer By Raw SQL feature.

Offer Attributes(output)

 UACICellCode

If an offer attributes contain an attribute matching "UACICellCode", the cell code for the treatment will be returned as the value for this offer attribute on a getOffers call.

Offer Attributes (output)

 UACICellName

If an offer attributes contain an attribute matching "UACICellName", the cell name for the treatment will be returned as the value for this offer attribute on a getOffers call.

Offer Attributes (output)

 UACIZoneID

If an offer attributes contain an attribute matching "UACIZoneID", the zone id for the treatment will be returned as the value for this offer attribute on a getOffers call.

Offer Attributes (output)

 UACISegmentID If an offer attributes contain an attribute matching "UACISegmentID", the segment id for the treatment will be returned as the value for this offer attribute on a getOffers call.

Offer Attributes (output)

 UACIOfferID If an offer attributes contain an attribute matching "UACIOfferID", the offer Id for the treatment will be returned as the value for this offer attribute on a getOffers call.

Offer Attributes (output)

 UACIOfferListID If the return offer is selected from an offer list configured in a rule, this attribute is included in the response to indicate the ID of the offerList for the treatment.

Offer Attributes

(output)

 UACIABTestBranchName If the returned offer is the outcome of an A/B testing, this attribute is included in the response to indicate the name of the selected A/B testing branch.

Runtime environment reserved parameters

The following reserved parameters are used by the runtime environment. Do not use these names for your event parameters.
  • UACIResponseTypeCode
  • UACIContactStatusCode
  • UACILogToLearning
  • UACIOfferTrackingCode
  • UACIOfferTrackingCodeType
  • ResetEventPattern
  • PatternToReset
  • ResetOfferSuppression
  • OfferToResetSuppression
  • UACICustomLoggerTableName
  • UACIExecuteFlowchartByName
  • UACIOffersBySQLTemplate
  • UACIQueryOffersBySQL
  • UACIGetProfileShowDimFields
  • UACIProfileFields
  • UACIOfferFields
  • UACIExcludeOfferFields
  • UACIPurgePriorBlackListOnLoad
  • UACIPurgePriorWhiteListOnLoad
  • UACIMergePatternStates
  • UACIResetMergedPatternStates
  • UACISavePatternStates
  • UACIShowPatternStates
  • UACIOfferDedupeAttribute
  • UACINoAttributeDedupeIfFewerOffer
  • UACIIgnoreBlackList
  • UACIIgnoreSuppressionRules
  • UACILogSeparationFileName
  • UACICachedOffers
  • UACIWaitForSegmentation
  • UACIPreRemoveParameter
  • UACIPostRemoveParameter
  • UACIInteractiveChannelName
  • UACIInteractiveChannelID
  • UACIInteractionPointName
  • UACIInteractionPointID
  • UACIEventName
  • UACIEventID
  • UACISessionID
  • UACIEnableOfferMappingFilter
  • UACIDisableOfferMappingFilter
  • UACICellCode
  • UACICellName
  • UACIOfferID
  • UACISegmentID
  • UACIZoneID
  • UACIABTestBranchName
  • UACIEmbeddedSession
  • UACIEventTime
  • UACIIncludeArbitration
  • UACIIncludeAttributeMetadata