Archibus Package and Deploy Wizard Overview

The Archibus Package and Deploy Wizard (available on the Navigator at System / System Administrator / Package and Deploy Wizard ) provides an automated process for migrating your data, extensions, and settings when upgrading to a newer version of Archibus.

The Package and Deploy Wizard features offer the following advantages over manually migrating changes:

  • Your back-up, prototype-to-production, and update processes can be consistent and repeatable.
  • Your standard processes migrate without hand editing.
  • Your data and extensions are automatically combined into Web Archive (WAR) files that can be backed up and transferred easily between computers and offices. You can then deploy these WAR files using the standard procedures supported by your application server.

Use the Package and Deploy Wizard to preserve the following when upgrading:

Component to Preserve Description
Data The wizard backs up your data files, such as enterprise graphic s files (.swf, .json,, etc) that reside on the application server
Extensions The wizard merges your personalized extensions with the files provided with a new Archibus release. The wizard can migrate any applications that are coded to the Archibus best practice guidelines. See Application and Workflow Rule Guidelines.
Settings The wizard preserves Archibus configuration and authentication preferences unique to your site are preserved, while merging them with new preferences and defaults supplied with a newer Archibus version

deploy_type.gif

The Package and Deploy Wizard divides the Archibus product into groups of files that should be upgraded together. For instance, the Archibus core product contains related files, services, and third-party libraries that Archibus develops and tests as a unit. As such, you should always upgrade Archibus core files together as one unit.

Similarly, each individual domain area, such as the Space domain, has forms, reports, workflow rules, and services that support that particular domain. Again, you should always upgrade domain files as a unit.

update_type.gif

Within reason, you can mix-and-match different portions of the product. For instance, you can keep all of your application domains as they are -- with your personalized workflow rules and forms -- and upgrade only the Archibus core. Alternately, you may wish to preserve your personalized workflow rules and forms for just one domain, Building Operations for instance, but upgrade all other portions of the product.

Version Compatibility

The following summarizes the versions that are supported and not supported when using the deployment packager:

Version Description
Version 19.1 and later The Package and Deploy Wizard can migrate properties for Archibus Version 19.1 and later
Version 17.3 and Version 18.x

You can also use the Package and Deploy Wizard on V.17.3 or V.18.x deployments. When upgrading from these versions:

  • You must copy the data and extension files manually to a staging server running V.19.1 or later (as these earlier versions did not contain the Package and Deploy Wizard ).

  • You must manually migrate preferences from your Archibus configuration files (for example, \WEB-INF\config\context\compatibility\afm-config.xml and afm-secure.xml ) to the newer V.19-and-later .preferences files.

For detailed instructions, see Upgrading V.17.3 and V.18.x Applications.

pre- V17.3 Upgrading V.17.3 applications to the newer core has been tested in order to verify compatibility with both V.1.0 and V.2.0 views and applications. While pre-V.17.3 versions use the same core features as V.17.3, these earlier version have not been specifically tested; and the Package and Deploy Wizard is not supported for pre-V.17.3 releases

System Requirements

Your deployment must meet the system requirements for the core you are deploying. For instance, if you are deploying the Archibus Web Central and this core requires JDK 1.5 or later, your installation must have JDK 1.5 or later. Or, to take another example, V.17.2 supported Oracle AS. You cannot update the V.17.2 core Web Central to V.19.1, which does not officially support Oracle AS, without some risk. For the current system requirements, see System Requirements.

Using the Package and Deploy Wizard

You can use the Package and Deploy Wizard to manage your upgrade process. The wizard provides the simplest method for upgrading and can be used with any deployment type.

The Package and Deploy Wizard asks a series of questions, and based on the answers, it writes the application-update.properties file that describes how your existing files and the new files in an Archibus update should be merged. It then calls the appropriate deployment packager actions.

If you are an advanced user, you can use the wizard interface, or run the Deployment Packager actions directly to package up data from production servers, extensions from staging servers, or entire deployment archives.

Use this table to locate the information you need:

Skill Description Learn More
Upgrading enterprise deployments using the wizard If you run the database and application server on different machines, use this procedure to upgrade. Running the Package and Deploy Wizard for Enterprise Deployments
Upgrading from V.17.3 and V.18.x Applications You can use the Deployment Packager to upgrade from V.17.3 or V.18.x applications with just a few extra steps. Upgrading V17.3 and V18.x Applications
Manually editing the application-update.properties file This topic describes the manual entries you must make when upgrading from V.17.3 or V.18.x Web Central applications, or when using the deployment packager actions to upgrade an enterprise without using the wizard. Editing Your Application Update Properties
For Advanced Users
Using the Deployment Packager Actions to Upgrade Enterprise Deployments to a New Version of Web Central For advanced users, who prefer to run the deployment packager actions without using the wizard. Upgrading Enterprise Deployments Using the Deployment Packager Actions
Upgrade specific domain Use case for upgrading only specific Web Central domains without using the wizard. Upgrading Only Specific Domains
Upgrade specific applications Use case for upgrading only specific Web Central applications without using the wizard. Upgrading Only Specific Web Central Applications
Creating extensions that use Archibus best- practice guidelines The Deployment Packager can migrate any applications that are coded to the Archibus best practice guidelines. This topic describes those practices. Application and Workflow Rule Guidelines
Troubleshooting files with duplicate names This topic describes when topics with the same name as a stock Archibus file are a problem, and how to locate these files. Identifying Duplicate Files
Preserving nonstandard configurations when upgrading If you have nonstandard configuration, this topic explains how to migrate these changes. Migrating Nonstandard Configuration Files
Using the Deployment Packager actions from the Navigator Procedures for using the Deployment Packager actions. Deployment Packager Actions: Overview