Change Impact and Upgrade

ccppmop160
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
. 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
. 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
, 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-Rally Integration Enhancements

Access Clarity Timesheets from Rally
Univ
As a Rally user, you can now access Clarity's Timesheet directly from Rally in SSO and non-SSO authentication environments. Timesheets open in a separate browser window. You simply need to add Tasks to the timesheet (if required), record time, and submit the timesheet.
The Clarity Timesheet app is a 'Core' Rally app, which Broadcom fully supports.
Upgrade Impact:
When upgrading, some key points you must remember are:
  • The new core Clarity Timesheet app replaces the former community app.
  • You must add the Clarity Timesheet app by using the gear icon.
  • The new core Clarity Timesheet app is supported with all supported Clarity releases.
Access Rally by using Channels in Clarity
Univ
You can access Rally directly from Clarity when Rally is configured as a Clarity Channel in SSO and non-SSO authentication environments. As with all Channels, the Rally application is accessed in the context of the Clarity investment, and no separate browser window is opened.
Upgrade Impact:
After you upgrade to this release, you can access Rally from Clarity by using channels.
Map Parent Field in Clarity and Rally
Linked
You can now map and synchronize Clarity's Parent field value to Rally's Parent field value. This ensures that changes are synchronized between both systems when you update the parent values in Clarity or Rally. Hence, when you use the Auto-Import Children option in Hierarchies, you can see the latest relationship between various investments in your organization.
Consider an example where you have created a set of Business Outcomes in Clarity and mapped them to Initiatives in Rally. You have also created Projects and mapped them to features in Rally. You can now create a bi-directional field mapping between the Parent fields in Clarity and Rally to ensure that the change is reflected in both of them whenever you update a parent for a project in either system.
Remember that you must execute the Synchronize Mapped Information job to synchronize the values between both systems.
Upgrade Impact:
Ensure that you have installed the latest version of the PMO-Accelerator content add-in to leverage the new capabilities. There is no change in functionality for the Import Integration Mappings, Synchronize Mapped Information, and Import Staging Tables jobs.
To learn more, see Integrating Clarity and Rally.
Map Custom Lookups from Clarity To Rally
Univ
You can now map Clarity single-value lookups to custom lookups (also called drop-down lists) in Rally. In the previous release, you could only map Clarity lookups to four Rally lookups, namely Rally Investment Categories, Rally Milestones, Rally Projects, and the Rally States.
Let's consider a scenario where you have a custom lookup in Rally titled Business Risk and want to map it to the Business Operational Risk lookup in Clarity. You can now:
  1. Create a New Lookup mapping in Clarity to map the values between the Business Operational Risk lookup in Clarity and the Business Risk lookup in Rally.
  2. Create a field mapping between these lookup fields to ensure data is synchronized.
When you update the value of the Business Operational Risk attribute in Clarity and run the Synchronize Mapped Information job, the Business Risk field in Rally will be automatically updated.
Some key points you must remember are:
  • In this release, you can only update custom lookup values in Rally based on changes in Clarity. The Rally-to-Clarity update is not supported.
  • Please review the Data Type Compatability table to review the supported mapping options. Clarity currently only supports mapping to the Drop Down List attribute type in Rally. You cannot map to the Drop Down list (Multi-Value) and Drop Down List (User) attributes.
  • In this release, you cannot map a Clarity number lookup to a Rally custom lookup. You can only map a Clarity string lookup to a Rally custom lookup.
Upgrade Impact:
Ensure that you have installed the latest version of the PMO-Accelerator content add-in to leverage the new capabilities.
To learn more, see Integrating Clarity and Rally.
Roadmaps Enhancements

Export the Roadmap Timeline to PDF
Linked
You can now export the Roadmap timeline view to a PDF file so that you can now include Timeline visuals in presentations or other documents for stakeholder communication. The Export capability is available in the Item Actions menu. The exported PDF includes the agreements, dependencies, and events defined in the roadmap. The exported file name follows the pattern "<roadmap name>_<saved view name>."
Some key points you must remember are:
  • When the exported PDF dimensions (Width X Height) are less than (or smaller) than the default dimensions, the PDF generated will use the default dimensions 1366 W X 768 H.
  • When the exported PDF dimensions (Width X Height) are greater than (or larger) than the default dimensions, the PDF generated will use the dimensions of the generated file.
  • Adobe Acrobat has a limitation with PDF files exceeding a 200" (horizontal) X 200" (vertical) dimension. The PDF file will open upon export but display an error message indicating some of the content may be truncated. If a Roadmap Timeline exceeds the PDF limitation, you will not experience any issues when viewing the Timeline within a supported browser.
  • Clarity's current job (Purge CSV Downloads), created to clean up CSV export files, has been updated to clean up PDF export files. The Purge CSV Downloads job is not available to the end-user from the (Classic PPM) and runs every day at 12:30 midnight and cleans up files older than seven days.
Upgrade
Impact
: After you upgrade to this release, you will be able to leverage the Export to PDF capability.
View Business Agreements on the Roadmap Timeline
Linked
The Business Agreements workspace in Clarity enables you to define and manage agreements between investments in Clarity. Stakeholders can review these agreements before conducting the next roadmap planning activity or making decisions that impact the investment dates. You can review existing agreements between investments by selecting the Show Agreements toggle. The dependencies between agreements are indicated by using dotted lines to highlight predecessor and successor relationships.
The Roadmap Timeline tools to optionally show Dependencies, Text Overflow, and Agreements have been updated to a 'slider' from a 'check box' to improve the overall user experience from a consistency perspective.
Upgrade
Impact
: After you upgrade to this release, you can start using the Agreements capability in Clarity. After you define agreements, you can view them in the associated roadmaps.
Create and Manage Item Events in the Roadmap Timeline
Linked
For Roadmap Items with linked investments, you can now configure visual indicators to represent events such as milestones or other key (linked) investment dates in the form of a diamond, circle, triangle, square, star, flag, or rocket. Events represent linked investment dates such as investment start or finish dates, Milestone Tasks, or custom date attributes. You can leverage the Events sub-tab on View Options to define the icons associated with relevant events.
Some key points you must remember are:
  • If an event falls outside the Roadmap Item start or finish date, the Event will be positioned at either the start or finish on the Roadmap Item – whichever is closest to the Event date.
  • After using 'Import from PPM,' you must synchronize events defined with a custom date attribute to ensure they are visible and positioned on a Roadmap Item.
  • When Roadmap Items are moved (shifted left or right), Event positioning (e.g., their corresponding dates) will move relative to the Roadmap Item move.
  • If a Roadmap Item has (2) Events that fall on the same date, only the Event created last will be displayed on the Roadmap Item.
Upgrade
Impact
: After you upgrade to this release, you can start using the Events capability in Roadmaps.
Synchronize Roadmap Items with Linked Investments
Linked
You can synchronize additional fields such as Roadmap Item Description, Manager, Priority, Status, Status Indicator, and Stage with linked investments. Roadmap Item (Name) and Goal were the only fields available under the 'Other' section in prior releases.
The Sync All Attributes option is selected by default. You can clear this option and select only relevant attributes.
The 'Sync Linked Items' page becomes distorted if an attribute's name has too many characters. Changing languages or applying a label that results in too many characters can cause the 'Other' attribute listing to be incorrectly positioned at the bottom of the page.
Upgrade
Impact
: After you upgrade to this release, you will be able to synchronize the new attributes.
To learn more, see Clarity Roadmaps.
Enhanced Visual Experience During Drag and Drop in the Roadmap Timeline
Linked
The user experience for moving a Roadmap Item within the Timeline view has an exciting new look and feel. The User Experience becomes available when changing either the start date only, the end date only, or shifting the roadmap item left of right or between swim lanes. The visible Date Drag Guidelines with extra shading help you position the roadmap item on the timeline.
Timesheets Enhancements

Enhanced User Experience While Adding Tasks
Linked
The user experience for adding tasks to a timesheet has been enhanced in this release. You can choose from the following four options:
  • Select Tasks
  • Add Assigned Tasks
  • Copy Previous Timesheet
  • Copy Previous Timesheet (with time)
The Smart filters in Clarity recognize the current user and populate the timesheet based upon the selection. The Copy Previous Timesheet options are only selectable if a timesheet for the prior period exists.
Upgrade Impact:
After you upgrade, you will be able to leverage the enhanced user experience while creating timesheets.
To learn more, see Submit a Timesheet.
Enhanced Filters While Using Select Tasks Page
Linked
When you manually wanted to add tasks to a timesheet in previous releases, you used the "+Work" page that included a series of custom filters. You can now use the Add Tasks button and choose Select Tasks to open the Select Tasks generic grid in this release. This grid includes all the capabilities of the Clarity generic grid. You can view the powerful filtering capability to identify and add relevant tasks quickly.
Upgrade Impact:
After you upgrade, you will leverage the enhanced Select Tasks grid to add tasks to the timesheet.
To learn more, see Submit a Timesheet.
The following are the rules/conditions determining which Tasks are displayed in the new My Timesheet 'Add Tasks' grid:
  • A default filter (Assigned Resource = Current User) is applied when you choose the "Select Tasks" option.
  • Tasks for active investments (e.g., Projects, Ideas, CITs, and NPIOs) where the user is allocated to the investment as either an individual or as a member of a team assigned to the investment.
  • Tasks for which the user has been assigned either an individual or a team member allocated to the task.
  • Only when the corresponding user exists and is:
    • Open for Time Entry
    • Active
    • Labor
    • Not a role
  • The task is not a milestone or a phase.
Status Report Enhancements

In this release, three new capabilities have been  introduced in the Status Module:
  1. You can now configure report content and preview & publish in a PDF format in Ideas and Custom Investments with the "Living Status Report" capability.
    • You can create new reports from the "Reports" tab, configure report content, preview, publish to a PDF format, and manage existing reports or view previously published reports.
    • From the "Current" tab, you can configure report content, preview, and publish to a PDF format (for the most current report).
      StatusModule_LivingStatusReport.png
  2. You can simultaneously update multiple status reports using bulk edit from the 'Reports' tab or configurable grid view. The Status module grid includes a new 'Latest' attribute to indicate the most recent record (by date) combined with 'report status' set to 'final.'
    StatusModule_EditBulk.png
  3. From the Status module grid, you can indicate the most recent status report record using the new 'Latest' checkbox.  Clarity determines the latest report by using the 'Report Date' and 'Report Status=Final.'
Upgrade Impact
: When you upgrade to this release, the Living Status Report will be available to all users who have access to the Status module.
Task Management Enhancements

Edit Dependencies in the Task Timeline
Linked
You can now directly manage dependencies in the Timeline grid by editing the predecessor and successor fields. This capability was not available in previous releases, and it reduces the need to use multiple third-party tools to manage tasks. You can click WBS/Row icon to choose a preferred format and then edit the predecessor and successor fields to define the new dependencies.
Upgrade Impact
: When you upgrade to this release, you will be able to edit dependencies on the Task Timeline.
Simultaneously Assign Multiple Resources to Task Assignments
Linked
The newly introduced Assigned Resources multi-value lookup (MVL) shows you various resources assigned to tasks. You can now use the multi-select capability to select multiple resources for the task. This capability provides project managers with an improved user experience and reduces the total number of clicks to assign work.
When you use Bulk Edit to update 'Assigned Resources' (MVL), the existing data will be removed and replaced with the new selection(s).
Upgrade Impact
: When you upgrade to this release, you will be able to use the multi-select capability to assign multiple resources.
To learn more, see Manage Tasks.
Review Baselines in the Timeline Layout
Linked
You can leverage the Compare to Baseline action to view the current baseline in the Task Timeline. This option displays the baseline taskbars by using the baseline dates and the current dates. In this release, the Baseline module has been added to the default project blueprint. After your administrator adds this module to your blueprint, you will see the baselines for your projects.
Some key points you must remember are:
  • You don't need to have access to the Baselines Module to use the Compare to Baseline action.
  • You don't need any additional access rights to use the Compare to Baseline action.
Upgrade Impact
: When you upgrade to this release, you will be able to use the Compare to Baseline action. Also, you must add the Baselines module to the relevant blueprints manually.
Expand and Collapse All Investments In The Timeline Layout
Linked
You can use the Expand All and Collapse All options in the Timeline layout to expand and collapse all tasks.
Upgrade Impact
: When you upgrade to this release, you will be able to leverage the new Expand All and Collapse All functionalities.
Quickly Filter Tasks Assigned to Self
Linked
You can quickly locate my Task assignments using the 'smart' filter where 'assigned resources' is the current user. It provides team members an improved user experience and reduces the total number of clicks to find their work.
Upgrade Impact:
When you upgrade to this release, you will be able to leverage the smart filter capability.
Allocate Resources to Investments on the Staffing Page
Linked
You can now create and add staffing allocations by using the Staffing Workspace. This option was not available in the previous release where the Staffing Workspace was introduced.
In the Staffing workspace, the Team object (the main object) now has date range context to leverage per-period metrics with either Sum of Totals or Grand Totals options.
Upgrade Impact:
After you upgrade to this release, you can create and add staffing allocations in the Staffing workspace. Ensure you have the relevant access rights to leverage this functionality.
To learn more about the Staffing workspace, see Analyze Resource Allocation.
Introducing Business Agreements
Linked
The success of any large organization depends on the seamless execution of hundreds of different investments that are loosely or tightly coupled with each other. Most customers struggle to capture and manage agreements between these investments. Generally, the discussions on the dependencies between investments happen in planning meetings, and the decisions are documented in emails which get buried very quickly.
Hence, when critical investments in an organization introduce changes that impact their delivery dates, most stakeholders are caught unaware, and the effects are felt both upstream and downstream. When you analyze the root cause of such failures and delays, you identify two key reasons.
  • There is no single place of truth in the organization where stakeholders can review dependencies between investments. Hence, they are unaware of the impact of making changes that extend the timelines of any investment.
  • Most stakeholders simply don't remember all the investments dependent on them and the ripple effect of introducing changes.
The Business Agreements workspace in Clarity addresses these challenges by enabling you to define and manage agreements between investments in Clarity. Stakeholders can review these agreements before conducting the next roadmap planning activity or making decisions that impact the investment dates.

Configure Blueprints for Business Agreements
Linked
As an application administrator or PMO content designer, you can use blueprints to configure layouts for the Agreements workspace. You can copy and configure blueprints that reflect the goals of each business unit in your organization. Let's consider an example where multiple product management teams in the organization are using agreements. You can create different blueprints that include custom fields and channels that are relevant to those stakeholders.
Upgrade Impact
: After you upgrade to this release, the Agreement blueprint will be available to you. You can create a copy of this blueprint and edit it.
To learn more see, Business Agreements Blueprints.
Working with the Business Agreements Canvas
Linked
The Canvas layout provides a simple and visually intuitive interface to help you manage your business agreement. The canvas will display grey shading to the area where the selected widget/field will be dropped. You can click a particular view to open the Canvas layout, including the Investment Dependences, Conversation, Stakeholders widgets, and the commitment and deadline fields.
Some key points to remember are that you can:
  • Configure the layout to add or remove widgets and attributes.
  • Modify the canvas by dragging the available widget or field to the canvas.
  • Resize widgets in fields.
  • Configure the data in six columns on the canvas.
  • Include all supported data types except TSVs.
  • Edit data on the canvas.
  • View only objects for which you have permission when editing data.
  • Use the "@" symbol to notify users while using the Conversations widget.
Upgrade Impact:
After upgrading to this release, you can use the canvas to manage business agreements between various investments.
View Business Agreements for Investments in Clarity
Linked
When you create an agreement between investments, you can see this agreement in the Agreements modules within those investments. Your administrator must add the Agreements module to the blueprint associated with your investments.
You cannot edit agreements from within your investment. However, you can click the Agreement Name and navigate to the Agreements workspace.
Upgrade Impact
: The administrator must add the Agreements module to various investment blueprints to ensure users can see the agreement.
Business Rules Enhancements

Disable Editing of Attributes
A new action is introduced in Blueprints to disable editing attributes. The Disable Editing Attributes action has two options:
  1. Disable Selected:
    You can now define attributes that should not be editable when conditions are met.
  2. Disable All Except Selected:
    You can also define an action where the selected attributes are editable, and all other attributes are not editable.
DiableEditingAttributes.png
Some key points you must remember while working with 'Disable Editing Attributes' are:
  • Rules will control the editing of the attributes within the investment. So, you can't edit the field from:
    • Board Layout
    • Grid Layout
    • Detail Panel
    • Properties Page
  • For the non-editable field, you will see a denial icon displayed, and the field will be greyed out.
Upgrade Impact
: When you upgrade to this release, the Disable Editing Attributes rule will be available in the relevant blueprints.
Active Rules Increased to 25
Univ
You can now define any number of rules within a blueprint. You can also have 25 rules simultaneously active. In previous releases, you could only have ten active rules.
  • Rules do not get applied in any specific order. Clarity reads all the rules and then applies them simultaneously.
  • If you have two rules that negate each other, then no rules will be applied unless the two rules contradicting each other are disabling attribute editing.
  • Suppose two rules disabling editing of attributes, such as one rule to disable editing of attributes and another to disable editing of all except selected attributes, are applied on the same attribute. In that case, the disabling of the attribute will supersede, and the attribute will be disabled.
  • Disabling editing of attributes will work in conjunction with FLS.
    • If an attribute is set to be read-only using business rules or FLS and editable using the other, then the read-only action will prevail.
Upgrade Impact
: After you upgrade to this release, you can simultaneously have 25 active business rules. You must activate existing rules manually.
Hide Actions By Using Business Rules
Univ
In the previous releases, administrators did not have fine-grained access control capabilities for actions. A new Hide Actions rule has been introduced in this release to show relevant actions to specific users. You can use the rule to hide actions based on conditions.
Upgrade Impact
: After you upgrade to this release, you will be able to leverage the Hide Actions capability. The Hide Actions capability is not available on the Pages blueprint.
Business Rules Available for Pages
You can now define business rules for Pages to control the modules, sections, and actions displayed to end-users for Pages in Clarity. When you create a blueprint, you define
  • Conditions
  • Actions
  • Action Targets
Upgrade Impact
: After you upgrade to this release, you will be able to leverage the Business Rules capability for Pages.
To learn more, see Blueprints for Pages.
Enhancements to Custom Investments

Define Templates for Custom Investments
Univ
You can create custom investment items from templates to save time and enforce consistency. A template is a framework that helps you quickly get started with new custom investments. For example, you may have templates for all major types of custom investments in your organization. While creating custom investments, users can simply choose the relevant template and create the investment.
Select the newly introduced Template flag to mark a particular custom investment as a template. When users create a new custom investment using a template, the Originating Template field will be populated automatically.
Some key points you must remember are:
  • You can secure The Template and the Originating Template field by using field-level security.
  • The Template field has been introduced in the Investment object.
  • The old Project Template field is kept in sync with the new investment template flag for projects.
  • The new Template field will not be displayed in Classic PPM.
  • The old project-specific Template field will not be displayed in Clarity. Its API alias is assigned to the Template field associated with the Investment object.
Upgrade Impact
: After you upgrade, the Template and the Originating Template fields will be available. You can now mark various investments as Templates.
Create a New Custom Investment Item from a Template
Univ
A new <CIT Name> - Create From Template access right has been introduced in this release. This right is present alongside the <CIT Name> - Create access right that is already available. When you have the  <CIT Name> - Create From Template access right, you will see the New From Template button in the Custom Investments grid and board layouts. You can use this button to create a new custom investment from a template. When you create a custom investment from a template, Clarity prompts you to enter the information requested by the administrator in the Create from Template module of the blueprint associated with the template. After you enter this information, Clarity will create a new custom investment with the following information:
  • Roles:
    You can remove the role after adding a named team member to the project that matches a role.
  • Financial Plans:
    Both detailed and summary financial plans.
  • Links:
    All links are copied. Links can contain parameter variables with dynamic context-sensitive values.
  • Task To-Do Items:
    Any to-do items that are associated with the existing tasks are copied to the new investment item.
    Completed
    items are reset to
    Open
    status.
  • Risks, Issues, and Changes
    : Any risks, issues, and changes associated with the template are copied over to the new investment item.
Some key points you must remember are:
  1. The Create from Template modal will only allow up to 200 attributes to be configured.
  2. The <CIT Name> - Create From Template access right coexists alongside the <CIT Name> - Create access right.
Upgrade Impact
: Administrators must assign the Create from Template access right to the respective users and groups after you upgrade.
Specify Mandatory Attributes While Creating Custom Investments
The Custom Investments blueprint includes a Create From Template configuration module. Administrators can use it to configure all the out-of-the-box and custom fields that users must populate in the New Custom Investment window when users create a new custom investment from a template.
Some key points to remember while using the Create From Template configuration module are:
  • Clarity will display all mandatory fields on the screen provided they do not have a default value set or auto-numbering.
  • Administrators cannot remove mandatory fields without default values or auto-numbering from the New Custom Investment section.
  • Administrators cannot add the Blueprint field to the New Custom Investment section.
  • In this release, you cannot add Timescaled value, Multi-value Lookups, and Attachment fields to the Create From Template section.
Upgrade Impact
: The Create From Template capability will be available when you upgrade to this release.
To learn more, see Custom Investments Blueprints.
Enforce Required Attributes for Custom Investments
Univ
The Create from Template module in the blueprint makes it mandatory for users to populate an attribute while creating a custom investment. However, you cannot use it to ensure that the attribute is required every time a user updates it. In Clarity 16.0.0 and higher releases, you can use the Always True condition in Business Rules to add a Required Attributes action. This would ensure that Clarity would not allow you to update records if the required attribute is not populated.
If you select the Always True flag, you cannot specify any other conditions in the Business Rule. You can choose only the Required Attributes action and select the relevant attributes.
Some of the key points you must remember are:
  • The Always True condition in business rules is only applicable to projects and custom investments.
  • You cannot select read-only attributes and auto-numbered attributes in the Required Attributes section.
  • You cannot select the Blueprint attribute by using business rules.
  • If users create an investment by using the New From Template option, Clarity will automatically add the required fields to the New Investment window.
  • When you update a required attribute with a non-null value, users cannot change its value to null. However, if an attribute has a null value before you enforce the business rule, users will not be prompted to add a value till they update the attribute.
  • You will not see any asterisk or visual indicator associated with attributes you select in the Required Attributes section. This applies to the grid layout, board layout, Details panel, and Properties module.
  • You cannot enforce this rule on the following data types:
    • Attachment
    • TSV
    • Calculated/Aggregated/Formula
    • Boolean
    • Read-only studio attributes
    • Auto Number fields
    • Rich Text fields
Upgrade Impact
: Only custom investments using a blueprint that has business rules for required attributes will be impacted. If the investment is using a blueprint that has business rules for required attributes, then:
  • End-users can update the investments without entering a value for the attributes required by the business rule. Clarity will not force the end-user to enter a value for those attributes.
  • Once the end-user enters values for any attribute required by the business rule, Clarity will always require a value for that attribute.
Datawarehouse and BI Enhancements

New Data Synchronized in the Data Warehouse
There are now main additions in the Data Warehouse.
  1. The Timesheet tables in the Datawarehouse have been updated to include the time entry note date field.
    Univ
  2. The investments tables include the newly introduced parent attribute.
    Univ
Upgrade Impact
: When you upgrade to this release, you must run the Load Datwarehouse Job at full load to view the additional data in the Datawarehouse.
Improved Performance of Load Data Warehouse Job
The addition of the following functionality has enhanced the Load Data Warehouse job:
  • The job performance associated with the DWH_RES_RESOURCE" table has been enhanced. When a Resource's property data changes, like the primary role or manager, the resource availability facts will not be updated unless the resource's available hours are updated. Also, when a resource is updated, if the resource name does not change, Clarity will not update any lookup tables based on the resource name. Clarity will not update lookups based on resource name where the resource name did not change.  Previously, if any resource property data changed, Clarity would update all the lookups based on resources for that resource.
  • Data synchronization processing has transitioned from scripts to database procedures for faster replication. The multi-valued lookup data synchronization is updated to improve performance. These improvements have only been made for the PostgreSQL database.
  • Data Warehouse leverages Pentaho Version 9.
Created Date Added to Data Warehouse
The Created Date attribute was added to various tables in the Data Warehouse in Clarity 15.9.3. The Clarity team made this change to address issues reported by customers where records were not getting synchronized if they updated them when the Load Data Warehouse job was being executed. The following areas in Clarity will leverage the Created Date attribute in this release.
Univ
Support for Clarity API Keys to Access Odata
The Enhanced Odata API allows you to use basic authentication and Clarity API Keys to authenticate users to access the Odata environment. You can use the following syntax:
  • Basic Authentication:
    • Username: <Clarity Username>|<Odata-Authenticator> 
    • Password: <Password defined in Clarity>
  • API Keys
    • Username : <API Client ID>|<Clarity Username>|<Odata-Authenticator>
    • Password: <API Keys>
  • The enhanced API works with Odata v2 and v4.
  • All the rules associated with API Keys, such as key expiration, will be applied.
  • Existing Odata access right is still needed to access Odata.
  • Administrators must enable APIs in their environment and create an API Client that end-users should use to generate API keys.
  • When you refresh a non-production from a production environment, Clarity will overwrite the API keys for the non-production environment with the production values as the API keys are stored in the database.
Upgrade Impact
: After you upgrade to this release, you will be able to use the API Keys feature for Odata authentication. Ensure you are using Odata v2 or v4.
To learn more about API Keys, see Authentication and Keys. To learn more about configuring OData access, see Configuring OData Access.
General Enhancements

Introducing Boards and Picklists for Custom Objects
Univ
You can use the Board layout in
Clarity
to view records associated with custom objects as cards. You can arrange these cards with drag-and-drop precision on a board layout with columnar swim lanes. Some key features associated with cards are:
  • Cards can display numeric data and money values (you can adjust the appearance of this data in View Options)
  • Cards appear in your choice of colors based on the value you select in the Color By field in View Options. Your color selections appear in the legend and are saved with the view.
  • Card titles default to the Name field. If you configure a default value for the Name field in Studio, the application uses that value when creating cards. Without a default value, new cards show New Item as their default name.
  • You can double-click a card to edit its name. You are not limited to using the default name. You can change the field used by the cards to display their names. In View Options, select any string attribute.
  • You can configure cards to display up to four (4) additional fields in any order (use View Options). When additional fields are selected, the name of the fields appears in the legend area.
  • You can configure cards to display up to three (3) numeric metrics in the order you select. The name of each metric appears in the legend.
You can also configure your display attributes, choices, and the color of each choice by using the picklist capability.
Upgrade Impact
: After you upgrade to this release, this board layout will be available on the Custom Objects page in Clarity.
To learn more about the Board layout, see Manage Your Data Using Board Layouts.
To learn more about using Custom Objects, see Viewing Custom Objects and Sub Objects.
New Job to Delete Job Log Entries
Univ
The Remove Job Logs and Report Library Entries by Type job lets you delete the job and report library entries. This job is similar to the "Remove Job Log and Report Library" job, except it takes different input parameters and gives administrators more control of what logs should be created. The job has two required parameters:
  • Job/Report Type: - Accepts multiple job types.
  • Age to Delete: Age of entries
Upgrade Impact
: After you upgrade to this release, this job will be available to you. Please note that this job is incompatible with the current Remove Job Log and Report Library job.
To learn more about Clarity jobs, see Jobs Reference.
Enhanced Auto Save Functionality
The Auto-Save functionality in Clarity has been updated. Clarity did not save their changes if a user updated a field and quickly navigated away in previous versions. Clarity will now continue to save changes as a user navigates away but wait 500 ms with no user interaction before refreshing the entire record.
Upgrade Impact
: The enhanced AutoSave functionality will be available after you upgrade to this release.
Confirmation Message Removed from Saved Views
Univ
When you navigated away from a view in previous releases, after making layout changes, you received a confirmation message to save your view. This confirmation message will not be available in Clarity 16.0.0 and higher releases. Whenever users update a view, the view name will be italicized to indicate a change. If a user navigates away without saving the view, their changes would be lost.
Upgrade Impact
: When you upgrade to this release, you will no longer receive a confirmation message when you navigate away from a view after making changes.
To learn more about using Saved Views, see Saved Views in Clarity.
Forecast and Forecast Variance Added to Financial Plan Details
Univ
The Cost Plan Details and the Budgets Details page now have three new attributes: Forecast, Forecast Variance, and Forecast Cutover.
Forecast is defined as the sum of the actual amount for the fiscal period completed and the planned amount for the fiscal period in the future.
Forecast variance is defined as the difference between the planned cost and forecast.
Forecast Cutover allows you to overwrite how Forecast is calculated. When you populate the Forecast Cutover field, Clarity will calculate Forecast as the sum of the actual amount till the Forecast cutover date and the planned amount for the fiscal period in the future.
  • Clarity calculates the total value for Forecast and Forecast variance based on the Totals ("Sum of Periods" or "Grand Totals") setting in View Options.
  • The Forecast attributes are not available in Classic PPM.
Upgrade Impact
: When you upgrade to this release, all three new fields will be available on the Cost Plan/Budget Plan details page. The Forecast Cutover date will not be available in Classic PPM.
Standardized Investment Naming
Univ
In the previous release, Clarity introduced the ability to create labels for stock and custom attributes. However, the Project Name, Idea Name, Project ID, and Idea ID could not be updated by using this functionality since their labels were hardcoded. In this release, you can associate labels with these fields, and Clarity will display the updated values in the grid, Details panel, and Properties module.
Upgrade Impact
: After you upgrade to this release, Clarity will apply the labels to the Project Name, Idea Name, Project ID, and Idea ID in the relevant grid, Details panel, and Properties module. In previous releases, these Project attributes were called "Name" and "ID." They will now be called "Project Name" and "Project ID."
Cross Object Grid Enhancements
Drag.png
When using the Group By capability in the cross-object investment grid (Hierarchies, To-Dos, Staffing), you can drag and drop columns from its parent group to a different group. This capability was not available in the previous release. For example, if you group the investments by "Type," all the investments would be grouped by investment type. The Name, Investment ID, and Type attributes will be available under the Common Investment section. The Parent and Level columns will be under the Hierarchical section. You can now drag the Level field from the Hierarchical section and place it next to the Name field in the Common Investment section.
Upgrade Impact
: When you upgrade to this release, you can drag and drop columns from a parent group to a different group. However, please note that you will see multiple entries for the group header in the Column Panel in such scenarios.
To learn more about the Hierarchies cross-object grid, see Analyze Investments in Hierarchies by Using the Cross-Object Investment Grid.
Introducing Smart Options
Univ
Clarity has now introduced Smart Filters, Smart Periods, and Smart Actions to enhance your experience.
Smart Filters
: You can filter for "Current User" across various investments and objects to quickly identify actions you must complete on that particular area of Clarity. For example, you can review all the projects approved by you on the Projects grid by using this filter.
Univ
You can create a custom lookup to be used along with the Current User flag filter.
Smart Dates
: You can now leverage dynamic date periods for Time-Scaled-Values (TSVs). These dynamic date options vary when you are selecting Start and End Periods in the View Options drop-down. They are available in Cost Plans, Budget Plans, Benefit Plans, Roadmaps, Hierarchy, Staffing, and Widgets.
Dynamic dates are based on the fiscal period defined in the default entity.
Smart Actions:
You can now quickly add tasks to your timesheets by using the Add Assigned Tasks, Copy Previous Timesheet, and Copy Previous Timesheet (with time) options.
Upgrade Impact: These Smart options will be available when you upgrade to this release.
Usability Enhancements
The following user experience enhancements have been introduced to the left-hand navigation menu in Clarity.
  • The left-hand navigation menu is now scrollable. To see additional navigation icons that does not display on a smaller screen or increased browser zoom, you can now use the new vertical scrollbar.
  • You now have the ability to use right-click on left-hand navigation menu to open a module such as project tiles in another window or tab.
Enhancements to Hierarchies

Investment Type Attribute Added to Risks, Issues, and Changes Grids
The Type attribute is now available in the Hierarchies Grid and the Risks, Issues, and Changes modules. This attribute helps display the investment type for a particular investment. You can now group the various risks, issues, or changes in a hierarchy by "Type" to view the risks associated with Projects, Ideas, and Custom investments.
Upgrade Impact
: When you upgrade to this release, the Type attribute will be available in Clarity. However, this attribute will not be available in Classic PPM.
User Experience Enhancements To Hierarchies
The following user experience enhancements have been introduced for hierarchies in Clarity.
  • You can click various investments from the cross-object investment grid or the Risks, Issues, and Changes modules to access them directly from Hierarchies. You can then navigate back from the investment to the hierarchy. This capability was not available in the previous releases.
  • You can use the Bulk Edit capability in the Risks, Issues, and Changes grid. To learn more about this capability, see Common Components.
  • You can import hierarchies and manage custom metrics from the cross-object investment grid. This capability was previously available in the Hierarchy layout.
To learn more about the cross-object investment grid, see Cross-Object Investment Grid.
Upgrade Impact
: When you upgrade to this release, these capabilities will be available in hierarchies.
Introducing the Investment Timeline Layout for Hierarchies (Read-Only)
The Timeline layout in hierarchies allows you to view the relationships between them by using a hierarchical timeline. Each bar corresponds to an investment, and their length is determined by the Start and Finish dates and the relevant View Options.
The Timeline layout is divided into the Investment Breakdown Structure on the left and the Investment Timeline on the right. Both the Investment Breakdown Structure and the Investment Timeline displays the relationships defined by using the Hierarchy layout.
Upgrade Impact
: When you upgrade to this release, the Timeline layout will be available to all users who have access to hierarchies.
Introducing the Status Module for Hierarchies
You can view the status reports associated with all the investments included in your hierarchy. When you open the Status module, you can access fields associated with the abstract investment object and concrete investment objects such as projects, ideas, and custom investments. You can also view fields associated with the Risks object. You use the information in the Status module to quickly analyze the health of various investments and make relevant decisions without leaving the Hierarchies workspace.
Some key points you must remember while working with the Status module are:
  • Your administrator needs to associate the Status module with a blueprint and then map the blueprint to a hierarchy. You can then view the Status module for that hierarchy.
  • If a user has view access to the hierarchy, they will have view access rights to all investments that are a part of the hierarchy. They can also view the status reports associated with those investments in the Status module.
  • You can edit various fields associated with the Status object. You will not be able to edit fields for any other object in the Status module.
To learn more about the Status module, see Explore Status Reports.
Upgrade Impact
: The Standard blueprint associated with Hierarchies will not be automatically updated to include the Status module. Administrators must create a copy of the Standard blueprint and add the Status module to make it available to end-users.
Introducing Configurable Widgets

You can review and summarize the health of an investment by using a series of configurable visual widgets. In this release, the following widgets are available:
  • Number Tile
  • Pie
  • Bar
  • Progress Ring
Linked
Some of the critical actions you can perform with widgets are:
  • Use the Show Widgets button to display the widgets toolbar.
  • Use the Add Widgets dialog box to add existing widgets from the My Widgets section and the Widget library.
  • Create a New Widget from the Add Widgets dialog box.
If you have the Widgets - Manage Widget Library access right, you can:
  • Add your widgets to the Widget library so that other users can leverage them.
  • Edit existing widgets to update the widget definition and filter criterion
  • Move a widget from the Widget library to the My Widgets section.
In this release, the widgets are available in Hierarchies, To Do's, and Custom Objects.
Upgrade Impact
: When you upgrade to this release, the existing out-of-the-box widgets for Hierarchies and To Do's will be automatically moved to the widget library of the administrator. They would need the Widgets - Manage Widget Library access right to edit these widgets.
Enhancements to APIs

View Contract Number in Broadcom SaaS Environment
Univ
The Telemetry Data Export portlet has been enhanced to display a new column, "Serial Number." This field displays the customer's active contract number and the line number for the specific license SKU. The Serial Number column will only be populated for Broadcom SaaS customers.
Upgrade Impact
: When Clarity SaaS customers upgrade to this release, they will see the Serial Number field on the Telemetry Data Export portlet.
To learn more see, View Telemetry Data.
Create an API Attribute ID for Custom Virtual Attributes
A few releases ago, we provided the capability to add API alias to virtual attributes via XOG.
In this release, we are enabling the capability to add the API alias for a virtual attribute in Classic PPM.
VirtualAttributes.png
Upgrade Impact
: When you upgrade to this release, you can enable the capability to manage the virtual attribute API alias in Classic PPM.
To learn more, see Virtual Attributes.
Lookup Object Type Available While Using Describe for the Object Attributes API
Linked
You can discover supported APIs by appending "/describe" to the API URL specified in the API section to view the list of supported public APIs for Clarity. The Describe capability now provides the object lookup attribute's reference object. The image highlights an example where the Value Stream object attribute references the Value Stream - General lookup.
Upgrade Impact
: When you upgrade to this release, you can use the enhanced Describe capability for APIs.
To learn more, see Getting Started with REST APIs.
Clear MVL fields with XOG
Linked
In previous releases, you could not remove a value populated in a multi-value lookup using XOG. In this release, the XOG API has been updated to remove all values populated within a multi-value lookup. The multi-value lookup will accept the new flag "complete= "true" that will replace the passed values with existing values. If no values are passed then, the API will remove all existing values.
Upgrade Impact
: When you upgrade to this release, you can remove values associated with multi-value lookups.
Introducing the User API
Linked
You can now use the User API to manage users. You will be able to use the APIs to:
  • Get user information
  • Update selected user information
  • Update user groups
Some key points you must remember are:
  • You need administrator access to update users.
  • You cannot create a new user by using the API in this release.
  • Assigning user groups can be done by updating the "userGroups" multi-value lookup.
Upgrade Impact
: When you upgrade to this release, you can leverage the User API.
To learn more about APIs in Clarity, see Getting Started with REST APIs.
Accessibility Enhancements

Each of the accessibility improvements is needed to drive adoption because organizations demand compliance with accessibility standards to ensure their users have the proper tools to view and access company-specific details. Numerous foundational accessibility improvements have been incorporated, encompassing:
  • Visual Design (e.g., color, contrast, visible focus)
  • Responsive Design (e.g., pop-up windows, text areas, and browser zoom)
  • Keyboard (e.g., key input, tab order, and focus)
  • Screen readers (e.g., semantics, hierarchy, and pages structures)
In this release, the following Clarity components are compliant with the four aspects of compliance in the form of Visual, Responsive Design, Keyboard, and Screen Reader support:
  • Main (Left) Navigation
  • Object, URL, or Attachment "Link" Navigation
  • My Timesheet
    • Add Tasks
    • Select Tasks Page
    • Add Tasks Flow
    • Add Tasks Filters
    • Notes
  • Holistic Page-Level Navigation
  • Financials Module
Some key points you must remember are:
  • The Clarity product team has determined the combinations below are the supported platforms from an accessibility perspective:
    • Operating System: Windows
    • Browsers: Chrome, Firefox, Edge
    • Screen Readers: JAWS
  • According to the screen reader survey, it is known that:
    • Windows is the clear market leader in the IT Industry.
    • Chrome and Firefox are dominant, whereas IE usage is declining.
    • JAWS is dominant in the Enterprise area.
In Clarity 16.0.0.1 and higher releases, when you click any page, each page shows the title element using one of the following formats:
  • {Page Title} - Clarity
  • {Instance Name} - {Module Name} - Clarity
The page title updates support the screen reader in effectively announcing the page title in Clarity.
Upgrade Impact:
You can leverage all the accessibility enhancements after you upgrade to this release.
To learn more, see Accessibility in Clarity.
Upgrade Script Updates NK_Curve Oracle Database Tables
If you are using the Oracle database with Clarity, the upgrade script will remove columns from specific database tables that are of type NK_CURVE. It will then recreate them again with an updated version of the NK_CURVE user data type. After the upgrade is completed, ensure that the Time Slice Sync job runs in order to recreate the data. This is necessary only if you are using SQL curves in your environment.
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.
JAXEN Enhancements in Clarity
Clarity 15.9.2 and higher releases include the JAXEN 1.2.0 library. This has impacted the syntax for certain GEL scripts. Read the following Knowledge Base article for more information.
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
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
16.0.0
15.8.1
15.9.3
15.8.0
15.9.2
15.7.0
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
  • You cannot upgrade to Release
    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
.
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'