Конвертер

Компонент для преобразования данных и файлов из одного формата в другой. Позволяет генерировать PDF из HTML или DOCX, конвертировать Excel в JSON, преобразовывать XML в JSON и выполнять другие операции с файлами.

Компонент Конвертер

Когда использовать

Используйте Конвертер, когда нужно изменить формат данных для дальнейшей обработки или интеграции. Типичные примеры:

• Сгенерировать PDF-счёт из HTML-шаблона

• Преобразовать загруженный Excel-файл в JSON для анализа

• Сконвертировать DOCX-договор в PDF для отправки клиенту

Настройка компонента

Секция «Общие свойства»

Секция «Источник данных»

Секция Источник данных

Вариант конвертации

Выберите тип преобразования:

Источник

Способ указания исходных данных:

Файл из записи
Принимает значение из поля типа «Файл» в записи Бипиума. Указанный файл будет сконвертирован.

• Каталог
  Список доступных каталогов для поиска записей. Формат: список каталогов.

• ID записи
  Идентификатор записи, в которой находится файл для конвертации.

  Формат: значение/выражение.

• Поле
  Идентификатор поля записи, в которой находится файл для конвертации.

URL к файлу
URL к файлу, который находится в открытом для системы доступе. Если вариант подразумевает использование шаблона, по ссылке должен находится он.

Содержимое
Поле для ввода содержимого к конвертации. В поле может храниться произвольная HTML-разметка (для варианта конвертации HTML → PDF) или буферные данные, на основе которых будет производиться конвертация.

Формат данных в поле – строка. Данные могут храниться в произвольных кавычках. Для использования переменных сценария в качестве встраиваемых значений используйте одинарные обратные кавычки «`». Пример заполнения поля HTML-разметки представлен ниже:

Секция «Параметры»

Секция Параметры

Данные можно вводить в формате «Ключ = значение» или в виде JSON-объекта.

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

В зависимости от варианта конвертации, поддерживаются следующие параметры:

HTML → PDF

XML → JSON

Формат значений

Позволяет выбрать способ передачи параметров конвертации. Возможные значения: Ключ = значение, JSON-объект.

Формат «ключ = значение»
Параметры передаются в виде Наименование параметра = Значение параметра

Формат «JSON — объект»
Параметры передаются в виде JSON-объекта.

В отличие от формата «Ключ-значение» этот формат может принимать в качестве ключа атрибута значение переменной:

{
    key1: value1,      // Ключ = значение
    key2: {            // Ключ с вложенным ключом
        key3: value3    
    },
    [key4]: value4     // Переменная в качестве ключа.
}

Секция «Результат»

В зависимости от выбранного варианта появляются дополнительные поля:

При выборе «Файл в запись»

При выборе «URL в переменную»

При выборе «Содержимое в переменную»

Формат результата

В зависимости от выбранного варианта конвертации результат сохраняется в разном формате.

HTML → PDF

Результатом является PDF-файл. В зависимости от выбранного способа сохранения:

• Файл в запись — файл сохраняется в указанное поле типа «Файл»

• URL в переменную — в переменную сохраняется ссылка на файл

• Содержимое в переменную — в переменную сохраняется буфер PDF-файла

DOCX → PDF

Результатом является PDF-файл. Формат результата аналогичен HTML → PDF.

Excel → JSON

Результатом будет объект, где ключи — названия листов Excel, а значения — массивы с данными строк. Каждая строка представлена в виде объекта, где ключи — буквы колонок (A, B, C и т.д.), а значения — содержимое ячеек.

{
  "Лист1": [
    { "A": "ячейка А1", "B": "ячейка B1", "C": "ячейка C1" },
    { "A": "ячейка А2", "B": "ячейка B2", "C": "ячейка C2" }
  ],
  "Лист2": [
    { "A": "ячейка А1", "C": "ячейка C1" },
    { "A": "ячейка А2", "B": "ячейка B2", "C": "ячейка C2" }
  ]
}

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

XML → JSON

Результатом будет JSON-объект, построенный из структуры XML-документа.

Пример XML:

<CAT>
  <NAME>Izzy</NAME>
  <BREED>Siamese</BREED>
  <AGE>6</AGE>
  <ALTERED>yes</ALTERED>
  <DECLAWED>no</DECLAWED>
  <LICENSE>Izz138bod</LICENSE>
  <OWNER>Colin Wilcox</OWNER>
</CAT>

Результат конвертации:

{
  "CAT": {
    "NAME": "Izzy",
    "BREED": "Siamese",
    "AGE": "6",
    "ALTERED": "yes",
    "DECLAWED": "no",
    "LICENSE": "Izz138bod",
    "OWNER": "Colin Wilcox"
  }
}

Пограничные события

Компонент поддерживает 2 типа пограничных событий:

• Ошибка — выход из компонента, если произошла какая-либо ошибка

• Таймаут — выход из компонента, спустя заданное ограничение по времени

Если компонент завершился с ошибкой, но на нем не было пограничного события, то процесс завершается. Сообщение ошибки возвращается в результатах процесса.