Using connectors

This document describes operations available to native connectors and connector clients.

For Workplace Search connectors, see the Workplace Search documentation.

Create a new index and configure a connector to manage the index’s documents.

The procedures for these operations are different for native connectors and connector clients:

View and manage all Elasticsearch indices managed by connectors.

Within Kibana, navigate to:

Enterprise Search > Content > Elasticsearch indices

View a list of indices and their attributes, including index health and ingestion status. Use the Ingestion method field to identify which indices are managed by connectors.

Within this interface, you can choose to view the details for each existing index or delete an index. Or, you can create a new connector index.

These operations require access to Kibana and additional index privileges.

After creating an index to be managed by a connector, you can configure automatic, recurring syncs.

Within Kibana, navigate to:

Enterprise Search > Content > Elasticsearch indices

Choose the index to configure, and then choose the Scheduling tab.

Within this interface, you can enable or disable recurring syncs. When enabled, you can additionally manage the sync schedule.

This operation requires access to Kibana and the write indices privilege for the .elastic-connectors index.

Alternatively, you can sync once.

After you enable recurring syncs or sync once, the first sync will begin. (There may be a short delay before the connector service begins the first sync.) You may want to view the index details to see the status or errors, or view the synced documents.

After creating the index to be managed by a connector, you can request a single sync at any time.

Within Kibana, navigate to:

Enterprise Search > Content > Elasticsearch indices

Then choose the index to sync.

Regardless of which tab is active, the Sync button is always visible in the top right. Choose this button to reveal sync options, and choose Sync to request a sync. (There may be a short delay before the connector service begins the sync.)

This operation requires access to Kibana and the write indices privilege for the .elastic-connectors index.

After a sync has started, you can cancel the sync before it completes.

Within Kibana, navigate to:

Enterprise Search > Content > Elasticsearch indices

Then choose the index with the running sync.

Regardless of which tab is active, the Sync button is always visible in the top right. Choose this button to reveal sync options, and choose Cancel Syncs to cancel active syncs. This will cancel the running job, and marks all pending and suspended jobs as canceled as well. (There may be a short delay before the connector service cancels the syncs.)

This operation requires access to Kibana and the write indices privilege for the .elastic-connectors and .elastic-connectors-sync-jobs index.

View the index details to see a variety of information that communicate the status of the index and connector.

Within Kibana, navigate to:

Enterprise Search > Content > Elasticsearch indices

Then choose the index to view.

The Overview tab presents a variety of information, including:

Possible values of ingestion status:

This tab also displays the recent sync history, including sync status (see below for possible values).

Possible values of sync status:

For each sync, choose the view button to display the job details, including:

This operation requires access to Kibana and the read indices privilege for the .elastic-connectors index.

View the documents the connector has synced from the data. Additionally view the index mappings to determine the current document schema.

Within Kibana, navigate to:

Enterprise Search > Content > Elasticsearch indices

Then choose the index to view.

Choose the Documents tab to view the synced documents. Choose the Index Mappings tab to view the index mappings that were created by the connector.

When setting up a new connector, ensure you are getting the documents and fields you were expecting from the data source. If not, see Troubleshooting for help.

These operations require access to Kibana and the read and manage indices privileges for the index containing the documents.

See Security for security details.

Use sync rules to limit which documents are fetched from the data source, or limit which fetched documents are stored in Elastic.

Within Kibana, navigate to:

Enterprise Search > Content > Elasticsearch indices

Then choose the index to manage and choose the Sync rules tab.

Use ingest pipelines to transform fetched data before it is stored in Elastic.

Within Kibana, navigate to:

Enterprise Search > Content > Elasticsearch indices

Then choose the index to manage and choose the Pipelines tab.