Просмотр кода страницы Компоненты работы с данными

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

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

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

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

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

=== Файловая операция ===
[[Файл:Компонент Файловая операция.png|центр|безрамки|534x534пкс]]
Производит указанную операцию ввода-вывода на диске. Работает с файлами, каталогами, путями.<blockquote>Компонент имеет дополнительные переходы по ошибкам доступа к файлам.</blockquote>
{| class="wikitable"
|+Свойства компонента
!Свойство
!Описание
|-
|<code>Тип объекта</code>
|Определяет тип объекта, над которым производится файловая операция.

Возможные значения:

* <code>Путь</code> (<code>path</code>,<code>1</code>) – Операции со строковым представлением пути.
* <code>Файл</code> (<code>file</code>,<code>2</code>) – Операции с файлами.
* <code>Каталог</code> (<code>folder</code>,<code>3</code>) – Операции с каталогами.
* <code>Содержимое файла</code> (<code>content</code>,<code>4</code>) – Операции с содержимым файла.
|-
|<code>Операция</code>
|Операция со строковым представлением пути.

Возможные значения:

* <code>Тип пути</code> (<code>getPathType</code>, <code>101</code>) – Возвращает категорию каталога по указанному пути.
* <code>Относительный путь</code> (<code>getRelativePath</code>, <code>102</code>) – Возвращает относительный путь, вырезая из него категорию.
* <code>Имя файла</code> (<code>getFileName</code>, <code>103</code>) – Возвращает имя файла из указанного пути.
* <code>Расширение</code> (<code>getFileExtension</code>, <code>104</code>) – Возвращает расширение файла из указанного пути.
* <code>Каталог</code> (<code>getFileDirectory</code>, <code>105</code>) – Возвращает имя каталога из указанного пути.
* <code>Построить путь</code> (<code>makePath</code>, <code>106</code>) – Возвращает путь, собранный из категории каталога и относительного пути, доступный для использования в других операциях и компонентах.
* <code>Построить путь к файлу</code> (<code>makeFilePath</code>, <code>107</code>) – Возвращает путь к файлу, собранный из трех аргументов: пути, имени файла и расширения.
|-
|<code>Операция</code>
|Операция с файлом.

Возможные значения:

* <code>Удалить</code> (<code>deleteFile</code>, <code>201</code>) – Удаляет файл.
* <code>Скопировать</code> (<code>copyFile</code>, <code>202</code>) – Копирует файл.
* <code>Переместить</code> (<code>moveFile</code>, <code>203</code>) – Перемещает файл в другой каталог.
* <code>Проверить наличие</code> (<code>fileExists</code>, <code>205</code>) – Возвращает <code>1</code>, если файл существует, иначе <code>0</code>.
* <code>Размер</code> (<code>getFileSize</code>, <code>206</code>) – Возвращает размер файла.
* <code>Хеш содержимого</code> (<code>getFileHash</code>, <code>207</code>) – Возвращает хеш содержимого файла.
* <code>Создать путь</code> (<code>ensureFolder</code>, <code>208</code>) – Создает каталог для файла по указанному пути, если он не существует.
* <code>Преобразовать в tiff</code> (<code>fileToFaxTiff</code>, <code>209</code>) – Преобразует файл в tiff, с параметрами подходящими для компонента Отправка факса  Поддерживаемые форматы для преобразования в tiff: bmp, jpg, pdf, png, tiff.
|-
|<code>Операция</code>
|Операция с каталогом.

Возможные значения:

* <code>Создать</code> (<code>makeFolder</code>, <code>301</code>) – Создает каталог, если он не существует.
* <code>Удалить</code> (<code>deleteFolder</code>, <code>302</code>) – Удаляет каталог.
* <code>Скопировать</code> (<code>copyFolder</code>, <code>303</code>) – Копирует каталог со всем содержимым.
* <code>Переместить</code> (<code>moveFolder</code>, <code>304</code>) – Перемещает каталог со всем содержимым в другой каталог.
* <code>Проверить наличие</code> (<code>folderExists</code>, <code>306</code>) – Возвращает <code>1</code>, если каталог существует, иначе <code>0</code>.
* <code>Количество файлов</code> (<code>getFolderFileCount</code>, <code>307</code>) – Возвращает количество файлов в каталоге на первом уровне.
* <code>Количество подкаталогов</code> (<code>getFolderSubfolderCount</code>, <code>308</code>) – Возвращает количество подкаталогов на первом уровне.
|-
|<code>Операция</code>

|Операция с содержимым файла.

Возможные значения:

* <code>Создать файл</code> (<code>createFile</code>, <code>401</code>) – Создает новый файл с указанным содержимым.
* <code>Записать файл</code> (<code>writeFile</code>, <code>402</code>) – Записывает новое содержимое в существующий файл.
* <code>Дописать в конец файла</code> (<code>appendFile</code>, <code>403</code>) – Добавляет содержимое в конец файла.
* <code>Считать файл</code> (<code>readFile</code>, <code>404</code>) – Возвращает содержимое файла.

Все операции с содержимым используют указанную кодировку для преобразования из строки в бинарный вид.
|-
|<code>Путь</code>
|Аргумент, содержащий путь.
|-
|<code>Отрезать расширение</code>
|Переключатель режима возврата файла без расширения.
|-
|<code>Категория каталога</code>
|Категория каталога, с использованием которой путь становится доступным для применения в операциях ввода-вывода.

Возможные значения:

* <code>SYNC_COMMON</code> (<code>1</code>) – Каталог общих данных всех доменов в синхронизирующемся между серверами каталоге.
* <code>SYNC_DOMAIN_COMMON</code> (<code>2</code>) – Каталог общих данных домена в синхронизирующемся между серверами каталоге.
* <code>SYNC_DOMAIN_DATA</code> (<code>3</code>) – Каталог данных домена в синхронизирующемся между серверами каталоге.
* <code>SYNC_SCRIPT_DATA</code> (<code>4</code>) – Каталог данных сценария в синхронизирующемся между серверами.
* <code>SITESHARE_PUBLIC</code> (<code>5</code>) – Каталог общих данных на сетевом диске сайтового хранилища, доступного всем серверам на сайте.
* <code>SITESHARE_DOMAIN_DATA</code> (<code>6</code>) – Каталог данных домена на сетевом диске сайтового хранилища, доступного всем серверам на сайте.
* <code>SITESHARE_SCRIPT_DATA</code> (<code>7</code>) – Каталог данных сценария на сетевом диске сайтового хранилища, доступного всем серверам на сайте.
* <code>GLOBALSHARE_PUBLIC</code> (<code>8</code>) – Каталог общих данных на сетевом диске глобального хранилища, доступного всем сайтам.
* <code>GLOBALSHARE_DOMAIN_DATA</code> (<code>9</code>) – Каталог данных домена на сетевом диске глобального хранилища, доступного всем сайтам.
* <code>GLOBALSHARE_SCRIPT_DATA</code> (<code>10</code>) – Каталог данных сценария на сетевом диске глобального хранилища, доступного всем сайтам.
* <code>TEMP</code> (<code>11</code>) – Временный каталог текущего обработчика сценария. Удаляется через 5 секунд после его завершения.
|-
|<code>Относительный путь</code>
|Аргумент, содержащий относительный путь.
|-
|<code>Имя файла</code>
|Аргумент, содержащий название файла.
|-
|<code>Расширение</code>
|Аргумент, содержащий расширение файла.
|-
|<code>Путь источника</code>
|Аргумент, содержащий путь источника.
|-
|<code>Путь назначения</code>
|Аргумент, содержащий путь назначения.
|-
|<code>Хеш-функция</code>
|Хеш-функция для применения к содержимому файла.
|-
|<code>Содержимое</code>
|Аргумент с содержимым файла.
|-
|<code>Кодировка</code>

|Кодировка для применения к содержимому файла при считывании в переменную и наоборот.

Возможные значения:

* <code>Авто</code> (<code>1</code>) – Автоматическое определение.
* <code>Бинарные данные</code> (<code>binary</code>, <code>2</code>) – Считывание бинарных данных без преобразования.
* <code>utf-8</code> (<code>3</code>)
* <code>utf-16</code> (<code>4</code>)
* <code>utf-32</code> (<code>5</code>)
* <code>cp1251</code> (<code>6</code>) – Кодовая страница <code>windows-1251</code> (кириллица).
* <code>Указать название</code> (<code>byname</code>, <code>7</code>) – Указание имени кодировки.
|-
|<code>BOM</code>
|Режим считывания содержания файла с учетом префикса кодировки для UTF.

Возможные варианты:

* <code>С BOM</code> (<code>withBOM</code>, <code>1</code>).
* <code>Без BOM</code> (<code>withoutBOM</code>, <code>2</code>).
|-
|<code>Endian</code>
|Режим раскладки кодировки unicode.

Возможные варианты:

* <code>Little-Endian</code> (<code>littleEndian</code>, <code>1</code>).
* <code>Big-Endian</code> (<code>bigEndian</code>, <code>2</code>).
|-
|<code>Название кодировки</code>
|Аргумент, содержащий имя применяемой кодировки.
|}

=== SQL-Запрос ===
[[Файл:Компонент SQL-запрос.png|центр|безрамки|499x499пкс]]

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

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

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

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

Возврат значений из БД происходит в табличном виде. Сохранение значений в переменные осуществляется по принципу идентичности имен столбцов в последнем из вернувшихся датасетов и переменных сценария. Переменным присваиваются значения из последней строки последнего датасета.
{| class="wikitable"
|+Свойства компонента
!Свойства
!Описание
|-
|<code>База Данных</code>

|БД для подключения.

Возможные варианты:

* <code>Проектная</code> (<code>project_psql</code>, <code>4</code>) – Проектная БД домена (PosgtreSQL), строка подключения к которой берется из настроек домена (<code>settings → project_postgresql_connstr</code>).
* <code>Другая</code> (<code>other</code>, <code>2</code>) – Другая БД.
|-
|<code>Драйвер</code>
|Возможные варианты:

* <code>ODBC</code> (<code>odbc</code>, <code>0</code>) – подключение через драйвер ODBC.
* <code>PSQL</code> (<code>psql</code>, <code>1</code>) – подключение через внутренний адаптер к PostgreSQL.

Для режима указания БД <code>Другая</code>.
|-
|<code>Строка соединения</code>
|Строка подключения к БД.

Для режима указания БД <code>Другая</code>.

Пример для 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
|-
|<code>Время, с</code>
|Таймаут на выполнение запроса к БД.
|-
|<code>Запрос</code>
|Тело 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 преобразуются в строковое представление при сохранении в переменные сценария.
|-
|<code>Параметры запроса</code>
|Списочное значение, устанавливающее параметры для запроса.

Порядок параметров строго соответствует порядку применения параметров в запросе.
|-
|<code>Кодировка</code>

|Кодировка, в которой следует сохранить строковые значения в переменных.

Возможные варианты:

* <code>utf-8</code> (<code>1</code>)
* <code>cp1251</code> (<code>2</code>) – Кодовая страница <code>windows-1251</code> (кириллица)
|-
|<code>Код ошибки</code>
|Переменная для сохранения кода ошибки.
|}


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

 Предыдущая статья курса: [[Базовые компоненты и логика построения сценариев]]
[[Категория:Курс "Разработка приложений"]]