How to Create and Process a Deploy (Windows)

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

Back to top

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:

1. webmanager-backend-webapp-1.0-SNAPSHOT.war (present in the root of the ZIP-file);
2. webmanager-static-webapp-1.0-SNAPSHOT.war (present in the root of the ZIP-file);
3. Gather all plugins into one new ZIP-file.
4. All plugins present in the edition-bundles directory of the unzipped archive.

Back to top

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.

Back to top

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.
• Start Tomcat.

Back to top

Using a Location Independent WAR

Installing and configuring XperienCentral in a DTAP (Development Testing Acceptance Production) environment is made much easier by using a location independent WAR file. This allows you to install XperienCentral on one server, configure it to your specifications and once it is running to your satisfaction, create a WAR file and port it to other servers in your environment. The advantage of this approach is that the XperienCentral deployment can be installed in directories of different names on different servers and be ported from a Windows environment to Linux and vice versa. Another advantage is that you can install multiple copies of XperienCentral alongside each other on one server for testing/troubleshooting purposes.

To use a location independent WAR archive, follow these steps:

1. Open the settings.xml file in the root of the XperienCentral installation and define the following property:
   
   

   <webmanager.springproperties.filename>file:${webmanager.configuration.properties}</webmanager.springproperties.filename>
   
   

2. Build a WAR archive of the XperienCentral project.

You can now extract the WAR file on another server or servers. For each installation, you must do one of the following:

Modify the Configuration Files Manually

Extract the files config.xml, startup_config.xml and webmanager.properties from the archive. Make the following modifications:

• config.xml - define cleansite_location, file_browser_directories and www_root_directory to match the installation.
• startup-config.xml - define base_directory and wcb_directory to match the installation.

• webmanager.properties - change the directories to match the installation.

Create New Configuration Files and Change the Catalina Options

Create new versions of the files config.xml, startup-config.xml and webmanager.properties. Change the Catalina startup options (setenv.sh or setenv.bat). For example, if the installation location is /vol/www/mywebsite, the Catalina startup options would be:

CATALINA_OPTS="$CATALINA_OPTS -Dwebmanager.configuration.initial=/vol/www/mywebsite/work/config/config.xml"
CATALINA_OPTS="$CATALINA_OPTS -Dwebmanager.configuration.startup=/vol/www/mywebsite/work/config/startup_config.xml"
CATALINA_OPTS="$CATALINA_OPTS -Dwebmanager.configuration.properties=/vol/www/mywebsite/work/config/webmanager.properties"

For JBoss add these 3 JAVA_OPTS to the standalone.conf and/or standalone.conf.bat.

Back to top