If you’re new to Unstructured, read this note first.Before you can create a source connector, you must first sign in to your Unstructured account:
- If you do not already have an Unstructured account, sign up for free. After you sign up, you are automatically signed in to your new Unstructured Starter account, at https://platform.unstructured.io. To sign up for a Team or Enterprise account instead, contact Unstructured Sales, or learn more.
- If you already have an Unstructured Starter or Team account and are not already signed in, sign in to your account at https://platform.unstructured.io. For an Enterprise account, see your Unstructured account administrator for instructions, or email Unstructured Support at support@unstructured.io.
- A Confluence Cloud account or Confluence Data Center installation.
- The site URL for your Confluence Cloud account or Confluence Data Center installation.
- A user in your Confluence Cloud account or Confluence Data Center installation.
- The user must have the correct permissions in your Conflunce Cloud account or Confluence Data Center installation to access the target spaces and pages.
-
One of the following:
- For Confluence Cloud or Confluence Data Center, the target user’s name or email address, and password. Change a Confluence Cloud user’s password. Change a Confluence Data Center user’s password.
- For Confluence Cloud only, the target user’s name or email address, and API token. Create an API token.
- For Confluence Data Center only, the target user’s personal access token (PAT). Create a PAT.
-
Optionally, the keys (not display names) of the specific spaces in the Confluence instance to access. To get a space’s key,
which is different from a space’s display name, open the space in your web browser and look at the URL. The space’s key is the part of the URL after
spaces/
but before the next/
after that.
Document permissions metadata
The source connector outputs any permissions information that it can find in the source location about the processed source documents and associates that information with each corresponding element that is generated. This permissions information is output into thepermissions_data
field, which is within the
data_source
field under the element’s metadata
field. This information lists the users or groups, if any, that have
permissions to read, update, or delete the element’s associated source document.
The following example shows what the output looks like. Ellipses indicate content that has been omitted from this example for brevity.
- On the sidebar, click Connectors.
- Click Sources.
- Cick New or Create Connector.
- Give the connector some unique Name.
- In the Provider area, click Confluence.
- Click Continue.
- Follow the on-screen instructions to fill in the fields as described later on this page.
- Click Save and Test.
- Name (required): A unique name for this connector.
- URL (required): The target Confluence site’s URL.
- For username and password authentication: for Authentication Method, select Username and Password. Then enter the username into the Username field and the password into the Password field.
- For API token authentication: for Authentication Method, select Username and API Token. Then enter the username into the Username field and the API token into the API Token field.
- For personal access token (PAT) authentication: for Authentication Method, select Personal Access Token. Then enter the PAT into the Personal Access Token field.
- Cloud: Check this box if you are using Confluence Cloud. By default this box is unchecked.
- Max number of spaces: The maximum number of Confluence spaces to access within the Confluence Cloud instance. The default is 500 unless otherwise specified.
- Max number of docs per space: The maximum number of documents to access within each space. The default is 150 unless otherwise specified.
- List of spaces: A comma-separated string that lists the keys (not display names) of all of the spaces to access, for example:
luke,paul
. By default, if no space keys are specified, and the Max Number of Spaces is reached for the instance, be aware that you might get unexpected results. - Extract inline images: Check this box to download images and replace the HTML content with Base64-encoded images. By default, this box is unchecked.
- Extract files: Check this box to download any embedded files in pages. By default, this box is unchecked.