Confluence Connector Prerequisites

Note: Before you begin the Confluence connector deployment, make sure a Confluence Administrator can participate in the deployment process to assign Confluence-specific tasks.

Cloud

User Accounts and Application Permissions

Required Permission Description
Confluence Account
  • A crawling account must be setup in Confluence. 
    • This account must have READ access to all content to be crawled.
    • If you want to crawl content with security, the crawling account must be an Administrator account to have access to user and group information and permissions on spaces and pages.

 

Network and Connectivity

Port Comment
HTTP/https The Confluence site must be accessible via HTTP/https from the server where the connector is deployed

 

Connector Features and Requirements

Features Supported Additional Information
Confluence Support Cloud

The Confluence Cloud connector requires Confluence cloud.

Searchable content types Yes All content types.
Content Update Full and Incremental All BA Insight Connectors support both Full and Incremental crawls, unless noted.
Permission Types Yes
Required Software

BA Insight Advanced Security Module

.NET Framework v4.7.2

The Confluence Connector requires the BA Insight Advanced Security Module to honor the full security model defined in Confluence.


 

Data Center

User Accounts and Application Permissions

Required Permission Description
Confluence Account
  • A crawling account must be setup in Confluence. 
    • This account must have READ access to all content to be crawled.
    • If you want to crawl content with security, the crawling account must be an Administrator account to have access to user and group information and permissions on spaces and pages.
Database Account
  • For SQL Server or PostgreSQL: A database user account  with READ access to all the tables of the Confluence database.

 

Network and Connectivity

Port Comment
HTTP/https The Confluence site must be accessible via HTTP/HTTPS from the server where the connector is deployed
Database Access

The SQL Server and PostgreSQL modes require direct access to the database servers:

  • SQL Server: Default port is 1433
  • PostgreSQL: Default port is 5432

 

Connector Features and Requirements

Features Supported Additional Information
Confluence Data Center Support v8.8.0 and later

The Confluence connector can be configured to run in two different modes:

  • REST API + SQL Server mode
    • This mode is based on the REST API and SQL Server database.
    • Beside the REST API, the Confluence connector accesses the Confluence database directly in order to enumerate the content to crawl.
  • REST API + PostgreSQL mode
    • This mode is based on the REST API and PostgreSQL database.
    • This mode works in the same way as the previous mode, but must be used when you configure Confluence servers to use PostgreSQL as the backend database.
Searchable content types Yes All content types.
Content Update Full and Incremental All BA Insight Connectors support both Full and Incremental crawls, unless noted.
Permission Types Yes
  • All BA Insight Connectors support fetch ACLs from the source system.

  • To make items public or restricted to a single user/set of users, use Connector Framework.

Required Software
  • BA Insight Advanced Security Module

  • .NET Framework v4.7.2

The Confluence Connector requires the BA Insight Advanced Security Module to honor the full security model defined in Confluence.