« Elastic OneDrive connector reference Elastic Oracle connector reference »

› ›

Elastic OpenText Documentum connector reference

This connector is an example connector that serves as a building block for customizations and is subject to change. Its source code currently lives on a feature branch and is yet not part of the main Elastic Connectors codebase. The design and code is less mature than supported features and is being provided as-is with no warranties. This connector is not subject to the support SLA of supported features.

The Elastic OpenText Documentum connector is written in Python using the Elastic connector framework. View the source code for this example connector.

Availability and prerequisites

edit

This example connector was introduced in Elastic 8.14.0, available as a self-managed connector client on a feature branch, for testing and development purposes only.

To use this connector, satisfy all connector client prerequisites. Importantly, you must deploy the connectors service on your own infrastructure. You have two deployment options:

Run connectors service from source. Use this option if you’re comfortable working with Python and want to iterate quickly locally.
Run connectors service in Docker. Use this option if you want to deploy the connectors to a server, or use a container orchestration platform.

Usage

edit

To set up this connector in the UI, select the OpenText Documentum tile when creating a new connector under Search → Connectors.

If you’re already familiar with how connectors work, you can also use the Connector APIs.

For additional operations, see Using connectors.

Connecting to OpenText Documentum

edit

Basic authentication is used to connect with OpenText Documentum.

Configuration

edit

Configure OpenText Documentum connector

edit

Note the following configuration fields:

OpenText Documentum host url (required)

The domain where OpenText Documentum is hosted. Example: https://192.158.1.38:2099/

Username (required)

The username of the account to connect to OpenText Documentum.

Password (required)

The password of the account to connect to OpenText Documentum.

Repositories (optional)

Comma-separated list of repositories to fetch data from OpenText Documentum. If the value is * the connector will fetch data from all repositories present in the configured user’s account.

Default value is *.

Examples:

elastic, kibana
*

Enable SSL (optional)

Enable SSL for the OpenText Documentum instance.

SSL Certificate (Required if SSL is enabled)

SSL certificate for the OpenText Documentum instance. Example:

-----BEGIN CERTIFICATE-----
MIID+jCCAuKgAwIBAgIGAJJMzlxLMA0GCSqGSIb3DQEBCwUAMHoxCzAJBgNVBAYT
...
7RhLQyWn2u00L7/9Omw=
-----END CERTIFICATE-----

Content Extraction

edit

Refer to content extraction in the official docs.

Documents and syncs

edit

The connector syncs the following objects and entities:

Repositories
Cabinets
Files & Folders

Files bigger than 10 MB won’t be extracted.
Permissions are not synced. All documents indexed to an Elastic deployment will be visible to all users with access to the destination Elasticsearch index.

Sync types

edit

Full syncs are supported by default for all connectors.

Incremental syncs are not available for this connector in the present version.

Sync rules

edit

Basic sync rules are identical for all connectors and are available by default.

Advanced sync rules are not available for this connector in the present version.

Connector Client operations

edit

End-to-end Testing

edit

The connector framework enables operators to run functional tests against a real data source, using Docker Compose. You don’t need a running Elasticsearch instance or OpenText Documentum source to run this test.

Refer to Connector testing for more details.

To perform E2E testing for the OpenText Documentum connector, run the following command:

$ make ftest NAME=opentext_documentum

For faster tests, add the DATA_SIZE=small flag:

make ftest NAME=opentext_documentum DATA_SIZE=small

By default, DATA_SIZE=MEDIUM.

Known issues

edit

There are no known issues for this connector. Refer to Known issues for a list of known issues for all connectors.

Troubleshooting

edit

See Troubleshooting.

Security

edit

See Security.

« Elastic OneDrive connector reference Elastic Oracle connector reference »