Справочник подключения Elastic Salesforce

Этот коннектор доступен в Elastic Cloud как управляемый коннектор начиная с версии 8.12.0. Для использования этого коннектора, выполните все требования к коннекторам с самостоятельным управлением.

Этот коннектор совместим со следующими системами:

Чтобы создать новый коннектор Salesforce:

Для дополнительных операций см. Интерфейс коннекторов в Kibana.

Вы можете использовать API Elasticsearch создания коннектора для создания нового нативного коннектора Salesforce.

Например:

resp = client.connector.put(
    connector_id="my-{service-name-stub}-connector",
    index_name="my-elasticsearch-index",
    name="Content synced from {service-name}",
    service_type="{service-name-stub}",
    is_native=True,
)
print(resp)

const response = await client.connector.put({
  connector_id: "my-{service-name-stub}-connector",
  index_name: "my-elasticsearch-index",
  name: "Content synced from {service-name}",
  service_type: "{service-name-stub}",
  is_native: true,
});
console.log(response);

PUT _connector/my-salesforce-connector
{
  "index_name": "my-elasticsearch-index",
  "name": "Content synced from Salesforce",
  "service_type": "salesforce",
  "is_native": true
}

См. документацию по API Elasticsearch для получения подробной информации обо всех доступных API коннекторов.

Для использования этого коннектора в качестве коннектора с самостоятельным управлением используйте рабочий процесс Коннектор в интерфейсе Kibana.

Для дополнительных операций см. использование коннекторов.

Коннектор Salesforce аутентифицируется с Salesforce через приложение, подключенное к Salesforce. Следуйте официальной документации Salesforce по настройке подключенного приложения для потока OAuth 2.0 Client Credentials.

При создании подключенного приложения в разделе API (Включить настройки OAuth) убедитесь, что следующие настройки включены:

Все остальные параметры должны быть отключены. Наконец, в разделе Выбранные OAuth-разрешения включите следующие OAuth-разрешения:

По умолчанию коннектор Salesforce требует разрешений глобального администратора для доступа к данным Salesforce. Разверните раздел ниже, чтобы узнать, как создать пользовательский пользователь Salesforce с минимальными разрешениями.

Для настройки этого коннектора требуются следующие параметры:

Идентификатор клиента и секрет клиента не отображаются автоматически после создания подключенного приложения. Вы можете найти их, выполнив следующие действия:

Ваш идентификатор клиента и секрет клиента теперь должны быть видны в верхней части страницы.

Безопасность на уровне документа (DLS) позволяет ограничить доступ к документам на основе разрешений пользователя. Эта функция доступна по умолчанию для подключения Salesforce и поддерживает как стандартные, так и пользовательские объекты.

Salesforce позволяет пользователям устанавливать разрешения следующим образом:

Для получения руководства ознакомьтесь с этими видео-уроками по настройке разрешений Salesforce.

Для импорта любых стандартных или пользовательских объектов пользователи должны убедиться, что объекту предоставлено разрешение Read. Это можно сделать, используя любой из следующих методов настройки разрешений.

Обратитесь к документации Salesforce для настройки разрешений через профили.

Обратитесь к документации Salesforce для настройки разрешений через наборы разрешений.

Обратитесь к документации Salesforce для настройки разрешений через группы наборов разрешений.

После настройки разрешений назначьте профили, наборы разрешений или группы наборов разрешений пользователю. Выполните эти шаги в Salesforce:

Правила синхронизации базового типа идентичны для всех подключений и доступны по умолчанию. Для получения дополнительной информации прочитайте Типы правил синхронизации.

В следующем разделе описаны расширенные правила синхронизации для этого подключения. Расширенные правила синхронизации позволяют фильтровать данные в Salesforce перед индексированием в Elasticsearch.

Они принимают следующие параметры:

Получение документов на основе указанного запроса и языка

Пример: Получение документов с помощью запроса SOQL

[
  {
    "query": "SELECT Id, Name FROM Account",
    "language": "SOQL"
  }
]

Пример: Получение документов с помощью запроса SOSL.

[
  {
    "query": "FIND {Salesforce} IN ALL FIELDS",
    "language": "SOSL"
  }
]

Получение стандартных и пользовательских объектов с помощью запросов SOQL и SOSL

Пример: Получение документов для стандартных объектов через SOQL и SOSL запрос.

[
  {
    "query": "SELECT Account_Id, Address, Contact_Number FROM Account",
    "language": "SOQL"
  },
  {
    "query": "FIND {Alex Wilber} IN ALL FIELDS RETURNING Contact(LastModifiedDate, Name, Address)",
    "language": "SOSL"
  }
]

Пример: Получение документов для пользовательских объектов через SOQL и SOSL запрос.

[
  {
    "query": "SELECT Connector_Name, Version FROM Connector__c",
    "language": "SOQL"
  },
  {
    "query": "FIND {Salesforce} IN ALL FIELDS RETURNING Connectors__c(Id, Connector_Name, Connector_Version)",
    "language": "SOSL"
  }
]

Получение документов со стандартными и пользовательскими полями

Пример: Получение документов со всеми стандартными и пользовательскими полями для объекта Account.

[
  {
    "query": "SELECT FIELDS(ALL) FROM Account",
    "language": "SOQL"
  }
]

Пример: Получение документов со всеми пользовательскими полями для объекта Connector.

[
  {
    "query": "SELECT FIELDS(CUSTOM) FROM Connector__c",
    "language": "SOQL"
  }
]

Пример: Получение документов со всеми стандартными полями для объекта Account.

[
  {
    "query": "SELECT FIELDS(STANDARD) FROM Account",
    "language": "SOQL"
  }
]

Подключение синхронизирует следующие объекты Salesforce:

Подключение не будет импортировать объекты, к которым у него нет разрешения на запрос.

Полные синхронизации поддерживаются по умолчанию для всех подключений.

Это подключение также поддерживает инкрементные синхронизации.

Подключение будет извлекать Content Documents из вашего источника Salesforce, если они соответствуют следующим критериям:

Это означает, что подключение не будет импортировать Content Documents, которые не прикреплены к поддерживаемому объекту Salesforce. Список поддерживаемых типов объектов см. в документах и синхронизациях.

Если один Content Document прикреплен к нескольким поддерживаемым объектам, для него будет создан только один документ Elastic. Этот документ сохранит ссылки на каждый объект, к которому он был подключен, в поле related_ids.

Дополнительную информацию об извлечении содержимого см. в разделе об извлечении содержимого.

См. раздел о безопасности подключений.

Это подключение создано с помощью фреймворка Elastic для подключений.

Просмотрите исходный код этого подключения (ветка 8.17, совместима с Elastic 8.17).

Это подключение доступно в виде самостоятельного самостоятельного подключения. Это самостоятельное подключение совместимо с версиями Elastic 8.10.0+. Для использования этого подключения выполните все требования к самостоятельным подключениям.

Это подключение совместимо со следующим:

Чтобы создать новое подключение Salesforce:

Вы можете использовать Elasticsearch API для создания подключений для создания нового самостоятельного подключения Salesforce.

Например:

resp = client.connector.put(
    connector_id="my-{service-name-stub}-connector",
    index_name="my-elasticsearch-index",
    name="Content synced from {service-name}",
    service_type="{service-name-stub}",
)
print(resp)

const response = await client.connector.put({
  connector_id: "my-{service-name-stub}-connector",
  index_name: "my-elasticsearch-index",
  name: "Content synced from {service-name}",
  service_type: "{service-name-stub}",
});
console.log(response);

PUT _connector/my-salesforce-connector
{
  "index_name": "my-elasticsearch-index",
  "name": "Content synced from Salesforce",
  "service_type": "salesforce"
}

Подробную информацию обо всех доступных API для подключений см. в документации API Elasticsearch.

Для использования этого подключения как самостоятельного подключения используйте рабочий процесс Подключение в интерфейсе Kibana.

Дополнительные операции см. в документации по работе с подключениями.

Подключение Salesforce аутентифицируется с Salesforce через приложение. Следуйте официальной документации Salesforce по настройке подключенного приложения для потока OAuth 2.0 с клиентом и секретом.

При создании приложения в разделе, озаглавленном API (Включить настройки OAuth), убедитесь, что следующие настройки включены:

По умолчанию для доступа к данным Salesforce требуется право глобального администратора подключения Salesforce. Разверните раздел ниже, чтобы узнать, как создать пользователь Salesforce с минимальными правами.

Самостоятельные подключения выполняются на вашей собственной инфраструктуре.

Вы можете развернуть подключение Salesforce как самостоятельное подключение с помощью Docker. Следуйте этим инструкциям.

curl https://raw.githubusercontent.com/elastic/connectors/main/config.yml.example --output ~/connectors-config/config.yml

# When connecting to your cloud deployment you should edit the host value
elasticsearch.host: http://host.docker.internal:9200
elasticsearch.api_key: <ELASTICSEARCH_API_KEY>

connectors:
  -
    connector_id: <CONNECTOR_ID_FROM_KIBANA>
    service_type: salesforce
    api_key: <CONNECTOR_API_KEY_FROM_KIBANA> # Optional. If not provided, the connector will use the elasticsearch.api_key instead

docker run \
-v ~/connectors-config:/config \
--network "elastic" \
--tty \
--rm \
docker.elastic.co/enterprise-search/elastic-connectors:8.17.3 \
/app/bin/elastic-ingest \
-c /config/config.yml

Дополнительную информацию см. в DOCKER.md в репозитории elastic/connectors.

Найдите все доступные Docker-изображения в официальном репозитории.

Для настройки этого соединителя требуется следующая информация:

Идентификатор и секрет клиента не отображаются автоматически после создания подключенного приложения. Вы можете найти их, выполнив следующие действия:

Теперь идентификатор и секрет клиента должны быть видны в верхней части страницы.

Защита на уровне документа (DLS) позволяет ограничить доступ к документам на основе разрешений пользователя. Эта функция доступна по умолчанию для соединителя Salesforce и поддерживает как стандартные, так и пользовательские объекты.

Salesforce позволяет пользователям задавать разрешения следующим образом:

Для получения руководства обратитесь к этим видеоурокам о настройке разрешений Salesforce.

Для извлечения любого стандартного или пользовательского объекта пользователи должны убедиться, что объекту предоставлено, по крайней мере, разрешение Read. Это можно сделать, используя любой из перечисленных методов настройки разрешений.

Обратитесь к документации Salesforce для настройки разрешений через профили.

Обратитесь к документации Salesforce для настройки разрешений через наборы разрешений.

Обратитесь к документации Salesforce для настройки разрешений через группы наборов разрешений.

После настройки разрешений назначьте профили, наборы разрешений или группы наборов разрешений пользователю. Выполните эти шаги в Salesforce:

Базовые правила синхронизации одинаковы для всех соединителей и доступны по умолчанию.

Для получения дополнительной информации ознакомьтесь с правилами синхронизации.

В следующем разделе описаны расширенные правила синхронизации для этого соединителя. Расширенные правила синхронизации позволяют фильтровать данные в Salesforce *до* индексирования в Elasticsearch.

Они принимают следующие параметры:

Извлечение документов на основе указанного запроса и языка

Пример: Извлечение документов с помощью запроса SOQL

[
  {
    "query": "SELECT Id, Name FROM Account",
    "language": "SOQL"
  }
]

Пример: Извлечение документов с помощью запроса SOSL.

[
  {
    "query": "FIND {Salesforce} IN ALL FIELDS",
    "language": "SOSL"
  }
]

Извлечение стандартных и пользовательских объектов с помощью запросов SOQL и SOSL

Пример: Извлечение документов для стандартных объектов с помощью запросов SOQL и SOSL.

[
  {
    "query": "SELECT Account_Id, Address, Contact_Number FROM Account",
    "language": "SOQL"
  },
  {
    "query": "FIND {Alex Wilber} IN ALL FIELDS RETURNING Contact(LastModifiedDate, Name, Address)",
    "language": "SOSL"
  }
]

Пример: Извлечение документов для пользовательских объектов с помощью запросов SOQL и SOSL.

[
  {
    "query": "SELECT Connector_Name, Version FROM Connector__c",
    "language": "SOQL"
  },
  {
    "query": "FIND {Salesforce} IN ALL FIELDS RETURNING Connectors__c(Id, Connector_Name, Connector_Version)",
    "language": "SOSL"
  }
]

Извлечение документов со стандартными и пользовательскими полями

Пример: Извлечение документов со всеми стандартными и пользовательскими полями для объекта Account.

[
  {
    "query": "SELECT FIELDS(ALL) FROM Account",
    "language": "SOQL"
  }
]

Пример: Извлечение документов со всеми пользовательскими полями для объекта Connector.

[
  {
    "query": "SELECT FIELDS(CUSTOM) FROM Connector__c",
    "language": "SOQL"
  }
]

Пример: Извлечение документов со всеми стандартными полями для объекта Account.

[
  {
    "query": "SELECT FIELDS(STANDARD) FROM Account",
    "language": "SOQL"
  }
]

Соединитель синхронизирует следующие объекты Salesforce:

Соединитель не будет извлекать объекты, для запроса к которым у него нет разрешений.

Полные синхронизации поддерживаются по умолчанию для всех соединителей.

Этот соединитель также поддерживает инкрементные синхронизации.

Соединитель будет извлекать документы Content Documents из вашего источника Salesforce, если они соответствуют следующим критериям:

Это означает, что соединитель не будет обрабатывать какие-либо документы содержимого, которые у вас есть и которые не присоединены к поддерживаемому объекту Salesforce. См. документы и синхронизации для списка поддерживаемых типов объектов.

Если один документ содержимого прикреплен к нескольким поддерживаемым объектам, для него будет создан только один документ Elastic. Этот документ сохранит ссылки на каждый объект, к которому он был подключен, в поле related_ids.

См. извлечение содержимого для получения более подробной информации об извлечении содержимого.

См. безопасность соединителей.

Этот соединитель построен с использованием фреймворка соединителей Elastic.

Просмотрите исходный код этого соединителя (ветка 8.17, совместимая с Elastic 8.17).