Clarity PPM
and Jaspersoft Cumulative Patch README Files

ccppmop158
HID_clarity_readme
Cumulative patches for
Clarity PPM
and Jaspersoft for
Clarity PPM
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 PPM
on this page because they behave like patches for existing
Clarity PPM
customers with Advanced Reporting environments.
  • SaaS Customers:
    Contact Support to request and schedule patch installation on specific
    Clarity PPM
    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 PPM
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 released so far:
Clarity PPM
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
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
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
Issues Fixed in
Clarity PPM
15.8.0.1
DE53768: After refresh, Load Data Warehouse fails: table does not exist due to old entries with schema name hard coded in table DWH_INTERNAL_MD
Steps to reproduce:
  1. Take a database backup from an environment when the Load Data Warehouse is still running and there are entries in DWH_INTERNAL_MD in PPM_DWH schema
  2. Restore the backup to another environment (both Clarity and Data Warehouse).
  3. Check the table DWH_INTERNAL_MD, note the entries are there.
  4. Now run Load Data Warehouse job - Full Load.
Expected result: The Load Data Warehouse job to complete successfully and creates the indexes that were in dwh_internal_md
Actual Result: The Load Data Warehouse job fails with error.
DE53952 - Drag and drop from column picker to the  grid column doesnot work
This was  working in
Clarity PPM
15.7.1, but now it is broken in
Clarity PPM
15.8.
Steps to reproduce:
  1. Log in to the
    Clarity PPM
    .
  2. Go to any grid(project grid).
  3. Open the column picker on a common grid.
  4. Drag a column from the column picker to the one of the column headers.
Expected Result:  Be able to add that selected column to the grid.
Actual Result:  It doesnot allow you to add the column to the grid via drag and drop.
DE53552 - Processes can be run through a HTML portlet even if the user does not have access rights to run processes
Steps to reproduce:
  1. Create a user with no process related access rights.
  2. Create a simple process that is linked to the project object and moves from start to finish steps, for testing purposes.
  3. Note the internal Process ID (5 million number on the URL).
  4. In a real scenario, the process creates or updates cost plans in the projects where the process is run.
  5. Create a HTML portlet with the code attached (HTML portlet.xml) .
  6. There are references to the process ID ('process_id=5003002') in the portlet. Replace the ID of the portlet by the ID of your process.
  7. Add the portlet to the project Dashboard tab.
  8. Log in as the user with no process related access rights that you created in step 1.
  9. No available processes can be seen in the Project, Processes tab.
  10. No processes link can be seen on the administration side either. There is no way the user can execute a process.
  11. Open a project, navigate to the Dashboard tab.
  12. The HTML portlet is present there and contains buttons such as: Create Cost plan, Update Cost Plan.
  13. The buttons initiated the processes specified on the HTML portlet.
  14. Click the buttons.
Expected Results: No processes to be executed as the user does not have rights.
Actual Results: Processes associated to the buttons are executed even if you do not have rights.
DE53998 - Help link does not work in non-English locale
SUMMARY: When the language is set to Spanish (or anything non-English), the Help button does nothing when clicked.
Steps to reproduce:
  1. Log in to
    Clarity PPM
    .
  2. Click Help - The documentation works as expected.
  3. Go to Home, Account Settings.
  4. Change Language to Spanish and Save.
  5. Click Help.
Expected Results: The expected behavior is that the following languages are supported
  • French
  • German
  • Spanish
  • Brazilian Portuguese
  • Italian
  • Japanese
It should display in the specific language. If it is in a language we don’t support for localization it should default to English.
Actual Results: No pop up comes up as the HID and language doesnot match.
DE53709: Modern UX: CMN-0009 error returned when updating an MVL field if a value selected is inactive
Steps to reproduce:
  1. Log in to Classic Clarity PPM.
  2. Navigate to Studio, project object.
  3. Create a Multi Value Lookup (MVL) type attribute based on the OOTB LOOKUP_USER_ACTIVE_SEC lookup.
  4. Provide an API Attribute ID to make it available in the New User Experience.
  5. Add the field to the project list view.
  6. Add some users to the field and save changes in a given project.
  7. Navigate to Admin, Resources.
  8. Select one of the users that we added to the MVL field and inactivate it.
  9. Navigate back to the project list and look at the MVL field and the selected values.
  10. The inactivated value is displayed.
  11. Add some further values and save. The changes are saved.
  12. Log in to the New User Experience, navigate to project list.
  13. Add the MVL field to the list.
  14. All the pre-selected values appear in the list. Also the users who were inactivated are listed.
  15. Edit the field. While editing, you only see the active values.
  16. Try to add some extra values to the field.
Expected Results: The extra values added to the field are saved.
Actual Results: Errror CMN-0009: Attribute 'MyMVL' has invalid Lookup Value '[5003289, 5003130, 5003267]'
DE54159: Unable to Import Roadmap with Custom Investments using OBS in Oracle and Postgres SQL
Steps to reproduce:
  1. Log in to the
    Clarity PPM
    .
  2. Create a Roadmap.
  3. Navigate to Import Roadmap from PPM and select a Custom Investment.
  4. In Custom investment import window, select an OBS and click import.
Expected result: All associated custom investments should be imported as roadmap items.
Actual result: No custom investments are imported as roadmap items.
DE53318: Multiple instance of job run
Steps to reproduce:
  1. Create a custom object.
  2. Create a custom action on the object that launches an instance-specific “Autoschedule Project” job.
  3. Put the action on the edit view of the object.
  4. Navigate to an instance of the object and click the action.
Expected Results: One instance of the “Autoschedule Project” job will run.
Actual Results: Multiple instances of the job run.  In “Scheduled Jobs” you see one but in the jobs log there is two instances of the job. 
Workaround: None.
DE53944 -Connection leak issue in Advanced Resource Planning (AE-3262)
Steps to reproduce:
  1. An active
    Clarity PPM
    system process (not an instance process). The process can be empty, no actions are required.
  2. An Advanced Resource Planning action (itd AE Actions List instance) configured to start the
    Clarity PPM
    process.
  3. Navigate to Advanced Resource Planning, and start the Test process from there, by using the context menu item (ex. Test process). Do this a couple of times.
  4. Check again the number of active connections. It will increase with each process started and remain high because the connections created during the process start are not being closed.
Expected Results: The number of active connection should be closed.
Actual Results: Check again the number of active connections. It will increase with each process started and remain high because the connections that are created during the process start are not being closed.
Workaround:  NA
DE54038 - REST API calls using Bearer Tokens do not release DB Connections after serving request
Steps to reproduce:
  1. Log in to the
    Clarity PPM
    , Administration, API Keys, Clients. Define a client that can be used.
  2. Navigate to API Keys from the top right corner of any page in the
    Clarity PPM
    and create an API Key.
  3. Restart the app service and make note of the connections open using the following URL. Do not let any other user log in to the application. http://HOST_NAME/niku/apache?alias=clarity&level=less&pool=less
  4. Use the API Key that you generated in Step 2 with the client that you defined in Step 1 as headers, to make a GET call in the following format: http://HOST_NAME/ppm/rest/v1/projects?limit=5&offset=0&sort=_internalId
  5. Make a note of the total ACTIVE connections using the same URL as in Step 3.
  6. Repeat Step 4.
  7. Make a note of the total ACTIVE connections using the same URL as in Step 3.
  8. Restart the app service.
  9. Instead of the Bearer Token, use Basic Authentication to make the GET call from Step 4.
  10. Make a note of the total ACTIVE connections using the same URL as in Step 3.
  11. Repeat Step 7.
  12. Make a note of the total ACTIVE connections using the same URL as in Step 3.
Expected Result: Count of ACTIVE connections do not increase in Steps 5, 7, 8, and 10.
Actual Result: Count of ACTIVE connections increases in Steps 5 and 7. They do not increase in Steps 8 and 10.
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 PPM 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 PPM
      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.
Issues Fixed in JasperReports Server 7.1.3_6.3.0.1 for Clarity 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
    Clarity PPM
    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
    Clarity PPM
    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
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 the Clarity 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.