WriteDocumentEx - Расширенный метод создания и отправки документа (ExtSdk2)

Материал из razgovorov.ru
Перейти к: навигация, поиск

Описание

Метод позволяет за один вызов записать и запустить документооборот по документу.

Алгоритм работы

Асинхронная загрузка файлов в WriteDocumentEx.

  1. Метод принимает на вход объект Документ с массивом вложений вида объект Файл со свойствами: Путь к файлу, Строка, Двоичные данные, Ссылка, Обработчики. Дополнительные данные по текущим свойствам см.метод WriteDocument.
  2. Метод проверяет наличие вложений, не имеющих свойства Ссылка.
    1. Если в объекте Документ все вложения в объекте файл содержат свойство Ссылка:
      1. Выполняется запись документа через СБИС.ЗаписатьДокумент.
      2. Производится выполнение этапа документа оборота, если таковое имеется: СБИС.ПодготовитьДействие и СБИС.ВыполнитьДействие.
      3. Возвращается результат работы метода с итоговым объектом документ
    2. Если в объекте Документ не все вложения в объекте имеют свойство Ссылка, то метод возвращает ошибку с текстом #ASYNC и кодом 308, обозначающую, что нужно подождать сообщение от плагина. Плагин загружает вложения на СБИС.Диск и заменяет во всех Вложениях в объекте Файл текущие свойства( Двоичные данные, Путь к файлу, Строка ) на Ссылка.
      1. Во время данного этапа возможны сообщения от плагина о проценте загрузки данных вложений, содержащее qyeryId вызванного изначально метода WriteDocumentEx, чтобы можно было увидеть текущий прогресс.
        • Событие: объект
        ИдВыполняемогоМетода: строка - ИдентификаторМетодаВПлагине
        ПроцентЗагрузки: строка - ПроцентЗагрузкиВложений
      2. В случае ошибки плагин выдает сообщение с ошибкой, содержащее qyeryId вызванного изначально метода WriteDocumentEx. Обработка документа плагином немедленно завершается.
        • Событие: объект
        ИдВыполняемогоМетода: строка - ИдентификаторМетодаВПлагине
        Ошибка: строка - сообщение об ошибке
  3. Данный шаг выполняется при условии, что все ссылки во вложениях проставлены. Документ готов к обработке плагином.
    1. Выполняется запись документа через СБИС.ЗаписатьДокумент.
    2. Производится выполнение этапа документа оборота, если таковое имеется: СБИС.ПодготовитьДействие и СБИС.ВыполнитьДействие.
    3. При успешном выполнении данных операции плагин пробрасывает сообщение с итоговым объектом документ, содержащее содержащее qyeryId вызванного изначально метода WriteDocumentEx.
      • Событие: объект
      ИдВыполняемогоМетода: строка - ИдентификаторМетодаВПлагине
      Документ: объект - итоговый объект документ
    4. В случае ошибки плагин выдает сообщение с ошибкой, содержащее qyeryId вызванного изначально метода WriteDocumentEx. Обработка документа плагином немедленно завершается.
      • Событие: объект
      ИдВыполняемогоМетода: строка - ИдентификаторМетодаВПлагине
      Ошибка: строка - сообщение об ошибке


Асинхронная загрузка файлов в WriteDocumentEx.

  1. Принимае на вход объект Документ с массивом вложений вида объект Файл со свойствами: Путь к файлу, Строка, Двоичные данные, Ссылка, Обработчики. Дополнительные данные по текущим свойствам см.метод WriteDocument.
  2. Проверяем вложения на наличие Ссылок
    1. Если во всех вложениях ссылки проставлены, то:
      1. Выполняем СБИС.ЗаписатьДокумент.
      2. Если необходимо действие для документа, то выполняем: СБИС.ПодготовитьДействие и СБИС.ВыполнитьДействие.
    1. Если во вложениях проставлены не все ссылки, то возвращаем ошибку с текстом "#ASYNC" и кодом 308. Она обозначает, что плагин сам проставит недостающие ссылки. Необходимо подождать.
      1. Во время данного этапа возможны сообщения от плагина о проценте обработки недостающих ссылок.
        • Событие: объект
        ИдВыполняемогоМетода: строка - Идентификатор метода в плагине
        ПроцентЗагрузки: строка - Процент загрузки вложений
      2. В случае ошибки плагин выдает сообщение с ошибкой. Обработка документа плагином немедленно завершается.
        • Событие: объект
        ИдВыполняемогоМетода: строка - Идентификатор метода в плагине
        Ошибка: строка - Сообщение об ошибке
  3. Данный шаг выполняется при условии, что все ссылки во вложениях проставлены. Документ готов к обработке плагином.
    1. Выполняется запись документа через СБИС.ЗаписатьДокумент.
    2. Производится выполнение этапа документа оборота, если таковое имеется: СБИС.ПодготовитьДействие и СБИС.ВыполнитьДействие.
    3. При успешном выполнении данных операции плагин пробрасывает сообщение с итоговым объектом документ, содержащее содержащее qyeryId вызванного изначально метода WriteDocumentEx.
      • Событие: объект
      ИдВыполняемогоМетода: строка - ИдентификаторМетодаВПлагине
      Документ: объект - итоговый объект документ
    4. В случае ошибки плагин выдает сообщение с ошибкой, содержащее qyeryId вызванного изначально метода WriteDocumentEx. Обработка документа плагином немедленно завершается.
      • Событие: объект
      ИдВыполняемогоМетода: строка - ИдентификаторМетодаВПлагине
      Ошибка: строка - сообщение об ошибке

Параметры

Результат

Исключения

Пример успешного вызова

Запрос

Ответ