How to Set Up and Configure the Confluence Cloud Connector

After running the MSI installation wizard, complete your installation using the manual steps for your type of Confluence connector below.

Selecting Appropriate Sub-Connector

While the connection is created, a sub-connector must be selected. If Confluence is running in Atlassian cloud, then there is one option only. Sub-connector must be selected using the following considerations otherwise:

• Connector can use the REST API only to get content from Confluence, but it has some limitations. (See earlier chapters.) To avoid those limitations, direct database access configuration is needed according to the database type used by Confluence.
• Confluence Server below version 7.17 supports both OAuth and Basic authentication. Version 7.18 and above however can be used by basic authentication only.

Configuring Confluence Connector for the On-Premise version of Confluence with OAuth

Install and Deploy the Confluence Add-On

The Confluence connector uses a Confluence add-on to help gather the data that is necessary for crawling. This add-on is provided by BA Insight as part of the installation package.

1. Log in to Confluence as a System Administrator.
   
2. Click the gear icon and select Add-ons
3. Click the Upload Add-on button.
   
   
4. Upload the BAInsightAddIn.jar file that is provided with the Confluence Connector zip file. This file is deployed by the installer to the Addin subfolder of installation target location.
   
5. Click Logging and Profiling from the left side menu.
   
6. Class/Package Name: Type BAInsightConnector in this field.
   
7. Add entry: Click the Add entry button.

Note: Note: Steps 5 through 7 are required because the add-on writes messages to the Confluence log file.

Generate the Authorization Token

To create an authorization token that enables the Confluence Connector to access Confluence while crawling, follow these steps:

1. On the server where the Connector is installed, navigate to:
      http://<host>:<port number>/OAuth.aspx
   • <host>: This is the FQDN, Host name, or IP of the server where the Connector is installed
   • <port number>: This is the port number that you selected during the Connector installation (by default, 2401)
     
2. Follow the instructions in the configuration page opened in previous step.
   
3. Read the notes carefully, because the Confluence user interface is not straightforward.
   Note the password because you need it at a later time.
   
4. Click Next.
   

5. Follow the on-screen prompts to log in using the credentials of the crawling user account (see Confluence Connector Prerequisites).
   

6. When the authorization process is complete, an access token is displayed on the screen.
   
   1. Copy and save this token. It is used later in the topic "Create and Register the Application Link in Confluence," step 12, below.
      
      

Create and Register the Application Link in Confluence

1. From within Confluence, click the "sprocket" icon in the top left corner and select the General configuration page:
   
   
2. Select Application Links from the left-side navigation under ADMINISTRATION.
   
   
3. Name your application link and click the "Create new link" button.
   
   
4. The Configure Application URL page appears, as shown below. Ignore any displayed errors.
   
5. Note the URL shown in the field New URL. Click Continue and follow the instructions below:
   
   
   
6. Click Continue on the dialog box. You see a form like the one shown here:
   
   
7. Enter an Application Name that Confluence administrators will recognize as the connector application link. This can be the same name as your Application link, entered above.
   Do not enter values in the other fields.
   
8. Set Application Type as "Generic Application."
   
9. Check the box labeled Create Incoming Link at the bottom of the form.
   
10. Click Continue.
    
11. The “Link applications” page appears.
    
12. Provide the following (required) values:
    
    • ConsumerKey: Always set it to ConfluenceConnector
    • Consumer Name: Always set it to Confluence Connector
    • Public Key: Copy the key generated in the Generate the Authorization Token step and enter it in this field.
      
      
      
13. Click Continue.
    
14. The Application link is now created.
    
    
15. Continue with the instructions provided in Confluence, which includes entering your Confluence base URL, including port.
    
    • Ensure you are using the correct protocol in your URL:
      • http or https
        
        
16. Click Next.
    
17. Read the instructions that appear and click the URL link shown on the screen.
    LEAVE THIS TAB OPEN. Do not click Finish.
    
    
18. Click Allow in the tab that opens.
    
    
19. An Access Approved tab opens.
    
    
20. Close the browser window.
    
21. Go back to the Confluence connector tab and click the Finish button.
    
    
22. The Authorization succeeds and the Access token appears on screen.
    
    
23. Open ConnectivityHub in a local browser. If you are using the server ConnectivityHub is installed on, the address is https://localhost:port. (55001 is the default local port).
    
24. Navigate to the Connections page.
    
25. Edit your Confluence connector.
    
    1. If you do not have a Confluence connector, create one by a creating a new Web Service connection.
    2. Read and enter values (or enter checkmark) into all available fields:
       
       
26. Select the Security tab.
    
27. In the Content owner field, enter your domain\username.
    
    
28. Select the Security: Directory tab.
    
29. Enter your fully qualified domain name in the Default domain field.
    
    
30. Click the Save button at the top of the page.
    
31. Navigate to Content Sources.
    
32. Select New>Web service content using the drop-down menu.
    
33. The Wizard appears.
    
34. Follow the wizard to configure your Connection and Target.

Configuring Confluence Connector for the On-Premise version of Confluence with Basic Authentication

1. Open Connectivity Hub in a local browser.
   1. If you are using the server Connectivity Hub is installed on, the address is https://localhost:port. (55001 is the default local port).
      
2. Navigate to the Connections page.
   
3. Edit your Confluence connector.
   
   1. If you do not have a Confluence connector, create one by a creating a new Web Service connection.
   2. Read and enter values (or check mark) into all available fields:
      
      
      
4. Select the Security tab.
   
5. In the Content owner field, enter your domain\username.
   
   
6. Select the Security: Directory tab.
   
7. Enter your fully qualified domain name in the Default domain field.
   
   
8. Click the Save button at the top of the page.
   
9. Navigate to Content Sources.
   
10. Select New>Web service content using the drop-down menu.
    
11. The Wizard appears.
    
12. Follow the wizard to configure your Connection and Target.

Configuring Confluence Connector for Confluence in Atlassian Cloud

Create an API token

The connector needs an API token to authenticate to the Atlassian cloud.

A Token can be generated using the following steps:

1. Log in to https://id.atlassian.com/manage/api-tokens as an administrator.
   
2. Click Create API token.
   
3. From the dialog that appears, enter a memorable and concise label for your token and clickCreate.
   
4. Click Copy to clipboard, then save it somewhere. It is needed later in connection settings.

Create an Admin API key

The connector is based on REST API, which doesn't return user email addresses for privacy reasons.

The API returns the names of users only, which is not suitable for user mapping.

• An optional but recommended feature of the connector is to use the Atlassian Admin API
• This requires the following authentication steps:

1. From your organization at admin.atlassian.com, selectSettings > API keys.
   
2. Click Create API key in the top right corner.
   
3. Enter a name that you’ll remember to identify the API key.
   
4. By default, the key expires one week from today.
   1. To change the expiration date, pick a new date under "Expires on."
   2. You cannot select a date longer than a year from the date of creation.
      
5. Click "Create" to save the API key.
   
6. Copy the generated key. You need it later on when creating your connection settings.

Create Connection

1. Open ConnectivityHub in a local browser. If you are using the server ConnectivityHub is installed on, the address is https://localhost:port. (55001 is the default local port).
   
2. Navigate to the Connectionspage.
   
3. Edit your connection settings.
   
   1. If you do not have a Confluence connection, create a connection by a creating a new Web Service connection.
   2. Enter values (or check) into all available fields.
      1. User name: 
         1. Login name of the administrator who generated the API token.
      2. Password:
         1. API token or API token and admin key based to the checkbox at the end.
         2. Token and key can be generated as described in previous sections.
      3. Confluence URL:
         1. Use this URL in Web browsers to reach the Confluence UI.
               
            
            
4. Click the Save button at the top of the page.
   
5. Navigate to Content Sources.
   
6. Select New>Web service content using the drop-down menu.
   
7. The Wizard appears.
   
8. Follow the wizard to configure your Connection and Target.