How to Deploy Your Confluence Connector

Confluence On-Premise Connector

When the Web service URL is specified, click Connect or Refresh Web Service in order to access a drop-down list of actions that the selected connector mode can use.

Specify your settings based on the mode that you chose in the Confluence Connector Prerequisites section.

Confluence Connection Settings for REST API Mode

• Password: Certificate password, as specified in the Generate the Authorization Token topic.
• Confluence URL: Use this URL in Web browsers to reach the Confluence UI.
• Return labels as metadata: If this option is enabled, labels are returned in a custom metadata property. Use this setting only if required due to performance impact. This impact is because an extra API call is required.
• Return all items as public: This setting skips the permission check for the crawled items in the search index. For this reason, all of the users have access to all of the items.
• Access Token: This token is required for authentication, and is generated in the last step of the Generate the Authorization Token section.
• Crawl content as anonymous: If this option is set, then no access token is required. However, only public content is crawled.
• Process body.storage as document: If enabled, the connector uses the storage representation of the page at indexing time instead of the exported view. You gain performance (especially if external content is included via plug-ins), but the page content may not match what users see via browsers.
• Time zone: Set the time zone to the same zone that is configured in the Confluence Server.

Connection Settings for the SQL or PostgreSQL Server Modes

• Password: If integrated security is used in the connection string, type only the certificate password only. (As specified using the Generate the Authorization Token section.) Otherwise, type the certificate and SQL connection passwords separated by a pipe (|) character.
• Confluence URL: This is the URL that can be used in Web browsers to reach the Confluence UI.
• Return labels as metadata: If this option is enabled, the labels are returned in a custom metadata property. Use this setting only if required due to performance impact. This impact is because an extra API call is required.
• Return all items as public: This setting skips the permission checks for the crawled items in the search index. For this reason, all users have access to all of the items.
• Access Token: This token is needed for authentication, and is generated in the last step of the Generate the Authorization Token section.
• Database Server Connection string: Specify here the standard ADO.Net connection string to access the database. Do not specify the password directly in the connection string; instead use the Password field described above.
• Crawl content as anonymous: If this option is set, then no access token is required. However, only public content is crawled.
• Process body.storage as document: If enabled, the connector will use the storage representation of the page at indexing time instead of the exported view. You gain performance (especially if external content is included via plug-ins) but the page content may not match what users see via web browsers.
• Time zone: Set the same time zone to the same zone that is configured in the Confluence server.

Content Configuration Specifics

Custom filters support two types of filtering:

• How to filter crawls to specific spaces: Type space keys without quotation marks (“”) separated by commas (,):
     Spacekey1, Spacekey2, Spacekey3

• How to filter specific pages: Type page titles in double quotes (“”):
     “My First Page”, “My Second Page”

Configure SharePoint for the Confluence Connector

Confluence generates URLs that are incompatible with SharePoint crawling operations.

For this reason, BA Insight recommends setting the item URL in the Connector Framework Content > Content Definition tab > Item URL to use the DocLoader facility that is provided by the Connector Framework.

If you want to expose the original Confluence URLs to your search users, follow these steps:

1. Create an additional managed property, using the Connector Framework to capture the SPW_URL value, which contains the Confluence URL.
2. Update the display templates in the search results to show the Confluence URL to your users.

For information about how to configure the DocLoader URL, see Connector Framework help on the Upland Right Answers Portal.

Confluence Cloud Connector

When the Web service URL is specified, click Connect or Refresh Web Service in order to access a drop-down list of actions that the selected connector mode can use.

Specify your settings based on the mode that you chose in the Confluence Connectors Prerequisites section.

Content Configuration Specifics

Custom filters support two types of filtering:

• How to filter crawls to specific spaces: Type space keys without quotation marks (“”) separated by commas (,):
     Spacekey1, Spacekey2, Spacekey3

• How to filter specific pages: Type page titles in double quotes (“”):
     “My First Page”, “My Second Page”

How to Configure SharePoint for the Confluence Cloud Connector

• Confluence generates URLs that are incompatible with SharePoint crawling operations.

• For this reason, BA Insight recommends setting the item URL in the Connector Framework Content > Content Definition tab > Item URL to use the DocLoader facility that is provided by the Connector Framework.

If you want to expose the original Confluence URLs to your search users, follow these steps:

1. Create an additional managed property, using the Connector Framework to capture the SPW_URL value, which contains the Confluence URL.
2. Update the display templates in the search results to show the Confluence URL to your users.