Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.unstructured.io/llms.txt

Use this file to discover all available pages before exploring further.

First time creating a connector? Read this first.

​
Requirements

You will need: To access the information you’ll need to configure the connector:
  1. Log into your account.
  2. Choose the Navigator tile. The IBM Navigator launches in a separate browser window, and provides a view of your object stores and content. You can use the IBM Navigator views to find the information necessary to create a connection to Unstructured. For the URL of your IBM FileNet server:
    • The server URL displays in the browser address bar. You only need the base URL that specifies the company and domain. For example, https://<company-name>.automationcloud.ibm.com.
    For object store names and folder paths:
    • Select the folder in the left pane. The full folder path is displayed at the top of the main detail pane, in the following format: <object-store>/<folder>/etc.
    For the document class:
    • Right-click the document and select Properties.
    For the account username:
    • Right-click the profile icon on the upper right in the top menu.

​
Examples

To create an IBM FileNet source connector, see the following examples. For more information on working with source connectors using the Unstructured API, see Source endpoints. 
import os

from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import CreateSourceRequest
from unstructured_client.models.shared import CreateSourceConnector

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="filenet",
                config={
                    "server_url": "<server-url>",
                    "object_store": "<object-store>",
                    "folder_path": "<folder-path>",
                    "document_class": "<document-class>",
                    "recursive": <true|false>,
                    "username": "<username>",
                    "password": "<password>"
                }
            )
        )
    )

    print(response.source_connector_information)

​
Configuration settings

Replace the preceding placeholders as follows:
​
name
string
required
A unique name for this connector.
​
server_url
string
required
The base URL of your Content Platform Engine, containing both the IBM domain and your company’s subdomain. For example, https://<company-name>.automationcloud.ibm.com.
​
object_store
string
required
The name of the object store to connect within the Content Platform Engine.
​
folder_path
string
required
Source connector only. The path of the folder within the object store to use as the source.
​
target_folder
string
required
Destination connector only. The path of the folder within the object store to use as the upload destination.
​
document_class
string
default:"Document"
The class of documents to include.
​
recursive
boolean
default:"false"
Source connector only. Set to true to include documents contained in any subfolders.
​
username
string
required
The username of the IBM Cloud Pak for Business Automation as a Service account to use.
​
password
string
required
The password for the corresponding username.