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

Материал из razgovorov.ru
Перейти к: навигация, поиск
Строка 25: Строка 25:
 
## Если во вложениях проставлены не все ссылки, то возвращаем ошибку с текстом "#ASYNC" и кодом 308.  См. "Исключения" №1. Она обозначает, что плагин сам проставит недостающие ссылки. Необходимо подождать.
 
## Если во вложениях проставлены не все ссылки, то возвращаем ошибку с текстом "#ASYNC" и кодом 308.  См. "Исключения" №1. Она обозначает, что плагин сам проставит недостающие ссылки. Необходимо подождать.
 
### Во время данного этапа возможны сообщения от плагина о проценте обработки вложений.
 
### Во время данного этапа возможны сообщения от плагина о проценте обработки вложений.
###: {{Шаблон:ApiParam|QueryId||строка| Идентификатор запроса в плагин}}
+
###* {{Шаблон:ApiParam|QueryId||строка| Идентификатор запроса в плагин}}
###: {{Шаблон:ApiParam|ProcentLoading||строка| Процент загрузки документа}}
+
###* {{Шаблон:ApiParam|ProcentLoading||строка| Процент загрузки документа}}
 
### В случае ошибки плагин выдает соответствующее сообщение. Обработка документа плагином немедленно завершается. См. "Исключения" №2
 
### В случае ошибки плагин выдает соответствующее сообщение. Обработка документа плагином немедленно завершается. См. "Исключения" №2
 
# Данный шаг выполняем при условии, что все ссылки во вложениях проставлены. Документ готов к обработке плагином.  
 
# Данный шаг выполняем при условии, что все ссылки во вложениях проставлены. Документ готов к обработке плагином.  

Версия 08:02, 18 февраля 2021

Описание

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

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

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

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


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

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

Параметры

Результат

Исключения

  1. Сообщение об ошибке с текстом "#ASYNC" и кодом 308
  2. Сообщение об ошибке с QueryID
    QueryId (строка) - Идентификатор запроса в плагин
    Error (строка) - Сообщение об ошибке

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

Запрос

Ответ