Confluence Connector

Overview

The Confluence Connector allows you to connect to your Confluence instance and extract data from specific spaces or pages. By entering a few essential details, you can access and retrieve the content you need from your Confluence environment. Whether you're looking to gather comprehensive information from specific spaces or individual pages, the Confluence Connector ensures you have all the details you need in a structured and organized format. Perfect for users who need quick and easy access to Confluence content, facilitating efficient documentation management and collaboration using our products ACE Search and Chat.

Table of Contents

• Confluence Connector
  • Overview
  • Table of Contents
  • Required Inputs
    • 1. Wiki URL
    • 2. Username
    • 3. API Token
    • 4. Fetch Type
  • Generating an API Token
  • Connector Configuration
    • Basic Setup
    • Advanced Options
      • Space Selection
      • Page Selection
  • Supported Content Types
  • Setting Up Scheduled Updates
  • Best Practices
  • Troubleshooting
  • FAQ
  • How to Use the Confluence Connector

Required Inputs

To use the Confluence Connector, you need to provide the following information:

1. Wiki URL

Description: The Wiki URL is the address of your Confluence instance. This URL points to the root of your Confluence site where all spaces and pages are hosted.

Where to Find: You can find this in the address bar of your web browser when you log in to Confluence. It usually looks something like https://yourcompany.atlassian.net/wiki or https://wiki.yourcompany.com.

2. Username

Description: The Username is your Confluence account name that you use to log in. This is required for authentication when connecting to Confluence.

Where to Find: Your Username is the email address or the account name associated with your Confluence profile. You can find it in your Confluence account settings or by checking the account you use to log in.

3. API Token

Description: The API Token is a secure key used to authenticate your connection to Confluence. It acts as a password specifically for API access, allowing the connector to retrieve data on your behalf.

Where to Find: You can generate an API Token from your Atlassian account under the API token management section. Visit https://id.atlassian.com/manage/api-tokens to create and manage your API tokens.

4. Fetch Type

Description: The Fetch Type determines what kind of content the Confluence Connector will retrieve. This input is a dropdown with two options:

• Spaces: Fetch all spaces within the Confluence site.
• Pages: Fetch specific pages within a space.

How to Use:

• Select Spaces if you want to retrieve a list of all Confluence spaces.
• Select Pages if you want to retrieve content from specific pages within a space.

Generating an API Token

To create an API token for use with the Confluence Connector:

1. Log in to your Atlassian account at https://id.atlassian.com/
2. Navigate to Security tab
3. In the API tokens section, click Create API token
4. Provide a descriptive label for your token (e.g., "Confluence Connector")
5. Click Create
6. Copy the generated token immediately (you won't be able to see it again)

Connector Configuration

Basic Setup

1. Navigate to the Knowledge Management section
2. Select "Add Knowledge"
3. Choose "Confluence" from the list of connectors
4. Enter your Wiki URL, Username, and API Token
5. Select the appropriate Fetch Type (Spaces or Pages)
6. Provide a descriptive name for this knowledge source
7. Set permissions for user access
8. Click "Save" to complete the setup

Advanced Options

Space Selection

If you chose "Spaces" as your Fetch Type, you can further refine which spaces to include:

• All Spaces: Retrieve content from all accessible spaces
• Specific Spaces: Select particular spaces by name or key
• Space Types: Choose to include only personal spaces, team spaces, or both

Page Selection

If you chose "Pages" as your Fetch Type, you'll need to specify:

• Space Key: The unique identifier for the Confluence space
• Page ID (optional): Specific page ID to retrieve
• Recursive (toggle): Whether to include child pages

Supported Content Types

The Confluence Connector can extract:

• Page Content: Text, tables, lists, and formatting
• Attachments: Referenced documents and files (with appropriate permissions)
• Comments: Discussions on pages
• Page Properties: Metadata, labels, and creation information
• Space Information: Space descriptions and settings

Setting Up Scheduled Updates

To keep your Confluence data current:

1. Enable the "Recurring" option in settings
2. Select update frequency:
   • Hourly: For frequently changing documentation
   • Daily: For regular working documentation
   • Weekly: For more stable reference materials
3. Specify the interval (e.g., every 12 hours, every 3 days)

Best Practices

• Start Small: Begin with specific pages or small spaces rather than your entire Confluence instance
• Use Clear Knowledge Names: Name your connections descriptively to easily identify content sources
• Regular Updates: Schedule appropriate update intervals based on how frequently your Confluence content changes
• Permission Management: Ensure the API token has appropriate access to all required spaces
• Content Organization: Use Knowledge Sets to group related Confluence content

Troubleshooting

Issue	Solution
Authentication failure	Verify your username and API token are correct
No spaces/pages found	Check that your user account has access to the requested content
Connection timeout	Ensure your Confluence instance is accessible and not experiencing downtime
Incomplete content	Verify that all necessary permissions are granted to your user account
Rate limiting	Reduce the frequency of updates or contact your Confluence administrator

FAQ

Q: Can I connect to multiple Confluence instances?
A: Yes, create separate connector configurations for each Confluence instance.

Q: Does the connector retrieve page history?
A: No, only the current version of each page is retrieved.

Q: Can I extract content from restricted spaces?
A: You can only extract content from spaces that your user account has permission to access.

Q: How are Confluence macros handled?
A: Most standard macros are processed and their content is extracted. Complex or custom macros may have limited support.

Q: Is there a limit to how many pages can be processed?
A: While there's no hard limit, performance may be impacted with very large spaces (thousands of pages).

How to Use the Confluence Connector

1. Enter the Required Inputs: Input the Wiki URL, Username, API Token, and select the appropriate Fetch Type from the dropdown menu.
2. Connect to Confluence: After entering the necessary information, the connector will establish a connection to your Confluence instance.
3. Extract Data: Based on the selected Fetch Type, the connector will either retrieve a list of spaces or extract content from specific pages, depending on your selection.
4. Access Content: Once extraction is complete, the content will be available through ACE Search and Chat interfaces.