The Upgrade Process › Filestore and Search Index Location Changes

Filestore and Search Index Location Changes

Two significant changes to the 13.x, 14.1, and 14.2 upgrade processes directly affect the filestore feature. The changes require you to act during the upgrade process to ensure that the filestore feature operates correctly after the upgrade.

Note: The actions are necessary only if your files are not stored in the database. If files are stored in the database, no action is required.

You can determine if your files are stored in the database using the Clarity System Administration (CSA) application. Log in to CSA and navigate to the Documents and Search link under the Properties tab, then review the Store Files in Database property.

Important! If the database is not the filestore repository, action is required. Failure to follow the recommended steps can lead to permanent loss of the filestore contents.

The following changes were made to the upgrade process in Version 13:

• The upgrade process always installs to an empty destination folder. During the upgrade, files and folders that exist in the target installation folder are moved to a new location before the new files are installed. If the filestore folder is located in the runtime folder, it is moved with the other content (not recommended). If the filestore is located outside the runtime folder (the recommended configuration), the filestore location is not moved or copied from the backup location.
• The filestore and search index folder structures were altered to accommodate architectural changes in Version 13. This change requires action for all Release 13.x and 14.x upgrades, whether the filestore was located in the installation folder or not.

Your action depends on the following factors:

• Where the filestore was before the upgrade
• The target installation folder that is selected during the upgrade

The correction must be made immediately after the upgrade completes, before any files are added to the filestore. Any files added to the filestore before the correction is made must be manually preserved using the following steps:

1. Use CA Clarity PPM to retrieve the newly checked-in documents and save them to a temporary location on the file system.
2. Perform the steps for the appropriate use case (A, B, or C) in the following Upgrade Action.
3. To check the saved documents back into the CA Clarity PPM filestore, use CA Clarity PPM.
4. Execute the following commands from the <runtime>/bin folder:

   ‘admin search recreate-index-files’
   ‘admin search recreate-index-data’
   

Upgrade Action: Complete the filestore and search index correction procedure.

Before you start, create a backup of the filestore so that recovery is possible in the event of an unexpected problem. Your document store could be used before this procedure can be completed. If so, the newly included documents must be added back to the filestore after you complete the correction procedure.

The following use cases illustrate the actions to take. To determine the correct course of action, use the filestore location and target installation folder.

Use Case A

• Filestore location: The filestore was located in the CA Clarity PPM runtime folder before the upgrade.
• Target installation folder: The existing (preupgrade) CA Clarity PPM runtime folder was selected as the target installation folder.

Before the upgrade process ran, the file or index folder was in the <runtime> folder. The upgrade process moved the file or folder to a folder named <runtime>_prev based on the chosen upgrade or installation option. The move resulted in the file or index folder being located in the <runtime>_prev folder. The file or index folder must be moved from the <runtime>_prev folder to another location because any subsequent upgrade attempt deletes this folder.

Perform these steps for this use case:

1. If before the upgrade the filestore location was <runtime>/filestore, copy or move the folders under <runtime>_prev/filestore to this new path:

   <new directory>/filestore/clarity
   

   Where <new directory> is located outside of the upgrade resulting <runtime> directory. Having the location outside of the runtime folder follows best practices. Placing the folder outside the CA Clarity PPM installation directory also ensures that this process is not repeated when CA Clarity PPM is upgraded.

   Log in to the CSA application, navigate to the Documents and Search link under the Properties tab, and update the Filestore Directory location. For example, if the filestore path is <old clarity install directory>/filestore, modify the path to <new directory>/filestore.

   Note: Do not append ‘clarity’ to the path in the CSA. The CA Clarity PPM architecture adds this update internally.

2. If before the upgrade the search index directory location was <runtime>/searchindex, copy or move the folders under <runtime>_prev/searchindex to this new path:

   <new directory>/ searchindex /clarity 
   

   Where <new directory> is located outside of the upgrade resulting <runtime> directory. Having the location outside of the runtime folder follows best practices.

   Log in to the CSA application and navigate to the Documents and Search link under the Properties tab and update the Index Directory location. For example, if the filestore path is <old clarity install directory>/searchindex, modify the path to <new directory>/searchindex.

   Note: Do not append ‘clarity’ to the path in the CSA. The CA Clarity PPM architecture adds this update internally.

3. Execute the following command from the <runtime>/bin folder:

   ‘admin search recreate-index-files’
   ‘admin search recreate-index-data’
   

Use Case B

• Filestore location: The filestore was located in the runtime folder before the upgrade.
• Target installation folder: A new, empty folder was selected as the target install folder.

Before the upgrade process ran, the file or index folder was located in the <runtime> folder. The upgrade process produced a different folder named <new runtime>. This process was based on the upgrade or installation option to select a different folder for the upgrade result than the current one. This choice has resulted in the file or index folder being located in the <runtime> folder.

Perform these steps for this use case:

1. If before the upgrade the filestore location was <runtime>/filestore, copy or move the folders under <runtime>/filestore to this new path:

   <new directory>/filestore/clarity
   

   Where <new directory> is located outside of the upgrade resulting <runtime> directory. Having the location outside of the runtime folder follows best practices. Locating the folder outside the installation directory ensures that this process is not repeated in the future when CA Clarity PPM is upgraded.

   Log in to the CSA application and navigate to the Documents and Search link under the Properties tab and update the Filestore Directory location. For example, if the filestore path is <old clarity install directory>/filestore, modify the path to <new directory>/filestore.

   Note: Do not append ‘clarity’ to the path in the CSA. The CA Clarity PPM architecture adds this update internally.

2. If before the upgrade the search index directory location was <runtime>/searchindex, copy or move the folders under <runtime>/searchindex to this new path:

    <new directory>/ searchindex /clarity 
   

   Where <new directory> is located outside the upgrade resulting <runtime> directory. Having the location outside the runtime folder follows best practices.

   Log in to the CSA application, navigate to the Documents and Search link under the Properties tab, and update the Index Directory location. For example, if the filestore path is <old clarity install directory>/searchindex, modify the path to <new directory>/searchindex.

   Note: Do not append ‘clarity’ to the path in the CSA. The CA Clarity PPM architecture adds this update internally.

3. Execute the following command from the <runtime>/bin folder:

   ‘admin search recreate-index-files’
   ‘admin search recreate-index-data’
   

Use Case C

• Filestore location: The filestore was located outside the runtime folder before the upgrade.
• Target installation folder: The target installation folder is not relevant to this use case. These steps must be performed for all upgrades with an external filestore.

The file or index folder is not located in the <runtime> folder.

Perform these steps for this use case:

1. If the previous filestore folder path is now located in <some folder>/filestore, copy or move the folders under <some folder>/filestore to this new path:

   <some folder>/filestore/clarity
   

2. If the previous search index folder path is now located in <some folder>/searchindex, copy or move the folders under <some folder>/seachindex to this new path:

   <some folder>/seachindex/clarity
   

3. Execute the following command from the <runtime>/bin folder:

   ‘admin search recreate-index-files’
   ‘admin search recreate-index-data’
   

No modification to the Filestore Directory or Index Directory properties is needed. You can view these properties from the Properties tab, Documents and Search subtab in the CSA application.

Note: Do not append ‘clarity’ to the path in the CSA. The CA Clarity PPM architecture adds this update internally.

Upgrade Reports

This release of CA Clarity PPM introduces a new reporting solution to replace the current Business Objects reporting solution. The new solution uses a CA Clarity PPM Data Warehouse and a third-party reporting tool (Jaspersoft). Both ship with CA Clarity PPM.

New customers who are installing for the first time must use the new Advanced Reporting solution.

Existing customers who have Business Objects installed can continue to use that reporting solution currently.

For more information about future plans for CA Business Intelligence and Business Objects, see the Jaspersoft Reporting FAQ.

CA Business Intelligence (CABI) Release 3.3 Service Pack 2

If you have an older version of CABI, complete both the steps. If you already have a CABI Release 3.3 installation, you only download and install Service Pack 2 (Step 2 in the following procedure).

Follow these steps:

1. Download and install CABI Release 3.3 by completing these steps:

   Note: This step is for upgrading customers with an older version of CABI.

   1. Log in to the CA Clarity PPM support page on CA Support Online.
   2. In the Quick Access section, click Download Center.
   3. In the Please narrow your search results for "Products" below section, select the product for which you are licensed (for example, CA Clarity PPM Core License), select the appropriate release number, and click Go.
   4. Click the Download link next to the appropriate CA Business Intelligence 3.3 download.
   5. On the Download Method page, select the appropriate download method to complete the download request.
   6. Install CABI Release 3.3.
2. Download and install Service Pack 2 on the CABI Release 3.3 installation.
   1. Download the CABI Release 3.3 Service Pack 2 and the Release Notes from the CA FTP site:

      Windows:

      ftp://ftp.ca.com/caproducts/CABI/CABI-3.x/boeXIR3_SP7/Windows/

      Note: Download both the zip file and the CABI 3.3 SP2 Release Notes.

      Linux:

      ftp://ftp.ca.com/caproducts/CABI/CABI-3.x/boeXIR3_SP7/Linux/

   2. Follow the instructions in the CABI 3.3 SP2 Release Notes to install Service Pack 2 on the CABI Release 3.3 instance.

CABI Services Recommended Settings

We recommend the following adjustments to your CABI setup for use with Release 13.2 and greater releases. Make the adjustments from the Central Management Console (CMC):

• WebIntelligenceProcessingServer
  • Maximum Connections: Change from 50 to 25.
  • Memory Maximum Threshold (MB): Change from 1800 to 1700.
  • Clone an extra service.
• ReportApplicationServer
  • Max Concurrent Report Jobs: Change from 75 to 50.
  • Clone an extra service.
• AdaptiveJobServer (specific to WEBI)
  • Clone an extra service.
• CrystalReportsJobServer
  • Clone an extra service.
• Stop and disable the following services that CA Clarity PPM does not use:
  • DesktopIntelligenceCacheServer
  • DesktopIntelligenceJobServer
  • DesktopIntelligenceProcessingServer
  • EventsServer
  • ListOfValuesJobServer
  • MultiDimensionalAnalysisServiceServer
  • PMMMeticsServer
  • PMMRepositoryServer
  • PMMRulesServer
  • PreditiveAnalysisServer (Available only for non-Windows environments)
  • ProgramJobServer
  • SetsProfileServer
  • SetsQueryServer

CA Clarity PPM Universes

The following CA Clarity PPM Legacy BIAR files are no longer provided with the product:

• CA_Clarity_Legacy_MSSQL.BIAR
• CA_Clarity_Legacy_Oracle.BIAR

The CA Clarity PPM Universes have been updated to reflect database schema changes in Release 14.2.

Note: See the Business Objects Universe Developer Guide for details.

Upgrade Action: Import the BIAR files as part of your Clarity 14.2 upgrade process.

Xcelsius Designer

Xcelsius Designer is not bundled with CA Clarity PPM and is not available to new customers who are installing CA Clarity PPM for the first time.

Existing customers with Xcelsius installed can find the latest supported version (Xcelsius Designer 2008 Service Pack 6 Fix Pack 3) on the CA Clarity PPM Download Center on CA Support Online.

Upgrade Actions: None

Upgrade Business Objects Reports

All reporting content for CA Clarity PPM is delivered in the Clarity Solution Pack.

Upgrade Action for CA Clarity PPM Versions Earlier than Release 13.2: As of Release 13.2, legacy stock report definitions in Studio are inactivated during the upgrade process.

The report definitions are converted from system-restricted status to user-defined to give you full control over the definitions. The existing reports in your Report Library become hidden because the report definitions have been deactivated. You can use the legacy stock reports and can see related instances in the Report Library by following these steps:

1. Open Administration, and from Data Administration, click Reports and Jobs.
2. Filter for Inactive Reports.
3. Activate the reports that you want to continue to use with Release 14.2.

Note: Support for these legacy reports is no longer available. Activating a report is done with the understanding that you are responsible for all changes to maintain the compatibility with Release 13.2 and releases beyond.

Post-Upgrade Action: We recommend installing the Clarity Solution Pack, which delivers the Release 14.2 compatible reporting content. For more about the Clarity Solution Pack, see the Solution Pack index page on Support Online.

Upgrade Reports from a Release Earlier than Release 12.1

Use this information to upgrade reports if you have a CA Clarity PPM version earlier than Release 12.1.

Note: BusinessObjects report instances that are created in a version earlier than Release 12.1 can be viewed only as a PDF file after the upgrade.

Upgrade Actions:

Preupgrade:

• Upgrade to CABI Release 3.3.

  Note: For more information about how to upgrade, see the Installation Guide.

• If you used any CA Clarity PPM universe objects, create a custom universe and link it to the CA Clarity PPM universe. The CA Clarity PPM universe is overwritten when the new Release 14.2 universes are installed.
• If you previously purchased the GSE Universes from CA Services, these universes are not overwritten by the Release 14.2 out-of-the-box universes.
• If you modified any out-of-the-box reports, move the modified reports to a custom report folder on the BusinessObjects server.

Upgrade:

• Follow the instructions in the Installation Guide.

Post-Upgrade:

• If you decide to continue using the legacy reports, see the instructions about reactivating legacy stock report definitions in Upgrade Business Objects Reports.

  Manually reschedule the scheduled reports. The scheduled reports that were configured before the upgrade to Release 14.2 do not automatically run after the upgrade.

• Update any user and security configurations that are required to support CABI Release 3.3 and trusted authentication integration with CA Clarity PPM.

  Note: For more information, see the Installation Guide.

• Reset the BusinessObjects InfoView passwords for all preupgrade users who must log in to InfoView and run reports.
• To reset passwords for multiple users, use BusinessObjects Central Administration.
• If LDAP is not configured, synchronize the user lists in BusinessObjects and CA Clarity PPM by running the Create Business Objects Users job. If the job is not run, a CA Clarity PPM user must have a BusinessObjects account created to run or open a report.

  The job creates a user in BusinessObjects for every user in CA Clarity PPM. The user that is created in BusinessObjects is given an encrypted password. To log in to the BusinessObjects server using the assigned password, the user ID and password must be reset under BusinessObjects Administration.

Upgrade Reports from a 12.x Release or Service Pack

Use this topic to understand the upgrade actions to take for reports if you have a CA Clarity PPM version older than Release 12.1.

Release 14.2 uses the same CABI requirements and trusted authentication integration with CA Clarity PPM as Release 12.1 and Service Pack 12.1.1.

Upgrade Actions:

Preupgrade:

• If you are not already using CABI Release 3.3, upgrade to that release.

  Note: For more information, see the Installation Guide.

• If you used any CA Clarity PPM universe objects, create a custom universe and link it to the CA Clarity PPM universe. The CA Clarity PPM universe is overwritten when the new Release 14.2 universes are installed.
• If you previously purchased the GSE Universes from CA Services, these universes are not overwritten by the Release 14.2 out-of-the-box universes.
• If you modified any out-of-the-box reports, move the modified reports to a custom report folder on the BusinessObjects server.

Upgrade:

• Follow the instructions in the Installation Guide.

Post-Upgrade:

• If you decide to continue using the legacy reports, see the instructions about reactivating legacy stock report definitions in Upgrade Business Object Reports.

  Manually reschedule the scheduled reports. The scheduled reports that were configured before the upgrade to Release 14.2 do not automatically run after the upgrade.

• If LDAP is not configured, synchronize the user lists in BusinessObjects and CA Clarity PPM by running the Create Business Objects Users job. If the job is not run, a CA Clarity PPM user must have a BusinessObjects account created to run or open a report.

  The job creates a user in BusinessObjects for every user in CA Clarity PPM. The user that is created in BusinessObjects is given an encrypted password. To log in to the BusinessObjects server using the assigned password, the user ID and password must be reset under BusinessObjects Administration.