Upgrade Clarity PPM

ccppmop158
The following image shows how an administrator upgrades a 
Clarity PPM
 installation for single and clustered servers. As a SaaS administrator, you do not execute the upgrade steps yourself; however, you still need to perform pre-upgrade and post-upgrade steps. For example, you upgrade from a test instance to a production instance.
Clear Your Browser Cache
After an upgrade or after changing their access rights, you may encounter a blank page until you clear the browser cache, cookies, and history files. The steps vary by the web browser. If you see improved results in Google Chrome incognito mode, that generally indicates you can clear your browser cache to achieve the same results in normal mode.
Also, try logging out and then logging back in again to reset your permissions. 
This image shows how to upgrade CA PPM
This image shows how to upgrade CA PPM
 
How Long Does It Take to Upgrade? 
 
 
From the day our SaaS customers place a ticket to request an upgrade, the entire process only requires approximately 2 to 4 days to be completed, plus 4 to 7 days for production environments, for a combined time of about 10 to 15 days. (More time is often used to conduct additional testing or try new features. We have seen very complex customer requirements with upgrade validation windows as long as 30, 60, or even 90 days.)
  1. All non-production upgrades are processed in batches which start every week on a Monday or Tuesday. 
  2. Each SaaS upgrade ticket shows when the new live environment is ready for your users. The customer contact person on the upgrade ticket also receives an email notification. As the SaaS contact, you can then notify other individuals that require a status update for the upgrade.
     To start a non-production SaaS upgrade, enter a ticket. When your team is finished testing, open a new ticket titled 
     
    “Testing Complete, Upgrade Production”
     
     to request the production upgrade.
  3. Allow 5 to 7 business days of lead time for receiving and scheduling your production upgrade request. Even with a submitted production ticket, we cannot guarantee availability in the next upgrade cycle. Availability of the date requested as well as standard maintenance windows are considered prior to a confirmation of a date provided on the ticket from the SaaS upgrade team. 
  4. Production upgrades typically start on the next available Friday after the close of business and typically finish by the end of the next day (Saturday). 
  5. Each SaaS upgrade ticket shows when the new live environment is ready for your users. The customer contact person on the ticket also receives an email notification. As the SaaS contact, you can then notify other individuals that require a status update for the upgrade.
 If you require immediate assistance with a major issue in your post-upgrade production environment, open a 
Severity 1
 ticket. If a rollback to the prior version is necessary, the whole process restores all your original pre-upgrade data.
 
 
2
 
 
(On-Premise only) Important Notes for Customers Planning to Upgrade to Release 15.7
  • Clarity PPM 15.7 uses AdoptOpenJDK 11.0.3+7. You need to install Adopt JDK and point your Java Home variable to the Adopt JDK directory.  
  • FIPS is Not Supported in 15.7:
     Reset any configuration changes that you made to enable FIPS 140-2 mode of operation in a previous release and disable FIPS before upgrading to 15.5.1. If you did not disable FIPS before the upgrade to 15.5.1, you will likely encounter an error.
  •  
    Oracle Installations Only
    : You cannot upgrade on Oracle until your 
    dbms_obfuscation_toolkit.md5
     package is enabled. For database encryption, enable your new security license (required only for database encryption).
    1. Enable and grant explicit permissions to 
      dbms_obfuscation_toolkit.md5
       (also provided with your Oracle installation).
    2. (Optional) Contact your database administrator or Oracle to obtain the advanced security license (OAS) required for 
      DBMS_CRYPTO
      .
    3. Start the upgrade
  •  
    After upgrading to 15.7 ensure all your client-side components like XOG, OWB, and Schedule Connect are installed again. 
(SaaS only)
 As a Clarity PPM user, you enjoy seamless automated upgrades in the cloud. SaaS administrators can prepare for an upgrade, review the new features, and perform any required or optional changes post-upgrade.
Pre-Upgrade: Review the RequirementsAddress the following important points before you begin an upgrade:
  • Days or weeks in advance, you can run a health report and examine any customizations that could interfere with a future upgrade. See Health Report, Job Monitor, Governor Settings, and Data Warehouse Audit Dashboard
  • Review the Release Information including the Release Notes and Change Impact and Upgrade documentation. See the 
    Known Issues
     for conditions that can affect the success of your upgrade. Take any required corrective actions. Read the Change Impact and Upgrade information for each release between your current one and the target release.
  • Verify that you are following a recommended upgrade path. Not all product releases and patch levels have supported upgrade paths between them.
  • Run the Delete Process Instance job in your current environment. A series of full scans on the BPM_ERRORS table can slow performance in Oracle and Microsoft SQL databases. For every query, the database flushes all buffer data to disk in order to load and read new rows. Run this job with date parameters to improve performance. For example, run in monthly time segments. See 
    Delete Process Instance Job 
    in Clarity PPM Jobs Reference.
  • License key information is required to install some third-party software products. See the documentation or README file that is provided with your third-party installation media.
  • Disable any custom database triggers or antivirus scanners that can interfere with the upgrade or installation scripts.
  • Check any third-party software you might also be upgrading, or be required to update.
    Note
    : For information about the versions of third-party software that this release supports, see the Clarity PPM 15.6.1 Release Notes.
  • Verify that a standard calendar exists in the product by looking at the properties of existing calendars. A standard calendar has the Standard check box selected in the calendar properties. To view properties of calendars, open the Administration menu, and from Project Management, click Base Calendars. If you deleted the shipped calendar named 
    Standard
    , create it before upgrading. Contact CA Support if your instance is missing the Standard base calendar.
  • Process all 
    In progress
     transactions into WIP. Review and fix all invalid transactions. Verify the following conditions:
    • imp_transactionimport and ppa_transcontrol are clear.
    • WIP adjustments are approved.
  • Review time slices. Verify that the table is slicing out only the data that is required. If extra data is getting sliced, the database size increases and affects performance.
  • (Optional) Clear the Datamart and recreate the data post-upgrade to improve the processing time of the upgrade. After the upgrade, run the following jobs to repopulate the Datamart tables:
    • Datamart Extraction job
    • Datamart Rollup job
  • Complete and put all processes on hold.
  • Remove or delete process history, notifications, jobs, or logs. Look for items that you do not need to retain.
  • Pause all scheduled jobs. Take special note of the 
    Time Slicing
     job. Pause it before the upgrade.
  • Turn off auditing on all objects before you start the upgrade process.
Only on-premise customers can run a checkinstall utility before starting their upgrade. As a SaaS administrator, be advised the following process is taking place for you by CA SaaS Operations. Clarity PPM SaaS Ops runs the checkinstall utility for your On Demand PPM instance a few days in advance of the scheduled installation date. If a validation error is found, a Support case is opened and logged under your customer site ID for visibility.
(On-Premise and SaaS)
 Pre-Upgrade Steps
  1. You must have the standard base calendar available in your 
    Clarity PPM
     application before you upgrade. If you deleted the shipped calendar that is named 
    Standard
    , create it before upgrading. Contact CA Support if your instance is missing the Standard base calendar.
  2. Process all 
    In progress
     transactions into WIP.
    1. Verify the following conditions:
      1. imp_transactionimport and ppa_transcontrol are clear.
      2. WIP adjustments are approved.
    2. Review and fix all invalid transactions.
  3. Review Time Slices.
    Verify that the table is slicing out only the data that is required. If extra data is getting sliced, the database size increases and affects system performance.
  4. Complete and put all processes on hold.
  5. Remove or delete process history, notifications, jobs, or logs. Look for items that you do not need to keep.
  6. Pause all scheduled jobs. Take special note of the 
    Time Slicing
     job. Pause it before stopping the 
    Clarity PPM
     services before upgrading.
(On-Premise and SaaS) 
Pre-Upgrade: Custom Processes, Scripts, and Other Customizations
 
Clarity PPM
 cannot upgrade any unsupported customized content. Customizations must be disabled and may need to be redesigned and re-implemented to work with changing product functionality.
! After an upgrade, unless you disable them, your customizations might result in errors or fail to work as expected.
 
Follow these steps
:
  1. Identify your custom content in your current release. For example, you have one or more custom processes with custom GEL scripts that modify timesheet status attributes.
  2. Acknowledge the customizations and recognize that the upgrade scripts might not support the custom content. Even if the custom content is upgraded, it may no longer work as expected. For example, your custom process references an object or attribute that has changed in the new release.
  3. As an on-premise administrator, the checkinstall script provides a warning for customizations that it detects pre-upgrade. As an on-demand administrator, you do not see these warnings or the referenced logs. To assist all administrators, we show the following example message in full to provide insight into the types of customizations that can negatively impact your upgrade experience:
    WARNING: Possible schema customizations have been found. Any customizations to the system are the responsibility of the customer to maintain and are not supported by CA Technologies. To upgrade successfully, all customizations must be reviewed, changed, or removed as needed before the upgrade. After a successful upgrade, the customizations may be added back to the system. The possible customizations found are listed in the following log files:
    check‐logs/database_customization_triggers.txt check‐logs/database_customization_indexes.txt check‐logs/database_customization_tables.txt checklogs/database_customization_constraints.txt
  4. Turn off the customizations before the upgrade. After the upgrade, reintroduce the customizations and test them in the Classic PPM interface. Optionally, verify the impact of the customization behavior on the 
    New User Experience
    .
  5. In addition to database objects, also evaluate attribute values. Review the Oracle and Microsoft SQL database and data warehouse changes (see the 
    Reference
     section in the English documentation). Validate if any of your customizations depend on any dropped, changed, or new attributes.
 Some customers have experienced errors with legacy custom content. After disabling the custom process, script, or other legacy custom content, the 
New User Experience
 provided the functionality with no net loss to end users. We recommend that you perform an analysis comparing the value of 
Clarity PPM
 features in a complete COTS/SaaS solution against the value of developing your own unsupported customizations.
(On-Premise only)
 Video: 
Clarity PPM
 Upgrade Assessment Utility
Learn how to use the Upgrade Assessment Utility to make upgrading 
Clarity PPM
 simple and quick:
 

 
 To play this video in full screen, click the YouTube logo. 
(On-Premise only)
 Pre-Upgrade: Review the Requirements
Address the following important points before you begin the upgrade:
  • Weeks or months in advance, you can run a health report and examine any customizations that could interfere with a future upgrade. See Centralized Governor Settings.
  • A user account with administrator rights is required for the server or servers on which you intend to install PPM.
  • Backup the existing installation directory and database. Verify that you have a consistent back-up of the database schema. Verify that you have sufficient disk space available on the server. For upgrades that span two or more releases, a prompt asks if you want the upgrade process to save the most recent backup step for you.
 Depending on the size of your database, each release backup can potentially take several hours. We recommend that you perform an initial upgrade with backups in a sandbox or test environment. After resolving any issues, you can upgrade the production environment and skip the backups since you already have them.
  • Run the Delete Process Instance job. A series of full scans on the BPM_ERRORS table can slow performance in Oracle and Microsoft SQL databases. For every query, the database flushes all buffer data to disk in order to load and read new rows. Run this job with date parameters to improve performance. For example, run in monthly time segments. See 
    Delete Process Instance Job 
    in Jobs Reference.
  • Read the Change Impact and Upgrade information for each release between the one you are currently using and the release to which you are upgrading. Review the known issues. Verify that you are following a recommended upgrade path. Not all product releases and patch levels have supported upgrade paths between them.
  • License key information is required to install some third-party software products. See the documentation or README file that is provided with your third-party installation media.
  • Disable any custom database triggers or antivirus scanners that can interfere with the upgrade or installation scripts.
  • Verify the configuration settings on the 
    Clarity PPM
     database server and note any changes that you want to make.
  • Upgrade the following third-party software (as needed) to work with this release.
    • AdoptOpenJDK 11.0.3+7
    • Apache Tomcat (application server)
     For information about the versions of third-party software that this release supports, see the Clarity PPM 15.6.1 Release Notes.
  • Verify that a standard calendar exists in the product by looking at the properties of existing calendars. A standard calendar has the Standard checkbox selected in the calendar properties. To view properties of calendars, open the Administration menu, and from Project Management, click Base Calendars. If you deleted the shipped calendar named Standard, create it before upgrading. Contact CA Support if your instance is missing the Standard base calendar.
  • If XDM was part of a previous version of 
    Clarity PPM
     that you are upgrading, an XDM step appears in the installation process. After you run this step, ensure that XDM is distributed to the other servers in the cluster.
  • We recommend that you turn off auditing on all objects before you start the upgrade process.
  • Process all 
    In progress
     transactions into WIP.  Review and fix all invalid transactions. Verify the following conditions:
    • imp_transactionimport and ppa_transcontrol are clear.
    • WIP adjustments are approved.
  • Review Time Slices. Verify that the table is slicing out only the data that is required. If extra data is getting sliced, the database size increases and affects performance.
  • Clear the Datamart and recreate the data post-upgrade to improve the processing time of the upgrade.
 The Datamart is automatically cleared for Oracle. Use 
NBI_Clean_Datamart_sp
 to clear the Datamart. The script does not clear the following tables:
  • The configuration table (NBI_CFG%)
  • Time facts tables that contain historical information (
    NBI_PM_PT_FACTS
     and 
    NBI_FM_PT_FACTS
    )
  • Complete and put all processes on hold. Remove or delete process history, notifications, jobs, or logs. Look for items that you do not need to retain.
  • Pause all scheduled jobs. Take special note of the 
    Time Slicing
     job. Pause it before stopping the 
    Clarity PPM
     services before the upgrade.
  • To verify that all components are installed and functioning before and after the upgrade, run the Health Report.
  • Remove all 
    Clarity PPM
     services before running the upgrade using the following command: 
    service remove all
    .
  • Verify that no files or folders in the installation folder are in use anywhere.
  • Turn off auditing on all objects before you start the upgrade process.
  • Verify that only one command line prompt is open, and that it is running as administrator. Close any open file browser windows that are open in directories that may be modified during the installation.
  • See the Known Issues for conditions that can affect the success of your upgrade. Take any required corrective actions.
  • The following step applies on Oracle databases only; however, the 
    automated backups during upgrade
     feature works on both Oracle and MS-SQL databases. To permit the upgrade to make automatic backups, grant the application database schema user the CREATE ANY DIRECTORY permission and SELECT permission on DBA_DATAPUMP_JOBS. Grant the same permissions for the data warehouse schema user if you are upgrading from a previous release of the data warehouse. These are for Oracle only.
 
grant CREATE ANY DIRECTORY to <app schema user>;
grant SELECT on DBA_DATAPUMP_JOBS to<app schema user>;
 
 
grant CREATE ANY DIRECTORY to <dwh schema user>;
grant SELECT on DBA_DATAPUMP_JOBS to <dwh schema user>;
 
  • In some environments where the application and database are on the same server, running the 
    service stop all
     command also stops the listener.
    1. To check the status of the listener, enter 
      lsnrctl status
      .
    2. If this returns error code 61, issue the command 
      lsnrctl start
      .
  • To avoid errors, when selecting a backup directory, verify that it is on the same server as the Oracle home directory.
 The installer asks you to review the checkinstall results before you proceed with the upgrade. If you are not ready, you can type 
N
 at the 
Y/N
 prompt.
(On-Premise only)
 Pre-Upgrade: Run Checkinstall
The Installation Checker (checkinstall) utility assesses any installation or upgrade. The utility runs automatically at the start of an installation or upgrade and at the end of an upgrade attempt. You can also run it manually. The utility produces a report results file (precheck-results.html) in the <install-root>/checkinstall/check-logs directory.
 
Upgrade Action
: For best results, run the Installation Checker before starting the full installation and upgrade process. Carefully evaluate and resolve warnings before proceeding.
 
Follow these steps:
 
  1. Extract the 
    Clarity PPM
     installer to the 
    Clarity PPM
     application server.
  2. Open a command prompt and navigate to the checkinstall directory located in the directory to which you extracted the installer.
  3. Invoke the checkinstall command:
    UNIX
    :
    sh checkinstall.sh
     
    Windows
    :
    checkinstall.bat
     You are asked for the Operator Username and Operator Email. This information refers to the user who is upgrading or installing and the email of the user. This information is stored as a record in the installation log.
  4. Verify the results.
    The results contain any warnings and errors and also indicate any customizations that you have made. Review the customizations and make adjustments for the upgrade as necessary.
(On-Premise only)
 Pre-Upgrade: Installation and Upgrade Dependencies
The install and upgrade scripts in this release introduce the following dependencies in the listed chronological order:
Install/Upgrade of This Component:
Requires This Component:
Upgrade 
Clarity PPM
 
Data Warehouse Configured
Load Data Warehouse Job Completed
Install PMO or APM add-ins
Data Warehouse Configured
 
New User Experience
 
PMO Accelerator Add-in
(On-Premise only)
 Pre-Upgrade: Make Third-Party JAR Files Accessible to the Installer
Because of licensing restrictions for some third-party library JAR files (currently the jgroups-all.jar and the xinclude.jar), changes were made in how these files ship. The JAR files are shipped separately from the 
Clarity PPM
 image in the installation media. The install.jar image does not contain the files mentioned. Any install packages for a previous version included in the install.jar also exclude the .jar files. For each release of 
Clarity PPM
, the .jar files are bundled into a folder on the installation media containing third-party libraries .jar file. For Release 15.x, the file is named 
thirdparty.libs.15.x.0.jar
.
Upgrade Action
: Retrieve the 
thirdparty.libs.15.x.0.jar
 file from the installation media. Place the .jar file in a location in your file system so that it is accessible to the installer.
 To keep the installer from prompting you for the file location, place the JAR file in the installation root directory. If you place the JAR file in another directory, the installer prompts you for the location.
(On-Premise only)
 Pre-Upgrade: Override Default Memory Settings (Large Data Sets)
If your 
Clarity PPM
 upgrade processes a large volume of data, we recommend that you override the default memory settings.
  1. Create a 
    memory.properties
     file.  
  2. Place it in the 
    $cappm/config
     directory. 
  3. Set the desired memory values in that file.
A typical upgrade uses the following default values:
defaultScriptMaxMem=1024m defaultScriptPermGenMem=128m
The following example shows new settings in the 
memory.properties
 file:
defaultScriptMaxMem=2560m defaultScriptPermGenMem=512m
(On-Premise only)
 Pre-Upgrade: Overview for a Typical 
Clarity PPM
 Upgrade
 
Follow these steps:
 
  1. Perform the pre-upgrade requirements.
    1. Install the prerequisite third-party software. For the supported operating environment information, see 
      Compatibilities
       in the Clarity PPM Release Notes 
      .
       
    2. Create a full backup of your database, file systems, and customizations (if applicable). To keep sequences in line, take a 
      cold 
      backup.
    3. Remove customer-added database triggers, stored procedures, indexes, views, and constraints before upgrading.
       As a result of the database schema changes for this release, most custom triggers, indexes, and constraints can cause the upgrade to fail. We recommend 
      removing
      , not disabling, customer-added triggers.
  2. Perform the remaining pre-upgrade steps and then start the upgrade as detailed in 
    Upgrade 
    Clarity PPM
     
    . This documentation is available only in the English edition of the documentation set.
  3. Some important changes include:
    • The upgrade prompts you for current and target 
      Clarity PPM
       folders. You can specify the same folder or different folders. If you specify the same folder for both, the existing folder is renamed. The new release is installed into an empty folder with the target folder name.
    • If you are installing on a different server, review the information about setting up the application server in 
      Install CA PPM
      . This documentation is available only in the English edition of the documentation set.
    • The HTTP and HTTPS Entry URL fields completed for the server in 
      Clarity PPM
       System Administration (CSA) cannot be 
      localhost 
      when Jaspersoft is integrated with 
      Clarity PPM
      . When you use Jaspersoft, enter the complete URLs on the Application subtab of the Properties tab for the 
      Clarity PPM
       server.
  4. Complete the initial post-upgrade steps:
    1. Verify that all installation steps completed successfully by reviewing the post-upgrade report that the installer generates.
    2. Review the 
      Clarity PPM
       System Administration server admin.log and install.log for errors.
    3. Reapply any database and file system customizations.
    4. Run the Oracle Table Analyze Job from 
      Clarity PPM
       after the upgrade is done to gather schema statistics. The expected time for this job to complete depends on the size of the database. We recommend that you run this job right after the upgrade and at off peak hours thereafter.
      If you use a custom statistics job, refer to the updated Oracle Table Analyze Job procedure in the 
      Clarity PPM
       schema in Release 15.7 (CMN_JOB_ANALYZE_SP) and make the necessary corrections in the custom statistics job.
  5. Upgrade your Advanced Reporting content or configure Advanced Reporting for the first time:
    1. Set up the Data Warehouse database and populate it with 
      Clarity PPM
       data.
    2. Install Jaspersoft and import the domain information for reporting.
  6. Install and upgrade your choice of add-ins and connectors.
    • Back up your 
      Clarity PPM
       installation before installing each add-in so that you can restore the application if necessary.
    • Apply the 
      Upgrade Ready
       content for those items that you are actively using.
       Consider the configurations that you have made to items before applying them. Applying modified items overwrites your configurations.
       
      Best Practice
      : If you modified stock 
      Clarity PPM
       content, copy the modified content before upgrading. Then, apply the new incoming stock 
      Clarity PPM
       content, and retrofit the modifications to the new content.
  7. Review the Studio views and system content and manually upgrade as needed.
    The upgrade preserves all pre-existing Studio view configurations. If an existing view has configurations or if the object for the view is partitioned, the system does not automatically upgrade the view or the partition.
    To determine which views were not automatically upgraded, use the Studio Views list page.
    Use these tips to help you review the views:
    • The Last Version column identifies changes to stock views in Release 15.7.
    • If a view was automatically upgraded as part of the upgrade process, a checkmark appears in the Upgraded column. No further action is required.
    • If a view that changed in Release 15.7 was not upgraded due to pre-existing configurations, decide whether to apply the changed view.
      Look for views with the following column information:
      Last Version column=15.7 and the Upgraded column= unchecked.
  8. Verify your NSQL queries.
    During the upgrade, the checkinstall utility automatically verifies NSQL queries. Results are captured in the postcheck-results.html file of the checkinstall-results.zip file. This log contains the following information:
    • Query name
    • Query ID
    • Content Source
    • Query ID from CMN_NSQL_QUERIES of the query that failed validation
    Each release contains one or more database or datawarehouse schema changes. To ensure that your custom portlets work, correct any invalid NSQL queries.
    For more information about the database schema changes, see Data Model Changes.
    Upgrade Action
    :
    If the query can be changed in Studio, complete these steps:
    1. Go to the NSQL tab for each failing query.
    2. Click the Preview button.
    3. Review the errors.
    4. Repair the broken query constructs or fields.
    5. Click the Preview button.
    6. Confirm that the NSQL query is valid.
      If the query is in use by active portlets and cannot be edited in Studio, complete these steps:
    7. Use the XML Open Gateway (XOG) to export the failing query.
    8. Correct the broken query constructs or fields.
    9. Use XOG to import the corrected query.
    10. In Studio, go to the NSQL tab for the imported query and click the Preview button.
    11. Confirm that the NSQL query is valid.
  9. Save the Upgrade Check Install Results Package.
    The upgrade process produces a zipped file that contains all of the artifacts that were created during the upgrade. Review the contents and save the zip package for future reference.
    The files are zipped into an archive that has a timestamp-encoded name (for example, checkinstall-results_2018-08-17_16-48-31.zip). This file is located in the checkinstall/check-logs directory, and if possible, the file is copied into the <target runtime dir>/logs/checkinstall directory.
(On-Premise only)
 Pre-Upgrade: MS SQL Server Database Compatibility Level
If you are using SQL Server 2014 for this release, set the compatibility level to 120 from SQL Server Management Studio or use the following command:
EXEC SP_DBCMPTLEVEL <database>, 120
If you are using SQL Server 2016 for this release, set the compatibility level to 130 from SQL Server Management Studio or use the following command:
EXEC SP_DBCMPTLEVEL <database>, 130
If you face performance issues in Clarity, we recommend you alter the compatibility level to 110 for optimal performance after upgrade.
(On-Premise only)
 Pre-Upgrade: Oracle Database Only PRJ_BLB_SLICES Table
The ID, UNIT, LAST_UPDATED_DATE and LAST_UPDATED_BY columns in the PRJ_BLB_SLICES table have been dropped. If you are using Oracle, the table is replicated before the columns are dropped. The replication requires you to verify that the tablespace that PRJ_BLB_SLICES occupies is large enough to accommodate the temporary size increase.
 
Upgrade Action
: To determine if the tablespace can deal with this condition, have your database administrator (as sysdba) run the following query. Change the schema owner to the owner of the 
Clarity PPM
 schema:
select SLC.owner, SLC.table_name, SLC.TABLESPACE_NAME, SLC.MB MB_NEEDED, TBSPC.MB_FREE MB_FREE, SIZING.MAX_MB, SIZING.MB_USED, EXT.AUTOEXTENSIBLE FROM (select owner, table_name, NVL(round((num_rows*avg_row_len)/(1024*1024)),0) MB, TABLESPACE_NAME from all_tables where owner = 'CLARITY' and table_name = 'PRJ_BLB_SLICES') SLC INNER JOIN (select df.tablespace_name, (df.totalspace - tu.totalusedspace) "MB_FREE" from (select tablespace_name, round(sum(bytes) / 1048576) TotalSpace from dba_data_files group by tablespace_name) df, (select round(sum(bytes)/(1024*1024)) totalusedspace, tablespace_name from dba_segments group by tablespace_name) tu where df.tablespace_name = tu.tablespace_name) TBSPC ON (SLC.TABLESPACE_NAME = TBSPC.TABLESPACE_NAME) INNER JOIN (select distinct(autoextensible), tablespace_name from dba_data_files) EXT on (slc.tablespace_name = ext.tablespace_name) INNER JOIN (select tablespace_name , count(*) as no_of_data_files , sum(MAXBYTES)/(1024*1024)*count(*) as MAX_MB , sum(user_bytes)/(1024*1024) MB_USED , round((sum(user_bytes)/(1024*1024))/(sum(MAXBYTES)/(1024*1024))*100,2) PERCENT_USED from dba_data_files group by tablespace_name) SIZING ON (SLC.TABLESPACE_NAME = SIZING.TABLESPACE_NAME)
The following example shows the kind of results that the query returns:
OWNER TABLE_NAME TABLESPACE_NAME MB_NEEDED MB_FREE MAX_MB MB_USED AUTO-EXTENSIBLE CLARITY PRJ_BLB_SLICES USERS_LARGE 1306 5020 90000 15997 YES
 
If AUTOEXTENSIBLE is YES:
 
The tablespace for PRJ_BLB_SLICES can grow automatically up to the MAX_MB value. Ensure that the MAX_MB value is higher than the MB_NEEDED + MB_USED.
 
If AUTOEXTENSIBLE is NO:
 
Ensure that the MB_NEEDED value is less than MB_FREE. If the MB_NEEDED value is not lower, the database administrator can allocate or extend extra data files to the tablespace under the TABLESPACE_NAME column.
 We recommend increasing the tablespace at least 20 percent more than is needed. The increase helps to ensure that the tablespace can accommodate standard data growth and the temporary replication.
(On-Premise only)
 Pre-Upgrade: Custom Processes, Scripts, and Other Customizations
The product cannot upgrade any unsupported customized content. Customizations must be disabled and may need to be redesigned and re-implemented to work with changing product functionality.
! After an upgrade, unless you disabled them, your customizations might result in errors or fail to work as expected.
 
Follow these steps
:
  1. Identify your custom content. For example, you have one or more custom processes with custom GEL scripts that modified timesheet status attributes in a previous release.
  2. Acknowledge the customizations and recognize that the upgrade scripts might not support the custom content. Even if the custom content is upgraded, it may no longer work as expected. For example, your custom process references an object or attribute that has changed in the new release.
  3. As an on-premise administrator, the checkinstall script provides a warning for customizations that it detects pre-upgrade. As an on-demand administrator, you do not see these warnings or the referenced logs. To assist all administrators, we show the message in full to provide insight into the types of customizations that can negatively impact your upgrade experience:
     
    WARNING
    : Possible schema customizations have been found. Any customizations to the system are the responsibility of the customer to maintain and are not supported by CA Technologies. To upgrade successfully, all customizations must be reviewed, changed, or removed as needed before the upgrade. After a successful upgrade, the customizations may be added back to the system. The possible customizations found are listed in the following log files:
    check‐logs/database_customization_triggers.txt
    check‐logs/database_customization_indexes.txt
    check‐logs/database_customization_tables.txt
    checklogs/database_customization_constraints.txt
  4. Turn off the customizations before the upgrade. After the upgrade, reintroduce the customizations and test them in the Classic PPM interface. Optionally, verify the impact of the customization behavior on the 
    New User Experience
    . In addition to database objects, also evaluate attribute values.
  • Some customers have experienced errors with legacy custom content. After disabling the custom process, script, or other legacy custom content, the 
    New User Experience
     provided the functionality with no net loss to end users. We recommend that you perform an analysis comparing the value of CA PPM features in a complete COTS/SaaS solution against the value of developing your own unsupported customizations.
  • The upgrade script reveals all potential customizations. You must remove the customizations that you created. The rest you can leave as is. CA Support recommends that you remove all known customizations. Sometimes you might be lucky and experience no upgrade issues if you leave your customizations. However, for a better upgrade experience without these potential customization issues, it is best to remove them and re-introduce them gradually post-upgrade.
(On-Premise only)
 Pre-Upgrade: Preserve Your File Directory Customizations
During the upgrade, you are prompted for the target installation directory. New pre-upgrade and post-upgrade steps let you copy files to and from the 
Clarity PPM
 directory using ant-based scripting. Use ant scripts to automate preserving and restoring customization in the 
Clarity PPM
 directories.
Templates are provided in release-specific upgrade folders that are located in the installer root directory (at the same level as the install.bat file). The templates are: 
preprocess-upgrade.xml
 and 
postprocess-upgrade.xml
.
 
Example of preprocess-upgrade.xml script
 
<project name="content" default="upgrade" basedir="."> <target name="upgrade"> <echo>Preserving customer specified files prior to upgrade from install.dir = ${install.dir}</echo> <if fileexists="${install.dir}" not="true"> <fail>Install dir not specified = ${install.dir}</fail> </if> <delete dir="upgrade_temp"/> <mkdir dir="upgrade_temp" /> <!-- Uncomment the copy below and list the files to be included for preservation --> <!--<copy todir="upgrade_temp"> <fileset dir="${install.dir}" > <include name="myfiles/my*.*"/> <include name="abb/*01.jar"/> <include name="a*01.jar"/> </fileset> </copy>--> </target> </project>
 
Example of postprocess-upgrade.xml script
 
<project name="content" default="upgrade" basedir="."> <target name="upgrade"> <echo>Restoring customer specified files after upgrade to install.dir = ${install.target.dir}</echo> <if fileexists="${install.target.dir}" not="true"> <fail>Install dir not specified = ${install.target.dir}</fail> </if> <!-- Uncomment the copy task below and list the files to be restored that were preserved in the preprocess-upgrade.xml script.--> <!--<copy todir="${install.target.dir}"> <fileset dir="upgrade_temp" > <include name="myfiles/my*.*"/> <include name="abb/*01.jar"/> <include name="a*01.jar"/> </fileset> </copy>--> </target> </project>
(On-Premise only)
 Upgrade an Apache Tomcat Single Server
 
Follow these steps:
 
  1. Stop and remove all services. Run the following commands:
    service stop app bg nsa beacon service remove app bg nsa beacon
  2. Set up the application server by installing or upgrading needed third-party software. See 
    Configure the Tomcat Application Server
     in Install Clarity PPM.
  3. From the command prompt, navigate to the directory where you want to unpack the 
    Clarity PPM
     installer file.
  4. Run the following commands: 
    mkdir temp cd temp
  5. Run the following command to extract install.jar from the installation media:
    jar -xvf <path of the installation media>/install.jar
  6. Run the installation script:
    UNIX
     
    chmod +x ./install.sh sh ./install.sh
     
    Windows
     
    install.bat
  7. If your upgrade spans two or more releases, the installer can store the most recent single version of the database as a convenient backup for you. The file names for the backups are:
    upgrade_backup_app.dmp
    upgrade_backup_dwh.dmp
    These files are available on the database server at the location you specify in the prompts. Application binary backups are also saved with the release version as the suffix. For example, your install directory is 
    C:\clarity
     and the version is 
    14.4.0.234
    . During the upgrade process, this binary backup is named 
    C:\clarity_14.4.0.234
    .
  8. (Optional) If the automated backup fails, the upgrade is not interrupted and continues. However, you can also elect to resume from the last successful backup. In order to have a successful restore process, obtain information from the install.log file. On a successful backup, the log file shows:
    7/25/17 10:18 AM (Echo) Application Database version 15.7.0 was backed up successfully.
    7/25/17 10:20 AM (Echo) DataWarehouse Database version 15.7.0 was backed up successfully.
  9. To troubleshoot backup failure for reasons beyond the installer such as network interruption, the following entries appear in the log file:
    7/25/17 10:32 AM (Echo) DataWarehouse Database version 15.7.0 backup failed.
  10. To complete the command-line upgrade, follow the prompts. 
  11. During the upgrade, default values from the existing 
    Clarity PPM
     installation are automatically entered as responses to the prompts.
    See the following list for upgrade property descriptions:
    •  
       
      Clarity PPM
       Home Directory: 
      Specifies the directory in which to install 
      Clarity PPM
      . This directory is created if it does not exist.
    •  
       
      Clarity PPM
       Target Directory (upgrade only): 
      Specifies a new install directory for the upgrade process that is different from the current install directory. The default value is the current install directory.
    •  
      JDK Home Directory: 
      The Java JDK home directory.
    •  
      Beacon Multicast Address: 
      The multicast address that the Beacon and 
      Clarity PPM
       System Administration use for service discovery. Each 
      Clarity PPM
       cluster requires a unique IP address. The multicast address must be in the Class address range between 224.0.0.0 and 239.255.255.255. Each server within a cluster must use the same address and port. Default value: 230.0.0.1; we recommend an IP address in the 239.x.x.x subnet.
    •  
      Beacon Multicast Port: 
      The port that the Beacon and 
      Clarity PPM
       System Administration use for service discovery. Each 
      Clarity PPM
       cluster requires a unique IP address. Each server within a cluster must use the same address and port. Default value: 9090
    •  
      Beacon Client Port: 
      Defines the server port number that the Beacon service uses.
    •  
      Super User Command Prefix: 
      (UNIX only) The optional command prefix utility, such as sudo, to execute root-level commands. An example where you could implement a root-level command is when choosing a socket port below 1024 because root-level access is required to allocate it.
    •  
      Super User Name: 
      (UNIX only) The optional replacement for the 
      root superuser
       name. This name can be used alone or with the superuser command prefix. For example, if used with sudo, specify the user to which sudo rights are given here.
    •  
      J2EE Server Vendor: 
      Specify the J2EE server vendor: Apache Tomcat (default).
    •  
      Install 
      Clarity PPM
       System Administration (CSA) Locally 
      (Apache Tomcat only) If you are installing 
      Clarity PPM
       System Administration on this server, enter 
      true
      . Otherwise, enter 
      false
      .
    •  
      Tomcat 8 Home Directory: 
      (Apache Tomcat only) Defines the Apache Tomcat home directory.
    •  
      CSA Web Port: 
      (Apache Tomcat only) Defines the web port number that 
      Clarity PPM
       System Administration uses. For a UNIX system, this value must be greater than 1024, or the service must be run as root.
    •  
      Enter password: 
      (Apache Tomcat only) Specifies the 
      Clarity PPM
       System Administration password. Default value: admin
    •  
      Operator User Name: 
      Specifies the user name of the operator who is running the installation script. This information is kept as a record in the installation log.
    •  
      Operator Email Address: 
      Specifies the email address of the operator who is running the installation script. This information is kept as a record in the installation log.
    •  
      Acknowledge reviewing Install Guide and Change Impact & Upgrade Guide: 
      This prompt records a response from installing users that they have read both 
      Installing and Upgrading
       and 
      Change Impact and Upgrade.
       
  12. Start the 
    Clarity PPM
     System Administration application.
  13. Update the properties of the server:
  14. In the left navigation panel, click Servers and select the server.
    The Properties tab for the server appears.
  15. Click each subtab on the Properties tab and complete the fields necessary for your configuration.
     For complete information about all of the fields on the subtabs, see 
     
    Clarity PPM
     System Administration (CSA) Server Properties
    .
  16. Start all services.
  17. Click All Services.
  18. Select the services and Click Start.
  19. To verify that 
    Clarity PPM
     is accessible from a browser, connect using the configured Entry URL value. The Entry URL is configured in 
    Clarity PPM
     System Administration on the Application subtab. If you have multiple application servers, the Entry URL points to the load balancer. If you have a single-server installation, the Entry URL points to the application server. The Entry URL has the following format:
    http://<server name>:<port>/niku/nu
    The default user ID and password are admin/admin. If the default HTTP port value of 80 is used, you do not have to specify the <port> value.
(On-Premise only)
 Upgrade an Apache Tomcat Clustered Server
 
Follow these steps:
 
  1. Remove all services in the cluster.
  2. Set up all servers by installing or upgrading needed third-party software. See 
    Configure the Tomcat Application Server
     in Install Clarity PPM.
  3. Open a command prompt on the server, and navigate to the directory where you want to unpack the 
    Clarity PPM
     installer file.
  4. Run the following commands:
    mkdir temp cd temp
  5. From the directory, run the jar command to extract install.jar from the installation media:
    jar -xvf <path of the installation media>/install.jar
  6. Run the installation script:
    UNIX
     
    chmod +x ./install.sh sh ./install.sh
     
    Windows
     
    install.bat
  7. To complete the command-line upgrade, follow the prompts. During the upgrade, default values from the existing 
    Clarity PPM
     installation are automatically entered as responses to the prompts.
    See the following list for upgrade property descriptions:
    •  
       
      Clarity PPM
       Home Directory
      Specifies the directory in which to install 
      Clarity PPM
      . This directory is created if it does not exist.
    •  
       
      Clarity PPM
       Target Directory (upgrade only)
      Specifies a new install directory for the upgrade process that is different from the current install directory. The default value is the current install directory.
    •  
      JDK Home Directory
      The Java JDK home directory.
    •  
      Beacon Multicast Address
      The multicast address that the Beacon and 
      Clarity PPM
       System Administration use for service discovery. Each 
      Clarity PPM
       cluster requires a unique IP address. The multicast address must be in the Class address range between 224.0.0.0 and 239.255.255.255. Each server within a cluster must use the same address and port.
      Default value: 230.0.0.1
      We recommend an IP address in the 239.x.x.x subnet.
    •  
      Beacon Multicast Port
      The port that the Beacon and 
      Clarity PPM
       System Administration use for service discovery. Each 
      Clarity PPM
       cluster requires a unique IP address. Each server within a cluster must use the same address and port.
      Default value: 9090
    •  
      Beacon Client Port
      Defines the server port number that the Beacon service uses.
    •  
      Super User Command Prefix
      (UNIX only) The optional command prefix utility, such as sudo, to execute root-level commands. An example where you could implement a root-level command is when choosing a socket port below 1024 because root-level access is required to allocate it.
    •  
      Super User Name
      (UNIX only) The optional replacement for the 
      root superuser
       name. This name can be used alone or with the superuser command prefix. For example, if used with sudo, specify the user to which sudo rights are given here.
    •  
      J2EE Server Vendor
      Specify the J2EE server vendor: Apache Tomcat (default).
    •  
      Install Clarity System Administration (CSA) Locally
      If you are installing 
      Clarity PPM
       System Administration on this server, enter 
      true
      . Otherwise, enter 
      false
      .
    •  
      Tomcat 8 Home Directory
      (Apache Tomcat only) Defines the Apache Tomcat home directory.
    •  
      CSA Web Port
      (Apache Tomcat only) Defines the web port number that 
      Clarity PPM
       System Administration uses. For a UNIX system, this value must be greater than 1024; otherwise, the service must be run as root.
    •  
      Enter password
      (Apache Tomcat only) Specifies the 
      Clarity PPM
       System Administration password.
      Default value: admin
    •  
      Operator User Name
      Specifies the user name of the operator who is running the installation script. This information is kept as a record in the installation log.
    •  
      Operator Email Address
      Specifies the email address of the operator who is running the installation script. This information is kept as a record in the installation log.
    •  
      Acknowledge reviewing Install Guide and Change Impact & Upgrade Guide
      This prompt records a response from installing users that they have read both 
      Installing and Upgrading
       and 
      Change Impact and Upgrade.
       
  8. Start the 
    Clarity PPM
     System Administration (CSA) application.
  9. Update the properties for each server in the cluster.
  10. In the left navigation panel, click Servers and select the server.
    The Properties tab for the server appears.
  11. Click each subtab that is listed on the Properties tab and complete the fields necessary for your configuration.
     For complete information about all of the fields that are found on the subtabs, see CSA: Clarity PPM System Administration.
  12. Verify that the database is accessible.
    To verify, open the Database subtab for a server and in the Internal Connection section verify that the status is Available.
  13. Start the Beacon service on all servers in the cluster.
    The Beacon service is required to distribute the upgraded content remotely to servers in the cluster.
  14. In the left navigation pane, select Distribute All.
     The Distribute All process is typically used to upgrade other servers in a cluster. However, if you are upgrading to 
    Clarity PPM
     from a version earlier than Release 8.1.1, you are required to upgrade each server individually.
     Use the following steps if you are upgrading from a release earlier than Release 8.1.1:
  15. Use FTP or otherwise transfer the install.jar file to the other servers in your distributed installation.
  16. Stop the local Beacon service before installing the new package.
  17. Install on each server using the install.jar file.
  18. Restart the Beacon service when all servers are installed.
  19. When the Distribute All command completes, complete these steps:
  20. Stop the Beacon service.
  21. Manually copy the following jar files from the administration server that runs 
    Clarity PPM
     System Administration to all the remaining servers in the cluster. The jar files replace the existing files in the $CLARITY_HOME/bin AND $CLARITY_HOME/lib directories.
    <install_dir>/bin/wrapper.jar
    <install_dir>/lib/commons-logging.jar
    <install_dir>/lib/jgroups-all.jar
    <install_dir>/lib/log4j.jar
    <install_dir>/lib/nsa.jar
    <install_dir>/lib/union.jar
    This extra step avoids any issues that might arise from distributing while files are in use on the administration server.
  22. To verify that the installation steps completed successfully, click Installation Overview in the left navigation pane.
  23. Review the 
    Clarity PPM
     Administration server 
    admin.log
     file for general errors or custom Studio Query (NSQL) validation errors.
  24. Start all services.
  25. Click All Services.
  26. Select the services and Click Start.
  27. To verify that 
    Clarity PPM
     is accessible from a browser, connect using the configured 
    Entry URL 
    value.
    The Entry URL is configured in 
    Clarity PPM
     System Administration on the Application subtab. If you have multiple application servers, the Entry URL points to the load balancer. If you have a single-server installation, the Entry URL points to the application server.
    The Entry URL has the following format:
    http://<
    server name
    >/niku/nu
    The default user ID and password are admin/admin.
(On-Premise only)
 Recover and Restore from a Backup
Recovery/restore requires a few checks to be done. The file install.log provides information on where the upgrade failed. In order to restore from the last successful backup (both application and database), follow these steps:
  1. Find the last successful backup message as indicated above.
  2. Look for the corresponding application binaries. For example, c:\clarity_14.4.0.234
  3. Delete the current installation directory.
  4. Rename the identified application binary to the install directory. For example, c:\clarity_14.4.0.234 renamed to c:\clarity
  5. After the application binary has been restored, proceed to restore the database. The process is similar to how a fresh install is initialized:
    1. Create the database user.
    2. Grant permissions (including new ones for db export).
    3. Restore the database from the backup created by the upgrade script.
(On-Premise only)
 Troubleshoot Upgrade Problems
Recover from Upgrade Failure
  • When upgrading PPM, if an intermediate install is 14.2, then the attribute "home" for the element "applicationServer" is set to tomcat 8. If the upgrade install fails on 14.2 then on restoring it make sure to modify the entry to tomcat 7 home directory location.
  • After restoring a database, make sure to reset the password as specified in properties.xml and provide privileges as mentioned above.
  • Ensure that services (beacon, nsa) are added and deployed. It is not important that they are running and should be shut down if running (except db).
(On-Premise and SaaS)
 Complete the Post-Upgrade Steps
Post-Upgrade: Optimize Oracle 12c Performance
On local installations of Oracle 12c R1 or R2, you might detect a regression issue with Oracle 12c when ORDERED hint is used in structured queries. An Oracle bug in 12c R2 can degrade performance if the optimizer is set to 12.2.0.1.
  • For systems using Oracle 12c R1 (12.1.0.2), no further action is required.
  • For systems using Oracle 12c R2 (12.2.0.1), you can optimize performance by setting the optimizer to 12.1.0.2. We recommend applying this optional local fix.
 
Follow these steps
  1. From a command prompt in Oracle, enter the following lines:
    sqlplus / as sysdba ALTER SYSTEM SET "_fix_control" = '17800514:0'; Exit;
  2. Run the following command:
    ALTER SYSTEM SET OPTIMIZER_FEATURES_ENABLE= '12.1.0.2' SCOPE=BOTH;
  3. Verify that your Oracle 12c R2 initialization file parameters appear similar to the following example:
    *._fix_control='17800514:0' *._optimizer_multi_table_outerjoin=FALSE *.audit_file_dest='/fs0/oracle/12201/12c/admin/niku/adump' *.audit_trail='DB' *.cluster_database=FALSE *.compatible='12.2.0.1' *.control_files='/fs0/oracle/12201/12c/oradata/niku/CONTROL01.CTL','/fs0/oracle/12201/12c/oradata/niku/CONTROL02.CTL' *.cursor_sharing='FORCE' *.db_block_size=8192 *.db_name='niku' *.diagnostic_dest='/fs0/oracle/12201/12c/admin/niku/udump' *.dispatchers='(PROTOCOL=TCP) (SERVICE=nikuXDB)' *.local_listener='LISTENER_NIKU' *.nls_comp='BINARY' *.nls_date_format='YYYY-MM-DD HH24:MI:SS' *.nls_language='AMERICAN' *.nls_sort='BINARY' *.nls_territory='AMERICA' *.open_cursors=1000 *.optimizer_adaptive_plans=false *.optimizer_adaptive_reporting_only=TRUE *.optimizer_adaptive_statistics=FALSE *.optimizer_features_enable='12.2.0.1' *.optimizer_inmemory_aware=FALSE *.pga_aggregate_target=4G *.processes=1000 *.remote_login_passwordfile='EXCLUSIVE' *.session_cached_cursors=1000 *.sessions=1536 *.sga_target=80G *.streams_pool_size=536870912 *.trace_enabled=TRUE *.undo_tablespace='UNDOTBS1'
(On-Premise and SaaS)
 Post-Upgrade: Trending Data Backups 
After the upgrade, if you use the new trending jobs to generate your own custom analytics data, we recommend that you make specific backups. A common troubleshooting technique for on-premise administrators involves dropping the data warehouse schema. If you have used that technique in the past or might in the future, exercise caution. Data warehouse data can be restored; however, without a backup, your custom trending data would be lost.
(On-Premise only)
 Post-Upgrade: Final Steps to Complete Your Upgrade
The following post-upgrade steps are required:
  1. Apply your upgraded add-ins and connectors.
    1. Request a backup of your 
      Clarity PPM
       installation before installing each add-in so that you can restore the application if necessary. You can also use the previous night's regular backup as a restore point. Backups are retained for seven days unless a longer period is requested. A 30, 60, or 90-day retention is available on request.
    2. Apply the Upgrade Ready content for those items that you are actively using.
       Consider the configurations that you have made to items before applying them. Applying modified items overwrites your configurations.
       
      Best Practice
      : If you modified stock 
      Clarity PPM
       content, copy the modified content before upgrading. Then, apply the new incoming stock 
      Clarity PPM
       content, and retrofit the modifications to the new content.
    3. Read the 
      PMO Accelerator Release Notes
       for important information about what has changed for the PMO Accelerator.
    4. Review the 
      System: PPM Content
       add-in for upgrade ready content (for example, the Role Capacity portlet). To accept the upgraded content, apply the changes.
  2. Review the Studio views and system content and manually upgrade as needed.
    The upgrade preserves all pre-existing Studio view configurations. If an existing view has configurations or if the object for the view is partitioned, the system does not automatically upgrade the view and/or the partition.
    To determine which views were not automatically upgraded, use the Studio Views list page.
    Here are some tips on reviewing the views:
    1. The Last Version column identifies changes to stock views in this release.
    2. If a view was automatically upgraded as part of the upgrade process, a checkmark appears in the Upgraded column. No further action is required.
    3. If a view that changed in an earlier release was not upgraded due to pre-existing configurations, decide whether to apply the changed view.
      Look for views with the following column information:
      Last Version column=15.2 and the Upgraded column=unchecked.
  3. The XML Open Gateway (XOG) client requires the Java Runtime Environment (JRE) until CA PPM 15.5.1 which uses Java 11 and no longer requires the JRE. If you use the XOG client in 15.5 and previous releases, note that the JRE is no longer available from 
    Clarity PPM
    . Review the supporting documentation and training materials you provide to your users. Wherever these materials direct users to download the JRE from within 
    Clarity PPM
    , update the reference. Direct your users to download the JRE (Version 8) from www.java.com. For 15.5.1 and higher, no JRE is necessary.
  4. Register any Portfolio Investment attributes that you want to display in portfolio pages. Although the required attributes display by default, you must register any other attributes (stock or custom) that you want to display.
  5. If you use a custom statistics job, refer to the updated Oracle Table Analyze Job procedure in the 
    Clarity PPM
     schema (CMN_JOB_ANALYZE_SP) and make necessary corrections in the custom statistics job.
  6. Your users can run the Schedule Connect clients, Microsoft Project (MSP), Open Workbench (OWB), and the XOG client. Use the Compatibilities section of the Release Notes to verify a compatible version of MSP and OWB. Do not automatically update MSP and OWB. Verify the version first to ensure compatibility. In addition, each user should install the newest version of the XOG client that ships with CA PPM. The XOG client is not required to use MSP and OWB.
 Review all of the following steps after installing a patch to verify any changes in functionality.
  • If you are upgrading with XDM, ensure that the XDM is distributed to other servers in the cluster.
  • Run the Oracle Table Analyze Job from 
    Clarity PPM
     after the upgrade is done to gather schema statistics. The expected time for this job to complete depends on the size of the database. We recommend that you run this job right after the upgrade and at off peak hours thereafter. If you use a custom statistics job, refer to the updated Oracle Table Analyze Job procedure in the 
    Clarity PPM
     schema in Release 14.2 (CMN_JOB_ANALYZE_SP) and make necessary corrections in the custom statistics job. Gather the schema statistics by running the Oracle Analyze job at the end of the upgrade. Verify the performance metrics. During the upgrade, performance metrics are collected and the following files are written to the Logs folder:
      • ScriptMetrics.xml
      • Bootstrap.xml
      The files contain the following information:
      • A list of all upgrade scripts executed
      • The row count of every table that is processed by preupgrade and postupgrade processing
      • The execution time and results for each script or object
  • To help ensure the correct functionality and accuracy of data in 
    Clarity PPM
     and all jobs, including the Load Data Warehouse Job, verify the following:
    1. The server time is the same (preferable, down to the second) on the 
      Clarity PPM
       application server, 
      Clarity PPM
       database server, and Data Warehouse database server.
    2. The timezone, date, and time is the same on the 
      Clarity PPM
       application server and database servers in the same environment. Do not have any differences. This synchronization is necessary because the Load Data Warehouse job imports data into the Data Warehouse database based on the last_updated_date field on the object's instances. If the date and time on the servers do not match, data may not be loaded into the Data Warehouse. For other jobs, if the date and time do not match, the job may not start. Or, the job may start later than expected, leading to inaccurate data.
  • Review the post upgrade report that the checkinstall utility generates. The files are zipped into an archive that has a timestamp-encoded name (for example, checkinstall-results_2018-12-17_16-48-31.zip). This file is located in the checkinstall/check-logs directory, and if possible, the file is copied into the <target runtime dir>/logs/checkinstall directory.
  • Verify that Beacon is always running to manage services and view logs.
  • Ask your functional experts to review your upgraded test system side-by-side with a working preupgrade system. 
    Tip
    : Use dual monitors for side-by-side comparison.
  • Review the 
    app-ca.log
     after the functional experts have used the test environment and look for new errors.
  • Review any customizations: Customer-added database triggers, custom indexes and constraints, any file system changes, and custom interfaces. Review anything that did not come out-of-the-box. Adjustments may be necessary for customizations to work with this release.
  • Review the system log file sizes. The log file size for all service system log files is set to 5 MB and to keep five rolling logs (for example, app-system.log, app-system.log.1).
  • GEL Tag Restrictions: Release 13.1 gave the ability to restrict certain GEL tags in an environment. See Upgrade Considerations for Release 13.1.
  • Register any Portfolio Investment attributes that you want to display in portfolio pages. Although the required attributes display by default, you must register any other attributes (stock or custom) that you want to display. Remove the 
    Resource - Edit Financial
     access right.
  • If your company policy does not allow resource managers access to the Financial Properties subpage for the resources they manage, you can remove that capability.
  • Run a post installation script to perform the following actions:
    1. Remove the 
      Resource - Edit Financial
       access right from all current resource managers.
    2. Clear the setting for the financial option that automatically grants the access right to new resource managers. To maintain existing behavior, this right is granted during the upgrade. This right replaces the automatic right that was removed as part of the Financially Enabled Roles feature.
    3. At the command line on the 
      Clarity PPM
       server, navigate to the <clarity_home>/bin directory. The directory contains the dbpatch script.
    4. Refer the knowledge base article here to disable the Resource - Edit Financial access right.
  • To verify that all components are installed and functioning after an upgrade, run the Health Report.
(On-Premise and SaaS)
 Post-Upgrade: Verify NSQL Queries
During the post-upgrade process, the CheckInstall utility automatically runs the NSQL validator script to verify your NSQL queries. The validator writes the results to the admin.log file in the check-results.html file inside the checkinstall-results.zip file.
Look for the following information in the log:
  • Query name
  • Query ID
  • Content Source
  • Query ID from CMN_NSQL_QUERIES of the query that failed validation
The following output represents a typical log file at this phase of the upgrade:
[04:15:25] : [exec] validateNSQL: [04:15:25] : [exec] Validating NSQL [04:15:25] : [exec] JVM args ignored when same JVM is used. [04:15:25] : [exec] Working directory ignored when same JVM is used. [04:15:28] : [exec] Failed to instrument com.niku.union.utility.caching.CacheController [04:15:28] : [exec] Failed to initialize instrumentation: access denied ("javax.management.MBeanTrustPermission" "register") [04:15:30] : [exec] Validating 181 NSQL grid/graph queries... [04:15:47] : [exec] Error validating NSQL [04:15:47] : [exec] Query name=Schedule Performance : Query ID=cop.schedulePerformance : Content Source=csk.niku.com : cmn_nsql_queries.id=5018009 [04:15:47] : [exec] Query name=Upcoming Milestones : Query ID=cop.upcomingMilestones : Content Source=csk.niku.com : cmn_nsql_queries.id=5018010 [04:15:47] : [exec] Query name=Open Milestones : Query ID=cop.openMilestonesLinkable : Content Source=csk.niku.com : cmn_nsql_queries.id=5018032 [04:15:47] : [exec] Query name=Upcoming Key Tasks & Milestones : Query ID=asp.upcomingkeytasksmilestones : Content Source=customer : cmn_nsql_queries.id=5074025 [04:15:47] : [exec] You must correct invalid NSQL queries. In PPM Studio, go to the NSQL tab for each failing NSQL query. Click the 'Preview' button to view the error details. [04:15:47] : [exec] Total execution time: 0H:0M:18.796S [04:15:47] : [exec] perform-check: [04:15:47] : [exec] report-result: [04:15:47] : [exec] script name = check-invalid-nsql.xml [04:15:47] : [exec] check.result = WARNING [04:15:47] : [exec] _output-log-info: [04:15:48] : [exec] Trying to override old definition of task checkIfDWHInstalled
Database schema changes can also impact your custom portlets. See Oracle and MS SQL Database Schema Changes.
Correct any invalid custom NSQL queries. If a query is associated with a portlet, clear the 
Available for User Portlets
 check box on the query properties page to edit the query. You cannot edit system queries that are provided by 
Clarity PPM
.
 
Follow these steps:
 
  1. Click 
    Administration, Studio, Queries
    .
  2. Open each failing query and click the 
    NSQL
     tab.
  3. Clear the 
    Available for User Portlets
     check box.
  4. Click 
    Save and Continue
    .
  5. Review the errors and repair the broken query constructs or fields.
  6. Click the 
    Preview
     button.
  7. Confirm that the NSQL query is valid.
  8. Click the 
    General
     tab.
  9. Select the 
    Available for User Portlets
     checkbox.
  10. Click 
    Save and Return
    .
 If the query is in use by active portlets and cannot be edited in Studio, use the XML Open Gateway (XOG):
  1. Export the failing query.
  2. Correct the broken query constructs or fields.
  3. Use XOG to import the corrected query. Perform the steps above this tip to preview and verify the query.
Some NSQL queries are delivered with add-ins. Applying an update for an add-in makes fixes for the NSQL queries that pertain to the add-in available for an update on the server.