This section describes the options available to under Dataplane Reports » Administration » Configuration.To configure Dataplane Reports, select Dataplane Reports → Administration from the top Jira navigation bar.
Then under the Dataplane Reports section in the left sidebar, select Configuration.
Dataplane Indexing
| Anchor | ||||
|---|---|---|---|---|
|
Before you can run any reports in Dataplane Reports, you must build Dataplane Reports' history index.
This is typically a one-time operation. Once the history index is built, Dataplane Reports updates the index in real-time to ensure that reports are always using use the most up-to-date data.
| Note |
|---|
Rebuilding the index can take a long time—up to a few hours on large systems, and sometimes even longer on enterprise-scale systems (particularly when using Microsoft SQL Server). 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 the Dataplane Reports → Administration → Configuration page select select the Configuration Indexer tab and click the Build Index button.
While the Dataplane Reports history index is being built, you can view the progress on this same Configuration page is actively updated with indexing progress.
| Info |
|---|
The index build is done as Dataplane Reports indexing is 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, requiring no active monitoring or other user actions. You are free to browse anywhere else in Jira while Dataplane is indexing, and may can return to the Dataplane's Administration → Configuration page at any point to see the latest index build time to check on indexing progress. |
Once When the Dataplane index build is complete, you will see the updated indexer status on this page:has finished, the Configuration page will confirm successful completion, or display any errors encountered.
Indexing on Jira Data Center
When building the Dataplane Reports index for the first time, or when incorporating incremental changes to the index, Dataplane runs its indexing operations in a background task to perform the indexing operations. In a multiple cluster Jira Data Center installationinstance, these indexing tasks are performed on only this background indexing task runs on only one cluster node at a any given time.
infoThe cluster node
on which you click the "Build Index" button in the UI may not necessarily be the node that performs the underlying indexing work.If you have any questions about how to determine which node is performing the indexing, please contact our support team.
On startup in a Jira Data Center instance, Dataplane will automatically select one "master" Jira node to perform the indexing tasks. As cluster nodes are brought up and down, so long as Dataplane is not in the middle of an indexing operation, these indexing tasks are automatically handed off to another live node in the cluster as neededDataplane Reports is currently using for indexing is called the Indexer Node, and is displayed on the Indexer tab of the app administration Configuration page.
When the Dataplane Reports app is enabled—on Jira Data Center startup, or on installation of the app—Dataplane automatically selects a cluster node to use as its Indexer Node based on node availability. If the Indexer Node is removed from the Jira Data Center cluster, Dataplane Reports automatically selects a new Indexer Node on which to perform future indexing operations.
| Note |
|---|
For performance reasons, the initial Dataplane index build process cannot be handed off to another node. If you are building the Dataplane Reports index for the very first time, or you are performing an upgrade that necessitates a Dataplane reindexDataplane requires a reindex for some other reason, you must ensure that the node performing the indexing operation remains up Dataplane's Indexer Node remains active in the Jira Data Center cluster for the duration of the indexing process. If the node goes down Indexer Node is removed from the Jira Data Center cluster in the middle of indexing, you must manually restart the indexing process. |
Synchronizing the History Index
Once the history index has been built, the Sync Index button allows you to request a manual synchronization of the Dataplane Reports index.
Performing a manual synchronization of the Dataplane index is not required under normal operation, since Dataplane tracks all issue changes automatically.
When you click the Sync Index button, Dataplane will perform the following actions:
- Refresh the list of Jira custom fields to determine if any newly-added fields should be made available for use in the Dataplane UI, and
- Find any previously-existing issues in Jira that do not already exist in the Dataplane index.
If you have added a new custom field to Jira (or renamed an existing one) since Dataplane was installed or enabled, clicking Sync Index will ensure that the custom field is made available to users.however there are a few situations where a Sync Index is necessary.
When Jira Issues are Created Unconventionally
Under normal circumstances, all issues that are created and updated in Jira are automatically included in the Dataplane index in real-time. However, if an issue is created without generating an issue event (such unconventionally—such as by some versions of the Jira Issue Importer, or by a Groovy-based script that does not generate events), the system events—the issue may not be added to the Dataplane Reports' index, and performing a manual Sync Index after the issue import may be required in order to see the issue in reports.
Similarly, if you disable or uninstall Dataplane, create some issues, and then re-enable Dataplane, those issues In addition, data for Jira issues created or edited while the Dataplane Reports app was disabled or uninstalled may not be visible in some historical reports until you click a manual Sync Index is run.
When
creating a new ScriptRunner-based custom field, you will need to click the Sync Index in Dataplane the very first after creating the custom field in Jira, which will allow the field to be displayed in the Dataplane UI. Dataplane does not require any further Sync Index operations for ScriptRunner fields (not even if you change the underlying script). However, since ScriptRunner fields are cached in Jira's Lucene index, you will need to reindex Jira itself if you make a change to the field's script that modifies the value it calculates for an issueAdding or Renaming Custom Fields
After adding a new custom field to Jira or renaming an existing one, a Sync Index is required to make the field available in Dataplane.
With a scripted custom field from the Jira Misc Custom Fields app or ScriptRunner app, a single Sync Index when the field is first added/renamed is sufficient to allow Dataplane Reports to make use of the field. No additional Dataplane Sync Index operation is needed when modifying the field's underlying Groovy script, however—as is standard practice with scripted custom fields from these apps—you will need to reindex Jira itself after any changes to the underlying Groovy script.
| Anchor | ||||
|---|---|---|---|---|
|
Each night at midnight (00:00) server time, Dataplane Reports runs a history index maintenance task. Among other functions, this task performs validity checks on the index data and optimizes index data storage.
If the nightly index maintenance task detects a critical, unrecoverable data error in the history index, Dataplane's history index is marked invalid and a full rebuild of the index is required. Until a Dataplane an administrator initiates a rebuild of the history index, Dataplane will Dataplane Reports will display an error message to all Dataplane users and administrators of the app indicating that report results may be invalid until the history index is rebuilt.
The early morning timing of this index invalidation can mean many hours go by before the issue is discovered and a Dataplane administrator is able to kick off a full rebuild of the Dataplane history index.
To limit downtime in this situation, set the following JVM property in your Jira bin/setenv.sh file to have Dataplane Reports automatically begin rebuilding its history index should it encounter any critical, unrecoverable index data errors:
| Code Block |
|---|
-Dcom.arsenalesystems.dataplane.indexer.autoRebuild=true |
| Info |
|---|
This JVM property setting is rarely needed, as unrecoverable Dataplane Reports index data errors are not common. We recommend enabling this property only if you are regularly experiencing Dataplane Reports index invalidation, and only as a temporary workaround while you engage our support team to determine the root cause of the problem. |
Removing the History Index
If you need to uninstall Dataplane Reports permanently, you can use the Remove Index button on the same Configuration tab to remove all existing Dataplane Reports index data from your Jira database. This will drop all of the tables that Dataplane Reports created to build an index.
| Info |
|---|
Depending on your database, dropping the tables may or may not release the recovered space back to the filesystem. |
Configuring Permissions
| Anchor | ||||
|---|---|---|---|---|
|
Permission to use Dataplane Reports is granted under Dataplane Access App Permission on the Configuration Permissions tab of the Dataplane Reports » Administration → Administration → Configuration 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.
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 Reports, 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.
| Info |
|---|
The permissions list does not grant add-on administration privileges. The Dataplane administration page is only accessible to users with Jira Administration privileges. |
| Anchor | ||||
|---|---|---|---|---|
|
Dataplane users can modify or extend the functionality of reports with sandboxed, Groovy-based Customizer Scripts.
By default, all users in the jira-users and jira-administrators groups are granted permission to use Customizer Scripts. If you wish to prevent some or all of these users from using Customizer Scripts, you may customize the list of groups under the Customizer Script Permission section on the Configuration tab of Dataplane Reports » Administrationthe Permissions tab of the Dataplane Reports → Administration → Configuration page.
Dataplane also handles saved reports that use Customizer Script: in order to run the report, either the user who created the report or the user who is currently accessing the report must have Customizer Script permission. This means that a small set of users may be given Customizer Script permission, who can then create a set of reports that can be shared with a larger set of users who do not have Customizer Script permission.
Note that Customizer Script permission is checked in real time. For example, if a trusted user is given Customizer Script permission and then saves a report with a script, any other user in the system (even those without Customizer Script permission) will be able to run the report. However, if Customizer Script permission is later withdrawn from the user who saved the report, only those other users who have Customizer Script permission will be able to run the report (even if the saved report itself has not been changed).
| Anchor | ||||
|---|---|---|---|---|
|
When saving a report, Dataplane allows users to make the resulting report available to other users, other groups, or everyone (including anonymous users, if your Jira permits anonymous access).
This section allows the administrator The Default Report Sharing setting on the Sharing tab of the Dataplane Reports → Administration → Configuration page allows you to define the default sharing options for newly-saved reports.
When users create new reports from a report template, the report will inherit the default sharing options specified in this section. Unless the administrator has made a selection in this section, the default for newly-created reports is "Not shared".
The selections made here apply only to newly-created reports that are being saved for the first time with Save As. The sharing selections of any existing saved reports will not be modified. In addition, existing reports that are copied using the Save As feature will still inherit the sharing options of the original report, rather than the default options specified here.
For a description of the Not shared option, the Everyone option and the projects/groups control, please see the documentation for Saving Reports.
| Panel | |
|---|---|
Page Contents
|