This documentation is for an old version of Dataplane Reports.

View the latest documentation, or the list of documentation for all versions.

To administer Arsenale Dataplane, locate the main JIRA navigation bar and select Dataplane Reports -> Administration.

The add-on administration page is accessible to all users with JIRA Administration privileges.

Building the History Index

Before you can run any reports with Arsenale Dataplane, you must build Dataplane's history index. This is a one-time operation.

Once the history index is built, Arsenale Dataplane updates the index in real-time to ensure that your reports are always using the most up-to-date data.

Rebuilding the index can take a long time – up to a few hours on large systems. While all indexing is done in the background and should not affect regular JIRA use, users will be unable to run Dataplane reports while the index is being built.

To build the history index, from the Dataplane Administration page select the Configuration tab and click the Build Index button.

While the Arsenale Dataplane index is being built, you can view the progress on this same Configuration page.

The index build is done as a background process. While the index is being built, you do not need to remain on the Dataplane Administration page, or on the Configuration tab within that page. You are free to browse anywhere else in JIRA, and may return to the Dataplane Administration page at any point to see the latest index build progress.

Once the Dataplane index build is complete, you will see the updated indexer status on this page:

Removing the History Index

If you need to uninstall Arsenale Dataplane permanently, you can use the Remove Index button on the same Configuration tab to remove all existing Dataplane index data from your JIRA database. This will drop all of the tables that Dataplane created to build an index. 

Depending on your database, dropping the tables may or may not release the recovered space back to the filesystem.

Configuring User Permissions

Which JIRA users are given access to Arsenale Dataplane is controlled under Permissions on the Configuration tab of the Arsenale Dataplane -> Administration page.

By default, all users in the jira-administrators and jira-users groups are given access to Dataplane. The Dataplane Reports JIRA menu item will be visible to groups in this permissions list, as well as access to Dataplane's reporting and analytics functionality.  

In general, users who are not in any group in the permissions list will not see any Dataplane menus or be able to run reports directly through Dataplane. However, if an existing Dataplane user creates a report, shares it, and adds the resulting shared report to a JIRA dashboard that is visible to other users, everyone who is able to see the dashboard will also be able to view the Dataplane report, even if those individuals do not otherwise have Dataplane privileges. This allows administrators to restrict report creation to a select group of users, but still to display read-only Dataplane reports to other users on dashboards and information radiators.

To give groups permission to use Dataplane, type in the group names and click Add Groups.

To remove groups of users from the permissions list, select those groups and click on Remove Selected Groups.

The permissions list does not grant add-on administration privileges.

The Dataplane administration page is only accessible to users with JIRA Administration privileges.

Enabling Debug Logging

The Support tab on the Arsenale Dataplane -> Administration page shows a number of key properties of your JIRA and Dataplane instance.  This information is particularly helpful to reference whenever working with Arsenale Support to debug and resolve a possible Dataplane issue.

When working with Arsenale Support you may be asked to enable Dataplane debug logging on this page to see and share more verbose Dataplane status information. To do so, click the Enabled checkbox next to the Debug Logging option. 

Enabling Debug Logging can have an impact on application performance, so it should normally be left disabled.

Enabling Experimental Features

Occasionally an Arsenale Dataplane release will include a number of optional, experimental features that users may try out. These features are always shipped disabled, so you must explicitly enable them in your Dataplane instance.

To access these features, go to Dataplane Reports->Administration and click on the tab for Dataplane Labs.

If no Dataplane Labs tab is visible on the Administration page it means the version of Arsenale Dataplane you are running does not include any experimental features.

Page Contents

Copyright © 2023 Appfire Technologies, LLC · All rights reserved · Contact Us · Powered by Atlassian Confluence