Change Impact and Upgrade

ccppmop1591
HID_HID_release_info_change_impact_od
This
Change Impact and Upgrade
page highlights significant changes, required actions, known issues, and recommended options for customers upgrading from the previous release to
Clarity
15.9.1
. Plan your
Clarity
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.
For compatibility related information see, Hardware and Software Compatibility Specifications
For installation and upgrade related information see Installing and Upgrading
For example, you are upgrading from
Clarity
Release 15.5 to
15.9.1
. Review the changes in releases 15.5, 15.5.1, 15.6, 15.6.1, 15.7, 15.7.1, 15.8, 15.8.1, and 15.9 before and after you upgrade. To switch to the
Change Impact and Upgrade
page for each release, click the
Versions
menu at the top of this page. Check back often for updated content, especially if you downloaded a PDF file. The English edition of this documentation is periodically updated with new information including new examples, explanations, corrections, and patch information.
To prepare for an upgrade to
Clarity
15.9.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.
Clarity
15.7 Onward - OracleJDK will be replaced with AdoptOpenJDK
Java Image
With effect from August 19, 2019,
Clarity
has discontinued product updates related to Oracle Java. 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
that supports AdoptOpenJDK. This change does not impact Jaspersoft, which will continue to support Java 8.
This page includes the following sections:
2
Clarity
Usability Enhancements

Group By Functionality Displays Aggregations for TSV Columns
When you use the Group By capability in the Staff Grid, the Assignments Grid, or the Financials grid, you will be able to view the totals for all the TSV’s available in the grid. Let’s consider an example where we have added the Remaining Allocation and Remaining Availability, TSV’s to the Staff Grid. When you group by Booking Status, you will be able to see the total aggregated values for Remaining Allocation and Remaining Availability for resources with Soft, Hard, and Mixed booking status.
Upgrade Action
: The Time Slicing Group By job has been introduced in this release. This job allows you to leverage the SQL curve technology introduced in
Clarity
to significantly improve the handling of time-phased data. You will now be able to view time-phased data without the restrictive time windows available in Classic PPM. The SQL curve technology also allows you to aggregate time-phased data by using the Group-By functionality in
Clarity
. It also enables
Clarity
to display the remaining availability for all resources (resource availability - resources aggerated allocations across investments ) in the Staff grid across investments. The first time the Time-Slicing-Group-By job runs, it may take some time (depending on data) before
Clarity
will display per-period metrics or support Group By aggregation.
Broadcom has identified a GCP SaaS operations performance issue related to this feature. As a result, the
feature has been disabled for GCP SaaS customers
and will be reintroduced in an upcoming release. Clarity On-Premise and Clarity AWS SaaS customers are unaffected by this issue and can continue to use this feature.
  • Custom TSVs are not visible in this release of
    Clarity
    . They are still visible only in Classic PPM.
  • All per-period metrics represented in the Staff, Assignments, and Financials modules for Projects, Ideas, and Custom Investments are using the SQL curve technology which extracts data from their corresponding BLOBs.
  • Administrators do not need to manually run the Time-Slicing Group-By job as part of an upgrade or fresh installation.
  • The Time-Slicing-Group-By job is non-concurrent with Time Slicing (legacy) job.
  • The SQL curve technology is not used in the Staffing workspace.
  • The Time Slicing Group By job is scheduled to run every five minutes in your environment. If you do not execute this job in your environment, you may not see accurate metric data in the Staff, Assignments, and Financials modules for Projects, Ideas, and Custom Investments.
For more information on the Time-Slicing Group-By job, see Clarity Jobs Reference
Usability Enhancement in Board Layout
The cards in the Board layout have been enhanced to ensure that the investment instance will open only when you click the card title. In previous releases, the investment instance even when you could click the empty space below the card title.
Upgrade Action
: No action required. The behavior has been enhanced to ensure you can click the card title to navigate to the investment instance or click the card and use the DETAILS panel to update information.
For more information on using the Board layout, see Common Components
Support for Rich Text Format (RTF) Attribute
You can now add rich text attributes for an object or subobject in
Clarity
. For example, a project manager can use RTF to create a project summary to highlight the project milestones and key achievements. Portfolio Managers and CIOs can navigate to this supplementary information with one click and remember what they've read. For more information on the Rich Text Format attribute, see Large String – Rich Text attributes and Add an Attribute.
  • The attributes with rich text format are not supported in Data Warehouse and Jaspersoft.
  • The Living Status Reports render rich text format content in the PDF preview.
Upgrade Actions
: No action required.
Actual Transactions Grid
In the Financials modules, along with the Cost Plans, Budget Plans, and Benefit Plans, you can now see the
Actual Transactions
grid. This grid is non-editable and displays the actual costs posted through transactions for an investment by transaction date, quantity, cost, and currency information. With the Actual Transactions grid, a financial manager can:
  • Better understand an investment’s financial visibility.
  • View the list of transactions that are posted and an overall summary of all the transactions associated with the investment in a single place.
  • Compare transaction currency amounts to converted currency amounts by task and resource.
For more information, see the Actual Transactions grid in Projects, Custom Investments, and Ideas.
  • The actuals transaction amounts are stored in five currency types. However, you can see it in your home currency.
Upgrade Actions
: No action required.
Advanced Filter Options (including Null Selector)
You can now use advanced filter options to refine search criteria and get specific results based on your need. Depending on the type of attribute that you choose to filter on, you get various operators such as, Is Equal To, Is Not Equal To, Is Empty, Is Not Empty, and so on. For example, if you want to filter projects that do not have a manager assigned, select the Manager attribute in the Filter and select the "Is Empty" operator.
Upgrade Action
: No action required. After you upgrade to
Clarity
15.9.1
, your existing filters will continue to work, as they will be set to the default operator for the corresponding data type. For example, if your existing filter is on a string attribute, the operator will be set to "Contains". 
For more information on using filters, see Common Components.
Visual Indicator for Locked Attributes
Clarity
now displays a visual indication (lock icon) whenever an attribute is locked by a process. The attribute is greyed out so that users understand that they cannot edit it. Many customers use
Clarity
workflows to define an approval process for object instances such as projects and ideas. As a part of the approval process, customers often lock sensitive attributes at various stages of the process.
Clarity
now displays a visual indicator to users that the attribute is locked so that they don’t try to edit it.
  • The lock icon is displayed on the Properties page and the DETAILS panel. It is not displayed in the Grid layout and the user will not know an attribute is locked till they try to edit it.
  • When an attribute is locked by a process, the screen needs to be refreshed to see the lock icon.
Upgrade Action
: No action required. After you upgrade to
Clarity
15.9.1
, all the attributes that are locked will have a lock icon next to them in the DETAILS panel and the Properties page.
Tasks are Sorted Based on WBS in Project Status
The Tasks widget in the Project Status page is now sorted based on the Work Breakdown Structure of tasks instead of alphabetical order. This change helps you view the status of the parent and child tasks together in a single view. For more information, see Clarity: Measure Progress and Publish Project Status Reports.
Upgrade Impact:
No action required. After you upgrade, the existing Task widgets in your Project Status page will be automatically sorted based on WBS.
Accessibility Enhancements

The
Clarity
product team is committed to ensuring support for the WCAG 2.1 AA standard. From release 15.9.1, Accessibility enhancements will be released incrementally to help organizations increase adoption and help users with accessibility requirements to experience
Clarity
seamlessly. The following table lists the accessibility improvements addressed in this release:
What is it about?
Who is it for?
What’s the change?
Visual design
Users with colorblindness
Color contrast and visible focus
Responsive design
Users with limited vision or partial blindness
Popup windows, text areas, and the browser zoom
Keyboard navigation
Users with mobility impairments
Key input, tab order, focus
Note
: Special keyboard controls or custom shortcut key combinations are not supported in this release.
Screen readers
Users with partial or complete blindness
Semantics, hierarchy, page structure
As an example, the following screenshot illustrates the color contrast changes implemented to improve the overall visual experience for all users including those with accessibility requirements:
For more information on the supported components and level of compliance, see Accessibility Features in Clarity.
Upgrade Action:
No action required. Any existing color preferences in the display, custom picklist, project banner, or document tags, will be mapped to the new color scheme automatically. For more information about the color mapping, see the Color Consolidation and Mapping section.
Timesheet Enhancements

Approve or Return Multiple Timesheets in Bulk
If you have approver rights, you can use the Bulk Actions to approve or return multiple timesheets at once. Bulk actions are an efficient way when you’ve multiple project contributors submitting timesheets. For more information on bulk actions, see Clarity: Review and Approve Timesheets.
  • If you select multiple timesheets and the status of the selected timesheets is not the same, you can’t use bulk actions to approve or return timesheets at once.
  • You cannot use the context menu to approve multiple timesheets.
Upgrade Action
: No action required.
Right-Click Context Menu to Review Timesheets
If you’re an approver, you can now right-click the selected timesheet to either approve or return them. The context menu for timesheets brings together all your important actions into one place, making it easier to approve or return the selected timesheet. For more information on approving timesheets, see Clarity: Review and Approve Timesheets.
  • If you select multiple timesheets and the status of the selected timesheets is not the same, you can’t use the context-menu to approve or return the selected timesheets at once.
  • You cannot use the context menu to approve multiple timesheets.
Upgrade Action
: No action required.
Timesheets - Expand and Collapse All
You can now expand and collapse your timesheets with a single click using the Expand All and Collapse All icons. With this feature, you can now easily view your Timesheet content when multiple investments and their associated tasks are in view. You can find this feature in the My Timesheets entry page, Review and Approve screen, and the Timesheets grid details pane.
For more information on Expand and Collapse All, see Clarity: Enter Hours and Submit a Timesheet and Clarity: Review and Approve Timesheets.
  • The Expand and Collapse All option is not available when you expand the Remove Work menu.
Upgrade Action
: No action required.
Time Period Is Open Option
Classic PPM automatically filters out Closed Time Reporting Periods and there is no way to review Timesheets in a Closed Period. In Clarity, the functionality has been enhanced to show both Open and Closed Timesheets with the ability to filter for Open or Closed Periods. A new field 'Time Period is Open' can be used to filter for Open (=Yes) or Closed (=No) Time Periods.
Upgrade Action
: No action required.
Use Channels to Embed External Content

You can use channels to embed content from another source, such as an external site, application, or Classic PPM context-sensitive investment reports into Clarity. You can interact with the content and make informed business decisions without leaving an investment in
Clarity
.
For more information, see Channels in Projects, Ideas, Custom Investments and Custom Objects.
  • The user and internal ID parameter syntax have changed.
  • When you copy a blueprint, the channels defined in the source blueprint are also copied.
  • A blueprint can have up to 50 modules. You can configure less than 15 channels when there are more than 35 modules that are already defined in the blueprint.
Upgrade Action
: No action required.
Enhancements to Custom Objects

This release includes the following enhancements to custom objects:
Support for Third-Level Custom Objects in
Clarity
You can now API enable a third-level custom object using the UI or XOG and display it as a tab in the Details panel in
Clarity
. Let us suppose that for each Purchase Order, you want to track the Purchase Order Lines (PO Lines) and then capture AP Invoice details for each PO line, you create custom objects as follows:
  • Purchase Order (Master Object - Level 1)
    • PO Lines (Subobject of Purchase Order - Level 2)
      • AP Invoice Details (Subobject of PO Lines - Level 3)
After you update the Purchase Order blueprint to include PO Lines as a module, the PO Lines module appears as a tab in the Purchase Order. Create a new PO line and click the Details panel to update the AP Invoice Details tab. The level 3 objects appear in alphabetical order after the Details tab.
Upgrade Action
: No action required. In previous releases, the third-level custom objects did not have the API Enabled option and hence could not be made available in
Clarity
. When you upgrade to
Clarity
15.9.1
, you can API enable the existing and new third-level custom objects and view them as a tab under the second-level object.
API Enable and Secure Custom Attributes of Custom SubObjects
You can now API enable the custom attributes associated with the custom subobjects and make them available in
Clarity
. You can also enable field-level security for these attributes. For more information, see API Enable Custom Attributes and Secure Field Level Access.
Upgrade Action
: No action required. In previous releases, the custom attributes of the third-level custom objects did not have the API Attribute ID field and hence could not be made available in
Clarity
. When you upgrade to
Clarity
15.9.1
, you can API enable the existing and new custom attributes in the third-level custom objects, and enable field-level security for these attributes if you want to secure them.
Roadmap and Hierarchy Enhancements

This section includes the roadmap and hierarchy enhancements in this release:
Add and Sync the Goal Attribute on the Roadmap Items Page
The Goal attribute of an investment item (such as Project, Idea, or Custom Investment) indicates the organizational goal that the investment item is aligned to. For example, you are working on a project to migrate to a new tool to reduce costs. You select Cost Reduction as your goal. When you import this project as a roadmap item in
Clarity
, you want to view the corresponding Goal for the project so that you can prioritize investments within the roadmap. In previous releases, the Goal attribute was not available on the Roadmap Items page.
With this enhancement, you can add the Goal attribute to the Roadmap Items page to view the Goal for each investment item that you imported as a roadmap item. You can also sync the Goal attribute anytime to pull the latest values from the corresponding investment items.
Upgrade Action
: No action required. In previous releases, the Goal attribute was not available on the Roadmap Items page. When you upgrade to
Clarity
15.9.1
, you can add the Goal attribute to the Grid layout and sync the values of the corresponding investment items.
For more information about Roadmaps, see Clarity: Top-Down Planning with Roadmaps.
Display Cross-Object Investment Grid in Hierarchies
A new read-only grid layout, also referred to as the cross-object grid, has been added to hierarchies. The grid displays all the investments (projects, ideas, and custom investments) that are a part of your hierarchy. You can use the grid to review attributes that are common across all investments or specific to individual investments. Let’s consider an example where the grid includes multiple projects, ideas, and custom investments. Attributes such as Budgeted Cost and Planned Benefit, which are common across all these investment types, are displayed under the Common Investment section. Attributes such as Objective and Sponsor are only associated with the custom investment are displayed under the relevant investment.
Upgrade Action
: When you upgrade to this release, you will not see any saved views for hierarchies. Traditionally, saved views on sub-objects of the Investment Abstract object are available across objects and instances. That means if you create a saved view on a cost plan for a project, the view will be available for all other projects, custom investments, and ideas. This functionality has been enhanced for hierarchies in
Clarity
15.9.1. Since a hierarchy contains instances across multiple investments, the views you save will not be shared across other instances of hierarchies. The upgrade process will delete all existing saved views for Hierarchies to deliver this enhanced functionality. From
Clarity
15.9.1 onwards, when you save a new view within a hierarchy instance, it will be available only within that instance.
Some of the limitations of using the cross-object investment grid in this release are:
  • Field-level security is not supported on the cross-object investment grid.
  • Attributes on the Financial Properties and Project Financial Properties abstract object will not be available on the cross-object investment grid.
  • There is no option to import investments into a hierarchy using the cross-object investment grid.
  • There is no option to mark an investment as a favorite by using the Starred attribute.
  • There is no support for custom metrics in the cross-object investment grid.
  • The Blueprint attribute on the filter does not work in the cross-object investment grid.
  • The Attachment, Calculated, Aggregated and Formula datatypes are not supported in the cross-object investment grid.
For more information see Create and Edit Hierarchies
Attributes Enhancements

Additional Attributes Available as Time Scaled Values in Staff Module
You can use the PER-PERIOD METRICS option in the Staff module to display the following additional TSV attributes.
  • Actuals: Displays the Per-Period - Actual Units aggregated from assignments for the team member.
  • ETC: Displays the Per-Period - Estimate Units aggregated from assignments for the team member.
  • Total Usage: Displays the per-period TSV Total Usage, which is calculated by combining the ETC and Actuals (ETC+Actuals)
  • Remaining Allocation: Displays the per-period TSV Remaining Allocation Units, which is calculated by subtracting Total Usage from Allocation for this investment (Allocation - Total Usage)
  • Remaining Availability: Displays the per-period TSV Remaining Availability, which is calculated by subtracting the resources aggerated allocations across investments from the resource availability. A negative value indicates that the resource is over-allocated.
  • The values will be displayed in FTE, hours, or days based on the user’s setting.
  • We recommend removing the scalar fields when using the per-period metric fields if you are setting the period start and finish to cover the entire investment date range because selected ‘Totals’ will display the same values as the scalar values.
  • Use the ‘Totals’ field in combination with their corresponding per-period metrics to ensure data is displayed properly. Remember that if the ‘Totals’ fields is selected without including their corresponding per-period metrics, the grid will not display expected values.
Upgrade Action
: There are a couple of changes that you will see when you upgrade to this release of
Clarity
.
  • In previous releases of
    Clarity
    , only Allocations and Hard Allocations were available under PER-PERIOD METRICS. When you upgrade to
    Clarity
    15.9.1, the Allocations time-varying attribute will be renamed as Allocation. You can also, add the additional attributes as PER-PERIOD METRICS and view them in the
    Clarity
    grid.
  • When you open the Team object in Classic PPM, you will see duplicate attributes to Actuals and ETC. The time-varying attributes will only be displayed in
    Clarity
    , while the scalar attributes will be available both in
    Clarity
    and in Classic PPM.
Support for Attachment Attributes in Grid Layout
You can now add attachment attributes to the Grid layout. While you are in the Grid layout, click the Columns panel and select the attachment attribute. Once the attribute is added, you can view, download, upload, and delete attachments from the Grid. For example, as the first step in your idea review process, you want to ensure that the ideas submitted for approval have an MVP document attached. By adding the corresponding attachment attribute for MVP to the Grid, you can group or filter by the status column to quickly view the list of ideas that do not have an MVP.
  • When you export the grid data to CSV, the corresponding attachment attribute columns in the CSV will display the details of the file name, mime type, and the URL to download the file.  
For more information about attachment attributes, see Clarity Studio Objects and Attributes.
Upgrade Action
: No action required. In previous releases, the attachment attribute was not available in the Grid layout. When you upgrade to
Clarity
15.9.1
, you can add the attachment attributes to the Grid layout and view, download, upload, and delete attachments.
Staffing Workspace: Days Unit of Measure
You can now configure
Clarity
to display work effort on the Staffing page in Days. In previous versions of
Clarity
, you could only view work effort in FTE or Hours. You can now use General Settings to configure the work effort to be displayed in days.
  • You can use General Settings to configure work effort in Days for the Staff, Assignments, and Tasks modules across all investments in
    Clarity
    .
  • You can use the Settings option for Project Management in Classic PPM to configure "Days" for the project summary metrics and the Cross-Project Tasks grid.
  • You can use the Administration setting in Timesheet Options to configure the Days option for Timesheets.
Upgrade Action
: No action required. When you upgrade, you can configure
Clarity
to display the work effort in days for the Staffing page.
PMO Accelerator Add-Ins Reporting Enhancements

Protect PMO Accelerator Attributes While Upgrading
Clarity
You can now select the attributes of the PMO Accelerator add-in that you want to update after you upgrade to the latest release of
Clarity
. In previous releases,
Clarity
would automatically update all the attributes. This meant that customers would lose all customizations such as display mappings they made to those attributes. Customers will now be able to selectively apply object level changes after each upgrade. Hence, a customer can choose to re-install one attribute, preserve changes to the second attribute, and install a third newly introduced attribute.
Upgrade Action
: No action required. After you upgrade, select the attributes of the PMO Accelerator add-in that you want to update.
Blueprint Attributes Available in Data Warehouse
The following attributes have been added to the Data Warehouse (DWH) and synchronized as part of the “Load Data Warehouse” job.
Blueprint Specific Attributes
Added to Table: dwh_inv_investment
  • Blueprint ID*
  • Blueprint Active ID*
  • blueprint and blueprint_key
  • Active_blueprint and active_blueprint_key
Upgrade Action
: No action required. After you upgrade, you will see the Blueprint attributes in the Data Warehouse.
New Custom Seeded Objects added to Roadmap Items
The following custom seeded objects were added to Roadmap Items by using the PMO Accelerator Add-In:
  • Project Category
  • Corporate Priority
  • Business Unit Priority
  • Architectural Fit
  • Commercial Value
  • Regulatory Compliance
  • Technology Compliance
Upgrade Action
: No action required. After you upgrade, the new attributes will be available when add or edit roadmap items.
Custom Investment Data Available in Jaspersoft Reports
All custom investment types where the INCLUDE IN THE DATA WAREHOUSE setting is checked will have data available in the Jaspersoft reports.
Upgrade Action
: No action required. After you upgrade, all the custom investment types where the INCLUDE IN THE DATA WAREHOUSE setting is checked will have data available in the Jaspersoft reports.
Enhancement to the Load DataWarehouse Job
The Load Data Warehouse job has been updated to include additional jobs that are incompatible with this job. The jobs incompatible with the Load Data Warehouse job are also updated to not run if this job is running. This change helps improve the performance of
Clarity
.
Upgrade Action
: No action required.
Enhanced Support for Federated SSO

Manage SAML Integration and Certificates
Clarity
15.9 allowed on-premise customers to use the credentials issued by an IdP - that supports SAML 2.0 - and log into
Clarity
. Customers had to use REST APIs to configure the SAML integration.
Clarity
15.9.1 allows you to use the Authentication and Keys option on the Administration page to perform the following activities:
  • Import SAML metadata into
    Clarity
  • Manage security certificates
  • Export service provider metadata
  • Configure multiple Identity Providers
For more information about how you can configuring
Clarity
to support SAML 2.0, see Configuring Clarity to Support SAML 2.0.
Upgrade Action
: In the previous release of
Clarity
, you needed to use REST APIs to import the IDP metadata into
Clarity
. After you upgrade to this release, you can use the Authentication and Keys option on the Administration page to manage SAML integration. If you had configured the SAML integration using REST APIs, you will see the relevant details in the SAML Configuration section and the Certificates section.
Specify Secondary Email for User
You can now specify a secondary email address for a user in
Clarity
. This is intended only for
Clarity
SaaS customers who want to create test user accounts in
Clarity
. In previous releases of
Clarity
SaaS, if customers created a test user with an invalid email address then they did not get any Okta activation information. In
Clarity
15.9.1 and higher releases, you can create a test user in
Clarity
where the user name and primary email address are invalid and the secondary email will be a valid email. You can use the same secondary email address for all test accounts.
After you create the new user in
Clarity
, Broadcom’s Okta “Just in time” (JIT) user creation automatically creates the user (in Okta) after receiving a SAML request. The user’s primary and secondary email is now configured in OKTA. However, once
Clarity
creates a user in OKTA, it will not update any details in OKTA. You need to work with your OKTA Group administrator to update user details in OKTA.
Upgrade Action
: No action required. Administrators can now specify a secondary email address for a user in
Clarity
.
To learn more about authentication for
Clarity
SaaS, see Clarity SaaS Authentication in the Google Cloud Platform.
To learn more about adding users in
Clarity
and specifying the secondary email address, see Configure User Accounts, Skills, and Access Rights.
Support for Jaspersoft 7.8
Clarity
15.9.1 and higher release now support Jaspersoft 7.8. Clarity 15.9.1 also supports Jaspersoft 7.1.3.
When you plan to install Jaspersoft 7.8, some of the key things you need to remember are:
  • You need to be on Clarity 15.9.1 and Jaspersoft 7.1.3 to upgrade to Jaspersoft 7.8.
  • Jaspersoft 7.8.0 includes an installation keystore. Create a backup of the installation keystore (<user.home.dir>/.jrsks & <user.home.dir>/.jrsksp) to ensure you can connect to the Jaspersoft database in case of any issues. You will not be able to access your data if you don't have a copy of the keystore files. If you are using a Windows server, the keystores are available under C:\users\<user directory>.
  • Jaspersoft 7.8.0 now supports TCPS for the Oracle 19c database. Customers who wish to upgrade to Jaspersoft 7.8.0 and switch to TCPS would need to install Jaspersoft 7.8.0 on Oracle 19c. They can then import content from their current Jaspersoft instance.
  • Jaspersoft 7.8.0 supports PostgreSQL. You can only use PostgreSQL for Jaspersoft after
    Clarity
    (on-premise) officially supports PostgreSQL (expected in May 2021). You cannot install Jaspersoft on PostgreSQL and configure it to work with
    Clarity
    in scenarios where
    Clarity
    uses Oracle or MSSQL database. 
  • Jaspersoft 7.8.0 also supports Microsoft SQL Server 2017 and Microsoft SQL Server 2019.
  • Jaspersoft 7.8.0 supports the Adopt Open JDK 11 and Tomcat 9.0.37.
  • Jaspersoft 7.8.0 requires you to install Chrome 85 or higher release on the server where you plan to install Jaspersoft.
  • When you export content from Jaspersoft 7.8.0, use the Legacy Key option to ensure you can import content on all existing Jaspersoft servers.
  • Jaspersoft 7.8 will not work on Internet Explorer. You can use the relevant versions of Chrome, Firefox, and Edge.
Upgrade Action
: You need to perform the following steps after you upgrade to Jaspersoft 7.8
  • Run the Restore Domains job - The domain structure got updated in Jaspersoft 7.8. The Restore Domains job will import the out-of-the-box domains available with Jaspersoft 7.8
  • Run the Load Datawarehouse job - This job will add all the custom attributes and customization into the Jaspersoft domains.
  • Update the Domain Schema - If you have created custom domains from out-of-the-box domains, you need to use the Update Domain Schema option. Follow these steps:
    1. Log in to Classic PPM and select
      Home
      ,
      Advanced Reporting
      .
    2. Select
      Manage
      ,
      Update Domain Schema
      and select the relevant
      Domain Name
      and
      Domain Schema
      .
Internet Explorer 11 Not Supported for
Clarity
Features
Classic PPM
still supports IE 11; however,
Clarity
cannot extend backward compatibility with any old browser technology, including IE 11.
This is not a known issue with
Clarity
. Instead, it is a known issue with IE 11. Microsoft has invested in a new browser, Microsoft Edge.
If users ignore the support requirements and attempt to use IE 11 with
Clarity
, the following problems could occur:
  • 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
Clarity
, switch to a new browser such as Edge, Firefox, or Chrome.
Telemetry Enhancements
Telemetry is a capability that is integrated into
Clarity
to send product usage and system configuration data to Broadcom. This data helps Broadcom gain insights into customers' product usage, understand their software needs, and focus on the features and platforms that are most commonly used. Telemetry DOES NOT collect any personally identifiable information (PII).
The Opt-In capability is no longer available when you configure the Subscription Compliance Setup section in the General System Settings.
Clarity
will send telemetry data to Broadcom for all your
Clarity
production servers. To learn more about the Telemetry capability, see Configure General System Settings
Dashboards Not Available in Google Cloud Platform
The Project Management Schedule Dashboard and Project Management Cost and Effort Dashboard portlets have been deprecated in the Google Cloud Platform. Please review this KB article for more information.
Microsoft Project Integration Upgrade Details
You should uninstall and upgrade your
Clarity
Microsoft Project Integration software using the version available after upgrading
Clarity
in Account Settings-> Software Downloads. Note that the Microsoft Project Interface bit level installed should match that of Microsoft Project. Microsoft Project Interface (x86) should be installed for 32 bit versions of Microsoft Project and Microsoft Project Interface (x64) version should be installed for 64 bit versions of Microsoft Project.
Updated Logout Behaviour for SAML Users
In previous releases,
Clarity
would redirect users to the errorURL when it receives SAML request that it could not process. In
Clarity
15.9 and higher releases,
Clarity
redirects users to the logout URL when it receives a valid SAML request with the following issues:
  • Clarity
    cannot find the user in its user store or
  •   The user is inactive in
    Clarity
    .
Users that use Spanish (Peru) locale will now have the period symbol as a decimal separator.
Change
: Users that use the "Spanish (Peru)" locale will now have the period "." symbol as the decimal separator instead of the comma "," symbol.
Impact
: If the user keeps the Peru locale and tries to use the comma as the decimal separator the symbol will be ignored and it will cause entered values to be saved as large integers instead of the expected value with decimal digits. If desired, the user can choose a different locale in account settings that uses the comma as the decimal separator.
More Details
: The Official Institute of Taxation of Peru uses "." as its decimal separator. Therefore Java (JDK 11.0.5) has been fixed to honor the period symbol instead of a comma. For more details on the Java fix reference their KB article.
Cannot Upgrade on Oracle Until Security License and MD5 Package Are Enabled
  1. Contact your database administrator or Oracle to obtain the advanced security license (OAS) required only if using DBMS_CRYPTO.
  2. Enable and grant explicit permissions to dbms_obfuscation_toolkit.md5 (also provided with your Oracle installation).
  3. Start the upgrade.
Known Issue Due to Dropped Support for Languages
This release no longer supports the following languages:
Catalan
Czech
Danish
Finish
Hungarian
Dutch
Norwegian
Polish
Russian
Swedish
Turkish
Chinese-Simplified
Chinese-Traditional
Korean
As a result, a user might see a raw text label or English text in the user interface instead of the translated text.
Workaround
: Switch your
Clarity
account settings to one of the supported languages listed in the Release Notes.
Clarity
help will be available only in English for a couple of months after release. The Help link in
Classic PPM
will automatically redirect you to the English site. The help link in
Clarity
currently defaults to the localized site and displays a blank page since the content is not localized. Broadcom will fix this issue in future releases.
Export to CSV Shows No Per-Period Metric Data Unless Totals Column is Present
The project STAFF and ASSIGNMENTS grids use the Totals and Per-Period Metrics columns for ETC, ETC Cost, Actuals, and Actual Cost.
  • If the Totals column and the Per-Period Metrics columns are configured on the grid, the Export to CSV file feature works as expected.
  • If you don't have the Totals column configured in the grid, the export does not work as expected (all per-period metric columns are blank).
Workaround
: In the grid, click Column Panel and add the Totals column to the grid layout before using Export to CSV.
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
Review Cancelled Jobs After Upgrade
Please review any
Clarity
jobs that are in the Canceled state after your upgrade is complete. Please pay special attention to any canceled jobs that were previously recurring jobs. Sometimes, after an upgrade, job parameters change and the jobs move to a canceled state. If you don't proactively review canceled jobs, you will only notice them after you receive escalations from the business.
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
Classic PPM
  • Data Warehouse Configured
  • Load Data Warehouse Job Completed
Clarity
  • PMO Accelerator Add-in Installed
Install PMO or APM add-ins
  • Data Warehouse Configured
Supported Upgrade Paths for Clarity
15.9.1
Please review the table to identify the minimum supported release from which you can upgrade to the latest version of
Clarity
.
Clarity Version
Minimum Supported Version for Direct Upgrade
15.9.1
15.7.0
15.9
15.6.1
15.8.1
15.6.1
15.8.0
15.3
15.7.1
15.3
15.7.0
15.2
15.6.1
15.0
15.6.0
15.0
15.5.1
14.3
15.5.0
14.3
15.4.1
14.1
15.4.0
13.2
15.3
13.2
15.2
13.2
15.1
13.2
  • If you have Release 14.3 or older, your release is no longer supported. Upgrade to Release 15.4 first, and then upgrade to
    15.9.1
  • You cannot upgrade to Release
    15.9.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.8 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 earlier 13.x releases, it often helps to upgrade to 14.3 or 14.4 first and skip the Advanced Reporting component. This approach simplifies the troubleshooting and restart process if an upgrade step fails. Then, from 14.x, you can upgrade to 15.6 and install Jaspersoft 7.1 for Advanced Reporting.
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.4 to 15.5, from 15.5 to 15.5.1, from 15.5.1 to 15.6, from 15.6 to 15.6.1,  from 15.6.1 to 15.7, from 15.7 to 15.7.1, from 15.7.1 to 15.8, from 15.8 to 15.8.1, and from 15.8.1 to
15.9.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 help 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.8. After the upgrade, install the latest 15.8 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. You can also visit the
Clarity
Community
to collaborate with other community members about your specific questions.
Pre-Upgrade: Run the Installation Checker (On-Premise Only)
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
    installer to the
    Clarity
    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  (On-Premise Only)
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
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
, 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  (On-Premise Only)
If your
Clarity
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 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
Custom Processes, Scripts, and Other Customizations
Clarity
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 a 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
    Clarity
    .
  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,
Clarity
provided the functionality with no net loss to end-users. We recommend that you perform an analysis comparing the value of
Clarity
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  (On-Premise Only)
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
Clarity
directory using ant-based scripting. Use ant scripts to automate preserving and restoring customization in
Clarity
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-Premise Only)
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'