This document will present you the key steps and best practices to perform a build upgrade with Campaign Classic.
Last update: 2019-05-30
This document 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 Campaign 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 article.
A build upgrade takes at least 2 hours.
The build upgrade process requires the following resources:
Before starting the build upgrade, you must perform a full preparation. Click on the Read more button for deeper information.Read More
These procedures 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 following procedures should be applied:
What is a conflict? A conflict often arises when an object that has been customized is being changed during the upgrade. Here are the main steps to manage conflicts:
It is highly recommended to resolve conflicts. Ignoring conflicts could have long term impacts: version incompatibilities, customer will not benefit from bug fixes.Read More
You will find below common questions when requesting a build upgrade to Adobe or before starting the build upgrade process on your on-premise instance, especially on these topics:
It is highly recommended to read these common questions before contacting Adobe Support. Also consult this article.Read More
Here are the key points on how to plan a build upgrade:
The build upgrade process requires the following resources:
Adobe architect: for hosted or hybrid architectures, the architect must coordinate with Customer Care.
On Premise: the customer's internal Project Leader leads the upgrade and manages lifecycle tests.
Hosted: the hosting team will partner with the Customer Care team and the customer to coordinate the upgrade timeline for all instances.
Adobe Campaign Administrator
On Premise: the administrator performs the upgrade.
Hosted: the hosting team performs the upgrade.
Before starting the build upgrade, you need to perform the following preparation:
You also need to know all the useful command lines before starting a build upgrade:
Here is the detailed procedure to update Adobe Campaign.
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:
SELECT * FROM neolane.nmsdeliverypart;
SELECT iSate, count(*) FROM neolane.nmsdeliveryGroup By iProd;
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:
Web services(IIS): iisreset /stop
Adobe Campaign service: net stop nlserver6
Note: 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.
C:\<installation path>\bin>nlserverpdump 12:12:12 > Application Server for Adobe Campaign version x.x (build xxx) dated xx/xx/xxxx No tasks
Note that 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>
The following services need to be restarted:
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.
Here are the specific build upgrade steps for Message Center.
Here are the specific build upgrade steps for Mid-Sourcing.
Here are the main actions to perform to manage conflicts.
Viewing 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:
2013-04-09 07:48:39.749Z 00002E7A 1 info log =========Summary of the update========== 2013-04-09 07:48:39.749Z 00002E7A 1 info log <instance name> instance, 6 warning(s) and 0 error(s) during the update. 2013-04-09 07:48:39.749Z 00002E7A 1 warning log The document with identifier 'mobileAppDeliveryFeedback' and type 'xtk:report' is in conflict with the new version. 2013-04-09 07:48:39.749Z 00002E7A 1 warning log The document with identifier 'opensByUserAgent' and type 'xtk:report' is in conflict with the new version. 2013-04-09 07:48:39.750Z 00002E7A 1 warning log The document with identifier 'deliveryValidation' and type 'nms:webApp' is in conflict with the new version. 2013-04-09 07:48:39.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_<server version number>_<time of postupgrade>.log file contains the synchronization result. It is available by default in the following directory: <installation directory/var/<instance/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?
There are three options to resolve conflicts:
To resolve conflicts, apply the following process:
Accepting the new version
When can I accept the new version?
Keeping the current version
When can I keep the current version?
Performing a merge
When to perform a merge?
What if I ignore the conflicts?
We highly recommend to always resolve conflicts
There are different types of merges:
How to Merge?
Where to find the code?
How to make a diff?
How to merge?
If you choose to resolve the conflict manually, proceed as follows:
Note: Development skills are required.
Here are the steps to perform a complex merge:
Here are the main questions and topics you should be aware of when requesting or performing a build upgrade on your Campaign instance.
How soon can the upgrade be completed?
As soon as a request for upgrade is received, the support team checks with Technical Operations team for their availability.
How much time does it take to perform a complete build upgrade?
Time depends on the size of the database. It takes at least 2 hours.
How much lead time is required for this activity?
Usually there should be a lead time of one week for upgrade requests for validation and confirmation on the Adobe technical operations team availability.
This can be performed at night based on Adobe technical operations team's availability. It is always recommended to upgrade the environment during business off-hours when no business users are connected to the instance.
Recommended days are Tuesday through Thursday during business off-hours. Due to limited availability of members from Adobe technical operations team and/or other dependent teams, we avoid weekends and specific holidays. This helps avoid any major issue which might need immediate attention.
How much does an upgrade cost?
There is no cost of upgrade for hosted Customers. However, if there are issues due to custom developments, the Customer needs to fix them. Alternately, they can request Adobe professional services which involves cost.
Will there be access to the instance during the upgrade process?
No. During build upgrade the database is not accessible. There would be a downtime.
Will the emails continue to be sent from Message Center (Real Time)?
Emails from Message Center will continue to be sent when the Marketing or MID instance is being upgraded. However, when the upgrade happens for Message Center (RT), it will not send emails from this instance.
Will the workflows continue to run and send the deliveries?
No. During build upgrade, workflow server and MTA are both stopped. This means workflows will not run and deliveries are not sent.
Will my tracking links still work during the upgrade?
They will work. New emails cannot be sent during the upgrade but tracking links included in already sent emails will be operational.
Are there any actions required from the Customer before the build upgrade?
Yes. Before requesting for a build upgrade make sure that there is no database structure update pending and that there are no conflicts in reports, forms or web applications.
Does the Customer need to be available during the build upgrade process?
Not necessarily. Adobe will contact the Customer once the build upgrade is complete for confirmation.
Does the Customer need to update the client console?
Yes. It is recommended that the console is on the same (or more recent) build as the server instance.
Can the Message Center (RT) and MID instances upgrade be performed before the marketing instance in case of hybrid architecture, or does it need to happen simultaneously?
It is recommended to first upgrade Message Center (RT) and MID and then plan for the marketing instance upgrade. It can happen simultaneously also since these are separate environments.
What's the latest version of Adobe Campaign for Classic?
Latest versions are mentioned in the Release notes. Refer to: https://docs.campaign.adobe.com/doc/AC/en/RN.html.
How much time are backups kept?
Backups are stored for a limited number of days, usually about a week. A rollback will not be possible after that period.
Is there a rollback mechanism?
Adobe does not recommend rollbacks, unless there are major issues which cannot be fixed in that build and create business and financial impact. For rollback, the database is restored with the last available backup.
How much time will it take to rollback?
It depends on database backup size. Usually takes 4 hours to complete.
What are the recommendations and guide lines (for on-premise customers)?
It is always recommended to upgrade to the latest build as it includes new features as well as fixes and improvements identified in earlier builds.