This section will provide you with an in-depth walkthrough on the upgrade process and the steps to identify and resolve conflicts.
The build upgrade must be carried out with caution, its impacts must be fully considered beforehand and the procedure must be completed with a high level of discipline. To ensure a successful upgrade, ensure that only expert users perform the steps outlined below. In addition, we strongly recommend getting in touch with Adobe Customer Care before starting any upgrade.
The following prerequisites are needed:
For hosted and hybrid instances, you must request the build upgrade to Adobe Technical Operations team. For more on this, refer to the Frequently Asked Questions section at the bottom if this page. Also consult the build upgrade FAQ.
Before starting the build upgrade, you must perform a full preparation as described below.
Once the system is ready to be upgraded, a build upgrade takes at least 2 hours.
The build upgrade process requires the following resources:
Here are the key points on how to plan a build upgrade:
The build upgrade process requires the following people to be involved:
Adobe architect: for hosted or hybrid architectures, the architect must coordinate with Adobe Campaign Client Care.
for On Premise installations: the customer’s internal Project Leader leads the upgrade and manages lifecycle tests.
for Hosted installation: the hosting team will partner with the Adobe Campaign Client Care team and the customer to coordinate the upgrade timeline for all instances.
Adobe Campaign Administrator:
for On Premise installations: the administrator performs the upgrade.
for Hosted installations: the hosting team performs the upgrade.
Adobe Campaign operator\marketing user: the operator runs tests on development, test and production instances.
Before starting the build upgrade, on-premise customers need to perform the following preparation:
Ensure any development work can be exported before the upgrade, export as packages.
Perform a full backup of the databases for all instances of the source and target environments.
Get the latest version of your server configuration file.
Download the latest build. Learn more about the Download center.
You also need to know all the useful command lines before starting a build upgrade:
Procedures below are only performed by on-premise customers. For hosted customers, it is taken care by the hosting team. To update Adobe Campaign to a new build, the detailed procedure is described below.
Here is how you duplicate an Adobe Campaign environment, in order to restore a source environment to a target environment, resulting in two identical work environments.
To do this, follow the steps below:
Create a copy of the databases on all instances in the source environment.
Restore these copies on all instances of the target environment.
Run the nms:freezeInstance.js cauterization script on the target environment before starting it up. This will stop all processes interacting with the outside: logs, tracking, deliveries, campaign workflows, etc.
Check cauterization, as follows:
Check that the only delivery part is the one which ID is set to 0:
SELECT * FROM neolane.nmsdeliverypart;
Check that the delivery status update is correct:
SELECT iSate, count(*) FROM neolane.nmsdeliveryGroup By iProd;
Check that the workflow status update is correct:
SELECT iState, count (*) FROM neolane.xtkworkflowGROUP BY iState; SELECT iStatus, count (*) FROM neolane.xtkworkflowGROUP BY iStatus;
In order to replace all files with the new version, it is required that all instances of the nlserverservice are shut down.
Shut down the following services:
Make sure that the redirection server (webmdl) is stopped, so that the nlsrvmod.dll file used by IIS can be replaced with the new version.
Validate that no tasks are active by running the nlserver pdump command. If there are no tasks, then the output should resemble the following:
C:\<installation path>\bin>nlserverpdump HH:MM:SS > Application Server for Adobe Campaign version x.x (build xxx) dated xx/xx/xxxx No tasks
Check the Windows Task Manager to confirm that all processes have stopped.
Run the Setup.exe file. If you need to download this file, access the Download center.
Select the installation mode: Update or Repair.
Click Finish: the installation program copies the new files.
Once the operation is complete, click Finish.
Open up the command line.
Run nlserver config -postupgrade -allinstances to perform the following:
This operation should only be performed once and only on an nlserverweb application server.
To synchronize only one database, run the following command:
nlserver config -postupgrade -instance: <instance_name>
Check if the synchronization has generated any errors or warnings.
The following services need to be restarted:
The client console must be on the same build as the server instance.
On the machine where the Adobe Campaign application server is installed (nlserverweb), download and copy the file:
Setup-client-7.xxxx.exe in [path of the application]\datakit\nl\en\jsp
The next time client consoles are connected, a window will inform users about the availability of a new update and offer them the possibility of downloading and installing it.
Some configurations require specific additional tasks to update to a new build.
When Transactional Messaging (Message Center) is enabled on your Campaign instance, you need to perform these additional steps to upgrade:
Update the Message Center production server to the chosen version.
Run the postupgrade scripts.
Run tests and ensure that the emails are successfully received through the Message Center production instance.
Upgrade clients and clear cache.
Publish Message Center templates to ensure that the interface between servers and Message Center instance is working.
Run tests to ensure that emails are successfully received through the Message Center production instance.
Run workflow tests in production to ensure that deliveries are received.
In the context of a mid-sourcing environment, you need to perform these additional steps to upgrade:
Contact Adobe Customer Care to coordinate the upgrade of the Mid-Sourcing server.
Validate that the version has been updated by running a test link. For example:
The Mid-Sourcing server must always run the same version (or more recent) as for the marketing servers.
You need to check the synchronization result. This procedure is only performed by on-premise customers. For hosted customers, it is taken care by the hosting team. There are two ways to view the synchronization result:
In the command-line interface, errors are materialized by a triple chevron ‘>>>’ and synchronization is stopped automatically. Warnings are materialized by a double chevron ‘>>’ and must be resolved once synchronization is complete. At the end of the postupgrade, a summary is displayed in the command prompt. It can look like this:
YYYY-MM-DD HH:MM:SS.749Z 00002E7A 1 info log =========Summary of the update========== YYYY-MM-DD HH:MM:SS.749Z 00002E7A 1 info log <instance name> instance, 6 warning(s) and 0 error(s) during the update. YYYY-MM-DD HH:MM:SS.749Z 00002E7A 1 warning log The document with identifier 'mobileAppDeliveryFeedback' and type 'xtk:report' is in conflict with the new version. YYYY-MM-DD HH:MM:SS.749Z 00002E7A 1 warning log The document with identifier 'opensByUserAgent' and type 'xtk:report' is in conflict with the new version. YYYY-MM-DD HH:MM:SS.750Z 00002E7A 1 warning log The document with identifier 'deliveryValidation' and type 'nms:webApp' is in conflict with the new version. YYYY-MM-DD HH:MM:SS.750Z 00002E7A 1 warning log Document of identifier 'nms:includeView‘ and type 'xtk:srcSchema' updated in the database and found in the file system. You will have to merge the two versions manually.
If the warning concerns a conflict of resources, user attention is required to resolve it.
The postupgrade_ServerVersionNumber_TimeOfPostupgrade.log file contains the synchronization result. It is available by default in the following directory: installationDirectory/var/instanceName/postupgrade. Errors and warnings are indicated by the error and warning attributes.
How is a conflict found?
Conflicts can be found within the postupgrade.log on the server in question or within the Campaign client interface (Administration > Configuration > Package management > Edit conflicts).
The document with identifier ‘stockOverview’ and type ‘nms:webApp’ is in conflict with the new version.
If a conflict is found, check if the following conditions match:
If neither of these conditions apply, this is a false positive. If both these conditions apply, a real conflict has been found.
Has the object been modified by the customer?
Has the object been changed in the new build?
To resolve conflicts, apply the following process:
In the Adobe Campaign explorer, go to Administration > Configuration > Package management > Edit conflicts.
Select the conflict you want to resolve in the list.
There are three options to resolve conflicts: Accept the new version, Keep the current version, Merge the code (and declare as resolved), Ignore the conflict (not recommended).
When can I accept the new version?
When can I keep the current version?
When to perform a merge?
What if I ignore the conflicts?
It is highly recommended to resolve conflicts.
There are different types of merges:
If you choose to resolve the conflict manually, proceed as follows:
Here are the steps to perform a complex merge:
Development skills are required to perform complex merges.