diff --git a/README.md b/README.md index 4244b39..48cc3e6 100644 --- a/README.md +++ b/README.md @@ -60,10 +60,25 @@ ## Обработчики данных +### ПоискНастроекКластера.epf + +Ищет в стандартном расположении или в указанных каталогах файлы настроек кластера серверов 1С (1cv8lst.lst) и передает найденные файлы далее на обработку. + +#### Параметры + +- **ОписанияКластеров** - массив путей к каталогам, в которых будет выполняться поиск файлов настроек кластеров 1С. Если не указан, то выполняется поиск в стандартных расположениях (%ProgramFiles%\1Cv8\srvinfo). + ### ЧтениеКаталога.epf Читает список файлов из указанного каталога по указанной маске и передает для дальнейшей обработки по одному. +#### Параметры + +- **Путь** - Путь к каталогу для файлов для обработки. Значение по умолчанию: <каталог запуска обработки>; +- **МаскиФайлов** - Маски поиска файлов, разделенные "";". Значение по умолчанию: "*.*"; +- **ИскатьВПодкаталогах** - Флаг поиска в подкаталогах. Значение по умолчанию: Ложь; +- **СортироватьПоИмени** - Флаг сортировки найденных файлов по имени. Значение по умолчанию: Истина. + ### ЧтениеСкобкоФайла.epf Читает скобочный файл в иерархию структур и массивов: @@ -87,37 +102,140 @@ - Для закрывающихся скобок ("}") выполняется обратный вызов МенеджерОбработкиДанных.ПродолжениеОбработкиДанных (МенеджерОбработкиДанных.epf) для передачи прочитанных данных на дальнейшую обработку -### ЧтениеЖР.epf +#### Параметры -Принимает на вход данные в том виде как их возвращает обработка чтения "скобкофайлов" и обрабатывает каждый элемент данных как запись текстового журнала регистрации. +- **ПутьКФайлу** - (обязательный, если обработчик стоит первым в цепочке) Имя файла, файл, поток данных для чтения; +- **УровниЗаписей** - Массив уровней записей (по вложенности), которые будут переданы на дальнейшую обработку. Значение по умолчанию: [1]; +- **НачальнаяСтрока** - Номер строки входящих данных с которой будет начато чтение. Значение по умолчанию: 1; +- **КаталогПозицийЧтения** - Путь к каталогу для сохранения позиций начала чтения. Если не указан, то позиции чтения сохраняться не будут; +- **ЧастотаЗамераСкоростиВыполнения** - Количество прочитанных записей для которых будет выполнен расчет скорости чтения данных. Если указан 0, то расчет скорости выполняться не будет. Значение по умолчанию: 0. + +### ЧтениеСпискаИБ.epf + +Принимает на вход данные в том виде как их возвращает обработка чтения "скобкофайлов" и обрабатывает элементы данных как запись настройки информационной базы в файле настроек кластера 1С. + +#### Параметры + +- **УровеньЭлементов** - (служебный, не требует установки) Номер уровня вложенности элементов в структуре данных, прочитанной из скобкофайла, которые будут прочитаны и обработаны. Значение: 3; +- **ИндексЭлементаРодителя** - (служебный, не требует установки) Индекс родительского элемента в структуре данных, подчиненные элементы которого будут прочитаны и обработаны. Значение: 2; +- **ПутьКФайлу** - Путь к файлу списка ИБ кластера 1С. Требуется для вывода информации о каталоге кластера 1С. ### ЧтениеСловаряЖР.epf Принимает на вход данные в том виде как их возвращает обработка чтения "скобкофайлов" и обрабатывает каждый элемент данных как запись словаря текстового журнала регистрации. -### ЧтениеСпискаИБ.epf +#### Параметры -Принимает на вход данные в том виде как их возвращает обработка чтения "скобкофайлов" и обрабатывает элементы данных как запись настройки информационной базы в файле настроек кластера 1С. +- **УровеньЭлементов** - (служебный, не требует установки) Номер уровня вложенности элементов в структуре данных, прочитанной из скобкофайла, которые будут прочитаны и обработаны. Значение: 1; +- **ИндексЭлементаРодителя** - (служебный, не требует установки) Индекс родительского элемента в структуре данных, подчиненные элементы которого будут прочитаны и обработаны. Значение: 0; + +### ЧтениеЖР.epf + +Принимает на вход данные в том виде как их возвращает обработка чтения "скобкофайлов" и обрабатывает каждый элемент данных как запись текстового журнала регистрации. + +#### Параметры + +- **УровеньЭлементов** - (служебный, не требует установки) Номер уровня вложенности элементов в структуре данных, прочитанной из скобкофайла, которые будут прочитаны и обработаны. Значение: 1; +- **ИндексЭлементаРодителя** - (служебный, не требует установки) Индекс родительского элемента в структуре данных, подчиненные элементы которого будут прочитаны и обработаны. Значение: 0; +- **Словари** - (обязательный) Словари данных журнала регистрации 1С. Задается в виде структуры <имя словаря>:[<ключ элемента>:<значение элемента>]; +- **ВыгружатьКолонки** - Содержит список колонок с указанием необходимости их выгрузки. Задается в виде структуры <имя колонки>:true|false; +- **РазмерПорцииОбработки** - Количество записей, которое будет прочитано прежде чем они будут переданы на дальнейшую обработку. Значение по умолчанию: 1; +- **ИмяФайлаЖурнала** - Имя обрабатываемого файла журнала регистрации. Требуется для вывода информации об имени файла журнала; +- **ИнформационнаяБаза** - Описание или имя информационной базы, чей журнал обрабатывается. Требуется для вывода информации об информационной базе 1С.; ### ЧтениеОтчетаПоВерсиямХранилища.epf Принимает на вход данные в том виде как их возвращает обработка чтения "скобкофайлов" и обрабатывает как элементы данных табличного документа (MXL) с отчетом по версиям хранилища 1С. +#### Параметры + +- **УровеньЭлементов** - (служебный, не требует установки) Номер уровня вложенности элементов в структуре данных, прочитанной из скобкофайла, которые будут прочитаны и обработаны. Значение: 4.; + ### ЧтениеЗамераПроизводительности.epf Принимает на вход данные в том виде как их возвращает обработка чтения "скобкофайлов" и обрабатывает каждый элемент данных как запись замера производительности 1С (PFF). +#### Параметры + +- **УровеньЭлементов** - (служебный, не требует установки) Номер уровня вложенности элементов в структуре данных, прочитанной из скобкофайла, которые будут прочитаны и обработаны. Значение: 3; + +### ФильтрДанных.os + +Принимает на вход данные в виде структуры или массива структур, проверяет их на соответствие заданным условиям и если условия выполняются, передает на дальнейшую обработку. + +#### Параметры + +- **Условия** - структура описания условий фильтра данных; + +#### Пример настройки фильтра + +```json + "ИмяОбработки":"ФильтрДанных", + "Параметры":{ + "Условия":{ + "Группа":"ИЛИ", + "Условия": [ + { + "ЛевоеЗначение":"&Важность", + "ВидСравнения":"ВСписке", + "ПравоеЗначение": [ + "Ошибка" + ] + }, + { + "Группа":"И", + "Условия": [ + { + "ЛевоеЗначение":"&СтатусТранзакции", + "ВидСравнения":"Равно", + "ПравоеЗначение": "Зафиксирована" + }, + { + "ЛевоеЗначение":"&ПредставлениеСобытия", + "ВидСравнения":"Содержит", + "ПравоеЗначение": "Данные" + } + ] + } + ] + } + }, +``` + ### ВыводДанныхВКонсоль.epf -Пример обработки вывода данных, любые входящие данные преобразует в формат JSON и выводит в панель сообщений. +Обработчик вывода данных, любые входящие данные преобразует в формат JSON и выводит в консоль. + +#### Параметры + +- **ОбрабатыватьКакМассив** - Истина - входящий массив будет обработан поэлементно; Ложь - входящий массив будет обработан как 1 значение. Значение по умолчанию: Истина. ### ВыводДанныхВФайлJSON.epf -Пример обработки вывода данных, любые входящие данные преобразует в формат JSON и выводит в указанный файл. +Обработчик вывода данных, любые входящие данные преобразует в формат JSON и выводит в указанный файл. + +#### Параметры + +- **ПутьКФайлу** - (обязательный) Путь к файлу JSON для сохранения данных; +- **ОбрабатыватьКакМассив** - Истина - входящий массив будет обработан поэлементно; Ложь - входящий массив будет обработан как 1 значение. Значение по умолчанию: Истина. ### ВыводДанныхВЭластик.epf -Пример обработки вывода данных, любые входящие данные преобразует в формат JSON и отправляет в индекс Elastic. +Обработчик вывода данных, любые входящие данные преобразует в формат JSON и отправляет в индекс Elastic. + +#### Параметры + +- **Эластик_Сервер** - (обязательный) Адрес сервера http-сервиса Elastic."); +- **Эластик_Порт** - Порт сервера http-сервиса Elastic. Значение по умолчанию: 9200; +- **Эластик_Путь** - Относительный путь к REST API Elastic; +- **Эластик_Пользователь** - Имя пользователя сервиса Elastic; +- **Эластик_Пароль** - Пароль пользователя сервиса Elastic; +- **ШаблонЗаголовкаИндекса** - (обязательный) Шаблон для установки значения заголовка индекса (_index) при выгрузке; +- **ШаблонТипаИндекса** - (обязательный) Шаблон для установки значения типа индекса (_type) при выгрузке; +- **ШаблонИдИндекса** -(обязательный) Шаблон для установки идентификатора индекса (_id) при выгрузке; +- **РазмерПорцииОбработки** - Количество записей, которое будет добавлено в пакет для отправки в Elastic. Значение по умолчанию: 1; +- **СохранятьОбработанныеДанные** - Флаг необходимости сохранения обработанных данных в результатах обработки. Значение по умолчанию: Ложь; +- **СохранятьОтправленныеСтроки** - Флаг необходимости сохранения строк, отправленных в Elastic в результатах обработки. Значение по умолчанию: Ложь. ## Файл настроек (JSON) @@ -164,12 +282,6 @@ { // путь к обработке чтения файла словарей журнала регистрации, обработчик будет вызван, для каждой прочитанной записи файла словарей "ПутьКОбработке":"$thisRoot\\ЧтениеСловаряЖР.epf", - "Параметры":{ - // фильтр обрабатываемых уровней вложенности "скобкофайла" - "УровеньЭлементов":1, - // фильтр индекса родительского элемента, обрабатываемых записей "скобкофайла" - "ИндексЭлементаРодителя":0 - }, "Обработчики":[ { // путь к обработке вывода произвольных данных в файл JSON, обработчик будет вызван, для каждой прочитанной записи словаря журнала регистрации