From 04852b94e2348f857e5f2c369584d2fc694f5683 Mon Sep 17 00:00:00 2001 From: Andrew May Date: Thu, 2 Apr 2026 16:18:01 -0700 Subject: [PATCH 1/4] Add topics and snippets for FileNet connectors --- .../workflow/destinations/filenet.mdx | 36 ++++++++++++ api-reference/workflow/sources/filenet.mdx | 35 ++++++++++++ docs.json | 6 ++ .../destination-connectors/filenet.mdx | 25 +++++++++ .../ingestion/source-connectors/filenet.mdx | 24 ++++++++ snippets/dc-shared-text/filenet-cli-api.mdx | 13 +++++ .../destination_connectors/filenet.sh.mdx | 28 ++++++++++ .../destination_connectors/filenet.v2.py.mdx | 56 +++++++++++++++++++ .../filenet_rest_create.mdx | 21 +++++++ .../destination_connectors/filenet_sdk.mdx | 29 ++++++++++ .../filenet-api-placeholders.mdx | 7 +++ .../general-shared-text/filenet-cli-api.mdx | 24 ++++++++ .../general-shared-text/filenet-platform.mdx | 9 +++ snippets/general-shared-text/filenet.mdx | 36 ++++++++++++ snippets/sc-shared-text/filenet-cli-api.mdx | 9 +++ snippets/source_connectors/filenet.sh.mdx | 20 +++++++ snippets/source_connectors/filenet.v2.py.mdx | 53 ++++++++++++++++++ .../source_connectors/filenet_rest_create.mdx | 22 ++++++++ snippets/source_connectors/filenet_sdk.mdx | 29 ++++++++++ ui/destinations/filenet.mdx | 34 +++++++++++ ui/sources/filenet.mdx | 34 +++++++++++ 21 files changed, 550 insertions(+) create mode 100644 api-reference/workflow/destinations/filenet.mdx create mode 100644 api-reference/workflow/sources/filenet.mdx create mode 100644 open-source/ingestion/destination-connectors/filenet.mdx create mode 100644 open-source/ingestion/source-connectors/filenet.mdx create mode 100644 snippets/dc-shared-text/filenet-cli-api.mdx create mode 100644 snippets/destination_connectors/filenet.sh.mdx create mode 100644 snippets/destination_connectors/filenet.v2.py.mdx create mode 100644 snippets/destination_connectors/filenet_rest_create.mdx create mode 100644 snippets/destination_connectors/filenet_sdk.mdx create mode 100644 snippets/general-shared-text/filenet-api-placeholders.mdx create mode 100644 snippets/general-shared-text/filenet-cli-api.mdx create mode 100644 snippets/general-shared-text/filenet-platform.mdx create mode 100644 snippets/general-shared-text/filenet.mdx create mode 100644 snippets/sc-shared-text/filenet-cli-api.mdx create mode 100644 snippets/source_connectors/filenet.sh.mdx create mode 100644 snippets/source_connectors/filenet.v2.py.mdx create mode 100644 snippets/source_connectors/filenet_rest_create.mdx create mode 100644 snippets/source_connectors/filenet_sdk.mdx create mode 100644 ui/destinations/filenet.mdx create mode 100644 ui/sources/filenet.mdx diff --git a/api-reference/workflow/destinations/filenet.mdx b/api-reference/workflow/destinations/filenet.mdx new file mode 100644 index 00000000..91481d95 --- /dev/null +++ b/api-reference/workflow/destinations/filenet.mdx @@ -0,0 +1,36 @@ +--- +title: FileNet +--- + +import FirstTimeAPIDestinationConnector from '/snippets/general-shared-text/first-time-api-destination-connector.mdx'; + + + +Send processed data from Unstructured to IBM FileNet. + +The requirements are as follows. + +import FileNetPrerequisites from '/snippets/general-shared-text/filenet.mdx'; + + + +To create an IBM FileNet destination connector, see the following examples. + +import FileNetSDK from '/snippets/destination_connectors/filenet_sdk.mdx'; +import FileNetAPIRESTCreate from '/snippets/destination_connectors/filenet_rest_create.mdx'; + + + + + + +Replace the preceding placeholders as follows: + +import FileNetAPIPlaceholders from '/snippets/general-shared-text/filenet-api-placeholders.mdx'; + + + +## Learn more + +-   [Couchbase Integration in Unstructured Platform](https://unstructured.io/blog/couchbase-integration-in-unstructured-platform) + diff --git a/api-reference/workflow/sources/filenet.mdx b/api-reference/workflow/sources/filenet.mdx new file mode 100644 index 00000000..993ce6c8 --- /dev/null +++ b/api-reference/workflow/sources/filenet.mdx @@ -0,0 +1,35 @@ +--- +title: FileNet +--- + +import FirstTimeAPISourceConnector from '/snippets/general-shared-text/first-time-api-source-connector.mdx'; + + + +Ingest your files into Unstructured from Couchbase. + +The requirements are as follows. + +import FileNetPrerequisites from '/snippets/general-shared-text/filenet.mdx'; + + + +To create an IBM FileNet source connector, see the following examples. + +import FileNetSDK from '/snippets/source_connectors/filenet_sdk.mdx'; +import FileNetAPIRESTCreate from '/snippets/source_connectors/filenet_rest_create.mdx'; + + + + + + +Replace the preceding placeholders as follows: + +import FileNetAPIPlaceholders from '/snippets/general-shared-text/filenet-api-placeholders.mdx'; + + + +## Learn more + +-   [Couchbase Integration in Unstructured Platform](https://unstructured.io/blog/couchbase-integration-in-unstructured-platform) \ No newline at end of file diff --git a/docs.json b/docs.json index 6f8763a9..7f784ae5 100644 --- a/docs.json +++ b/docs.json @@ -49,6 +49,7 @@ "ui/sources/databricks-volumes", "ui/sources/dropbox", "ui/sources/elasticsearch", + "ui/sources/filenet", "ui/sources/google-cloud", "ui/sources/google-drive", "ui/sources/jira", @@ -80,6 +81,7 @@ "ui/destinations/delta-table", "ui/destinations/databricks-delta-table", "ui/destinations/elasticsearch", + "ui/destinations/filenet", "ui/destinations/google-cloud", "ui/destinations/ibm-watsonxdata", "ui/destinations/kafka", @@ -165,6 +167,7 @@ "api-reference/workflow/sources/databricks-volumes", "api-reference/workflow/sources/dropbox", "api-reference/workflow/sources/elasticsearch", + "api-reference/workflow/sources/filenet", "api-reference/workflow/sources/google-cloud", "api-reference/workflow/sources/google-drive", "api-reference/workflow/sources/jira", @@ -196,6 +199,7 @@ "api-reference/workflow/destinations/delta-table", "api-reference/workflow/destinations/databricks-delta-table", "api-reference/workflow/destinations/elasticsearch", + "api-reference/workflow/destinations/filenet", "api-reference/workflow/destinations/google-cloud", "api-reference/workflow/destinations/ibm-watsonxdata", "api-reference/workflow/destinations/kafka", @@ -433,6 +437,7 @@ "open-source/ingestion/source-connectors/discord", "open-source/ingestion/source-connectors/dropbox", "open-source/ingestion/source-connectors/elastic-search", + "open-source/ingestion/source-connectors/filenet", "open-source/ingestion/source-connectors/github", "open-source/ingestion/source-connectors/gitlab", "open-source/ingestion/source-connectors/google-cloud-storage", @@ -474,6 +479,7 @@ "open-source/ingestion/destination-connectors/dropbox", "open-source/ingestion/destination-connectors/duckdb", "open-source/ingestion/destination-connectors/elasticsearch", + "open-source/ingestion/destination-connectors/filenet", "open-source/ingestion/destination-connectors/google-cloud-service", "open-source/ingestion/destination-connectors/ibm-watsonxdata", "open-source/ingestion/destination-connectors/kafka", diff --git a/open-source/ingestion/destination-connectors/filenet.mdx b/open-source/ingestion/destination-connectors/filenet.mdx new file mode 100644 index 00000000..6def0aad --- /dev/null +++ b/open-source/ingestion/destination-connectors/filenet.mdx @@ -0,0 +1,25 @@ +--- +title: FileNet +--- + +import SharedFileNet from '/snippets/dc-shared-text/filenet-cli-api.mdx'; + + + +Now call the Unstructured Ingest CLI or the Unstructured Ingest Python library. The source connector can be any of the ones supported. This example uses the local source connector. + +This example sends files to Unstructured for processing by default. To process files locally instead, see the instructions at the end of this page. + +import FileNetAPISh from '/snippets/destination_connectors/filenet.sh.mdx'; +import FileNetAPIPyV2 from '/snippets/destination_connectors/filenet.v2.py.mdx'; + + + + + + +To understand how [vector search](https://www.couchbase.com/products/vector-search/) works in Couchbase, refer to this [tutorial](https://developer.couchbase.com/tutorial-python-langchain-pdf-chat) and the [Couchbase docs](https://docs.couchbase.com/cloud/vector-search/vector-search.html) + +import SharedPartitionByAPIOSS from '/snippets/ingest-configuration-shared/partition-by-api-oss.mdx'; + + \ No newline at end of file diff --git a/open-source/ingestion/source-connectors/filenet.mdx b/open-source/ingestion/source-connectors/filenet.mdx new file mode 100644 index 00000000..64a6fc3e --- /dev/null +++ b/open-source/ingestion/source-connectors/filenet.mdx @@ -0,0 +1,24 @@ +--- +title: FileNet +--- + +import SharedFileNet from '/snippets/sc-shared-text/filenet-cli-api.mdx'; + + + +Now call the Unstructured CLI or Python. The destination connector can be any of the ones supported. This example uses the local destination connector: + +This example sends data to Unstructured for processing by default. To process files locally instead, see the instructions at the end of this page. + +import FileNetSh from '/snippets/source_connectors/filenet.sh.mdx'; +import FileNetPyV2 from '/snippets/source_connectors/filenet.v2.py.mdx'; + + + + + + + +import SharedPartitionByAPIOSS from '/snippets/ingest-configuration-shared/partition-by-api-oss.mdx'; + + \ No newline at end of file diff --git a/snippets/dc-shared-text/filenet-cli-api.mdx b/snippets/dc-shared-text/filenet-cli-api.mdx new file mode 100644 index 00000000..a19c15b5 --- /dev/null +++ b/snippets/dc-shared-text/filenet-cli-api.mdx @@ -0,0 +1,13 @@ +FileNet + +[Couchbase](https://couchbase.com) is a Distributed NoSQL Cloud Database. Couchbase embraces AI with coding assistance for developers, and vector search for their applications. + +Batch process all your records to store structured outputs in a Couchbase database. + +The requirements are as follows. + +import FileNetShared from '/snippets/general-shared-text/filenet.mdx'; +import FileNetSharedCLIAPI from '/snippets/general-shared-text/filenet-cli-api.mdx'; + + + \ No newline at end of file diff --git a/snippets/destination_connectors/filenet.sh.mdx b/snippets/destination_connectors/filenet.sh.mdx new file mode 100644 index 00000000..44bd8135 --- /dev/null +++ b/snippets/destination_connectors/filenet.sh.mdx @@ -0,0 +1,28 @@ +```bash CLI +#!/usr/bin/env bash + +# Chunking and embedding are optional. + +unstructured-ingest \ + local \ + --input-path $LOCAL_FILE_INPUT_DIR \ + --output-dir $LOCAL_FILE_OUTPUT_DIR \ + --strategy hi_res \ + --chunk-elements \ + --embedding-provider huggingface \ + --num-processes 2 \ + --verbose \ + --partition-by-api \ + --api-key $UNSTRUCTURED_API_KEY \ + --partition-endpoint $UNSTRUCTURED_API_URL \ + --additional-partition-args="{\"split_pdf_page\":\"true\", \"split_pdf_allow_failed\":\"true\", \"split_pdf_concurrency_level\": 15}" \ + filenet \ + --connection-string $CB_CONN_STR \ + --username $CB_USERNAME \ + --password $CB_PASSWORD \ + --bucket $CB_BUCKET \ + --scope $CB_SCOPE \ + --collection $CB_COLLECTION \ + --num-processes 2 \ + --batch-size 80 +``` \ No newline at end of file diff --git a/snippets/destination_connectors/filenet.v2.py.mdx b/snippets/destination_connectors/filenet.v2.py.mdx new file mode 100644 index 00000000..ebacce1c --- /dev/null +++ b/snippets/destination_connectors/filenet.v2.py.mdx @@ -0,0 +1,56 @@ +```python Python Ingest +import os + +from unstructured_ingest.pipeline.pipeline import Pipeline +from unstructured_ingest.interfaces import ProcessorConfig + +from unstructured_ingest.processes.connectors.filenet import ( + CouchbaseAccessConfig, + CouchbaseConnectionConfig, + CouchbaseUploadStagerConfig, + CouchbaseUploaderConfig +) +from unstructured_ingest.processes.connectors.local import ( + LocalIndexerConfig, + LocalConnectionConfig, + LocalDownloaderConfig +) +from unstructured_ingest.processes.partitioner import PartitionerConfig +from unstructured_ingest.processes.chunker import ChunkerConfig +from unstructured_ingest.processes.embedder import EmbedderConfig + +# Chunking and embedding are optional. + +if __name__ == "__main__": + Pipeline.from_configs( + context=ProcessorConfig(), + indexer_config=LocalIndexerConfig(input_path=os.getenv("LOCAL_FILE_INPUT_DIR")), + downloader_config=LocalDownloaderConfig(), + source_connection_config=LocalConnectionConfig(), + partitioner_config=PartitionerConfig( + partition_by_api=True, + api_key=os.getenv("UNSTRUCTURED_API_KEY"), + partition_endpoint=os.getenv("UNSTRUCTURED_API_URL"), + strategy="hi_res", + additional_partition_args={ + "split_pdf_page": True, + "split_pdf_allow_failed": True, + "split_pdf_concurrency_level": 15 + } + ), + chunker_config=ChunkerConfig(chunking_strategy="by_title"), + embedder_config=EmbedderConfig(embedding_provider="huggingface"), + destination_connection_config=CouchbaseConnectionConfig( + access_config=CouchbaseAccessConfig( + password=os.getenv("CB_PASSWORD"), + ), + connection_string=os.getenv("CB_CONN_STR"), + username=os.getenv("CB_USERNAME"), + bucket=os.getenv("CB_BUCKET"), + scope=os.getenv("CB_SCOPE"), + collection=os.getenv("CB_COLLECTION") + ), + stager_config=CouchbaseUploadStagerConfig(), + uploader_config=CouchbaseUploaderConfig(batch_size=100) + ).run() +``` \ No newline at end of file diff --git a/snippets/destination_connectors/filenet_rest_create.mdx b/snippets/destination_connectors/filenet_rest_create.mdx new file mode 100644 index 00000000..71fb1f9c --- /dev/null +++ b/snippets/destination_connectors/filenet_rest_create.mdx @@ -0,0 +1,21 @@ +```bash curl +curl --request 'POST' --location \ +"$UNSTRUCTURED_API_URL/destinations" \ +--header 'accept: application/json' \ +--header "unstructured-api-key: $UNSTRUCTURED_API_KEY" \ +--header 'content-type: application/json' \ +--data \ +'{ + "name": "", + "type": "filenet", + "config": { + "username": "", + "bucket": "", + "connection_string": "", + "scope": "", + "collection": "", + "password": "", + "batch_size": + } +}' +``` \ No newline at end of file diff --git a/snippets/destination_connectors/filenet_sdk.mdx b/snippets/destination_connectors/filenet_sdk.mdx new file mode 100644 index 00000000..1881f8b9 --- /dev/null +++ b/snippets/destination_connectors/filenet_sdk.mdx @@ -0,0 +1,29 @@ +```python Python SDK +import os + +from unstructured_client import UnstructuredClient +from unstructured_client.models.operations import CreateDestinationRequest +from unstructured_client.models.shared import CreateDestinationConnector + +with UnstructuredClient(api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")) as client: + response = client.destinations.create_destination( + request=CreateDestinationRequest( + create_destination_connector=CreateDestinationConnector( + name="", + type="filenet", + config={ + "username": "", + "bucket": "", + "connection_string": "", + "scope": "", + "collection": "", + "password": "", + "batch_size": + } + ) + ) + ) + + print(response.destination_connector_information) +# ... +``` \ No newline at end of file diff --git a/snippets/general-shared-text/filenet-api-placeholders.mdx b/snippets/general-shared-text/filenet-api-placeholders.mdx new file mode 100644 index 00000000..723f32ef --- /dev/null +++ b/snippets/general-shared-text/filenet-api-placeholders.mdx @@ -0,0 +1,7 @@ +- `` (_required_) - TODO. +- `` TODO. +- `` TODO. +- `` (_required_) - TODO. +- `` - (_required_) - TODO. +- `` - (_required_) - TODO. +- `` (_required_) - The password for the Couchbase server. \ No newline at end of file diff --git a/snippets/general-shared-text/filenet-cli-api.mdx b/snippets/general-shared-text/filenet-cli-api.mdx new file mode 100644 index 00000000..3ce0055f --- /dev/null +++ b/snippets/general-shared-text/filenet-cli-api.mdx @@ -0,0 +1,24 @@ +The FileNet connector dependencies: + +```bash CLI, Python +pip install "unstructured-ingest[couchbase]" +``` + +import AdditionalIngestDependencies from '/snippets/general-shared-text/ingest-dependencies.mdx'; + + + +These environment variables are required for the Couchbase Connector: + +- `CB_CONN_STR` - The Connection String for the Couchbase server, represented by `--connection-string` (CLI) or `connection_string` (Python). +- `CB_USERNAME` - The username for the Couchbase server, represented by `--username` (CLI) or `username` (Python). +- `CB_PASSWORD` - The password for the Couchbase server, represented by `--password` (CLI) or `password` (Python). +- `CB_BUCKET` - The name of the bucket in the Couchbase server, represented by `--bucket` (CLI) or `bucket` (Python). +- `CB_SCOPE` - The name of the scope in the bucket, represented by `--scope` (CLI) or `scope` (Python). +- `CB_COLLECTION` - The name of the collection in the scope, represented by `--collection` (CLI) or `collection` (Python). + +Additional available settings include: + +- `--collection-id` (CLI) or `collection_id` in `CouchbaseDownloaderConfig` (Python) - Optional for the source connector. The + unique key of the ID field in the collection. The default is `id` if not otherwise specified. + [Learn more](https://docs.couchbase.com/server/current/learn/services-and-indexes/indexes/indexing-and-query-perf.html#introduction-document-keys). \ No newline at end of file diff --git a/snippets/general-shared-text/filenet-platform.mdx b/snippets/general-shared-text/filenet-platform.mdx new file mode 100644 index 00000000..b375f88e --- /dev/null +++ b/snippets/general-shared-text/filenet-platform.mdx @@ -0,0 +1,9 @@ +Fill in the following fields: + +- **Folder Path** (_required_): TODO +- **Document Class**: TODO. +- **Recursive**: TODO. +- **Server URL** (_required_): TODO. +- **Object Store** (_required_): TODO. +- **Username** (_required_): The cluster access name (username) that has access to the cluster. +- **Password** (_required_): The password for the corresponding username. \ No newline at end of file diff --git a/snippets/general-shared-text/filenet.mdx b/snippets/general-shared-text/filenet.mdx new file mode 100644 index 00000000..57cbff2c --- /dev/null +++ b/snippets/general-shared-text/filenet.mdx @@ -0,0 +1,36 @@ +FileNet +- For the [Unstructured UI](/ui/overview) or the [Unstructured API](/api-reference/overview), only Couchbase Capella clusters are supported. +- For [Unstructured Ingest](/open-source/ingestion/overview), Couchbase Capella clusters and local Couchbase server deployments are supported. + + + +import AllowIPAddressRanges from '/snippets/general-shared-text/ip-address-ranges.mdx'; + +For Couchbase Capella, you will need: + +- A [Couchbase Capella account](https://docs.couchbase.com/cloud/get-started/create-account.html#sign-up-free-tier). +- A [Couchbase Capella cluster](https://docs.couchbase.com/cloud/get-started/create-account.html#getting-started). +- A [bucket](https://docs.couchbase.com/cloud/clusters/data-service/manage-buckets.html#add-bucket), + [scope](https://docs.couchbase.com/cloud/clusters/data-service/scopes-collections.html#create-scope), + and [collection](https://docs.couchbase.com/cloud/clusters/data-service/scopes-collections.html#create-collection) + on the cluster. +- The cluster's [public connection string](https://docs.couchbase.com/cloud/get-started/connect.html#connect-from-sdk-cbsh-cli-or-ide). +- The [cluster access name (username) and secret (password)](https://docs.couchbase.com/cloud/clusters/manage-database-users.html#create-database-credentials). +- [Incoming IP address allowance](https://docs.couchbase.com/cloud/clusters/allow-ip-address.html) for the cluster. + + + +For a local Couchbase server, you will need: + +- [Installation of a local Couchbase server](https://docs.couchbase.com/server/current/getting-started/start-here.html). +- [Connection details](https://docs.couchbase.com/server/current/guides/connect.html) to the local Couchbase server. + +To learn more about how to set up a Couchbase cluster and play with data, refer to this [tutorial](https://developer.couchbase.com/tutorial-quickstart-flask-python). \ No newline at end of file diff --git a/snippets/sc-shared-text/filenet-cli-api.mdx b/snippets/sc-shared-text/filenet-cli-api.mdx new file mode 100644 index 00000000..d27ff8e1 --- /dev/null +++ b/snippets/sc-shared-text/filenet-cli-api.mdx @@ -0,0 +1,9 @@ +Connect FileNet to your preprocessing pipeline, and use the Unstructured Ingest CLI or the Unstructured Ingest Python library to batch process all your documents and store structured outputs locally on your filesystem. + +The requirements are as follows. + +import SharedFileNet from '/snippets/general-shared-text/filenet.mdx'; +import SharedFileNetCLIAPI from '/snippets/general-shared-text/filenet-cli-api.mdx'; + + + diff --git a/snippets/source_connectors/filenet.sh.mdx b/snippets/source_connectors/filenet.sh.mdx new file mode 100644 index 00000000..21d00fe1 --- /dev/null +++ b/snippets/source_connectors/filenet.sh.mdx @@ -0,0 +1,20 @@ +```bash CLI +#!/usr/bin/env bash + +unstructured-ingest \ + couchbase \ + --metadata-exclude filename,file_directory,metadata.data_source.date_processed \ + --connection-string "$FILENET_CONNECTION_STRING" \ + --username $COUCHBASE_USERNAM \ + --password $COUCHBASE_PASSWORD \ + --bucket $COUCHBASE_BUCKET \ + --scope $COUCHBASE_SCOPE \ + --collection $COUCHBASE_COLLECTION \ + --output-dir $LOCAL_FILE_OUTPUT_DIR \ + --num-processes 2 \ + --partition-by-api \ + --api-key $UNSTRUCTURED_API_KEY \ + --partition-endpoint $UNSTRUCTURED_API_URL \ + --strategy hi_res \ + --additional-partition-args="{\"split_pdf_page\":\"true\", \"split_pdf_allow_failed\":\"true\", \"split_pdf_concurrency_level\": 15}" \ +``` diff --git a/snippets/source_connectors/filenet.v2.py.mdx b/snippets/source_connectors/filenet.v2.py.mdx new file mode 100644 index 00000000..0af2c0bb --- /dev/null +++ b/snippets/source_connectors/filenet.v2.py.mdx @@ -0,0 +1,53 @@ +```python Python Ingest +import os + +from unstructured_ingest.pipeline.pipeline import Pipeline +from unstructured_ingest.interfaces import ProcessorConfig + +from unstructured_ingest.processes.connectors.filenet import ( + CouchbaseIndexerConfig, + CouchbaseDownloaderConfig, + CouchbaseConnectionConfig, + CouchbaseAccessConfig, +) + +from unstructured_ingest.processes.connectors.local import ( + LocalConnectionConfig +) +from unstructured_ingest.processes.partitioner import PartitionerConfig +from unstructured_ingest.processes.chunker import ChunkerConfig +from unstructured_ingest.processes.embedder import EmbedderConfig + +# Chunking and embedding are optional. + +if __name__ == "__main__": + Pipeline.from_configs( + context=ProcessorConfig(), + indexer_config=CouchbaseIndexerConfig(batch_size=100), + downloader_config=CouchbaseDownloaderConfig(download_dir=os.getenv("LOCAL_FILE_DOWNLOAD_DIR")), + source_connection_config=CouchbaseConnectionConfig( + access_config=CouchbaseAccessConfig( + password=os.getenv("CB_PASSWORD") + ), + username=os.getenv("CB_USERNAME"), + connection_string=os.getenv("CB_CONN_STR"), + bucket=os.getenv("CB_BUCKET"), + scope=os.getenv("CB_SCOPE"), + collection=os.getenv("CB_COLLECTION") + ), + partitioner_config=PartitionerConfig( + partition_by_api=True, + api_key=os.getenv("UNSTRUCTURED_API_KEY"), + partition_endpoint=os.getenv("UNSTRUCTURED_API_URL"), + strategy="hi_res", + additional_partition_args={ + "split_pdf_page": True, + "split_pdf_allow_failed": True, + "split_pdf_concurrency_level": 15 + } + ), + chunker_config=ChunkerConfig(chunking_strategy="by_title"), + embedder_config=EmbedderConfig(embedding_provider="huggingface"), + destination_connection_config=LocalConnectionConfig() + ).run() +``` \ No newline at end of file diff --git a/snippets/source_connectors/filenet_rest_create.mdx b/snippets/source_connectors/filenet_rest_create.mdx new file mode 100644 index 00000000..69ce71a5 --- /dev/null +++ b/snippets/source_connectors/filenet_rest_create.mdx @@ -0,0 +1,22 @@ +```bash curl +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": "", + "type": "filenet", + "config": { + "username": "", + "bucket": "", + "connection_string": "", + "scope": "", + "collection": "", + "password": "", + "batch_size": , + "collection_id": "" + } +}' +``` \ No newline at end of file diff --git a/snippets/source_connectors/filenet_sdk.mdx b/snippets/source_connectors/filenet_sdk.mdx new file mode 100644 index 00000000..515a9168 --- /dev/null +++ b/snippets/source_connectors/filenet_sdk.mdx @@ -0,0 +1,29 @@ +```python 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="", + type="filenet", + config={ + "username": "", + "bucket": "", + "connection_string": "", + "scope": "", + "collection": "", + "password": "", + "batch_size": , + "collection_id": "" + } + ) + ) + ) + + print(response.source_connector_information) +``` \ No newline at end of file diff --git a/ui/destinations/filenet.mdx b/ui/destinations/filenet.mdx new file mode 100644 index 00000000..007d8d26 --- /dev/null +++ b/ui/destinations/filenet.mdx @@ -0,0 +1,34 @@ +--- +title: FileNet +--- + +import FirstTimeUIDestinationConnector from '/snippets/general-shared-text/first-time-ui-destination-connector.mdx'; + + + +Send processed data from Unstructured to IBM FileNet. + +The requirements are as follows. + +import FileNetPrerequisites from '/snippets/general-shared-text/filenet.mdx'; + + + +To create the destination connector: + +1. On the sidebar, click **Connectors**. +2. Click **Destinations**. +3. Cick **New** or **Create Connector**. +4. Give the connector some unique **Name**. +5. In the **Provider** area, click **FileNet**. +6. Click **Continue**. +7. Follow the on-screen instructions to fill in the fields as described later on this page. +8. Click **Save and Test**. + +import FileNetFields from '/snippets/general-shared-text/filenet-platform.mdx'; + + + +## Learn more + +-   [Couchbase Integration in Unstructured Platform](https://unstructured.io/blog/couchbase-integration-in-unstructured-platform) \ No newline at end of file diff --git a/ui/sources/filenet.mdx b/ui/sources/filenet.mdx new file mode 100644 index 00000000..074c93c1 --- /dev/null +++ b/ui/sources/filenet.mdx @@ -0,0 +1,34 @@ +--- +title: FileNet +--- + +import FirstTimeUISourceConnector from '/snippets/general-shared-text/first-time-ui-source-connector.mdx'; + + + +Ingest your files into Unstructured from IBM FileNet. + +The requirements are as follows. + +import FileNetPrerequisites from '/snippets/general-shared-text/filenet.mdx'; + + + +To create the source connector: + +1. On the sidebar, click **Connectors**. +2. Click **Sources**. +3. Cick **New** or **Create Connector**. +4. Give the connector some unique **Name**. +5. In the **Provider** area, click **FileNet**. +6. Click **Continue**. +7. Follow the on-screen instructions to fill in the fields as described later on this page. +8. Click **Save and Test**. + +import FileNetFields from '/snippets/general-shared-text/filenet-platform.mdx'; + + + +## Learn more + +-   [Couchbase Integration in Unstructured Platform](https://unstructured.io/blog/couchbase-integration-in-unstructured-platform) \ No newline at end of file From 8fc3baa9e897d1244a2c5498941c737866d2f420 Mon Sep 17 00:00:00 2001 From: Andrew May Date: Fri, 3 Apr 2026 11:20:18 -0700 Subject: [PATCH 2/4] Test using variable for FileNet product name --- api-reference/workflow/destinations/filenet.mdx | 4 ++-- api-reference/workflow/sources/filenet.mdx | 4 ++-- docs.json | 3 +++ ui/destinations/filenet.mdx | 4 ++-- ui/sources/filenet.mdx | 2 +- 5 files changed, 10 insertions(+), 7 deletions(-) diff --git a/api-reference/workflow/destinations/filenet.mdx b/api-reference/workflow/destinations/filenet.mdx index 91481d95..e33037db 100644 --- a/api-reference/workflow/destinations/filenet.mdx +++ b/api-reference/workflow/destinations/filenet.mdx @@ -6,7 +6,7 @@ import FirstTimeAPIDestinationConnector from '/snippets/general-shared-text/firs -Send processed data from Unstructured to IBM FileNet. +Send processed data from Unstructured to {{filenet}}. The requirements are as follows. @@ -14,7 +14,7 @@ import FileNetPrerequisites from '/snippets/general-shared-text/filenet.mdx'; -To create an IBM FileNet destination connector, see the following examples. +To create an {{filenet}} destination connector, see the following examples. import FileNetSDK from '/snippets/destination_connectors/filenet_sdk.mdx'; import FileNetAPIRESTCreate from '/snippets/destination_connectors/filenet_rest_create.mdx'; diff --git a/api-reference/workflow/sources/filenet.mdx b/api-reference/workflow/sources/filenet.mdx index 993ce6c8..9fdb7d81 100644 --- a/api-reference/workflow/sources/filenet.mdx +++ b/api-reference/workflow/sources/filenet.mdx @@ -6,7 +6,7 @@ import FirstTimeAPISourceConnector from '/snippets/general-shared-text/first-tim -Ingest your files into Unstructured from Couchbase. +Ingest your files into Unstructured from {{filenet}}. The requirements are as follows. @@ -14,7 +14,7 @@ import FileNetPrerequisites from '/snippets/general-shared-text/filenet.mdx'; -To create an IBM FileNet source connector, see the following examples. +To create an {{filenet}} source connector, see the following examples. import FileNetSDK from '/snippets/source_connectors/filenet_sdk.mdx'; import FileNetAPIRESTCreate from '/snippets/source_connectors/filenet_rest_create.mdx'; diff --git a/docs.json b/docs.json index 7f784ae5..2c7eff85 100644 --- a/docs.json +++ b/docs.json @@ -704,6 +704,9 @@ "tagId": "GTM-KJQHTZ6F" } }, + "variables": { + "filenet": "IBM FileNet" + }, "redirects": [ { "source": "/api-reference/api-services/accessing-unstructured-api", diff --git a/ui/destinations/filenet.mdx b/ui/destinations/filenet.mdx index 007d8d26..200a0218 100644 --- a/ui/destinations/filenet.mdx +++ b/ui/destinations/filenet.mdx @@ -1,12 +1,12 @@ --- -title: FileNet +title: FileNet --- import FirstTimeUIDestinationConnector from '/snippets/general-shared-text/first-time-ui-destination-connector.mdx'; -Send processed data from Unstructured to IBM FileNet. +Send processed data from Unstructured to {{filenet}}. The requirements are as follows. diff --git a/ui/sources/filenet.mdx b/ui/sources/filenet.mdx index 074c93c1..498a8ed7 100644 --- a/ui/sources/filenet.mdx +++ b/ui/sources/filenet.mdx @@ -6,7 +6,7 @@ import FirstTimeUISourceConnector from '/snippets/general-shared-text/first-time -Ingest your files into Unstructured from IBM FileNet. +Ingest your files into Unstructured from {{filenet}}. The requirements are as follows. From f31b65c6d47ad7c379a5c0769ae8681b813de88f Mon Sep 17 00:00:00 2001 From: Andrew May Date: Tue, 7 Apr 2026 17:37:43 -0700 Subject: [PATCH 3/4] Initial draft of FileNet connectors feature --- .../destination-connectors/filenet.mdx | 4 +- .../destination_connectors/filenet.sh.mdx | 13 ++-- .../filenet_rest_create.mdx | 12 ++-- .../destination_connectors/filenet_sdk.mdx | 14 ++--- .../filenet-api-placeholders.mdx | 15 ++--- .../general-shared-text/filenet-cli-api.mdx | 21 ++++--- .../general-shared-text/filenet-platform.mdx | 13 ++-- snippets/general-shared-text/filenet.mdx | 61 ++++++++----------- snippets/sc-shared-text/filenet-cli-api.mdx | 2 +- snippets/source_connectors/filenet.sh.mdx | 17 +++--- .../source_connectors/filenet_rest_create.mdx | 13 ++-- snippets/source_connectors/filenet_sdk.mdx | 13 ++-- ui/destinations/filenet.mdx | 11 ++-- ui/sources/filenet.mdx | 8 +-- 14 files changed, 106 insertions(+), 111 deletions(-) diff --git a/open-source/ingestion/destination-connectors/filenet.mdx b/open-source/ingestion/destination-connectors/filenet.mdx index 6def0aad..64f78538 100644 --- a/open-source/ingestion/destination-connectors/filenet.mdx +++ b/open-source/ingestion/destination-connectors/filenet.mdx @@ -10,6 +10,8 @@ Now call the Unstructured Ingest CLI or the Unstructured Ingest Python library. This example sends files to Unstructured for processing by default. To process files locally instead, see the instructions at the end of this page. +[//]: # (tech-review: need to verify these samples for sh and python) + import FileNetAPISh from '/snippets/destination_connectors/filenet.sh.mdx'; import FileNetAPIPyV2 from '/snippets/destination_connectors/filenet.v2.py.mdx'; @@ -18,8 +20,6 @@ import FileNetAPIPyV2 from '/snippets/destination_connectors/filenet.v2.py.mdx'; -To understand how [vector search](https://www.couchbase.com/products/vector-search/) works in Couchbase, refer to this [tutorial](https://developer.couchbase.com/tutorial-python-langchain-pdf-chat) and the [Couchbase docs](https://docs.couchbase.com/cloud/vector-search/vector-search.html) - import SharedPartitionByAPIOSS from '/snippets/ingest-configuration-shared/partition-by-api-oss.mdx'; \ No newline at end of file diff --git a/snippets/destination_connectors/filenet.sh.mdx b/snippets/destination_connectors/filenet.sh.mdx index 44bd8135..e30a6ea3 100644 --- a/snippets/destination_connectors/filenet.sh.mdx +++ b/snippets/destination_connectors/filenet.sh.mdx @@ -17,12 +17,13 @@ unstructured-ingest \ --partition-endpoint $UNSTRUCTURED_API_URL \ --additional-partition-args="{\"split_pdf_page\":\"true\", \"split_pdf_allow_failed\":\"true\", \"split_pdf_concurrency_level\": 15}" \ filenet \ - --connection-string $CB_CONN_STR \ - --username $CB_USERNAME \ - --password $CB_PASSWORD \ - --bucket $CB_BUCKET \ - --scope $CB_SCOPE \ - --collection $CB_COLLECTION \ + --username $FILENET_USERNAME \ + --password $FILENET_PASSWORD \ + --server-url $FILENET_SERVER_URL \ + --object-store $FILENET_OBJECT_STORE \ + --folder-path $FILENET_FOLDER_PATH \ + --document-class $FILENET_DOCUMENT_CLASS \ + --recursive $FILENET_RECURSIVE \ --num-processes 2 \ --batch-size 80 ``` \ No newline at end of file diff --git a/snippets/destination_connectors/filenet_rest_create.mdx b/snippets/destination_connectors/filenet_rest_create.mdx index 71fb1f9c..dede2c17 100644 --- a/snippets/destination_connectors/filenet_rest_create.mdx +++ b/snippets/destination_connectors/filenet_rest_create.mdx @@ -9,13 +9,13 @@ curl --request 'POST' --location \ "name": "", "type": "filenet", "config": { + "server_url": "", + "object_store": "", + "folder_path": "", + "document_class": "", + "recursive": , "username": "", - "bucket": "", - "connection_string": "", - "scope": "", - "collection": "", - "password": "", - "batch_size": + "password": "" } }' ``` \ No newline at end of file diff --git a/snippets/destination_connectors/filenet_sdk.mdx b/snippets/destination_connectors/filenet_sdk.mdx index 1881f8b9..b707d353 100644 --- a/snippets/destination_connectors/filenet_sdk.mdx +++ b/snippets/destination_connectors/filenet_sdk.mdx @@ -12,13 +12,13 @@ with UnstructuredClient(api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")) as clien name="", type="filenet", config={ - "username": "", - "bucket": "", - "connection_string": "", - "scope": "", - "collection": "", - "password": "", - "batch_size": + "server_url": "", + "object_store": "", + "folder_path": "", + "document_class": "", + "recursive": , + "username": "", + "password": "" } ) ) diff --git a/snippets/general-shared-text/filenet-api-placeholders.mdx b/snippets/general-shared-text/filenet-api-placeholders.mdx index 723f32ef..7d981cad 100644 --- a/snippets/general-shared-text/filenet-api-placeholders.mdx +++ b/snippets/general-shared-text/filenet-api-placeholders.mdx @@ -1,7 +1,8 @@ -- `` (_required_) - TODO. -- `` TODO. -- `` TODO. -- `` (_required_) - TODO. -- `` - (_required_) - TODO. -- `` - (_required_) - TODO. -- `` (_required_) - The password for the Couchbase server. \ No newline at end of file +- `` (_required_) - A unique name for this connector. +- `` (_required_) - The base URL of your {{filenet}} server, containing both the IBM domain and your company's subdomain. For example, `https://.automationcloud.ibm.com`. +- `` - (_required_) - The name of the object store to connect within the content platform engine. +- `` (_required_) - The path of the folder to connect to within the object store. +- `` The class of documents to include. +- `` Set to `true` to include documents contained in any subfolders. +- `` - (_required_) - The username of the IBM Cloud Pak for Business Automation as a Service account to use. +- `` (_required_) - The password for the corresponding username. \ No newline at end of file diff --git a/snippets/general-shared-text/filenet-cli-api.mdx b/snippets/general-shared-text/filenet-cli-api.mdx index 3ce0055f..33816c91 100644 --- a/snippets/general-shared-text/filenet-cli-api.mdx +++ b/snippets/general-shared-text/filenet-cli-api.mdx @@ -1,24 +1,29 @@ The FileNet connector dependencies: ```bash CLI, Python -pip install "unstructured-ingest[couchbase]" +pip install "unstructured-ingest[filenet]" ``` import AdditionalIngestDependencies from '/snippets/general-shared-text/ingest-dependencies.mdx'; -These environment variables are required for the Couchbase Connector: +These environment variables are required for the {{filenet}} connector: -- `CB_CONN_STR` - The Connection String for the Couchbase server, represented by `--connection-string` (CLI) or `connection_string` (Python). -- `CB_USERNAME` - The username for the Couchbase server, represented by `--username` (CLI) or `username` (Python). -- `CB_PASSWORD` - The password for the Couchbase server, represented by `--password` (CLI) or `password` (Python). -- `CB_BUCKET` - The name of the bucket in the Couchbase server, represented by `--bucket` (CLI) or `bucket` (Python). -- `CB_SCOPE` - The name of the scope in the bucket, represented by `--scope` (CLI) or `scope` (Python). -- `CB_COLLECTION` - The name of the collection in the scope, represented by `--collection` (CLI) or `collection` (Python). +[//]: # (tech-review: confirm the names of these FILENET variables) + +- `FILENET_SERVER_URL` - The URL of your Content Platform Engine,, represented by `--server-url` (CLI) or `server_url` (Python). +- `FILENET_OBJECT_STORE` - The name of object store in the {{filenet}} server, represented by `--object-store` (CLI) or `object_store` (Python). +- `FILENET_FOLDER_PATH` - The path of the folder within the object store, represented by `--folder-path` (CLI) or `folder_path` (Python). +- `FILENET_DOCUMENT_CLASS` - The document class of documents contained in the folder, represented by `--document-class` (CLI) or `document_class` (Python). +- `FILENET_RECURSIVE` - `true` to include subfolders, represented by `--recursive` (CLI) or `recursive` (Python). +- `FILENET_USERNAME` - The username for the IBM Cloud Pak for Business Automation as a Service account, represented by `--username` (CLI) or `username` (Python). +- `FILENET_PASSWORD` - The password for the corresponding username, represented by `--password` (CLI) or `password` (Python). Additional available settings include: +[//]: # (tech-review: is this setting available for FileNet?) + - `--collection-id` (CLI) or `collection_id` in `CouchbaseDownloaderConfig` (Python) - Optional for the source connector. The unique key of the ID field in the collection. The default is `id` if not otherwise specified. [Learn more](https://docs.couchbase.com/server/current/learn/services-and-indexes/indexes/indexing-and-query-perf.html#introduction-document-keys). \ No newline at end of file diff --git a/snippets/general-shared-text/filenet-platform.mdx b/snippets/general-shared-text/filenet-platform.mdx index b375f88e..6409ff31 100644 --- a/snippets/general-shared-text/filenet-platform.mdx +++ b/snippets/general-shared-text/filenet-platform.mdx @@ -1,9 +1,10 @@ Fill in the following fields: -- **Folder Path** (_required_): TODO -- **Document Class**: TODO. -- **Recursive**: TODO. -- **Server URL** (_required_): TODO. -- **Object Store** (_required_): TODO. -- **Username** (_required_): The cluster access name (username) that has access to the cluster. +- **Name** (_required_): A unique name for this connector. +- **Server URL** (_required_): The base URL of your {{filenet}} server, containing both the IBM domain and your company's subdomain. For example, `https://.automationcloud.ibm.com`. +- **Object Store** (_required_): The name of the object store to connect within the server. +- **Folder Path** (_required_): The path of the folder to connect to within the object store. +- **Document Class**: The class of documents to include. +- **Recursive**: Select 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. \ No newline at end of file diff --git a/snippets/general-shared-text/filenet.mdx b/snippets/general-shared-text/filenet.mdx index 57cbff2c..e98072c0 100644 --- a/snippets/general-shared-text/filenet.mdx +++ b/snippets/general-shared-text/filenet.mdx @@ -1,36 +1,25 @@ -FileNet -- For the [Unstructured UI](/ui/overview) or the [Unstructured API](/api-reference/overview), only Couchbase Capella clusters are supported. -- For [Unstructured Ingest](/open-source/ingestion/overview), Couchbase Capella clusters and local Couchbase server deployments are supported. - - - -import AllowIPAddressRanges from '/snippets/general-shared-text/ip-address-ranges.mdx'; - -For Couchbase Capella, you will need: - -- A [Couchbase Capella account](https://docs.couchbase.com/cloud/get-started/create-account.html#sign-up-free-tier). -- A [Couchbase Capella cluster](https://docs.couchbase.com/cloud/get-started/create-account.html#getting-started). -- A [bucket](https://docs.couchbase.com/cloud/clusters/data-service/manage-buckets.html#add-bucket), - [scope](https://docs.couchbase.com/cloud/clusters/data-service/scopes-collections.html#create-scope), - and [collection](https://docs.couchbase.com/cloud/clusters/data-service/scopes-collections.html#create-collection) - on the cluster. -- The cluster's [public connection string](https://docs.couchbase.com/cloud/get-started/connect.html#connect-from-sdk-cbsh-cli-or-ide). -- The [cluster access name (username) and secret (password)](https://docs.couchbase.com/cloud/clusters/manage-database-users.html#create-database-credentials). -- [Incoming IP address allowance](https://docs.couchbase.com/cloud/clusters/allow-ip-address.html) for the cluster. - - - -For a local Couchbase server, you will need: - -- [Installation of a local Couchbase server](https://docs.couchbase.com/server/current/getting-started/start-here.html). -- [Connection details](https://docs.couchbase.com/server/current/guides/connect.html) to the local Couchbase server. - -To learn more about how to set up a Couchbase cluster and play with data, refer to this [tutorial](https://developer.couchbase.com/tutorial-quickstart-flask-python). \ No newline at end of file +- 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 {{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. {{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 {{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://.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: `//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. diff --git a/snippets/sc-shared-text/filenet-cli-api.mdx b/snippets/sc-shared-text/filenet-cli-api.mdx index d27ff8e1..b3aa46b3 100644 --- a/snippets/sc-shared-text/filenet-cli-api.mdx +++ b/snippets/sc-shared-text/filenet-cli-api.mdx @@ -1,4 +1,4 @@ -Connect FileNet to your preprocessing pipeline, and use the Unstructured Ingest CLI or the Unstructured Ingest Python library to batch process all your documents and store structured outputs locally on your filesystem. +{{filenet}} is an enterprise content management system that enables organizations store, manage, secure, and automate documents and business content at scale. The requirements are as follows. diff --git a/snippets/source_connectors/filenet.sh.mdx b/snippets/source_connectors/filenet.sh.mdx index 21d00fe1..09776a95 100644 --- a/snippets/source_connectors/filenet.sh.mdx +++ b/snippets/source_connectors/filenet.sh.mdx @@ -2,19 +2,18 @@ #!/usr/bin/env bash unstructured-ingest \ - couchbase \ - --metadata-exclude filename,file_directory,metadata.data_source.date_processed \ - --connection-string "$FILENET_CONNECTION_STRING" \ - --username $COUCHBASE_USERNAM \ - --password $COUCHBASE_PASSWORD \ - --bucket $COUCHBASE_BUCKET \ - --scope $COUCHBASE_SCOPE \ - --collection $COUCHBASE_COLLECTION \ + filenet \ + --username $FILENET_USERNAME \ + --password $FILENET_PASSWORD \ + --server-url $FILENET_SERVER_URL \ + --object-store $FILENET_OBJECT_STORE \ + --folder-path $FILENET_FOLDER_PATH \ + --document-class $FILENET_DOCUMENT_CLASS \ + --recursive $FILENET_RECURSIVE \ --output-dir $LOCAL_FILE_OUTPUT_DIR \ --num-processes 2 \ --partition-by-api \ --api-key $UNSTRUCTURED_API_KEY \ --partition-endpoint $UNSTRUCTURED_API_URL \ --strategy hi_res \ - --additional-partition-args="{\"split_pdf_page\":\"true\", \"split_pdf_allow_failed\":\"true\", \"split_pdf_concurrency_level\": 15}" \ ``` diff --git a/snippets/source_connectors/filenet_rest_create.mdx b/snippets/source_connectors/filenet_rest_create.mdx index 69ce71a5..bbee3edb 100644 --- a/snippets/source_connectors/filenet_rest_create.mdx +++ b/snippets/source_connectors/filenet_rest_create.mdx @@ -9,14 +9,13 @@ curl --request 'POST' --location \ "name": "", "type": "filenet", "config": { + "server_url": "", + "object_store": "", + "folder_path": "", + "document_class": "", + "recursive": , "username": "", - "bucket": "", - "connection_string": "", - "scope": "", - "collection": "", - "password": "", - "batch_size": , - "collection_id": "" + "password": "" } }' ``` \ No newline at end of file diff --git a/snippets/source_connectors/filenet_sdk.mdx b/snippets/source_connectors/filenet_sdk.mdx index 515a9168..5472c394 100644 --- a/snippets/source_connectors/filenet_sdk.mdx +++ b/snippets/source_connectors/filenet_sdk.mdx @@ -12,14 +12,13 @@ with UnstructuredClient(api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")) as clien name="", type="filenet", config={ + "server_url": "", + "object_store": "", + "folder_path": "", + "document_class": "", + "recursive": , "username": "", - "bucket": "", - "connection_string": "", - "scope": "", - "collection": "", - "password": "", - "batch_size": , - "collection_id": "" + "password": "" } ) ) diff --git a/ui/destinations/filenet.mdx b/ui/destinations/filenet.mdx index 200a0218..f5e6aafe 100644 --- a/ui/destinations/filenet.mdx +++ b/ui/destinations/filenet.mdx @@ -2,6 +2,8 @@ title: FileNet --- +{{filenet}} is an enterprise content management (ECM) system that enables organizations store, manage, secure, and automate documents and business content at scale. + import FirstTimeUIDestinationConnector from '/snippets/general-shared-text/first-time-ui-destination-connector.mdx'; @@ -25,10 +27,11 @@ To create the destination connector: 7. Follow the on-screen instructions to fill in the fields as described later on this page. 8. Click **Save and Test**. -import FileNetFields from '/snippets/general-shared-text/filenet-platform.mdx'; +[//]: # (tech-review: any chance we can reorder the UI fields to reflect the heirachy of the resources here?) +[//]: # (tech-review: meaning, server > object store > folder path > document type > recursive) +[//]: # (tech-review: also, does the Document Type field do anything in destination connectors?) - -## Learn more +import FileNetFields from '/snippets/general-shared-text/filenet-platform.mdx'; --   [Couchbase Integration in Unstructured Platform](https://unstructured.io/blog/couchbase-integration-in-unstructured-platform) \ No newline at end of file + \ No newline at end of file diff --git a/ui/sources/filenet.mdx b/ui/sources/filenet.mdx index 498a8ed7..591e4b46 100644 --- a/ui/sources/filenet.mdx +++ b/ui/sources/filenet.mdx @@ -2,6 +2,8 @@ title: FileNet --- +{{filenet}} is an enterprise content management system that enables organizations store, manage, secure, and automate documents and business content at scale. + import FirstTimeUISourceConnector from '/snippets/general-shared-text/first-time-ui-source-connector.mdx'; @@ -20,7 +22,7 @@ To create the source connector: 2. Click **Sources**. 3. Cick **New** or **Create Connector**. 4. Give the connector some unique **Name**. -5. In the **Provider** area, click **FileNet**. +5. In the **Provider** area, click **{{filenet}}**. 6. Click **Continue**. 7. Follow the on-screen instructions to fill in the fields as described later on this page. 8. Click **Save and Test**. @@ -28,7 +30,3 @@ To create the source connector: import FileNetFields from '/snippets/general-shared-text/filenet-platform.mdx'; - -## Learn more - --   [Couchbase Integration in Unstructured Platform](https://unstructured.io/blog/couchbase-integration-in-unstructured-platform) \ No newline at end of file From 864422fa00ba44cdb56d758801b299891a28d0b3 Mon Sep 17 00:00:00 2001 From: Andrew May Date: Wed, 8 Apr 2026 09:00:57 -0700 Subject: [PATCH 4/4] Final edit to initial draft of FileNet connectors docs --- ui/destinations/filenet.mdx | 1 - 1 file changed, 1 deletion(-) diff --git a/ui/destinations/filenet.mdx b/ui/destinations/filenet.mdx index f5e6aafe..e3fb9ff2 100644 --- a/ui/destinations/filenet.mdx +++ b/ui/destinations/filenet.mdx @@ -31,7 +31,6 @@ To create the destination connector: [//]: # (tech-review: meaning, server > object store > folder path > document type > recursive) [//]: # (tech-review: also, does the Document Type field do anything in destination connectors?) - import FileNetFields from '/snippets/general-shared-text/filenet-platform.mdx'; \ No newline at end of file