# Справка: процессы

# Тип блока ask

Позволяет запросить общую для всех файлов дополнительную информацию во время сабмита. Код сабмита может получить эту информацию следующим образом:

const shared_state = await window.imshost.getProcessSharedState();
const vals = shared_state[bname] // bname - имя блока, который запрашивал информацию
// vals - объект с внесенными значениями

Параметры:

  • properties - массив запрашиваемых свойств (см. раздел Справка: генерация форм)
  • rememberLast - нужно ли запоминать последние введенные значения

Выходы:

  • next - данные внесены
  • cancel - пользователь отменил ввод

# Тип блока attempt

Позволяет повторять заданные действия не более N раз.

Параметры:

  • num - количество попыток
  • failMessage - текст ошибки, если попытки кончились

Выходы:

  • next - попытки еще не кончились
  • fail - попытки уже кончились

# Тип блока batch

Ожидает другие файлы, пока их количество не достигнет заданного количества

Параметры:

  • num - количество файлов, которое нужно накопить. Если не задано, то ожидает все файлы

Выходы:

  • next - файлы накоплены

# Тип блока browserAuth

Позволяет выполнить авторизацию на сайте микростока. Сначала происходит попытка открыть целевую страницу (targetPage). Если страница открывается, то блок пропускает файлы. Если не открывается, то страница меняется на страницу входа (loginPage) и пользователю отображается окно браузера для ввода своих данных. После заполнения формы, как только пользователь оказывается на целевой странице (targetPage) или его адрес попадает под маску (targetPageMask), файлы проходят дальше

Параметры:

  • destination - служебное имя микростока, к которому относится форма входа
  • targePage - адрес целевой страницы
  • targetPageMask - маска адреса целевой страницы. Пропуск в маске помечается *
  • loginPage - адрес страницы входа
  • forceLogin - если true, то браузер сразу будет открываться на странице логина без попытки открыть целевую

Выходы:

  • next - авторизация пройдена
  • cancel - отмена пользователем

# Тип блока browserSubmit

При активации блока в скрытом браузере открывется целевая страница targetPage и вызываеися код submitCode.

Параметры:

  • targePage - адрес целевой страницы
  • submitCode - выполняемый на целевой странице код
  • destination - служебное имя микростока, в рамках которого осуществляется сабмит
  • connection - служебное имя FTP-соединения, использованного при загрузке файлов
  • dictionaries - словарь, который передается в код submitCode
  • marker - добавляемый после успешного прохождения статус. Если null, то статус не добавляется

Выходы:

  • next - сабмит выполнен
  • unauthorized - пользователь не авторизован
  • notfound - файл на микростоке не найден
  • fail - ошибка обработки файла

# Тип блока confirm

Позволят спросить пользователя, уверен, ли он, что хочет продолжить

Параметры:

  • message - текст вопроса
  • yesCaption - изменить текст кнопки "Да"
  • noCaption - изменить текст кнопки "Нет"
  • withCancel - отобразить кнопку "Отмена"
  • cancelCaption - измененить текст кнопки "Отмена"
  • danger - пометить, что действие потенциально опасно (кнопка "Да" будет красной)

Выходы:

  • yes - выбрано "Да"
  • no - выбрано "Нет"
  • cancel - выбрано "Отмена"

# Тип блока delay

Задержка перед выполнением следующего блока

Параметры:

  • delay - размер задержки в секундах
  • range - разброс задержки в секундах (для разных файлов будет разное время задержки в пределах +-range)

Выходы:

  • next - переход дальше после задержки

# Тип блока metadataFilter

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

Параметры:

  • filter - условие фильтрации. Либо строка (одно условие), либо массив
  • failMessage - если задано, то при провале проверки файлу будет назначен заданный текст ошибки. Либо одна строка (общая ошибка на все условия), либо массив - разные ошибки на разные условия (первое условие - первый текст ошибки, второе условие - второй текст ошибки и т.д.)

Выходы:

  • next - файл попадает под все условия
  • fail - файл не попадает хотя бы под одно условие

# Тип блока runCommand

Выполнить команду над попавшими в блок файлами в приложении IMS Studio.

Параметры:

  • command - наименование команды
  • commandParameter - дополнительный параметр команды

Выходы:

  • next - команда выполнена
  • fail - произошла ошибка при выполнении команды

# Тип блока upload

Загрузка файлов, используя заданное FTP-соединение.

Параметры:

  • connection - служебное имя FTP-соединения
  • skipAlreadyUploaded - пропустить уже загруженные (проверка по статусу файла)

Выходы:

  • next - файл успешно загружен
  • fail - произошла ошибка во время загрузки
  • reject - файл не подходит под требования FTP-соединения
  • cancel - пользователь отменил загрузку во время данных для входа

# Тип блока uploadCheck

Проверка загружены ли файлы на заданный микросток. Проверка по статусу файла

Параметры:

  • destination - служебное имя микростока

Выходы:

  • next - файл еще не загружен
  • skip - файл уже загружен