FileNet

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 Let’s Go account, at https://platform.unstructured.io. To sign up for a Business account instead, contact Unstructured Sales, or learn more.
• If you already have an Unstructured Let’s Go, Pay-As-You-Go, or Business SaaS account and are not already signed in, sign in to your account at https://platform.unstructured.io. For other types of Business accounts, see your Unstructured account administrator for sign-in instructions, or email Unstructured Support at [e-mail].

After you sign in, the Unstructured user interface (UI) appears, which you use to get your Unstructured API key, as follows:

1. After you sign in to your Unstructured Let’s Go, Pay-As-You-Go, or Business account, click API Keys on the sidebar.
   

   For a Business account, before you click API Keys, make sure you have selected the organizational workspace you want to create an API key for. Each API key works with one and only one organizational workspace. Learn more.

2. Click Generate API Key.
   

3. Follow the on-screen instructions to finish generating the key.
   

4. Click the Copy icon next to your new key to add the key to your system’s clipboard. If you lose this key, simply return and click the Copy icon again.
   

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 the notebook Dropbox-To-Pinecone Connector API Quickstart for Unstructured, 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, email Unstructured Support at [e-mail].

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

Ingest your files into Unstructured from IBM FileNet.

The requirements are as follows.

• An IBM Cloud Pak for Business Automation as a Service account with access to the IBM FileNet Content Platform Engine server object store to which you want to connect. IBM FileNet is a component of IBM Cloud Pak for Business Automation as a Service.

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.

To create an IBM FileNet source connector, see the following examples.

Python SDK

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)

Replace the preceding placeholders as follows:

• <name> (required) - A unique name for this connector.
• <server-url> (required) - The base URL of your IBM FileNet server, containing both the IBM domain and your company’s subdomain. For example, https://<company-name>.automationcloud.ibm.com.
• <object-store> - (required) - The name of the object store to connect within the content platform engine.
• <folder-path> (required) - The path of the folder to connect to within the object store.
• <document_class> The class of documents to include.
• <recursive> Set to true to include documents contained in any subfolders.
• <username> - (required) - The username of the IBM Cloud Pak for Business Automation as a Service account to use.
• <password> (required) - The password for the corresponding username.

Learn more

•   Couchbase Integration in Unstructured Platform