Change Impact and Upgrade

ccppmop159
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.0
. 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.0
. 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.0
, 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.
2
Clarity
User Interface Enhancements

Select Favorite Object Instances (On-Premise Only)

You can now mark various object instances as your favorite by associating a star against them. This allows you to easily flag and find instances that require extra monitoring or attention. You can mark an instance as a favorite by adding the Starred attribute to the Grid layout or to the Details panel in
Clarity
.
Fav.png
You can mark the following object instances as a favorite:
  • Project
  • Ideas
  • Custom Investment Type
  • Roadmap
  • Hierarchies
  • Custom Object
Some other actions you can perform with Starred instances are:
  • Filter for Starred instances
  • Save a view with starred object instances
  • Import Starred Object instances into Hierarchies and Roadmaps
The "Favorites" feature is currently not available out-of-the-box for on-premise and SaaS
Clarity
customers. After upgrading to
Clarity
15.9, some of our SaaS customers reported issues related to this feature. With this in mind, the Favorites feature has been disabled for
Clarity
SaaS customers. While the feature is available in
Clarity
15.9, it has been hidden in
Clarity
15.9 Patch 1 for on-premise customers. Please contact the Broadcom Support team if you want to enable this feature in your environment.
  • You do not need "Edit" rights to set an object instance as a favorite.
  • The Starred attribute is not available in the object definition in
    Classic PPM
    . You cannot modify it.
  • You need to manually add the Starred attribute to the grid layout, or Details panel.
  • You can mark an object instance as a favorite only for top-level objects. This functionality is not available for sub-objects such as Tasks.
  • If you mark an object instance as a favorite, only you will be able to see the star associated with it. The star will not be visible to other users.
  • The location of the Starred attribute in the column panel and the filter is not sorted correctly. This is a known issue and will be fixed in future releases.
Upgrade Action:
No impact. When you upgrade to
Clarity
15.9.0
, you can add the Starred attribute to the Clarity grid from the column panel and start marking your favorite object instances.
To learn more, see Common Components
Customize the Theme Colors
You can customize the background color and the foreground colors to reflect your organization’s branding. You can also use it to differentiate between various environments, such as development, QA, and production.
Theme.png
Clarity
supports the following CSS color formats:
  • HEX
  • RGB
  • HSL
  • You can also type in the color name
You can also select the light or dark color scheme for menu icons, text, and login logo.
 
Clarity
does not support the CMYK, HSV, and NCol CSS color formats.
Upgrade Action:
No impact. When you upgrade to
Clarity
15.9.0
, you can customize the background color and the foreground colors to reflect your organization’s branding.
To learn more, see Clarity: System Settings
Quick Save Functionality for Views
The Quick Save functionality allows you to save changes to your view in a single click. Consider a scenario, where you opened a High Priority view on the Ideas page. The view shows all ideas grouped by priority and sorted by ROI. You have now added the Starred attribute to the grid and selected a few favorite ideas. You can simply click the Save button to save your changes to the view.
SV.png
If you are not the owner of the view that is loaded for you, you will see the view name as “(copy) saved view name”. When you make changes, your view name will change to "Unsaved copy saved view name". You can now save your view whenever you are ready.
Upgrade Action:
In previous releases of
Clarity
, you would need to open the view selector, select the view, and finally save your changes. You can use the Quick Save functionality in
Clarity
15.9.0
to save your view in a single click.
To learn more, see Common Components
Enhancing the Drop-Down Component
The drop-down component for
Clarity
has been enhanced. It will now dynamically display a drop-up or a drop-down list depending on the length of the list and the area available on the screen. This enhancement makes it vastly easier for you to select and view options.
DropDown
Upgrade Action:
No impact. When you upgrade to
Clarity
15.9.0
, you dynamically see a drop-up or a drop-down list depending on the length of the list and the area available on the screen.
Logical OR Available for Filters
Clarity
now allows you to use the logical OR filter to quickly identify relevant records. In previous releases, you could only use the AND filter when you filtered using multiple attributes.  From this release, you can use Match All (AND) or Match Any (OR) options to filter various records. Consider an example where you want to identify all ideas that have the Priority set to high or have the Planned ROI between 100% to 400%. In such scenarios, you can select the Priority and Planned ROI attributes in the filter and use the
Match Any
option. You will see the relevant ideas that match this criterion.
OR
Upgrade Action:
In previous releases, the logical OR was not available for filters. When you upgrade to
Clarity
15.9.0
, you can start using the logical OR filter to identify relevant records and create new views.
To learn more, see Common Components
Enhancements to the Date Data Type
Clarity
now supports localized date formats based on the following factors:
  • Option selected by the user in the Settings page
  • Locale specified for the user
Date
Example
: Janet has selected the short (8/18/20) option on the Settings page and her locale is set to UK.
Clarity
will display the date as 18/8/2020. If you change the locale to the United States,
Clarity
will then display 8/18/2020. If you update the locale to Japan,
Clarity
will display 2020/8/18. You can also enter the date directly in the grid by using space, forward slash, a hyphen, and period as separators. You can also enter single digits or mixed digits. The data entry format will be validated based on your locale. If you do not use a locale-appropriate format, the error is highlighted with a red border around the cell.  For example, if your locale is set to UK, you cannot enter the date as, 8/18/2020.
Upgrade Action:
No impact. When you upgrade to
Clarity
15.9.0
, the new date option will be available to you.
Inactive Indicator for Investments
When you mark an investment as inactive,
Clarity
will display an Inactive indicator next to the investment name.
Inactive
Upgrade Action:
No impact. When you upgrade to
Clarity
15.9.0
, you can view the Inactive indicator next to the investments that are inactive.
Timesheet Usability Enhancement – Submit Button
In some cases, customers have reported that users are inadvertently creating and submitting their timesheets with no data, causing unnecessary administrative effort. The Submit button has been removed from the Create Timesheet page and is no longer available. Users can only submit a timesheet after they have populated it.
Inactive
Upgrade Action:
In previous releases of
Clarity
, the Submit button is available on the Create Timesheet page. When you upgrade to
Clarity
15.9.0
, the Submit button will no longer be available on this page. You can only submit a timesheet after you have populated it.
Support for Additional Attributes

Support for Attachment Attributes in
Clarity
You can now manage the attachment attributes of stock and custom objects in
Clarity
. Previously, the attachment attributes were only available in
Classic PPM
. This enhancement allows you to use
Clarity
for processes that require uploading documents to an attribute. With this enhancement, you can API enable the attachment attributes and make them available in
Clarity
Once the attribute is API enabled, you can do the following:
  • Configure the attachment attribute to be displayed in the Details panel of the Timeline, Board, and Grid layouts.
  • Configure the blueprint of the corresponding object to display the attachment attribute on the Properties page.
  • View, upload, and delete attachments in the Details panel or in the Properties page.
Attach
  • This enhancement is not supported for objects that do not have the Details panel or Properties page. For example, Roadmap Items and Cross-Project Tasks. Use
    Classic PPM
    to manage the attachment attributes for these objects.
  • The attachment attribute cannot be added to the grid in the Grid Layout or to the cards in the Board Layout. Use the Details panel or the Properties page to view, upload, or delete attachments.
  • Just like in
    Classic PPM
    , multiple files cannot be uploaded in one go, when uploading files to an attribute that supports multiple documents. Upload one file at-a-time.
  • When you create an instance (such as a Project or Idea) from the Board layout in
    Clarity
    , the attachment attributes appear disabled until all the mandatory fields are filled out.
Upgrade Action:
After you upgrade to
Clarity
15.9.0
, you need to API enable the various attachment attributes that you want to display in
Clarity
. For more information, see API Enable Custom Attributes.
To learn more, see Attachment Attribute.
Clarity
OBS Display Enhancements
Clarity
Uses Slash as OBS Delimiter
Clarity
now uses a slash ( / ) as an OBS unit separator. In the previous releases of
Clarity
, you would use the greater than symbol ( > ) as the OBS unit separator. This change allows you to use the slash symbol in filters to search for specific OBS units.
Clarity
Grid Now Shows the Complete OBS
The
Clarity
Grid now shows the complete OBS value. You can either expand the column or use the tooltip to view the complete OBS value.
OBS
You will need to expand the Details panel to view the full OBS path. You can also click
Configure
and expand the OBS field length to be wide enough to display the full OBS path.
Upgrade Action:
No impact. When you upgrade to
Clarity
15.9.0
, you will see all these improvements in the product.
Cost Plans and Budgets Enhancements - Total Units and Total Revenue
The “Total Units” and “Total Revenue” attributes are available out-of-the-box in the Financials module, Cost Plans, and Budgets pages. The attributes are available in the grid, the Details layout, and the filter for Projects, Ideas, and Custom Investments.
Total
Upgrade Action:
No impact. When you upgrade to
Clarity
15.9.0
, these attributes will be available in
Clarity
.
Task Enhancements – Guidelines
The “Guidelines” field is available out-of-the-box in the Task module for Projects and Custom Investments. The attributes are available in the grid, the Details layout, and the filter. Project managers typically use guidelines to provide additional information to assist users with their immediate tasks.
Total
Upgrade Action:
No impact. When you upgrade to
Clarity
15.9.0
, the Guidelines attributes will be available.
Common Grids Usability Improvements

Multi-Select Delete Now Available in
Clarity
Common Grids
You can use the Bulk Delete capability in the Common Grid to delete multiple records. Consider a scenario where you have created a project from a template and want to delete specific tasks that were created. You can now select multiple tasks and use the Delete button to delete all the tasks. If you select more than one record,
Clarity
will prompt you to confirm your action before deleting the records.
Total
  • This capability is not available at an instance-level. Hence, you cannot bulk delete multiple projects, ideas, custom investments or custom objects. However, once you navigate to the Staff, Tasks, or other modules within an investment, you can select multiple records and delete them.
  • Clarity
    business logic will supersede the delete request wherever applicable. For example,
    Clarity
    will not delete a task that has actuals associated with it.
  • You cannot use the Bulk Delete options in the following grids:
    • Cost Plans (single delete only)
    • Cost Plan Details (single delete only)
    • Budgets (not allowed)
    • Budgets Plan Details (not allowed)
    • Status Report Grid (Project Sub-Object)
    • Cross Project Task Grid
    • Staffing Workspace
    • Roadmap Items
Upgrade Action:
No impact. When you upgrade to
Clarity
15.9.0
, the Bulk Delete capability will be available.
To learn more, see Common Components
Assign Tasks By Using the Details Panel on Tasks Module
You can now assign resources, teams, or roles to a task by using the Assignments tab on the Details Panel of the Tasks Module. The Assignments tab provides you all the functionalities that you get with the Assignments module. Hence, you can manage task assignments, perform resource and role planning, and monitor estimated-to-complete (ETC) values for your team members. You can click
Expand
to use some key capabilities of the common grid such as Views, Group-by, Filter, and Export to CSV.
  • If a Task, such as Phase, does not support Assignments, you will see the "This Task type does not support assignments" message when you navigate to the Assignments tab.
  • Actions are not supported for Milestone or Summary Tasks.
  • All grid configuration changes made from the Assignments grid on the Details panel are reflected in the Assignments module.
  • All grid configuration changes made from the Assignments module are reflected in the Assignments grid on the Details panel.
  • The views in the Assignments Module and in the Assignments grid on the Details panel are independent. If you create a view on the Assignments module, it will not be available in the Assignments grid on the Details panel. Similarly, if you create a view on the Assignments grid on the Details panel, it will not be available in the Assignments module.
Group
Upgrade Action:
When you upgrade to
Clarity
15.9.0
, the Assignments tab includes the grid that is available with the Assignments module. In previous releases of
Clarity
, the Assignments tab had a drop-down list that was used to assign a task to a resource, role, or team.
Enhancements to Group By Mode
If you group the columns in the grid by a specific attribute and update the dimensions of various columns, your changes will be saved when you save the view in
Clarity
. This was not the case in previous releases. Also, your configuration changes will persist if you navigate from the grid and return – prior to saving the view.
Group
Upgrade Action:
No impact. When you upgrade to
Clarity
15.9.0
, the enhancements to Group By Mode capability will be available.
Fiscal Period Column Headings Have Colors
All common grid column headers configured to display per-period (e.g., TSV) data are assigned a unique color to improve visibility and readability. This enhancement will help you distinguish per period metrics (TSV’s) from each other. The applied column heading color does not have a specific meaning since an attribute is not mapped to a specific color.
  • The following grids support color-coded per-period metrics (TSV’s):
    • Staff module
    • Assignments module
    • Cost Plan Details
    • Budget Plan Details
    • Benefit Plan Details
  • Clarity
    assigns colors to each column header in the order the metric fields are selected from View Options. The same colors, for each selected per-period metric, will also be visible in the column configuration panel.
Group
Upgrade Action:
When you upgrade to
Clarity
15.9.0
, your existing fiscal period column headings will now have colors.
Custom Object Enhancements

Details Module Renamed to Properties Module
The “Details” module in the blueprint has been renamed to “Properties” in the blueprint. This change helps you distinguish between the Details panel in the grid and board layout. In the custom object grid view, the object instance information tab will still be called “Details”. Opening the object instance will display the “Properties” module.
Group
Upgrade Action:
When you upgrade to
Clarity
15.9.0
, the Details module for all your investments will be renamed as the Properties module.
Custom Sub Objects Available in Details Panel
You can configure
Clarity
to display custom sub-objects in the Details panel. This allows you to review, edit, and analyze data associated with custom sub-objects in the Details panel. Consider a scenario where a customer uses
Clarity
to manage projects and products. They have created a custom object named Vendors to capture details associated with vendors for products. They have also created two sub-objects to capture data related to Distribution Location and Purchase Order. These sub-objects are available as modules in the Blueprint associated with the Vendor object. You can view the sub-objects in the Details panel by using the
Show in Details Flyout
option.
Group
You can view the sub-objects in the Details panel by performing the following steps:
  1. Ensure that the custom sub-object is API enabled.
  2. Create a copy of the Custom Object blueprint and edit it.
  3. Add the sub-object as a module and select the
    Show in Details
    checkbox.
  4. Associate the new blueprint with the record.
  5. Navigate to the custom object and select a record.
  6. Open the Details panel and navigate to the sub-object module.
  7. Edit details by using the grid layout.
  • The tabs in the Details panel now have names instead of icons to distinguish between various sub-objects.
  • The tabs in the Details panel now have a scroll so that you can navigate between various sub-objects.
    Group
  • Sub-objects share the grid between module and Details panel.
  • The Grid View layout defined in the module will be reflected in the details panel. Any changes you make in the Details panel will also be reflected in the grid.
  • Sub-objects in the Details panel cannot have their own panel.
  • You can expand and close the sub-object to have a larger viewing area.
  • The state of the Details panel is retained till the user changes it.
    Clarity
    persists the state even if the user logs out.
  • The tab selected with the Details panel is also retained.
Upgrade Action:
When you upgrade to
Clarity
15.9.0
, you can API-enable custom sub-objects and use the Show in Details Flyout option to ensure they are available in the Details panel.
To learn more, see Common Components
Field-Level Security for Custom Objects
You can now secure custom object attributes by using Field-Level Security (FLS). You can leverage the
Clarity
common grid to secure attributes. Once an attribute is secure, it will have a secure icon adjacent to it. This icon is displayed in the Grid layout, the Details panel, and the Properties module.
Group
When a user with the View access right tries to edit the attribute in the grid, they will see a denial icon displayed and the field will be grayed out. Users who do not have View or Edit access, will not have an option to add the secured attribute to their view. If the user accesses a saved view where a secured attribute is included, then the view is presented without that attribute, in an unsaved state.
  • You need the Administration - Access and Attributes Management – Navigate access right to setup FLS.
  • You can assign access right only to user groups.
  • Clarity
    Business rules take precedence over FLS.
  • FLS takes precedence over Instance/OBS/Global rights.
  • Field level security is only applicable to
    Clarity
    . FLS does not impact
    Classic PPM
    .
  • You can only secure attributes whose REST API aliases are populated.
Upgrade Action:
No impact. When you upgrade to
Clarity
15.9.0
, you can use field-level security to secure custom object attributes.
To learn more, see Secure Field Level Access
Clarity
Roadmap Enhancements

Usability Enhancement – Import from PPM
When you use the Import from PPM option, to import investments from
Clarity
, they will now appear in an alphabetical list. Investments will be alphabetized by name and not ID.
Import
Upgrade Action:
When you upgrade to
Clarity
15.9.0
, and use the Import from PPM option, investments will now appear in alphabetical order.
Synchronize Additional Attributes
Roadmap items now support the “Large String” attribute. The Matching Custom Attributes capability has been expanded to now synchronize the following attributes:
Import
  • Lookups (SVL) - (Static and Parameterized)
  • Number
  • String
  • Boolean
  • Date
  • Money
  • Large String
  • Clarity
    will synchronize additional attributes when you select the "Matching Custom Attributes“ option.
  • Clarity
    matches attributes based on API Attribute ID and type.
  • If you select the "Matching Custom Attributes" option and
    Clarity
    finds a match based on these criteria, the data will be populated from the investment to the roadmap item.
  • When you synchronize Large String attributes,
    Clarity
    will copy the data as is, including special characters and formatting.
  • When you synchronize the “Money” attribute,
    Clarity
    will copy the amount without any conversion.
  • When you synchronize the “Money” attribute,
    Clarity
    requires two pieces of information namely currency and amount.
Upgrade Action:
When you upgrade to
Clarity
15.9.0
, and use the Import from PPM option, investments will now appear in an alphabetical list. You can also synchronize additional custom attributes.
Improvements to Hierarchies

Improved Import Capabilities
You can now import investments into Hierarchies by using the object grid. You can use existing saved views to find specific investments to import. You can also use the Details panel view to get additional details of the investment instance prior to importing it into Hierarchies.
Import
Upgrade Action:
When you upgrade to
Clarity
15.9.0
, you will be able to import investments into Hierarchies by using the object grid.
Word Wraps in Card Names
Clarity
will wrap Card titles and display long titles properly. The level of zoom will determine the amount of title that is displayed.
Import
Upgrade Action:
When you upgrade to
Clarity
15.9.0
, the card titles will be wrapped to display long titles properly.
Plus Icon on Bottom of Card
Investment cards with children will now display an expandable icon at the bottom. The Minus icon is displayed when the children are displayed. The Plus icon is displayed when children are hidden. No icon is displayed if a card does not have a child. When you collapse a card’s child, all the levels below it will automatically collapse.
Import
Upgrade Action:
When you upgrade to
Clarity
15.9.0
, investment cards with children will now display an expandable icon at the bottom.
Right-click Context Menu on Cards
Right mouse click for investment cards has a context-sensitive menu. The Menu options will depend on the following factors:
Import
  • Card has children
  • Card has parents
  • Any card’s child is hidden (not just the selected card)
  • The option to delete a card is always displayed in the menu.
Upgrade Action:
When you upgrade to
Clarity
15.9.0
, you can right-click investment cards to open a context-sensitive menu.
Open an Investment Card Item Instance (Double-click Action)
Double-clicking an investment card will open the investment instance. You will have the ability to navigate back to Hierarchies. Any changes you make to the object instance are immediately reflected when navigating back to Hierarchies.
Import
Upgrade Action:
When you upgrade to
Clarity
15.9.0
, you can double-click investment cards to open the associated investment instance.
Improvements to the
Clarity
-
Rally
Integration
This release includes the following improvements to the Synchronization Job in
Clarity
-
Rally
Integration:
  • When a project fails to synchronize due to system-level exceptions, the Agile Integration “Synchronize” option for the project retains the configuration setting. In the previous releases, the “Synchronize” option was getting automatically unchecked for such projects and the administrator had to manually select it to enable the projects for future synchronization.
  • When a project cannot be synchronized due to system-level exceptions, the synchronization job logs an error message with the details of the impacted project and continues to process the remaining projects. Previously, the synchronization job would abort when it encountered a system-level exception
  • The integration is optimized to comply with the data limit set by
    Rally
    . This optimization helps ensure that the synchronization job does not fail due to the breach of data limit.
  • The logging enhancements to the synchronization job provides more meaningful data to help troubleshoot issues efficiently. The logs now include specific workspace details such as; Project ID, API ID, Owner ID, and so on, that help identify the problem quickly.
Upgrade Action:
After the upgrade, the improvements will be effective on your existing integration setup. 
To learn more, see Integrate
Clarity
with
Rally
REST API Enhancements
Using the
/virtual/userProfile
API, you can now retrieve the user profile information such as first name, last name, email ID, locale, and so on, of the logged-in user. For more information, see Retrieve User Profile Information using API.
Upgrade Action:
When you upgrade to
Clarity
15.9.0
, you can start using the User Profile API.
Jaspersoft Enhancements
Added Support for New Date Format
Ad hoc Views now support a new international date format of “dd MMM YYYY”. This date format is available regardless of the user locale. The date format can be selected from the context menu in an ad-hoc view.
Import
Upgrade Action:
When you upgrade to
Clarity
15.9.0
, the new international date format of “dd MMM YYYY" will be available to you.
Domain Designer Issue Fixed (SaaS Only)
When customers migrated from our old SaaS datacenter to GCP, their database also changed from Oracle to PostgreSQL. PostgreSQL is case-sensitive and returns database table and column names in lowercase, unlike Oracle which returned database table and column names in upper case. This issue meant that any custom domains in JasperSoft would break if the customer tried to edit it. The Doman Designer issue has been resolved in this release.
Upgrade Action:
When you upgrade to
Clarity
15.9.0
, the domain designer issue will be resolved.
New Administration Portlets

Three new administrative portlets have been added in
Clarity
to provide details on time slices.
Import
  • Current Process Time Slice Requests: Displays any currently executing time slice jobs.
  • Time Slice Request Status: Shows the current status of all Time Slice Requests, including custom slices and internal slices.
  • Time Slice Counts: Slice count data from the past sixty runs of the job.
Upgrade Action:
When you upgrade to
Clarity
15.9.0
, the new portlets will be available to you.
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.
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
    .
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.
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 Canceled Jobs After Upgrade
Please review the 
Clarity
jobs that are in the Canceled state after your upgrade is complete. Please pay special attention to any canceled jobs that are scheduled to recur.  Sometimes, job parameters can change after an upgrade, causing the jobs to move to the canceled state. Review these jobs, create a new scheduled job for each of them, and update the parameters as necessary. You can then delete the canceled jobs. Review and reschedule these jobs proactively to avoid 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 Release
15.9.0
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
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.0
  • You cannot upgrade to Release
    15.9.0
    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.0
.
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'