Jaspersoft Server Decommissioning Best Practices Runbook for On Premise
search cancel

Jaspersoft Server Decommissioning Best Practices Runbook for On Premise

book

Article ID: 449234

calendar_today

Updated On:

Products

Clarity PPM On Premise

Issue/Introduction

  • Recommended decommissioning approach
    • Suggested sequence of activities for safely decommissioning Jaspersoft servers
    • Any prerequisites that should be completed before shutdown
  • Dependency and impact assessment
    • Upstream/downstream systems, jobs, interfaces, or integrations that typically depend on Jaspersoft
    • Authentication/SSO, scheduling, notification, API, or file-transfer dependencies to verify
    • Common impact areas that teams often miss during decommissioning
  • Clarity-related updates
    • Clarity configurations, links, jobs, or references that should be removed or updated
    • Any application settings, connection endpoints, or metadata that must be repointed
    • Recommended cleanup steps in Clarity post-cutover
  • Validation and best practices
    • Pre-decommission validation checklist (functional, technical, and operational)
    • Post-decommission checks to confirm no hidden dependencies remain
    • Rollback/contingency recommendations in case any issue is identified
  • Documentation and governance
    • Any standard runbooks, or internal documentation we should follow

Environment

Clarity 16.4.3, 16.5.0

Resolution

Nov 9, 2026 is the Clarity 16.5.0 release. This is the point where Advanced Reporting is functionally removed. After you upgrade to 16.5.0:

  • Jaspersoft-based reporting is no longer available under Reports and Jobs.
  • The Advanced Reporting console is gone. This includes Jaspersoft Studio reports, Ad hoc views and reports, Dashboards, and Domains.
  • Classic Object Actions that call Jaspersoft reports stop working.
  • Modern UX Channels that point to Jaspersoft reports stop working.

Because there is no automated migration tool, any report you still need must be re-created in the native Reporting workspace before you upgrade.

Phase 0  Prerequisites

  1. Confirm native reporting is live and that the reports you depend on have been re-created and validated in Modern UX under Reporting, Reports.
  2. Take the following backups:
    • The properties.xml file from CLARITY_HOME/config.
    • A Jaspersoft repository export, taken from the console using Export.
    • A dump of the Jaspersoft database.
    • A snapshot of the Clarity database for rollback reference.
  3. Schedule a maintenance window and notify report consumers.

Phase 1  Inventory what depends on Jaspersoft

Do this on 16.4.3 while Jaspersoft is still running.

First, run the Jaspersoft - User Access Rights report in Classic PPM and save the output. You will use it in Phase 3 to remove the rights.

Next, work through the areas below and note everything that points at Jaspersoft. Each item you find becomes a task to remediate in Phase 3. The Reference section at the end lists the underlying tables if your DBA prefers to check the database directly rather than the UI.

Check these areas inside Clarity:

  • Modern UX Channels. Look for any Channel whose target address points at the Jaspersoft report server, for example an address containing reportservice or your Jaspersoft hostname. These stop working at 16.5.0. Check the Channels defined under each Blueprint, and any standalone Channel definitions.
  • Classic Object Actions. Look for object actions of the external link type that point at a Jaspersoft report. These stop working at 16.5.0.
  • Attribute URL (hyperlinks). These are the clickable links on field values. Look for any URL whose link points at Jaspersoft.
  • Registered reports under Reports and Jobs. Identify which of the registered reports are Jaspersoft reports as opposed to native reports, and confirm with someone who knows the report inventory before you retire any of them.
  • Jaspersoft integration footprint. Confirm whether Jaspersoft was actively in use, for example whether users were being synced to Jaspersoft. This tells you how much cleanup and communication is needed.

Also list the dependencies that are not stored in the Clarity database:

  • Jaspersoft own scheduled and emailed reports. Jaspersoft has its own scheduler and email path, separate from the Clarity job scheduler.  Inventory them and plan a native replacement or retirement.
  • Jaspersoft Studio Professional connections used by report developers.
  • Anything outside Clarity that links to the /reportservice URL, such as portals, bookmarks, and links built in GEL or HTML.
  • Infrastructure tied to the Jaspersoft host: reverse-proxy or load-balancer rules, DNS entries, firewall rules, SSL certificates, and monitoring.

Phase 2 Turn off the Jaspersoft configuration

Clarity only contacts Jaspersoft when a Jaspersoft report server is configured, and that state is determined entirely by the webUrl value in the reportServer entry of properties.xml. You do not need to delete the whole entry.

Steps:

  1. Stop Clarity services.
  2. Go to CLARITY_HOME/config and back up properties.xml with a version suffix.
  3. Set webUrl as below: 
    <reportServer id="jaspersoft" webUrl="http://<my_reportserver>/reportservice" context="/reportservice"   home="" serviceUrl="http://localhost:8000" volumeName="" username="ppmjasperadmin"   vendor="jaspersoft" databaseId="Niku" jndiName="jdbc/clarity" dwJndiName="jdbc/dwh" orgName="" orgId=""/> 
  4. Save the file and restart all Clarity services. Confirm the Load Data Warehouse log shows the line "Jaspersoft is not configured, domain updates will not run".
  5. Cancel and Delete the Create and Update Jaspersoft Users job so it stops trying to log in to Jaspersoft. Also Deactivate it from Administraition

Phase 3 - Clean up Clarity

  1. Remove access rights. Using the report output from Phase 1, remove the Jaspersoft and Advanced Reporting rights from users and groups. The Advanced Reporting link disappears once the rights are gone.
  2. (OPTIONAL) Update the application menu. In Classic PPM, go to Administration - Studio - Menu Manager - Application Menu. Open Reports and Jobs, rename it to Jobs 
  3. Remediate the items found in Phase 1. Do this through the UI, not with SQL deletes.
    • For the Classic Object Actions, go to Administration - Studio - Objects, open the object, then Actions, and disable or repoint each Jaspersoft action.
    • For the Modern UX Channels, go to Modern UX - Blueprints, open the blueprint, then Channels, and repoint or remove them.
    • For the attribute link schemes, repoint or deactivate them.
    • For the registered Jaspersoft reports, retire them through the Reports UI.

Phase 4  Validate before upgrading to 16.5.0

Functional and technical checks:

  • Run Load Data Warehouse, both full and incremental. It should finish cleanly.
  • Run Time Slice and confirm the Data Warehouse data is current.
  • Confirm the Create and Update Jaspersoft Users job is inactive and there are no new failures in the bg logs.
  • Re-check the Phase 1 areas. Nothing should still point at Jaspersoft, unless it is an item you intentionally kept.
  • Search the Clarity bg and app logs for jaspersoft, reportservice, and ClarityJasperAdmin. There should be no new errors.
  • Click through the UI. There should be no Advanced Reporting link, the menu should show Jobs, and there should be no broken Object Actions or Channels.
  • Confirm native reports render with current data.
  • Confirm with stakeholders that no business report is still served only by Jaspersoft.

Phase 5  Upgrade to 16.5.0

With Jaspersoft turned off, the Jaspersoft Users job disabled, and the Phase 3 remediation complete, upgrade to 16.5.0. After the upgrade, the Advanced Reporting console and the Reports and Jobs Jaspersoft entries are removed by the product. This is expected, because you have already remediated everything that referenced them.

Phase 6  Remove the Jaspersoft servers and database

Do this after 16.5.0 is stable.

  1. Stop the Jaspersoft and Tomcat report-server services.
  2. Remove the Jaspersoft Tomcat webapps and delete the docs and examples folders under tomcat_home\webapps. These are exploitable on Jaspersoft by default. See Apache Tomcat Default Files
  3. Reverse the Jaspersoft JVM and service registrations. See How to Set JVM Options for Jaspersoft Servers for Clarity PPM.
  4. Decommission the Jaspersoft database after a final backup.
  5. Remove the infrastructure tied to the Jaspersoft host: DNS entries, load-balancer and proxy rules, firewall rules, SSL certificates, and monitoring.
  6. Ensure there is no Jaspersoft credentials in the properties.xml
  7. You can consider keeping the Jaspersoft server and database in a stopped but retained state for at least one full reporting cycle before you delete them permanently.

Additional Information

Note: This document describes a decommission on Clarity 16.4.3, the same should apply if you are planning your decommission on an earlier version of Clarity, with the caveats of MUX Reporting being set or not depending on version