Editing Your Application Update Properties

The Deployment Packager uses the \config\application-update.properties file to know which data, extension, and preferences files to compress to the Web Archive (WAR) file that contains the files that will be merged with a new Archibus version.

The Package and Deploy Wizard writes the application-update.properties file based on your selections. Using the wizard there is no need to edit the file. This topic is for advanced users who want to edit the file directly, or for those upgrading from V.17.3 and V/18.x Web Central applications.

Editing the application-update.properties File

The template for the application-update.properties file resides in \schema\ab-core\system-administration\update-app-wizard\templates .

Copy this file to \WEB-INF\config and edit it before running the Deployment Packager actions.

Using any text editor, such as Notepad, you can make the following edits.

  • Adding and Removing Files . To add a file or folder, just add a line to the preferences file. You can use wild cards. For example, adding “ \projects\hq\graphics\*” indicates to include all files in the graphics folder and in any and all subfolders. To exclude a file or folder, remove the line.
  • Data. Each data line starts with “ data=” , meaning that a file or set of files should be included in the mysite-data.war file. Typically, you will need to add the lines that state where your project data is.
  • Extensions . Each extension line starts with “ extensions=” , meaning that the file or set of files should be included in the mysite-extensions.war . You only need to edit this section if your add-in manager has extended Archibus to add new applications or has changed an existing Archibus application.

    Typical extensions have just a few folders of new views, a few workflow rules, and one or two .jar files. By marking these few changes to be preserved, you can update to a new Archibus version and preserve your changes. Any new files will be added to Archibus. In the case of a conflict, your file will be used in place of the Archibus file.

  • Properties: You should change this list of files only if you update to a new version of Archibus that has added additional .properties files.

A typical packager properties file is below.

# application-update.properties # ---- Data Files ---- # These files typically come from the production server. # Your project files. These include: # Enterprise graphic files (.swf,.emf,.json) data=\projects\hq\graphics\* # Drawing files (.dwg or .rvt) data=\projects\hq\drawings\* # Any database backup files data=\projects\hq\database-backups\* # All temporary user work (reports, data transfer files, etc.) data=\projects\users\* # All per-site application files (e.g. ad-hoc view files and dashboard views created # with the View Definition Wizard or Alter # View and My Favorites features). data=\schema\per-site\* # ---- Application Extension Files ---- # If your integration team has made personalized extensions in the # schema\ab-products folder, list the folder containing your extensions, e.g.: extension=\schema\ab-products\space\my-new-process\* # ---- Properties Files ---- # Include your preferences files. The list of update-able preferences files # is fixed. Do not add files to this list. # Include this file so that deployment packages made from any server will # use the exact same file set. data=\WEB-INF\config\application-update.properties # Include your Archibus license file. data =\WEB-INF\config\afm-licenses.xml # Include your projects list. data =\WEB-INF\config\afm-projects.xml # Include your properties files. data =\WEB-INF\config\core.properties data =\WEB-INF\config\security.properties data =\WEB-INF\config\mail.properties data =\WEB-INF\config\smartclient.properties # Include any configuration files containing your authentication changes. data =\WEB-INF\config\sso.properties data =\WEB-INF\config\ldap.properties data =\WEB-INF\config\accountmanager.properties data =\WEB-INF\config\projectid.properties