If you’re new to Unstructured, read this note first.

Before you can create a source connector, you must first sign up for Unstructured and get your Unstructured API key. After you sign up, the Unstructured user interface (UI) appears, which you use to get the key. To learn how, watch this 40-second how-to video.

After you create the source connector, add it along with a destination connector to a workflow. Then run the worklow as a job. To learn how, try out the hands-on Workflow Endpoint quickstart, go directly to the quickstart notebook, or watch the two 4-minute video tutorials for the Unstructured Python SDK.

You can also create source connectors with the Unstructured user interface (UI). Learn how.

If you need help, reach out to the community on Slack, or contact us directly.

You are now ready to start creating a source connector! Keep reading to learn how.

Ingest your files into Unstructured from Confluence.

The requirements are as follows.

The following video provides related setup information for Confluence Cloud:

​
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 the permissions_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.

[
    {
        "...": "...",
        "metadata": {
            "...": "...",
            "data_source": {
                "...": "...",
                "permissions_data": [
                    {
                        "read": {
                            "users": [
                                "11111:11111111-1111-1111-1111-111111111111"
                            ],
                            "groups": [
                                "22222222-2222-2222-2222-22222222",
                                "33333333-3333-3333-3333-33333333"
                            ]
                        }
                    },
                    {
                        "update": {
                            "users": [
                                "44444:44444444-4444-4444-4444-44444444",
                                "55555:55555555-5555-5555-5555-55555555"
                            ],
                            "groups": [
                                "66666666-6666-6666-6666-66666666",
                            ]
                        }
                    },
                    {
                        "delete": {
                            "users": [
                                "77777:77777777-7777-7777-7777-77777777"
                            ],
                            "groups": [
                                "88888888-8888-8888-8888-88888888"
                            ]
                        }
                    }
                ],
                "...": "..."
            }
        }
    }
]

To look up information about a particular Confluence user, use the user’s ID (also known as their account ID) from the preceding output to call the GET /wiki/rest/api/user operation in the Confluence REST API.

To look up information about a particular Confluence group, use the group’s ID from the preceding output to call the GET /wiki/rest/api/group/by-id operation in the Confluence REST API.

To create a Confluence source connector, see the following examples.

import os

from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import CreateSourceRequest
from unstructured_client.models.shared import (
    CreateSourceConnector,
    SourceConnectorType,
    ConfuenceSourceConnectorConfigInput
)

with UnstructuredClient(api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")) as client:
    response = client.sources.create_source(
        request=CreateSourceRequest(
            create_source_connector=CreateSourceConnector(
                name="<name>",
                type=SourceConnectorType.CONFLUENCE,
                config=ConfluenceSourceConnectorConfigInput(
                    url="<url>",
                    max_num_of_spaces=<max-num-of-spaces>,
                    max_num_of_docs_from_each_space=<max-num-of-docs-from-each-space>,
                    spaces=["<space-name>", "<space-name>"],
                    extract_images=<True|False>,
                    extract_files=<True|False>,

                    # For API token authentication:

                    username="<username>",
                    token="<api-token>",
                    cloud=<True|False>

                    # For personal access token (PAT) authentication:

                    token="<personal-access-token>",
                    cloud=False

                    # For password authentication:

                    username="<username>",
                    password="<password>",
                    cloud=<True|False>     
                )
            )
        )
    )

    print(response.source_connector_information)

Replace the preceding placeholders as follows:

  • <name> (required) - A unique name for this connector.
  • <url> (required) - The URL to the target Confluence Cloud instance.
  • <max-num-of-spaces> - The maximum number of Confluence spaces to access within the Confluence Cloud instance. The default is 500 unless otherwise specified.
  • <max-num-of-docs-from-each-space> - The maximum number of documents to access within each space. The default is 150 unless otherwise specified.
  • spaces is an array of strings, with each <space-name> specifying the name of a space to access, for example: ["luke","paul"]. By default, if no space names are specified, and the <max-num-of-spaces> is exceeded for the instance, be aware that you might get unexpected results.
  • extract_images - Set to true to download images and replace the HTML content with Base64-encoded images. The default is false if not otherwise specified.
  • extract_files - Set to true to download any embedded files in pages. The default is false if not otherwise specified.

For API token authentication:

  • <username> - The name or email address of the target user.
  • <api-token> - The user’s API token value.
  • For cloud, true if you are using Confluence Cloud. The default is false if not otherwise specified.

For personal access token (PAT) authentication:

  • <personal-access-token> - The target user’s PAT value.
  • cloud should always be false.

For password authentication:

  • <username> - The name or email address of the target user.
  • <password> - The user’s password.
  • For cloud, true if you are using Confluence Cloud. The default is false if not otherwise specified.

Was this page helpful?

Suggest edits