Frequently Asked Questions

General

Can Dataplane report on issues created before it was installed or only on those issues created or modified after installation?

Arsenale Dataplane reports on the entire history of your JIRA instance, providing a comprehensive analysis of even those issues created or modified before Dataplane was installed.

When Dataplane is first installed, it automatically indexes your entire JIRA instance history including every issue creation, workflow transition, and field value change ever made. Once the initial index is complete, all subsequent changes in your JIRA instance are tracked by Dataplane in realtime.

So with Dataplane you get the same detailed insight into past project and team performance and metrics as you have going forward.

How current is the data I'm viewing in Dataplane reports?

After Arsenale Dataplane does an initial index, upon installation, of your JIRA instance history, all subsequent changes in your JIRA instance are then tracked by Dataplane in realtime.

So all Arsenale Dataplane reports reflect the most current state of your JIRA issues.  There is no delay between JIRA issue changes and those changes being reflected in Dataplane reports, whether those reports are viewed within Dataplane, on JIRA dashboards, or in Confluence via a Dataplane gadget.

Will Arsenale Dataplane modify any of my JIRA project or issue data?

No. Dataplane does not modify your JIRA data in any way.  

All of your JIRA project, issue, configuration and other JIRA application data is treated as read-only by Arsenale Dataplane. For its performance-optimized reporting and storing of saved reports and user-specific settings, Dataplane creates and maintains its own, separate database tables within the JIRA database.

Is Dataplane subject to the same 1000 issue export limit as the JIRA Issue Navigator?

No. Dataplane works completely independent of the JIRA Issue Navigator and is not subject to this limitation.

If you have not yet run into this limitation in the JIRA Issue Navigator, it refers to trying to do an Excel export of the results of a JIRA search and being limited to a maximum of 1000 issues (rows) that can be exported at any one time. This can make it difficult to pull comprehensive JIRA data into Excel for additional analysis. The limit built into the JIRA Issue Navigator is due to potential performance and memory issues with larger exports.  You may increase this limit via a JIRA configuration parameter but should carefully monitor instance performance and memory usage in making any changes. Any changes made to JIRA's export limit is independent of Arsenale Dataplane and has no effect on your export of issues from Dataplane.

With Dataplane you can easily run reports on and export results containing tens of thousands of issues. Dataplane's Issues Table Report is an excellent substitute for viewing and exporting issues from the JIRA Issue Navigator. 

Dataplane's report queries are run directly against the JIRA database rather than JIRA's internal issue cache.  So that Dataplane's database queries are not completely unbounded in result size, Dataplane places a soft limit on database query results of 20 million result items (20,000,000 rows x columns of data). While we expect this limit should be more than sufficient for the majority of JIRA instances, if running a Dataplane report produces an error indicating this limit has been reached, you may tune the limit with the following JVM parameter:

-Dcom.arsenalesystems.dataplane.query.result.limit=30000000

Dashboard Gadgets

When using Dataplane dashboard gadgets in Confluence, why do users get an authentication prompt?

On some systems, after you add a Dataplane report to a Confluence page, users see a message similar to the following at the top of the gadget in Confluence:

If you are a registered user, there may be more information available to you. You will need to log in and approve this gadget's access to your account. (Show Restricted URLs)

[Login & Approve]

This message instructs users to confirm their identity to the JIRA server. (The confirmation is performed using the industry-standard OAuth protocol.) When the user clicks "Login & Approve", they will be sent to the JIRA server in order to confirm the connection, and they are then returned to Confluence to see the Dataplane report. This authentication prompt is a general feature of all Atlassian Gadget that require user authentication, so it is not specific to Dataplane.

In general, users should only have to perform this approval once. If users need to continually approve the gadget, or if even performing one approval is too much, some alternate solutions are listed below.

Solution 1: Switch to Trusted Application authentication

The easiest way to work around the problem is to configure the Application Link between the two applications to use Trusted Applications authentication. When Trusted Applications authentication is in use, authentication is automatic and users will never be asked to approve the gadget. To enable Trusted Applications:

  1. In JIRA, go to Toolgear » Add-ons » Application Links.
  2. Find the Application Link corresponding to your Confluence server, then click "Edit".
  3. Click on "Outgoing Authentication".
  4. Click on the "Trusted Applications" tab (or ensure that it is already selected), then click "Enable".
  5. Click on "Incoming Authentication".
  6. Click on the "Trusted Applications" tab (or ensure that it is already selected), then click "Enable". You may need to scroll to the bottom of the dialog window to find the Enable button.

This procedure will enable Trusted Applications authentication for all gadgets, and the confirmation dialog should no longer appear.

Solution 2: Diagnose and Fix OAuth Configuration

If you do not wish to use (or cannot use) Trusted Applications for your Application Links, but you still receive the approval confirmation dialog more than once per user session, something is likely broken with your OAuth configuration.

Some of the following issues are known to cause problems with the OAuth confirmation:

  • accessing Confluence (or JIRA) with a URL other than the base URL configured in the application's configuration page. For example, if JIRA is configured with a base URL of "http://jira.mycompany.com" but users typically access JIRA using a shortcut of "http://jira", OAuth may not work properly. To correct this issue, ensure that the base URL is configured correctly in the JIRA system configuration, and then ensure that all users are accessing it with that name. (If you run JIRA behind a web server, you may wish to configure your web serfver to redirect all nonstandard URLs to the canonical URL.)
  • configuring both Confluence and JIRA on the same hostname, only differentiated by a context path or port. OAuth may not always work as desired if (say) your Confluence server is accessible at http://tools/confluence and JIRA is accessible at http://tools/jira. Similarly, trying to access JIRA as http://tools:8080 and trying to access Confluence as http://tools:8090 may also cause problems. In this scenario, consider creating different hostnames for each applications. (Both services can still continue to be run on the same physical or virtual machine, but they should be given their own distinct hostnames and URLs.)

One additional tool for investigating OAuth problems is the OAuth authentication tokens page in the user's profile. To access this tool:

  • First, log onto Confluence as one of the users who is having authentication problems.
  • Try to display pages containing Dataplane gadgets a few times. Make sure that you authenticate the gadgets more than once.
  • Next, log into JIRA as the same user.
  • Click on the user profile icon in the top right corner and select "Profile".
  • Click the "Tools" dropdown in the top right corner of the page, and select "View OAuth Access Tokens".

The subsequent OAuth Tokens page will show a list of all of the approved OAuth Access Tokens for the specified user. If you see a large number of tokens that were all approved at around the same time, you may need to go back and double-check the URL configurations.

When viewing Dataplane gadgets on a Confluence page, why do users get a PermissionException error?

When viewing a Dataplane gadget in Confluence, users may get a message such as the following, even though they are correctly logged into both Confluence and JIRA:

PermissionException: In order to access this feature, you need to log in.

This typically happens when using Application Links that are configured with Trusted Applications, but you are using incompatible versions of JIRA and Confluence. In particular, Atlassian published a number of security advisories on 2014-02-26 that impact the following versions of JIRA and Confluence:

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.

If only one of your applications falls into the above version range, that application still must be patched, since the Application Links in later versions of Confluence and JIRA are not compatible with earlier versions in the above range that do not have the patch.

When viewing Dataplane gadgets on a Confluence page, why is the gadget blank or why can it not be configured?

We are aware of two possibilities:

Long-Running Reports Cause Timeouts and Blank Gadgets in Confluence

If your Dataplane report requires a long time to generate, the gadget may appear to be loading on your Confluence page for the first few seconds, but it will then stop and render as a blank gadget. This issue is caused by a short timeout built into the HTTP relay functionality in Confluence.

To solve the problem, edit the JVM system parameters for Confluence. For Linux installations, this is done by editing the CATALINA_OPTS variable in $JIRA_HOME/bin/setenv.sh. For Windows installations, please instead follow Atlassian's documentation for instructions on editing JVM system parameters.

For Confluence 5.x and below, add the following to your CATALINA_OPTS. The default timeout for Confluence 5.x is 15 seconds.

-Dhttp.socket.timeout=60000

For Confluence 6 and above, you must add the following parameter instead to CATALINA_OPTS. The default timeout for Confluence 6+ is 5 seconds.

-Datlassian.http.connection.timeout=60000

The above change will increase the HTTP relay timeout from the default to 60 seconds. If your reports require more time, you may adjust this value accordingly. Please note that the timeout specified by this parameter is in milliseconds.

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.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 Configuration » 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.

If you use JIRA behind a web server proxy, you may still be able to leave gzip compression enabled on the proxy.

I'm still having problems with rendering Dataplane gadgets in Confluence. Help!

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.

JIRA Issue Fields

What JIRA issue fields are supported by Arsenale Dataplane?

Dataplane reports on a wide variety of JIRA field types including:

  • the majority of built-in JIRA fields
  • the majority of standard JIRA custom fields
  • custom fields from the following add-ons: JIRA Agile, Valiantys nFeed and ScriptRunner
  • all other third-party custom fields that are "stattable" (have been implemented using the JIRA CustomFieldStattable class)

For complete details, see the Dataplane Supported JIRA Fields page.

Why is my custom field not in the list of fields that can be reported on?

There are a few reasons why this may be the case:

  1. your custom field may come from a third-party JIRA add-on that is not yet supported by Arsenale Dataplane.  Dataplane currently supports custom fields from the following add-ons—JIRA Agile, Valiantys nFeed and ScriptRunner—as well as any other third-party add-on's custom fields that are "stattable" (which means that they have been implemented using the JIRA CustomFieldStattable class).
  2. your custom field may not be supported 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. Additionally, only numeric-typed fields can be used in areas of the application that require a numeric field, such as for the Value option in the Sum Numeric Field by Date Report.
  3. your custom field may not be in the list of Dataplane's Supported JIRA Fields
  4. you just added a new JIRA custom field that is supported by Arsenale Dataplane but you have not yet:
    1. rebuilt your JIRA index so that the custom field is useable by JIRA, and 
    2. clicked on Sync Index on the Dataplane Administration page so that the custom field is known to Dataplane

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.

For example:

Administration

What does Sync Index do and when is it necessary?

In order to provide high performance historical reporting, Arsenale Dataplane 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 realtime.

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: 

  • if you've added issues to your JIRA instance unconventionally, such as with the JIRA Importers Plugin, a third-party issue migration tool, or a command-line interface
  • if you've added a new custom field to your JIRA instance

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 Administration 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.  

How do I disable the user feedback links in Dataplane?

Arsenale Dataplane includes a number of links in the application to allow users to easily open a support ticket with Arsenale: to suggest new features or product improvements, to request help with a feature or report, or to file a bug.

If you wish to disable this feature, hiding all product feedback links in Arsenale Dataplane:

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

  2. Scroll down until you find the listing for Arsenale Dataplane, 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.

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

Licensing

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

If you are running Dataplane 1.8 or lower, a bug in the Atlassian Add-On Manager (UPM) (UPM-4565) causes JIRA to stop Dataplane 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 1.8 or lower to a more recent release. We apologize for this inconvenience.

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

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

If you are already running Dataplane 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, visit the Manage Add-ons section of JIRA Administration:

    1. Click on the Arsenale Dataplane listing.
    2. Click the "pencil" icon next to the License Key text box to edit your existing license.
    3. Copy the Dataplane license string from the License Key text box to a temporary text file.

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

    5. Paste your Dataplane license back into the text box, and click Update to apply it.
    6. Verify the License Status field shows your license is now "Valid".

 

If you have any problems addressing this issue, please contact us for help.

Copyright © 2017 Arsenale Systems, Inc. · All rights reserved · Contact Us · Powered by Atlassian Confluence