Предыдущая статья курса: Базовые компоненты и логика построения сценариев

Общая информация

Для выполнения работы с данными и осуществления сложных операций, в платформе Эра предусмотрен специальный набор компонентов служебных сценариев.

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

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

Описания компонентов

Файловая операция

Производит указанную операцию ввода-вывода на диске. Работает с файлами, каталогами, путями.

Компонент имеет дополнительные переходы по ошибкам доступа к файлам.

Свойства компонента
Свойство	Описание
`Тип объекта`	Определяет тип объекта, над которым производится файловая операция. Возможные значения: `Путь` (`path`,`1`) – Операции со строковым представлением пути. `Файл` (`file`,`2`) – Операции с файлами. `Каталог` (`folder`,`3`) – Операции с каталогами. `Содержимое файла` (`content`,`4`) – Операции с содержимым файла.
`Операция`	Операция со строковым представлением пути. Возможные значения: `Тип пути` (`getPathType`, `101`) – Возвращает категорию каталога по указанному пути. `Относительный путь` (`getRelativePath`, `102`) – Возвращает относительный путь, вырезая из него категорию. `Имя файла` (`getFileName`, `103`) – Возвращает имя файла из указанного пути. `Расширение` (`getFileExtension`, `104`) – Возвращает расширение файла из указанного пути. `Каталог` (`getFileDirectory`, `105`) – Возвращает имя каталога из указанного пути. `Построить путь` (`makePath`, `106`) – Возвращает путь, собранный из категории каталога и относительного пути, доступный для использования в других операциях и компонентах. `Построить путь к файлу` (`makeFilePath`, `107`) – Возвращает путь к файлу, собранный из трех аргументов: пути, имени файла и расширения.
`Операция`	Операция с файлом. Возможные значения: `Удалить` (`deleteFile`, `201`) – Удаляет файл. `Скопировать` (`copyFile`, `202`) – Копирует файл. `Переместить` (`moveFile`, `203`) – Перемещает файл в другой каталог. `Проверить наличие` (`fileExists`, `205`) – Возвращает `1`, если файл существует, иначе `0`. `Размер` (`getFileSize`, `206`) – Возвращает размер файла. `Хеш содержимого` (`getFileHash`, `207`) – Возвращает хеш содержимого файла. `Создать путь` (`ensureFolder`, `208`) – Создает каталог для файла по указанному пути, если он не существует. `Преобразовать в tiff` (`fileToFaxTiff`, `209`) – Преобразует файл в tiff, с параметрами подходящими для компонента Отправка факса Поддерживаемые форматы для преобразования в tiff: bmp, jpg, pdf, png, tiff.
`Операция`	Операция с каталогом. Возможные значения: `Создать` (`makeFolder`, `301`) – Создает каталог, если он не существует. `Удалить` (`deleteFolder`, `302`) – Удаляет каталог. `Скопировать` (`copyFolder`, `303`) – Копирует каталог со всем содержимым. `Переместить` (`moveFolder`, `304`) – Перемещает каталог со всем содержимым в другой каталог. `Проверить наличие` (`folderExists`, `306`) – Возвращает `1`, если каталог существует, иначе `0`. `Количество файлов` (`getFolderFileCount`, `307`) – Возвращает количество файлов в каталоге на первом уровне. `Количество подкаталогов` (`getFolderSubfolderCount`, `308`) – Возвращает количество подкаталогов на первом уровне.
`Операция`	Операция с содержимым файла. Возможные значения: `Создать файл` (`createFile`, `401`) – Создает новый файл с указанным содержимым. `Записать файл` (`writeFile`, `402`) – Записывает новое содержимое в существующий файл. `Дописать в конец файла` (`appendFile`, `403`) – Добавляет содержимое в конец файла. `Считать файл` (`readFile`, `404`) – Возвращает содержимое файла. Все операции с содержимым используют указанную кодировку для преобразования из строки в бинарный вид.
`Путь`	Аргумент, содержащий путь.
`Отрезать расширение`	Переключатель режима возврата файла без расширения.
`Категория каталога`	Категория каталога, с использованием которой путь становится доступным для применения в операциях ввода-вывода. Возможные значения: `SYNC_COMMON` (`1`) – Каталог общих данных всех доменов в синхронизирующемся между серверами каталоге. `SYNC_DOMAIN_COMMON` (`2`) – Каталог общих данных домена в синхронизирующемся между серверами каталоге. `SYNC_DOMAIN_DATA` (`3`) – Каталог данных домена в синхронизирующемся между серверами каталоге. `SYNC_SCRIPT_DATA` (`4`) – Каталог данных сценария в синхронизирующемся между серверами. `SITESHARE_PUBLIC` (`5`) – Каталог общих данных на сетевом диске сайтового хранилища, доступного всем серверам на сайте. `SITESHARE_DOMAIN_DATA` (`6`) – Каталог данных домена на сетевом диске сайтового хранилища, доступного всем серверам на сайте. `SITESHARE_SCRIPT_DATA` (`7`) – Каталог данных сценария на сетевом диске сайтового хранилища, доступного всем серверам на сайте. `GLOBALSHARE_PUBLIC` (`8`) – Каталог общих данных на сетевом диске глобального хранилища, доступного всем сайтам. `GLOBALSHARE_DOMAIN_DATA` (`9`) – Каталог данных домена на сетевом диске глобального хранилища, доступного всем сайтам. `GLOBALSHARE_SCRIPT_DATA` (`10`) – Каталог данных сценария на сетевом диске глобального хранилища, доступного всем сайтам. `TEMP` (`11`) – Временный каталог текущего обработчика сценария. Удаляется через 5 секунд после его завершения.
`Относительный путь`	Аргумент, содержащий относительный путь.
`Имя файла`	Аргумент, содержащий название файла.
`Расширение`	Аргумент, содержащий расширение файла.
`Путь источника`	Аргумент, содержащий путь источника.
`Путь назначения`	Аргумент, содержащий путь назначения.
`Хеш-функция`	Хеш-функция для применения к содержимому файла.
`Содержимое`	Аргумент с содержимым файла.
`Кодировка`	Кодировка для применения к содержимому файла при считывании в переменную и наоборот. Возможные значения: `Авто` (`1`) – Автоматическое определение. `Бинарные данные` (`binary`, `2`) – Считывание бинарных данных без преобразования. `utf-8` (`3`) `utf-16` (`4`) `utf-32` (`5`) `cp1251` (`6`) – Кодовая страница `windows-1251` (кириллица). `Указать название` (`byname`, `7`) – Указание имени кодировки.
`BOM`	Режим считывания содержания файла с учетом префикса кодировки для UTF. Возможные варианты: `С BOM` (`withBOM`, `1`). `Без BOM` (`withoutBOM`, `2`).
`Endian`	Режим раскладки кодировки unicode. Возможные варианты: `Little-Endian` (`littleEndian`, `1`). `Big-Endian` (`bigEndian`, `2`).
`Название кодировки`	Аргумент, содержащий имя применяемой кодировки.

SQL-Запрос

Позволяет производить действия в БД, а также передавать параметры (на вход и на выход).

В качестве параметров выступают переменные сценария.

Подключение к серверу БД осуществляется по строке подключения. Обращение к БД происходит через ODBC и требует наличия в ОС соответствующих драйверов.

В случае ошибки переход осуществляется по ветке «Ошибка», и в переменную «Код ошибки» возвращается соответствующий код исключения БД.

Возврат значений из БД происходит в табличном виде. Сохранение значений в переменные осуществляется по принципу идентичности имен столбцов в последнем из вернувшихся датасетов и переменных сценария. Переменным присваиваются значения из последней строки последнего датасета.

Свойства компонента
Свойства	Описание
`База Данных`	БД для подключения. Возможные варианты: `Проектная` (`project_psql`, `4`) – Проектная БД домена (PosgtreSQL), строка подключения к которой берется из настроек домена (`settings → project_postgresql_connstr`). `Другая` (`other`, `2`) – Другая БД.
`Драйвер`	Возможные варианты: `ODBC` (`odbc`, `0`) – подключение через драйвер ODBC. `PSQL` (`psql`, `1`) – подключение через внутренний адаптер к PostgreSQL. Для режима указания БД `Другая`.
`Строка соединения`	Строка подключения к БД. Для режима указания БД `Другая`. Пример для odbc драйвера Driver={SQL Server Native Client 11.0}; Server=192.168.0.73,14350; Database=testbase; UID=test; PWD=123; Пример для psql драйвера Driver={PostgreSQL Unicode(x64)}; Server=127.0.0.1; Port=5433; Database=era_dummy_central_common; Uid=platformpgadmin; Pwd=123456; или аналогично формату в конфигурации: host:127.0.0.1,port:5432,login:platformpgadmin,pwd:123456,database:postgres
`Время, с`	Таймаут на выполнение запроса к БД.
`Запрос`	Тело SQL-запроса. Пример для ODBC: INSERT INTO EMPLOYEE (NR, FIRSTNAME, LASTNAME, GENDER) VALUES (?, ?, ?, ?) Пример для PSQL: SELECT name as a, birthdate::varchar as b,Where id = $1 or code = $2 Если запрос возвращает таблицу значений из нескольких строк, то в переменные сохраняется произвольная строка. При этом сопоставление значений производится по именам столбцов в датасете выдачи и переменных. Возвращаемые специальные значения null, true, false преобразуются в строковое представление при сохранении в переменные сценария.
`Параметры запроса`	Списочное значение, устанавливающее параметры для запроса. Порядок параметров строго соответствует порядку применения параметров в запросе.
`Кодировка`	Кодировка, в которой следует сохранить строковые значения в переменных. Возможные варианты: `utf-8` (`1`) `cp1251` (`2`) – Кодовая страница `windows-1251` (кириллица)
`Код ошибки`	Переменная для сохранения кода ошибки.

Следующая статья курса: Запуск служебных сценариев

Предыдущая статья курса: Базовые компоненты и логика построения сценариев