> ## 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.

# IBM FileNet

> Connect Unstructured to IBM FileNet as a source to ingest documents and content from your FileNet content repository into Unstructured.

<Note>
  First time creating a connector? [Read this first](/api-reference/workflow/connector-first-time-reqs).
</Note>

## Requirements

You will need:

* An [IBM Cloud Pak for Business Automation as a Service](https://www.ibm.com/products/cloud-pak-for-business-automation) account with access to the IBM FileNet [Content Platform Engine server](https://www.ibm.com/docs/en/filenet-p8-platform/5.7.0?topic=architecture-content-platform-engine) 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](https://www.automationcloud.ibm.com/auth/index.jsp).

2. Choose the **Navigator** tile.

   The [IBM Navigator](https://www.ibm.com/docs/en/content-navigator/3.2.0) 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](https://www.ibm.com/docs/en/filenet-p8-platform/5.7.0?topic=infrastructure-defining-object-stores) 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](/api-reference/api/source/source-apis).

<CodeGroup>
  ```python Python SDK theme={null}
  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)
  ```

  ```bash curl theme={null}
  curl --request 'POST' --location \
  "$UNSTRUCTURED_API_URL/sources" \
  --header 'accept: application/json' \
  --header "unstructured-api-key: $UNSTRUCTURED_API_KEY" \
  --header 'content-type: application/json' \
  --data \
  '{
      "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>"
      }
  }'
  ```
</CodeGroup>

## Configuration settings

Replace the preceding placeholders as follows:

<ParamField body="name" type="string" required>
  A unique name for this connector.
</ParamField>

<ParamField body="server_url" type="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`.
</ParamField>

<ParamField body="object_store" type="string" required>
  The name of the object store to connect within the Content Platform Engine.
</ParamField>

<ParamField body="folder_path" type="string" required>
  Source connector only. The path of the folder within the object store to use as the source.
</ParamField>

<ParamField body="target_folder" type="string" required>
  Destination connector only. The path of the folder within the object store to use as the upload destination.
</ParamField>

<ParamField body="document_class" type="string" default="Document">
  The class of documents to include.
</ParamField>

<ParamField body="recursive" type="boolean" default="false">
  Source connector only. Set to `true` to include documents contained in any subfolders.
</ParamField>

<ParamField body="username" type="string" required>
  The username of the IBM Cloud Pak for Business Automation as a Service account to use.
</ParamField>

<ParamField body="password" type="string" required>
  The password for the corresponding username.
</ParamField>