creatio.common

Настройка глобального поиска

Важно

В данной статье описана настройка глобального поиска с использованием сервиса индексации Logstash. Начиная с версии 7.10.3 вместо Logstash может использоваться сервис GlobalSearchService. Если в вашем приложении включена данная функциональность, воспользуйтесь обновленной инструкцией.

В приложениях, развернутых on-site, для работы глобального поиска необходимо настроить дополнительные компоненты:

Java — платформа для вычислений, необходимая для работы компонентов глобального поиска.

ElasticSearch — поисковая система.

Logstash — система сбора данных для индексации в ElasticSearch.

Global Search Configuration Service (GSCS API) — сервис для конфигурирования поиска и настройки взаимодействия с Logstash.

LogstashService — сервис, контролирующий запуск Logstash.

На заметку

Для установки GSCS и LogstashService необходимы файлы, которые можно получить, обратившись в службу поддержки.

Содержание

Рекомендуемые системные требования

Установка компонентов глобального поиска

Настройка bpm’online для глобального поиска

Регистрация компонентов глобального поиска

Смотрите также

Глобальный поиск

Рекомендуемые системные требования

Для разворачивания компонентов глобального поиска рекомендуется использовать два отдельных сервера:

Сервер, на котором развернут только ElasticSearch. Рекомендуемые системные требования к этому серверу:

Операционная система

Linux Debian 64-bit, последней версии

ЦПУ (CPU)

2–4 ядра. Intel(R) Xeon(R) CPU E5-4640 0 @ 2.40GHz или подобные

ОЗУ (RAM)

3 Гб

НЖМД (HDD)

Примерно половина объема базы данных

Дополнительное ПО

Java

Сервер, который содержит компоненты Logstash, GSCS API и LogstashService. Рекомендуемые системные требования к этому серверу:

Операционная система

Microsoft Windows 64-bit

ЦПУ (CPU)

Intel(R) Xeon(R) CPU E5-2630 v4 2.20GHz или подобные

ОЗУ (RAM)

2 Гб

НЖМД (HDD)

60 Гб

Дополнительное ПО

Java (Java Runtime Environment последней версии)

Internet Information Services (IIS)

Смотрите также

Установка компонентов глобального поиска

Настройка bpm’online для глобального поиска

Регистрация компонентов глобального поиска

Установка компонентов глобального поиска

Порядок установки компонентов:

1.Java.

2.ElasticSearch.

3.Logstash.

4.Global Search Configuration Service.

5.LogstashService.

Установка Java

Среда Java JRE должна быть развернута как в Windows, так и в Linux. Для установки или обновления Java воспользуйтесь инструкциями по ссылке.

Установка ElasticSearch

Для установки ElasticSearch выполните следующие действия:

1.Скачайте архив ElasticSearch по ссылке и распакуйте его.

2.Выполните команду bin/elasticsearch.

3.В утилите curl выполните команду:

curl http://localhost:9200/

4.После установки ElasticSearch установите плагин для поиска по морфологии. Для этого скачайте актуальную версию по ссылке. Для установки плагина выполните команду в директории elasticsearch:

bin/elasticsearch-plugin install URL

где URL — это URL плагина из таблицы совместимости версий. Например, для версии 5.3.0 выполните:

bin/elasticsearch-plugin install http://dl.bintray.com/content/imotov/elasticsearch-plugins/org/elasticsearch/elasticsearch-analysis-morphology/5.3.0/elasticsearch-analysis-morphology-5.3.0.zip

Установка Logstash

Для установки Logstash выполните следующие действия:

1.Скачайте архив Logstash по ссылке и распакуйте его.

Важно

Logstash должен располагаться в корне диска для обеспечения корректной работы функциональности symlink.

2.Проверьте работоспособность Logstash, выполнив команду:

cd logstash-5.3.0
bin/logstash -e 'input { stdin { } } output { stdout {} }'

После запуска Logstash дождитесь появления строки “Pipeline main started” и затем введите “hello world” в командной строке:

hello world
2013-11-21T01:22:14.405+0000 0.0.0.0 hello world

Logstash добавит в сообщение метку даты и времени и информацию об IP-адресе. Выйдите из Logstash, используя комбинацию клавиш CTRL+D в оболочке, где запущен Logstash.

3.Установите на сервер Logstash плагин, выполнив команду из поддиректории bin директории Logstash:

#для Windows
bin\logstash-plugin.bat install logstash-filter-aggregate

4.Если необходимо настроить логирование, добавьте в файл bin\setup.bat перед строкой “:opts defined” следующее:

SET JAVA_OPTS=%JAVA_OPTS% -Dlog4j.configurationFile=[logstash path]\config\log4j2.properties

где [logstash path] — путь к директории, где распакован logstash.

На заметку

При возникновении вопросов по установке Logstash воспользуйтесь инструкцией по ссылке.

Установка Global Search Configuration Service

Для установки компонента GSCS API получите установочные файлы, обратившись в службу технической поддержки, и затем выполните следующие действия:

1.Разверните сервис в IIS. При необходимости укажите в настройках сайта хост и порт, например, http://gscsapi-server:port.

2.Добавьте в файл Web.config сервиса любое значение свойства ApiKey. Это значение необходимо для авторизации системных действий по регистрации и обслуживанию приложений, подключенных к глобальному поиску. Приложение bpm’online не использует функции API, где требуется API Key.

3.Создайте директорию с сетевым доступом, в которой будут храниться конфигурационные файлы Logstash и логи. Укажите путь к этой директории в Web.config в свойство logstashConfigsFolderPath в виде пути к папке, например “\\my-server\path\folder”.

4.Скачайте sqljdbcDriver версии 4 по ссылке и поместите его в папку с сетевым доступом. Укажите путь к нему в файле Web.config в свойстве jdbcDriver. Например, \\my-server\logstash\lib\sqljdbc_4.0\enu\sqljdbc4.jar.

5.На сервере базы данных добавьте пользователя с правами только на чтение. Логин и пароль этого пользователя установите в Web.config в свойства jdbcUser и jdbcPassword.

6.Установите в файле Web.config в свойства elasticUserLogin и elasticUserPassword значения ‘1’.

7.Установите в Web.config в свойство schedule желаемый интервал повторной индексации в cron-формате, например — ‘* * * * *’ (каждую минуту). Подробнее о задании интервала индексации можно прочитать по ссылке.

Установка LogstashService

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

1.Разверните сервис в IIS на той же машине, где находится Logstash. При необходимости укажите хост и порт, например, http://logstash-service:port.

2.Установите в Web.config в свойство logstashPath полный путь к файлу logstash.bat из директории, где установлен Logstash, например, `C:\Logstash\bin\logstash.bat`

Смотрите также

Рекомендуемые системные требования

Настройка bpm’online для глобального поиска

Регистрация компонентов глобального поиска

Настройка bpm’online для глобального поиска

В bpm’online укажите в системной настройке “Адрес сервиса конфигурирования поиска” (код GlobalSearchConfigServiceUrl) web-адрес сервиса GSCS API в формате “http://gscsapi-server:port”.

Смотрите также

Рекомендуемые системные требования

Установка компонентов глобального поиска

Регистрация компонентов глобального поиска

Регистрация компонентов глобального поиска

Регистрация сервера Logstash

Для регистрации сервера Logstash выполните POST-запрос на GSCS API сервис по адресу http://gscsapi-server:port/addlogstash, с таким телом запроса:

"LogstashServerName": "[имя машины, где расположен LogstashService, например my-logstash-server]"
"LogstashServiceUrl": "[web-адрес LogstashService, например http://my-logstash-server:1337]"
"ApiKey": "[ранее указанный ApiKey из файла Web.config]"

Регистрация приложения bpm’online

Для регистрации приложения bpm’online выполните POST-запрос к GSCS API сервису по адресу http://gscsapi-server:port/addnewsite, с таким телом запроса:

"SiteName": "my-site", // Значение SiteName должно быть равно названию БД приложения bpm'online.
"DbServerName": "[имя sql сервера]", // Например 'localhost' или 'my-sql-server\mssql2014'. Если есть специфический порт для SQL-сервера, его нужно указать так 'localhost:1234'
"ApiKey": "[ранее указанный ApiKey]" // ApiKey из Web.config

Ссылка на созданный в ElasticSearch индекс придет в ответе, имеющем такой формат:

"ResponseMessage" : "http://elasticsearch:9200/7230950b90acf453404773da47490ef07230950b90acf453404773da47490ef0",
"ResponseStatus" : "OK"

Установите полученную ссылку в системную настройку “Адрес сервиса поиска” (код GlobalSearchUrl) в приложении.

Активация глобального поиска

После выполнения всех описанных выше настроек перезапустите пул приложений bpm’online в IIS и выполните вход в приложение. Это действие подготовит конфигурационные файлы для сбора данных и запустит Logstash.

С этого момента поиск будет доступен из командной строки.

На заметку

Скорость индексации данных зависит от размера базы данных, параметров SQL-сервера и параметров ElasticSearch сервера.

Смотрите также

Рекомендуемые системные требования

Установка компонентов глобального поиска

Настройка bpm’online для глобального поиска

 

Был ли данный материал полезен?

Как можно улучшить эту статью?