search cancel

Clarity Upgrade error "Error validating NSQL"


Article ID: 186675


Updated On:


Clarity PPM On Premise Clarity PPM SaaS


The install.log is showing the following error post upgrade:

The log may show multiple query names:

3/08/20 3:11 PM (Java) Error validating NSQL
3/08/20 3:11 PM (Java) 
3/08/20 3:11 PM (Java) Query name=Issues Listing : Query ID=<Query.ID> : Content :
3/08/20 3:11 PM (Java) You must correct invalid NSQL queries.  In PPM Studio, go to the NSQL tab for each failing NSQL query. Click the 'Preview' button to view the error details. See the Change Impact Guide for further information.


Release : All Supported Releases


This can be due to custom queries that require corrections post upgrade.


Step 1: Correct any invalid custom NSQL queries:

  • See section: (On-Premise and SaaS) Post-Upgrade: Verify NSQL Queries at: (On-Premise and SaaS) Complete the Post-Upgrade Steps where the below steps and more details are referenced
  • If a query is associated with a portlet, clear the Available for User Portlets check box on the query properties page to edit the query.

Note: You cannot edit system queries that are provided by Clarity.

Follow these steps: 

  1. Click Administration, Studio, Queries.
  2. Open each failing query and click the NSQL tab.
  3. Clear the Available for User Portlets check box.
  4. Click Save and Continue.
  5. Review the errors and repair the broken query constructs or fields.
  6. Click the Preview button.
  7. Confirm that the NSQL query is valid.
  8. Click the General tab.
  9. Select the Available for User Portlets checkbox.
  10. Click Save and Return.

If the query is in use by active portlets and cannot be edited in Studio, use the XML Open Gateway (XOG):

  1. Export the failing query.
  2. Correct the broken query constructs or fields.
  3. Use XOG to import the corrected query. Perform the steps above this tip to preview and verify the query.

Step 2: Check for additional errors in the install.log that may be the root cause of the failure that require fixing prior to retrying the upgrade.

Additional Information

Note: These warnings are not blocking the upgrade and will not fail an upgrade