v7

The server configuration file

The overall configuration of Adobe Campaign is defined in the serverConf.xml file, located in the conf directory of the installation directory. This section lists all the different nodes and parameters of the serverConf.xml file.

The first parameters are inside the shared node. These are related to the instance. They are potentially used by all the nlserver commands (nlserver web, nlserver wfserver, etc.). The other sections are related to a specific nlserver sub-command.

Shared parameters

• authentication
• dataStore
• dnsConfig
• exec
• htmlToPdf
• ims
• javaScript
• mailExchanger
• module
• monitoring
• ooconv
• proxyConfig
• threadPool
• urlPermission
• cusHeaders
• xtkJobs

Other parameters

• archiving
• inMail
• interactiond
• mta
• nmac
• pipelined
• repair
• securityZone
• sms
• stat
• syslogd
• tracking
• trackinglogd
• web
• wfserver

authentication

Here are the different parameters of the authentication node:

Parameter	Description	Type	Default value
checkIPConsistent	Enable IP address checking.	Boolean	false
defaultMode	Default identification mode.	String	'nl'
longSessionTimeOutSec	Timeout of long sessions in seconds.	Long	1296000
securityTimeOutSec	Security token timeout in seconds.	Long	86400
sessionCacheSec	Cache duration: cache of session information in seconds.	Long	600
sessionTimeOutSec	Session timeout in seconds.	Long	86400

XTK

Here are the different parameters of the authentication > XTK node:

Parameter	Description	Type	Default value
internalPassword	Password of internal account.	String
internalSecurityZone	Internal account security zone: authorized zone for the internal account.	String	'lan'

dataStore

Here are the different parameters of the dataStore node. This is where the server data sources are defined.

Parameter	Description	Type	Default value
exportDirectory	Export directory: path of destination directory for the exported data.	String	'$(XTK_INSTALL_DIR)/var/$(INSTANCE_NAME)/export/'
extraSandboxedDirectories	Extra sandboxed directories: other paths to be added in the sandbox (coma separated).	String	'/home/customers/,/sftp/'
formCacheTimeToLive	Form cache expiration delay: timeout in seconds after which a cache entry is invalidated. O means that cache entries are only refreshed at publication time.	Long	600
hosts	DNS masks: list of DNS masks that this instance serves (comma separated, can use * and ? patterns).	String	'*'
interactionCacheTimeToLive	Interaction JSSP cache expiration delay: timeout in seconds after which a cache entry is invalidated. A negative value means that the cache is always invalidated. '0', empty or invalid values are considered to be 60.	Long	300
lang	Instance language (enumeration). Possible values are 'fr_FR' (Français), 'en_GB' (English (UK)), 'en_US' (English (US)), 'de_DE' (Deutsch) and 'ja_JP' (Japanese).	String	'en_US'
uploadDirectory	Upload folder: path of destination directory for the uploaded data.	String	'$(XTK_INSTALL_DIR)/var/$(INSTANCE_NAME)/upload/'
uploadAllowlist	Authorized files to be downloaded separated by ','. The string must be a valid, regular java expression. See Limiting uploadable files.	String	'.+'
useVault	Store secrets in Vault: use Hashicorp Vault.	Boolean	false
vaultSecretPath	Secret path in Vault	String	'/v1/secret/campaign/'
vaultTokenPath	Local path of the file that contains the vault token. $(HOME) can be used in this path (but not other env variables).	String	'$(HOME)/.vaulttoken'
vaultUrl	Hashicorp Vault URL	String
viewCacheTimeToLive	Validity period of view cache: timeout in seconds after which a cache entry is invalidated. A negative value means that the cache is always invalidated. '0', empty or invalid values are considered to be 60.	Long	600
workingDirectory	XPath of the working directory.	String	workingDirectory : XPath of the working directory. Default: '$(XTK_INSTALL_DIR)/var/$(INSTANCE_NAME)/workspace/'

proxyAdjust

Here are the different parameters of the dataStore > proxyAdjust node. URLs matching the regular expression are regenerated based on the URL defined in urlBase.

Parameter	Description	Type
urlBase	Base to use when generating external URLs. Ex: https://server.domain.com	String
urlRegEx	Regular expression to match URLs. Ex: http://server\.lan\.net.*	String

dataSource

Here are the different parameters of the dataStore > dataSource node.

Parameter	Description	Type	Default value
name	Data Source name	String	default

In the dataStore > dataSource > dbcnx node, configure the connection settings:

Parameter	Description	Type	Default value
NChar	Unicode storage	Boolean
dbSchema	Workspace	String
encrypted	Encrypted password	Boolean
login	Account	String
password	Password	String
provider	Type (enumeration). Possible values are 'Oracle', 'MSSQL' (Microsoft SQL Server), 'PostgreSQL' (PostgreSQL), 'Teradata', 'DB2', 'MySQL', 'Netezza', 'AsterData', 'SAPHANA' (SAP HANA), 'RedShift' (Amazon Redshift), 'ODBC' (ODBC (Sybase ASE, Sybase IQ)), 'Relay' (HTTP relay to remote database).	String	'Oracle'
server	Server	String
timezone	Time zone: see Time zone management.	String
unicodeData	Unicode data in the database	Boolean
useTimestampTZ	Date fields with time zone: see Time zone management.	Boolean

In the dataStore > dataSource > sqlParams node, configure the SQL parameters:

Parameter	Description	Type
funcPrefix	Function prefix	String

In the dataStore > dataSource > pool node, configure the parameters of associated connections pool:

Parameter	Description	Type
aliveTestDelaySec	Delay between connection validity checks.	Short
freeCnx	Number of free connection kept in the pool.	Short
maxCnx	Maximum number of allowed connections before refusing a new connection. See this technote.	Short
maxIdleDelaySec	Maximum idle time of connection. 0 means default value.	Short

virtualDir

Here are the different parameters of the dataStore > virtualDir node. This is the configuration of the virtual directory to real directory mapping.

For additional information, refer to Managing public resources.

Parameter	Description	Type
name	Name of the virtual directory	String
path	Full path of the actual directory	String

Here is the default configuration:

<virtualDir name="images" path="$(XTK_INSTALL_DIR)/var/res/img/"/>
<virtualDir name="formCache" path="$(XTK_INSTALL_DIR)/var/$(INSTANCE_NAME)/formCache/"/>
<virtualDir name="publicFileRes" path="$(XTK_INSTALL_DIR)/var/res/$(INSTANCE_NAME)"/>

preprocessCommand

Here are the different parameters of the dataStore > preprocessCommand node. These are the authorized commands for pre-processing of the ‘Load file’ workflow activity.

Parameter	Description	Type
command	Command line	String
label	Command line label	String
name	Command line name	String

Here is the default configuration:

<preprocessCommand command="" label="None" name="none"/>
<preprocessCommand command="zcat &quot;$fileName&quot;" label="Decompression" name="zcat"/><preprocessCommand command="gpg --decrypt &quot;$fileName&quot;" label="Decrypt" name="gpg"/>

dnsConfig

Here are the different parameters of the dnsConfig (DNS configuration) node.

For additional information, refer to this section.

Parameter	Description	Type	Default value
localDomain	Domain name: default domain name. Used by the SMTP HELO command. By default, uses the network parameters of the first network interface declared in Windows; or parses the file/etc/resolv.conf under Linux (domain or search entry).	String
nameServers	DNS server: comma separated list of domain name servers (DNS). See the note below.	String
retry	Number of retries for a DNS query.	Long	4
timeout	Timeout in milliseconds for a DNS query.	Long	5000

exec

Here are the different parameters of the exec (command execution) node.

For additional information, refer to Restricting authorized external commands.

Parameter	Description	Type
blacklistFile	Path to the file containing the commands to add to the allowlist.	String
user	Execute commands as a different user.	String

htmlToPdf

Here are the different parameters of the htmlToPdf node. This is the configuration of the service for converting web pages into PDF documents.

Parameter	Description	Type	Default value
command	Command line for running the conversion (in 'other' mode).	String
maxProcessusCount	Max. number of conversion processes allowed at a time on one machine.	Long	5
mode	Tool to use for the conversion. Possible values are: phantomjs, wkhtmltopdf, other, disabled	String	'phantomjs'
timeout	Timeout for a conversion: maximum conversion time in seconds. Beyond this threshold, the conversion process is stopped and an error is raised.	Long	120
verbose	Verbose mode: start in verbose mode to diagnose possible errors.	Boolean	false
waitTime	Delay when waiting for a process: delay in seconds, when all processes are used at the same time and when waiting for a process to free up. If this delay is exceeded, conversion is stopped and an error is raised.	Long	15

Example for phantomjs:

phantomjs - -ignore-ssl-errors=true '$(XTK_INSTALL_DIR)/bin/htmlToPdf.js' '-out:{outPdf}' '-post:{postFile}' '-url:{originUrl}' -sessiontoken:{sessiontoken} -format:{format} -orientation:{orientation} -marginTop:{marginTop} -marginLeft:{marginLeft} -marginRight:{marginRight} -marginBottom:{marginBottom}

ims

Here are the different parameters of the ims node. This is the configuration for Campaign connecting to another service using IMS.

Parameter	Description	Type	Default value
authIMSClientId	Client ID	String
authIMSClientSecret	Secret key (encrypted in AES)	String
authIMSCode	Authorization code (encrypted in AES)	String
authIMSEndpoint	IMS server URL	String	'https://ims-na1.adobelogin.com'
authIMSTAClientId	Technical Account Client ID	String
authIMSTAClientSecret	Technical Account Secret key (encrypted in AES)	String
authIMSTAId	Technical Account ID	String
authIMSTAPrivateKey	Technical Account Private Key (encrypted in AES)	String

JavaScript

Here are the different parameters of the javaScript node. This is the configuration of the JavaScript interpreter.

For additional information, refer to the Reporting documentation.

Parameter	Description	Type	Default value
maxMB	Maximum size in megabytes before running the garbage collector.	Long	512
stackSizeKB	Size of each stack chunk in kilo octets. This is a memory management tuning parameter which most users should not adjust.	Long	8

mailExchanger

Here are the different parameters of the mailExchanger node. This is the configuration of the SMTP server.

Parameter	Description	Type	Default value
mxAddress	SMTP server: IP address of SMTP server for the transfer of emails.	String
mxPort	TCP port of SMTP server used for the Email transfer.	String	25

module

Here are the different parameters of the module node. This is the configuration for the namespaces restrictions module xtk.

Parameter	Description	Type	Default value
defaultNameSpace	Default namespace used when creating a new entity.	String	'cus'

monitoring

Here are the different parameters of the monitoring node. This is the monitoring service configuration.

Parameter	Description	Type	Default value
maxPreparationJobsSec	Maximum preparation time: duration in seconds after which a delivery action should no longer be in preparation.	Long	3600
unixScript	Unix script ran by the monitoring service.	String
winScript	Windows script to be executed by the monitoring service.	String

ooconv

Here are the different parameters of the ooconv node. This is the configuration of the document conversion server.

Parameter	Description	Type	Default value
maxConversions	Maximum number of conversions which an OpenOffice server is allowed to perform. Beyond this number, the server is restarted.	Long	1000
maxServerIdleSec	Maximum idle time of OpenOffice server before forced closing.	Long	7200
portRange	Interval of ports on which the OpenOffice servers are listening.	String	8101-8110
url	URL of the document conversion server.	String	'http://localhost:8080/nl/jsp/ooconv.jsp'

proxyConfig

Here are the different parameters of the proxyConfig node. This is the configuration of proxy parameters.

For additional information, refer to Proxy connection configuration.

Parameter	Description	Type	Default value
enabled	Use a proxy server.	Boolean	false
override	Exceptions: list of addresses for which proxy parameters shall be ignored.	String	'localhost*'
useSingleProxy	Unique proxy server: use the same configuration for all types of proxy.	Boolean	false

HTTP Proxy / Secure proxy

In the proxyConfig > HTTP Proxy / Secure proxy node, configure the following parameters.

For additional information, refer to Proxy connection configuration.

Parameter	Description	Type
address	Address of proxy server	String
login	Login for the connection to proxy server	String
password	Password for the connection with proxy server	String
port	Proxy server port	Short

threadPool

Here are the different parameters of the threadPool node.

Parameter	Description	Type	Default value
maxThreadCount	Maximum number of threads in pool.	Long	10

urlPermission

Here are the different parameters of the urlPermission node. This is the list of URLs that the Javascript code can access.

List of domains and regular expressions specifying whether a URL encountered in the Javascript code can or cannot be used by the Adobe Campaign server.

If the URL cannot be found, the default action is carried out, according to the default mode specified.

For additional information, refer to Outgoing connection protection.

Parameter	Description	Type	Default value
action	Default action if the URL is not in the authorized list (enumeration). Possible values are 'ignore' (authorize without warning message, this requires disabling the protection), 'warn' (authorize and issue a warning message) and 'deny' (prohibit access to the URL).	String	deny
debugTrace	Debugging trace of the URL selection mechanism: issues additional messages during the URL verification process.	Boolean	false

cusHeaders

This node allows you to add specific headers in requests performed when uploading a file from an external server. Content Delivery Networks (CND) can ask for a specific header in order to trust the requester. These headers can be used to improve the trust on Campaign requests, particulary when downloading personalized documents for each recipient at delivery execution step. A high number of resource download requests can be interpreted as a DDos attack. dnsPattern allows you to to set specific header names and values for different CDNs based on their domain name.

  <!-- List of custom headers added to request.
         -->
    <cusHeaders>

    <!-- Pattern of DNS name or domain
         value :  dnsPattern: All or part of the URL's domain to verify, * is a wild card Default:  -->
      <dnsPattern value="">

    <!-- Header Name and Value
           headerName :  Header Name
           headerValue :  Header Value -->
        <headerDef headerName="" headerValue=""/>

      </dnsPattern>

    </cusHeaders>

url

For each URL, add a url node with the following parameters:

For additional information, refer to Outgoing connection protection.

Parameter	Description	Type
dnsSuffix	Domain name, or domain parent, concerned by the URL: all or part of the URL's domain to verify, to accelerate the verification. The URL is only verified with respect to the regular expression if its domain contains dsnSuffix.	String
urlRegEx	Regular expression to refine validating URLs belonging to this domain: regular expression that the URL must verify, should it correspond to dnsSuffix.	String

If a record satisfies dnsSuffix but not urlRegEx, the following record is examined.

For example, to authorize access to all of the URLs of the domain business.com, we can define two records:

dnsSuffix=“business.com” urlRegEx=“http://.*”

and

dnsSuffix=“business.com” urlRegEx=“https://.*”

Here is the default configuration:

<url dnsSuffix="api.omniture.com" urlRegEx="https://api.omniture.com/genesis/i/3.1.*"   />
<url dnsSuffix="omniture.com" urlRegEx="https://api[1-5].omniture.com/genesis/i/3.1.*"  />
<url dnsSuffix="marketing.adobe.com"                     urlRegEx="https://.*"                                    />
<url dnsSuffix="fcm.googleapis.com"                      urlRegEx="https://fcm.googleapis.com/fcm/send.*"       />
<url dnsSuffix="graph.facebook.com"                      urlRegEx="https://.*"                                    />
<url dnsSuffix="api.line.me"                             urlRegEx="https://api.line.me/.*"                      />
<url dnsSuffix="api.twitter.com"                         urlRegEx="https://api.twitter.com/1.1.*"              />
<url dnsSuffix="adobeid-na1.services.adobe.com"          urlRegEx="https://.*"                                    />
<url dnsSuffix="adobeid-na1-stg1.services.adobe.com"     urlRegEx="https://.*"                                    />
<url dnsSuffix="localhost"                               urlRegEx="http://localhost:8080/nms/jsp/.*"              />
<url dnsSuffix="localhost"                               urlRegEx="http://localhost:8080/nl/jsp/.*"               />
<url dnsSuffix="localhost"                               urlRegEx="http://localhost:8080/xtk/jsp/.*"              />

xtkJobs

Here are the different parameters of the xtkJobs node. This is the configuration of the server jobs.

Parameter	Description	Type	Default value
purgeLogsPeriod	Memory status refresh period of server processing (in ms).	Long	500

archiving

Here are the different parameters of the archiving node. This is the configuration of the executed archiving operations in the background.

For additional information, refer to Activating email archiving (on premise).

Parameter	Description	Type	Default value
acquireLimit	Number of EMLs to process at the same time	Long	100
archivingType	Archiving strategy of sent messages (enumeration). Possible values are '0' (no archiving) and '1' (transfers archiving of sent messages to a SMTP server).	Byte	0
args	Start-up parameters	String
autoStart	Automatic start	Boolean	false
compressBatchSize	Size of a compressed archive: max number of files in a compressed archive.	Long	10000
compressionFormat	Compression format used during archiving (enumeration). Possible values are '0' (no compression) and '1' (compress sent messages using zip format).	Byte	1
expirationDelay	Delay before automatic archiving of unprocessed emails: number of days before unprocessed emails are archived.	Long	2
initScript	ID of JavaScript to execute when starting the process.	String
maxProcessMemoryAlertMb	Memory consumption alert: alert concerning the amount of RAM consumed (in Mb) by a given process.	Long	1800
maxProcessMemoryWarningMb	Memory consumption warning: warning concerning the amount of RAM consumed (in Mb) by a given process.	Long	1600
pollDelay	Delay (in seconds) between each update event.	Long	60
processRestartTime	Time of the day when the process is automatically restarted. See Automatic process restart.	String	'06:00:00'
purgeArchivesDelay	Number of days before unprocessed emails are deleted.	Long	7
runLevel	Priority at start. Low priority modules are first started and last stopped. The syslogd module must therefore have the priority 0.	Short	10
smtpBccAddress	Archiving target destination	String
smtpEnableTLS	Activate SMTPS support: activates the delivery of emails in safe mode (STARTTLS/SMTPS) when supported by the remote server.	Boolean	false
smtpNbConnection	Number of connections to the archiving SMTP server.	Long	1
smtpRelayAddress	Comma-separated list of DNS names or IP addresses of SMTP relays to use.	String
smtpRelayPort	IP port of SMTP server.	Long	25

inMail

Here are the different parameters of the inMail node. This is the configuration of the inbound Email management module.

Parameter	Description	Type	Default value
args	Start-up parameters	String
autoStart	Automatic start	Boolean	false
checkInstanceName	Verify instance name: if true, the name of the Adobe Campaign instance contained in the Message-ID headers must be the same as the current instance.	Boolean	true
defaultForwardAddress	Forwarding address: default email transfer address not processed by a rule.	String	false
errorForwardAddress	Address for errors: default address used to transfer invalid Emails (bad MIME encoding).	String
ignoreSize	Ignore message size: is used to ignore the size of a message returned by POP3 servers. In this case, the module expects a '.' at the end of the messages.	Boolean	false
inMailPeriodSec	Message reading period: message queue polling frequency.	Long	5
initScript	ID of JavaScript to execute when starting the process.	String
maxBroadLog	Maximum number of logs to update: defines the maximum number of log messages to keep in memory before updating the database.	Long	20
maxMsgPerSession	Maximum number of messages to read during POP3 session.	Long	200
maxProcessMemoryAlertMb	Memory consumption alert: alert concerning the amount of RAM consumed (in Mb) by a given process.	Long	1800
maxProcessMemoryWarningMb	Memory consumption warning: warning concerning the amount of RAM consumed (in Mb) by a given process.	Long	1600
maxSessionTTLSec	Session duration: maximum duration of message processing session.	Long	100
popMailPeriodSec	POP3 polling period	Long	300
popQueueSize	Queue size of read messages	Long	100
popTimeoutSec	Communication timeout with POP3 server.	Long	300
processRestartTime	Time of the day when the process is automatically restarted. See Automatic process restart.	String	'06:00:00'
reloadPeriodSec	Database reload frequency of accounts to be polled.	Long	600
runLevel	Priority at start. Low priority modules are first started and last stopped. The syslogd module must therefore have the priority 0.	Short	10

msgDump

In the inMail > msgDump node, configure the following parameters. This is the configuration of the dump of processed messages.

Parameter	Description	Type	Default value
dump	Save all inbound messages in text format.	Boolean	false
msgPath	Message dump path.	String	'/tmp/inMail'

interactiond

Here are the different parameters of the interactiond node. This is the configuration of the write daemon for inbound Interaction events.

For additional information, refer to Interaction - Data buffer.

Parameter	Description	Type	Default value
args	Start-up parameters	String
autoStart	Automatic start	Boolean	false
callDataSize	Max. number of characters stored in the shared memory for call data.	Long	0
initScript	ID of JavaScript to execute when starting the process	String
maxProcessMemoryAlertMb	Memory consumption alert: alert concerning the amount of RAM consumed (in Mb) by a given process.	Long	1800
maxProcessMemoryWarningMb	Memory consumption warning: warning concerning the amount of RAM consumed (in Mb) by a given process.	Long	1600
maxSharedEntries	Max. number of events stored in the shared memory.	Long	25000
nextOffersSize	Maximum number of eligible offers sorted right after propositions, to be stored for statistics.	Long	0
processRestartTime	Time of the day when the process is automatically restarted. See Automatic process restart.	String	'06:00:00'
runLevel	Priority at start. Low priority modules are first started and last stopped. The syslogd module must therefore have the priority 0.	Short	10
statsPeriod	Aggregation duration in seconds for the response time statistics. 0 means statistic storage was deactivated.	Long	600
targetKeySize	Max. number of characters stored in the shared memory for identifying individuals.	Long	16

mta

Here are the different parameters of the mta node. This is the configuration of delivery agents.

b

Parameter	Description	Type	Default value
args	Start-up parameters	String	'-tracefilter:nlmta'
autoStart	Automatic start	Boolean	false
dataLogPath	Save path of emails sent: if not empty, the path where all source files of sent emails will be saved.	String
debugPath	Dump directory:iIf not empty, copy MIME envelopes of sent mail messages in this directory. Used for trouble shooting.	String
dnsRequestLogDelayMs	DNS query logs delay: time in milliseconds to display the logs.	Long
errorPeriodSec	Error statistics frequency: time between generation of statistics and storage in the database.	Long	300
initScript	ID of JavaScript to execute when starting the process.	String
logEmailErrors	Generate error statistics and store them in the database.	Boolean	true
logLevel	Display level of log messages. Severity level of the logs written in the database. Log messages generated by the MTA are not all always written in the database. With this parameter, you can define the level from which you consider a message must be written in the database. If you define level 2, messages of level 1 and 0 are also written, whereas if you define level 1, only messages of level 1 and 0 are written. Possible values are: 0 (errors), 1 (warning), 2 (info)	Long	2
maxMemoryMb	Maximum memory size (in MB) that an mta process can use. Above this limit, the process is re-started so that the memory it uses is released to the system.	Long	1024
maxProcessMemoryAlertMb	Memory consumption alert: alert concerning the amount of RAM consumed (in Mb) by a given process.	Long	1800
maxProcessMemoryWarningMb	Memory consumption warning: warning concerning the amount of RAM consumed (in Mb) by a given process.	Long	1600
minConnectionsToLog	Connection threshold to take into account. Error statistics are not generated for a given path if the total number of connections for the period specified by errorPeriodSec is strictly lower than the threshold.	Long	100
minErrorsToLog	Error threshold to take into account: error statistics are not generated for a given path if the total number of errors for the period specified by errorPeriodSec is strictly lower than the threshold.	Long	1
minMessagesToLog	Message threshold to take into account. Error statistics are not generated for a given path if the total number of messages sent for the period specified by errorPeriodSec is strictly lower than the threshold.	Long	1000
notifRelay	Notification relay: HostName:Port used to relay notifications.	String
processRestartTime	Time of the day when the process is automatically restarted. See Automatic process restart.	String	'06:00:00'
purgeDataLogDelay	Delay before archived emails are deleted: number of days before archived emails in the directory specified in dataLogPath are purged.	Long	15
retryLostMessages	Retry lost messages: parts of deliveries will be retried if the child process is dead.	Boolean	true
runLevel	Priority at start. Low priority modules are first started and last stopped. The syslogd module must therefore have the priority 0.	Short	10
signEmailLinks	Enable the signature mechanism. This improves security on tracking links in email.	Boolean	true
statServerAddress	Address of the delivery statistics server, given as <dns or ip> [: <port> ]. See Coordinates of the statistics server.	String	If not defined, the default port is 7777.
statServerTLSSupport	Enable TLS by domain: enables the TLS configurable by MX (requires an up-to-date statistics server).	Boolean	true
useMomentum	If set to "true", your instance is using the Enhanced MTA.	Boolean
verifyMode	Verification mode: activates the verify mode (no physical transmission of messages; used for simulation and tests).	Boolean	false
workingPath	Working directory: location of temporary files used by the MTA to communicate with its child processes.	String	'$(XTK_INSTALL_DIR)/var/$(INSTANCE_NAME)/mta/'
xMailer	X-Mailer field: value of field 'X-Mailer' in SMTP mail header.	String	'nlserver, Build $(PRODUCT_VERSION)'

cache

In the cache node, configure the following parameters. This is the local file cache configuration.

Parameter	Description	Type	Default value
maxPeriodSec	Recycled after: period, expressed in seconds, after which the file is automatically deleted from the cache to reclaim storage.	Long	244800
maxSizeOnDiskMb	Maximum cache size (Mb).	Long	1024
purgePeriodSec	Purge frequency: period in seconds between executions of the cache purge mechanism.	Long	3600

relay

In the mta > relay node, configure the following parameters. This is the configuration of the mail server for the message delivery.

The list will be handled in the same way as a list of MX returned by a MX DNS query, usually the first MX is used as long as it is available, then the next one is used, and so on.

For additional information, refer to SMTP relay.

Parameter	Description	Type	Default value
address	Comma-separated list of DNS names or IP addresses of SMTP relays to use.	String
port	IP port of SMTP server.	Long	25

master

In the mta > master node, configure the following parameters. This is the configuration of the main server.

For additional information, refer to this section.

Parameter	Description	Type	Default value
dataBasePoolPeriodSec	Database polling frequency of the jobs to be delivered. This value indicates the database polling frequency (in seconds). To obtain the list of jobs waiting for delivery, the MTA polls the database on a regular basis. When there is no job waiting, the polling period is defined by this value. Otherwise if a job has been transferred to a child server, then this polling duration is automatically reduced to one second so that a new job can be processed again as soon as possible, i.e. as soon as a child server is available again. This does not mean that database query will be done every second until a child server is available again. In fact, a database access is only done when at least one child server becomes available.	Long	30
dataBaseRetryDelaySec	Waiting period after a database connection failure. A database connection failure is usually caused by the database server itself. The server may also be stopped for maintenance purposes, for example. The DataBaseRetryDelay parameter defines the duration between two connection attempts in case of a database connection failure.	Long	60
domainKeysReloadPeriodSec	Validity period for the cache of private keys (DomainKeys). Private keys used to sign emails following the DomainKeys recommendation (http://antispam.yahoo.com/domainkeys) are stored as options in the database. The domainKeysReloadPeriodSec parameter defines how many seconds the MTA can keep these keys in a cache. After this delay, all keys must be reloaded from the database.	Long	600
maxSpareServers	Maximum number of child servers. Represents the maximum number of servers running. It is recommended to limit this number at an optimum compatible with the server memory resources. This can be checked during a delivery. The used memory should not exceed a third of a the physical memory available otherwise the swap will be used. See MTA child processes.	Long	2
minSpareServers	Minimum number of child servers. The MTA tries to keep at least this number of servers running. If there are less, it restarts new servers every second until this value is reached.	Long	0
startSpareServers	Number of child server at start-up. The number of child servers is dynamically monitored; when the MTA starts, it creates as many child servers as indicated by this value. Normally, child servers cannot be started faster than one server per second in order to save host resources. However, when the MTA starts, this limitation is overruled so that child servers are available as soon as possible.	Long	0

child

In the mta > child node, configure the following parameters. This is the configuration of child servers.

For additional information, refer to Email sending optimization.

Parameter	Description	Type	Default value
extraArgs	Optional command line arguments	String
idleChildTimeoutSec	Timeout until idle child servers are stopped. If a child server has an idle time greater than this parameter, it will automatically kill itself to free up host resources.	Long	60
maxAgeSec	Maximum message retention time. If a prepared message could not be sent because of throttling or was not able to connect to the target MTA, the message is abandoned and will be processed at the next retry.	Long	600
maxGCMConnectPerChild	Maximum of parallel Http requests to the FCM initiated by each child server.	Long	8
maxMsgPerChild	Maximum count of messages per child server. Each MTA child processes this number of messages and dies. It is important to specify a number such that memory or resource leaks in the MTA are harmless (typically a few thousands). Even if there are no known memory leaks in the MTA code, the embedded JavaScript and XSL engines are not fully reliable.	Long	5000000
maxWaitingMessages	Pending messages: maximum number of messages waiting in memory to be delivered.	Long	2000
maxWorkingSetMb	Maximum memory size (in MB) that a child process can use. Above this limit, the process is stopped so that the memory it uses is released to the system.	Long	128
soapConnectorTimeoutSec	Timeout (in seconds) after which a SOAP connection for a delivery connector is abandoned.	Long	600
startWithFirstMX	Always start with the highest priority MX.	Boolean	false
timeToLive	Maximum number of consecutive attempts when resumed.	Long	48

In the mta > child > smtp node, configure the following parameters. This is the configuration of SMTP sessions.

Parameter	Description	Type	Default value
enableTLS	Activates the delivery of emails in safe mode (STARTTLS/SMTPS) when supported by the remote server.	Boolean	false
idleSessionTimeoutSec	Idle session timeout. This parameter is only used if the session is reused for transmitting several messages to a given domain. When the MTA has completed the message transmission, the SMTP session it has used is not systematically closed. If a message is ready to be sent for this same domain then the same SMTP session will be reused and this is why the session is not automatically closed. The parameter IdleSessionTimeout parameter lets you define the time during which an SMTP session can remain active waiting for another message. Once the duration has elapsed, the session is automatically closed.	Long	5
initialDelaySec	Initial delay before retrying connection. This delay is doubled each time connection fails.	Long	4
maxSessionsPerChild	Maximum number of SMTP sessions by child server. To deliver a message, the MTA initializes an SMTP connection with the recipient MTA. The maximum number of concurrent and active SMTP sessions for a given child server is limited by this value. If you multiply this value by maxSpareServers, you get the maximum number of messages that can be concurrently processed by a given child server.	Long	1000

In the mta > child > smtp > IPAffinity node, configure the following parameters. This is the configuration of the management of affinities with IP addresses for optimized outgoing SMTP traffic.

For additional information, refer to List of IP addresses to use and Managing outbound SMTP traffic with affinities.

Parameter	Description	Type
localDomain	Domain name: local domain name linked to the IP address. Used when issuing an SMTP HELO command.	String
name	Logical name: names linked to the affinity by users. Names are separated using semicolons;	String

In the mta > child > smtp > IP node, configure the following parameters.

For additional information, refer to List of IP addresses to use.

Parameter	Description	Type
address	Associated physical address. Eg: '192.168.0.1'	String
publicId	Associated public address ID. Used as a key for the statistics server. Must be numeric. See this section.	Long
weight	Specifies the frequency of use for this IP, relative to other IPs (bigger weights lead to higher frequencies).	Long
includeDomains	Comma separated list of domain masks to include.	String
excludeDomains	Comma separated list of domain masks to exclude.	String
heloHost	Computer name linked to the IP address. Used when issuing an SMTP HELO command.	String

nmac

Here are the different parameters of the nmac node. This is the configuration of for push notification deliveries.

Parameter	Description	Type	Default value
useHTTPProxy	Use HTTP proxy defined in shared/proxyHTTP.	Boolean	false

relay

Here are the different parameters of the nmac > relay node. This configures the use of a relay for the message delivery (ios http2 connector).

Parameter	Description	Type	Default value
address	DNS address or name of the relay to use.	String
port	Relay port	Long	443
trustedCertsChain	Certificate chain (PEM file). Useful when using a mock server.	String

pipelined

Here are the different parameters of the pipelined node. This is the configuration of the event processing module for Pipeline Services.

Parameter	Description	Type	Default value
appName	Name of the application generated in the Developer connection when the public key is saved.	String
args	Start-up parameters	String
authGatewayEndpoint	URL to obtain a gateway token.	String	'https://api.omniture.com'
authPrivateKey	Private key to obtain tokens (encrypted in AES with the XtkKey option).	String
autoStart	Automatic start	Boolean	false
disableAuth	Disable authentication: connect to Pipeline Services without authentication.	Boolean	2
discoverPipelineEndpoint	URL to discover the Pipeline Services URL.	String	'https://producer-pipeline-pnw.adobe.net'
dumpStatePeriodSec	Status save period: frequency that the process's internal information is saved in a file. Inactive if 0.	Long	0
forcedPipelineEndpoint	Listening URL: force the listening URL of the Pipeline Services.	String
initScript	ID of JavaScript to execute when starting the process.	String
maxProcessMemoryAlertMb	Memory consumption alert: alert concerning the amount of RAM consumed (in Mb) by a given process.	Long	1800
maxProcessMemoryWarningMb	Memory consumption warning: warning concerning the amount of RAM consumed (in Mb) by a given process.	Long	1600
monitorServerPort	Status server port: HTTP server port allowing you to query the status of the process. Inactive if 0.	Long	7781
pointerFlushMessageCount	The pointer will be stored in the database every time that this number of messages are processed.		1000
pointerFlushPeriodSec	Delay before the pointer is stored: the pointer will be stored in the database at least once during this period (useful in case of low activity).	Long	5
processRestartTime	Time of the day when the process is automatically restarted. See Automatic process restart.	String	'06:00:00'
processingJSThreads	Number of threads for event processing with a personalized JavaScript connector.	Long	4
processingThreads	Number of threads for event processing.	Long	4
retryPeriodSec	Delay between processing if there is a failure.	Long	30
retryValiditySec	Abandon after this period: abandon the event if the processing is still failing after this period.	Long	300
runLevel	Priority at start. Low priority modules are first started and last stopped. The syslogd module must therefore have the priority 0.	Short	10

repair

Here are the different parameters of the repair node. This is the configuration of the database repair module.

Parameter	Description	Type	Default value
repairActionDelayMin	Delivery actions repair module: delay (in minutes) after which delivery actions can be processed by the repair module.	Long	60

securityZone

Here are the different parameters of the securityZone node.

For additional information, refer to Define security zones.

Parameter	Description	Type	Default value
allowDebug	Authorize debug mode for Web applications.	Boolean	false
allowEmptyPassword	Authorize the user to use the application without a password.	Boolean	false
allowHTTP	Authorize the use of HTTP for operator logon.	Boolean	false
allowSQLInjection	Authorize the use of SQLDATA in expressions.	Boolean	false
allowUserPassword	Authorize user/password session tokens.	Boolean	false
label	Label	String	NewLabel()
name	Internal name	String	NewName()
sessionTokenOnly	Do not use the security token.	Boolean	false
showErrors	Display error details	Boolean	false

Here is the default configuration:

<securityZone allowDebug="false" allowHTTP="false" allowSQLInjection="false" label="Public Network" name="public">
  <subNetwork name="all" label="All addresses" mask="*" proxy="127.0.0.1, ::1"/>

  <securityZone allowDebug="true" allowHTTP="false" allowSQLInjection="false" label="Private Network (VPN)"
                name="vpn" showErrors="true">

    <securityZone allowDebug="true" allowEmptyPassword="false" allowHTTP="true" allowUserPassword="false"
                  allowSQLInjection="false" label="Private Network (LAN)" name="lan" sessionTokenOnly="true"
                  showErrors="true">
      <subNetwork name="lan1" label="Lan 1" mask="192.168.0.0/16" proxy="127.0.0.1, ::1"/>
      <subNetwork name="lan2" label="Lan 2" mask="172.16.0.0/12" proxy="127.0.0.1, ::1"/>
      <subNetwork name="lan3" label="Lan 3" mask="10.0.0.0/8" proxy="127.0.0.1, ::1"/>
      <subNetwork name="localhost" label="Localhost" mask="127.0.0.0/8" proxy="127.0.0.1, ::1"/>
      <subNetwork name="lan6"  label="Lan (IPv6)" mask="fc00::/7" proxy="127.0.0.1, ::1"/>
      <subNetwork name="lan6b" label="Lan (IPv6)" mask="fe80::/10" proxy="127.0.0.1, ::1"/>
      <subNetwork name="localhost6" label="Localhost (IPv6)" mask="::1/128" proxy="127.0.0.1, ::1"/>
    </securityZone>

  </securityZone>
</securityZone>

subNetwork

Here are the different parameters of the securityZone > subNetwork node.

For additional information, refer to Define security zones.

Parameter	Description	Type	Default value
label	Label	String	NewLabel()
mask	Mask or address	String
name	Internal name	String	NewName()
proxy	Mask or address of (reverse) proxy used by this sub-network to access the instance. In this case, the 'X-Forwarded-For' header will be tested instead of this proxy.	String	127.0.0.1

sms

Here are the different parameters of the sms node. This is the configuration of the inbound SMS management module.

Parameter	Description	Type	Default value
args	Start-up parameters	String
autoStart	Automatic start	Boolean	false
dataRetentionDays	Maximum number of days files working files kept by the SMPP connector.	Long	60
dataSizeMo	Maximum size in MB of the SMPP working files.	Long	512
initScript	ID of JavaScript to execute when starting the process.	String
keepAlivePeriod	Recurrence of the session continuity frame: max. period in seconds between two frames for notifying that the receiving session is still enabled.	Long	25
maxProcessMemoryAlertMb	Memory consumption alert: alert concerning the amount of RAM consumed (in Mb) by a given process.	Long	1800
maxProcessMemoryWarningMb	Memory consumption warning: warning concerning the amount of RAM consumed (in Mb) by a given process.	Long	1600
pollPeriod	Search frequency: SMS account poll period.	Long	300
processRestartTime	Time of the day when the process is automatically restarted. See Automatic process restart.	String	'06:00:00'
reloadPeriod	Account reload frequency: database reload frequency of accounts to be polled.	Long	600
runLevel	Priority at start. Low priority modules are first started and last stopped. The syslogd module must therefore have the priority 0.	Short	10
srReadDelay	Number of seconds late for SR processing: only SRs with a recovery date earlier than the current time minus the duration in seconds given by srReadDelay.	Long	600
timeout	Communication timeout with SMS gateway.	Long	300

netsize

Here are the different parameters of the sms > netsize node.

Parameter	Description	Type	Default value
netsizeConnectionTimeout	Timeout in seconds when establishing a connection with Netsize.	Long	30

stat

Here are the different parameters of the stat node. This is the configuration of the MTA statistics module.

Parameter	Description	Type	Default value
args	Start-up parameters	String
autoStart	Automatic start	Boolean	false
initScript	ID of JavaScript to execute when starting the process.	String
maxProcessMemoryAlertMb	Memory consumption alert: alert concerning the amount of RAM consumed (in Mb) by a given process.	Long	1800
maxProcessMemoryWarningMb	Memory consumption warning: warning concerning the amount of RAM consumed (in Mb) by a given process.	Long	1600
port	Server listening port. See this section.	Short
processRestartTime	Time of the day when the process is automatically restarted. See Automatic process restart.	String	'06:00:00'
runLevel	Priority at start. Low priority modules are first started and last stopped. The syslogd module must therefore have the priority 0.	Short	10

syslogd

Here are the different parameters of the syslogd node. This is the configuration of the Log management module.

Parameter	Description	Type	Default value
args	Start-up parameters	String
autoStart	Automatic start	Boolean	false
initScript	ID of JavaScript to execute when starting the process.	String
maxFileSizeMb	Maximum size in Mb for a log file.	Long	10
maxNumberOfLoginsFiles	Maximum number of logins.log files to keep.	Long	365
maxProcessMemoryAlertMb	Memory consumption alert: alert concerning the amount of RAM consumed (in Mb) by a given process.	Long	1800
maxProcessMemoryWarningMb	Memory consumption warning: warning concerning the amount of RAM consumed (in Mb) by a given process.	Long	1600
processRestartTime	Time of the day when the process is automatically restarted. See Automatic process restart.	String	'06:00:00'
runLevel	Priority at start. Low priority modules are first started and last stopped. The syslogd module must therefore have the priority 0.	Short	10

tracking

Here are the different parameters of the tracking node. This is the configuration of the tracking server.

Parameter	Description	Type	Default value
args	Start-up parameters	String
autoStart	Automatic start	Boolean	false
blockRedirectForUnsignedTrackingLink	Disable malformed URLs generated from previous builds.	Boolean	false
consolidationPeriodSec	Consolidation period	Long	300
dedupOpenPeriodMin	Deduplicate openings: remove duplicate open tracking logs to limit the effects of mail previews in mail readers like Outlook.	Long	1
errorIgnorePercent	Ignore up to X% of errors: do not update tracking indicators as long as the ratio of journals not already taken into account does not reach this value.	Byte	1
errorIgnorePeriod	Update error indicators: maximum duration before error indicators are recomputed.	Long	86400
indicatorsDuration	Compute indicators during: duration after the validity date of a delivery after which consolidated indicators are no longer computed.	Long	2592000
initScript	ID of JavaScript to execute when starting the process	String
logCountPerRequest	Number of logs requested by call to the remote tracking server.	Long	1000
maxProcessMemoryAlertMb	Memory consumption alert: alert concerning the amount of RAM consumed (in Mb) by a given process.	Long	1800
maxProcessMemoryWarningMb	Memory consumption warning: warning concerning the amount of RAM consumed (in Mb) by a given process.	Long	1600
phishbowlServiceAPIKey	API key for the Phishbowl Service Endpoint Integration. This protects redirection of malformed URLs generated from older builds.	Long
phishbowlServiceEndpoint	Endpoint for the Phishbowl Service Endpoint Integration. This protects redirection of malformed URLs generated from older builds.	Long
processRestartTime	Time of the day when the process is automatically restarted. See Automatic process restart.	String	'06:00:00'
runLevel	Priority at start. Low priority modules are first started and last stopped. The syslogd module must therefore have the priority 0.	Short	10
trackingIgnorePercent	Ignore up to X% of tracking: do not update tracking indicators as long as the ratio of journals not already taken into account does not reach this value.	Byte	1
trackingIgnorePeriod	Update tracking indicators: maximum duration before tracking indicators are recomputed.	Long	86400
userAgentCacheSize	Size of browser identifier cache.	Long	500

trackinglogd

Here are the different parameters of the trackinglogd node. This is the configuration of the tracking log writing daemon.

Parameter	Description	Type	Default value
args	Start-up parameters	String
autoStart	Automatic start	Boolean	false
initScript	ID of JavaScript to execute when starting the process	String
maxCreateFileRetry	Max writing retries: maximum number of files that can be created in case of writing failure in log files.	Long	5
maxLogsSizeOnDiskMb	Maximum log size: maximum space used by logs on disk (in MB). May not be less than 100 MB.	Long	500
maxProcessMemoryAlertMb	Memory consumption alert: alert concerning the amount of RAM consumed (in Mb) by a given process.	Long	1800
maxProcessMemoryWarningMb	Memory consumption warning: warning concerning the amount of RAM consumed (in Mb) by a given process.	Long	1600
maxSharedLogs	Maximum log count: maximum number of logs stored in shared memory. Cannot be less than 10000.	Long	25000
processRestartTime	Time of the day when the process is automatically restarted. See Automatic process restart.	String	'06:00:00'
purgeLogsPeriod	Number of logs before purge: number of logs inserted before starting the purge of log files. May not be lower than 50000.	Long	50000
runLevel	Priority at start. Low priority modules are first started and last stopped. The syslogd module must therefore have the priority 0.	Short	10
webTrackingParamSize	Maximum number of characters saved in shared memory for extra web tracking parameters.	Long	64

web

Here are the different parameters of the web node. This is the configuration of the Web Module.

For additional information, refer to this section.

Parameter	Description	Type	Default value
JVMOptions	Options of the JVM passed as a string.	String
MaxThreads	Maximum number of threads.	Long	75
MinSpareThreads	Minimum number of threads.	Long	5
args	Start-up parameters	String
autoStart	Automatic start	Boolean	false
controlPort	Tomcat listening control port: refer to Configure Tomcat.	Short	8005
httpPort	Tomcat HTTP listening port: refer to Configure Tomcat.	Short	8080
initScript	ID of JavaScript to execute when starting the process.	String
maxDeliveryQueueSize	Size of the queue for SubmitDelivery calls: maximum number of SubmitDelivery SOAP calls that can be queued.	Long	50
maxProcessMemoryAlertMb	Memory consumption alert: alert concerning the amount of RAM consumed (in Mb) by a given process.	Long	1800
maxProcessMemoryWarningMb	Memory consumption warning: warning concerning the amount of RAM consumed (in Mb) by a given process	Long	1600
notifRelay	Notification relay: HostName:Port enabling relay of notifications.	String
processRestartTime	Time of the day when the process is automatically restarted. See Automatic process restart.	String	'06:00:00'
runLevel	Priority at start. Low priority modules are first started and last stopped. The syslogd module must therefore have the priority 0.	Short	10
startSoapRouterInModule	Start the SOAP router in module mode.	Boolean	false

jsp

Here are the different parameters of the web > jsp node. This is the configuration of the parameters used by the JSPs.

Parameter	Description	Type	Default value
debug	Execution of JSP in debug mode or not.	Boolean
downloadPath	Download folder: download path of installation programs for the client consoles.	String	'$(XTK_INSTALL_DIR)/datakit/nl/eng/jsp'
foFileName	Path of .fo file.	String
soapRouter	URL of SOAP router (http://myserver/xxx, http://jni or mailto:xxx).	String	'http://jni'

The web > jsp > classpath node contains the list of all class paths to use when starting JVM. Here is the default configuration:

'$(XTK_INSTALL_DIR)/tomcat-8/bin/bootstrap.jar
          $(XTK_INSTALL_DIR)/tomcat-8/bin/tomcat-juli.jar
          $(XTK_INSTALL_DIR)/tomcat-8/lib/tomcat-coyote.jar
          $(XTK_INSTALL_DIR)/tomcat-8/lib/tomcat-util.jar
          $(XTK_INSTALL_DIR)/tomcat-8/lib/tomcat-api.jar
          $(XTK_INSTALL_DIR)/tomcat-8/lib/servlet-api.jar
          $(XTK_INSTALL_DIR)/tomcat-8/lib/jsp-api.jar
          $(XTK_INSTALL_DIR)/tomcat-8/lib/el-api.jar
          $(XTK_INSTALL_DIR)/tomcat-8/lib/annotations-api.jar
          $(XTK_INSTALL_DIR)/tomcat-8/lib/catalina.jar
          $(XTK_INSTALL_DIR)/tomcat-8/lib/websocket-api.jar
          $(XTK_INSTALL_DIR)/tomcat-8/lib/tomcat7-websocket.jar
          $(XTK_INSTALL_DIR)/java/lib/pdfbox-2.0.4.jar
          $(XTK_INSTALL_DIR)/java/lib/FontBox-0.1.0.jar
          $(XTK_INSTALL_DIR)/java/lib/AGJavaEndpoint.22.jar
          $(XTK_INSTALL_DIR)/java/lib/NSGConstants.jar
          $(XTK_INSTALL_DIR)/java/lib/smpp.jar
          $(XTK_INSTALL_DIR)/java/lib/nlweb.jar
          $(XTK_INSTALL_DIR)/java/lib/jcaptcha-all.jar
          $(XTK_INSTALL_DIR)/java/lib/apns-1.0.0.Beta6-jar-with-dependencies.jar
          $(XTK_INSTALL_DIR)/java/lib/commons-collections-3.2.2.jar
          $(XTK_INSTALL_DIR)/java/lib/jcommon-1.0.16.jar
          $(XTK_INSTALL_DIR)/java/lib/jfreechart-1.0.13.jar
          $(XTK_INSTALL_DIR)/java/lib/barcode4j-light.jar
          $(XTK_INSTALL_DIR)/java/lib/zxing.jar
          $(XTK_INSTALL_DIR)/java/lib/raztec.jar
          $(XTK_INSTALL_DIR)/java/lib/gson-2.7.jar
          $(XTK_INSTALL_DIR)/java/lib/alpn-api-1.1.3.v20160715.jar
          $(XTK_INSTALL_DIR)/java/lib/netty-all-4.1.6.Final.jar
          $(XTK_INSTALL_DIR)/java/lib/netty-tcnative-boringssl-static-1.1.33.Fork22.jar
          $(XTK_INSTALL_DIR)/java/lib/pushy-0.8.1.jar
          $(XTK_INSTALL_DIR)/java/lib/slf4j-api-1.7.21.jar
          $(XTK_INSTALL_DIR)/java/lib/slf4j-simple-1.7.21.jar'

jssp

Here are the different parameters of the web > jssp node. This is the configuration of the parameters used by the JSSPs.

Parameter	Description	Type	Default value
collectsGarbageAfterRequest	Enables the garbage collector of the JavaScript context after each query.	Boolean	true
timeToLive	Maximum number of pages served by a JavaScript context.	Long	1000

The web > jsp > classpath node contains the list of all class paths to use when starting JVM.

relay

Here are the different parameters of the web > relay node. This is the configuration of the relay for HTTP requests between two zones.

For additional information, refer to this section.

Parameter	Description	Type	Default value
debugRelay	Start the HTTP relay module within the Web server in debug mode.	Boolean	false
forbiddenCharsInAuthority	Forbidden character(s) (Domain): list of forbidden characters in the 'authority' section of a URI.	String	'.?#@/:'
forbiddenCharsInPath	Forbidden character(s) (Path): list of forbidden characters in the 'path' section of a URI.	String	'?#/'
modDir	Value of the 'mod_dir' module option: list of files to be used during a query on a folder.	String	'index.md'
startRelay	Start the HTTP relay module.	Boolean	false
startRelayInModule	Start the HTTP relay module within the Web server.	Boolean	true
timeout	Wait time before deleting banned url.	String	'60'

Add a web > relay > url node for each URL to relay (insert order defines priority) with the following parameters.

For additional information, refer to Dynamic page security and relays and section.

Parameter	Description	Type	Default value
IPMask	Authorized IPs: comma separated list of source IP addresses allowed to use the relay for this mask.	String
deny	Deny access to these URLs (return an HTTP 403 error)	Boolean
hostMask	DNS alias to relay: comma separated list of DNS alias masks to relay (ex: '*.adobe.com').	String
httpAllowed	HTTP access authorized no matter what the security zone (like webApps).	Boolean
relayHost	Add original host: use the HTTP 'Host' header of the original request when relaying.	Boolean
relayPath	Add initial URL path: append the complete path of the URLs to relay to the URL of the target page.	Boolean
status	Synchronization status of a public resource (enumeration). Possible values are 'normal' (normal execution), 'blacklist' (url added to denylist in case of error 404) and 'spare' (file upload on spare server if existing).	String	normal
targetUrl	URL of the target page: refer to Configure Tomcat.	String
timeout	Maximum execution time (in seconds) of the request being relayed.	Long
urlPath	Mask of URLs to relay (ex: '/nl*', '*.jsp').	String

Here is the default configuration:

<url IPMask="" deny="" hostMask="" relayHost="true" relayPath="true"
     status="normal" targetUrl="http://localhost:7781" timeout="" urlPath="/pipelined/*"/>
<url IPMask="" deny="" hostMask="" relayHost="true" relayPath="true" targetUrl="http://localhost:8080"
     timeout="" status="normal" httpAllowed="false" urlPath="/view/*"/>
<url IPMask="" deny="true" hostMask="" relayHost="true" relayPath="true" targetUrl="http://localhost:8080"
     timeout="" status="normal" httpAllowed="false" urlPath="*ooconv.jsp*"/>
<url IPMask="" deny="true" hostMask="" relayHost="true" relayPath="true" targetUrl="http://localhost:8080"
     timeout="" status="normal" httpAllowed="false" urlPath="/res/*.jsp*"/>
<url IPMask="" deny="" hostMask="" relayHost="true" relayPath="true" targetUrl="http://localhost:8080"
     timeout="" status="normal" httpAllowed="true" urlPath="*/sc.jssp"/>
<url IPMask="" deny="" hostMask="" relayHost="true" relayPath="true" targetUrl="http://localhost:8080"
     timeout="" status="normal" httpAllowed="true" urlPath="*/interactionProposal.jssp"/>
<url IPMask="" deny="" hostMask="" relayHost="true" relayPath="true" targetUrl="http://localhost:8080"
     timeout="" status="normal" httpAllowed="true" urlPath="*/zoneJson.jssp"/>
<url IPMask="" deny="" hostMask="" relayHost="true" relayPath="true" targetUrl="http://localhost:8080"
     timeout="" status="normal" httpAllowed="true" urlPath="/nms/jsp/barcode.jsp"/>
<url IPMask="" deny="" hostMask="" relayHost="true" relayPath="true" targetUrl="http://localhost:8080"
     timeout="" status="normal" httpAllowed="true" urlPath="/nms/jsp/captcha.jsp"/>
<url IPMask="" deny="" hostMask="" relayHost="true" relayPath="true" targetUrl="http://localhost:8080"
     timeout="" status="normal" httpAllowed="true" urlPath="/nms/jsp/webForm.jsp"/>
<url IPMask="" deny="" hostMask="" relayHost="true" relayPath="true" targetUrl="http://localhost:8080"
     timeout="" status="normal" httpAllowed="true" urlPath="/xtk/jsp/zoneinfo.jsp"/>
<url IPMask="" deny="" hostMask="" relayHost="true" relayPath="true" targetUrl="http://localhost:8080"
     timeout="" status="normal" httpAllowed="true" urlPath="*/facebookCallback.jssp"/>
<url IPMask="" deny="" hostMask="" relayHost="true" relayPath="true" targetUrl="http://localhost:8080"
     timeout="" status="normal" httpAllowed="true" urlPath="/nl/jsp/m.jsp"/>
<url IPMask="" deny="" hostMask="" relayHost="true" relayPath="true" targetUrl="http://localhost:8080"
     timeout="" status="normal" httpAllowed="true" urlPath="/nl/jsp/s.jsp"/>

<url IPMask="" deny="" hostMask="" relayHost="true" relayPath="true" targetUrl="http://localhost:8080"
     timeout="" status="blacklist" httpAllowed="false" urlPath="/nms/jsp/*.jsp"/>
<url IPMask="" deny="" hostMask="" relayHost="true" relayPath="true" targetUrl="http://localhost:8080"
     timeout="" status="blacklist" httpAllowed="false" urlPath="/xtk/jsp/*.jsp"/>
<url IPMask="" deny="" hostMask="" relayHost="true" relayPath="true" targetUrl="http://localhost:8080"
     timeout="" status="blacklist" httpAllowed="false" urlPath="/nl/jsp/*.jsp"/>
<url IPMask="" deny="" hostMask="" relayHost="true" relayPath="true" targetUrl="http://localhost:8080"
     timeout="" status="blacklist" httpAllowed="false" urlPath="*.jssp"/>
<url IPMask="" deny="" hostMask="" relayHost="true" relayPath="true" targetUrl="http://localhost:8080"
     timeout="" status="blacklist" httpAllowed="true" urlPath="/webApp/*"/>
<url IPMask="" deny="" hostMask="" relayHost="true" relayPath="true" targetUrl="http://localhost:8080"
     timeout="" status="blacklist" httpAllowed="false" urlPath="/report/*"/>
<url IPMask="" deny="" hostMask="" relayHost="true" relayPath="true" targetUrl="http://localhost:8080"
     timeout="" status="blacklist" httpAllowed="false" urlPath="/jssp/*"/>
<url IPMask="" deny="" hostMask="" relayHost="true" relayPath="true" targetUrl="http://localhost:8080"
     timeout="" status="normal" httpAllowed="false" urlPath="/strings/*"/>
<url IPMask="" deny="" hostMask="" relayHost="true" relayPath="true" targetUrl="http://localhost:8080"
     timeout="" status="normal" httpAllowed="true" urlPath="/interaction/*"/>
<url IPMask="" deny="" hostMask="" relayHost="true" relayPath="true" targetUrl="http://localhost:8080"
     timeout="" status="normal" httpAllowed="true" urlPath="/barcode/*"/>
<url IPMask="" deny="" hostMask="" relayHost="true" relayPath="true" targetUrl="http://localhost:8080"
     timeout="" status="normal" httpAllowed="true" urlPath="/lineImage/*"/>

<url IPMask="" deny="" hostMask="" relayHost="false" relayPath="false" targetUrl=""
     timeout="" status="spare" httpAllowed="true" urlPath="/favicon.*"/>
<url IPMask="" deny="" hostMask="" relayHost="false" relayPath="false" targetUrl=""
     timeout="" status="spare" httpAllowed="true" urlPath="/*.md"/>
<url IPMask="" deny="" hostMask="" relayHost="false" relayPath="false" targetUrl=""
     timeout="" status="spare" httpAllowed="true" urlPath="/*.png"/>
<url IPMask="" deny="" hostMask="" relayHost="false" relayPath="false" targetUrl=""
     timeout="" status="spare" httpAllowed="true" urlPath="/*.jpg"/>

Add a web > relay > responseHeader node for each HTTP header to add to replies forwarded to the relay.

For additional information, refer to Managing HTTP headers.

Parameter	Description	Type
name	Header name	String
value	Header value	String

Here is the default configuration:

<responseHeader name="X-XSS-Protection" value="1; mode=block"/>

redirection

Here are the different parameters of the web > redirection node. This is the configuration of the redirection module.

For additional information, refer to this section.

Parameter	Description	Type	Default value
IMSOrgId	Organization ID: unique organization identifier within the Adobe Experience Cloud, used in particular for the VisitorID service and the IMS SSO.	String
P3PCompactPolicy	Value describing the policy used for permanent cookies (compliant with the P3P Compact Policy format).	String	'CAO DSP COR CURa DEVa TAIa OUR BUS IND UNI COM NAV'
cookieDomain	Comma separated list of domains to be configured to explicitly indicate your domain to set cookie.	String
databaseId	Database identifier associated with the tracking instance.	String
defLogCount	Log count by call: number of logs returned by default upon a call of method GetTrackingLogs.	Long	30
expirationURL	Page for expired redirections: URL of Web page used by default by the redirection server when redirection for a delivery action has expired.	String
maxJobsInCache	Maximum job count: maximum number of delivery actions in cache. May not be lower than 50.	Long	100
showSourceIP	When set to false, the value of sourceIP in the response returned by r/test is an empty string.	Boolean	true
startRedirection	Start the redirection service.	Boolean	true
startRedirectionInModule	Start the redirection service in module mode.	Boolean	true
trackWebVisitors	Web tracking: creation of logs for the pages visited by unknown users.	Boolean	false
trackingPassword	Password used by the redirection server.	String

Here are the different parameters of the web > redirection > spareServer node.

For additional information, refer to Redundant tracking.

Parameter	Description	Type	Default value
enabledIf	Taken into account if: the tracking server is taken into account if the expression returns true.	String
id	Name	String	1
url	Extra redirection server URL	String

spamCheck

Here are the different parameters of the web > spamCheck node. This is the configuration the Email anti-spam scoring evaluation parameters.

For additional information, refer to Configuring SpamAssassin.

Parameter	Description	Type
command	Command to execute to evaluate the anti-spam score of an email (e.g. 'perl spamcheck.pl').	String

wfserver

Here are the different parameters of the wfserver node. This is the workflow process configuration.

For additional information, refer to High availability workflows and affinities.

Parameter	Description	Type	Default value
affinity	Affinity	String
args	Start-up parameters	String
autoStart	Automatic start	Boolean	false
dataBasePoolPeriodSec	Period	Long	20
initScript	ID of JavaScript to execute when starting the process.	String
maxProcessMemoryAlertMb	Memory consumption alert: alert concerning the amount of RAM consumed (in Mb) by a given process.	Long	1800
maxProcessMemoryWarningMb	Memory consumption warning: warning concerning the amount of RAM consumed (in Mb) by a given process.	Long	1600
notifRelay	Notification relay: HostName:Port enabling relay of notifications.	String
processRestartTime	Time of the day when the process is automatically restarted. See Automatic process restart.	String	'06:00:00'
runLevel	Priority at start. Low priority modules are first started and last stopped. The syslogd module must therefore have the priority 0.	Short	10