eazyBI gadgets in Atlassian Jira and Confluence

eazyBI reports and dashboards can be published as gadgets in Atlassian applications Jira and Confluence.

The main benefit of eazyBI gadgets compared to embedded <iframe> eazyBI reports is that one eazyBI user can authorize access to eazyBI using OAuth authorization and then publish selected reports or dashboards to other users who are not eazyBI users.

eazyBI gadgets are supported just for STANDARD and PLUS subscription plans as well as in Private eazyBI.

These instructions are for eazyBI Cloud. If you are using eazyBI add-on for Jira Server or Jira Cloud please see Publish in Jira dashboards in the eazyBI for Jira documentation space.

As OpenSocial gadgets are not included in new Google Sites and the old Google Sites are planned to be deprecated, the OpenSocial gadgets functionality is no longer supported by eazyBI.

Here are the steps how to publish an eazyBI report in a Jira dashboard or Confluence page.

Increase gadget data request timeout

By default, data requests from gadgets in Confluence pages will time out after 5 seconds. If you have longer running eazyBI reports then please specify -Datlassian.http.connection.timeout=TIMEOUT_IN_MILLISECONDS Java property in Confluence startup scripts. E.g. in bin/setenv.sh add to CATALINA_OPTS

CATALINA_OPTS="-Datlassian.http.connection.timeout=60000 ${CATALINA_OPTS}"

to increase gadget data request timeout to 60 seconds.

Register OAuth client application

At first, you need to register Jira or Confluence as OAuth client application in eazyBI. Go to your accounts administration page and click on Users. If you have STANDARD or PLUS subscription plan then you should see OAuth Client Applications section.

Register your Jira or Confluence application with Custom application type and specify just Main Application URL (it is used just for information purposes), do not specify callback URL (as it will be provided by Jira or Confluence dynamically).

After registering application you will see OAuth details information that you will need when registering the eazyBI application in Jira or Confluence.

Configure application link in Jira or Confluence

Go to your Jira or Confluence administration pages and register new eazyBI application and configure Outgoing Authentication for it:

  • In Service Provider Name enter eazyBI
    If you would like to publish data from several eazyBI accounts then use unique service provider name for each eazyBI account (for example, eazyBI account name)
  • Input previously generated OAuth details values in Consumer KeyShared SecretRequest Token URLAccess Token URL,Authorize URL fields.

Add eazyBI report and dashboard gadget to gadget directory

As a Jira or Confluence administrator, add eazyBI gadgets to directory using report gadget URL https://eazybi.com/gadgets/report.xml and dashboard gadget URL https://eazybi.com/gadgets/dashboard.xml

If you used non-default service provider name then specify its name with the service_name parameter. For example, if service provider name is eazyBI account name then report gadget URL should be https://eazybi.com/gadgets/report.xml?service_name=eazyBI+account+name

In the case of Private eazyBI the gadget URL are like this:  <eazyBI HOST>/eazybi/gadgets/report.xml

Add eazyBI report or dashboard gadget to Jira dashboard or Confluence page

Now you can add eazyBI report or dashboard gadget to either Jira dashboard or Confluence page.

  • If previous configuration steps were done correctly then at first added report should show the Authorize access to eazyBI link.
  • After clicking this link new browser page should open where you will need to authorize access to your eazyBI account.
  • Then authorization window should close and report gadget should show selection list with available eazyBI reports. Select necessary report and click Save.
  • After that, you should see your eazyBI report.

Report height and width modification

In report gadget parameters you can modify Report height parameter and specify report height in pixels.

In Jira dashboards report width is resized automatically based on dashboard layout. In the Confluence page you can specify width parameter in gadget parameters – specify auto for full-width reports or specify width in pixels.

Report sharing with other users

If you share Jira dashboards or Confluence pages with other Jira or Confluence users then each user will need to make at first eazyBI report authorization using their eazyBI user credentials.