Atlassian Confluence plugin

Click the following link for additional content such as blogs, videos, use cases, and more:

Atlassian Confluence

Display contextual links to your Atlassian Confluence documentation pages.

Only the Jira Cloud offering is supported by this data source.

Adding a data source

To add a data source, open the relevant workspace and then 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 Add data source page.

Before you start

  1. Check the required permissions
  2. Create an API token
  3. Configure the data source in SquaredUp

Check the required permissions

You will need the email address of a user and an Atlassian API token created by that user. The user account only needs read-only access to a space to return pages from that space.

Creating an API token

This plugin requires you to provide an Atlassian API token to authenticate the data source.

It is recommended to generate a specific API token for your SquaredUp instance, so if you ever need to revoke it you will not impact any other applications.

For steps for API token management from Atlassian, see Atlassian: Manage API tokens for your Atlassian account

The user can create a scoped API token from here: https://id.atlassian.com/manage-profile/security/api-tokens

Configuring the data source

  1. Display name:
    Enter a name for your data source. This helps you to identify this data source in the list of your data sources.

  2. Domain URL:
    The domain for the Atlassian instance you wish to use, in the format:
    https://your-domain.atlassian.net
  3. User email address:
    Enter the email address of the Atlassian account that generated the API token.
  4. API token:
    Select the type of token to use. See Before you start for more information.
  5. Token:
    Enter the API token generated from the email address in the Creating an API token section.
    Note

    If you selected the Without scopes (legacy) option, the same API token can be used for the Jira and Confluence data sources.

Testing and troubleshooting

If you encounter an error refer to the guidance or contact our support team in-app or via SquaredUp Support

For errors on dashboard tiles see Troubleshooting tiles.

When you select Test and Add SquaredUp will test that the email address and API token are both valid and return data from Jira.

Error
What to do
Unable to access Jira, please make sure API Token is valid
Check that the user email address is correct. Check that the API token is correct. See Creating an API token
If you get an error for a newly created API token, wait a couple of minutes and then click Rerun tests, as it takes a few minutes for the API token to be created.
Authentication failed. Please check your username, password, and permissions - you may be limited to public pages
Unauthorized. Please verify the User Email Address and API Token.
Check that the user email address is correct.
getaddrinfo ENOTFOUND <domain url>
An error occurred while connecting to the data source
ERROR: Failed to configure connection, please try again later and contact support if this persists
Check that the Domain URL is correct.
ERROR: Internal plugin error (Support Code: Usxi0iZcIAMEbtw=)
TypeError [ERR_INVALID_ARG_TYPE]: The first argument must be of type string or an instance of Buffer, ArrayBuffer, or Array or an Array-like Object. Received undefined
Check the API token.

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 are named queries targeted at a data source, typically mapped to a specific API endpoint. They define how SquaredUp retrieves live data. By standardizing information from diverse formats into a simple table, data streams provide a consistent starting point regardless of the original source system.

Each plugin includes its own set of data streams. When editing a tile or exploring data, the data stream you choose acts as the entry point to the objects and records within that data source.

Scoped data streams allow you to specify which objects to pull data about. Global data streams return general information not tied to objects.

Some data streams are configurable, meaning you can configure additional settings on the Parameters tab of the tile editor to create a bespoke query.

While creating a tile you can tweak data streams by grouping or aggregating specific columns.

See Data Streams for more information.

The following data streams are installed with this plugin.

Pages (Match All Labels) / All

Get all pages that match all labels

Pages (Match All Labels) / Archived

Get archived pages that match all labels

Pages (Match All Labels) / Current

Get current pages that match all labels

Pages (Match Some Labels) / All

Get all pages that match some labels

Pages (Match Some Labels) / Archived

Get archived pages that match some labels

Pages (Match Some Labels) / Current

Get current pages that match some labels

Pages / All

Get all pages that match all labels

Pages / Archived

Get archived pages that match all labels

Pages / Current

Get current pages that match all labels

Was this article helpful?

Have more questions or facing an issue?
Submit a ticket