Upgrading to Java CAPS 6.2

Previous: Book Information

Upgrading to Java CAPS 6.2

The topics listed here provide information about upgrading to the Java^TM Composite Application Platform Suite (Java CAPS) Release 6.2. If you have any questions or problems, see the Java CAPS Support web site at http://goldstar.stc.com/support.

To access all the Java CAPS documentation in PDF and HTML format, go to http://docs.sun.com/app/docs/prod/sj.caps?a=view.

What You Need to Know

Overview of Upgrading to Java CAPS 6.2

What You Need to Do

Reference Material

Overview of Upgrading to Java CAPS 6.2

The process of upgrading from 5.x releases to 6.x releases is different from the previous upgrading process. Beginning with Release 6, you no longer perform an in-place installation. Instead, install Java CAPS 6.x in a new directory, and then import your Projects from previous releases.

Here are the basic steps for upgrading from 5.x releases of Java CAPS to release 6.2:

Install Java CAPS in a new directory
Export your Projects and Environments from an earlier release of Java CAPS 5.1.0–5.1.3 or Integrated Composite Application Network Suite (ICAN Suite) 5.0.5
Import your Projects and Environments into release 6.2 using the NetBeans^TM IDE Import Manager
Update your runtime components, and then build and deploy the Projects

To upgrade from 6x releases of Java CAPS, you can either perform the above steps, or you can upgrade the existing Repository and use it with the new Java CAPS 6.2 installation. Performing the upgrade in this way, you do not need to export and import any Projects; you will just continue to use the existing Repository.

Note –

Components from 5.x versions of Java CAPS or ICAN are not compatible with Release 6.2 components. For example, you cannot use a 5.1.3 Enterprise Designer to connect to a Release 6.2 Repository or vice versa.

Perform the procedure below related to the version from which you are upgrading:

Upgrading From Release 5.0.5 - 5.1.3 to Release 6.2

The process to upgrade from release 5.0.5 and earlier to release 6.2 has changed considerably. With release 5.1.3 and earlier, you performed an in-place installation. Now, you install Java CAPS 6.2 into a new directory, export 5.1.3 and earlier Projects and Environments and then import them into release 6.2 using the 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

Perform the following steps to upgrade from a 5.x release of Java CAPS to release 6.2.

Tip –

These steps include installing Java CAPS. See one of the following topics for complete instructions on how to install:

Before beginning an installation, ensure that you are familiar with the contents of Planning for Java CAPS Installation .

Note that a default Java CAPS installation does not install the complete set of products that were installed in previous versions. You might need to manually install some additional components, such as Adapters or other add-ons.

Exporting and Importing Projects and Environments

Perform one of the following procedures to export existing Projects and import them into the new Java CAPS environment.

Tip –

When exporting a Project, note the following:

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 profiles are not exported, because they have references to both Project and Environment elements that are not required at the Project level.

To Use 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.2.

See the notes under Upgrading From Release 5.0.5 - 5.1.3 to Release 6.2 for links to more information.

If you are using any components that are not included in the default installation, reinstall them now.

This includes certain adapters and add-ons, certain core components like Sun Master Index, and so on.

Tip –
You can view a list of installed products for Java CAPS 6.2 on the Suite Uploader, which can be accessed from a web browser if the Repository is started. The URL is http://host-name:port-number.. The default port number is 12000.

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.2.

Record the settings for your Projects and Environments before exporting them. You will need this information when you reset the properties.
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 Projects or Environments in the displayed lists.
3. Click the appropriate Arrow button to transfer the highlighted items to the Selected Projects or Selected Environments panes.
4. When the desired Project appears in the Selected Projects pane, click Browse.
  
  The Save As dialog box appears. A file name is already defined 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 Java CAPS Project or Environment into the NetBeans IDE.
1. Start the NetBeans IDE.
2. On the menu bar, select Tools, point to CAPS Repository, and then select Import Project.
  
  A warning dialog box appears with a reminder to save any unsaved changes.
3. Click No if you need to save or check in any changes; otherwise, click Yes to continue with the process.
  
  The Import Manager dialog box appears.
4. In the From ZIP file field, browse to the location of the export ZIP file you created and then select the file.
5. If you want the Project to appear as top level in the Projects pane in the NetBeans IDE, select As Top-Level under the Destination Project field drop down list.
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, and then close the Import Manager dialog box.
  
  The Project appears in the Projects Window.

To Use a 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 or Environment you are exporting.
export_file is the name and path for the archive file to contain the Project 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 the notes under Upgrading From Release 5.0.5 - 5.1.3 to Release 6.2 for links to more information.

If you are using any components that are not included in the default installation, reinstall them now.

This includes certain adapters and add-ons, certain core components like Sun Master Index, and so on.

Tip –
You can view a list of installed products for Java CAPS 6.2 on the Suite Uploader, which can be accessed from a web browser if the Repository is started. The URL is http://host-name:port-number.. The default port number is 12000.

Export a Project using the export script.
1. Open a command prompt.
2. Navigate to JavaCAPS_install_dir\repository\util.
3. Enter the following command:
  
  exportProject username password branch_name export_file project_name environment_name
  
  For example, to save the Project myProject to the file c:\project1export.zip with the default login, the command would be similar to the following:
  
  exportProject admin adminadmin C:\JavaCAPS5\project1export.zip myProject.

Import the Java CAPS Project or Environment into the NetBeans IDE.
1. Start the NetBeans IDE.
2. On the menu bar, select Tools, point to CAPS Repository, and then select Import Project.
  
  A warning dialog box appears with a reminder to save any unsaved changes.
3. Click No if you need to save or check in any changes; otherwise, click Yes to continue with the process.
  
  The Import Manager dialog box appears.
4. In the From ZIP file field, browse to the location of the export ZIP file you created and then select the file.
5. If you want the Project to appear as top level in the Projects pane in the NetBeans IDE, select As Top-Level under the Destination Project field drop down list.
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, and then close the Import Manager dialog box.
  
  The Project appears in the Projects Window.

Continue to Completing the Upgrade From Java CAPS 5.x.

Completing the Upgrade From Java CAPS 5.x

Once you have imported all previous Projects and Environment into Java CAPS 6.2, you need to redeploy and in some cases reconfigure the Projects.

To Complete the Upgrade

Complete the steps under Exporting and Importing Projects and Environments.

Recreate any connection pools using the GlassFish Admin Console.

Redefine any required security attributes using the GlassFish Admin Console.

Reinstall the required plugins in Enterprise Manager.

If you are migrating a JMS-based Project and are using the same Environment as before, you need to update the JMS URL defined in the Environment. The new default URL is stcms://localhost:18007.

Build and deploy all migrated Projects.

Upgrading From Release 6 or R6U1 to Release 6.2

You can upgrade from previous release 6 versions by using the import and export method described in Upgrading From Release 5.0.5 - 5.1.3 to Release 6.2, or you can perform side-by-side upgrade that allows you to continue to use your existing Repository by applying a patch to update the components. When you have completed the side-by-side upgrade, you will have two Java CAPS environments and will use the Java CAPS 6.2 components to connect to your Repository from the previous environment.

To upgrade from an earlier Release 6 version, perform the following steps:

Upgrading the Repository (side-by-side method) OR Upgrading From Release 5.0.5 - 5.1.3 to Release 6.2 (export and import method)
Completing the Upgrade From Java CAPS 6.x

Upgrading the Repository

This topic describes the side-by-side method of upgrading the Repository. In addition to installing the laster version of Java CAPS, you will also install a patch to the previous version's Repository so you can continue using it in the new Java CAPS installation.

Tip –

See one of the following topics for complete instructions on how to install Java CAPS:

Before beginning an installation, ensure that you are familiar with the contents of Planning for Java CAPS Installation .

To Upgrade the Repository

Perform a complete backup of your existing Java CAPS Repository, domains, and the caps-patch directory.

Install Java CAPS 6.2 in a separate directory with the following guidelines:
- Use the same Repository name for the new Repository as for the existing Repository that you are upgrading.
- Use the same port numbers for the new installation as you did for the existing Java CAPS environment.

Rename the new Repository to repository_62.

Copy the caps-patch directory from the Java CAPS 6.2 environment into the existing Java CAPS directory.

Note –
This step will replace the caps-patch directory in the old Java CAPS environment.

Copy the file named patches_ml.zip from the patches directory of your installation media to a temporary local directory.

Extract the ZIP file to the temporary directory (maintaining the directory structure).

Navigate to TempDir/patches_ml/patches/.

You should see a file name 6836560-01-REP.zip.

Install the Repository patch by running the following command. Use the caps-patch-install command from the old Repository's caps-patch/util/bin directory.

caps–patch–install –verbose -repuser user -reppwd pasword –patch temp-dir/6836560–01–REP.zip

where temp-dir is the location where you copied 6836560-01-REP.zip.

Note –
The patch installer takes additional optional parameters. For more information about the syntax, see Java CAPS 6 Patch Management Tools in Installing Patches for Java CAPS.

This updates the Repository in the older Java CAPS environment.

If you are using LDAP prefixes, open the file JavaCAPSHome/repository/repository/startserver.bat (or startserver.sh), where JavaCAPSHome is the Java CAPS R6 or R6U1 home directory. Add the following to the JAVA_OPTS section of the file:

-Dorg.apache.catalina.realm.JNDIRealm.ROLE_PREFIX=prefix

where prefix is the full LDAP prefix to use; for example, com.sun.java.

Note –
LDAP prefixes are a new features of the LDAP Adapter in this release. Prefixes are similar to suffixes, except they are prepended instead of appended to a user or group name to form the distinguished name (DN).

Start the Repository you just updated (in the old Java CAPS environment) and launch the Java CAPS 6.2 NetBeans IDE.

Connect to the updated Repository from the NetBeans IDE.

You might need to modify the Repository connection information and CAPS Project location to connect to the correct Repository.

Open the existing Repository-based Projects in the Projects window to verify that you are connecting correctly to the updated Repository.

Continue to Completing the Upgrade From Java CAPS 6.x.

Completing the Upgrade From Java CAPS 6.x

Once you have imported all previous Projects and Environment into Java CAPS 6.2 or have updated the previous Repository, you need to redeploy and in some cases reconfigure the Projects. Runtime components need to be recreated as well.

To Complete the Upgrade

Complete the steps under Upgrading the Repository.

Recreate any runtime artifacts using the GlassFish Admin Console for Java CAPS 6.2.

This could include any connection pools, security attributes, application configurations, application variables, and so on.

Reinstall the required plugins in Enterprise Manager.

Open any JBI Projects in NetBeans Project window.

Build and deploy all Repository and JBI Projects to the new GlassFish server installed with Java CAPS 6.2.

Previous: Book Information