Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

If either your Confluence instance or your Jira instance fall into the above version range, you need to apply the official patches to both systems in order for the Trusted Applications link to work properly. For example, patching only Jira but not Confluence can lead to the above PermissionException errors, and it is , likely that , other parts of the Application Link will not work correctly either.

...

When using Dataplane Reports gadgets in Confluence, why am I getting HTTP 504 timeout errors?

This is caused by Confluence's short default By default, Confluence has a short timeout when making HTTP HHTP requests to Jira from a Confluence macro. The default timeout in Confluence 6+ . x and above is only 5 seconds , and in Confluence 5. x and below it is 15 seconds.

To solve the problem, edit the JVM system parameters for Confluence. For Linux installations, this is done by editing the CATALINA_OPTS variable in you change the default settings in your instance.

How to change the timeout settings

  1. In your Confluence instance, click on the settings icon Image Added.
  2. In Configuration, select General Configuration.
  3. In Connection Timeouts, select Edit to adjust the settings.

If the problem persists, you need to edit the JVM system parameters for Confluence.

Editing the JVM parameter - Linux

  1. Go to $JIRA_HOME/bin/setenv.sh

...

Info

Confluence's Administration » General Configuration page has settings that would appear to change the applicable HTTP timeout, however due to Confluence bug CONFSERVER-51594 Confluence gadget macros ignore these settings. For more details, see this Atlassian Knowledge Base article. You must instead use the JVM parameters listed below.

For Confluence 6 and above, add the following parameter to CATALINA_OPTS:

-Datlassian.http.connection.timeout=60000

...

  1. Edit the CATALINA_OPTS variable.
  2. For Confluence 6 and above, add the following parameter to CATALINA_OPTS:

    -Datlassian.HTTP.connection.timeout=60000

    For Confluence 5. x and below, add the following parameter to CATALINA_OPTS:

    -Dhttp.socket.timeout=60000

Timeout parameter values are in milliseconds, so the above change sets the HTTP timeout to 60 seconds (60,000 ms). If your longest-running Dataplane reports require more time, adjust this value accordingly. 

When using Dataplane Reports gadgets in Confluence, why is the gadget blank or cannot be configured?

We are aware of two possibilities:

Long-Running Reports Cause Timeouts and Blank Gadgets in Confluence

When a Dataplane report takes a long time to generate, the Confluence gadget may appear to be loading for a few seconds but then stop and render as a blank gadget.

To fix this, adjust Confluence's default HTTP timeout as described above in When using Dataplane gadgets in Confluence, why am I getting HTTP 504 timeout errors?.

...

Gzip Compression Causes Issues and Blank Gadgets with Jira 5.1 to 6.2.4

If you are using Jira 5.1 through 6.2.4 inclusive, a Jira bug (JRA-29795) requires that you disable Jira's built-in gzip compression feature in order to use the Dataplane gadget in Confluence. Jira 5.For Windows installations, follow Atlassian's documentation on editing JVM system parameters.

Image AddedIf you're running Confluence Data Center, do ensure to add this parameter in all of your Confluence nodes.

Info

Confluence's Administration → General Configuration page has settings that would appear to change the applicable HTTP timeout, however, due to Confluence bug CONFSERVER-51594 Confluence gadget macros ignore these settings. For more details, see this Atlassian Knowledge Base article. You must instead use the JVM parameters listed below.



When using Dataplane Reports gadgets in Confluence, why is the gadget blank or cannot be configured?

We are aware of two possibilities:

Long-Running Reports Cause Timeouts and Blank Gadgets in Confluence

When a Dataplane report takes a long time to generate, the Confluence gadget may appear to be loading for a few seconds but then stop and render as a blank gadget.

To fix this, adjust Confluence's default HTTP timeout as described above When using Dataplane gadgets in Confluence, why am I getting HTTP 504 timeout errors?.

Anchor
gzip
gzip

Gzip Compression Causes Issues and Blank Gadgets with Jira 5.1 to 6.2.4

If you are using Jira 5.1 through 6.2.4 inclusive, a Jira bug (JRA-29795) requires that you disable Jira's built-in gzip compression feature to use the Dataplane gadget in Confluence. Jira 5.0.x and Jira 6.2.5+ are not impacted.

Atlassian already recommends disabling gzip compression if you are using Jira behind an Apache httpd server with mod_proxy, and they indicate that you may actually experience a performance gain by turning it off.

To disable gzip compression, access the Jira administration panel and select System » General → General Configuration » Edit → Edit Configuration, and then disable the "Use gzip compression" feature. Failure to disable Jira's gzip compression will result in Dataplane gadgets failing to display in Confluence.

...

Some customers have reported issues with the Application Links configuration when one application is configured to connect over regular HTTP, but the other application is configured to connect over HTTPS, and that this problem is not specific to Dataplane. Ensuring that both Confluence and Jira use the same protocol may make it easier to set up a working application link.

...

...

The most common reason for this is, that after adding a new custom field to Jira that is supported by Dataplane Reports, you must:

...

  1. your custom field may not be in the list of Dataplane's Supported Jira Fields, including supported third-party app custom fields.
  2. your custom field may be supported by Dataplane, but not in the context in which you are trying to use it in a Dataplane report. For example, historical reports like the Issues Value by Date Report, support a different set of fields than reports based only on an issue's current field values, since not all Jira fields are indexed historically by Dataplane. Additionally, only numeric fields can be used in Dataplane report configuration options that require a numeric value, as with the Value option in the Sum Numeric Field by Date Report.

Calculations and Values

When reporting on time durations, are the calculated total, average, max, and min times adjusted for non-working hours?

No. All reports that include time duration statistics—such as the Closure Time Report, Time in Status Report, or the Sum Numeric Field Report—currently use a raw calculation of hours that makes no consideration for non-working hours.

...

...

What does Sync Index do and when is it necessary?

In order to To provide high performance historical reporting, Dataplane Reports builds and maintains its own optimized index of every change made to the issues in your Jira instance. Once Dataplane's index is built—after initial installation, on upgrade, or after manually clicking the Build Index button in Dataplane Administration—all subsequent issue changes in your Jira instance are tracked by Dataplane in realtimereal time.

There are a couple unconventional situations, however, where Dataplane's index of the state of your Jira instance may not be completely up-to-date: 

...

Under any of the above circumstances, the new issues or custom field will not be available within Dataplane until you click on the Sync Index button on the Dataplane Reports → Administration page→ Configuration page.

Sync Index tells Dataplane to re-synchronize its realtime indexing with the current state of your Jira instance, picking up any new custom fields or unconventionally created Jira issues. This incremental synchronization is very fast and should complete in under a minute on most instances.  

Anchor
disableFeedback
disableFeedback
How do I disable the

...

feedback and support links in Dataplane Reports?

Some Dataplane Reports includes a number of links in the application to allow users to easily open a support ticket: to suggest new features or product improvements, to request help with a feature or report, or to file a pages display links to our support portal, enabling users and administrators to easily suggest new product features or improvements, request help, or report a possible bug.

If  See our documentation on Disabling Feedback and Support Links if you wish to disable this feature, hiding all product feedback links in Dataplane Reports:

  1. Go to Jira Administration -> Add-Ons, and click on Manage add-ons.

  2. Scroll down until you find the listing for Dataplane Reports, and click on it to expand the add-on listing.

  3. Click on the link labeled "xx of yy modules enabled" on the right-hand side of the listing. Then scroll down to see the list of individual components ("modules") of the Dataplane add-on.

  4. Find the "Issue Collector Web Resources (issueCollectorWebResources)" module and click on the Disable button that appears when you hover your cursor over that module listing.

Image Removed

The feedback module is now disabled, and Dataplane Reports product feedback links are no longer visible to users.

Image Removed

...

No. Uninstalling Dataplane Reports is perfectly safe, and does not delete any Dataplane Reports user data or settings.

Dataplane Reports user data and settings are stored in an app-specific set of Active Objects tables in the Jira database, which are left untouched when Dataplane Reports is uninstalled. Upon reinstallation of Dataplane Reports, all app user data and settings are available again within Dataplane.

Security

Is Dataplane Reports vulnerable to CVE-2021-44228 Apache Log4j2 exploit ("Log4Shell")?

No. Dataplane Reports is not vulnerable to CVE-2021-44228, which is based on an exploit of the Java log4j2 (v2.0+) library.

Dataplane Reports does not use log4j2. For logging, Dataplane uses the log4j v1.2.17 API provided by Jira; but this log4j version is not vulnerable to CVE-2021-44228. 

The Atlassian CVE-2021-44228 disclosure page details some specific circumstances in which a Jira instance, and apps like Dataplane Reports that use Jira's log4j v1.2.17 API, could be exposed to a CVE-2021-44228-like exploit should Jira be configured in a non-default way by an instance administrator. Please review that page in detail to determine if it applies to your Jira configuration.

Licensing

...

Why is Dataplane Reports no longer available upon expiration of my paid license maintenance period?

If you are running Dataplane Reports 1.8 or lower, a bug in the Atlassian Add-On Manager (UPM) (UPM-4565) causes Jira to stop Dataplane Reports from running upon license maintenance expiration, rather than letting you continue using Dataplane outside of your maintenance period (as your perpetual license allows). This also affects impacts users who are in the process of upgrading from Dataplane Reports 1.8 or lower to a more recent release. We apologize for this inconvenience.

To resolve the issue while running Dataplane Reports 1.8 or lower, you will need to:

1) Upgrade to Dataplane Reports 1.9 or newer, and
2) Remove and reinstall your Dataplane Reports license. This will correct the licensing condition immediately. 

If you are already running Dataplane Reports 1.9 or later, these special instructions do not apply and no action is needed.

To resolve the licensing bug, after upgrading to a new version of Dataplane Reports, visit the Manage Add-ons section of Jira Administration:

...

Delete your license string so that the License key text box is empty, and click Update.

...

.

Anchor
dataSafetyUninstalling
dataSafetyUninstalling
Does uninstalling Dataplane Reports delete any app user data or settings?

No. Uninstalling Dataplane Reports is perfectly safe, and does not delete any Dataplane Reports user data or settings.

Dataplane Reports user data and settings are stored in an app-specific set of Active Objects tables in the Jira database, which are left untouched when Dataplane Reports is uninstalled. Upon reinstallation of Dataplane Reports, all app user data and settings are available again within Dataplane.

Security

Is Dataplane Reports vulnerable to CVE-2021-44228 Apache Log4j2 exploit ("Log4Shell")?

No. Dataplane Reports is not vulnerable to CVE-2021-44228, which is based on an exploit of the Java log4j2 (v2.0+) library.

Dataplane Reports does not use log4j2. For logging, Dataplane uses the log4j v1.2.17 API provided by Jira; but this log4j version is not vulnerable to CVE-2021-44228. 

The Atlassian CVE-2021-44228 disclosure page details some specific circumstances in which a Jira instance, and apps like Dataplane Reports that use Jira's log4j v1.2.17 API, could be exposed to a CVE-2021-44228-like exploit should Jira be configured in a non-default way by an instance administrator. Please review that page in detail to determine if it applies to your Jira configuration.