Upgrading From Release 5.0.5 or Later to Release 6

The process to upgrade from release 5.0.5 and earlier to release 6 has changed considerably. With release 5.1.3 and before, you performed an in-place installation. Now, you install Java CAPS 6 into a new directory, export 5.1.3 and before Projects and Environments and then import them into release 6 using NetBeans IDE. There are two ways to export your old Projects and Environments and create an external file:

Use Enterprise Designer's export function
Use a command-line script

This topic provides instructions on how to successfully upgrade to release 6.

To Upgrade Using Enterprise Designer to Export Projects and Environments

Before You Begin

Before beginning the process of exporting Projects and Environments from prior releases of Java CAPS 5.1.0–5.1.3 or ICAN Suite 5.0.5, it is recommended that you acquaint yourself with the steps to complete the task in the appropriate eGate Integrator User's Guide.

Install Java CAPS 6.

See one of the following topics for instructions on how to complete an installation:
- Using the Java CAPS 6 Installation GUI
- Using the Java CAPS 6 Installation CLI
Tip –
Before beginning an installation, ensure that you are familiar with the contents of Planning for Java CAPS Installation.

Export a Project or Environment from releases 5.0.5 through 5.1.3 using Enterprise Designer and create an external file to import into Release 6.

Record the settings for your Projects and Environments before exporting them. You will need this information when you reset the properties.

Note –
You can also use a command-line script to create an external file. For instructions on how to perform this task using the command line, see To Upgrade Using the Command Line to Export Projects and Environments.

When exporting a Project, note that:
- The exported Project may have references to elements that are in other Projects. A list of such references is generated during the export process.
- Project deployment objects are not exported, because they have references to both Project and Environment elements that are not required at the Project level.
Tip –
You can also export Projects or Environments using the command line. For instructions on how to perform this task, see To Upgrade Using the Command Line to Export Projects and Environments.
1. From the Repository or Project context menu, select Export Project to display the Export Manager dialog.
  
  Note –
  If you do not have any existing Environments in your Repository, the Environment panes are empty.
2. Highlight the desired Project(s) and/or Environment(s) in the displayed lists.
3. Click the appropriate Arrow button to transfer the highlighted items to the Selected Projects or Selected Environments panes.
  
  Note –
  In this example we only selected a Project, so the Environment will not be mentioned in the remaining steps.
4. When the desired Project is listed in the Selected Projects pane, click Browse to display the Save As dialog.
  
  A file name has been created by adding the ZIP extension to the Project name.
  
  Note –
  You can change the export file name.
5. To enter the file name click Save As.
  
  The Export Manager dialog box reappears.
6. Select the export destination and then click Export to export the Project file.
  
  This process may take a few minutes. The Export Status message box appears after the file has been exported successfully.
7. To close the message box click OK.

Import the non-JBI based Project or Environment into NetBeans IDE.
1. Start NetBeans IDE.
2. On the menu bar, select Tools, CAPS Repository, and then Import Project.
3. When an Import Project warning tells you to save changes that are not saved or checked in, click No if you need to do this; otherwise, click Yes to continue with the process.
  
  The Import Manager dialog box appears.
4. To select the export ZIP file you created, in the From ZIP file field browse to the location of the ZIP file and select it.
5. If you want the Project to appear as top level in the Projects pane in NetBeans IDE, under the Destination Project field drop down list, select “As Top-Level.”
6. When you have made all your selections on the Import Manager dialog box, click Import.
7. When the Import Status message appears, click OK.
8. Wait until the Repository completes refreshing, then close the Import Manager dialog box.
  
  The Project appears under Projects in the left pane.

To Upgrade Using the Command Line to Export Projects and Environments

Before You Begin

You can export a Project, an Environment, or a Project and an Environment using a command-line script. Before beginning the process of exporting Projects and Environments from prior releases of Java CAPS 5.1.0–5.1.3 or ICAN Suite 5.0.5, it is recommended that you acquaint yourself with the steps to complete the task in the appropriate eGate Integrator User's Guide.

Location of Script File

JavaCAPS_install_dir\repository\util\exportProject.bat

JavaCAPS_install_dir/repository/util/exportProject.sh

Command Syntax

exportProject username password branch_name export_file project_name environment_name

where:

branch_name is the name of the Repository branch to contain the Project and/or Environment you are exporting.
export_file is the name and path for the archive file to contain the Project and/or Environment you are exporting.
project_name is the name of the Project you are exporting. You can export multiple Projects by listing them one after another, separated by a plus sign (+). If you do not export a Project, leave this parameter as an empty string ("").
environment_name is the name of the Environment you are exporting. You can export multiple Environments by listing them one after another, separated by a plus sign (+). If you do not export an Environment, leave this parameter as an empty string ("").

Note –
The project_name and environment_name variables assume that the objects reside in the same repository directory as the script file you are using.

Caution –
Project names should not include special characters such as a comma ( , ), single quote ( '), or double quote ( " ). If any of these characters are used, you must escape them when using the exportProject command-line tool.

Install Java CAPS 6.

See one of the following for instructions on how to complete an installation:
- Using the Java CAPS 6 Installation GUI
- Using the Java CAPS 6 Installation CLI
Tip –
Before beginning an installation, ensure that you are familiar with the contents of Planning for Java CAPS Installation.

Export a Project using the export script.
1. Open a command prompt.
2. Change the directory to JavaCAPS_install_dir\repository\util.
3. To save the Project myProject to the file c:\project1export.zip, enter exportProject username password JavaCAPS_install_dir\project1export.zip myProject “ “.

Import the non-JBI based Project or Environment into NetBeans IDE.
1. Start NetBeans IDE.
2. On the menu bar, select Tools, CAPS Repository, and then Import Project.
3. When an Import Project warning tells you to save changes that are not saved or checked in, click No if you need to do this; otherwise, click Yes to continue with the process.
  
  The Import Manager dialog box appears.
4. To select the export ZIP file you created, in the From ZIP file field browse to the location of the ZIP file and select it.
5. If you want the Project to appear as top level in the Projects pane in NetBeans IDE, under the Destination Project field drop down list, select “As Top-Level.”
6. When you have made all your selections on the Import Manager dialog box, click Import.
7. When the Import Status message appears, click OK.
8. Wait until the Repository completes refreshing, then close the Import Manager dialog box.
  
  The Project appears under Projects in the left pane.

Previous: Overview of Upgrading to Java CAPS 6