ELITEA Toolkit Guide: Confluence Integration

Introduction

Purpose of this Guide

This guide is your definitive resource for integrating and effectively utilizing the Confluence toolkit within ELITEA. It provides a detailed, step-by-step walkthrough, from setting up your Confluence API token to configuring the toolkit in ELITEA and seamlessly incorporating it into your Agents. By following this guide, you will unlock the power of automated knowledge management, streamlined collaboration workflows, and enhanced information access, all directly within the ELITEA platform. This integration empowers you to leverage AI-driven automation to optimize your Confluence-driven workflows, enhance team productivity, and improve knowledge sharing within your organization.

Brief Overview of Confluence

Confluence, by Atlassian, is a leading team collaboration and knowledge management platform widely used by organizations to create, organize, and share information. It serves as a central hub for teams to collaborate on projects, document knowledge, and build a comprehensive knowledge base. Confluence offers a wide array of functionalities, including:

Integrating Confluence with ELITEA brings these powerful collaboration and knowledge management capabilities directly into your AI-driven workflows. Your ELITEA Agents can then intelligently interact with your Confluence spaces and pages to automate knowledge-related tasks, enhance collaboration processes, and improve information accessibility through AI-powered automation.

Toolkit's Account Setup and Configuration in Confluence

Account Setup

If you do not yet have a Confluence account, please follow these steps to create one:

  1. Visit Atlassian Website: Open your web browser and navigate to the official Atlassian website.
  2. Sign Up for Confluence: Click on the "Try Confluence free" or "Get it free" button to start the sign-up process.
  3. Create an Atlassian Account: Follow the prompts to create an Atlassian account. You can sign up using your email address, Google account, or Apple account. For professional use, it's recommended to use your company email address.
  4. Choose a Workspace Name: During the signup process, you will be asked to choose a workspace name for your Confluence site. Enter a suitable name for your workspace.
  5. Set Up Your Workspace: Follow the remaining onboarding steps to set up your Confluence workspace, including defining its purpose and inviting team members if needed.
  6. Explore Confluence Features: Once your workspace is set up, explore the onboarding tips and familiarize yourself with Confluence features, spaces, pages, and navigation.

Confluence-Workspace_Creation

Token/API Key Generation: Creating an API Token in Confluence

For secure integration with ELITEA, it is essential to use a Confluence API token for authentication. This method is more secure than using your primary Confluence account password directly and allows you to control access permissions.

Follow these steps to generate an API token in Confluence:

  1. Log in to Confluence: Access your Confluence workspace by navigating to your Confluence URL (e.g., your-workspace.atlassian.net/wiki) and logging in with your credentials.
  2. Access Account Settings: Click on your profile avatar in the top right corner of the Confluence interface. From the dropdown menu, select "Manage account".

Confluence-Settings

  1. Navigate to Security Settings: In the Atlassian account settings page, navigate to the "Security" section in the left-hand sidebar.

Confluence-Security_tab

  1. Access API Tokens: Within the "Security" settings, locate the "API tokens" section and click on "Create and manage API tokens".
  2. Create API Token: On the "API tokens" page, click the "Create API token" button.

Confluence-API_Token_Creation

  1. Name Your Token: In the "Create API token" dialog, enter a descriptive Label for your token, such as "ELITEA Integration Token" or "ELITEA Agent Access." This label will help you identify the purpose of this token later. You can also set an optional expiration date if needed.
  2. Create Token: Click the "Create" button to generate the API token.
  3. Securely Copy and Store Your API Token: Immediately copy the generated API token that is displayed in the pop-up window. This is the only time you will see the full token value. Store it securely in a password manager or, preferably, ELITEA's built-in Secrets feature for enhanced security within ELITEA. You will need this API token to configure the Confluence toolkit in ELITEA.

Confluence-Copy_Token

Confluence-Created_Token

System Integration with ELITEA

Agent Creation/Configuration

To integrate Confluence functionalities into your workflows, you will need to configure the Confluence toolkit within an ELITEA Agent. You can either create a new Agent specifically for Confluence interactions or modify an existing Agent to incorporate Confluence tools.

  1. Navigate to Agents Menu: In ELITEA, go to the Agents menu from the main navigation panel.
  2. Create or Edit Agent:
    • Create a New Agent: Click on the "+ Agent" button to create a new Agent. Follow the on-screen prompts to define essential Agent attributes such as Agent name, a descriptive Agent description, the desired Agent type, and initial instructions for the Agent.
    • Edit an Existing Agent: Select the Agent you intend to integrate with Confluence from your list of Agents. Click on the Agent's name to open its configuration settings for editing.
  3. Access Tools Section: Within the Agent configuration interface, scroll down until you locate the "Tools" section. This section is where you will add and configure toolkits, including the Confluence toolkit.

Toolkit Configuration

This section provides detailed instructions on how to configure the Confluence toolkit within your ELITEA Agent.

  1. Add Toolkit: In the "Tools" section of the Agent configuration, click on the "+" icon. This action will display a dropdown list of available toolkits that can be integrated with your Agent.
  2. Select Confluence Toolkit: From the dropdown list of available toolkits, choose "Confluence". Selecting "Confluence" will open the "New Confluence tool" configuration panel, where you will specify the settings for your Confluence integration.
  3. Configure Confluence Toolkit Settings: Carefully fill in the following configuration fields within the "New Confluence tool" section:

    • Name: Enter a descriptive Name for this specific Confluence toolkit instance. Choose a name that is easily recognizable and helps you identify its purpose within your Agent's instructions (e.g., "ProjectConfluence", "KnowledgeBaseAccess", "ConfluenceIntegration").
    • Description: Provide a concise Description for the toolkit. This description should clarify the toolkit's purpose or the specific Confluence space it is intended to access (e.g., "Toolkit for accessing and managing project documentation in Confluence", "Integration for Confluence Space 'Project Documentation'").
    • URL: Enter the base URL of your Confluence instance. Ensure you use the correct format, including https:// or http:// and the full workspace URL (e.g., https://your-workspace.atlassian.net/wiki).
    • Username: Enter the Username associated with your Confluence account for which you generated the API token. This is typically your email address used for Confluence login.
    • Authentication Options - API Key: Select the "API Key" authentication option.
      • Password/Secret: Choose "Password" and paste the API token you generated in Confluence (during the "Software-Specific Setup" section of this guide) into the "Password" field.
      • Enhanced Security with Secrets (Recommended): For enhanced security, it is strongly recommended to use ELITEA's Secrets Management feature to store your Confluence API token securely. Instead of directly pasting the token into the "Password" field, select the "Secret" option and choose the pre-configured secret containing your Confluence API token from the dropdown list. This prevents hardcoding sensitive credentials in your toolkit configuration.
    • Space: Enter the Space name in Confluence that you want to access with this toolkit. This is the Space Key, which is typically found in the URL of your Confluence space (e.g., for URL https://your-workspace.atlassian.net/wiki/spaces/DOCS/overview, the Space Key is DOCS).
    • Hosting Option: Select the appropriate "Hosting option" for your Confluence instance:
      • Cloud: Select "Cloud" if you are using Confluence Cloud (e.g., accessed via atlassian.net).
      • Server: Select "Server" if you are using a self-hosted Confluence Server or Data Center instance. Note: When connecting to an Epam Confluence instance, ensure you select "Server" as the Hosting option.
    • Advanced Settings: Configure additional settings to control data fetching and presentation:
      • Pages limit per request: Set the maximum number of pages to retrieve per request (e.g., 5).
      • Max total pages: Define the maximum number of pages to retrieve in total (e.g., 10).
      • Number of retries: Specify how many times the tool should retry after a failure (e.g., 2).
      • Min retry, sec: Set the minimum number of seconds to wait before retrying (e.g., 10).
      • Max retry, sec: Set the maximum number of seconds to wait before retrying (e.g., 60).

    Confluence-Toolkit_Configuration

  4. Enable Desired Tools: In the "Tools" section within the Confluence toolkit configuration panel, select the checkboxes next to the specific Confluence tools that you want to enable for your Agent. It is crucial to enable only the tools that your Agent will actually need to use to adhere to the principle of least privilege and minimize potential security risks. Available tools include:

    • Get pages with label - Retrieves all pages that have a specific label.
    • List pages with label - Lists all pages that contain a specific label.
    • Search pages - Searches for pages based on keywords or phrases.
    • Create page - Creates a single new page in Confluence.
    • Create pages - Creates multiple pages in Confluence.
    • Get page tree - Retrieves the hierarchical structure of pages.
    • Delete page - Deletes a specific page.
    • Update page by id - Updates the content of a page identified by its ID.
    • Update page by title - Updates the content of a page identified by its title.
    • Update labels - Adds or removes labels from a page.
    • Update pages - Updates multiple pages at once.
    • Site search - Performs a search across the entire Confluence site.
    • Search by title - Searches for pages based on their title.
    • Read page by id - Retrieves the content of a page using its unique ID.
    • Generic request - Allows to send custom HTTP requests to Confluence API.
  5. Complete Setup: After configuring all the necessary settings and enabling the desired tools, click the arrow icon (typically located at the top right of the toolkit configuration section) to finalize the Confluence toolkit setup and return to the main Agent configuration menu.

  6. Click Save in the Agent configuration to save all changes and activate the Confluence toolkit integration for your Agent.

Tool Overview: Confluence Toolkit Functionalities

Once the Confluence toolkit is successfully configured and added to your Agent, you can leverage the following tools within your Agent's instructions to enable intelligent interaction with your Confluence workspace:

Instructions and Prompts for Using the Confluence Toolkit

To effectively utilize the Confluence toolkit within your ELITEA Agents, you need to provide clear and precise instructions within the Agent's "Instructions" field, telling the Agent how and when to use these tools.

General Instruction Structure:

When instructing your Agent to use a Confluence tool, you will typically follow this pattern:

Use the "[tool_name]" tool to [describe the action you want to perform] in Confluence.
Provide the following parameters:
- Parameter 1: <value or description of value>
- Parameter 2: <value or description of value>
- ...

Example Agent Instructions for Confluence Toolkit Tools:

Important Considerations for Agent Instructions:

Best Practices and Use Cases for Confluence Integration

Best Practices for Efficient Integration

Use Cases for Confluence Toolkit Integration

The Confluence toolkit opens up a wide range of automation possibilities for knowledge management, documentation workflows, and information retrieval within ELITEA. Here are some compelling use cases:

Troubleshooting and Support

Troubleshooting Common Issues

FAQs

  1. Q: Can I use my regular Confluence password for the ELITEA integration?
    • A: No, it is strongly recommended to use a Confluence API token instead of your main account password for security reasons. API tokens provide a more secure and controlled way to grant access to external applications like ELITEA.
  2. Q: What permissions should I grant to the Confluence API Token?
    • A: Confluence API tokens have a fixed scope (access to Confluence REST API). You don't need to select specific scopes when generating the token. However, ensure that the Confluence account associated with the API token has the necessary permissions within Confluence to access and modify the spaces and pages your Agent will be interacting with.
  3. Q: What is the correct format for the Confluence URL in the toolkit configuration?
    • A: The Confluence URL should be entered in the full format, including https:// or http:// and the complete workspace URL (e.g., https://your-workspace.atlassian.net/wiki). Ensure there are no typos or missing parts in the URL. For Epam Confluence, use https://kb.epam.com/.
  4. Q: Why is my Agent getting "Permission Denied" errors even though I think I have configured everything correctly?
    • A: Double-check the following:
      • API Token Validity: Ensure that the API token is valid and has not been revoked.
      • Confluence Account Permissions: Verify that the Confluence account associated with the API token has the necessary permissions to access the specific spaces and pages your Agent is trying to interact with.
      • Hosting Option: Double-check that you have selected the correct "Hosting option" (Cloud or Server) in the toolkit configuration, especially for self-hosted or Epam Confluence instances.

Support and Contact Information

If you encounter any issues, have questions, or require further assistance beyond what is covered in this guide regarding the Confluence integration or ELITEA Agents in general, please do not hesitate to contact our dedicated ELITEA Support Team. We are here to help you resolve any problems quickly and efficiently and ensure you have a smooth and productive experience with ELITEA.

How to Reach ELITEA Support:

Best Practices for Effective Support Requests:

To help us understand and resolve your issue as quickly as possible, please ensure you provide the following information in your support email:

Before Contacting Support:

We encourage you to first explore the resources available within this guide and the broader ELITEA documentation. You may find answers to common questions or solutions to known issues in the documentation.

To further enhance your understanding and skills in integrating Confluence with ELITEA, here are some helpful resources: