Integration and Configuration

setTrackId

String

Enter your Mapp Intelligence track ID (provided by Mapp).

empty

yes

setTrackDomain

String

Enter your Mapp Intelligence tracking URL.

empty

yes

setDomain

String[]

Specify the domains you do not want to identify as an external referrer (e.g. your subdomains).

$_SERVER['HTTP_HOST']

no

addDomain

String

Specify the domain you do not want to identify as an external referrer (e.g. your subdomains).

empty

no

setUseParamsForDefaultPageName

String[]

Includes specific URL parameter(s) in the default page name.

empty

no

addUseParamsForDefaultPageName

String

Includes specific URL parameter(s) in the default page name.

empty

no

setActivateAdvancedPermission

Boolean

Enable if you need to differentiate between additional usage options for the tracked data, e.g., only to your Intelligence instance or to both Intelligence and Engage.

false

no

setAdvancedPermissionCategory

Integer

• 0 (default): only Intelligence

• 3: Intelligence and Engage

0

no

setContainsInclude

String[]

Specify the strings that must be contained in the request URL to measure the request.

empty

no

addContainsInclude

String

Specify the string that must be contained in the request URL to measure the request.

empty

no

setContainsExclude

String[]

Specify the strings that must be contained in the request URL to not measure the request.

empty

no

addContainsExclude

String

Specify the string that must be contained in the request URL to not measure the request.

empty

no

setMatchesInclude

String[]

Specify the regular expressions that must be match the request URL to measure the request.

empty

no

addMatchesInclude

String

Specify the regular expression that must be match the request URL to measure the request.

empty

no

setMatchesExclude

String[]

Specify the regular expressions that must be match the request URL to not measure the request.

empty

no

addMatchesExclude

String

Specify the regular expression that must be match the request URL to not measure the request.

empty

no

setLogger

MappIntelligenceLogger

Activates the debug mode. The debug mode sends messages your own LoggerClass (see MappIntelligenceLogger).

null

no

setLogLevel

String

Specify the debug log level:

• NONE: no logs

• FATAL: fatal errors

• ERROR: errors leading to data loss or break code

• WARN: errors that can affect data quality

• INFO: general info on configuration and send status

• DEBUG: general info on request sendout and queue status

ERROR

no

setDebug

Boolean

Activates the debug mode. The debug mode sends messages to the PHP system logger (Operating System's system logging mechanism or a file, depending on what the error_log configuration directive is set to).

false

no

setDeactivate

Boolean

Deactivate the tracking functionality.

false

no

setConsumerType

String

Specify the consumer to use for data transfer to Intelligence ( CURL, FORK_CURL, FILE, FILE_ROTATION or CUSTOM).

CURL

no

setConsumer

MappIntelligenceConsumer

Specify the custom consumer for data transfer to Intelligence (see MappIntelligenceConsumer).

null

no

setFilename

String

Enter the path to your request logging file. This is only relevant when using FILE consumer.

sys_get_temp_dir() . '/MappIntelligence

Requests.log'

no

setFilePath

String

Enter the path to your request logging file. This is only relevant when using FILE_ROTATION consumer.

sys_get_temp_dir() . '/'

no

setFilePrefix

String

Enter the prefix from your request logging files. This is only relevant when using FILE_ROTATION consumer.

MappIntelligenceRequests

no

setMaxAttempt

Integer

Specify the number of resend attempts. After the maxAttempts have been reached, the requests will be deleted even if the sending failed.

1

no

setAttemptTimeout

Integer

Specify the interval of request resend in milliseconds.

100

no

setMaxBatchSize

Integer

Specify the maximum request number per batch.

50

no

setMaxQueueSize

Integer

Specify the maximum number of requests saved in the queue.

1000

no

setMaxFileLines

Integer

The maximum number of lines per file.

10 * 1000

no

setMaxFileDuration

Integer

The maximum file duration.

30 * 60 * 1000

no

setMaxFileSize

Integer

The maximum number of maximal file size.

24 * 1024 * 1024

no

setForceSSL

Boolean

Sends every request via SSL.

true

no

setUserAgent

String

Enter the origin client HTTP user agent string.

$_SERVER['HTTP_USER_AGENT']

no

setClientHintUserAgent

String

Enter the origin Client Hint header for "sec-ch-ua" (see  How can I make my website ready for Google Chrome's Client Hints? and  Information on Google Chrome User-Agent Client Hints for more details).

empty

no

setClientHintUserAgentFullVersionList

String

Enter the origin Client Hint header for "sec-ch-ua-full-version-list" (see  How can I make my website ready for Google Chrome's Client Hints? and  Information on Google Chrome User-Agent Client Hints for more details).

empty

no

setClientHintUserAgentMobile

String

Enter the origin Client Hint header for "sec-ch-ua-mobile" (see  How can I make my website ready for Google Chrome's Client Hints? and  Information on Google Chrome User-Agent Client Hints for more details).

empty

no

setClientHintUserAgentModel

String

Enter the origin Client Hint header for "sec-ch-ua-model" (see  How can I make my website ready for Google Chrome's Client Hints? and  Information on Google Chrome User-Agent Client Hints for more details).

empty

no

setClientHintUserAgentPlatform

String

Enter the origin Client Hint header for "sec-ch-ua-platform" (see  How can I make my website ready for Google Chrome's Client Hints? and  Information on Google Chrome User-Agent Client Hints for more details).

empty

no

setClientHintUserAgentPlatformVersion

String

Enter the origin Client Hint header for "sec-ch-ua-platform-version" (see  How can I make my website ready for Google Chrome's Client Hints? and  Information on Google Chrome User-Agent Client Hints for more details).

empty

no

setRemoteAddress

String

Enter the origin client Remote address (ip).

$_SERVER['REMOTE_ADDR']

no

setReferrerURL

String

Enter the origin client HTTP referrer URL.

$_SERVER['HTTP_REFERER']

no

setRequestURL

String

Enter the origin client HTTP request URL.

"https://" . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI']

no

setCookie

String[]

Enter a array of all origin client cookies.

$_COOKIE

no

addCookie

String

Enter a origin client cookie (key, value).

empty

no