Clarity PPM 15.5.1 Change Impact and Upgrade

The Change, Impact, and Upgrade page highlights significant changes, required actions, known issues, and recommended options for customers upgrading from the previous release to cappm Release 15.5.1. Plan your cappm upgrade and determine the options that fit your business needs. Teams can also use this information to plan your new feature adoption, onboarding, and training efforts. 
ccppmop1551
The 
Change, Impact, and Upgrade 
page highlights significant changes, required actions, known issues, and recommended options for customers upgrading from the previous release to 
Clarity PPM
 Release 15.5.1. Plan your 
Clarity PPM
 upgrade and determine the options that fit your business needs. Teams can also use this information to plan your new feature adoption, onboarding, and training efforts. 
 Due to the different specs for Java 8 and Java 11, before you upgrade to 15.5.1 you must decide between two workaround strategies. See Java 11 below.
 
Before upgrading from an earlier release, review this Change Impact and Upgrade page for all subsequent releases.
 For example, you are upgrading from Release 14.4 to 15.5.1. Review the changes in releases 15.1, 15.2, 15.3, 15.4, 15.4.1, 15.5, and 15.5.1 before starting your upgrade. To switch to the 
Change Impact and Upgrade
 page for each release, click the 
Versions
 menu at the top of this page at docops.ca.com. Check back often for updated content, especially if you downloaded a PDF or EPUB file. The English edition of this documentation is periodically updated with new information including new examples, explanations, corrections, and patch information.
 
2
 
 
HID_HID_release_info_change_impact_od
 
HID_release_info_change_impact_op
Clarity PPM 15.7 Onward - OracleJDK will be replaced with AdoptOpenJDK
Java Image
Clarity PPM will discontinue product updates related to Oracle Java, beginning 
August 19, 2019
. This will allow our development team to focus on adding value to future product releases.CA Technologies, a Broadcom Company (CA), continues to support its products and stand by the terms and conditions set forth in the license agreements between CA Technologies and its customers. 
Existing customers may continue to run and use releases that include Oracle Java components in production and non-production environments
. However, to address any future Java security and vulnerability issues that may arise, it may be necessary for customers to install a service pack or upgrade to a newer release of Clarity PPM that supports AdoptOpenJDK.This change does not impact Jaspersoft, which will continue to support Java 8. 
To prepare for an upgrade to 
Clarity PPM
 Release 15.5.1, review the supported upgrade paths, features, enhancements, and required upgrade actions. The following information summarizes how the new changes introduced in this release impact your upgrade experience to 
Clarity PPM
 Release 15.5.1.
Clarity PPM 15.5.1 Changes: New User Experience Features
To-Do Item Owners and Due Dates
  • You can now define and edit a due date for to-do items. The due date for a to-do item must fall within the project date range.
  • You can also assign and update an owner for to-do items from the active resources, roles, or teams that are available to the parent task.
 
Upgrade Action
: No action is required. If to-do items existed in your previous release, they remain intact after upgrade. When you open to-do items in 15.5.1, the following new fields appear with no values:
  • OWNER
  • DUE DATE
You can update the empty fields with values in any 
open
 or 
completed
 to-do items.
Easy Access to Manage Local Picklists
Prior to this release, you had to click 
Settings
 and then click the drop-down menu for a local or global picklist to see the 
Manage
 option.
 
Upgrade Action
: No action is required. You can now easily manage your local picklists for a roadmap using either of the following methods:
  • Click the 
    EDIT
     link available from the COLUMNS panel on the Board layout. With 
    edit
     access to the roadmap, you can see an active 
    EDIT
     link for managing local picklists. The 
    EDIT
     link appears disabled for global picklists. If you have view-only access to the roadmap, the 
    EDIT
     link does not appear. 
  • Click the 
    MANAGE PICKLISTS
     link available in the 
    Settings
     panel on the timeline, board, and grid layouts (as shown in the image below). The resulting MANAGE PICKLISTS page allows you to create and edit your local picklists.
  image2018-12-7_10-53-40.png  
: Only the roadmap creator and other users with edit access rights to the roadmap can manage picklists. The 
EDIT
 and 
MANAGE PICKLISTS
 options do not appear if the user does not have access rights to edit the roadmap.
Include Custom Investment Objects in Roadmaps
A new 
Include in Roadmaps
 check box is available in Classic Clarity for your optional customer-defined investment types.
  image2018-12-7_9-1-45.png  
Clarity PPM 15.5 introduced support for custom investment types; however, no XOG support was available for the data for any instances of an investment type. The application did not disable the ability to import or export Studio views through XOG; however, the application disabled the ability to display views in Classic and configure views in Studio for new investment types. Therefore, XOG import and export of views has no impact on investment type functionality.
In 15.5.1, you can create new investment types through XOG and view the new 
Include in Roadmaps
 setting (selected by default) on the object properties page. The 
Include in Roadmaps
 attribute is available only for custom investment extension objects.
 
Upgrade Action
: No action is required. When you upgrade from 15.5.0 to 15.5.1, the 
Include In Roadmaps
 attribute for all Custom Investment objects is clear (enabled is set to 0). If you XOG out from a previous version and XOG in a custom investment object, the Include In Roadmaps option is also unchecked by default.
 
To include custom investment object instances in roadmaps perform the following steps after you upgrade:
 
  1. Create your custom investment objects in Classic PPM Studio.
  2. Create instances of custom investment types in the 
    New User Experience
    .
  3. On the 
    Object Properties
     page, in the 
    Object Extension
     field, select 
    Investment Extension
     and click 
    Save
    .
  4. The page refreshes to show a new 
    Include in Roadmaps
     check box. The option is selected by default (with one exception: if you upgrade from 15.5.0, the option is not selected as a default).
  5. To exclude instances of the custom investment object in roadmaps, clear the 
    Include in Roadmaps
     check box.
  6. To import one or more custom investment instances as roadmap items in a roadmap, open the roadmap grid, board, or timeline and select a single scenario, and then click 
    Import from PPM
    .
Link and Synchronize Custom Investments
  image2018-12-7_9-23-25.png  
 
Upgrade Action
: No action is required.
To link and synchronize custom investments as roadmap items, perform the following steps after you upgrade:
  1. Open a roadmap, select a scenario, and import custom investments.
  2. You can edit the association between the roadmap item and custom investment by selecting a value from the 
    Linked To
     field.
  3. Set the 
    Sync
     check box and observe the 
    Last Synced Date
     column.
  4. Click 
    Sync Linked Items
    .
Observe the following additional new behavior after your upgrade:
  • You can drill into the investment in the 
    Linked To
     column
  • Each row that contains an investment shows a new 
    Linked To Type
     so users know which type of custom investment or project is linked.
  • Be careful when synchronizing and switching scenarios since different attribute data can be overwritten.
: Screenshots on this page have been reduced to prevent clutter. To see more details, zoom-in to magnify your browser view or right-click an image and select 
Open image in new tab
.
Clarity PPM 15.5.1 Changes: Financial Features for Classic Clarity PPM Ideas
Internal Rate of Return (IRR) Adjustment
In previous releases, the Planned IRR for ideas was not calculating a value and was blank in certain scenarios where costs preceeded benefits by about one year. The behavior was limited to detailed plans for ideas; simple plans did successfully calculate IRR.
  IRR_fix.png  
 
Upgrade Action
: No action is required; however, we recommend that you examine your ideas in Classic PPM. Previously blank values for Planned IRR might now calculate a value as a result of this adjustment in 15.5.1.
: If no positive (or negative) cash flow exists, IRR is left blank. To learn more, see the following links:
Clarity PPM 15.5.1 Changes: Administrative Features
Delete Investments with Timesheets or WIP Transactions
In prior releases, attempting to mark projects for deletion would result in an error message if the projects had posted actuals. To delete investments with posted timesheets or WIP transaction data, you had to perform the following steps:
  1. Run the Purge Financial Transactions job for the investment to remove the financial transactions.
  2. Delete the time reporting periods that cover the range of actual time entries for the investment.
Those steps deleted 
all
 timesheets in the selected reporting periods and affected timesheet entries for other investments that spanned the same time periods. In this release, you can target the deletion of 
specific
 investments without affecting the posted timesheet entries for other active investments.
You are no longer required to delete the entire time reporting period. This feature includes the following new options (by default, both options are not activated):
  • A new 
    Allow Marked Investments with Timesheet and Transaction Data to be Deleted
     system option. 
  • A new 
    Delete Marked Investments with Timesheet and Transaction Data
     parameter when running the Delete Investments and Time Reporting Periods job.
: The 
Delete Investments
 job in previous releases is renamed 
Delete Investments and Time Reporting Periods 
in 15.5.1.
This feature also includes the removal of investments and time entries associated with incidents in the Classic PPM Demand Management functionality.
 
Upgrade Action: 
No action is required; however, if you decide to use this new feature to delete investments with timesheet or transaction data, follow these steps (we show the steps for projects; however, you can also perform similar steps for other non-project investments):
  1. Before you upgrade:
    1. Review the access right assignments for the Job Run access on your existing Delete Investments job.
    2. Make a note of the existing job schedules.
    3. Remove all scheduled instances of the job.
  2. After you upgrade to the new release, log in to Classic PPM.
  3. Click 
    Administration
    Reports and Jobs
    . Review and modify access to the Delete Investments and Time Reporting Periods job for all users.
    : As an administrator, restrict who can run this job because it can result in the deletion of data that may need to be reviewed. We recommend that access to the job be granted only to users who are responsible for reviewing the time reporting periods marked for deletion and for reviewing the investments that are marked for deletion.
  4. Click 
    Administration
    Project Management
    Settings
    .
  5. Select the 
    Allow Marked Investments with Timesheet and Transaction Data to be Deleted
     check box.
  6. Click 
    Home
    Portfolio Management
    Projects
    . Open a project with known actuals and timesheet data.
  7. Click 
    Properties
    Settings
    . In the 
    General
     section, clear the 
    Active
     check box and save your changes. Before you can delete projects and investments, you are required to make their status 
    inactive
    .
  8. Click 
    Home
    Portfolio Management
    Projects
    . Select one or more check boxes for projects in the list and click 
    Mark for Deletion
    .
  9. (Optional) Click 
    Administration
    Project Management
    Time Reporting Periods
    . Select the check boxes for one or more reporting periods and click 
    Mark for Deletion
    .
  10. Click 
    Home
    Reports and Jobs
    . Click the 
    Jobs
     tab.
  11. Open the 
    Delete Investments and Time Reporting Periods
     job.
  12. In the 
    Parameters
     section, select the 
    Delete Marked Investments with Timesheet and Transaction Data
     check box.
  13. Run or schedule the 
    Delete Investments and Time Reporting Periods
     job.
: When you delete a project or investment, the application removes any investment-specific charge codes from the database (PRCHARGECODE table). Any rate matrix rows that used the investment-specific charge code are also removed.
View Time Reporting Periods Marked for Deletion
This release helps users identify which closed time reporting periods are marked for deletion. As an administrator, review the new 
Marked for Deletion
 column on the Time Reporting Periods page before running the Delete Investments and Time Reporting Periods job.
 
Upgrade Action
: No action is required. To review the changes introduced by this enhancement, follow these steps:
  1. Click 
    Administration
    Project Management
    Time Reporting Periods
    .
  2. Select the check boxes for one or more closed reporting periods and click 
    Mark for Deletion
    .
  3. Review the new 
    Marked for Deletion
     column. A yellow check mark appears for rows that were selected for deletion.
  4. (Optional) You can also filter time reporting periods with the new 
    Marked for Deletion
     filter field.
API-Enable Custom Subobjects for the New User Experience
You can now API-enable custom subobjects of the Project object. You can then add these sub objects as modules to a project blueprint. When you create a new project using the blueprint, the sub object appears as a tab with a grid containing the selected attributes.
 
Upgrade Action
: No action is required. To display the subobjects that were defined prior to this release in the project pages of the 
New User Experience
, complete the following steps:
  1. In Classic PPM Studio, API-enable the subobjects.
  2. Provide API Attribute IDs for the subobject attributes.
  3. In the new UX, configure a project blueprint to include the sub objects as modules.
  4. Publish the blueprint.
  5. Create a project using the blueprint.
  6. Verify that the subobjects appear as tabs on the project.
New 25,000-Row GEL Governor Limit in CSV Files
In 15.5.1, the same limit for Excel is enforced for CSV with MAX_CSV_GEL_ROWS=25000.
: Until you upgrade to 15.5.1, avoid creating GEL scripts that attempt to read, run, or append records in very large CSV files. Out-of-memory errors and application outages can occur. 
 
Upgrade Action
: No action is required. If you had GEL scripts in a previous release that were causing issues, the new limit prevents application outages from related out-of-memory errors associated with attempting to read a large CSV file in a GEL script. Make adjustments to your existing GEL scripts to limit the number of rows being read from a CSV file to 25,000.
Governor Limits are available on the 
Application
 tab of the Health Report. The label changed from 
GEL ROWS
 to 
SQL GEL ROWS
 and 
CSV GEL ROWS
 was added to control the number of rows read from a CSV file.
  DE42793-CSV-ROWS.png  
Do not confuse the CSV limit with the SQL limit, which remains at 100,000 rows (MAX_SQL_GEL_ROWS=100000).
New 
processFileLines
 GEL Tag
This tag allows you to read one record at a time from a file. Without this tag, previous releases required reading the whole file at once and then iterating through the file.
 
Upgrade Action
: No action is required.
 
Example
:
 
<f:processFileLines fileName="${logdir}${logfile}" delimiter=" " indexVar="d" embedded="false" var="logfilerow">
  <!-- do steps/activities here -->
</f:processFileLines>
 
New CSA Properties for LDAP
 
(Available Only in On-Premise Editions of Clarity PPM with Patch 15.5.1.1 or higher)
 
In previous releases, the LDAP - Synchronize Obsolete Users job could run over multiple days without completion. Your business users accessing reports and other users in your LDAP were not fully synchronized with CA PPM. To enhance performance when adding, removing, or deactivating users from 
Clarity PPM
 based on LDAP group membership, on-premise editions of this release include two new options in Clarity System Administration (CSA):
  • Use Group Memberships
  • Group Identifier on User
 
Upgrade Action
: No action is required; however, after installing the 15.5.1.1 patch, on-premise administrators can apply two new options for synchronizing users between 
Clarity PPM
 and their LDAP:
  •  
    Use Group Memberships: 
    When you select this option, the LDAP - Synchronize Obsolete Users job uses the value of the new 
    Group Identifier on Users 
    option to perform the synchronization, improving performance.
  •  
    Group Identifier on Users
    : This new field allows you to specify a different reverse relationship from users to groups in your active directory. The value of this field is used only if you select 
    Use Group Memberships
    . The default value is 
    memberOf
    .
  20181219-CSA-LDAP.jpg  
Clarity PPM 15.5.1 Changes: Jaspersoft 7.1
Jaspersoft 7.1 Upgrade
 
Upgrade Action
: After upgrading to 15.5.1, SaaS customers are already at 7.1. On-premise customers should begin upgrade plans to take advantage of new features and enhancements in 7.1 and to migrate away from the known issues associated with Jaspersoft 6.4.2.
When upgrading, observe the following changes:
  •  
    Ehcache
    : The same Ehcache.XML file used with 6.4.2 can be applied to 7.1 (required in clustered environments).
  •  
    Jaspersoft Studio Pro
    : Redo the connections with Jaspersoft Studio Pro and the optional CA JDBC Adapter for Advanced Reporting.
  •  
    Changes to the Login Page
    : The layout of the reportservice login page changed in JasperReports Server 7.1. The CSS classes did not change; however, some default values were modified. If you customized the login page, verify that your customizations behave correctly in 7.1, and make any necessary changes. If you have not customized the Login page, this change does not affect you.
  •  
    Pipe | Character
    : Jaspersoft examples in documentation no longer include the pipe character ( | ) because new versions of tomcat do not support it.
  •  
    Tomcat Version
    : Tomcat 8.5.30 is strongly recommended due to performance issues with 8.5.31.
Jaspersoft 7.1 Missing Attribute Removal
  image2018-12-7_10-4-42.png  
 
Upgrade Action
: After upgrading to 15.5.1 and Jaspersoft 7.1, customers also automatically receive the following enhancement. When attributes are removed in CA PPM, downstream Jaspersoft views and reports prompt you with the option to remove the attributes.
 
To observe the new behavior, perform the following steps
:
  1. Log in to CA PPM and navigate to Classic PPM Studio.
  2. Create a custom attribute for a project.
  3. Run the Load Data Warehouse job to populate the changes for the new custom attribute in the data warehouse.
  4. In 
    Advanced Reporting
    , create an adhoc view with the new custom attribute and save the adhoc view as a report.
  5. After some time, a user might delete the custom attribute from a project. When the Load Data Warehouse job runs, the attribute no longer appears in the data warehouse.
  6. In previous releases of Jaspersoft including 6.4.2, users see an error message when they attempt to open the ad hoc view or report with the missing attribute. The report developer would have to remove the attribute.
  7. In Jaspersoft 7.1, a new 
    Missing Data
     window appears and shows the missing attributes.
  8. To remove the attributes from the ad hoc views and reports at the data source, click 
    Remove Items
    .
: For 15.5.1 and higher, run your Clarity PPM app, bg, CSA, and beacon using Java 11 and run Jaspersoft using Java 8.
Clarity PPM 15.5.1 Changes: Java 11 Impacts on Clarity PPM Upgrades
Java 11 Impacts on Clarity Upgrades from Earlier Releases
A known issue with the installer and requirements to shift from Java 8 to 11 interrupt the typical upgrade process.
 
Upgrade Action
: Before upgrading, choose one of the following two workaround strategies: A or B.
Workaround A: Two-Step Upgrade
Upgrade to 15.5.0, install Java 11, and apply 15.5.1
 
Workaround B: Modified Direct Upgrade
Specify Java 8 location using a release-install.properties file
 
Workaround A: Two-Step Upgrade
In this workaround option, you upgrade in two steps:
  1. Go to CA Support and download the ISO image for the CA PPM 15.5.0 installer.
  2. Create an installation DVD or mount the ISO.
  3. Upgrade to 15.5.0 while you still have Java 8.
  4. Install Java 11 and remove Java 8.
  5. Go to CA Support and download the ISO for the CA PPM 15.5.1 installer.
  6. Create an installation DVD or mount the ISO.
  7. Run the 15.5.1 upgrade installer.
    Because you now have Java 11 and not Java 8, the upgrade is successful.
Workaround B: Modified Direct Upgrade
In this workaround option, specify the location of JDK 8 for the release-level upgrade incremental steps or 
hops
 to use by preparing a 
release-install.properties
 file in a convenient location on the same server you are upgrading.
  1. Create a 
    release-install.properties
     file. Each release hop can use a set of properties during the upgrade. In this case, you specify the location of JDK 8.
  2. Add the following line:
     java_home=<full path to JDK 8 root folder>
    Windows Example
    : In this example, JDK 8 is installed in the following location:
     C:\jdks\jdk1.8.0_171
    In your 
    release-install.properties
     file, enter the following line with escaped path separators:
     
     java_home=c:\\jdks\\jdk1.8.0_171
    Linux Example
    :
     java_home=/Library/Java/JavaVirtualMachines/jdk1.8.0_171.jdk/Contents/Home
  3. Save the file.
  4. Start the 15.5.1 upgrade installer script.
  5. When prompted, provide the location of the 
    Third-Party Libraries JAR Directory
    .
    For example, if you are upgrading from 15.4 to 15.5.1, the following entries in the command prompt window might appear:
    Third Party Libraries Jar Directory [c:] : c:\deploy\tplib You chose the following: thirdparty.libs.jar.dir = c:\deploy\tplib Copying 1 file to c: Created dir: c:\deploy\tplibsdir Expanding: c:\deploy\thirdparty.libs.15.5.1.jar into c:\deploy\tplibsdir Current version: 15.4.0.270 Upgrading to:15.5.1.240 Expanding: c:\deploy\install-packages\15.4.1\upgrade-repack.15.4.1.115tpexcludes.jar into c:\deploy\install-packages\15.4.1\upgrade-repack.15.4.1.115tpexcludes Expanding: c:\deploy\install-packages\15.5.0\upgrade-repack.15.5.0.225tpexcludes.jar into c:\deploy\install-packages\15.5.0\upgrade-repack.15.5.0.225tpexcludes
  6. Copy your 
    release-install properties
     file into each of the upgrade directories that were created through the expansion of the JAR files:
     
    c:\deploy\install-packages\15.4.1\upgrade-repack.15.4.1.115tpexcludes
    c:\deploy\install-packages\15.5.0\upgrade-repack.15.5.0.225tpexcludes 
     
  7. Resume the upgrade. The command prompt waits for user input to continue.
  8. When prompted for the 
    J2SDK Home Directory
    , enter the full path to the root of the JDK 11 installation.
    : If your upgrade has already been running and the folders in 
    upgrade-repack.xtpexcludes
     already extracted from the package, you may directly copy the 
    release-install.properties
     file without waiting for the install script to reach a certain stage. After the folders in 
    $install\install-packages\1x.x\upgrade-repack.1x.xtpexcludes
     are extracted, they remain and are reused by the installer.
Java 11 Impacts on Integrations with MSP, OWB, Schedule Connect, and XOG
This release requires Java 11. See also the JDK Support Timeline image below (subject to change).
 
Upgrade Action
: After upgrading to 15.5.1, upgrade your XOG, OWB, and Schedule Connect client applications. These clients now use native Java 11 code and no longer require a separate Java 8 JRE as they did in previous releases.
: The new JDK still has many of the same familiar administrative tools. They are now in the 
$JAVA_HOME/bin
 folder. To learn more, see https://docs.oracle.com/en/java/javase/11/tools/.
  image2018-11-19_17-37-54.png  
 
CA PPM 15.5.1 and Java 11
: Oracle provides the Java 8 platform that is shipped with prior releases of CA PPM and Java 11 that is shipped with 15.5.1. Oracle has announced end-of-public-support for the version of Java used by CA PPM 15.5.0 and earlier. Java 8 was provided with releases of CA PPM prior to 15.5.1 which now includes Java 11.
 
Customers may continue to run Java 8 in production and non-production CA PPM 15.5.0 and earlier environments after the Java 8 end-of-service date.
 However, after July 31, 2019, CA Technologies (a Broadcom Company) will no longer provide any fixes, patches, service packs, updates, upgrades, programmatic changes, new features, or coverage for updated or new operating systems, browsers, or any additional components for Java 8. CA Support may submit potential security and vulnerability issues to Oracle Support for possible remediation; however, customers will be required to get any remediation to such vulnerabilities directly from Oracle. Customers can continue to contact CA Support after July 31, 2019, for troubleshooting issues potentially related to Java 8 on an "as-is" basis if installed in conjunction with a still-supported CA product. If a workaround cannot be determined, the problem will be deemed "irresolvable." We encourage you to plan for migration to CA PPM 15.5.1 or higher as soon as possible, so you can take full advantage of the new features, enhancements, and components. CA PPM 15.5.1 and newer includes Java 11, the latest version of Java provided by Oracle. Please note that Java 11 does not work with and is not supported by CA PPM 15.5 or earlier releases.
 
No customer action is required to use Clarity PPM with Java 11
: Clarity PPM embeds Java under the terms of a commercial contract with Oracle. Because CA (a Broadcom Company) distributes this Java code to you as a customer of the Clarity PPM solution, you do not need your own separate contract for Clarity PPM Java compliance. However, as a customer developing your own software products, you might need your own commercial contract with Oracle or a Java provider. As a customer, you can continue to acquire a JDK from Oracle if you need for your own applications. Consult your team. Also note that, in the future, it is 
possible
 that Clarity PPM might begin using OpenJDK.
As a customer, you cannot use Clarity PPM releases, patches, or components for any other purpose than to update Clarity. For example, you cannot reverse engineer, copy, or otherwise apply Clarity deliverables to update your own internal use of Java.
Clarity 15.5.1 Changes: User Interface Updates in the 15.5.1.1 Patch
New! The Clarity PPM Brand is Back
With the acquisition of CA Technologies by Broadcom, the Clarity PPM product name, formerly rebranded as CA PPM, has been restored in the 15.5.1.1 patch. The product is now branded CA Clarity Project and Portfolio Management, CA Clarity PPM, or simply, Clarity PPM. 
 
Upgrade Action
: No action is required. 
: Historic references with mixed branding will continue to appear throughout the application and in the online documentation, community content, Support KB articles, videos, and other content.
  • Users can expect to see rebranded Login pages for Classic PPM and the 
    New User Experience
     and a new Clarity icon in their web browsers. 
  • The copyright notice on the Login and About pages has been changed from CA to Broadcom.
  • On Classic and New UX pages, the CA logo has been replaced by the new Clarity PPM logotype.
The following images provide examples of the branding changes. This image shows the 
before
 and 
after
 Classic and Modern UX Login pages:
  rebrand1.png  
This image shows the new application pages and About pages in Classic PPM and the 
New User Experience
:
  rebrand2.png  
New! Introducing the Phoenix UI Theme
The 15.5.1.1 patch also introduces a new 
Phoenix UI
 theme designed to invite Classic Clarity PPM users into the new aesthetics and styling of the Clarity Modern UX (formerly introduced with CA PPM 15.1 as the 
New User Experience
). See https://communities.ca.com/videos/7811-preview-of-new-clarity-ppm-phoenix-ui-theme.
 
Upgrade Action
: No action is required. To learn more about applying UI themes, see CA PPM Studio UI Themes in the Reference section of the documentation.
Clarity 15.5.1 Changes: PPM Integration with 
CA Agile Central
 
New Investment-Level Integrations with CA Agile Central (Rally)
Integration can be configured and managed in Clarity PPM; however, not in 
CA Agile Central
 ( icon_beta.png  that beta functionality is expected in Rally in late 2019). You can still leverage the integration between Clarity PPM and CA Agile Central (Rally) investments; however, the Rally user interface cannot support connecting an investment to a Clarity project.
 
Upgrade Action
: In an integrated environment, the Integration Type attribute appears. This attribute was introduced in 15.5.0 with one choice (
Portfolio Item
). In 15.5.1, you can also choose 
Investment
.
  image2018-11-20_17-40-30.png  
  1. An upgrade script for customers who use the Agile Add-in updates the 
    Integration Type
     attribute to 
    Portfolio Item
     in all agile projects.
  2. Post-upgrade, review your projects. You can now select a value for the new 
    Integration Type
     attribute. Choose 
    Investment
     or 
    Portfolio Item
    . The value you choose determines the appearance of the 
    Agile Summary
     page for the project.
  3. See the detailed steps in the Add-Ins and Integrations section of the English edition of this documentation.
  image2018-11-20_17-45-25.png  
: The 
Time Tracking Project Template
 field has been removed. The Synchronize Agile Central job ignores this attribute which had been used in previous releases.
Improvements to the Synchronize Agile Central Job
The 
Date Window
 parameter now includes options for filtering by projects that were updated in the last month or last quarter:
  • Projects updated in the last month (new)
  • Projects updated in the last 3 months (new)
  • Projects updated in the last 12 months
  • Projects updated in the last 24 months
You can also set the new 
Synchronize Projects where Work Status is Complete
 option. By default, this option is not selected.
 
Upgrade Action
: No action is required; however, these new options are available. Revisit your job settings.
  image2018-11-20_17-56-59.png  
Other Clarity PPM 15.5.1 Changes 
IPv6 Network Compatibility Restrictions
The following section applies only to on-premise environments.
CA PPM 15.5 is certified to operate in an IPv6 networking environment with restrictions. Other configurations of CA PPM using IPv6 are likely to work but have not been certified. For mixed environments with IPv6 and IPv4, the server instance uses two network interface cards, one configured for IPv6 and the other for IPv4. We performed our certification testing on an isolated private IPv6 environment that is not accessible to other networks.
During PPM installation in IPv6 environments, you are prompted for the correct multicast and bind address. The following entries provide examples:
 
IPv6 Mulitcast
: ff0e::75:75
 
bindAddress
=fe80::cb8b:3483:cddd:bca3
Red Hat Enterprise Linux Configurations with Oracle
We support mixed mode IPv6 installations of CA PPM, mail server, and Jaspersoft in Red Hat Enterprise Linux (RHEL) configurations with Oracle.
  •  
    RHEL OS Version
    : 7u5
  •  
    App Server
    : Apache Tomcat 8.5.33 (64-bit)
  •  
    Database
    : Oracle Enterprise Edition 12.2.0.1.0
  •  
    JasperReports Server
    : 7.1
IPv6 Notes and Known Issues
  • CA PPM supports pure IPv6 and mixed mode. Jaspersoft only supports mixed mode IPv6.
  • We have tested PPM on a private network where the mail server is not accessible. This is expected to work; however, it was not a tested component.
  • Components that connect to an external network outside of the isolated IPv6 environment were not tested. These components include an integrated mail server and integration with CA Agile Central. Not tested does not mean it does not work.
  • Due to issue DE38980, the 
    New User Experience
     does not work as expected when an IPv6 address is used in the URL.
    Workaround: Use Host Name instead of IPv6 address.
  • Due to an unknown issue, the Jaspersoft URL provided in CA PPM System Administration (CSA) does not work with IPv6 addresses.
    Workaround: Use Host Name instead of IPv6 address.
  • Due to issue DE38981, a problem with DBLINK does not allow you to save a data warehouse link when IPv6 is configured, resulting in a Load Data Warehouse job failure.
    Workaround: Connect to DWH-Database. CREATE DATABASE LINK PPMDBLINK CONNECT TO <schema> IDENTIFIED BY <password> USING '<user>';
Upgrades from CA PPM 15.3 to 15.5.1 on RHEL
We do not recommend attempts to integrate any IPv6 components into earlier releases and then upgrade to 15.5 or higher. IPv6 was not supported in 15.3 and earlier releases. Upgrade to 15.4 or higher using IPv4 and then switch to IPv6 in your new environment. If your requirements mandate an attempt to force an upgrade from 15.3 to 15.4 or higher in an IPv6 environment, follow these steps:
  1. Verify your RHEL OS, app server, and database version numbers meet the requirements listed above.
  2. Start the upgrade.
    The following error is likely to appear:
    Error: Failed to initialize Context properties java.sql.SQLNonTransientConnectionException: [CA Clarity][Oracle JDBC Driver]
     
  3. To resolve the error, update all entries in the following files: 
    update config/properties.xml update bin/admin.sh (or admin.bat) update {install.dir}/.setup/scripts/db.macros.xml
Locate all instances of the following entry: 
<jvmarg value="-Djava.net.preferIPv4Stack=true"/>
Replace all instances of this entry from 
true
 to 
false
:
<jvmarg value="-Djava.net.preferIPv4Stack=false"/>
Extension of Digital Certificate for MSP and OWB Integrations
The 15.5.1.1 patch includes an updated digital signature for optional Clarity PPM integrations with Microsoft Project (MSP) and CA Open Workbench (OWB). The original expiration date of April 5, 2019 has been extended until 2020. The embedded certificate is exclusively available through the installer. (CA Support can trace this change using DE44578.) 
Oracle Database Changes
New Oracle 12c Multi-Tenant Support and Encryption Options
Oracle 12c introduces multi-tenancy (MT), pluggable database (PDB) capabilities, and new encryption options.
Oracle multi-tenant architectures for next-generation cloud databases deliver isolation, agility, and scale. A multi-tenant container database can hold many pluggable databases. An existing database can simply be adopted with no application changes required. Oracle MT fully complements Oracle Real Application Clusters, Oracle Active Data Guard, and other options.
CA PPM officially supports Transparent Data Encryption (TDE) at the tablespace level. Limited support is available for JDBC traffic between the application and the database.
 
Upgrade Action: 
To implement an MT architecture, follow the steps in the Install CA PPM topic. A summary of the complete steps appears below as a convenience.
  1. As a database administrator, install and configure your Oracle MT enabled database. You can create a container in a test environment for CA PPM, create your PDB, directory, and permissions, and query your PDB and resolve any connection issues.
  2. Make the following change in CSA:
    1. Select the 
      Specify URL
       check box.
      The 
      JDBC URL
       field appears with default values that include an 
      SID
       assignment. For example:
       jdbc:clarity:oracle://my_ppm_server:1818;
      SID=niku;
       BatchPerformanceWorkaround=true;
       InsensitiveResultSetBufferSize=0;
       ServerType=dedicated;
       supportLinks=true 
       
    2. Change 
      SID
       to 
      ServiceName
      .
    3. Set the 
      ServiceName
       parameter to the name of your PDB.
The following image shows a new configuration example:
  image2018-10-15_10-40-58.png  
Data Model Changes
To view a summary of the data model changes for this release including the data warehouse, see 
Schema Changes 
under
 Reference
 in the English edition of the documentation.
Security Fix for JavaScript 
A security fix for a JavaScript bug could impact users upgrading from a previous release. For example, you have a custom HTML portlet in Studio that returns the session ID in the HTML body of responses to the client. After an upgrade to 15.5.1, the mechanism to retrieve the user ID has changed. You can no longer get the user from the session ID (
var currentSession = window.clarity.session.sessionId;
 will return 
undefined
).
 
Upgrade Action: 
To retrieve the user ID, use the following convention:
var currentSession = window.clarity.session.userId;
Known Issues for Release 15.5.1
The following section lists the known issues at the time this release was delivered.
 
 
4
 
4
 
 
Check-Install Utility Fails If It Detects Any Past Failure of the Load Data Warehouse Job
The check-install utility would typically alert you if 
only the most recent instance
 of the Load Data Warehouse job had failed prior to running the 15.5.1 upgrade. In this known issue, the 15.5.1 check-install utility fails if it detects 
any previous failure
 of the job, even if the latest instance of the job was successful.
 
Workaround
: Modify and then run the following query to capture and delete failed instances of the Load Data Warehouse job. As an Oracle or Microsoft SQL Server database administrator, update the query statements to delete all previous failed instances of the job and then resume check-install to continue your upgrade:
select * from CMN_SCH_JOB_RUNS where JOB_ID = '5110024' and STATUS_CODE = 'FAILED'
DE37990: XOG or SOAP Integrations Invoking WSDL Queries
The following rare potential known issue applies only to customers upgrading from 15.3 or a previous release where all of the conditions listed below are satisfied.
Due to a bug fix in 15.4 (DE37990) and newer releases (including 15.5.1) that restores correct behavior, your legacy external integration scripts that invoke WSDL queries from the XOG, SOAP, or other means could experience the following problems, requiring corrective action on your part after an upgrade from 15.3 or older releases (at the base level or any patch level) to 15.4 or higher, including 15.5.1.
To illustrate the problem, consider whether the following PPM integration scenario applies to you:
  • You maintain an integration tool that interfaces with CA PPM to read and write data.
  • You use NSQL queries to read data. You might import projects, tasks, incidents, or even configuration data such as lookup field values that are based on dynamic NSQL queries.
  • You use slicing (paging) to limit the response size and rely on the slice return value to indicate how many more pages exist.
  • You invoke a SOAP request for any NSQL query with multiple results. For example, you make a XOG read request using SOAP on a slice size that is smaller and lower than the total results. Or, you enter a slice size that does not divide the total results evenly (
    total results 
    modulo
     slice size > 0
    ).
The last page retrieved in the result set (final slice) could have a slice size that no longer matches the requested size, but is instead, the returned number of items. In CA PPM 14.4, this was not the case. The slice size returned was always the requested one, even if fewer items were retrieved. CA PPM 15.4 and higher restores this functionality.
 
Upgrade Action
: If this scenario applies to your organization, advise your integration developers to examine their code for calculating when the next page exists. As a workaround, they might already be storing the requested page size. The size element in the response was corrected in 15.4 and newer releases to represent the 
returned records count
 instead of the 
requested size
.
In 15.4 and higher, the NSQL web service query limit can only be controlled up to the internal limit of 50,000 for the maximum results returned. You can still run a query that pulls more data than this by requesting it in chunks. For example, in 75,000 total possible results, you could get up to 50,000 on the first pull, and then the next pull would get the remaining 25,000.
: The bug fix for DE37990 resolved a serious issue where the MAX_FETCH_LIMIT governor could be overridden in WSDL query calls, producing incorrect slice totals and results. Bypassing that necessary governor limit also permitted a single user action to create a 
java.lang.OutOfMemoryError
 condition to bring down the application service. Release 15.4 and higher releases include this bug fix.
Change in Status Report Status Lookup Values
The following subtle change applies only to customers upgrading from 14.3 or earlier releases (as previously announced, mainstream support for those releases has expired).
Starting with Release 14.4, the default 
Status Report Status
 lookup values changed from 
Minor Variance
 to 
Needs Help
 and from 
Significant Variance
 to 
At Risk
. The 
On Track
 value remained the same. See the PMO Accelerator Release Notes in the 14.4 edition of the English documentation set.
Cannot Edit an Instance in the New Status Report Grid or Custom Subobject Grid
A known issue with the new status report grid layout prevents users from editing an instance even though they have the required 
Status Report – Edit
 instance rights. As a workaround, grant 
Status Report – Edit All
 global rights to authorized users. A similar known issue might be observed with the new grid layout for custom subobjects of the project object. Users cannot edit an instance even though they have the required edit 
instance
 rights. As a workaround, grant 
global
 access rights for editing to authorized users.
'An error occurred while saving preferences' in a Custom Subobject Grid
Some users might see 
 
An error occurred while saving preferences
 
 the first time they open the page.
 
Workaround
: Users can safely ignore this message. The next time the user opens the grid on this page, this message no longer appears.
Internet Explorer 11 No Longer Supported for the New User Experience
Classic PPM still supports IE 11; however, the 
New User Experience
 cannot extend backward compatibility with any old browser technology, including IE 11.
This is not a known issue with CA PPM. Instead, it is a known issue with IE 11. Microsoft has invested in a new browser, Microsoft Edge.
: If they ignore the support requirements and attempt to use IE 11 with the 
New User Experience
, your users could encounter the following problems:
  • Defective features or memory leaks (with no scheduled fixes from Microsoft)
  • Missing browser framework support for new REST API capabilities
  • Poor appearance or slow performance with HTML 5 and new Angular components
  • Links to other sites stop working or show messages indicating you need to update your browser
For example, using IE 11, you could cause your roadmap timeline to stop working, the staffing pages might not load all resources, and other problems could occur that appear to be 
random
 until users realize they are using old unsupported browser technology to access a completely new drag-and-drop feature-rich web application interface. For best results when viewing the modern user experience pages in CA PPM, switch to a new browser such as Edge, Firefox, or Chrome.
Known Issue DE45971: Cannot Upgrade Directly to 15.5.1 Due to Mixed Java 8 and 11 Configurations
Clarity PPM 15.5.1 requires Java 11. Upgrading to 15.5.1 from a previous release using the following typical steps fails:
  1. Prepare your current release of CA PPM with Java 8 for the upgrade.
  2. Install Java 11 and set the home path.
  3. Start the upgrade script and provide the necessary details.
The upgrade fails at 
IS_CUSTOMER_DB.xml
 with the following error:
\clarity\.setup\scripts\db.xml:893: java.lang.NoClassDefFoundError: jdk/internal/reflect/MethodAccessorImpl
A known bug is using the wrong version of the JDK during the upgrade process.
 
Workaround
: Apply workaround A or B documented earlier on this page. See Clarity PPM 15.5.1 Changes: Java 11 Impacts on Clarity PPM Upgrades.
Known Issue: Cannot Upgrade on Oracle Until Optional Security License is Enabled
 
Workaround
: Contact your database administrator or Oracle to obtain the advanced security license (OAS) required only for DBMS_CRYPTO if you want to implement database encryption. If you do not want database-level encryption, skip this step.
Known Issue: Upgrade to 15.5.1 Fails with Error ORA-00904: Invalid Identifier dbms_obfuscation_toolkit.md5
In CA Clarity PPM environments running an Oracle database, the 
dbms_obfuscation_toolkit
 package is part of the SYS schema and is typically enabled. If this package is disabled, your upgrade can fail when implementing 
POSTUPGRADE_API_KEY_SETTINGS.xml
.
 
Workaround
: Determine if 
dbms_obfuscation_toolkit
 is enabled and verify that the PPM schema has access to execute it.
 
Follow these steps:
 
  1. Connect to the PPM database schema and execute the following SQL query:
    select SUBSTR(dbms_obfuscation_toolkit.md5(input => UTL_RAW.cast_to_raw(to_char(sysdate,'YYYY-MM-DD HH24:MI:SS'))),-32,32) FROM dual;
     
  2. If the query returns data, the  
    dbms_obfuscation_toolkit
     package is enabled and accessible; otherwise, you see the 
    ORA-00904: Invalid Identifier...
     error message.
  3. Contact your Oracle DBA to enable the 
    dbms_obfuscation_toolkit
     package and make sure that the PPM database schema user has access permissions and can run it.
Known Issue: FIPS Support Not Available in CA PPM 15.5.1
FIPS is not supported due to compatibility issues with JDK 11 and the Bouncy Castle FIPS provider.
 
Upgrade Action
: Disable FIPS in your current release before upgrading to CA PPM 15.5.1. If you require FIPS, delay your upgrade plans until a fix or workaround is available.
 
Explanation
: After an upgrade, system administrators would typically not re-generate a new keystore and would continue to use their older keystore. Ideally, JDK 11 should be able to read older keystores generated by lower JDK, openjdk, or openssl versions. However, after an upgrade to 15.5.1, verification of the BCFIP.jar signature fails. Bouncy Castle (our encryption provider) does not support FIPS with JDK 11. Administrators would have received the following error in the logs:
 
 java.util.jar.JarException:   file:/fs0/niku/1551runtime/lib/bc-fips.jar not signed by trusted signer
 
 
Workaround
: Upgrading customers would need to reset any configuration changes they made to enable FIPS 140-2 mode of operation in previous releases before upgrading to 15.5.1. If you did not disable FIPS before the upgrade to 15.5.1, you will likely encounter this error. 
: JRE is no longer part of JDK 11. When a fix is found, you might need to copy the FIPS provider jar (bc-fips.jar) to 
JAVA_HOME/lib
 instead of 
JAVA_HOME/JRE/lib/ext
. Remember to modify the security providers list in the properties file at 
JAVA_HOME/conf/security/java.security
 instead of its old Java 8 location at 
JAVA_HOME/JRE/lib/security/java.security
.
DE42925: Cannot XOG-Out Data For a Single User By Resource ID
You might experience the following issue if you export (XOG-out) a project with multiple task assignees. To encounter this issue, you would have to modify your XOG script to filter on the project ID and just one resource ID from the project. After you export the project, instead of getting filtered allocations for a particular resource, your XOG output contains the allocations for every resource in the project.
 
Workaround
: Apply post-processing on the output to filter the content or extract the single record.
 This issue has been resolved in recent development activity for the next release of CA PPM. Contact CA Support to request the possibility of inclusion in a future 15.4.1 or 15.5.1 patch.
After resolving this issue, either of the following filters for 
resourceId
 or 
resourceID
 will work as expected to filter for only one resource:
<Filter name="resourceId" criteria="EQUALS">csk.testEngineer</Filter>
<Filter name="resourceID" criteria="EQUALS">csk.testEngineer</Filter>
Unauthorized When Assigning Staff to Tasks
In Modern PPM 15.5 and higher, when selecting a staff member for task assignment, an error can appear indicating the user is not authorized to assign the staff member:
ERROR: API-1007: You are not authorized to process request. Contact your system administrator for necessary security rights.
The following conditions must be present for this error to occur:
  • The searchable pull-down always appears on the Task Staff tab for users that have view or edit project access.
  • The user does not have 
    Project - Task Management
     access to edit tasks on the project. 
  • The user is a participant or has explicit project view access granted.
  • The pull-down list does not check for the 
    Project - Task Management
     access right for the user.
 
Workaround
: Grant the user the 
Project – Task Management
 access right to allow them to manage tasks on their assigned projects. See KB0000112099.
Task Assignment Lookup Includes Assigned
When the user opens the searchable pull-down list to select a Resource, Role or Team to a Task, the list always includes staff members already assigned to the Task. When the user selects a resource, role or team already assigned, an error message appears: 
ERROR: Team member is already assigned to this task.
In CA PPM 15.5 and 15.5.1, this pull-down does not filter out staff that is already assigned to the task. No workaround is available. See KB0000112101.
Unable to Update Project Staff Records
A user with edit project access but without booking rights is allowed to update Project Staff page records for non-allocation fields. When trying to update a non-allocation field the user can encounter an 
Unable to update record 
error in Classic PPM or in New UX. 
The cause of this condition is rooted in the XOG. The XOG is defining an allocation segment that ends at midnight of the project finish date. A XOG WARNING message will appear in CA PPM 15.4.1 or newer releases:
XOG-3909: AllocCurve segment finish on Resource [resourceName] is later than project finish
 
Workaround
: When another user with edit access to the project and booking rights to the staff can successfully update the record, the data is automatically updated and clipped to fall within the date/time range of the project. Ensure the XOG file creates allocations within the Project date and time range. See KB000095832.
Selecting a Project Role for a Staff Member
In the Project Staff grid in CA PPM 15.4.1 or newer, on a row for a staff member, the Project Role lookup displays all types of roles. The user can select a non-labor role for a labor resource record and it allows the user to select a different role for a role record.
The lookup displays all types of roles based on the user 
Resource - View
 access right for active roles in the system and it is up to the user to review the selection of the Project Role field for selecting the correct type of role. The current design of the application allows flexibility for the user to select any role for determining cost rates. The lookup is not dependent on the type of resource or role record (for example, Staff Allocation Project Role, Staff Task Assignment Project Role, or Voucher Transaction Entry Role). See KB000097161.
Unsupported Parameterized Lookups Appear
A user can define a parameterized or a Static Dependent lookup in a studio object and enable API Alias. Unexpectedly, the field appears in the Modern PPM Grid Column Panels for the following grids in 15.4 or higher:
  • Roadmaps
  • Project Staff
  • Project Risks, Issues, Changes
  • Tasks (My Tasks) grid
 
Workaround
: Remove the API Alias so that the field does not show up in a Modern PPM grid. See KB000095938.
Status Report Error: You are not authorized to create status reports
A user with Status Report create and edit access must access the project Status Reports for the system to automatically create the initial status report. If this is not done, a user with only view access will encounter an error: 
You are not authorized to create status reports
.
Users Without Rights to Create Might Have Access to Add New Rows
In this release, a user without explicit access rights to create subobject instances might be able to click the 
+ Add Row
 button or right-click and select 
Insert Row
. At minimum, the user would already have the following rights:
  •  
    Project - Navigate
     
  •  
    Project Management - Navigate
     
  •  
    Project - View Management - All
     
In addition, the user could have 
<custom_subobject_name> - View All
 rights. When the user navigates to the project Status Report page or custom subobject page in an open project, the options to create new rows would typically be hidden. Even if they attempt to click those options, the user still cannot create a new instance.
A subtle variant of this known issue exists on the project task grid where the 
+ Add Row
 button appears if the user has 
Project Task Management
 access (and not explicit create rights).
DE41143: API-1007 Authorization Error In CA PPM 15.4.1 or Higher
A user with 
Task Management
 or 
edit
 access must open the Project Task page Board layout for the system to automatically create the board. If this is not done, a user with only view access to tasks will encounter an API-1007 authorization error. Participants without explicit 
Project - View
 access see the Tasks page but get an API-1007 authorization error in accessing the task board.
 
Workaround
: Users need some type of Project View access to see the Task List or Task Board. For participants, grant access to 
Project – View
. If users with only 
Project – View
 base access get an API-1007 authorization error in accessing the task board, grant those participants access to 
Project – View Tasks
.
DE45213: API-1018: Unable to Process the Request; Refer to error code for details... Error in New User Experience
A known issue might be observed when attempting to replace a role with a resource, updating allocation start or finish dates, or Allocation %. Another symptom that may be seen due to this issue is a "Could not load project" error message when trying to access a project in the New UX.
 
Steps to Reproduce:
 
  1. Log in to the Clarity PPM New UX.
  2. In the main menu, click 
    Staffing
    .
  3. In the 
    Requests
     section, expand a role that is added to one or more projects.
  4. Click on a project beneath the role.
  5. Change Allocate to a resource.
  6. Click 
    Confirm Allocation
    .
Expected Results: Role is replaced successfully without any error
Actual Results: Receive an API Error: API-1018 and role is not replaced with the resource
 
Steps to Reproduce:
 
  1. Log in to the Clarity PPM New UX.
  2. Go to 
    Projects
     and click on a project.
Expected Results: The project opens successfully without putting in the user name and password.
Actual Results: A message appears in the top center "Could not load project" and you are asked to log in.
Resolution
: This issue is fixed in Clarity PPM 15.5.1.1 and higher cumulative patches, and in 15.6 and newer releases.
Classic PPM E-Mail Notification Link When Adding a Participant
When a person is added as a participant on a project from the 
New User Experience
 in 15.3 or newer releases, the e-mail notification provides a link to the project in Classic PPM instead of the New UX.
Workaround
: The user must have access to 
New User Experience
 and can manually navigate to the project. See KB000097158.
Cannot API-Enable an Existing Custom SubObject In Studio
API enabling existing custom subobjects of the master Project object directly in Studio is not working due to a defect. Users might not see their custom subobject as a module in the project blueprint or as a page in an open project. If the API alias exists for an object, any further attempts (even through the XOG) to API-enable the same object will not work because such requests are ignored. The API alias is generated but metadata is not seeded for the modules.
 
Workaround
: Several workarounds exist. Only the second of four use cases below is an issue. All other cases are working fine. 
  • API-enable the subobject in Studio immediately when you create it.
  • API-enable the subobject in Studio after it is created (only this use case fails; you cannot later decide to API-enable the subobject during any future edits)
  • API-enable a subobject through a XOG create script
  • API-enable a subobject through a XOG update script
Known Issue with Fresh Installations of Jaspersoft 7.1
In on-premise environments, you might observe the following 
Failed to execute: create index 
entry in the installation logs during a new installation of Jaspersoft 7.1.0 on Oracle 11g R2 or 12c:
 
[exec] [exec] init-js-db-pro:
[exec] [exec] [echo] For JDBC driver the artifactId and version properties are set:
[exec] [exec] [echo] maven.jdbc.artifactId=ojdbc8
[exec] [exec] [echo] maven.jdbc.version=12.2.0.1.0
[exec] [exec] [echo] Specified JDBC driver jar exists
[exec] [exec] [advanced-sql] Executing resource: /fs0/clarity1/install_cd/ca_ppm_jaspersoft_7.1.0/buildomatic/install_resources/sql/oracle/js-pro-create.ddl
[exec] [exec] [advanced-sql] 0 rows affected
[exec] [exec] [advanced-sql] 
Failed to execute: create index
 idx46_jiresfldr_hidden_idx on JIResourceFolder(hidden)
[exec] [exec] [advanced-sql] java.sql.SQLException: ORA-01408: such column list already indexed
[exec] [exec] [advanced-sql] 0 rows affected
[exec] [exec] [advanced-sql] Executing resource: /fs0/clarity1/install_cd/ca_ppm_jaspersoft_7.1.0/buildomatic/install_resources/sql/oracle/quartz.ddl
 
: You can ignore this entry. The warning appears to be alerting you about a duplicate index creation scenario; however, it is not a valid warning.
  • This warning has no impact on your installation and does not affect any Jaspersoft 7.1 functionality. 
  • CA Engineering teams confirmed that all the DDL commands are successfully executed after the reported warning.
  • The warning only appears on new Oracle installations; it does not occur with supported versions of Microsoft SQL Server 
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
 
New User Experience
 
  • PMO Accelerator Add-in Installed
Install PMO or APM add-ins
  • Data Warehouse Configured
Supported Upgrade Paths for Release 15.5.1
To upgrade 
directly
 to this release (15.5.1), your current release must be 14.3 or higher. The 15.5.1 installer can backup and upgrade your data from supported older releases. 
  • If you have Release 13.3, 14.1, or 14.2, your release is no longer supported. You might be able to upgrade to Release 15.2 or 15.3 first, and then upgrade to 15.5.0 before you install 15.5.1.
  • You cannot upgrade to Release 15.5.1 
    directly
     from Release 14.2 with Jaspersoft 5.6.1 or from Release 14.3 with Jaspersoft 6.1.0. The Jaspersoft 6.4.2 or 7.1 upgrade does not support those configurations. Your 
    indirect
     upgrade is still supported. For example, upgrade to 14.3 and Jaspersoft 6.4.2 first. Then upgrade to 15.5.0 and then 15.5.1 and upgrade to Jaspersoft 7.1.
  • You can upgrade from a previous release even if you have no Jaspersoft reports environment configured. The data warehouse is required; however, reporting is not required. You can elect to upgrade from 14.x and perform a fresh installation of your reports environment.
  • To upgrade from 13.2 and earlier releases, upgrade to 14.3 first and skip the Advanced Reporting component. This middle step simplifies the troubleshooting and restart process if an upgrade step fails. Then, from 14.3, you can upgrade to 15.5, apply the 15.5.1 service pack, install Jaspersoft 7.1 for Advanced Reporting, and apply any patches.
: The installer detects how many incremental upgrade steps are required to update your installation to the latest release. If two or more, you are prompted to decide if you would like the installer to save automated backups at each step. For example, from 15.3 to 15.4, from 15.4 to 15.5, and from 15.5 to 15.5.1.
If you have installed any patches on the base version, verify that you applied the latest supported cumulative patch before and after you upgrade. Patch maintenance before and after upgrades is important for troubleshooting, security fixes, and general system health.
 
Follow these steps
:
  1. Select your current release from the 
    Versions
     menu at the top right of that docops page.
    For example, select 15.1 and verify you installed the 15.1.0.9 patch or select 15.3 and verify that you installed the 15.3.0.5 patch before starting your upgrade to 15.5.1. After the upgrade, install the latest 15.5.1 patch.
 You might experience issues if you attempt to upgrade directly from an unsupported patch level. For best results, follow a supported upgrade path. To learn more, contact CA Support or CA Services. You can also visit the CA PPM Community to collaborate with other community members about your specific questions.
: You can upgrade to 15.5.1 from 15.5.0.0 or 15.4.0.0 base releases, 15.5.0.1 or 15.4.0.1 patched releases, 15.4.1.0 service pack base release, or from any 15.4.1.x patched release.
CA PPM Upgrade Overview 
 
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 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 CA 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 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.
  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 manage the views:
    • The Last Version column identifies changes to stock views in this release.
    • 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 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=14.4 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
    This release contains database 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.
Pre-Upgrade: Run the Installation Checker
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.
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 file in a location in your file system so that it is accessible to the installer.
 
Tip
: To keep the installer from prompting you for the file location, place the JAR file in the installation root directory. If you place the file in another directory, the installer prompts you for the file location.
Upgrade Large Data Sets
If your 
Clarity PPM
 upgrade processes a large volume of data, we recommend that you override the default memory settings that are used by the upgrade.
You can override the default memory settings this release. Create a 
memory.properties
 file and place it in the $cappm/config directory. Set the desired memory values in that file.
Here are the default values that the upgrade uses:
defaultScriptMaxMem=1024m defaultScriptPermGenMem=128m
Here are some sample settings in the 
memory.properties
 file:
defaultScriptMaxMem=2560m defaultScriptPermGenMem=512m
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
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.
Custom Processes, Scripts, and Other Customizations
CA 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. 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. You can see these warnings or the referenced logs for insight into the types of customizations that can negatively impact your upgrade experience. For example:
    WARNING: Possible schema customizations have been found. Any customizations to the system are the responsibility of the customer to maintain and are not supported. To upgrade, 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. As an on-demand (SaaS) administrator, you do not see these warnings or the referenced logs. These example messages provide insight into the types of customizations that can negatively impact your upgrade experience.
  5. In on-premise or SaaS environments, turn off your 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
  6. 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 CA PPM features in a complete COTS/SaaS solution against the value of developing your own unsupported customizations.
Pre-and-Post-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>
Post-Upgrade or Post-Install: 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'