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