Atlassian Confluence plugin
For more information about what this plugin does and the data streams it retrieves, see:
Display contextual links to your Atlassian Confluence documentation pages.
Only the Jira Cloud offering is supported by this data source.
To add a data source click on the + next to Data Sources on the left-hand menu in SquaredUp. Search for the data source and click on it to open the Configure data source page.
Before you start
Creating an Atlassian API key
This plugin requires you to provide an Atlassian API token to authenticate the data source. If you do not have one already, a Jira admin can generate a new one here https://id.atlassian.com/manage-profile/security/api-tokens.
It is recommended to generate a specific API token for your SquaredUp instance, as if you ever need to revoke it you will not impact any other applications.
For detailed steps for API token management from Atlassian, see:
https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account.
Required permissions
When you configure the data source, you must provide the User email address of the account that created the token.
If the user account doesn't have access to a space, the space won't be returned. If the user account has read-only access to a space, then you get the pages in that space.
Configuring the data source
Display name:
Enter a name for your data source. This helps you to identify this data source in the list of your data sources.- Domain url:
The domain for the Atlassian instance you wish to use, in the format:
https://your-domain.atlassian.net - User email address:
Enter the email address of the Atlassian account that generated the API token. - API token:
Enter a current API token generated from the email address in the Before you start section.The same API token can be used for the Jira and Confluence data sources.
(Optional) Restrict access to this data source:
You can enable this option if you only want certain users or groups to have access to the data source, or the permission to link it to new workspaces. See data source access control for more information.Click Test and add to validate the data source configuration. SquaredUp will now attempt to connect to SquaredUp using the provided authentication method.
- Testing passed – a success message will be displayed and then the configuration will be saved.
- Testing passed with warnings – warnings will be listed and potential fixes suggested. You can still use the data source with warnings. Select Save with warnings if you believe that you can still use the data source as required with the warnings listed. Alternatively, address the issues listed and then select Rerun tests to validate the data source configuration again. If the validation now passes, click Save.
- Testing Failed – errors will be listed and potential fixes suggested. You cannot use the data source with errors. You are able to select Save with errors if you believe that a system outside of SquaredUp is causing the error that you need to fix. Alternatively, address the issues listed and then select Rerun tests to validate the data source configuration again. If the validation now passes, click Save.
You can edit any data source configurations at any time from Settings > Data Sources.
Next Steps
Data streams
You can use these data streams to create new tiles to show data, or if there are preconfigured dashboards installed you can copy or edit those.
Data streams standardize data from all the different shapes and formats your tools use into a straightforward tabular format.
While creating a tile you can tweak data streams by grouping or aggregating specific columns.
Depending on the kind of data, SquaredUp will automatically suggest how to visualize the result, for example as a table or line graph.
Data streams can be either global or scoped:
- Global data streams are unscoped and return information of a general nature (e.g. "Get the current number of unused hosts").
- A scoped data stream gets information relevant to the specific set objects supplied in the tile scope (e.g. "Get the current session count for these hosts").
See Data Streams for more information.
The following data streams are installed with this plugin.