In This Topic
Creating the Deploy
Creating the deploy is accomplished in two steps.
Create a Specific settings.xml for the Target Environment
A deploy is always created with a specific target environment in mind. So, for example, a deploy can specifically be created for a test environment. For each target environment you need a separate settings.xml
. For a test environment, copy the settings.xml
to settings-test.xml
and then adjust the properties in the settings-test.xml
file. The typical properties you should check to ensure they are correct are:
- Path names
- Hos tnames
- Database properties
- Usernames/passwords
Build the Deploy using Maven
After the properties have been set in the target environment, execute the following command in a Command prompt:
mvn -s settings-test.xml -P build-deploy clean package assembly:assembly
What to Deliver to the System Administrator
After the deploy has been built, a .ZIP file is present in the “target” folder. The default name of the ZIP-file is “webmanager-webmanager-1.0-SNAPSHOT.zip”. Send the following files to the system administrator of the target environment:
webmanager-backend-webapp-1.0-SNAPSHOT.war
(present in the root of the ZIP-file);webmanager-static-webapp-1.0-SNAPSHOT.war
(present in the root of the ZIP-file);- Gather all plugins into one new ZIP-file.
- All plugins present in the
edition-bundles
directory of the unzipped archive.
How to Process the Deploy
After receiving the files from the developer, the system administrator has to perform the following steps to process the files:
- Stop Tomcat.
- To support a rollback, back up the following folders and files:
<webmanager-root>\deploy\webmanager-backend-webapp-1.0-SNAPSHOT.war
<webmanager-root>\wwwroot\mywebsite\wm\
- Create a backup of your relational database
- Remove the content of the following folders:
<webmanager-root>\work\edition-bundles\
<webmanager-root>\work\osgi\*
<webmanager-root>\deploy\web (remove the entire folder)
<tomcat-installation-dir>\work\*
<tomcat-installation-dir>\temp\*
- Remove the following file:
<webmanager-cleansite-location>\webmanager-cleansite-1.0-SNAPSHOT.jar
- Copy
webmanager-backend-webapp-1.0-SNAPSHOT.war
to<webmanager-root>\deploy
. - Copy
webmanager-cleansite-1.0-SNAPSHOT.jar
to<webmanager-cleansite-location>
. - Unzip the
webmanager-static-webapp-1.0-SNAPSHOT.war
to<webmanager-root>\wwwroot\mywebsite\
(overwrite all files). - Unzip the plugin .ZIP zip file to
<webmanager-root>\work\deploy
(if it was delivered). - Place the
edition-bundles
plugins received from the developer in the<webmanager-root>\work\edition-bundles\
directory. - Start Tomcat.
How to Roll Back a Deploy
It is possible that XperienCentral will not start correctly after installing a new deploy. Usually this is caused by incorrect configuration settings. To switch back to the last known good configuration, perform these steps:
- Stop Tomcat.
- Restore the files from the backup:
- Copy
webmanager-backend-webapp-1.0-SNAPSHOT.war
back to<webmanager-root>\deploy\appBase
. - Copy the
wm
folder back to<webmanager-root>\wwwroot\mywebsite\
. - Remove the plugins present in the
<webmanager-root>\work\edition-bundles\
directory. - Copy the
edition-bundles
plugins from the backup to<webmanager-root>\work\edition-bundles\
. - Remove
/vol/www/mywebsite/work/jcr/repository/
. - Restore the database.
- Copy
- Start Tomcat.