Clarity
and Jaspersoft Cumulative Patch README Files

ccppmop1581
HID_clarity_readme
Cumulative patches for
Clarity
and Jaspersoft for
Clarity
are periodically available. Before applying a patch, see the README for important information.
Although they are technically not patches, we list the Jaspersoft installers for
Clarity
on this page because they behave like patches for existing
Clarity
customers with Advanced Reporting environments.
  • SaaS Customers:
    Contact Support to request and schedule patch installation on specific
    Clarity
    instances in the On-Demand Portal. Any fixes for reports are automatically deployed in your SaaS environment. Notifications for scheduled mandatory Jaspersoft patches are provided by email to the customer support contacts on file.
  • On-premise Customers:
    To install a patch or update reporting content, download the patch from Support and follow the README instructions on this page.
This section contains the following topics:
2
Clarity
Cumulative Patch Summary
As patches are cumulative in nature, when you install a single patch, it includes all the fixes in all previous patches, keeping you up-to-date. The following table lists the patches that are released so far:
Clarity
Base Release
15.3
15.4.0
15.4.1
15.5.0
15.5.1
15.6.0
15.6.1
15.7.0
15.7.1
15.8.0
15.8.1
Latest Patch:
15.3.0.5
15.4.0.1
15.4.1.4
15.5.0.1
15.5.1.3
15.6.0.1
15.6.1.3
15.7.0.1
15.7.1.3
15.8.0.1
15.8.1.1
JasperReports
6.4.2_5.4.2.15
or
7.1.0.6.1.0.X
6.4.2_5.4.2.15
or
7.1.0.6.1.0.X
6.4.2_5.4.2.15
or
7.1.0.6.1.0.X
6.4.2_5.4.2.15
or
7.1.0.6.1.0.X
7.1.0.6.1.0.X
7.1.0.6.1.0.X
7.1.0.6.1.0.X
7.1.0.6.1.0.X
7.1.0.6.1.0.x
7.1.0.6.1.0.X
7.1.0.6.1.0.X
Clarity PPM has now been rebranded as Clarity. You can see the new Clarity logo on the login screen and in the New User Experience. The documentation is updated to reflect the new brand. Clarity refers to the New User Experience, and Classic PPM refers to the Classic PPM Studio.
Issues Fixed in 15.8.1.1
DE57188  - Export to CSV: Hyperlinks with char length more than 255 do not work
Excel has a limitation of 255 characters for links and Excel will truncate the link. This fix will check if the link is >255 characters, we will display the only label with no link.  If the link <= 255 characters, we display the label and link.
Steps to Reproduce:
  1. Click on Project list.
  2. From the upper right hand corner, click on the gear icon.
  3. Click on Export to CSV.
  4. Verify the exported csv files and verify the links are properly exported.
  5. Now click on any existing project.
  6. Click on the Status Reports subpage ( using he down arrow next to Properties Tab).
  7. Create a new status report with name as "sr_test".
  8. From the status report list page click Export to CSV.
Expected Results - The csv is generated with working links
Actual Results - The links do not work
DE56341 - Query Dependent Lookup Values on the custom object module list page does not preserve the value
Steps to Reproduce:
  1. Log in to Classic PPM and Navigate to Administration, Object.
  2. Create a sub object of Project and name it as for example, AAA.
  3. Create a Dynamic Query lookup.
  4. Create a lookup attribute using the above created dynamic lookup.
  5. Save the attribute and now set the Lookup Parameter Mapping to --Object ID--.
  6. Now Navigate to Clarity and add the AAA object as a module in your blueprint.
  7. Navigate to the AAA module list page and add the attribute Lookup Attribute.
  8. Create an instance of Dependency and fill the value for Lookup Attribute.
  9. Refresh the browser and now the Lookup Attribute value does not appear, however in the details layout the value remains.
Expected Results: The value of lookup attribute (Lookup Attribute) should be shown on the list page.
Actual Results: The value of lookup attribute (Lookup Attribute) disappears.
DE55738 - Calculated attribute with DateDiff doesn't work properly in PostgreSQL
Steps to Reproduce:
  1. Using Classic PPM, add the following calculated attribute called:
    "% Schedule Gap" (DateDiff(schedule_finish,baseline_finish,"Day")/+DateDiff(baseline_finish,baseline_start,"Day"))*100
  2. Add the field to the view: "Project Summary::projectGeneral".
  3. Review a project that has the following fields populated:
    • Property Label
    • % Schedule Gap
    • Baseline Start
    • Baseline Finish
    • Finish Date
  4. Review the "% Schedule Gap" field.  The calculation is incorrect.
Expected Results: Calculated attribute using DateDiff report is correct calculation.
Actual Results: Calculated attribute using DateDiff shows "0" or some other incorrect value.
DE50348 - Patch 15.8.1.1: Synchronize Agile Central job is failing in Production
Steps to Reproduce:
  1. Log in to Classic PPM.
    1. Configure Agile Central to Clarity integration.
    2. Create a project and enable Agile Central integration.
  2. Log in to Rally.
    1. Create more than 2000 resources.
    2. Create different user stories and tasks and assign different owners (created from step 2a).
  3. In Classic PPM, run the Synchronize Agile Central job.
Expected Results: Project and tasks are synchronized and the Synchronize Agile Central job is executed successfully.
Actual Results: For some projects, the job fails with the following error in logs:
java.io.IOException: HTTP/1.1 524 Origin Time-out For those projects, the Synchronized checkbox gets unchecked as there are exceptions processing the request.
DE55120 - Rally sync error API-1019 post upgrade to 15.7.1 for some projects
Steps to Reproduce:
  1. Log in to Classic PPM.
    1. Configure Agile Central to Clarity integration.
    2. Create a project and enable Agile Central integration.
  2. Log in to Rally.
    1. Create more than 2000 milestones.
  3. In Classic PPM, run the Synchronize Agile Central job.
Expected Results: Project and tasks sync successfully and the Synchronize Agile Central job is executed successfully.
Actual Results: For some projects, the job fails with the following error: There was a problem syncing tasks for the CA PPM project: <Project Name>500api.internalErrorAPI-1019 : Could not process the request due to internal error.
DE56197 - OBS filtering on Custom Object is not working
SUMMARY: Unable to filter  OBS unit on Customer Objects
Steps to reproduce:
  1. Log in to Classic PPM as Administrator.
  2. Create a customer master object (example: Suman Custom Object) and API enable the object.
  3. Either create an OBS or use an existing OBS and associate the object created (example: Suman Custom Object).
  4. Once the OBS association is done, you can enable the API Attribute in order to see even in Clarity.
  5. Go to the Custom object Menu from Classic PPM and create a couple of instances for the object created and update the OBS unit.
  6. Configure the Custom Object List Page to add OBS Unit in filter and list section.
  7. On the filter section select an OBS Unit and filter.
Expected Results: The list page should fetch the result based on the OBS UNIT match.
Actual Results: The list page does not show any records even when filter value matches.
Workaround: Log in to Clarity and filter the OBS unit and it shows the correct value.
DE54888 - New UX - Filtering on Project Grid reverts to original results
Steps to reproduce:
  1. Connect to a large customer dataset (see environmental details below).
  2. Go to Projects - Grid
  3. Note the number of projects there.
  4. Now quickly add a filter, i.e. Active =Yes.
  5. Note the amount of projects changing down.
  6. Within 5 seconds, note the amount of projects that are reverting to the initial number.
DE56718 - Error 401 - Unauthorized when returning to the project Team Staff list
STEPS TO REPRODUCE:
  1. Create a user UserA .
  2. Create a project MyProject and add a team member.
  3. Add every instance access right related to the project object for MyProject.
  4. Add also the Projects Navigate global right.
  5. Log in as UserA.
  6. Go to Project Management, Projects, and edit the MyProject project.
  7. Go to the Team tab.
  8. Click Staff Member Properties.
  9. Click Return, Save and Return.
Patches are intended to be timely fixes and are not fully regression or integration tested, and are only tested against the issues listed below. We feel confident that this patch will resolve the defects targeted in this patch, but a patch could have adverse side effects to the function of your
Clarity
application. Do not apply patches directly to production systems without first verifying in a test environment. If any issues arise in the installation or use of this patch, contact Support.
Files Included In the Patch
  • README.txt
  • install.sh - Unix installer
  • install.bat - Windows installer
  • install.xml - Ant install script
Prerequisites
Install only on systems running the version stated above.
Install the Patch
Follow these steps:
  1. Back up all files and the database on the target system.
  2. On the CSA server, copy the installer into a temp directory.
  3. Navigate to the temp directory and enter the following command to extract the contents: jar xvf <patch_jar_file>
  4. Run the following command to stop all local nsa, app and bg services: service stop nsa app bg
  5. From the temp directory, enter the following command to execute the installer script:
    •   install.bat OR
    •   install.sh
  6. Follow the remaining on-screen instructions to complete the installer script.
  7. Run the following command to start all services: service start all
  8. If you are running multiple servers in a cluster:
    1. Log in to the CSA and go to the All Services page to shut down any remote app and bg services.
    2. Go to the Distribute All page, select remote servers, and click Distribute.
    3. Return to the All Services page to restart services when the distribution is complete.
    4. IMPORTANT: If you currently use or want to use the new Jaspersoft Reports and Data Warehouse, choose Step 9 or Step 10. If you do not use these features, skip Steps 9 and 10.
  9. If you are applying this patch and you have already configured Jaspersoft Reports and the Data Warehouse:
    1. From <install_dir>/bin directory command prompt, enter the following command to generate keystore:
    2. admin jaspersoft keystore
    3. Copy the keystore files generated in the path - <install_dir>/config directory to <Jaspersoft Tomcat Instance Directory>/webapps/<jaspersoftContext>/WEB-INF/config
    4. Enter the following command to upgrade the report content:
    5. admin content-jaspersoft csk -userName <superuser> -password <password> upgrade -retryCount 50
    6. Restart all
      Clarity
      services.
    7. Run the Load Data Warehouse Access Rights job.
  10. If you are applying this patch and you want to use the new Jaspersoft Reports and Data Warehouse but have not yet configured them:
    1. From <install_dir>/bin directory command prompt, enter the following command to generate keystore:
    2. admin jaspersoft keystore
    3. Copy the keystore files generated in <install_dir>/config directory to <Jaspersoft Tomcat Instance Directory>/webapps/<jaspersoftContext>/WEB-INF/config
    4. Enter the following command to install the release content: admin content-jaspersoft csk -userName <superuser> -password <password> -retryCount 50. This command imports jaspersoft_csk.zip followed by the file that has patch content (file name for patch content contains jaspersoft_csk_upgrade).
    5. If you encounter any error during the import of the patch content, enter the following command to re-import the patch content: admin content-jaspersoft csk -userName <superuser> -password <password> upgrade -retryCount 50 force
    6. Configure the Data Warehouse section in CSA. See CSA: CA PPM System Administration at docops.ca.com/ppmop.
    7. Enter the following command from the <install_dir>/bin directory command prompt to apply the data warehouse patch content:
      1. admin db dwh-upgrade -Dupgrade.phase=maintenance
      2. Restart all PPM services.
      3. Run the Load Data Warehouse Access Rights job.
Uninstall the Patch
Follow these steps:
  1. Run the following command to stop all local nsa, app, and bg services: service stop nsa app bg
  2. Restore the installation files and database from the backups above.
  3. Run the following command to start all services: service start all
  4. If you are running multiple servers in a cluster, log in to CSA and go to the All Services page to shut down any remote app and bg services.
  5. Go to the Distribute All page, select remote servers, and click Distribute.
  6. Return to the All Services page to restart services when the distribution is complete.
JasperReports Server 7.1.3 for
Clarity
Jaspersoft Server 7.1.3 version includes critical security fixes and it is highly advisable to upgrade to 7.1.3 version. In addition, falling too far behind can increase your risk exposure and compound maintenance time and cost. To learn more about the security vulnerabilities which were fixed in Jaspersoft 7.1.3 version, refer to the security advisories issued by Tibco.
To learn more about installing Jaspersoft, see Install and Configure Jaspersoft.dita. To learn more about upgrading to the latest version of Jaspersoft, see Jaspersoft-7.1.3-Upgrade Assistant.dita.
Issues Fixed in JasperReports Server 7.1.3_6.3.0.1 for
SaaS
DE57233 - Spinning Issue When a New Join Condition is Added to an Existing Domain in the Domain Designer
Steps to reproduce:
  1. Login to
    PPM classique
    and click
    Advanced Reporting
    .
  2. Navigate to
    Domains
    and edit any domain (Ex: Project Management domain).
  3. Click
    Edit Domain with Domain Designer
    .
  4. Click the
    Tables
    tab and add a new table to the selection list.
  5. Click the
    Joins
    tab and create a join with the new table you added.
  6. Click the
    OK
    button.
Expected Result: The page reloads successfully and a new join is created.
Actual Result: The Page does not reload and the Javascript error is displayed.
DE57234 and DE57235 - Unable to See Tables in Domain Designer
Steps to reproduce:
  1. Login to
    PPM classique
    and click
    Advanced Reporting
    .
  2. Navigate to Domains and edit any domain (Ex: Project Management domain).
  3. Click
    Edit Domain with Domain Designer
    .
  4. Click the
    Tables
    tab.
Expected Result: You can see a list of tables and select the relevant table.
Actual Result: You see the
List of Invalid Reference
error.
DE57236 - Added Support for New Fixed Date Format "dd MMM YYYY" as Additional Adhoc Mask Date Format
You can now see the date value as "13 May 2020" for 05/13/2020.
Issues Fixed in JasperReports Server 7.1.3_6.3.0.1 for
Clarity
On-Premise
DE57233 and DE57236 have been addressed for
Clarity
On-Premise customers. The details associated with these defects can be found in the Issues Fixed in JasperReports Server 7.1.3_6.3.0.1 for
SaaS
section.
Install the Patch
  1. Stop the application server (Apache Tomcat Server), on which Jaspersoft is deployed.
  2. Find the root web application folder (e.g. Windows - c:\\apache-tomcat\\webapps\\reportservice and Linux - /fs0/apache-tomcat/webapps/reportservice).
  3. Create a back-up of that folder to a new, separate location.
  4. Extract the Jaspersoft Patch zip file to the relevant location.
  5. Navigate to the "patch directory"/bin folder. The bin folder contains installer scripts, that you need to run on the OS command prompt.
  6. For interactive installation, enter install.bat/install.sh based on your operating system.
  7. Run command 'install.bat/install.sh' command. Ensure the property values in 'install.properties' file has relevant values.
    • patch.deploy.tomcat: The absolute path of the Tomcat Server base folder.
    • patch.deploy.jrs.webapp.name: Enter the webapp name of Jaspersoft.
    • patch.deploy.capb.name: The value should always be "clarity".
    • patch.install.mode: The value can be 'standalone' or 'cluster' based on the node you install the patch.
  8. Clear the application server (Apache Tomcat Server) 'temp' directory.
  9. Clear the application server (Apache Tomcat Server) 'work' directory.
  10. Start the Apache Tomcat Server, on which Jaspersoft is deployed.
  11. Clear browser cache on the client.
Uninstall the Patch
  1. Stop the application server (Apache Tomcat Server), on which Jaspersoft is deployed.
  2. Find the root web application folder.
  3. Restore all the files under /reportservice from backup.
  4. Restart the Tomcat instance.