Is Not a Valid Reference Error
Platform Notice: Data Center - This article applies to Atlassian products on the Data Center platform.
Note that this knowledge base article was created for the Data Center version of the product. Data Center knowledge base articles for non-Data Center-specific features may also work for Server versions of the product, however they have not been tested. Support for Server* products ended on February 15th 2024. If you are running a Server product, you can visit the Atlassian Server end of support announcement to review your migration options.
*Except Fisheye and Crucible
Environment
any version of Jira Server or Data Center
Symptoms
There can be a variety of different symptoms or there could be none present at all. What is consistent is the appearance of the following errors within the atlassian-jira.log
.
2011-02-17 09:39:12,163 http-8080-5 WARN xxxxxxx 579x6004x1 1b7w9ft 192.179.113.217 /secure/IssueNavigator.jspa [velocity] org.apache.velocity.runtime.exception.ReferenceException: reference : template = getEncodedBodyFromContent [line 1,column 71] : ${issue.id} is not a valid reference.
at org.apache.velocity.runtime.parser.node.ASTReference.render(ASTReference.java:277)
at org.apache.velocity.runtime.parser.node.SimpleNode.render(SimpleNode.java:230)
at org.apache.velocity.app.VelocityEngine.evaluate(VelocityEngine.java:300)
at org.apache.velocity.app.VelocityEngine.evaluate(VelocityEngine.java:202)
at com.atlassian.velocity.DefaultVelocityManager.getEncodedBodyForContent(DefaultVelocityManager.java:143)
at com.atlassian.jira.plugin.webfragment.JiraWebFragmentHelper.getHtml(JiraWebFragmentHelper.java:115)
Cause
This error occurs due to a third-party plugin that is not fully compatible with JIRA or can occur due to modifications to the default velocity templates.
Some users have detected more specific causes and resolutions! Please read through the comments below.
Workaround
If your instance is running without noticeable error, this error message can be safely ignored - however we would recommend following the steps in the resolution to identify any problematic plugins.
Resolution
As we do not have a comprehensive list of all plugins that can cause this problem, the plugin will need to be identified through isolation testing. This can be done with the following steps.
- First, attempt to upgrade all your plugins and then see if the problem is still persistent - it may be a plugin developer has corrected the incompatibility.
- If the problem is still present, disable all plugins through the UPM, as in Disabling all add-ons (using Safe Mode).
- Enable each plugin one-by-one, whilst monitoring the logs for the error message and also checking JIRA for any browser errors that may have been present.
- When you find the problematic plugin, please keep it disabled and forward the problem to its vendor, whose details can be found on the Atlassian Marketplace.
Currently, we're trying to asses impact of this problem on our customers. If you believe there is a need to improve currently returned warning message, please provide us your feedback and vote on JRASERVER-25195 - Capture offending plugin causing 'issue.id is not a valid reference' error