Home

Other Products

Installing and updating the server component

Note: To update the server component of Document Collaboration, you first need to remove the existing version.
To install the server component on the Jazz Team Server, do the following:
  1. Download the archived update site from ibm.com/software/awdtools/document:
    • For Rational Team Concert 2.0, download DocumentCollaborationServerUpdateSite_forRTC2.zip.
    • For Rational Team Concert 1.x, download DocumentCollaborationServerUpdateSite_forRTC1.zip.
  2. Extract the file contents (preserving the directory structure) to a new directory named DocumentCollaborationServerUpdateSite, next to the JazzInstallDir directory.

    After extraction, the directory structure should look like this:

    • JazzInstallDir
      • server
    • DocumentCollaborationServerUpdateSite
      • features
      • plugins

  3. Stop the Jazz Team Server.
  4. Copy mainsoft-documents-profile.ini to your server provision profiles directory:
    • For Rational Team Concert 2.0, copy mainsoft-documents-profile.ini to JazzInstallDir/server/conf/jazz/provision_profiles.
    • For Rational Team Concert 1.x, copy mainsoft-documents-profile.ini to JazzInstallDir/server/provision_profiles.

    The file mainsoft-documents-profile.ini instructs the Jazz Team Server to look for DocumentCollaborationServerUpdateSite next to the JazzInstallDir directory.
    Note: If the DocumentCollaborationServerUpdateSite folder is located elsewhere, edit the mainsoft-documents-profile.ini file to point to file://<path...>/DocumentCollaborationServerUpdateSite. For example:
    • Windows: url=file://bob-xp/MainsoftDownloadedAndExtractedZipFiles/DocumentCollaborationServerUpdateSite
    • Linux: url=file:///machinename/users/bob/MainsoftDownloadedAndExtractedZipFiles/DocumentCollaborationServerUpdateSite

    If your Jazz Team Server is running on WebSphere Application Server, the ini file in the server provision profiles directory must use an absolute path for the URL property. For example, instead of url=file:./DocumentCollaborationServerUpdateSite, you should use: url=file:/C:/JazzTeamServer/server/DocumentCollaborationServerUpdateSite (Windows), or url=file:/opt/IBM/JazzTeamServer/server/DocumentCollaborationServerUpdateSite (Linux).
  5. From the Command Prompt, set the Jazz Team Server folder JazzInstallDir/jazz/server/ as the current directory and run the command:
    repoTools -addTables
    Run the command repoTools -addTables.

    Note: The first time you install Mainsoft Document Collaboration for Rational Jazz, you will see the message "Component has not been installed in the database: com.mainsoft.team.documents". You can safely ignore this message and continue with the installation.
  6. Start the Jazz Team Server.
To verify that your server installation was successful, open the Web admin interface at https://localhost:9443/jazz/admin and click on the Component Status link. The Component Status page should list com.mainsoft.team.documents, and the two services com.mainsoft.team.documents.common.IDocumentsRestService and com.mainsoft.team.documents.common.IDocumentsService.

The two Document Collaboration services installed on the Jazz Team Server.

Note: A free 60-day trial license will start when you first access the features in Document Collaboration.
Related tasks
Installing and upgrading the client component
Removing the server component
Configuring the server to work with a proxy

Related information
Installed server components
  • Overview
  • Accessibility features
  • Installing and upgrading Document Collaboration
    • Installing and updating the server component
    • Installing and updating the client component
    • Removing the server component
    • Removing the client component
    • Installed server components
  • Getting started with Document Collaboration
  • Working with the Documents folder in Team Artifacts
  • Working with the Documents view
  • Configuring the preferences
  • Configuring the Related Document Workflow precondition
  • Using the Related Document Workflow precondition
  • Understanding how Jazz uses document site credentials
  • Licensing and Trial Extension