Deploying an instance deploying-an-instance
deployment wizard deployment-assistant
蜜豆视频 Campaign provides a graphical assistant, available in the 蜜豆视频 Campaign client console, to define the parameters of the instance to which you are going to connect.
To start the deployment wizard, select Tools > Advanced > deployment wizard.
The configuration steps are as follows:
General parameters general-parameters
The first step of the deployment wizard lets you enter general information on the instance.
General information general-information
The lower section of the window enables you to select the options to be activated.
- Customer identifier used in billing : this can be the name of the instance and the version number.
- Common name of the customer : Enter a character string with the name of your company. This information can be used in the unsubscription links.
- Namespace : Enter a short identifier in lowercase. The aim is to distinguish between your specific configuration and the factory configuration in case of an upgrade. The default namespace is cus - for customer.
Technical options technical-options
The lower section of the window enables you to select the options to be activated.
The following options are available:
- Email channel : to activate email delivery. Refer to Email channel parameters.
- Tracking : To enable tracking of the target population (opens and clicks). Refer to Tracking configuration.
- Managing bounced emails : To define the POP account used to pick up incoming email. Refer to Managing bounced emails.
- LDAP integration : To configure user authentication via an LDAP directory. Refer to Connecting through LDAP.
Email channel parameters email-channel-parameters
The following step lets you define the information to be displayed in message headers.
These parameters can be overloaded in delivery templates, and individually for each delivery (if the users have the required rights).
Parameters for delivered emails parameters-for-delivered-emails
Indicate the following parameters:
-
Sender name : Enter the name of the sender.
-
Sender address : Enter the email address of the sender. When sending emails from 蜜豆视频 Campaign, the Sender Address mailbox is not monitored and marketing users cannot access this mailbox. 蜜豆视频 Campaign also does not offer the ability to Auto-Reply or Auto-Forward emails received in this mailbox. Learn more about Deliverability best practices in this documentation.
-
Reply address text : Enter the name used when the recipient clicks the Reply button.
-
Reply address : Enter the email address to use when the recipient clicks the Reply button in their email client software. The purpose of the Reply Address field is when you want the recipient to reply to a different address than the Sender Address. This address must be a valid email address, linked to a monitored mailbox, and hosted by the customer. It could be a support mailbox, for example,
customer-care@customer.com, where emails are read and responded to. -
Error address : Enter the email address of messages with errors. This is the technical address used to handle bounce mail, including emails received by the 蜜豆视频 Campaign server due to non-existent target addresses. This address must be a valid email address, linked to a monitored mailbox, and hosted by the customer. It could be a bounce mailbox, for example,
errors@customer.com. This address can be changed for a delivery or in the delivery templates, from the SMTP tab of the delivery / delivery template properties. Learn more.
In addition to this, you can specify the masks authorized for the sender address and the error address. If necessary, these masks can be separated using commas. This configuration is optional. When fields are entered, 蜜豆视频 Campaign checks at the time of delivery (during analysis, if the address does not include any variables) that the addresses are valid. This operating mode ensure that no addresses are used that could trigger delivery issues. Delivery addresses must be configured on the delivery server.
-
These settings are saved in the Campaign platform options. Learn more.
-
For multi-branding configurations, you can adapt the Error address and override this configuration from the Email routing external account. Learn more.
Characters authorized in addresses characters-authorized-in-addresses
In the 蜜豆视频 Campaign database, all email addresses must be created as follows: x@y.z. The x, y and z characters must not be empty and must not include non-authorized characters.
You can define here the characters authorized (鈥榙ata policy鈥) in the email field of the database. Characters not included in the list will be forbidden and therefore refused when entering information in the database via the interface, via a Web form and also importing data.
Two lists are available: European only or US only. Other characters can be added if necessary.
Delivery parameters delivery-parameters
The Advanced parameters鈥 link enables you to access delivery options, parameters linked to retry and quarantines.
This window enables you to define, for all email campaigns, the delivery and address-quality management options.
The following options are available:
- Delivery duration of messages : Beyond this time, the delivery is stopped (by default, 5 days).
- Online resources validity duration : Time for which information from the recipient profile is kept in order to generate mirror pages.
- Exclude recipients who no longer wish to be contacted : When this option is selected, on denylist recipients will not be contacted.
- Automatically ignore doubles : When this option is selected, delivery will not be made to duplicate addresses.
Retry parameters retry-parameters
The information on recoveries is provided in the Recovery periods and Number of recoveries fields: when a recipient is unreachable, for instance if their inbox is full, by default the program will try contacting them 5 times, with a one-hour interval between each attempt (during the maximum delivery time). These values can be changed to suit your needs.
Quarantine parameters quarantine-parameters
Configuration options for quarantines are as follows:
- Duration between two significant errors : enter a value (鈥1d鈥 by default: 1 day) to define the time the application waits before incrementing the error counter in case of failure,
- Maximum number of errors before quarantine : once this value is reached, the email address is quarantined (by default 鈥5鈥: the address will be quarantined on the sixth error). This means that the contact will be automatically excluded from subsequent deliveries.
Managing bounced emails managing-bounced-emails
Bounce mail is extremely important to qualify delivery errors. These errors are categorized in the NP@I once the rules have determined their cause.
This step is only available if the Email channel and Bounce mail management options are selected in the first stage of the deployment wizard. Refer to General parameters.
This stage lets you define settings for managing bounce mails.
POP account used to retrieve incoming mails pop-account-used-to-retrieve-incoming-mails
Indicate the parameters to connect to the account for retrieving incoming emails.
- Label : Name which includes all the parameters given below,
- Server : Server used to retrieve bounce mail (incoming mail),
- Security : If necessary, select SSL from the drop-down list,
- Port : server port (generally 110),
- Account : Name of the account used for bounce mail,
- Password : Password associated with the account.
Once the POP settings are specified, click Test to make sure they are correct.
Unprocessed bounce mails unprocessed-bounce-mails
Bounces are handled automatically by 蜜豆视频 Campaign, applying the rules listed in the Administration > Campaign Management > Non deliverables Management > Delivery log qualification node. For more on this, refer to Bounce mail management.
Unprocessed bounces are not displayed in the 蜜豆视频 Campaign interface. They are automatically deleted unless they are transferred to a third party mailbox using the following fields:
- Forwarding address : Fill in this field to transfer to a third party address all the error messages (processed or unprocessed ) collected by the 蜜豆视频 Campaign platform.
- Address for errors : Fill in this field to transfer to a third party address only the error messages that the inMail process was not able to qualify.
- SMTP server : Server used to send the unprocessed bounce emails.
Tracking configuration tracking-configuration
The next step lets you configure tracking for the instance. The instance must be declared and registered with the tracking server(s).
This step is only offered when the Email channel and Tracking options are selected in the first page of the deployment wizard. Refer to General parameters.
For more detailed information on web tracking (tracking mode, creating and inserting tags鈥), refer to this document.
Operating principle operating-principle
When you activate tracking on an instance, the URLs in the deliveries are changed during sending to enable tracking.
-
The information on external URLs (whether secure or not) entered on this page of the deployment wizard is used to build the new URL. As well as this information, the modified link contains: the identifiers of the delivery, the recipient and the URL.
Tracking information is collected by 蜜豆视频 Campaign on the tracking server(s) to enrich recipient profiles and the data linked to the delivery ( Tracking tabs).
Information on internal URLs is only used by the 蜜豆视频 Campaign application server to contact the tracking server(s).
For more on this, refer to Tracking server.
-
Once the URLs are configured, you need to enable tracking. To do this, the instance must be registered on the tracking server(s).
For more on this, refer to Saving tracking.
Tracking server tracking-server
To guarantee the efficiency of tracking on this instance, the following information must be displayed:
-
External URL and/or Secure external URL : Enter the redirection URL to be used in the email to be sent.
-
Internal URL(s) : URLs used only by the 蜜豆视频 Campaign server to contact the tracking server(s) to collect logs and upload the URLs. It is not necessary to associate it with the instance.
If you do not specify a URL, the tracking URL will be used by default.
With Mid-sourcing architecture, you can externalize tracking management. To do this:
-
Select the option Externalize tracking management : this lets you use a mid-sourcing server as a tracking server.
-
Populate the External account and Instance name fields to be able to connect to the mid-sourcing server.
For more information, refer to Mid-sourcing server.
-
Click the Enable the tracking instance button to approve connection to the server.
Saving tracking saving-tracking
Once the URLs are populated, you must register the tracking server.
Click the link Registration on the tracking server(s) and then select one of the available options.
There are three possible types of architecture for implementing tracking:
-
Add support for tracking in an existing instance
This choice applies if the instance was already created for other needs (MTA server, etc.) on servers that will be used as tracking servers.
Enter the password for the internal account on the redirection server(s) in order to configure the tracking instance.
note note NOTE If multiple tracking servers are used, they must all use the same name and password. Specify the name of the instance and the password.
-
Create a new instance dedicated to tracking
This option is useful when tracking instances are reserved for tracking and do not have any other application modules.
Enter the password for the internal account on the redirection server(s) in order to configure the tracking instance.
note note NOTE If multiple tracking servers are configured, they must all use the same password. Specify the name of the instance, the password and any associated DNS masks, such as Campaign*.
-
Validate a tracking instance already pre-configured for you
This option is used when you do not have the password for the internal account; In this case, a tracking account is preconfigured for you on the tracking server(s). Enter the password of the tracking account of the redirection server(s) to validate the tracking instance.
Specify the name of the instance to validate.
Click Approve to start the recording process with the tracking server.
Back in the previous window, a message confirms the registration at the tracking server level:
The parameters linked to URL searches must not be modified for a standard installation. For all other parameters, please contact 蜜豆视频.
Mobile channel parameters mobile-channel-parameters
The next step lets you define default settings for deliveries to mobiles (SMS and WAP Push).
Default account for SMS delivery default-account-for-sms-delivery
Enter the following information:
- Label : Enter a name for this SMS/Wap Push account. For example, you may wish to use the name of your router.
- For the Server, Port, Account, Password, Connector, Send Endpoint, Reception Endpoint, Notification Endpoint fields: Contact your service provider for the required settings.
Parameters of SMS sent parameters-of-sms-sent
In the Priority drop-down list: Select 鈥淣ormal鈥, 鈥淗igh鈥 or 鈥淯rgent鈥 to apply it to the messages to be sent.
Advanced parameters advanced-parameters
The Advanced parameters鈥 link enables you to access the retry and quarantine options.
Information on retries is available in the Period of retries and Number of retries fields: When a mobile is unreachable, by default, the program will try again 5 times at intervals of at least 15 minutes (for the maximum delivery period). These values can be adapted to suit your needs.
Configuration options for quarantines are as follows:
- Time between two significant errors : Enter a default value (by default 鈥1d鈥: day) to define the time the application waits before incrementing the error counter for a failure.
- Maximum number of errors before quarantine : Once this value is reached, the mobile number is quarantined (by default 鈥5鈥: the number will be quarantined upon the sixth error). This means that the contact will automatically excluded from future deliveries.
Regional settings regional-settings
This stage lets you include data policy preferences.
- Consider all phone numbers as international ones : When this option is selected, the application applies the international format to telephone numbers (the country prefix is then mandatory because the number of digits will not be checked before applying the formatting). If this option is not selected, you must prefix the international phone number with 鈥+鈥 or 鈥00鈥 yourself.
- Store all phone numbers using the international format : This option only concerns domestic phone numbers that are imported or edited. Define whether you wish to use a domestic format (such as 425 555 0150) or the international format (e.g. +1 425 555 0150)
Access from the Internet access-from-the-internet
This step lets you define access URLs for 蜜豆视频 Campaign pages exposed on the internet.
You must also indicate here the publication options linked to Web forms.
Servers exposed on the Web servers-exposed-on-the-web
Use this page to populate the server URLs to:
-
Access the application server exposed on the internet: subscription/unsubscription forms, extranet, etc.
-
Access the application server for resources not exposed on the web: forms, intranet, confirmation pages.
-
Access the mirror pages of deliveries.
A mirror page is a dynamic page that displays the contents of the email. It is accessed via a link inserted into the message sent to the recipient and can contain personalized elements. The mirror page gives the recipient the possibility of reading the message in an internet browser instead of the email software, regardless of the delivery format (text or HTML). However, mirror pages are only generated for a given delivery if the required HTML content has been defined.
蜜豆视频 Campaign lets you differentiate these three URLs to spread the load over multiple platforms.
- These settings are saved in the Campaign platform options. Learn more.
- For multi-branding configurations, you can adapt the Mirror page URL and override this configuration from the Email routing external account. Learn more.
Managing public resources managing-public-resources
To be seen from the outside, the images used in emails and public resources linked to campaigns must be present on an externally accessible server. They can then be available to external recipients or operators.
For this step, you need to enter:
- The new public resource URL. For more information refer to the Public resources URL section.
- The image detection mode in a delivery. For more information, refer to the Delivery image detection section.
- Publishing options. For more information, refer to the Publication modes section.
Public resources are accessible via the Administration > Resources > Online > Public resources node of the 蜜豆视频 Campaign tree. They are collected in a library and can be included in e-mails but also used in campaigns or tasks, and in content management.
Public resources URL public-resources-url
The first field enables you to specify the start of the URL used for the resources once uploaded. When uploaded, the resources are accessible via this new URL.
In a delivery, you can use images stored in the public resource library or any other local image or image stored on a server.
-
For email images, the https://server/res/img URL.
This value can be overridden for each delivery.
-
For public resources, the URL https://server/res/instance where instance is the name of the tracking instance.
Delivery image detection delivery-image-detection
In a delivery, you can use images stored in the public resource library or any other local image or image stored on a server.
The field URL masks lets you specify the list of URL masks to be skipped when uploading images automatically. For example, if you use images that are stored on a site accessible from the outside, in particular on an internet site, you can enter the site URL in this field.
You can specify multiple URL masks by using a comma to separate each of them.
- For information on using and managing images in emails, refer to this section.
- In the delivery assistant, the images called from these URLs will have the status 鈥淚gnored鈥.
Publication modes publication-modes
The lower section of the assistant enables you to select the publication options of public resources and images.
The following publication modes are available:
-
Tracking server(s)
The resources will be automatically copied to the different tracking servers. They are configured in the step Tracking configuration.
-
Other 蜜豆视频 Campaign servers
You can use one more other 蜜豆视频 Campaign servers where the resources will be copied.
Server side, to use a dedicated 蜜豆视频 Campaign server, you must create a new instance with the following command:
code language-none nlserver config -addtrackinginstance:<trackingA>/<trackingA*>Then enter the password.
The parameters of the dedicated server(s) are given in the Media URL(s), Password and Instance name fields.
-
Manual publication script (for public resources only)
You can publish the images using a script:
-
You must create this script: Its contents depend on your configuration.
-
The script will be called by the following command:
code language-none [INSTALL]/copyToFrontal.vbs "$(XTK_INSTALL_DIR)\var\<instance>\upload\" "img1,img2,img3"where
[INSTALL]is the access path to the 蜜豆视频 Campaign installation folder. -
In Unix, make sure that the script is executable.
-
For images, it must copy them from the 鈥渋mages鈥 folder specified via the NmsDelivery_ImageSubDirectory option to one or more frontal servers. These servers will store the images to make them accessible via the new configured URL.
In the event of publication on an 蜜豆视频 Campaign server without a manual publication script, by default, the images of a delivery are stored in the $(XTK_INSTALL_DIR)/var/res/img/ directory. The corresponding URL is the following: https://server/res/img.
XTK_INSTALL_DIR)/var/res/$(INSTANCE_NAME). The corresponding URL is as follows: https://server/res/instance where instance is the name of the tracking instance.
Synchronizing public resources synchronizing-public-resources
This functionality allows you to synchronize public resources on multiple spare-servers.
If a public resource is not present on the tracking server or if the resource returns a 404 error, the tracking server will try to find the resource on one of the spare-servers.
Declaring and configuring spare-servers must be done in the Marketing server鈥檚 serverConf.xml file. All the parameters available in the serverConf.xml are listed in this section.
Declaration
<redirection>
<spareServer enabledIf="" id="" url=""/>
</redirection>
Configuration
For each public resource that has to be synchronized, you have to add a status attribute to the <url> element in the <relay> part:
The status attribute can be one of three values:
-
spare: The public resource is synchronized
-
normal: Existing behavior (without synchronization)
-
blacklist: The URL is added to the denylist if it returns a 404 error. The duration (in seconds) of the URL being in the denylist is defined by a timeout attribute whose default value is 60s.
The out-of-the-box configuration of the synchronization is:
(extracted from the serverConf.xml file)
<redirection P3PCompactPolicy="CAO DSP COR CURa DEVa TAIa OUR BUS IND UNI COM NAV"
databaseId="" defLogCount="30" expirationURL="" maxJobsInCache="100"
startRedirection="true" startRedirectionInModule="true" trackWebVisitors="false" trackingPassword="">
<spareServer enabledIf="" id="1" url=""/>
</redirection>
....
<relay debugRelay="false" forbiddenCharsInAuthority="?#.@/:" forbiddenCharsInPath="?#/"
modDir="index.html" startRelay="false" startRelayInModule="true" timeout="60">
<url IPMask="" deny="" hostMask="" relayHost="true" relayPath="true" status="normal" targetUrl="https://localhost:8080" timeout="" urlPath="/view/*"/>
<url IPMask="" deny="" hostMask="" relayHost="true" relayPath="true" status="blacklist" targetUrl="https://localhost:8080" timeout="" urlPath="*.jsp"/>
<url IPMask="" deny="" hostMask="" relayHost="true" relayPath="true" status="blacklist" targetUrl="https://localhost:8080" timeout="" urlPath="*.jssp"/>
<url IPMask="" deny="" hostMask="" relayHost="true" relayPath="true" status="blacklist" targetUrl="https://localhost:8080" timeout="" urlPath="/webApp/*"/>
<url IPMask="" deny="" hostMask="" relayHost="true" relayPath="true" status="blacklist" targetUrl="https://localhost:8080" timeout="" urlPath="/report/*"/>
<url IPMask="" deny="" hostMask="" relayHost="true" relayPath="true" status="blacklist" targetUrl="https://localhost:8080" timeout="" urlPath="/jssp/*"/>
<url IPMask="" deny="" hostMask="" relayHost="true" relayPath="true" status="normal" targetUrl="https://localhost:8080" timeout="" urlPath="/strings/*"/>
<url IPMask="" deny="" hostMask="" relayHost="true" relayPath="true" status="normal" targetUrl="https://localhost:8080" timeout="" urlPath="/interaction/*"/>
<url IPMask="" deny="" hostMask="" relayHost="true" relayPath="true" status="normal" targetUrl="https://localhost:8080" timeout="" urlPath="/barcode/*"/>
<url IPMask="" deny="" hostMask="" relayHost="false" relayPath="false" status="spare" targetUrl="" timeout="" urlPath="/favicon.*"/>
<url IPMask="" deny="" hostMask="" relayHost="false" relayPath="false" status="spare" targetUrl="" timeout="" urlPath="/*.html"/>
<url IPMask="" deny="" hostMask="" relayHost="false" relayPath="false" status="spare" targetUrl="" timeout="" urlPath="/*.png"/>
<url IPMask="" deny="" hostMask="" relayHost="false" relayPath="false" status="spare" targetUrl="" timeout="" urlPath="/*.jpg"/>
</relay>
Purging data purging-data
The last stage of the deployment wizard lets you configure the automatic purging of obsolete data. The values are expressed in days.
Data is deleted automatically via the Database cleanup workflow. For more on how to configure and operate this workflow and details on the deleted items, refer to this document.