Atlassian Confluence Connector#

Squirro provides a 1-Click Connector for Confluence. This connector allows the Project Creators to connect to an Atlassian account and index the Confluence data into Squirro.

Setting Up a Connector#

Usage assumes that the OAuth setup for the 1-click connectors has already been done on the server. This is by default available on all of our cloud servers at https://start.squirro.com. For any other Squirro installation, please ask your Squirro server admin to follow the steps in the For any other Squirro installation, follow the steps in the OAuth Configuration section below.

  • Head over to the Enterprise tab on the Data screen as shown in the screenshot below.

image1

  • Click on the Confluence icon. Squirro will show a prompt asking you to authenticate your Atlassian account. Click on the Authenticate button there.

image2

  • Once you click on the Authenticate button, you will be re-directed to the Sign-in screen hosted by Atlassian.

Squirro will never ask you for your Atlassian password. This is requested by Atlassian itself.

image3

  • Once you sign-in you will be prompted to approve Confluence scopes. This screen is presented to you by Atlassian asking you to provide consent for your Confluence data to Squirro.

image4

  • After approving scopes and selecting your Atlassian instance (if your account has access to multiple Atlassian instances), you will be brought back to Squirro’s source configuration screen. This screen shows which Atlassian account Squirro has connected to.

image5

  • Now, you can click Save & Exit for Squirro to automatically configure the mapping of item fields and labels, as well as any other required source configuration.

If your account has access to multiple Atlassian instances, Squirro will index data from the first found instance by default. The searching instance process is not deterministic and the found instance may vary across OAuth authentications. To select specific Atlassian instance provide Atlassian instance URL in the Advanced Options section.

  • Alternatively you can define those settings manually by clicking Next and going through the whole source setup process. This allows you the full flexibility of how the Confluence data should be mapped to Squirro items.

  • After clicking on Save & Exit, you will see your source running. Sit back, relax, and enjoy as your Confluence data is indexed into Squirro.

image6

OAuth Configuration#

App Config#

You will need to register an OAuth2 app on the Atlassian portal to allow Squirro to connect to the Atlassian accounts of end users. Please follow the steps below to do so.

Note that the exact process on the Atlassian platform may change. If you notice big discrepancies between the current Atlassian website and the documentation page here, please reach out to Squirro’s support at support@squirro.com for help.

image7

  • On the next screen, choose the name of your app, accept the terms and click the Create button.

image8

  • In the Permissions tab add Confluence API service.

image9

  • After adding Confluence API service, click the Configure button and add the following scopes:

    • Read Confluence space summary

    • Read Confluence content properties

    • Read Confluence detailed content

    • Read Confluence content summary

    • Search Confluence content and space summaries

    • Read user

    • Read user groups

    • Download content attachments

image10

  • Switch to the Authorization tab and configure OAuth 2.0 Authorization by clicking Configure button.

image11

  • On the next screen configure OAuth 2 Callback URL. This is the URL Atlassian will redirect the user to after successful authorization. This needs to be set to https://<your-server-url>/dataloader/confluence_plugin/pl/atlassian/authorized on your server.

    For example: https://squirro.example-company.com/dataloader/confluence_plugin/pl/atlassian/authorized.
    After that click Save changes button.

image12

Apply for Production#

Also note that the apps are listed as a private by default. It means that only the owner of the app may grant it access to their account. The app will also show a warning about Development status during the user authorization process when the users connect their Squirro instance to their Atlassian account. To avoid that, you have to apply for publishing the Confluence app.

To start that process you first have to set up the logo icon and add some description about the application in the Settings tab. After that follow the steps described in the Distribution tab. It requires the links to the privacy policy, terms of service, customer support contact and information about how your app stores personal data.

Squirro Configuration#

After having created the OAuth2 app on the Atlassian portal, you need to configure the Client ID and the Client Secret on your Squirro instance.

  • Get the Confluence Client ID and the Client Secret from the Settings tab of the app.

image13

This configuration will soon be possible from the user interface.

  • Edit /etc/squirro/common.ini on your Squirro cluster and add the following lines:

[dataloader]
confluence_client_id = YOUR_ID
confluence_client_secret = YOUR_SECRET

  • If the [dataloader] header is already present in this file, add the two lines to the existing section. The section header can not appear more than once in the configuration file.

  • Restart the frontend & datasource service to apply the settings:

sudo systemctl restart sqfrontendd
sudo systemctl restart sqdatasourced

Confluence / Jira GPDR Compliance#

Atlassian imposes rules on the handling of user personal data to be compliant with GDPR regulations for apps building on top of Atlassian products:

https://developer.atlassian.com/cloud/confluence/user-privacy-developer-guide/

https://developer.atlassian.com/platform/marketplace/data-privacy-guidelines/

Squirro’s 1-Click Connector does not store any personal data of any Atlassian user. It uses OAuth for Authorization. The process does not disclose any personal information, neither does Squirro store user personal data generated / stored in an Atlassian product in Squirro.

Every Squirro user has a unique Squirro ID. For Squirro users Squirro’s Terms & Conditions and Privacy Policy apply: https://squirro.com/general-terms-conditions/