Document toolboxDocument toolbox

flex.bi gadgets in Atlassian JIRA and Confluence

flex.bi reports and dashboards can be published as gadgets inĀ Atlassian applicationsĀ JIRA and Confluence.

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

flex.bi gadgets are supported just forĀ BUSINESS subscription plan,Ā as well as in flex.bi Enterprise.

Here are the steps how to publish aĀ flex.bi report in JIRA dashboard or Confluence page.

Increase gadget data request timeout

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

JAVA_OPTS="... -Dhttp.socket.timeout=60000"

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 flex.bi. Go to yourĀ accounts administration pageĀ and click onĀ Users. If you have BUSINESS 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Ā flex.bi application in JIRA or Confluence.

Configure application link in JIRA or Confluence

Go to your JIRA or Confluence administration pages and register newĀ flex.biĀ application and configureĀ Outgoing AuthenticationĀ for it:

  • InĀ Service Provider NameĀ enterĀ flex.bi
    IfĀ you would like to publish data from severalĀ flex.biĀ accounts then use unique service provider name for eachĀ flex.biĀ account (for example,Ā flex.biĀ account name)
  • Input previously generatedĀ OAuth detailsĀ values inĀ Consumer Key,Ā Shared Secret,Ā Request Token URL,Ā Access Token URL,Authorize URLĀ fields.

Add eazyBI report and dashboard gadget to gadget directory

As a JIRA or Confluence administrator,Ā addĀ flex.biĀ gadgets to directory using report gadget URLĀ https://flex.bi/bi/gadgets/report.xmlĀ and dashboard gadget URLĀ https://flex.bi/bi/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Ā flex.biĀ account nameĀ then report gadget URL should beĀ https://flex.bi/bi/gadgets/report.xml?service_name=flex.bi+account+name

Add flex.bi report or dashboard gadget to JIRA dashboard or Confluence page

Now you can add flex.bi 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 flex.biĀ link.
  • After clicking this link, a new browser page should open where you will need to authorize access to your flex.bi account.
  • Then authorization window should close and report gadget should show selection list with available flex.bi reports. Select necessary report and clickĀ Save.
  • After that, you should see your flex.bi 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 flex.bi report authorization using their flex.bi user credentials.