Upgrading for Major Releases
This topic assumes that you have developed and deployed a compact installation of Arbortext Editor at your site for either a major or maintenance Arbortext Editor release and need to upgrade your installation for the next major release. An example of a maintenance release is 7.0 M030, and an example of a major release is 7.1 F000. A new version of the Arbortext Editor Deployment Kit is released with each Arbortext Editor major release.
Testing Your Customizations
You might want to test any customizations in your existing Arbortext Editor compact installation deployment with the new release before upgrading. Arbortext Editor will always be able to process your existing siteprefs.xml file, even if changes were made to that file in a new release. However, some of your other customizations might not work correctly in the new release.
Follow these steps to test the customizations in your Deploy Directory with a new release of Arbortext Editor:
1. Download and install the regular installation of Arbortext Editor on a test system.
2. Set the
APTDEPLOYPATH environment variable on the test system to point to the location of your existing Deploy Directory.
3. Start Arbortext Editor as usual and test your customizations.
The APTDEPLOYPATH environment variable forces Arbortext Editor to use your Deploy Directory as the source for its customization and configuration information. You are able to run the new release with your customizations just as users would in your updated compact installation.
For more information, refer to the Deploying a centralized configuration topic in the Administrator's Guide PDF.
Upgrading Using the Same Deploy Directory
If you are satisfied that your customizations works correctly with the new major release, you can upgrade using the same Deploy Directory as your current compact installation. To upgrade the compact installation of Arbortext Editor on your users’ systems, you must add a new directory to your Deploy Directory for the new major release. You must also develop and deploy a new compact installation program for the release.
|
|
Unlike upgrading an existing compact installation of Arbortext Editor for a maintenance release, when upgrading to a new major release you can change the features defined in the manifest.txt file for the existing installation.
|
Follow these steps to develop a compact installation program for the new release that uses the same Deploy Directory:
1. Download the release file for the new major release of the Arbortext Editor Deployment Kit from the PTC support site and unzip the contents to a directory on your system.
To download a release file, go to the PTC support site at
www.ptc.com/en/support and select
Download Software.
The zip file for the 64–bit version of the Arbortext Editor Deployment Kit is available when you select Arbortext Editor from the product list.
2. Execute the create_installer.exe application from the new release’s deployment kit.
Enter the same Deploy Directory in the Deploy Directory field that you are using for the existing compact installation.
Use whatever value you desire in the Installer Output File field and click the Create Installer button to create the new installation program.
3. Create a new subdirectory in your Deploy Directory for the new release and add the same files from the new release of the Arbortext Editor Deployment Kit that you used for the existing release.
For example, suppose your existing Deploy Directory contained the following directories and files:
site\
siteprefs.xml
custom.zip
7.0M030\
manifest.txt
java.cab
help_center_de.cab
help_center_en.cab
help_center_es.cab
help_center_fr.cab
help_center_it.cab
help_center_ja.cab
help_center_ko.cab
help_center_zh_CN.cab
help_center_zh_TW.cab
In this case, you would add a subdirectory for the major release that contains the exact same files from the new release of the Arbortext Editor Deployment Kit:
site\
siteprefs.xml
custom.zip
7.0M030\
manifest.txt
java.cab
help_center_de.cab
help_center_en.cab
help_center_es.cab
help_center_fr.cab
help_center_it.cab
help_center_ja.cab
help_center_ko.cab
help_center_zh_CN.cab
help_center_zh_TW.cab
7.1F000\
manifest.txt
java.cab
help_center_de.cab
help_center_en.cab
help_center_es.cab
help_center_fr.cab
help_center_it.cab
help_center_ja.cab
help_center_ko.cab
help_center_zh_CN.cab
help_center_zh_TW.cab
Note that you do not need to change the site directory in your Deploy Directory, as it will automatically be used by the upgraded Arbortext Editor.
4. Edit the manifest.txt file for the new directory and uncomment the appropriate .cab files.
5. Test the new installation program on a system that does not have the existing compact installation of Arbortext Editor.
Make sure the features and site customizations you expect are present in the upgraded version of Arbortext Editor.
6. Optionally, tell your users to uninstall the previous version of Arbortext Editor before installing the new release.
This is often a good practice when upgrading from one major release to another.
7. Distribute the new compact installation program to your users and tell them to download and execute it to upgrade Arbortext Editor to the new major release.
Note that your Deploy Directory now supports two releases of Arbortext Editor. If a user ran the compact installation application for the 7.0 M030 version of Arbortext Editor, then that version would be installed on their system. A Deploy Directory can support multiple versions of the compact installation application.
Once you are certain that no users at your site will need to install the previous version of Arbortext Editor, you can remove the directory for that version from your Deploy Directory.
Upgrading Using a New Deploy Directory
If you determine that your existing customizations do not work correctly with the new release, the best practice is to develop a new Deploy Directory for the new release that is independent of the old directory. Follow these steps to develop a compact installation program for the new release that uses a new Deploy Directory:
1. Download the release file for the new major release of the Arbortext Editor Deployment Kit from the PTC support site and unzip the contents to a directory on your system.
To download a release file, go to the PTC support site at
www.ptc.com/en/support and select
Download Software.
The zip file for the 64–bit version of the Arbortext Editor Deployment Kit is available when you select Arbortext Editor from the product list.
2. Determine the location of the new Deploy Directory for this release.
For example:
\\server\arbortext_deploy7.1
3. Modify your customizations as needed to support the new release and create a new custom.zip file for the new Deploy Directory.
4. Create a new Deploy Directory for the release in the new location.
For example, you could create a Deploy Directory containing the following directories and files:
site\
siteprefs.xml
custom.zip
7.1F000\
manifest.txt
java.cab
adapter_windchill.cab
help_center_de.cab
help_center_en.cab
help_center_es.cab
help_center_fr.cab
help_center_it.cab
help_center_ja.cab
help_center_ko.cab
help_center_zh_CN.cab
help_center_zh_TW.cab
5. Edit the manifest.txt file for the new directory and uncomment the appropriate .cab files.
6. Execute the create_installer.exe application from the new release’s deployment kit.
Enter the new Deploy Directory in the Deploy Directory field.
Use whatever value you desire in the Installer Output File field and click the Create Installer button to create the new installation program.
7. Test the new upgrade installation program on a system that does not have the existing compact installation of Arbortext Editor.
Make sure the features and site customizations you expect are present in the new version of Arbortext Editor.
8. Optionally, tell your users to uninstall the previous version of Arbortext Editor before installing the new release.
This is often a good practice when upgrading from one major release to another.
9. Distribute the new compact installation program to your users and tell them to download and execute it to upgrade Arbortext Editor to the new major release.
