Show Menu
TOPICS×

Configuring Campaign options

The Administration / Platform / Options node allows you to configure Adobe Campaign options.
Modifying or updating Adobe Campaign options can be performed by experts users only.
Some of them are built-in when installing Campaign, and others can be added manually when needed. Available options vary according to the packages installed with your instance.

Delivery

Option name Description
Deliverability_LastBroadLogMsgDate Date of the last broadLogMsg retrieved from the deliverability instance.
Deliverability_LastBroadLogMsgSent Date of the last broadLogMsg sent to the deliverability instance.
DmRendering_cuid Delivery reports identifier. Please contact support to obtain your identifier.
DmRendering_SeedTargets List of schemas for which you want to use test addresses for Inbox Rendering. (element names are separated with commas) E.g.: custom_nms_recipient.
NmsBilling_MainActionThreshold Minimum number of recipients in order for a delivery to be considered as the main one in the billing report.
NmsBroadcast_DefaultProvider Default routing service provider for the new templates.
NmsBroadcast_LogsPerTransac Number of BroadLogs that are created for a delivery at once.
NmsBroadcast_MaxDelayPerTransac Insertion (into table) of logs (broadLogs) per transactions : number of rows to process per batch.
NmsBroadcast_MidAnalyzeBatchSize Grouping size of delivery parts when analyzing mid-sourcing deliveries.
NmsBroadcast_MsgValidityDuration Default delivery period for a delivery (in seconds).
NmsBroadcast_RegexRules Regular expressions for normalizing delivery messages.
NmsBroadcast_RemoveBlackList Entering "1" as the value lets you exclude recipients who no longer wish to be contacted.
NmsBroadcast_RemoveDuplicatesRecipients Entering "1" as the value lets you automatically ignore doubles.
Nms_DefaultRcpSchema Adobe Campaign uses a "Nms_DefaultRcpSchema" global variable to dialog with the default recipient database (nms:recipient). The option value must correspond to the name of the schema which matches the external recipient table.
NmsDelivery_ErrorAddressMasks Lets you define the syntax of the Error address used when replying to a message.
NmsDelivery_FromAddressMasks Lets you define the syntax of the From address used when sending a message.
NmsDelivery_MaxRetry Maximum number of retries during analysis.
NmsDelivery_PublishingScript Publication script.
NmsDelivery_NoCountBroadLogMsgPush Disable the broadLogMsg count for push messages.
NmsDeliveryWizard_ShowDeliveryWeight Display the message weight in the delivery wizard.
NmsEmail_DefaultErrorAddr Default 'error' email address at instance's level used for email delivery if left empty by user.
NmsEmail_DefaultFromAddr Default 'from' email address at instance's level used for email delivery if left empty by user.
NmsEmail_DefaultReplyToAddr Default 'reply' email address at instance's level used for email delivery if left empty by user.
NmsEmail_ExpOrganization Common name of the customer. Used in some warning messages displayed to the recipients. "You are receiving this message because you have been in contact with ***** or an affiliated company. To no longer receive messages from *****".
NmsEmail_FromName Default 'from' email label at instance's level used for email delivery if left empty by user.
NmsEmail_ReplyToName Default 'reply' email label at instance's level used for email delivery if left empty by user.
NmsEmail_RetryCount Period between two retries of an email message (in seconds).
NmsEmail_RetryPeriod Period of retries for email messages.
NmsForecast_MsgWeightFormula Formula used to calculate the weighting of a message for a provisional delivery.
NmsInmail_WhitelistEmails List of authorized forwarding email addresses (from the inbound mail processing module). The addresses have to be separated by commas (or * to allow all). E.g. xyz@abc.com,pqr@abc.com.
NmsNPAI_EmailMaxError On channel "email"(use as default) : Maximal number of errors that is accepted, for SOFT errors during sending before putting the recipient into quarantine.
NmsNPAI_EmailSignificantErrorDelay On channel "email"(use as default) : Minimal period to spent since the previous referenced SOFT error, before taking into account a new SOFT error.
NmsNPAI_MobileMaxError On channel "mobile" : Maximal number of errors that is accepted, for SOFT errors during sending before putting the recipient into quarantine.
NmsNPAI_MobileSignificantErrorDelay On channel "mobile" : Minimal period to spent since the previous referenced SOFT error, before taking into account a new SOFT error.
XtkEmail_Characters Valid characters for an email address.
NmsServer_MirrorPageUrl URL of the mirror page server (by default, should be identical to NmsTracking_ServerUrl). It is the default value of email deliveries when the URL is not specified in the routing definition.
NmsPaper_SenderLine1 Line 1 of the sender's address.
NmsPaper_SenderLine3 Line 3 of the sender's address.
NmsPaper_SenderLine4 Line 4 of the sender's address.
NmsPaper_SenderLine6 Line 6 of the sender's address.
NmsPaper_SenderLine7 Line 7 of the sender's address.
NmsSMS_Priority Parameters of sent SMS messages: information transmitted to the SMS gateway to indicate the message priority.
NmsSMS_RetryCount Number of retries when sending SMS messages.
NmsSMS_RetryPeriod Period during which retries of SMS messages will be performed.
XtkEmail_Characters Valid characters for an email address.
NmsMidSourcing_LogsPeriodHour Allows a maximum period (expressed in hours) to be specified as to limit the number of broadlogs recovered every time the synchronization workflow is executed. See this section .
NmsMidSourcing_PrepareFlow Maximum number of calls in MidSourcing session, which can be run in parallel (3 by default).
NMS_ActivateOwnerConfirmation
Lets you allow the operator in charge of the delivery to confirm the send, if a specific operator or group of operators is designated for starting a delivery in the delivery's properties.
To do this, activate the option by entering "1" as the value. To deactivate this option, enter "0".
The send confirmation process will then function as default: only the operator or group of operators designated for the send in the delivery properties (or an administrator) will be able to confirm and carry out the send. See this section .
NmsMTA_Alert_Delay Custom delay (in minutes) after which a delivery is considered as 'delayed', default being 30 minutes.
XtkBarcode_SpecialChar Enable/Disable support for special characters for Code128.
NmsLine_AESKey AES key used in the 'lineImage' servlet to encode the URLs (LINE channel).
NmsWebSegments_LastStates Name of the option which contains the web segments and their states.
NmsUserAgentStats_LastConsolidation Last consolidation date for NmsUserAgent statistics.
XtkSecurity_Restrict_EditXML Add this option with the "0" value to disable the edition of deliveries' XML code (right-click / Edit XML source or CTRL + F4 shortcut).

Resources

Option name Description
NcmRessourcesDir Location of resources for publication in the Adobe Campaign client console. See this section .
NcmRessourcesDirPreview Location of resources for previewing in the Adobe Campaign client console. See this section .
NmsDelivery_DefaultIgnoredImage List of URL masks for the images skipped during upload.
NmsDelivery_ImagePublishing Configuration of image uploading. The values can be none / tracking / script / list (can be overridden by operator's optional settings).
NmsDelivery_ImageSubDirectory Folder in which the images on the server are to be stored.
NmsServer_LogoPath Space to display logos.
NcmPublishingDir Root folder for publications. For more on HTML and Text contents generation, refer to this section .
XtkImageUrl Lets you define the server on which the images used in the deliveries are stored to enable the browser to get them. For build versions <= 5098, we use the URL of the images that were uploaded onto the instance. For build versions > 5098, we use instead the delivery's public URL or the XtkFileRes_Public_URL option's URL.
NmsDelivery_MediaInstance Lets you configure the instance name for image uploading.
NmsDelivery_MediaPassword Lets you configure the password for image uploading.
NmsDelivery_MediaServers Lets you configure the media URL(s) for image uploading.
NmsBroadcast_MsgWebValidityDuration Default validity duration for online resources of a delivery (in seconds).
XtkFileRes_Public_URL New URL for public resource files.

Campaign & workflow management

Option name Description
CrmMarketingActivityWindow Marketing history shown for this number of months.
NmsOperation_Duration Default validity period of a campaign (in seconds).
NmsOperation_LimitConcurrency Maximum number of delivery/workflow/hypothesis/simulation jobs that can be processed at a time, started by operationMgt workflow.
NmsOperation_OperationMgtDebug Allows you to monitor the operationMgt technical workflow execution. When activated (value "1"), the execution information are logged in the workflow audit logs.
NmsOperation_TimeRange Time period for targeting and extraction conditions in scheduled mode.
Workflow_AnalysisThreshold Number of affected records after which table statistics are automatically recomputed.
XtkReport_Logo Logo to be displayed in the top right-hand corner of the reports exported.
NmsServer_PausedWorkflowPeriod Number of days to wait between checks for paused workflows.
NmsCampaign_Activate_OwnerConfirmation Activate the deliveries validation by the owner of the operation by entering "1" as the value. To deactivate this option, enter "0".
NmsAsset_JavascriptExt Additional JS library to load in workflow's activity "Marketing resource notifications".

Security

Option name Description
XtkAcceptOldPasswords (Install compatibility mode:build>6000) If the "1" is entered, this option activates the compatibility mode for stored passwords. Changing this option prevents the use of old passwords stored in the database.
XtkKey This key is used to encrypt most passwords in the database. (external accounts, LDAP password...).
XtkSecurity_Allow_PrivilegeEscalation If 1 is selected, this option to allow privilegeEscalation in javascript.
XtkSecurity_Disable_ControlsOnFileDownload If 1 is selected, this option disable ACL controls during a file download (via fileDownload.jsp).
XtkSecurity_Disable_JSFileSandboxing If 1 is selected, this option disable the file sandboxing within Javascript.
XtkSecurity_SaveOptions_AllowNonAdmin If set to 'true', authorized non-admin operator to update the xtkOption values through the deployment wizard.
XtkSecurity_Unsafe_DecryptString If 1 is selected, this option allow to use decryptString to decrypt some passwords.
XtkTraceDeleteLogin Enter the "1" value to trace the deletion of elements with Audit trail information in the mData, through the modification of its "modified by" field before the deletion of the record.

Message Center

Option name Description
MC_EnrichmentCustomJs JavaScript library to be personalized for enriching events. Must contain the implementation of these two functions:
  • enrichRtEvents(aiEventId); : enriches and saves events in the database (where aiEventId corresponds to the table of real time events processed).
  • enrichBatchEvents(aiEventId); : enriches and saves events in the database (where aiEventId corresponds to the ID table of batch events processed).
MC_LastUpdateFromBL Date of the last event status update via delivery logs.
MC_RoutingCustomJs JavaScript library to be personalized for routing events. Must contain the implementation of these two functions:
  • dispatchRtEvent(iEventId); : returns the internal name of the transactional message selected to process the real time event (where iEventId corresponds to the ID of the real time event processed).
  • dispatchBatchEvent(iEventId); : returns the internal name of the transactional message selected to process the batch event (where iEventId corresponds to the ID of the batch event processed).
MC_RtEventAvgDeliveryTimeAlert Alert threshold of average sending time of real-time events.
MC_RtEventAvgDeliveryTimeWarning Warning threshold for average sending time of real-time events.
MC_RtEventAvgProcessTimeAlert Alert threshold for the average processing time of real-time events.
MC_RtEventAvgProcessTimeWarning Warning threshold for the average processing time of real-time events.
MC_RtEventAvgQueueAlert Alert threshold for the average number of queued real-time events.
MC_RtEventAvgQueueTimeAlert Alert threshold for average queuing time of real-time events.
MC_RtEventAvgQueueTimeWarning Warning threshold for average queuing time of real-time events.
MC_RtEventAvgQueueWarning Warning threshold for the average number of queued real-time events.
MC_RtEventErrorAlert Alert threshold for processing errors of real-time events.
MC_RtEventErrorWarning Warning threshold for processing errors of real-time events.
MC_RtEventMaxQueueAlert Alert threshold for maximum number of queued real-time events.
MC_RtEventMaxQueueWarning Warning threshold for maximum number of queued real-time events.
MC_RtEventMinQueueAlert Alert threshold for minimum number of queued real-time events.
MC_RtEventMinQueueWarning Warning threshold for minimum number of queued real-time events.
MC_RtEventQueueAlert Threshold before critical condition for the queue of pending real time events.
MC_RtEventQueueWarning Threshold before warning for the queue of pending real time events.
MC_RtEventThroughputAlert Alert threshold for real-time event throughput.
MC_RtEventThroughputWarning Warning threshold for real-time event throughput.
NmsMessageCenter_RoutingBatchSize Size of the regrouping for the event routing.
MC_LastRtEventStat Update pointer of RtEvent status (last date until when the data was retrieved).
NmsLine_MessageCenterURL Message Center server URL used to send welcome messages (LINE channel).

Database

Option name Description
NmsCleanup_LastCleanup Defines the last time the cleanup process was run.
NmsCleanup_BroadLogPurgeDelay
Lets you define the delay after which broadlog are erased from the database.
This option is automatically created once the delay is modified within the interface. If you modify the value from the options list, it should be expressed in seconds.
NmsCleanup_EventHistoPurgeDelay
Lets you define the delay after which the event history is erased from the database.
This option is automatically created once the delay is modified within the interface. If you modify the value from the options list, it should be expressed in seconds.
NmsCleanup_EventPurgeDelay
Lets you define the delay after which events are erased from the database.
This option is automatically created once the delay is modified within the interface. If you modify the value from the options list, it should be expressed in seconds.
NmsCleanup_EventStatPurgeDelay
Lets you define the delay after which the event statistics are erased from the database.
This option is automatically created once the delay is modified within the interface. If you modify the value from the options list, it should be expressed in seconds.
NmsCleanup_PropositionPurgeDelay
Lets you define the delay after which propositions are erased from the database.
This option is automatically created once the delay is modified within the interface. If you modify the value from the options list, it should be expressed in seconds.
NmsCleanup_QuarantineMailboxFull
Lets you define the delay after which the quarantines are erased from the database.
This option is automatically created once the delay is modified within the interface. If you modify the value from the options list, it should be expressed in seconds.
NmsCleanup_RecycledDeliveryPurgeDelay
Lets you define the delay after which recycled deliveries are erased from the database.
This option is automatically created once the delay is modified within the interface. If you modify the value from the options list, it should be expressed in seconds.
NmsCleanup_RejectsPurgeDelay
Lets you define the delay after which rejects are erased from the database.
This option is automatically created once the delay is modified within the interface. If you modify the value from the options list, it should be expressed in seconds.
NmsCleanup_TrackingLogPurgeDelay
Lets you define the delay after which tracking logs are erased from the database.
This option is automatically created once the delay is modified within the interface. If you modify the value from the options list, it should be expressed in seconds.
NmsCleanup_TrackingStatPurgeDelay
Lets you define the delay after which tracking statistics is erased from the database.
This option is automatically created once the delay is modified within the interface. If you modify the value from the options list, it should be expressed in seconds.
NmsCleanup_VisitorPurgeDelay
Lets you define the delay after which visitors are erased from the database.
This option is automatically created once the delay is modified within the interface. If you modify the value from the options list, it should be expressed in seconds.
NmsCleanup_WorkflowResultPurgeDelay
Lets you define the delay after which workflow results is erased from the database.
This option is automatically created once the delay is modified within the interface. If you modify the value from the options list, it should be expressed in seconds.
WdbcCapabilities_AzureDw Azure SQL Datawarehouse connector options.
WdbcOptions_TableSpaceIndex Name of the tablespace intended to contain the indexes of the Adobe Campaign standard tables.
WdbcOptions_TableSpaceUser Name of the tablespace intended to contain the data of the standard Adobe Campaign tables.
WdbcOptions_TableSpaceWork Name of the tablespace intended to contain the data of the Adobe Campaign work tables.
WdbcOptions_TableSpaceWorkIndex Name of the tablespace intended to contain the indexes of the Adobe Campaign work tables.
WdbcTimeZone Time zone of the Adobe Campaign's instance. See Configuration .
WdbcUseNChar Are the database's string fields defined with NChar?
WdbcUseTimeStampWithTZ Do the database's 'datetime' fields store timezone info?
XtkDatabaseId ID of the database. Begins by 'u' for Unicode DataBase.
XtkInstancePrefix Prefix added to internal names generated automatically.
XtkQuery_Schema_LineCount Maximum number of results returned by a query on xtk:schema and xtk:srcSchema.
XtkSequence_AutoGeneration All customized schemas, created after this time, with autopk="true" and without the attribute "pkSequence" will get an auto-geneated sequence "auto_ <schemanamespace> <schemaname> _seq.
NlMigration_KeepFolderStructure During migration, the tree structure is automatically reorganized based on the new version standards. This option allows you to disable the automatic migration of the navigation tree. If you use it, after migration you will have to delete obsolete folders, add the new folders and run all necessary checks.
  • Data type: Integer
  • Value (text) : 1
This option should only be used if the out-of-the-box navigation tree has undergone too many changes. For more on this, refer to this section .
NmsLastErrorStatCoalesce Last processing date of the NmsEmailErrorStat table cleanup.
PostUpgradeLastError Information concerning the error that occurred in the Postupgrade, following the syntax below: {Build number}:{mode: pre/post/...}:{The 'lessThan'/'greaterOrEquelThan' where error occurred + sub-step}
XtkCleanup_NoStats Enter the "1" value so that the update of statistics is not performed through the cleanup workflow.

Integration

Option name Description
AEMResourceTypeFilter Types of AEM resources that can be used in Adobe Campaign. Values must be separated by commas.
nmsPipeline_config Lets you configure Experience Cloud Triggers. Data type is "long text" and must be in JSON format. See How to use Experience Cloud Triggers with Adobe Campaign Classic .
LASTIMPORT_<%=instance.internalName%>_<%=activityName%> This option is used when importing data from a third-party system through a CRM connector. Enabling the option lets you collect only objects modified since the last import. This option has to be manually created and populated as below:
  • Internal name : LASTIMPORT_<%=instance.internalName%>_<%=activityName%>
  • Value (field) : date of the last import, with the yyyy/MM/dd hh:mm:ss format.
TNT_EdgeServer Adobe Target server used for the integration. This option is already selected by default. This value corresponds to the Adobe Target Domain Server, followed by the value /m2. For example: tt.omtrdc.net/m2. See this section .
TNT_TenantName Adobe Target Organization name. This value corresponds to the name of the Adobe Target Client. See this section .
AAM_DataSourceId Option used for the integration with Adobe Audience Manager.
AAM_DestinationId Option used for the integration with Adobe Audience Manager.
WdbcCapabilities_Teradata Teradata connector options.
WdbcCapabilities_Hive Hive connector options.

Offers

Option name Description
NmsCoupons_MaxPerTransac Number of coupons that are updated per SQL transaction.
NmsInteraction_LastPropositionSynchControl_ '+ [proposition's schema] + "_" + extAccountSource.@executionInstanceId + [proposition's schema] + "_" + vars.executionInstanceIdFilter
NmsInteraction_LastPropositionSynchExec_ '+ [ proposition's schema] + "_" + extAccountSource.@executionInstanceId + "_" + extAccountTarget.@executionInstanceId
NmsInteraction_SynchWorkflowIds Synchronization workflow tracking.
NmsInteraction_UseDaemon Enable/disable asynchronous proposition writing ("0" to disable, "1" to enable).
NmsModule_CouponsEnabled Lets you enable coupons.

Server

Option name Description
NmsExecutionInstanceId Execution instance identifier.
NmsServer_CustomerId Customer identifier used when sending the billing report.
NmsServer_IntranetURL Internal base URL to access the application server.
NmsServer_LastPostUpgrade Build number of the AC instance before the last upgrade.
NmsServer_URL Base URL of the public web application server.
XtkPassUnknownSQLFunctionsToRDBMS Lets you continue using old undeclared SQL functions after migrating. We strongly recommend against using this option due to the security risks it introduces.

Tracking

Option name Description
NmsTracking_Available Option that lets you activate tracking.
NmsTracking_ClickFormula Tracked-URL calculation script.
NmsTracking_ExtAccount Lets you define the tracking server's external account.
NmsTracking_Instance Lets you define the instance name on the tracking server.
NmsTracking_LastConsolidation Last time the tracking information has been consolidated with new data.
NmsTracking_OpenFormula Open URL computation script.
NmsTracking_Password Password for the tracking sever
NmsTracking_Pointer The pointer keeps track of the last messsage events that were processed through their IDs and date.
NmsTracking_SecureServerUrl Secure URL of the frontal tracking server.
NmsTracking_ServerUrl URL of the frontal tracking server.
NmsTracking_ServerUrlList List of the URLs used to contact the tracking servers.
NmsTracking_UserAgentRules Browser-identification rule set.
NmsTracking_WebFormula Script used to compute Web tracking tags.
NmsTracking_WebTrackingDelivery Name of the virtual delivery designed for web tracking management.
NmsTracking_WebTrackingMode Lets you define the web tracking mode.

GDPR

Option name Description
Privacy_Request_ConfirmDeletePending If option 1 is selected, you have to confirm manually the deletion in the interface in a second step. Otherwise, data will be deleted without confirmation.
Privacy_Request_ConfirmDeletePendingDelay Delay between request waits for deleting confirmation and request is cancelled.
Privacy_Request_MaxErrorAllowed The maximum number of error allowed when processing/deleting a privacy request.
Privacy_Request_PurgeDelay Delay between request is created on the queue and request data is deleted.

LDAP

Option name Description
XtkLdap_Active Enable LDAP server to be used to authenticate users and provide authorizations to users.
XtkLdap_AppLogin Application login to contact the server for various searches.
XtkLdap_AppPassword Encrypted password for the application login.
XtkLdap_AutoOperator Enable automatic creation of operators and rights in Adobe Campaign.
XtkLdap_DN Computation formula for LDAP DN based on login.
XtkLdap_DNSearch Enable DN search in directory.
XtkLdap_DNSearchBase Search base.
XtkLdap_DNSearchFilter DN search filter.
XtkLdap_DNSearchScope Search scope.
XtkLdap_Mechanism Authentication type used to contact the LDAP server (plain, md5, lds, ntlm, dpa).
XtkLdap_Rights Enable synchronization of authorizations and groups from LDAP directory to named rights in Adobe Campaign.
XtkLdap_RightsAttr LDAP attribute containing the authorization name.
XtkLdap_RightsBase Search base.
XtkLdap_RightsFilter Search filter for user authorizations.
XtkLdap_RightsMask Expression to extract the names of the Adobe Campaign rights from the LDAP authorizations.
XtkLdap_RightsScope Search scope.
XtkLdap_Server LDAP server address (it is possible to specify a port by specifying ':' as the separator).

Web forms

Option name Description
XtkUseScrollBar Value set to 1 will allow Scroll bar addition to detail forms.
XtkWebForm_Instance Instance to be used for web form invalidation in 'other server(s)' mode.
XtkWebForm_Password Password of the instance to be used for web form invalidation in 'other server(s)' mode.
XtkWebForm_ServersMode Option that lets you specify the invalidation mode of web forms: local by default, uses tracking servers if the option is 'tracking' and uses a personalized list with the 'other server(s)' option.
XtkWebForm_ServersURLs Personalized address list of servers to be contacted for web form invalidation ('other server(s)' mode).