Running the Package and Deploy Wizard for Enterprise Deployments

If you have an enterprise deployment:

  • Your database and application server are often on different servers.
  • You often have changes to the Archibus applications that you wish to preserve.
  • You often have other extensions besides My Favorites that you wish to preserve.
  • You prototype your changes on a staging server before you copy them to the production server.

To use the wizard, you will run it twice:

The diagram below overviews the process and the procedures follow.

enterprise_upgrade.gif

Prerequisites

Back up your files

The wizard sequence merges your project, application, and configuration data. Therefore, it is important to back up the following workstation files, before running the wizard:

  • \archibus\schema
  • \archibus\projects

You do not need to back up your project database data if it is running on a separate database server, as the upgrade process does not affect the database server.

Copy the war file

Copy the newer Archibus Web Central distribution file, the archibus.war , downloaded to the production server to replace the older version of archibus.war.

Staging Server Procedure

To package extensions:

  1. First run the wizard on the staging server. Select System / System Administrator / Package and Deploy Wizard .
  2. Verify Backup : Back up your data and click Next.
  3. Specify Deployment Type: Choose Enterprise Deployment and Staging Server and click Next.
  4. Specify Update Type :
    • If you have changed many Archibus applications, select the “Core only” update type to preserve all of your application changes.
    • If you have changed one of the stock Archibus applications, select the “Core and Specific Application Domains” option. Select the domains in which you have *not* made changes, that is, select the application domains that you *do* wish to upgrade.
    • Click Next.
  5. Preserve Data: The wizard will list the project locations it finds in your active projects in your projects list ( \config\afm-projects.xml ). If this list is incorrect, stop the wizard, and correct your projects list. You can do so by editing the afm-projects.xml file directly. Click Next.
  6. Preserve Extensions : If you have created additional extensions that do not reside in the subfolders that hold the stock Archibus applications (that is, extensions that are not beneath the \schema\ab-products folder), then use the Add Folder action to add those folders so that they will also be preserved. Click Next.
  7. Package Deployment: Click the Package Deployment File action to create a new my-site-extensions.war file.
  8. Copy this mysite-extensions.war file to your production server. Place it in the same folder containing the archibus.war file.

Production Server Procedure

After performing the staging server procedure, run the Package and Deploy Wizard on the production server.

  1. Verify Backup . Back up your data and click Next.
  2. Specify Deployment Type . Choose Enterprise Deployment and Production Server and click Next.
  3. Verify Archive. Select Yes-Next to indicate that you have updated your archibus.war distribution file to the one from the newer version of Archibus.
  4. Specify Update Type . Make the same selections that you did for the staging server, and click Next.
  5. Preserve Data. The wizard will list the project locations it finds in your active projects in your projects list ( config\afm-projects.xml). If this list is incorrect, stop the wizard, and correct your projects list. You can do so by editing the a fm-projects.xml file directly. Click Next.
  6. Package Deployment . Press the Package Deployment File action to create a new archibus.war file.

You can now redeploy Archibus using the updated archibus.war file.

Redeploying when Running Apache Tomcat

To redeploy when running Apache Tomcat:

  1. Stop your application server.
  2. Delete all files beneath the \Archibus subfolders, except for the .war files.
  3. Move the .war file that was created to \\tools\\tomcat\webapps .
  4. Restart Tomcat.