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

Материал из razgovorov.ru
Перейти к: навигация, поиск
Строка 18: Строка 18:
 
# Данный шаг выполняется при условии, что все ссылки во вложениях проставлены. Документ готов к обработке плагином. Выполняется запись документа через СБИС.ЗаписатьДокумент и производится выполнение этапа документа оборота, если таковое имеется: СБИС.ПодготовитьДействие и СБИС.ВыполнитьДействие.  
 
# Данный шаг выполняется при условии, что все ссылки во вложениях проставлены. Документ готов к обработке плагином. Выполняется запись документа через СБИС.ЗаписатьДокумент и производится выполнение этапа документа оборота, если таковое имеется: СБИС.ПодготовитьДействие и СБИС.ВыполнитьДействие.  
 
## При успешном выполнении данных операции плагин пробрасывает сообщение с итоговым объектом документ, содержащее содержащее qyeryId вызванного изначально метода WriteDocumentEx.
 
## При успешном выполнении данных операции плагин пробрасывает сообщение с итоговым объектом документ, содержащее содержащее qyeryId вызванного изначально метода WriteDocumentEx.
−
 
+
##* Событие: объект
 +
##:: ИдВыполняемогоМетода: строка - ИдентификаторМетодаВПлагине
 +
##:: Документ: объект - итоговый объект документ
 
## В случае ошибки плагин выдает сообщение с ошибкой, содержащее qyeryId вызванного изначально метода WriteDocumentEx. Обработка документа плагином немедленно завершается.  
 
## В случае ошибки плагин выдает сообщение с ошибкой, содержащее qyeryId вызванного изначально метода WriteDocumentEx. Обработка документа плагином немедленно завершается.  
−
{ ключи: значение,
+
##* Событие: объект
 +
##:: ИдВыполняемогоМетода: строка - ИдентификаторМетодаВПлагине
 +
##:: Ошибка: строка - сообщение об ошибке
 
    
 
    
−
# Если в документе есть данные подлежащие загрузке на СБИС.Диск, то метод запускает загрузку всех файлов и пробрасывает исключение "#ASYNC и кодом 308"
 
−
# Если последнее обновление документа было больше чем секунду назад, то пробрасывается событие в ВО
 
−
#* Объект{
 
−
#:: { L"QueryId", Идентификатор запроса в плагин },
 
−
#:: { L"ProcentLoading", Процент загрузки }
 
−
#: }
 
−
# Если документ загружен на 100 процентов, то пробрасывается событие окончания с итоговым объектом документ.
 
−
#* Объект{
 
−
#:: { L"QueryId", Идентификатор запроса в плагин },
 
−
#:: { L"ResultDocument", [[Документ_-_Объект_ExtSdk2|объект Документ]]}
 
−
#: }
 
−
# Если процесс загрузки файлов сгенерировал ошибку, то пробрасывается событие с объектом ошибки
 
−
#* Объект{
 
−
#:: { L"QueryId", Идентификатор запроса в плагин },
 
−
#:: { L"Error", Текст ошибки }
 
−
#: }
 
 
== Параметры ==
 
== Параметры ==
 
* {{Шаблон:ApiParam|Document|1|объект| [[Документ_-_Объект_ExtSdk2|объект Документ]]}}
 
* {{Шаблон:ApiParam|Document|1|объект| [[Документ_-_Объект_ExtSdk2|объект Документ]]}}

Версия 11:02, 16 февраля 2021

Описание

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

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

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

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

Параметры

Результат

Исключения

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

Запрос

Ответ

Источник — «http://wiki.razgovorov.ru/index.php?title=WriteDocumentEx_-_Расширенный_метод_создания_и_отправки_документа_(ExtSdk2)&oldid=4991»