Installing and setting up the beta release

This document explains how to install, set up, and configure the IBM® Rational® Collaborative Architecture Management. This document also explains how to import model content onto the IBM Rational Collaborative Architecture Management model server.

Before you begin, you may want to review this section for an overview of the installation and configuration process: Installation, setup, and configuration process overview.

Table of Contents

Installation, setup, and configuration process overview

Use the following steps to help you understand the entire installation, setup, and configuration process. Each step contains a link to additional information located elsewhere in this document.
  1. Before you install this version of the IBM Rational Collaborative Architecture Management beta, you must uninstall any previous installations of the IBM Rational Collaborative Architecture Management or Rational Architecture Review betas. For details, refer to this section: IBM Rational Collaborative Architecture Management.
  2. To gain an understanding of the various components of the beta, take a look at this section: IBM Rational Collaborative Architecture Management. Before you start the installation process, look at the Installation Prerequisites and other products you that you can use to create links between resources: Optional installations.
  3. Download and extract the beta installation files, install them, and then setup and configure the model server so you can host model content on the web. For details, see Downloading and extracting the beta files and Installing the IBM Rational Collaborative Architecture Management components.
  4. After you have installed, setup, and configured your environment, you can modify the sample project if you created it during the configuration process, or you can log onto the server and create a new project that will contain model resources. For details, see Modifying the Sample Project and Creating a new project area.
  5. Once you setup a project area, you can import model resources onto the server. But first, you need to configure the import engine, start it up, and then create an import definition. After you configure the import engine, you can request and import to load Rational Software Architect models onto the server using the instructions in this topic: Importing Rational Software Architect models to the model server.
  6. After your model resources are imported onto the server, you can view them on the Web: Viewing models through the web user interface.

IBM Rational Collaborative Architecture Management components

The IBM Rational Collaborative Architecture Management has the following main components:
Software component Description
IBM Installation Manager, WS_Beta Use IBM Installation Manager WS_Beta to install all of the beta components. Using the IBM Installation Manager, you can install the model server on a machine that can serve data, the collaboration client on any client desktop that has Rational Software Architect 8.0 or higher installed, and the import engine on a computer (or more than one computer) that has access to the model content you want to import.
IBM Rational Collaborative Architecture Management Model Server This Jazz-based server hosts Rational Software Architect models so your team can add comments to models and mark up diagrams for collaboration purposes.
Rational Software Architect Import Engine This utility imports Rational Software Architect model content onto the model server. The Import Engine must be installed and configured on any computer that contains Rational Software Architect models that you want to import onto the model server.
Rational Software Architect Collaboration client This Rational Software Architect 8.0 extension allows you to access the search, commenting, markup, and other services that the model server supports within Rational Software Architect. This extension adds a Team Modeling view, a Comments view, and provides additional fields that allow you to search a model repository.

You may install the Rational Software Architect Collaboration client on multiple computers that have Rational Software Architect v8.0 or higher installed.

Rational Software Architect, version 8.0 (or 8.0.1).
Important: Rational Software Architect is not included in the beta installation package. If you do not have Rational Software Architect version 8.0, you can download and install the trial version using the following link: http://www14.software.ibm.com/webapp/download/search.jsp?pn=Rational+Software+Architect

Installation Prerequisites

Before you install the IBM Rational Collaborative Architecture Management files, review the following installation prerequisites.

Optional installations

If you want to explore resource linking between IBM Rational Collaborative Architecture Management and other Jazz-based products such as Rational Requirements Composer, Rational Team Concert, or Rational Quality Manager, you can download those products from jazz.net using the links provided below. Installation and configuration instructions for these products are located on jazz.net.
Optional installation Download location
Rational Requirements Composer 3.0 https://jazz.net/downloads/rational-requirements-composer/.
Rational Team Concert™ 3.0 https://jazz.net/downloads/rational-team-concert/
Rational Quality Manager 3.0 https://jazz.net/downloads/rational-quality-manager/
Simple Mail Transport Protocol (SMTP) server If you want to explore e-mail notifications when someone enters a comment on a resource, you must have an SMTP server available.

Downloading and extracting the beta files

About this task

Procedure

  1. Go to the following location: https://www14.software.ibm.com/webapp/iwm/web/preLogin.do?source=swerpratl-rarb-3
  2. Enter your IBM ID and Password; then click Sign in.
  3. If you agree to the license agreement, click I agree, and then click I confirm.
  4. Using the Download Director or HTTP, download the following files:
    Beta File File Description

    RSA_CAM_Server_Setup.offering-Beta4.disk1.zip (196 MB)

    Rational Software Architect V8.0 Beta 4 Server Set up
    CAM_Server.offering-Beta4.disk1.zip (629 MB) IBM Rational Collaborative Architecture Management Server - Disk 1
    CAM_Server.offering-Beta4.disk2.zip (465 MB) IBM Rational Collaborative Architecture Management Server - Disk 2
    RSA_CAM_Server.offering-Beta4.disk1.zip (56 MB) IBM Rational Software Architect extension for Collaborative Architecture Management server
    (Optional) RSA_CAM_Client.offering-Beta4.disk1.zip (10 MB) IBM Rational Collaborative Architecture Management Client extension for Rational Software Architect
    RSA_CAM_ImportEngine.offering-Beta4.disk1.zip (254 MB) IBM Rational Software Architect import engine for Collaborative Architecture Management Server
  5. After you download all of the files, extract them to the same directory on your computer. After you extract all compressed files, you should have the following installation directories, keeping in mind that the COLCLIENT (IBM Rational Collaborative Architecture Management Client extension for Rational Software Architect) is optional.
    • RCAM_SETUP
    • RSAS
    • RSAImportEngine
    • NorvoServer
    • COLCLIENT

Installing the IBM Rational Collaborative Architecture Management components

Download the IBM Rational Collaborative Architecture Management 3.0 components and use the IBM Installation Manager WS_Beta to install files on your computer.

Before you begin

Ensure that you have extracted all beta files to the same location; after extraction, you should have a directory named RSAS_SETUP.

Procedure

  1. Log onto your computer or local area server as a user with administrator permissions.
  2. Go to the RCAM_SETUP directory and run launchpad.exe file.
  3. Once the Launchpad opens, click Install Server under Server. The IBM Installation Manager WS_Beta installation process begins. IBM Rational Collaborative Architecture Management uses this specific version of IBM Installation Manager (named, IBM Installation Manager WS_Beta) to install all beta components.
    Note: You may need to clear all of the check boxes except for the IBM Installation Manager 1.4.1 (Beta=WS_Beta) check box to get started.
    1. On the Install Packages page, click Next to begin to install IBM Installation Manager WS_Beta 1.4.1.
    2. If you agree to the license agreement, click I accept the terms in the license agreements and then click Next.
    3. On the Install Packages page, click Next to accept the default Installation Manager Directory and then click Install to install IBM Installation Manager WS_Beta 1.4.1. After the installation process is complete, click Restart Installation Manager.
  4. Using IBM Installation manager (Beta=WS_Beta), step through the various IBM Installation Manager WS_Beta pages and install all of the following IBM Rational Collaborative Architecture Management components (install packages):
    • IBM Rational Collaborative Architecture Management Server
    • IBM Rational Collaborative Architecture extension for Collaborative Architecture Management server
    • IBM Rational Software Architect model import engine for Collaborative Architecture Management server
    • (Optional) IBM Rational Collaborative Architecture Management client extension for Rational Software Architect
      Note: To install the client extension for Rational Software Architect, you must install Rational Software Architect 8.0.0 or 8.0.1 before the collaboration client.
    Important: You must select and install all of the Install Packages. If you do not install IBM Rational Collaborative Architecture extension for Collaborative Architecture Management server or IBM Rational Software Architect model import engine for Collaborative Architecture Management server, there will be no way to import and view a model on the server.
  5. For each IBM Rational Collaborative Architecture Management component you install, you must review and accept the license agreement and click Next.
  6. Accept the default installation directory, or enter a different location. Click Next until the Install button is active; then click Install.
  7. Press Finish to complete the installation. Close the launchpad.
    Note: If you have multiple computers that contain Rational Software Architect model content that you want to import onto the model server, you must install the Rational Software Architect import engine on each of those computers. The same is true if you want to use the Collaboration Client extension for Rational Software Architect on multiple computers.

Setting up and configuring the IBM Rational Collaborative Architecture Management 3.0 Server

You can configure the IBM Rational Collaborative Architecture Management 3.0 Server. After you finish the configuration process, you can add user accounts to the sample project that you create during the setup process. After the project is set up, you can configure the import engine so you can import Rational Software Architect models onto the model server.

Before you begin

Prerequisite: Before you configure the server, you must install IBM Rational Collaborative Architecture Management server.
Prerequisite: Before you configure the server, you must enable pop-ups to avoid installation problems during the setup and configuration process.
Restriction: When you go through the setup and configuration wizard, make sure you do not refresh the browser or use the front and back buttons.

Procedure

  1. To start the server, click Start > All Programs > Rational Collaborative Architecture Management > Start Jazz Team Server. The Tomcat command window opens. Wait for the message INFO: Server startup in # ms. This step may take a while to complete the first time you start the server; on subsequent restarts, the server starts much faster.
    Tip: You can also start the server by typing JazzInstallDir/server/server.startup at the command line, where JazzInstallDir is the root directory in which the Jazz Team Server is installed.
  2. In a web browser, go to: https://[fully qualified hostname]:9443/jts/setup. This step may take a while to complete the first time you access the server setup.
    Note:

    A [fully qualified hostname] is the host name and the DNS domain reference of the computer on which the Jazz Team Server is installed.

    An example of a good fully qualified host name is rcamweb.example.com.

    Examples of a bad fully qualified host name include the local host and an IP address.

  3. On the Jazz Team Server login page, enter ADMIN (case sensitive) in both the User ID and Password fields, and then click Log In.
  4. On the Introduction page, click Next.
  5. On the Configure Public URI page, provide a public URI in the following format: https://[fully qualified hostname]:9443/jts. Click Test Connection and, after the test is successful, click Next.
    Tip: If you have another Jazz-based product installed on the server, to avoid port number collision, you should change the default port number now from 9443 to some other number such as 29443.
    Remember: The [fully qualified hostname] is the host name and the DNS domain reference of the computer on which the Jazz Team Server is installed.
  6. On the Configure Database page, accept the default settings and click Next.
    Note: If you change the default values or set values for an enterprise database such as DB2, Oracle, or SQL Server, click Test Connection to ensure that the connection is configured correctly.
  7. On the Enable E-mail Notification page, enable or disable email notification. If you enable notifications, you must provide information about the email server and test the connection. After your selection, click Next.
  8. On the Setup User Registry page, provide the following information.
    1. Select the type of user registry to use. For this beta program, you may want to accept I the default of Tomcat User Database.
      Note: If you select an LDAP user registry, you must provide information to configure the connection between the Jazz Team Server and the LDAP server.
    2. Provide the user ID, name, password, and email address of the user who has administrative user access to the Jazz Team Server. For this beta, consider using RCAM_Admin for the user ID, name, and password.
    3. For security reasons, you may want to disable the ADMIN user.
    4. Assign the Collaborative Architecture Management - Collaborator license to the new RCAM_Admin account, and then click Next.
  9. On the Register Applications page, the wizard detects the applications that are installed. The Jazz Team Server and Application Setup wizard automatically finds the /rmps application and populates the Application Instance, Discovery URL, and the Functional User ID fields. For this beta, accept the default settings and click Register Applications. The wizard creates a new user (named RCAM_Admin) and implements two additional wizard steps to set up IBM Rational Collaborative Architecture Management.
  10. After the application is registered, click Next.
  11. On the Finalize Application page, click Finalize Application.
    Important: After you click Finalize Application, the wizard progresses automatically; however, a window might open and close, which is a known issue during authentication. If some of the steps fail, you might need to enable pop-ups on your server. If this problem occurs, enable pop-ups, return to the setup wizard, and click the Finalize Application again. When you click this button a second time, the configuration should be successful.
  12. After the application is finalized, click Next, but do not click Finish even though the button is enabled. The wizard advances to a page where you create a sample project. Creating a sample project is optional, but can help you get started quickly. The wizard automatically creates a user named sample_user that has a license to view and comment on model resources, as well as a project named Sample Project that contains the basic process template that gives all users all permissions. The wizard also adds the sample_user member to the sample project.
  13. On the Create Sample Project page, click Create Sample Project and click Next. A user named sample_user and a project named Sample Project are created.
    Important: When you create the sample project through the setup and configuration wizard, a process template named Basic is applied to the project. The Basic process template is the easy to work with because it does not define any roles and allows every user to do anything in the application. If you want to explore permissions and roles, after the server is setup and configured, consider creating another project and apply a process template named Default to the project. The process template named Default is more strict and is helpful when you want to control permissions at a granular level.
  14. On the Summary page, review the setup details for the Jazz Team Server.
    Important: At this point in the wizard, you have successfully completed the setup and the application is ready to use even though you have not clicked Finish in the wizard; this is a known issue. If you do click Finish, the wizard simply redirects you to https://[fully qualified hostname]:9443/jts/admin where you can administer your project by adding user accounts and specifying roles and permissions.
  15. To help you get started with your project, on the Summary page, click 1. Create Users or 2. Administer the Server. These links provide direct access to areas within the application that allow you to populate your project with user accounts or modify server settings. However, after you click either of these two pages, you are not able to navigate back to setup and configuration wizard.

Modifying the Sample Project

After you install and configure the server, as well as create the Sample Project during the configuration process, you can modify the Sample Project project area. If you did not create the sample project area, you can create a new project.

Before you begin

To modify the Sample Project that was automatically created using the setup and configuration wizard, go to the following URL substituting the fully qualified hostname with the fully qualified hostname of your server: https://[fully qualified hostname]:9443/jts/admin. Log in using the RCAM_Admin/RCAM_Admin user account. Then, click the down arrow located next to the house icon in the upper-left corner of the UI, and select Jazz Team Server Home. The Welcome to the Jazz Team Server Administration Home page opens.

About this task

To modify the Sample Project:

Procedure

  1. On the Welcome to the Jazz Team Server Administration Home page, click Jazz Team Server - User Administration.
  2. On the Active Users page, click the Create User.
  3. Enter a user name, user ID, and email address; grant the user a Collaborative Architecture Management - Collaborator license as well as JazzUsers under Repository Permissions.
  4. Click Save and repeat these steps if you want to add additional user accounts.
  5. On the Welcome to the Jazz Team Server Administration Home page, click /rmps - Project Areas.
    Tip: You can also access this area by using the following URL substituting the fully qualified hostname with fully qualified hostname of your server: https://[fully qualified hostname]:9443/rmps/admin.
  6. On the Active Project Areas page, click the Sample Project name to open and edit the project area; this sample project was created in the setup and configuration wizard.
  7. Under the Members section, click Add to update the Sample Project with members (also known as user accounts) you created in step 2. You can also add user accounts with Administrator permissions.
  8. Explore the options on the various tabs (Timelines, Roles, Permissions, and so on) and edit the settings according to the needs of your project.
  9. Click Save to retain any settings you changed.

Creating a new project area

After you install and configure the server, you can create a new project area. If you didn't create the Sample Project during the setup and configuration process, you need to create a new project to store model content on the model server.

Before you begin

To create a new project area, go to the following URL substituting the fully qualified hostname with the fully qualified hostname of your server: https://[fully qualified hostname]:9443/jts/admin. Log in using the RCAM_Admin/RCAM_Admin user account. Then, click the down arrow located next to the house icon in the upper-left corner of the UI, and select Jazz Team Server Home. The Welcome to the Jazz Team Server Administration Home page opens.

About this task

To create a new project area:

Procedure

  1. On the Active Project Areas page, click Create Project Area.
  2. Enter a project name, summary, and description.
  3. Select one of the following available processes:
    • Basic Process Template - Use this process template to if you do not want to adhere to any project roles or permissions; this process template allows every user account to do anything within the /rmps application. For example, any user account can edit and delete comments that other users have created, and any user can view and comment on models and participate in reviews. Any user can import models onto the server and make changes to project areas and dashboards.
    • Default Process Template - Use this process template if you want to test roles and permissions. The default template contains four defined roles:
      Defined Role Description
      Architect An architect can view and comment on models, and create and participate in reviews.
      Commenter A commenter can view and comment on models and participate in reviews.
      Publisher A publisher can create import definitions and import models to the server.
      Project Lead A project lead can make changes to project areas and dashboards, and delete comments and reviews.
  4. Add members and administrators to the project, and then click Save. After you create the project area, you can add user accounts to the project.

Importing Rational Software Architect models to the model server

Before you can view Rational Software Architect models and diagrams on the Web, you must import model data to the model server by using the Rational Software Architect import engine. Importing model data is not a one-time action; you must re-import model data each time that you want changes made in your local workspace to be visible on the model server. You can also schedule imports so they occur automatically on a regular basis. In addition, you can write ANT scripts so you can pull model content directly from your source control management system to the model server.

About this task

The import engine is a small application which can run on any machine on the network, but will typically be set up on a machine which is able to serve model data (be able to check out data from a configuration management system). The import engine must have read-only file system access to the relevant directories.

You must install the import engine on any computer that contains the model data you want to place on the model server; however, this computer does not need to be the same computer that hosts the model server.

There are four parts to importing model data to the model server:

  1. Configuring the import engine (Part 1)
  2. Starting the import engine (Part 2)
  3. Creating an import definition (Part 3)
  4. Requesting an import (Part 4)

To view general guidelines on how you can write ANT scripts to pull model data from your source control management (SCM) system to the IBM Rational Collaborative Architecture Management model server, see this topic: (Optional) Reference: Using ANT scripts to pull model content onto the server

Configuring the import engine (Part 1)

Before you start the import engine, you must set it up correctly. Configuring the import engine typically only has to be done one time on a per-computer basis. For example, if your team has five separate computers that contain Rational Software Architect model content that should be placed on the model server, your team must configure the import engine on each of the individual computers.

Before you begin

Before you begin to configure the import engine, you must make sure the Jazz™ Team Server that you plan on importing models to has been started. To start the server, click Start > All Programs > Rational Collaborative Architecture Management > Start Jazz Team Server. The Tomcat command window opens. Wait for the message INFO: Server startup in # ms. This step may take a while to complete the first time you start the server; however, on subsequent restarts, the server starts much faster.

About this task

To configure the import engine:

Procedure

  1. Click Start > Programs > IBM Rational Software Architect Import Engine > Configure import engine. The Rational Software Architect Import Engine opens.
  2. In the Front Server URL field, enter the fully-qualified host name of the IBM Rational Collaborative Architecture Management server URL such as https://[fully qualified hostname]:9443/rmps; the front server URL must point to the computer that hosts imported model content.
  3. Enter the appropriate credentials for the Jazz User Account and Jazz User Password. You might consider creating an administrator or functional user that is responsible for placing model content onto the server.
    Note: The required jazz user id and password can be any user on Jazz which has at least a JazzGuest permission. This user account can also have JazzUser, JazzAdmin permissions, but it must have the Collaborative Architecture Management - Collaborator license.
  4. In the Import Engine Name field, enter a name (RCAM_Import_Def) that symbolically represents the computer on which the import engine runs; many import definitions may use the same import engine name. All import engine names are unique and case-sensitive. Remember the import engine name because you need it later when you import model content to the server.
  5. In the Eclipse Installation Directory field, ensure that the directory path points to the default Import Engine installation directory of C:/Program Files/IBM/RSAImportEngine. This default installation directory allows you to import workspaces from standard Eclipse installations (Eclipse installations that use CVS or no source control management system at all). However, if you have model content that resides in a Rational Team Concert-based workspace, or in a workspace tied to any other software configuration management (SCM) system which requires special support beyond standard Eclipse, you must specify a value in the Eclipse Installation Directory field that points to the Rational Team Concert Eclipse client installation location or the installation directory of any other SCM system used.
    Important: If your workspace has multiple projects that each contain modeling elements, and a subset of those projects reside under Rational Team Concert source control, you must ensure that the Eclipse Installation Directory field points to your Rational Software Architect with Rational Team Concert installation location. Otherwise, if you just specify the default location of the import engine (C:\IBM\RSAImportEngine), after import, you'll only be able to view model content that was not under source control. Rational Team Concert stores projects in a different way that standard Eclipse cannot discover.
    Important: If you have model data that is stored in a configuration management system such as IBM Rational ClearCase or IBM Rational Team Concert, refer to the following topic that provides general guidance on how use ANT scripts to pull models from your configuration management system and place the content onto the model server: (Optional) Reference: Using ANT scripts to pull model content onto the server
  6. Test the configuration by clicking Test Configuration. Before you test the connection, ensure the IBM Rational Collaborative Architecture Management server is running. The test and configuration may take several minutes to complete.
  7. Click Save and Exit.

Results

After you configure the import engine, you must start it. The import engine is a background process that runs until you request the engine to stop. You can start the import engine by clicking Start > IBM Rational Software Architect Import Engine > Start import engine. There is also an option to stop the import engine located off the Start menu.

Starting the import engine (Part 2)

About this task

After you have configured the import engine, you must start it.
  • Click Start > All Programs > IBM Rational Software Architect Import Engine > Start import engine. The Rational Software Architect Import Engine starts.. If you try to start the import engine when it is already running, an information message appears stating that the import engine is already running.

Creating an import definition (Part 3)

After you have configured and started the import engine, you must create an import definition on the model server that specifies all of the model content you want to import to the IBM Rational Collaborative Architecture Management server.

About this task

You have two different options that reflect the way you can define the model content that you want to place on the model server:
  • Import all the model data from an Eclipse workspace. This mode uses an installed version of Eclipse to access the workspace. This option allows you to do an exact one-to-one mapping or import of the local workspace; every model contained within the workspace is placed onto the model server. This option provides a way to get all content onto the model server quickly.
  • Import individual projects from one or more Eclipse workspaces. This mode uses the file system and does not require an Eclipse installation unless you want to use Ant scripts. This option allows you to customize and define individual projects that you want to place onto the model server. Using this option, you can pull projects from different Eclipse workspaces; you can also pull specific projects from the same Eclipse workspace, rather than all content when you use the first option. For details on working with ANT scripts, see (Optional) Reference: Using ANT scripts to pull model content onto the server.
Important: Once an import definition has been created, the mode cannot be changed until the import definition is deleted. When you delete an import definition, all associated model data for the project is also deleted. To delete an import definition (and associated model data), click Delete Import Definition and Data on the Import Definition page.
To create an import definition using the first mode (by specifying an Eclipse workspace path):

Procedure

  1. On the model server, click Rational Software Architect Import (located next to the Models drop down menu), and then click Import Definition; the Import Definition page opens.
  2. On the Import Definition page, select one of the following two options, and complete the substeps below each option:
    • Import all the model data from an Eclipse workspace. This mode uses an installed version of Eclipse to access the workspace.
      1. In the Import Engine field, enter the same Import Engine ID that you created when you configured the import engine RCAM_Import_Def).
      2. Click Test to make sure the Import Engine has started and the connection is valid.
      3. (Optional) In the Ant Script Path, enter the location of your Ant script. For more details on using ANT scripts, refer to this topic (Optional) Reference: Using ANT scripts to pull model content onto the server.
      4. In Eclipse Workspace Path, enter the path to your local Eclipse workspace(s) folder that contains the model content you want to import onto the model server. The Eclipse Workspace Path should point to a local computer (not to the IBM Rational Collaborative Architecture Management server) that contains the Rational Software Architect models; this computer must also have the import engine installed, configured, and running. When you provide this filepath, you are configuring the import engine to go to a specific workspace and put all the model contents into a project on the IBM Rational Collaborative Architecture Management server.
      5. (Optional) In the Path Maps section, specify the pathmap variables which you may have used in your own workspace. Remember, the server has no file system, so the value of a pathmap has to be relative to the workspace path itself.
    • If you select Import individual projects from one or more Eclipse workspaces. This mode uses the file system and does not require an Eclipse installation unless you want to use Ant scripts, go to step
      1. In the Import Engine field, enter the same Import Engine ID that you created when you configured the import engine RCAM_Import_Def).
      2. Click Test to make sure the Import Engine has started and the connection is valid.
      3. (Optional) In the Ant Script Path, enter the location of your Ant script. For more details on using ANT scripts, refer to this topic (Optional) Reference: Using ANT scripts to pull model content onto the server.
      4. Under Projects, enter the paths to the individual projects within Eclipse workspaces on the computer that contains the model content you want to import. To add a project, click Add on the Projects section.
      5. Enter the names of the projects that you want to import.
      6. (Optional) In the Path Maps section, specify the pathmap variables which you may have used in your own workspace. Remember, the server has no file system, so the value of a pathmap has to be relative to the workspace path itself.
  3. (Optional) In the Schedule section, click Automatically request an import using this schedule and specify how often you want the Import Engine to check for model updates. You can also schedule a snapshot after import so you have an exact view of the project at a specific point in time.
  4. Click Save to retain all of your import definition updates.

Requesting an import (Part 4)

Once you have created an import definition, you can request an import to load model content onto the IBM Rational Collaborative Architecture Management server.

Procedure

  1. On the model server, click Rational Software Architect Import (located next to the Models drop down menu), and then click Request Import; the Request Import page opens.
  2. Select any of the following options:
    • Validate model contents - runs the import and validates the contents
    • Reimport and overwrite all resources - starts the entire import process again, which may take a long time to complete. If you clear this check box, only model resources that have changed are imported onto the model server.
    • Create snapshot of the entire project after import completes - creates a snapshot after import so you have an exact view of the project at a specific point in time.
  3. Click Request Import, located in the upper-right corner of the page. The import process begins, and a link to the Import Status page appears. On the Import Status page, you can view the progress of the import.
    Important: The import process can take a long time to complete based on the size of the model content you are importing onto the model server. Small models are quick, while model content that are many MB in size may take hours to complete.
  4. After the import completes, navigate to the Models tab to explore the resources and model content that were just imported.

(Optional) Reference: Using ANT scripts to pull model content onto the server

You can use ANT scripts to connect to your configuration management system with the model server.

About this task

Using custom ANT scripts, you can pull the latest versions of model data into the file system of the computer on which the server has been told to retrieve the data. Using the Import Definition page within the Web UI, you specify where the IBM Rational Collaborative Architecture Management server retrieves the model data using the Eclipse workspace path or the workspace path and project directories. These paths must point to the file system of the same computer on which the Import Engine is installed and configured.

Important: This is an advanced concept; if you do not know ANT scripting, this process is not recommended because you are responsible for writing custom scripts that are tailored to your configuration and environment.
Using an Ant script to retrieve the latest model data from your configuration management system requires the use of the following two IBM Rational Collaborative Architecture Management-related fields:
IBM Rational Collaborative Architecture Management-Related Field Description
The Ant Script Path field on the Import Definition page of the web UI for your project. The Ant script path path points to the location of the ANT script; this location must be on the same file system as the computer on which the Import Engine is installed. For example, an Ant script will do something like, "use these credentials to log into my source control management (SCM) server, locate the projects in my workspace, and retrieve the latest data". You can write ANT scripts to do other tasks; however, at this time, there is no need to use ANT for anything other than pulling model data from your SCM system.
Note: You can write an ANT script that does not require the knowledge of workspaces. When you add an ANT script path to the Import Definition, that ANT script is executed as the first step in the import.
The Eclipse Installation Directory field in the Import Engine Configuration window. The Eclipse Installation Directory must point to an Eclipse installation that is able to interpret the ANT script provided in the Import Definition. If you have not provided an ANT script, this field should be left as the default, which points to the installation location of the Import Engine. While the Import Engine isn't a true Eclipse installation (it's really a rich client platform), it is designed to handle the import when there isn't an ANT script requires executing.

When you write your Ant script, you can use basic Ant or you can use some tasks provided by your SCM such as Rational Team Concert. If you use special SCM tasks within your Ant script, your Eclipse Installation Path must point to an Eclipse installation of that SCM system.

While Rational Team Concert is an Eclipse installation, you can install Rational ClearCase plug-ins on top of a generic Eclipse installation. If you are using CVS tasks in your Ant script, you can point to your Rational Software Architect installation because CVS is bundled with Rational Software Architect.

If you want to run SCM-specific Ant tasks to work with your SCM, the Eclipse installation that you point to must have one of the following:
  • the Collaboration Client extension for Rational Software Architect, installed using Installation Manager.
  • the Import Engine hook, installed in any version of Eclipse as an update site. See the Eclipse online help for instructions on how to point to a local Update Site, which in this example, means pointing to the norvo-importhook-updatesite folder in the Import Engine installation path: C:\Program Files\IBM\RSAImportEngine\norvo-importhook-updatesite.
If you have no need to use SCM-specific Ant tasks, your Eclipse Installation Path only needs to point to the Import Engine installation: C:\Program Files\IBM\RSAImportEngine

Viewing models through the web user interface

Once you import your Rational Software Architect workspace to the model server, and fix any broken path map references, you can view your model and related resources through the web user interface.

Procedure

  1. Navigate to https://[fully qualified hostname]:9443/rmps/web
  2. Click on the Models tab, and begin to explore your model and related artifacts through the web interface.
  3. Use the search feature to navigate through your model, or use the Explorer to traverse through your model as well.

(Optional) Working with the Rational Software Architect collaboration client extension

After you use the import engine to load model workspaces onto the server, you can configure Rational Software Architect to synchronize comments made between models in Rational Software Architect with models that have been imported onto the model server. The collaboration client provides similar Web functionality allowing you to comment, sketch, and link within Rational Software Architect to models in a model repository.

Configuring Rational Software Architect server locations

After you install the collaboration client extension, you must update Rational Software Architect with the location of your model server. Otherwise, you will not be able to synchronize comments made between models in Rational Software Architect and models that have been imported onto the model server.

About this task

When you are connected to a model repository, all projects that are available in the model repository are rendered from the server and are displayed and organized into different nodes and folders in the Team Explorer view. You can view the diagrams in the diagram editor. In addition, if you already have models in your Rational Software Architect workspace that also reside on the server, the models in the workspace are automatically linked to the models on the server when the server connection is established.

Note: When you establish a connection between a Rational Software Architect workspace and a model repository on a server, any changes you make in your workspace do not automatically update on the server. To make workspace changes available on the server (if you add an operation to a class, for example), the model contents must be imported to the server. However, if you add any links, comments, or sketches on a resource, these lightweight updates are updated on the server instantly.
To configure Rational Software Architect to point to repositories and projects on a model server:

Procedure

  1. In Rational Software Architect, to open the Team Modeling view, click Window > Show View > Other; then click Modeling > Team Modeling and click OK. This view opens next to the Project Explorer view.
  2. In the Team Modeling view, right-click Create a new connection. The Server Configuration window opens.
  3. In the Address field, enter the address of the server such as https://[fully qualified hostname]:9443/rmps
  4. In the Name field, instead using the long server name that appears by default, you might want to rename the server to something more meaningful to your project.
  5. In the Username and password fields, enter the same username you use to log in to the IBM Rational Collaborative Architecture Management server.
  6. Click OK.

Uninstalling IBM Rational Collaborative Architecture Management files

Before you install IBM Rational Collaborative Architecture Management beta , you must uninstall any previous installations ofIBM Rational Collaborative Architecture Management.

About this task

To uninstall the collaboration client extension, the import engine, and the model server:

Procedure

  1. In IBM Installation Manager WS_Beta, on the Start page, click Uninstall. Installation Manager WS_Beta searches its defined repositories for the installed beta packages.
  2. Select the following installed beta packages, and then click Next:
    • IBM Rational Software Architect Exporter
    • IBM Rational Software Architect Server
    • IBM Rational Collaboration Client Extension for RSA
      Note: Even though you cannot install these packages simultaneously, you can uninstall all packages at the same time.
  3. Read the information related to configuration file backups and click Next.
  4. On the Summary page, review the packages that are selected for removal and click Uninstall. The Uninstall Packages page displays the packages that were uninstalled.
  5. Click Finish.
    Note: To uninstall IBM Installation Manager WS_Beta, use the Add/Remove Programs functionality.

Feedback