Интеграция с 1С документооборот базовая функциональность

ВыполнитьЗапросАсинхронно

Описание, пример вызова

// Выполняет запрос к сервису 1С:Документооборот в фоновом задании.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   Запрос - ОбъектXDTO - выполняемый запрос.
//   УникальныйИдентификатор - УникальныйИдентификатор - уникальный идентификатор формы, из которой выполняется запрос.
//   НаименованиеФоновогоЗадания - Строка - представление длительной операции, которое будет выведено в интерфейс.
//
// Возвращаемое значение:
//   см. ДлительныеОперации.ВыполнитьВФоне
//
Функция ВыполнитьЗапросАсинхронно(Прокси, Запрос, УникальныйИдентификатор, НаименованиеФоновогоЗадания = "") Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ВыполнитьЗапросАсинхронно(Прокси, Запрос, УникальныйИдентификатор, НаименованиеФоновогоЗадания);

ВыполнитьЗапросВФоне

Описание, пример вызова

// Выполняет запрос к сервису 1С:Документооборот из фонового задания.
//
// Параметры:
//   Параметры - Структура:
//     * ИнтеграцияС1СДокументооборотWSОпределения - ХранилищеЗначения
//     * ИнтеграцияС1СДокументооборотВерсияСервиса - Строка
//     * ИнтеграцияС1СДокументооборотИмяПользователя - Строка
//     * ИнтеграцияС1СДокументооборотИспользуетсяАутентификацияJWT - Булево
//     * ИнтеграцияС1СДокументооборотИспользуетсяАутентификацияОС - Булево
//     * ИнтеграцияС1СДокументооборотМестоположениеПрокси - Строка
//     * ИнтеграцияС1СДокументооборотПароль - Строка
//     * ИнтеграцияС1СДокументооборотПарольИзвестен - Булево
//     * ЗапросСтрока - Строка
//   АдресХранилища - Строка - адрес хранилища, куда будет помещен результат запроса.
//
Процедура ВыполнитьЗапросВФоне(Параметры, АдресХранилища) Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ВыполнитьЗапросВФоне(Параметры, АдресХранилища)

ВыполнитьПакетныйЗапросАсинхронно

Описание, пример вызова

// Выполняет пакетный запрос к сервису 1С:Документооборот в фоновом задании.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   Запросы - Массив из ОбъектXDTO - запросы пакета.
//   УникальныйИдентификатор - УникальныйИдентификатор - уникальный идентификатор формы, из которой выполняется запрос.
//   НаименованиеФоновогоЗадания - Строка - представление длительной операции, которое будет выведено в интерфейс.
//   ПроверятьПодчиненные - Булево - указывает требуется ли проверять результаты запросов, входящих в пакет.
//
// Возвращаемое значение:
//   см. ДлительныеОперации.ВыполнитьВФоне
//
Функция ВыполнитьПакетныйЗапросАсинхронно(Прокси, Запросы, УникальныйИдентификатор, НаименованиеФоновогоЗадания = "", Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ВыполнитьПакетныйЗапросАсинхронно(Прокси, Запросы, УникальныйИдентификатор, НаименованиеФоновогоЗадания, );

ВыполнитьПакетныйЗапросВФоне

Описание, пример вызова

// Выполняет запрос к сервису 1С:Документооборот из фонового задания.
//
// Параметры:
//   Параметры - Структура:
//     * ИнтеграцияС1СДокументооборотWSОпределения - ХранилищеЗначения
//     * ИнтеграцияС1СДокументооборотВерсияСервиса - Строка
//     * ИнтеграцияС1СДокументооборотИмяПользователя - Строка
//     * ИнтеграцияС1СДокументооборотИспользуетсяАутентификацияJWT - Булево
//     * ИнтеграцияС1СДокументооборотИспользуетсяАутентификацияОС - Булево
//     * ИнтеграцияС1СДокументооборотМестоположениеПрокси - Строка
//     * ИнтеграцияС1СДокументооборотПароль - Строка
//     * ИнтеграцияС1СДокументооборотПарольИзвестен - Булево
//     * ЗапросыСтрока - Массив из Строка
//     * ПроверятьПодчиненные - Булево
//   АдресХранилища - Строка - адрес хранилища, куда будет помещен результат запроса.
//
Процедура ВыполнитьПакетныйЗапросВФоне(Параметры, АдресХранилища) Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ВыполнитьПакетныйЗапросВФоне(Параметры, АдресХранилища)

ЗаписатьОбъектВФоне

Описание, пример вызова

// Записывает изменения объекта в Документообороте в фоновом задании.
//
// Параметры:
//   Параметры - Структура:
//     * ИнтеграцияС1СДокументооборотWSОпределения - ХранилищеЗначения
//     * ИнтеграцияС1СДокументооборотВерсияСервиса - Строка
//     * ИнтеграцияС1СДокументооборотИмяПользователя - Строка
//     * ИнтеграцияС1СДокументооборотИспользуетсяАутентификацияJWT - Булево
//     * ИнтеграцияС1СДокументооборотИспользуетсяАутентификацияОС - Булево
//     * ИнтеграцияС1СДокументооборотМестоположениеПрокси - Строка
//     * ИнтеграцияС1СДокументооборотПароль - Строка
//     * ИнтеграцияС1СДокументооборотПарольИзвестен - Булево
//     * ОбъектСтрока - Строка - строковое предствление объекта XDTO с сохраняемыми данными.
//   АдресХранилища - Строка - адрес хранилища, куда будет помещен результат запроса.
//
Процедура ЗаписатьОбъектВФоне(Параметры, АдресХранилища) Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗаписатьОбъектВФоне(Параметры, АдресХранилища)

ОбъектXDTOВСтроку

Описание, пример вызова

// Преобразует объект XDTO из пространства имен "HTTP://www.1c.ru/dm" в строку.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   ОбъектXDTO - ОбъектXDTO - объект XDTO xml представление которого требуется получить.
//
// Возвращаемое значение:
//   Строка
//
Функция ОбъектXDTOВСтроку(Прокси, ОбъектXDTO) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ОбъектXDTOВСтроку(Прокси, ОбъектXDTO)

ПараметрыДлительнойОперации

Описание, пример вызова

// Возвращает структуру параметров для обращения к сервису 1С:Документооборот в фоновом задании.
//
// Параметры:
//   ИспользоватьКэш - Булево - при проверке возможности авторизации без пароля не требуется использовать кэш.
//
// Возвращаемое значение:
//   Структура:
//     * ИнтеграцияС1СДокументооборотWSОпределения - ХранилищеЗначения
//     * ИнтеграцияС1СДокументооборотВерсияСервиса - Строка
//     * ИнтеграцияС1СДокументооборотИмяПользователя - Строка
//     * ИнтеграцияС1СДокументооборотИспользуетсяАутентификацияJWT - Булево
//     * ИнтеграцияС1СДокументооборотИспользуетсяАутентификацияОС - Булево
//     * ИнтеграцияС1СДокументооборотМестоположениеПрокси - Строка
//     * ИнтеграцияС1СДокументооборотПароль - Строка
//     * ИнтеграцияС1СДокументооборотПарольИзвестен - Булево
//
Функция ПараметрыДлительнойОперации(ИспользоватьКэш = Истина) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПараметрыДлительнойОперации(ИспользоватьКэш);

ПодключитьсяИПолучитьВерсиюСервисаВФоне

Описание, пример вызова

// Выполняет подключение к сервису 1С:Документооборот из фонового задания, и делает запрос версии сервиса.
//
// Параметры:
//   Параметры - см. ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПараметрыДлительнойОперации
//   АдресХранилища - Строка - адрес хранилища, куда будет помещен результат запроса.
//
Процедура ПодключитьсяИПолучитьВерсиюСервисаВФоне(Параметры, АдресХранилища = "") Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПодключитьсяИПолучитьВерсиюСервисаВФоне(Параметры, АдресХранилища);

ПолучитьОбъектВФоне

Описание, пример вызова

// Получает объект из Документооборота в фоновом задании.
//
// Параметры:
//   Параметры - Структура:
//     * ИнтеграцияС1СДокументооборотWSОпределения - ХранилищеЗначения
//     * ИнтеграцияС1СДокументооборотВерсияСервиса - Строка
//     * ИнтеграцияС1СДокументооборотИмяПользователя - Строка
//     * ИнтеграцияС1СДокументооборотИспользуетсяАутентификацияJWT - Булево
//     * ИнтеграцияС1СДокументооборотИспользуетсяАутентификацияОС - Булево
//     * ИнтеграцияС1СДокументооборотМестоположениеПрокси - Строка
//     * ИнтеграцияС1СДокументооборотПароль - Строка
//     * ИнтеграцияС1СДокументооборотПарольИзвестен - Булево
//     * Тип - Строка
//     * ID - Строка
//     * Колонки - Массив из Строка - необязательно, состав заполняемых колонок.
//               - Строка - если список колонок разделен через запятую.
//     * ПравилоИнтеграции - СправочникСсылка.ПравилаИнтеграцииС1СДокументооборотом3 - правило интеграции для
//         заполнения объекта ИС.
//     * ВнешнийОбъектИС - ЛюбаяСсылка - передается для заполнения свойства externalObject.
//   АдресХранилища - Строка - адрес хранилища, куда будет помещен результат запроса.
//
Процедура ПолучитьОбъектВФоне(Параметры, АдресХранилища) Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПолучитьОбъектВФоне(Параметры, АдресХранилища)

ПолучитьПроксиВФоне

Описание, пример вызова

// Создает прокси веб-сервиса Документооборота в фоновом задании, с настройками, переданными напрямую.
//
// Параметры:
//   Параметры - Структура:
//     * ИнтеграцияС1СДокументооборотWSОпределения - ХранилищеЗначения
//     * ИнтеграцияС1СДокументооборотВерсияСервиса - Строка
//     * ИнтеграцияС1СДокументооборотИмяПользователя - Строка
//     * ИнтеграцияС1СДокументооборотИспользуетсяАутентификацияJWT - Булево
//     * ИнтеграцияС1СДокументооборотИспользуетсяАутентификацияОС - Булево
//     * ИнтеграцияС1СДокументооборотМестоположениеПрокси - Строка
//     * ИнтеграцияС1СДокументооборотПароль - Строка
//     * ИнтеграцияС1СДокументооборотПарольИзвестен - Булево
//
// Возвращаемое значение:
//   WSПрокси - прокси веб-сервиса Документооборота.
//   Неопределено - в случае, если прокси веб-сервиса получить не удалось.
//
Функция ПолучитьПроксиВФоне(Параметры) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПолучитьПроксиВФоне(Параметры)

СтрокаВОбъектXDTO

Описание, пример вызова

// Преобразует строку в объект XDTO из пространства имен "HTTP://www.1c.ru/dm".
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   Строка - Строка - xml представление объекта XDTO.
//
// Возвращаемое значение:
//   ОбъектXDTO
//
Функция СтрокаВОбъектXDTO(Прокси, Строка) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.СтрокаВОбъектXDTO(Прокси, Строка)

ВыполнитьОбменДанными

Описание, пример вызова

// Выполняет обмен данными с 1С:Документооборотом по правилам интеграции.
//
Процедура ВыполнитьОбменДанными() Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ВыполнитьОбменДанными()

АдресВебСервиса1СДокументооборот

Описание, пример вызова

// Получает адрес публикации веб-сервиса Документооборот.
//
// Возвращаемое значение:
//   Строка - адрес сервиса.
//
Функция АдресВебСервиса1СДокументооборот() Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.АдресВебСервиса1СДокументооборот()

ВерсияСервиса

Описание, пример вызова

// Получает версию сервиса из параметров сеанса.
//
// Возвращаемое значение:
//   Строка - версия сервиса.
//
Функция ВерсияСервиса() Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ВерсияСервиса()

ВыполнитьЗапрос

Описание, пример вызова

// Выполняет запрос к сервису, превращая сообщения об ошибках в вид, понятный пользователю.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   Запрос - ОбъектXDTO - выполняемый запрос.
//
// Возвращаемое значение:
//   ОбъектXDTO - результат выполнения запроса.
//
Функция ВыполнитьЗапрос(Прокси, Запрос) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ВыполнитьЗапрос(Прокси, Запрос)

ВыполнитьПакетныйЗапрос

Описание, пример вызова

// Выполняет пакет запросов к сервису Документооборота.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   Запросы - Массив из ОбъектXDTO - запросы пакета.
//   ПроверятьПодчиненные - Булево - указывает требуется ли проверять результаты запросов, входящих в пакет.
//
// Возвращаемое значение:
//   ОбъектXDTO - объект XDTO типа DMBatchResponse.
//
Функция ВыполнитьПакетныйЗапрос(Прокси, Запросы, ПроверятьПодчиненные = Ложь) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ВыполнитьПакетныйЗапрос(Прокси, Запросы, ПроверятьПодчиненные);

ДобавитьСтрокуИнвертируемыхКонстант

Описание, пример вызова

// Добавляет строку инвертируемых констант в таблицу зависимости констант.
//
// Параметры:
//   ТаблицаКонстант - см. ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗависимостиКонстант
//   ИмяРодительскойКонстанты - Строка - имя родительской константы как оно задано в конфигураторе.
//   ИмяПодчиненнойКонстанты - Строка - имя подчиненной константы как оно задано в конфигураторе.
//
Процедура ДобавитьСтрокуИнвертируемыхКонстант(ТаблицаКонстант, ИмяРодительскойКонстанты, Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ДобавитьСтрокуИнвертируемыхКонстант(ТаблицаКонстант, ИмяРодительскойКонстанты, );

ДобавитьСтрокуСоответствияТипов

Описание, пример вызова

// Добавляет строку в таблицу соответствия типов.
//
// Параметры:
//   Таблица - ТаблицаЗначений - таблица соответствия типов.
//   ИмяТипаXDTO - Строка - имя типа XDTO
//   ТипОбъектаИС - Тип - тип объекта ИС.
//
Процедура ДобавитьСтрокуСоответствияТипов(Таблица, ИмяТипаXDTO, ТипОбъектаИС) Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ДобавитьСтрокуСоответствияТипов(Таблица, ИмяТипаXDTO, ТипОбъектаИС)

ДобавитьСтрокуТаблицыЗависимостиКонстант

Описание, пример вызова

// Добавляет строку в таблицу зависимости констант.
//
// Параметры:
//   ТаблицаКонстант - см. ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗависимостиКонстант
//   ИмяРодительскойКонстанты - Строка - имя родительской константы как оно задано в конфигураторе
//   ЗначениеРодительскойКонстанты - Произвольный - значение родительской константы
//   ИмяПодчиненнойКонстанты - Строка - имя подчиненной константы как оно задано в конфигураторе
//   ЗначениеПодчиненнойКонстанты - Произвольный - значение подчиненной константы
//
Процедура ДобавитьСтрокуТаблицыЗависимостиКонстант(ТаблицаКонстант, ИмяРодительскойКонстанты, Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ДобавитьСтрокуТаблицыЗависимостиКонстант(ТаблицаКонстант, ИмяРодительскойКонстанты, );

ДопРеквизитПоИмени

Описание, пример вызова

// Возвращает ссылку на дополнительный реквизит по уникальному имени.
//
// Параметры:
//   ИмяДопРеквизита - Строка - см. ИнтеграцияС1СДокументооборотБазоваяФункциональность.ИмяДопРеквизита
//
// Возвращаемое значение:
//   ПланВидовХарактеристикСсылка.ДополнительныеРеквизитыИСведения
//
Функция ДопРеквизитПоИмени(ИмяДопРеквизита) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ДопРеквизитПоИмени(ИмяДопРеквизита)

ДоступенФункционалВерсииСервиса

Описание, пример вызова

// Получает доступность функционала версии web-сервиса Документооборота.
//
// Параметры:
//   ВерсияСервиса - Строка - версия web-сервиса Документооборота, содержащая требуемый функционал.
//   Оптимистично - Булево - признак необходимости вернуть Истина, если версия сервиса пока неизвестна.
//
// Возвращаемое значение:
//   Булево - Истина, если web-сервис Документооборота указанной версии доступен.
//
Функция ДоступенФункционалВерсииСервиса(ВерсияСервиса = "", Оптимистично = Ложь) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ДоступенФункционалВерсииСервиса(ВерсияСервиса, Оптимистично);

ЕстьПодсистемаДО2

Описание, пример вызова

// Определяет, встроены ли в конфигурации модули БИД, предназначенные для интеграции с 1С:Документооборотом редакции 2.
//
// Возвращаемое значение:
//   Булево
//
Функция ЕстьПодсистемаДО2() Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЕстьПодсистемаДО2()

ЕстьПодсистемаДО3

Описание, пример вызова

// Определяет, встроены ли в конфигурации модули БИД, предназначенные для интеграции с 1С:Документооборотом редакции 3.
//
// Возвращаемое значение:
//   Булево
//
Функция ЕстьПодсистемаДО3() Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЕстьПодсистемаДО3()

ЕстьУникальныйИдентификатор

Описание, пример вызова

// Проверяет значение на объектный тип, содержащий уникальный идентификатор.
//
// Параметры:
//   Значение - Произвольный - проверяемое значение.
//
// Возвращаемое значение:
//   Булево - Признак наличия у объекта уникального идентификатора.
//
Функция ЕстьУникальныйИдентификатор(Значение) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЕстьУникальныйИдентификатор(Значение)

ЗависимостиКонстант

Описание, пример вызова

// Возвращает таблицу, описывающую зависимость констант в конфигурации.
// Каждая строка таблицы означает:
// для родительской константы со значением Х допустимо только значение Y для подчиненной константы.
//
// Возвращаемое значение:
//   ТаблицаЗначений:
//     * ИмяРодительскойКонстанты - Строка
//     * ИмяПодчиненнойКонстанты - Строка
//     * ЗначениеРодительскойКонстанты - Произвольный
//     * ЗначениеПодчиненнойКонстанты - Произвольный
//
Функция ЗависимостиКонстант() Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗависимостиКонстант()

ЗаписатьОбъект

Описание, пример вызова

// Записывает изменения объекта в Документообороте.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   Объект - ОбъектXDTO - XDTO объект с сохраняемыми данными.
//
// Возвращаемое значение:
//   ОбъектXDTO - Объект XDTO типа DMUpdateResponse.
//
Функция ЗаписатьОбъект(Прокси, Объект) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗаписатьОбъект(Прокси, Объект)

ЗаписатьОбъекты

Описание, пример вызова

// Записывает изменения объектов в Документообороте.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   Объекты - Массив из ОбъектXDTO - массив XDTO объектов с сохраняемыми данными.
//
// Возвращаемое значение:
//   ОбъектXDTO - Объект XDTO типа DMUpdateResponse.
//
Функция ЗаписатьОбъекты(Прокси, Объекты) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗаписатьОбъекты(Прокси, Объекты)

ЗаписатьОбъектыЗапрос

Описание, пример вызова

// Возвращает запрос для записи изменений объектов в Документообороте.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   Объекты - Массив из ОбъектXDTO - массив XDTO объектов с сохраняемыми данными.
//
// Возвращаемое значение:
//   ОбъектXDTO - Объект XDTO типа DMUpdateRequest.
//
Функция ЗаписатьОбъектыЗапрос(Прокси, Объекты) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗаписатьОбъектыЗапрос(Прокси, Объекты)

ЗаписатьОшибку

Описание, пример вызова

// Записывает ошибку в ЖР.
//
// Параметры:
//   ТекстОшибки - Строка - текст ошибки.
//   СобытиеВторогоУровня - Строка - имя события, добавляемое через точку к имени события по умолчанию.
//
Процедура ЗаписатьОшибку(ТекстОшибки, СобытиеВторогоУровня = "") Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗаписатьОшибку(ТекстОшибки, СобытиеВторогоУровня);

ЗаписатьПредупреждение

Описание, пример вызова

// Записывает предупреждение в ЖР.
//
// Параметры:
//   ТекстПредупреждения - Строка - текст предупреждения.
//   СобытиеВторогоУровня - Строка - имя события, добавляемое через точку к имени события по умолчанию.
//
Процедура ЗаписатьПредупреждение(ТекстПредупреждения, СобытиеВторогоУровня = "") Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗаписатьПредупреждение(ТекстПредупреждения, СобытиеВторогоУровня);

ЗаполнитьЗначенияСвойствXDTO

Описание, пример вызова

// Заполняет свойства объекта-приемника по объекту-источнику.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   Приемник - ОбъектXDTO - заполняемый объект.
//   Источник - ОбъектXDTO - источник данных заполнения.
//
Процедура ЗаполнитьЗначенияСвойствXDTO(Прокси, Приемник, Источник) Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗаполнитьЗначенияСвойствXDTO(Прокси, Приемник, Источник)

ЗаполнитьОбъектXDTOИзОбъектногоРеквизита

Описание, пример вызова

// Заполняет объект XDTO (приемник) по реквизиту (источник).
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   Источник - ФормаКлиентскогоПриложения, Структура - содержит реквизиты или свойства,
//     по которым заполняется объект XDTO.
//   ИмяРеквизита - Строка - имя объектного реквизита источника.
//   Приемник - ОбъектXDTO - содержит заполняемое свойство.
//   ТипОбъектаXDTO - Строка - тип XDTO заполняемого свойства.
//   ЗаполнятьВсегда - Булево - признак заполнения, даже если объектный реквизит не заполнен.
//
Процедура ЗаполнитьОбъектXDTOИзОбъектногоРеквизита(Прокси, Источник, ИмяРеквизита, Приемник, Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗаполнитьОбъектXDTOИзОбъектногоРеквизита(Прокси, Источник, ИмяРеквизита, Приемник, );

ЗаполнитьОбъектныйРеквизит

Описание, пример вызова

// Заполняет объектный реквизит (приемник) по объекту XDTO (источник).
//
// Параметры:
//   Приемник - Произвольный - объект, содержащий реквизиты или свойства,
//     которые должны быть заполнены по свойству объекта XDTO.
//   Источник - ОбъектXDTO, СвойствоXDTO - объект XDTO или его свойство, по которому будет заполнен объектный реквизит.
//   ИмяРеквизита - Строка - имя объектного реквизита.
//   ЗаполнятьПредставление - Булево - признак необходимости заполнения реквизита представления
//     по свойству objectID.presentation.
//
Процедура ЗаполнитьОбъектныйРеквизит(Приемник, Источник, ИмяРеквизита, ЗаполнятьПредставление = Ложь) Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗаполнитьОбъектныйРеквизит(Приемник, Источник, ИмяРеквизита, ЗаполнятьПредставление);

ЗаполнитьПодписиОбъектаXDTO

Описание, пример вызова

// Заполняет объект XDTO электронными подписями.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   ОбъектXDTO - ОбъектXDTO - объект XDTO со свойством signatures, куда будут добавлены подписи.
//   МассивПодписей - Массив из см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеПодписи
//
Процедура ЗаполнитьПодписиОбъектаXDTO(Прокси, ОбъектXDTO, МассивПодписей) Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗаполнитьПодписиОбъектаXDTO(Прокси, ОбъектXDTO, МассивПодписей)

ЗаполнитьРеквизитФормыИзXDTO

Описание, пример вызова

// Заполняет указанный реквизит формы по свойству объекта XDTO.
//
// Параметры:
//   Форма - ФормаКлиентскогоПриложения - форма, реквизит которой заполняется.
//   ИмяРеквизитаФормы - Строка - имя заполняемого реквизита.
//   ОбъектXDTO - ОбъектXDTO - источник данных заполнения.
//   ИмяСвойстваXDTO - Строка - имя свойства-источника данных.
//
Процедура ЗаполнитьРеквизитФормыИзXDTO(Форма, ИмяРеквизитаФормы, ОбъектXDTO, ИмяСвойстваXDTO) Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗаполнитьРеквизитФормыИзXDTO(Форма, ИмяРеквизитаФормы, ОбъектXDTO, ИмяСвойстваXDTO)

ЗаполнитьРеквизитыИзПотребителя

Описание, пример вызова

// Заполняет реквизиты объекта XDTO по объекту ИС.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   ОбъектXDTO - ОбъектXDTO - заполняемый объект.
//   ОбъектИС - ЛюбаяСсылка - источник заполнения.
//
Процедура ЗаполнитьРеквизитыИзПотребителя(Прокси, ОбъектXDTO, ОбъектИС) Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗаполнитьРеквизитыИзПотребителя(Прокси, ОбъектXDTO, ОбъектИС)

ЗначениеРеквизитаПоОбъектуXDTO

Описание, пример вызова

// Возвращает значение реквизита объекта ИС по значению реквизита объекта ДО.
//
// Параметры:
//   ОбъектXDTO - ОбъектXDTO - исходный объект, соответствие которому нужно найти.
//   ТипРеквизита - Тип - тип заполняемого реквизита объекта ИС.
//   ИмяРеквизита - Строка - имя заполняемого реквизита ИС.
//   ТипОбъекта - Тип - тип заполняемого объекта ИС.
//   Объект - Произвольный - заполняемый объект ИС.
//   ЭтоДополнительноеСвойство - Булево - истина, если переданный объект является доп. свойством.
//   Свойство - ПланВидовХарактеристикСсылка.ДополнительныеРеквизитыИСведения - свойство-владелец.
//   ПараметрыВыбора - Соответствие из КлючИЗначение - параметры выбора:
//     * Ключ - Строка - имя параметра вида "Отбор.Владелец".
//     * Значение - Произвольный - значение параметра (отбора).
//   СоздаватьЕслиНеНайден - Булево - автоматически создавать новый элемент справочника ИС, в случае,
//     если не удалось подобрать существующий элемент по значению реквизита объекта ДО.
//
// Возвращаемое значение:
//   ЛюбаяСсылка - ссылка на найденный или созданный объект.
//
Функция ЗначениеРеквизитаПоОбъектуXDTO(ОбъектXDTO, ТипРеквизита, ИмяРеквизита = Неопределено, Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗначениеРеквизитаПоОбъектуXDTO(ОбъектXDTO, ТипРеквизита, ИмяРеквизита, );

ИмяДопРеквизита

Описание, пример вызова

// Возвращает уникальное имя дополнительного реквизита для последующего использования в правилах интеграции.
//
// Параметры:
//   ДопРеквизит - ПланВидовХарактеристикСсылка.ДополнительныеРеквизитыИСведения - дополнительный реквизит.
//
// Возвращаемое значение:
//   Строка - имя дополнительного реквизита.
//
Функция ИмяДопРеквизита(ДопРеквизит) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ИмяДопРеквизита(ДопРеквизит)

ИмяСобытияЖурналаРегистрации

Описание, пример вызова

// Возвращает локализованное имя события журнала регистрации для интеграции с ДО.
//
// Параметры:
//   СобытиеВторогоУровня - Строка - имя события, добавляемое через точку к имени события по умолчанию.
//
// Возвращаемое значение:
//   Строка - Интеграция с 1С:Документооборотом
//        или Интеграция с 1С:Документооборотом.<ИмяСобытияВторогоУровня>.
//
Функция ИмяСобытияЖурналаРегистрации(СобытиеВторогоУровня = "") Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ИмяСобытияЖурналаРегистрации(СобытиеВторогоУровня);

ИндексКартинкиЭлементаСправочника

Описание, пример вызова

// Возвращает индекс картинки элемента справочника.
//
// Возвращаемое значение:
//   Число - индекс картинки.
//
Функция ИндексКартинкиЭлементаСправочника() Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ИндексКартинкиЭлементаСправочника()

ИнтеграцияС1СДокументооборотПередЗаписьюДокумента

Описание, пример вызова

// Назначает новому документу идентификатор основания, если это возможно.
//
// Параметры:
//   Источник - ДокументОбъект - записываемый документ.
//   Отказ - Булево - признак необходимости отказаться от записи.
//   РежимЗаписи - РежимЗаписиДокумента - режим записи документа.
//   РежимПроведения - РежимПроведенияДокумента - режим проведения документа.
//
Процедура ИнтеграцияС1СДокументооборотПередЗаписьюДокумента(Источник, Отказ, РежимЗаписи, РежимПроведения) Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ИнтеграцияС1СДокументооборотПередЗаписьюДокумента(Источник, Отказ, РежимЗаписи, РежимПроведения)

ИнтеграцияС1СДокументооборотПередЗаписьюСправочника

Описание, пример вызова

// Назначает новому элементу справочника идентификатор основания, если это возможно.
//
// Параметры:
//   Источник - СправочникОбъект - записываемый справочник.
//   Отказ - Булево - признак необходимости отказаться от записи.
//
Процедура ИнтеграцияС1СДокументооборотПередЗаписьюСправочника(Источник, Отказ) Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ИнтеграцияС1СДокументооборотПередЗаписьюСправочника(Источник, Отказ)

ИспользоватьПрисоединенныеФайлы1СДокументооборота

Описание, пример вызова

// Проверяет, используются ли присоединенные файлы ДО.
//
// Возвращаемое значение:
//   Булево
//
Функция ИспользоватьПрисоединенныеФайлы1СДокументооборота() Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ИспользоватьПрисоединенныеФайлы1СДокументооборота()

НайтиСписокОбъектов

Описание, пример вызова

// Получает значения, доступные для выбора по запросу DMGetObjectListRequest.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   ТипОбъектаВыбораXDTO - Строка - имя типа объекта, значения которого требуется получить.
//   УсловияОтбораОбъектов - ОбъектXDTO - объект XDTO типа DMObjectListQuery.
//
// Возвращаемое значение:
//   ОбъектXDTO - объект XDTO типа DMGetObjectListResponse.
//
Функция НайтиСписокОбъектов(Прокси, ТипОбъектаВыбораXDTO, УсловияОтбораОбъектов = Неопределено) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.НайтиСписокОбъектов(Прокси, ТипОбъектаВыбораXDTO, УсловияОтбораОбъектов);

НайтиСписокОбъектовЗапрос

Описание, пример вызова

// Возвращает запрос DMGetObjectListRequest для получения значений, доступных для выбора.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   ТипОбъектаВыбораXDTO - Строка - имя типа объекта, значения которого требуется получить.
//   УсловияОтбораОбъектов - ОбъектXDTO - объект XDTO типа DMObjectListQuery:
//     * columnConformity - СписокXDTO
//
// Возвращаемое значение:
//   ОбъектXDTO - объект XDTO типа DMGetObjectListRequest.
//
Функция НайтиСписокОбъектовЗапрос(Прокси, ТипОбъектаВыбораXDTO, УсловияОтбораОбъектов = Неопределено) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.НайтиСписокОбъектовЗапрос(Прокси, ТипОбъектаВыбораXDTO, УсловияОтбораОбъектов);

НовоеИсходящееПисьмо

Описание, пример вызова

// Получает объект XDTO исходящего письма, заполненный по умолчанию.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   Предмет - Структура - описание предмета (ID, type).
//
// Возвращаемое значение:
//   ОбъектXDTO - новое исходящее письмо.
//
Функция НовоеИсходящееПисьмо(Прокси, Предмет = Неопределено) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.НовоеИсходящееПисьмо(Прокси, Предмет);

ОбновитьПовторноИспользуемыеПараметры

Описание, пример вызова

// Очищает все сохраненные значения функций с повторным использованием возвращаемых значений и параметры сеанса.
//
Процедура ОбновитьПовторноИспользуемыеПараметры() Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ОбновитьПовторноИспользуемыеПараметры()

ОбработкаЗаполненияДокументы

Описание, пример вызова

// Обработчик подписки на событие ОбработкаЗаполнения для документов.
//
// Параметры:
//   Источник - ОпределяемыйТип.ИнтеграцияС1СДокументооборотДокументыОбъектыПереопределяемый
//   ДанныеЗаполнения - Произвольный - значение, которое используется как основание для заполнения.
//   СтандартнаяОбработка - Булево - признак выполнения стандартной обработки события.
//
Процедура ОбработкаЗаполненияДокументы(Источник, ДанныеЗаполнения, СтандартнаяОбработка) Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ОбработкаЗаполненияДокументы(Источник, ДанныеЗаполнения, СтандартнаяОбработка)

ОбработкаЗаполненияСправочники

Описание, пример вызова

// Обработчик подписки на событие ОбработкаЗаполнения для справочников.
//
// Параметры:
//   Источник - ОпределяемыйТип.ИнтеграцияС1СДокументооборотСправочникиОбъектыПереопределяемый
//   ДанныеЗаполнения - Произвольный - значение, которое используется как основание для заполнения.
//   ТекстЗаполнения - Строка
//                   - Неопределено
//   СтандартнаяОбработка - Булево - признак выполнения стандартной обработки события.
//
Процедура ОбработкаЗаполненияСправочники(Источник, ДанныеЗаполнения, ТекстЗаполнения, СтандартнаяОбработка) Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ОбработкаЗаполненияСправочники(Источник, ДанныеЗаполнения, ТекстЗаполнения, СтандартнаяОбработка)

ОписаниеВебСервисов

Описание, пример вызова

// Возвращает описание веб-сервиса 1С:Документооборота.
//
// Возвращаемое значение:
//   Строка
//
Функция ОписаниеВебСервисов() Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ОписаниеВебСервисов()

ПередЗаписьюНаСервере

Описание, пример вызова

// Помещает в дополнительные свойства идентификатор объекта-основания. Вызывается перед записью объекта.
//
// Параметры:
//   Форма - ФормаКлиентскогоПриложения - форма записываемого объекта.
//   Объект - ДокументОбъект, СправочникОбъект - записываемый объект.
//   ПараметрыЗаписи - Структура - структура, содержащая параметры записи.
//
Процедура ПередЗаписьюНаСервере(Форма, Объект, ПараметрыЗаписи) Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПередЗаписьюНаСервере(Форма, Объект, ПараметрыЗаписи)

ПоддерживаетсяАутентификацияОС

Описание, пример вызова

// Определяет возможность использования аутентификации ОС платформой 1С:Предприятия.
// Возвращает Истина для версий 8.3.7 и старше под MS Windows, и Ложь в остальных случаях.
//
// Возвращаемое значение:
//   Булево
//
Функция ПоддерживаетсяАутентификацияОС() Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПоддерживаетсяАутентификацияОС()

ПодходящийТип

Описание, пример вызова

// Возвращает подходящий тип потребителя для объекта XDTO.
//
// Параметры:
//   ТипыКандидаты - Массив из Тип - массив типов, из которых требуется выбрать подходящий.
//   ЗначениеСвойстваXDTO - ОбъектXDTO - значение свойства объекта XDTO, в соответствии с типом которого
//     нужно выбрать подходящий тип.
//   ТипТекущегоЗначения - Тип - если реквизит объекта ИС имеет составной тип, и в нем уже установлено какое-то
//     определенное значение, тип текущего значения будет более приоритетным при выборе подходящего типа.
//
// Возвращаемое значение:
//   Тип - один из элементов массива ТипыКандидаты, подходящий для типа объекта XDTO.
//
Функция ПодходящийТип(ТипыКандидаты, ЗначениеСвойстваXDTO = Неопределено, ТипТекущегоЗначения = Неопределено) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПодходящийТип(ТипыКандидаты, ЗначениеСвойстваXDTO, ТипТекущегоЗначения);

ПолучитьНастройки

Описание, пример вызова

// Возвращает настройки базы Документооборота.
//
// Возвращаемое значение:
//   ФиксированнаяСтруктура:
//     * НужноИзвлечьТекст - Булево
//     * ИспользоватьЭлектронныеЦифровыеПодписи - Булево
//     * ДобавлятьРаботуВЕжедневныйОтчетПриВыполненииЗадачи - Булево
//     * ФактическийИсполнительЗадач - Строка - объект XDTO типа DMActualTasksPerformer.
//     * ВестиУчетСканКопийОригиналовДокументов - Булево
//     * ПоказыватьЗанятыеФайлыПриЗавершенииРаботы - Булево
//     * ИспользоватьАвтозаполнениеФайлов - Булево
//     * ИзменятьЗаданияЗаднимЧислом - Булево
//     * СписокИсполнителейЗадач - Массив из см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО
//     * ЗаголовокСообщенияВОбластиПредпросмотра - Строка
//     * СписокРасширенийСканКопийОригиналов - Строка
//     * ДоступныЗадачиМне - Булево
//
Функция ПолучитьНастройки() Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПолучитьНастройки()

ПолучитьНастройкиЗапрос

Описание, пример вызова

// Возвращает запрос для получения настроек базы Документооборота.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//
// Возвращаемое значение:
//   ОбъектXDTO - объект XDTO типа DMGetSettingsRequest.
//
Функция ПолучитьНастройкиЗапрос(Прокси) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПолучитьНастройкиЗапрос(Прокси)

ПолучитьНовыйОбъект

Описание, пример вызова

// Получает заполненный по-умолчанию объект из Документооборота.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   Тип - Строка - имя типа XDTO объекта.
//   Предмет - Структура - Используется для получения бизнес-процессов:
//     * ID - Строка - уникальный идентификатор объекта в Документооборот.
//     * type - Строка - имя типа XDTO.
//   Колонки - Массив из Строка - необязательно, состав заполняемых колонок.
//           - Строка - если список колонок разделен через запятую.
//   ВидДокументаДОID - Строка - идентификатор вида документа, если требуется получить новый документ данного вида.
//
// Возвращаемое значение:
//   ОбъектXDTO - объект XDTO типа DMGetNewObjectResponse.
//
Функция ПолучитьНовыйОбъект(Прокси, Тип, Предмет = Неопределено, Колонки = Неопределено, Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПолучитьНовыйОбъект(Прокси, Тип, Предмет, Колонки, );

ПолучитьНовыйОбъектЗапрос

Описание, пример вызова

// Возвращает запрос для получения заполненного по-умолчанию объекта из Документооборота.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   Тип - Строка - имя типа XDTO объекта.
//   Колонки - Массив из Строка - необязательно, состав заполняемых колонок.
//           - Строка - если список колонок разделен через запятую.
//   ВидДокументаДОID - Строка - идентификатор вида документа, если требуется получить новый документ данного вида.
//
// Возвращаемое значение:
//   ОбъектXDTO - объект XDTO типа DMGetNewObjectRequest.
//
Функция ПолучитьНовыйОбъектЗапрос(Прокси, Тип, Колонки = Неопределено, ВидДокументаДОID = Неопределено) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПолучитьНовыйОбъектЗапрос(Прокси, Тип, Колонки, ВидДокументаДОID);

ПолучитьОбъект

Описание, пример вызова

// Получает объект из Документооборота.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   Тип - Строка - имя типа XDTO.
//   ID - Строка - уникальный идентификатор объекта в Документообороте.
//   Колонки - Массив из Строка - необязательно, состав заполняемых колонок.
//           - Строка - если список колонок разделен через запятую.
//   ПравилоИнтеграции - СправочникСсылка.ПравилаИнтеграцииС1СДокументооборотом3 - правило интеграции для
//     заполнения объекта ИС.
//   ВнешнийОбъектИС - ЛюбаяСсылка - передается для заполнения свойства externalObject.
//
// Возвращаемое значение:
//   ОбъектXDTO - объект XDTO заданного типа.
//
Функция ПолучитьОбъект(Прокси, Тип, ID, Колонки = Неопределено, ПравилоИнтеграции = Неопределено, Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПолучитьОбъект(Прокси, Тип, ID, Колонки, ПравилоИнтеграции, );

ПолучитьОбъекты

Описание, пример вызова

// Получает объекты из Документооборота.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   Объекты - Массив из Структура:
//     * ID - Строка
//     * Тип - Строка
//     * ВнешнийОбъектИС - ЛюбаяСсылка - передается для заполнения свойства externalObject.
//   Колонки - Массив из Строка - необязательно, состав заполняемых колонок.
//           - Строка - если список колонок разделен через запятую.
//   ПравилоИнтеграции - СправочникСсылка.ПравилаИнтеграцииС1СДокументооборотом3 - правило интеграции для
//     заполнения объекта ИС.
//
// Возвращаемое значение:
//   СписокXDTO - список объектов XDTO заданного типа.
//
Функция ПолучитьОбъекты(Прокси, Объекты, Колонки = Неопределено, ПравилоИнтеграции = Неопределено) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПолучитьОбъекты(Прокси, Объекты, Колонки, ПравилоИнтеграции);

ПолучитьОбъектыЗапрос

Описание, пример вызова

// Возвращает запрос для получения объектов из Документооборота.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   Объекты - Массив из Структура:
//     * ID - Строка
//     * Тип - Строка
//     * ВнешнийОбъектИС - ЛюбаяСсылка - передается для заполнения свойства externalObject.
//   Колонки - Массив из Строка - необязательно, состав заполняемых колонок.
//           - Строка - если список колонок разделен через запятую.
//   ПравилоИнтеграции - СправочникСсылка.ПравилаИнтеграцииС1СДокументооборотом3 - правило интеграции для
//     заполнения объекта ИС.
//
// Возвращаемое значение:
//   ОбъектXDTO - объект XDTO типа DMRetrieveRequest.
//
Функция ПолучитьОбъектыЗапрос(Прокси, Объекты, Колонки = Неопределено, ПравилоИнтеграции = Неопределено) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПолучитьОбъектыЗапрос(Прокси, Объекты, Колонки, ПравилоИнтеграции);

ПолучитьПрокси

Описание, пример вызова

// Создает прокси веб-сервиса Документооборота с настройками авторизации из параметров сеанса или, если это
// невозможно, например, при создании прокси в фоновом задании, с настройками, переданными напрямую.
//
// Параметры:
//   ВызыватьИсключение - Булево - Истина, если при невозможности получения следует вызвать исключение.
//   ИмяПользователя - Строка - имя пользователя ДО, или
//                   - Неопределено - признак необходимости получить имя, сохраненное в параметрах сеанса.
//   Пароль - Строка - пароль пользователя ДО, или
//          - Неопределено - признак необходимости получить пароль, сохраненное в параметрах сеанса.
//   АдресВебСервисаДокументооборота - Строка - адрес веб-сервиса ДО, или
//                                   - Неопределено - признак необходимости использовать ранее сохраненный адрес.
//   ИспользуетсяАутентификацияОС - Булево - неявно возвращаемое значение,
//     признак необходимости использовать аутентификацию ОС (8.3.7 и выше).
//   ИспользуетсяАутентификацияJWT - Булево - неявно возвращаемое значение,
//     признак необходимости использовать аутентификацию через JWT-токены (8.3.21 и выше).
//   ТекстСообщенияОбОшибке - Строка - неявно возвращаемое значение, текст сообщения об ошибке.
//   ПользовательЗаданияОбмена - Булево - вызов выполняется для настройки пользователя задания обмена.
//     Параметры сеанса текущего пользователя изменяться не будут.
//
// Возвращаемое значение:
//   WSПрокси - прокси веб-сервиса Документооборота.
//   Неопределено - в случае, если прокси веб-сервиса получить не удалось.
//
Функция ПолучитьПрокси(ВызыватьИсключение = Истина, ИмяПользователя = Неопределено, Пароль = Неопределено, Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПолучитьПрокси(ВызыватьИсключение, ИмяПользователя, Пароль, );

ПолучитьРеквизитыОбъектаИС

Описание, пример вызова

// Возвращает реквизиты объекта потребителя указанного типа.
//
// Параметры:
//   ТипОбъектаИС - Строка - полное имя метаданных объекта.
//   ДляВыражения - Булево - возвращает список реквизитов для составления выражения на встроенном языке.
//
// Возвращаемое значение:
//   ТаблицаЗначений:
//     * Имя - Строка
//     * Представление - Строка
//     * Тип - ОписаниеТипов
//     * ЭтоТаблица - Булево
//     * Таблица - Строка
//     * ТаблицаДляСортировки - Строка
//     * ЭтоДополнительныйРеквизитИС - Булево
//     * ДополнительныйРеквизитИС - ПланВидовХарактеристикСсылка.ДополнительныеРеквизитыИСведения
//     * СвязиПараметровВыбора - Массив из Структура:
//         ** Имя - Строка
//         ** ПутьКДанным - Строка
//     * Порядок - Число
//
Функция ПолучитьРеквизитыОбъектаИС(ТипОбъектаИС, ДляВыражения = Ложь) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПолучитьРеквизитыОбъектаИС(ТипОбъектаИС, ДляВыражения);

ПользователюРазрешеноИспользованиеИнтеграции

Описание, пример вызова

// Определяет доступность интеграции для текущего пользователя. Может переопределяться
// при отказе от использования поставляемой роли ИспользованиеИнтеграцииС1СДокументооборотом.
//
// Возвращаемое значение:
//   Булево - Истина, если использование интеграции разрешено.
//
Функция ПользователюРазрешеноИспользованиеИнтеграции() Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПользователюРазрешеноИспользованиеИнтеграции()

ПометитьНаУдалениеСнятьПометкуОбъекта

Описание, пример вызова

// Помечает объект на удаление или снимает пометку.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   ID - Строка - идентификатор помечаемого на удаление объекта в Документообороте.
//   Тип - Строка - имя типа XDTO помечаемого на удаление объекта.
//
// Возвращаемое значение:
//   ОбъектXDTO - Объект XDTO типа DMDeleteResponse.
//
Функция ПометитьНаУдалениеСнятьПометкуОбъекта(Прокси, ID, Тип) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПометитьНаУдалениеСнятьПометкуОбъекта(Прокси, ID, Тип)

ПометитьНаУдалениеСнятьПометкуОбъектов

Описание, пример вызова

// Помечает объекты на удаление или снимает пометку.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   Объекты - Массив из Структура:
//     * ID - Строка
//     * Тип - Строка
//
// Возвращаемое значение:
//   ОбъектXDTO - Объект XDTO типа DMDeleteResponse.
//
Функция ПометитьНаУдалениеСнятьПометкуОбъектов(Прокси, Объекты) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПометитьНаУдалениеСнятьПометкуОбъектов(Прокси, Объекты)

ПометитьНаУдалениеСнятьПометкуОбъектовЗапрос

Описание, пример вызова

// Возвращает запрос для пометки объектов на удаление или для снятия пометки.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   Объекты - Массив из Структура:
//     * ID - Строка
//     * Тип - Строка
//
// Возвращаемое значение:
//   ОбъектXDTO - Объект XDTO типа DMDeleteRequest.
//
Функция ПометитьНаУдалениеСнятьПометкуОбъектовЗапрос(Прокси, Объекты) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПометитьНаУдалениеСнятьПометкуОбъектовЗапрос(Прокси, Объекты)

ПравилоЗаполненияИзРеквизитаОбъектаДО

Описание, пример вызова

// Конструктор структуры, описывающей правило заполнения из реквизита объекта ДО.
//
// Параметры:
//   Имя - Строка - имя реквизита объекта XDTO.
//   Представление - Строка - представление реквизита объекта ДО.
//   Обновлять - Булево - требуется ли обновлять реквизит объекта ИС из реквизита объекта ДО.
//
// Возвращаемое значение:
//  Структура:
//     * Имя - Строка
//     * Представление - Строка
//     * Обновлять - Булево
//
Функция ПравилоЗаполненияИзРеквизитаОбъектаДО(Имя, Представление = "", Обновлять = Истина) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПравилоЗаполненияИзРеквизитаОбъектаДО(Имя, Представление, Обновлять);

ПредельноеКоличествоВыбираемыхОбъектов

Описание, пример вызова

// Возвращает предельное количество объектов, выбираемых сервисом при получении списков.
//
// Параметры:
//   Тип - Строка - тип объекта XDTO
//
// Возвращаемое значение:
//   Число - предельное количество элементов, выбираемых за раз
//
Функция ПредельноеКоличествоВыбираемыхОбъектов(Тип) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПредельноеКоличествоВыбираемыхОбъектов(Тип)

ПредопределенноеЗначениеДО

Описание, пример вызова

// Запрашивает ссылку на предопределенный объект Документооборота по заданному имени и типу.
//
// Параметры:
//   ТипОбъекта - Строка - Имя класса XDTO, предопределенный объект которого требуется получить.
//   ИмяПредопределенногоЭлемента - Строка - Имя предопределенного элемента.
//
// Возвращаемое значение:
//   ОбъектXDTO - Объект XDTO типа DMObject.
//
Функция ПредопределенноеЗначениеДО(ТипОбъекта, ИмяПредопределенногоЭлемента) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПредопределенноеЗначениеДО(ТипОбъекта, ИмяПредопределенногоЭлемента)

ПредставлениеТипаОбъектаXDTO

Описание, пример вызова

// Возвращает представление типа объекта XDTO Документооборота по имени типа.
//
// Параметры:
//   ТипXDTO - Строка - имя типа объекта XDTO.
//
// Возвращаемое значение:
//   Строка - представление типа объекта XDTO Документооборота по имени типа.
//
Функция ПредставлениеТипаОбъектаXDTO(ТипXDTO) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПредставлениеТипаОбъектаXDTO(ТипXDTO)

ПриЗаписиКонстанты

Описание, пример вызова

// Вызывается при записи констант подсистемы Интеграция с 1С:Документооборотом.
//
// Параметры:
//   Источник - КонстантаМенеджерЗначения - записываемая константа.
//   Отказ - Булево - флаг отказа от выполнения записи.
//
Процедура ПриЗаписиКонстанты(Источник, Отказ) Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПриЗаписиКонстанты(Источник, Отказ)

ПриОпределенииЗначенияРеквизитаПоОбъектуXDTO

Описание, пример вызова

// Вызывается при заполнении реквизита объекта ИС по значению реквизита объекта ДО.
//
// Параметры:
//   Результат - Произвольный - заполняемое значение реквизита объекта ИС.
//   ЗначениеЗаполнения - ОбъектXDTO - исходный объект, соответствие которому нужно найти.
//                      - Структура - структура со свойствами:
//     * ТипXDTOОбъекта - Строка - тип XDTO объекта, из значения свойства которого выполняется заполнение.
//     * ИмяСвойства - Строка - имя свойства, из значения свойства которого выполняется заполнение.
//     * ЗначениеСвойства - Произвольный - значение заполнения, соответствие которому нужно найти.
//   ТипРеквизита - Тип - тип заполняемого реквизита объекта ИС.
//   ИмяРеквизита - Строка - имя заполняемого реквизита ИС.
//   ТипОбъекта - Тип - тип заполняемого объекта ИС.
//   Объект - Произвольный - заполняемый объект ИС.
//   ЭтоДополнительноеСвойство - Булево - истина, если переданный объект является доп. свойством.
//   Свойство - ПланВидовХарактеристикСсылка.ДополнительныеРеквизитыИСведения - свойство-владелец.
//   ПараметрыВыбора - Соответствие из КлючИЗначение - параметры выбора:
//     * Ключ - Строка - имя параметра вида "Отбор.Владелец".
//     * Значение - Произвольный - значение параметра (отбора).
//
Процедура ПриОпределенииЗначенияРеквизитаПоОбъектуXDTO(Результат, ЗначениеЗаполнения, ТипРеквизита, ИмяРеквизита, Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПриОпределенииЗначенияРеквизитаПоОбъектуXDTO(Результат, ЗначениеЗаполнения, ТипРеквизита, ИмяРеквизита, );

ПриСозданииНаСервере

Описание, пример вызова

// Добавляет команды Документооборота на форму объекта при создании на сервере.
//
// Параметры:
//   Форма - ФормаКлиентскогоПриложения - форма, из которой вызвана процедура.
//   МестоРазмещенияКоманд - ГруппаФормы - место для размещения, по умолчанию - командная панель формы.
//   ПараметрыОповещения - Структура - параметры, где может быть установлен источник команды.
//   Ссылка - ЛюбаяСсылка - ссылка на объект ИС, являющийся основным объектом формы.
//
Процедура ПриСозданииНаСервере(Форма, МестоРазмещенияКоманд = Неопределено, ПараметрыОповещения = Неопределено, Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПриСозданииНаСервере(Форма, МестоРазмещенияКоманд, ПараметрыОповещения, );

ПриСозданииНаСервереФормРазмещаемыхНаРабочемСтоле

Описание, пример вызова

// Вызывается при создании форм интеграции, размещаемых на рабочем столе.
// Позволяет отказаться от их создания при работе в неразделенном сеансе или при выполнении обновления ИБ.
//
// Параметры:
//   Отказ - Булево - отказ от создания.
//
Процедура ПриСозданииНаСервереФормРазмещаемыхНаРабочемСтоле(Отказ) Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПриСозданииНаСервереФормРазмещаемыхНаРабочемСтоле(Отказ)

ПриложениеЯвляетсяВебКлиентом

Описание, пример вызова

// Возвращает Истину, если клиентское приложение является веб клиентом, иначе Ложь.
//
// Возвращаемое значение:
//   Булево
//
Функция ПриложениеЯвляетсяВебКлиентом() Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПриложениеЯвляетсяВебКлиентом()

ПроверитьВозвратВебСервиса

Описание, пример вызова

// Проверяет возврат WEB-сервиса. В случае возврата объекта типа DMError вызывает исключение.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   Ответ - ОбъектXDTO - проверяемый результат вызова сервиса.
//
Процедура ПроверитьВозвратВебСервиса(Прокси, Ответ) Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПроверитьВозвратВебСервиса(Прокси, Ответ)

ПроверитьТип

Описание, пример вызова

// Проверяет тип объекта XDTO.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   ОбъектXDTO - ОбъектXDTO - проверяемый объект
//   Тип - Строка - имя типа для проверки
//
// Возвращаемое значение:
//   Булево - Истина если объект является объектом указанного типа и Ложь в противном случае.
//
Функция ПроверитьТип(Прокси, ОбъектXDTO, Тип) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПроверитьТип(Прокси, ОбъектXDTO, Тип)

СвойствоСуществует

Описание, пример вызова

// Определяет существует ли свойство в объекте XDTO.
//
// Параметры:
//   ОбъектXDTO - ОбъектXDTO - исходный объект, свойство которого нужно проверить.
//   ИмяСвойства - Строка - имя свойства.
//   ВызыватьИсключение - Булево - вызывать исключение в случае, если не существует свойства с указанным именем.
//
// Возвращаемое значение:
//   Булево - свойство существует.
//
Функция СвойствоСуществует(ОбъектXDTO, ИмяСвойства, ВызыватьИсключение = Ложь) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.СвойствоСуществует(ОбъектXDTO, ИмяСвойства, ВызыватьИсключение);

СвойствоУстановлено

Описание, пример вызова

// Определяет было ли установлено свойство в объекте XDTO.
//
// Параметры:
//   ОбъектXDTO - ОбъектXDTO - исходный объект, свойство которого нужно проверить.
//   ИмяСвойства - Строка - имя свойства.
//
// Возвращаемое значение:
//   Булево - свойство установлено.
//
Функция СвойствоУстановлено(ОбъектXDTO, ИмяСвойства) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.СвойствоУстановлено(ОбъектXDTO, ИмяСвойства)

СерверРаботаетПодWindows

Описание, пример вызова

// Возвращает Истина, если сервер работает под Windows, и Ложь в противном случае.
//
// Возвращаемое значение:
//   Булево
//
Функция СерверРаботаетПодWindows() Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.СерверРаботаетПодWindows()

СогласованВ1СДокументооборот

Описание, пример вызова

// Возвращает признак состояния "Согласован" по данным документооборота.
//
// Параметры:
//   СсылкаНаОбъект - ЛюбаяСсылка - ссылка на объект ИС.
//
// Возвращаемое значение:
//   Булево - состояние согласования в ДО.
//
Функция СогласованВ1СДокументооборот(СсылкаНаОбъект) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.СогласованВ1СДокументооборот(СсылкаНаОбъект)

СоздатьDMLink

Описание, пример вызова

// Создает объект DMLink.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   ИдентификаторОбъектаДО - Строка - идентификатор объекта ДО.
//   ТипОбъектаДО - Строка - тип объекта XDTO.
//   ОбъектИС - ЛюбаяСсылка - ссылка на объект ИС.
//
// Возвращаемое значение:
//   ОбъектXDTO - объект XDTO типа DMLink.
//
Функция СоздатьDMLink(Прокси, ИдентификаторОбъектаДО = "", ТипОбъектаДО = "", ОбъектИС = Неопределено) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.СоздатьDMLink(Прокси, ИдентификаторОбъектаДО, ТипОбъектаДО, ОбъектИС);

СоздатьExternalObject

Описание, пример вызова

// Создает объект ExternalObject.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   ВнешнийОбъектИС - ЛюбаяСсылка - ссылка на внешний объект ИС.
//   ID - Строка - идентификатор внешнего объекта ИС.
//   Тип - Строка - тип внешнего объекта ИС.
//   Наименование - Строка - наименование внешнего объекта ИС.
//
// Возвращаемое значение:
//   ОбъектXDTO - объект XDTO типа ExternalObject.
//
Функция СоздатьExternalObject(Прокси, ВнешнийОбъектИС = Неопределено, ID = "", Тип = "", Наименование = "") Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.СоздатьExternalObject(Прокси, ВнешнийОбъектИС, ID, Тип, Наименование);

СоздатьExternalObjectID

Описание, пример вызова

// Создает объект ExternalObjectID.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   ВнешнийОбъектИС - ЛюбаяСсылка - ссылка на внешний объект ИС.
//   ID - Строка - идентификатор внешнего объекта ИС.
//   Тип - Строка - тип внешнего объекта ИС.
//
// Возвращаемое значение:
//   ОбъектXDTO - объект XDTO типа ExternalObjectID.
//
Функция СоздатьExternalObjectID(Прокси, ВнешнийОбъектИС = Неопределено, ID = "", Тип = "") Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.СоздатьExternalObjectID(Прокси, ВнешнийОбъектИС, ID, Тип);

СоздатьObjectID

Описание, пример вызова

// Создает объект DMObjectID.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   ID - Строка - идентификатор объекта XDTO.
//   Тип - Строка - тип объекта XDTO.
//
// Возвращаемое значение:
//   ОбъектXDTO - объект XDTO типа DMObjectID.
//
Функция СоздатьObjectID(Прокси, ID = "", Тип = "") Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.СоздатьObjectID(Прокси, ID, Тип);

СоздатьИзДанныхСсылочногоОбъектаДО

Описание, пример вызова

// Создает объект XDTO из структуры данных ссылочного объекта ДО.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   ДанныеСсылочногоОбъектаДО - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО
//
// Возвращаемое значение:
//   ОбъектXDTO - объект XDTO, наследуемый от типа DMObject.
//
Функция СоздатьИзДанныхСсылочногоОбъектаДО(Прокси, ДанныеСсылочногоОбъектаДО) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.СоздатьИзДанныхСсылочногоОбъектаДО(Прокси, ДанныеСсылочногоОбъектаДО)

СоздатьНовыйОбъект

Описание, пример вызова

// Создает новый объект в Документообороте.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   Объект - ОбъектXDTO - описание создаваемого объекта.
//
// Возвращаемое значение:
//   ОбъектXDTO - Объект XDTO типа DMCreateResponse или DMError.
//
Функция СоздатьНовыйОбъект(Прокси, Объект) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.СоздатьНовыйОбъект(Прокси, Объект)

СоздатьОбъект

Описание, пример вызова

// Создает XDTO объект указанного типа из пространства имен веб-сервиса Документооборота.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   ТипОбъекта - Строка - тип объекта XDTO.
//   ВнешнийОбъектИС - ЛюбаяСсылка - передается для заполнения свойств name и externalObject.
//   ЗаполнитьИзВнешнегоОбъекта - Булево - требуется заполнить объект XDTO из внешнего объекта ИС.
//
// Возвращаемое значение:
//   ОбъектXDTO - объект XDTO указанного типа.
//
Функция СоздатьОбъект(Прокси, ТипОбъекта, ВнешнийОбъектИС = Неопределено, ЗаполнитьИзВнешнегоОбъекта = Истина) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.СоздатьОбъект(Прокси, ТипОбъекта, ВнешнийОбъектИС, ЗаполнитьИзВнешнегоОбъекта);

СоздатьОбъектXDTOДляСохраненияПодписей

Описание, пример вызова

// Создает XDTO объект для передачи массива подписей в Документооборот.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   ДанныеВладельцаПодписи - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеВладельцаПодписи
//
// Возвращаемое значение:
//   ОбъектXDTO - Объект XDTO с заполненным свойством signatures.
//
Функция СоздатьОбъектXDTOДляСохраненияПодписей(Прокси, ДанныеВладельцаПодписи) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.СоздатьОбъектXDTOДляСохраненияПодписей(Прокси, ДанныеВладельцаПодписи)

СокращенноеНаименованиеКонфигурации

Описание, пример вызова

// Возвращает сокращенное наименование интегрируемой конфигурации для вывода в заголовках и декорациях.
//
// Возвращаемое значение:
//   Строка - сокращенное наименование конфигурации.
//
Функция СокращенноеНаименованиеКонфигурации() Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.СокращенноеНаименованиеКонфигурации()

СсылкаИзUUID

Описание, пример вызова

// Получает ссылку на объект по имени объекта конфигурации и ID.
//
// Параметры:
//   Тип - Строка - тип объекта конфигурации.
//   UUID - Строка - идентификатор объекта конфигурации.
//
// Возвращаемое значение:
//   ЛюбаяСсылка - ссылка на объект.
//
Функция СсылкаИзUUID(Тип, UUID) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.СсылкаИзUUID(Тип, UUID)

СсылкиПоВнешнимОбъектам

Описание, пример вызова

// Возвращает ссылки на объекты этой конфигурации по информации о них в объекте ДО.
//
// Параметры:
//   ОбъектXDTO - ОбъектXDTO - потомок DMObject, объект ДО.
//              - Структура - содержит идентификатор и тип внешнего объекта:
//     * ID - Строка - идентификатор внешнего объекта по данным 1С:Документооборота;
//     * type - Строка - тип внешнего объекта по данным 1С:Документооборота.
//
// Возвращаемое значение:
//   Массив из ЛюбаяСсылка - массив ссылок на связанные объекты этой конфигурации.
//
Функция СсылкиПоВнешнимОбъектам(ОбъектXDTO) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.СсылкиПоВнешнимОбъектам(ОбъектXDTO)

ТаймаутСервиса

Описание, пример вызова

// Возвращает таймаут прокси веб-сервиса Документооборота, возможно, переопределенный в настройках.
//
// Возвращаемое значение:
//   Число - таймаут в секундах.
//
Функция ТаймаутСервиса() Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ТаймаутСервиса()

ТекущийПользовательДокументооборота

Описание, пример вызова

// Получает текущего пользователя 1С:Документооборота.
//
// Возвращаемое значение:
//   Массив из ОбъектXDTO - Объект XDTO типа DMUser, DMEmployee или Неопределено.
//
Функция ТекущийПользовательДокументооборота() Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ТекущийПользовательДокументооборота()

ТекущийПользовательДокументооборотаЗапрос

Описание, пример вызова

// Возвращает запрос для получения текущего пользователя 1С:Документооборота.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//
// Возвращаемое значение:
//   ОбъектXDTO - объект XDTO типа DMGetCurrentUserRequest.
//
Функция ТекущийПользовательДокументооборотаЗапрос(Прокси) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ТекущийПользовательДокументооборотаЗапрос(Прокси)

УстановитьВерсиюСервиса

Описание, пример вызова

// Устанавливает версию сервиса в параметрах сеанса.
//
// Параметры:
//   ИзФоновогоЗадания - Булево - процедура запускается из фонового задания.
//   ТекстОшибки - Строка - неявно возвращаемое значение, текст сообщения об ошибке,
//     полученный при определении версии сервиса.
//
Процедура УстановитьВерсиюСервиса(ИзФоновогоЗадания = Ложь, ТекстОшибки = "") Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.УстановитьВерсиюСервиса(ИзФоновогоЗадания, ТекстОшибки);

УстановитьПараметрыСеанса

Описание, пример вызова

// Устанавливает параметры сеанса работы с подсистемой "Интеграция с 1С:Документооборотом".
//
// Параметры:
//   ИмяПараметра - Строка
//   УстановленныеПараметры - Массив из Строка
//
Процедура УстановитьПараметрыСеанса(ИмяПараметра, УстановленныеПараметры) Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.УстановитьПараметрыСеанса(ИмяПараметра, УстановленныеПараметры)

УстановитьПараметрыСеансаПоМассивуИмен

Описание, пример вызова

// Устанавливает параметры сеанса по массиву имен.
//
// Параметры:
//   ИменаПараметров - Массив из Строка - массив строк с именами параметров сеанса к установке.
//
Процедура УстановитьПараметрыСеансаПоМассивуИмен(ИменаПараметров) Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.УстановитьПараметрыСеансаПоМассивуИмен(ИменаПараметров)

УстановитьШтрихкод

Описание, пример вызова

// Добавляет в связанный документ в ДО штрихкод по объекту ИС.
//
// Параметры:
//   ОбъектИС - ЛюбаяСсылка - объект ИС, источник данных заполнения.
//   ID - Строка - идентификатор объекта Документооборота.
//   Тип - Строка - XDTO-тип объекта Документооборота
//
Процедура УстановитьШтрихкод(ОбъектИС, ID, Тип) Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.УстановитьШтрихкод(ОбъектИС, ID, Тип)

ЭтоОбъектноеЗначение

Описание, пример вызова

// Проверяет, является ли значение объектным, т.е. наследуется от типа DMObject.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   Значение - Произвольный - проверяемое значение.
//
// Возвращаемое значение:
//   Булево - Истина, в случае, если значение является потомком типа DMObject, иначе Ложь.
//
Функция ЭтоОбъектноеЗначение(Прокси, Значение) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЭтоОбъектноеЗначение(Прокси, Значение)

ЭтоОбъектноеСвойство

Описание, пример вызова

// Проверяет, является ли свойство объектным, т.е. наследуется от типа DMObject.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   ОбъектXDTO - ОбъектXDTO - объект, содержащий проверяемое свойство
//   ИмяСвойстваXDTO - Строка - имя проверяемого свойства
//
// Возвращаемое значение:
//   Булево - Истина, в случае, если свойство является потомком типа DMObject, иначе Ложь
//
Функция ЭтоОбъектноеСвойство(Прокси, ОбъектXDTO, ИмяСвойстваXDTO) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЭтоОбъектноеСвойство(Прокси, ОбъектXDTO, ИмяСвойстваXDTO)

ДанныеФайловОбъектаИС

Описание, пример вызова

// Возвращает данные хранящихся на стороне ДО файлов.
//
// Параметры:
//   Источник - ЛюбаяСсылка - ссылка на исходный объект ИС.
//   ИдентификаторФормы - УникальныйИдентификатор - идентификатор форма-владельца хранилища.
//   СписокРасширений - Строка - список расширений файлов, которые требуется получать из ДО через запятую.
//
// Возвращаемое значение:
//   Массив из см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеФайла
//
Функция ДанныеФайловОбъектаИС(Источник, ИдентификаторФормы, Знач СписокРасширений = Неопределено) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ДанныеФайловОбъектаИС(Источник, ИдентификаторФормы, СписокРасширений);

ДобавитьКомандуПечати

Описание, пример вызова

// Добавляет команду печати в таблицу печатных форм объекта.
//
// Параметры:
//   ПечатныеФормы - ТаблицаЗначений:
//     * МенеджерПечати - Строка - имя объекта, в модуле менеджера которого располагается
//                                 процедура Печать, формирующая табличные документы для этой команды.
//     * ИмяКоманды - Строка
//     * ПредставлениеКоманды - Строка
//     * ДополнительныеПараметры - Строка - (необязательный) произвольные параметры для передачи в менеджер печати.
//   КомандаПечати - см. УправлениеПечатью.КомандыПечатиФормы
//
Процедура ДобавитьКомандуПечати(ПечатныеФормы, КомандаПечати) Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ДобавитьКомандуПечати(ПечатныеФормы, КомандаПечати)

ЗаполнитьКоллекциюПечатныхФорм

Описание, пример вызова

// Заполняет коллекцию печатных форм объекта по имени менеджера печати и команде менеджера печати.
//
// Параметры:
//   ВнешнийОбъект - ЛюбаяСсылка - внешний объект.
//   ИмяКоманды - Строка - имя команды.
//   ДополнительныеПараметры - Строка - (необязательный) произвольные параметры для передачи в менеджер печати.
//   КоллекцияПечатныхФорм - ТаблицаЗначений - неявно возвращаемое значение.
//
Процедура ЗаполнитьКоллекциюПечатныхФорм(ВнешнийОбъект, ИмяКоманды, ДополнительныеПараметры, Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗаполнитьКоллекциюПечатныхФорм(ВнешнийОбъект, ИмяКоманды, ДополнительныеПараметры, );

ЗаполнитьТаблицуМенеджеровПечатиОбъекта

Описание, пример вызова

// Получает таблицу менеджеров печати форм объектов.
//
// Параметры:
//   МенеджерОбъекта - Строка - полное имя метаданных менеджера объекта.
//   ПечатныеФормы - ТаблицаЗначений:
//     * МенеджерПечати - Строка - имя объекта, в модуле менеджера которого располагается
//                                 процедура Печать, формирующая табличные документы для этой команды.
//     * ИмяКоманды - Строка
//     * ПредставлениеКоманды - Строка
//     * ДополнительныеПараметры - Строка - (необязательный) произвольные параметры для передачи в менеджер печати.
//
Процедура ЗаполнитьТаблицуМенеджеровПечатиОбъекта(МенеджерОбъекта, ПечатныеФормы) Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗаполнитьТаблицуМенеджеровПечатиОбъекта(МенеджерОбъекта, ПечатныеФормы)

ИмяПечатнойФормы

Описание, пример вызова

// Формирует имя файла печатной формы объекта ИС для помещения в ДО.
//
// Параметры:
//   Источник - ЛюбаяСсылка - ссылка на исходный объект ИС.
//   ПредставлениеКоманды - Строка - синоним команды печати.
//   СинонимМакета - Строка - синоним макета печатной формы.
//   ИмяМакета - Строка - имя макета печатной формы.
//
// Возвращаемое значение:
//   Строка
//
Функция ИмяПечатнойФормы(Источник, ПредставлениеКоманды, СинонимМакета, ИмяМакета) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ИмяПечатнойФормы(Источник, ПредставлениеКоманды, СинонимМакета, ИмяМакета)

ИндексПиктограммыФайла

Описание, пример вызова

// Получается индекс пиктограммы файла - индекс в картинке КоллекцияПиктограммФайлов.
//
// Параметры:
//   Расширение - Строка - расширение файла.
//   ПометкаУдаления - Булево - файл помечен на удаление.
//
// Возвращаемое значение:
//   Число
//
Функция ИндексПиктограммыФайла(Расширение, ПометкаУдаления = Ложь) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ИндексПиктограммыФайла(Расширение, ПометкаУдаления);

КоличествоФайловСвязанногоОбъекта

Описание, пример вызова

// Возвращает количество прикрепленных файлов к связанному объекту 1С:Документооборот.
//
// Параметры:
//   ID - Строка - идентификатор объекта Документооборота.
//   Тип - Строка - XDTO-тип объекта Документооборота.
//   ВключаяУдаленные - Булево - учитывать ли помеченные на удаление файлы.
//
// Возвращаемое значение:
//   Число - количество прикрепленных файлов.
//
Функция КоличествоФайловСвязанногоОбъекта(ID, Тип, ВключаяУдаленные = Истина) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.КоличествоФайловСвязанногоОбъекта(ID, Тип, ВключаяУдаленные);

КомандыПечатиФормы

Описание, пример вызова

// Возвращает команды печати формы.
//
// Параметры:
//   ИмяФормы - Строка - имя формы объекта.
//
// Возвращаемое значение:
//   см. УправлениеПечатью.КомандыПечатиФормы
//
Функция КомандыПечатиФормы(ИмяФормы) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.КомандыПечатиФормы(ИмяФормы)

КонтрольОтправкиФайлов

Описание, пример вызова

// Конструктор таблицы, кэширующей значения для последующего внесения в регистр
// сведений КонтрольОтправкиФайловВ1СДокументооборот.
//
// Возвращаемое значение:
//  ТаблицаЗначений:
//     * Источник - ЛюбаяСсылка - ссылка на исходный объект ИС.
//     * ИмяФайла - Строка - имя печатной формы.
//     * ТабличныйДокумент - ТабличныйДокумент - сформированная печатная форма.
//
Функция КонтрольОтправкиФайлов() Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.КонтрольОтправкиФайлов()

МенеджерыПечати

Описание, пример вызова

// Возвращает таблицу значений с информацией о менеджерах печати объекта.
//
// Параметры:
//   МенеджерОбъекта - Строка - полное имя метаданных менеджера объекта.
//
// Возвращаемое значение:
//   ТаблицаЗначений:
//     * ИмяКоманды - Строка - имя команды менеджера печати.
//     * МенеджерПечати - Строка - имя объекта, в модуле менеджера которого располагается
//         процедура Печать, формирующая табличные документы для этой команды.
//     * ПредставлениеКоманды - Строка - представление команды печати для отображения на формах.
//     * ДополнительныеПараметры - Строка - (необязательный) произвольные параметры для передачи в менеджер печати.
//
Функция МенеджерыПечати(МенеджерОбъекта) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.МенеджерыПечати(МенеджерОбъекта)

ПечатныеФормыКСозданию

Описание, пример вызова

// Формирует параметры создания файлов объекта ДО из печатных форм объекта ИС.
//
// Параметры:
//   Источник - ЛюбаяСсылка - ссылка на исходный объект ИС.
//   ПрисоединяемыеПечатныеФормы - см. ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПрисоединяемыеПечатныеФормы
//   ТипФайловСохраненияПечатныхФорм - ПеречислениеСсылка.ТипыФайловСохраненияПечатныхФормОбъектов - тип файла,
//     в котором сохраняется печатная форма.
//   КонтрольОтправкиФайлов - см. ИнтеграцияС1СДокументооборотБазоваяФункциональность.КонтрольОтправкиФайлов
//   ТолькоОбновление - Булево - Истина, если выполняется только обновление существующих форм.
//   ИдентификаторФормы - УникальныйИдентификатор - идентификатор форма-владельца хранилища.
//
// Возвращаемое значение:
//   Массив Из см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.НовыеПараметрыСозданияФайла
//
Функция ПечатныеФормыКСозданию(Источник, ПрисоединяемыеПечатныеФормы, ТипФайловСохраненияПечатныхФорм, Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПечатныеФормыКСозданию(Источник, ПрисоединяемыеПечатныеФормы, ТипФайловСохраненияПечатныхФорм, );

ПриОпределенииНаличияПрисоединенныхФайлов

Описание, пример вызова

// Вызывается при определении наличия файлов, хранимых в интегрируемой конфигурации.
//
// Параметры:
//   ВладелецФайлов - Произвольный - объект-владелец.
//   ЕстьФайлы - Булево, Неопределено - неявно возвращаемое значение, признак наличия присоединенных файлов.
//
Процедура ПриОпределенииНаличияПрисоединенныхФайлов(ВладелецФайлов, ЕстьФайлы) Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПриОпределенииНаличияПрисоединенныхФайлов(ВладелецФайлов, ЕстьФайлы)

ПрисоединенныеФайлыВИС

Описание, пример вызова

// Возвращает список присоединенных файлов, хранимых в ИС.
//
// Параметры:
//   ВладелецФайлов - Произвольный - объект-владелец.
//
// Возвращаемое значение:
//   Массив из ЛюбаяСсылка - список ссылок на прикрепленные файлы.
//
Функция ПрисоединенныеФайлыВИС(ВладелецФайлов) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПрисоединенныеФайлыВИС(ВладелецФайлов)

ПрисоединяемыеПечатныеФормы

Описание, пример вызова

// Конструктор таблицы значений, описывающей присоединяемые печатные формы.
//
// Возвращаемое значение:
//  ТаблицаЗначений:
//     * ИмяКоманды - Строка - имя команды менеджера печати.
//     * ПредставлениеКоманды - Строка - представление команды печати для отображения на формах.
//     * МенеджерПечати - Строка - имя менеджера печати, как оно задано в конфигураторе.
//     * Обновлять - Булево - обновлять значение.
//     * РольФайлаID - Строка - идентификатор роли файла печатной формы на стороне ДО.
//     * ДополнительныеПараметры - Строка - (необязательный) произвольные параметры для передачи в менеджер печати.
//
Функция ПрисоединяемыеПечатныеФормы() Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПрисоединяемыеПечатныеФормы()

ПриПолученииПрисоединенныхФайлов

Описание, пример вызова

// Вызывается при получении присоединенных файлов.
//
// Параметры:
//   ВладелецФайлов - Произвольный - объект-владелец.
//   ДанныеФайлов - Массив из см. РаботаСФайлами.ДанныеФайла
//
Процедура ПриПолученииПрисоединенныхФайлов(ВладелецФайлов, ДанныеФайлов) Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПриПолученииПрисоединенныхФайлов(ВладелецФайлов, ДанныеФайлов)

ПриПоявленииПрисоединенныхФайловДокументооборота

Описание, пример вызова

// Устанавливает признак наличия присоединенных файлов ДО для объекта ИС. Вызывается при добавлении
// связи с объектом ДО, имеющим файлы, при добавлении файла из интерфейса ИС и при фоновом обновлении.
//
// Параметры:
//   ID - Строка - идентификатор объекта Документооборота.
//   Тип - Строка - XDTO-тип объекта Документооборота.
//   ОбъектИС - ОпределяемыйТип.ВладелецПрисоединенныхФайлов - объект ИС.
//   НаличиеПрисоединенныхФайлов - Булево - Истина, если в ДО есть присоединенные файлы.
//
Процедура ПриПоявленииПрисоединенныхФайловДокументооборота(ID, Тип, ОбъектИС, Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПриПоявленииПрисоединенныхФайловДокументооборота(ID, Тип, ОбъектИС, );

ПриУдаленииПрисоединенныхФайловДокументооборота

Описание, пример вызова

// Снимает признак наличия присоединенных файлов для объекта ИС, если их нет в самой ИС. Вызывается при
// удалении связи с объектом ДО и при фоновом обновлении.
//
// Параметры:
//   ID - Строка - идентификатор объекта Документооборота.
//   Тип - Строка - XDTO-тип объекта Документооборота.
//   ОбъектИС - ОпределяемыйТип.ВладелецПрисоединенныхФайлов - объект ИС.
//
Процедура ПриУдаленииПрисоединенныхФайловДокументооборота(ID, Тип, ОбъектИС) Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПриУдаленииПрисоединенныхФайловДокументооборота(ID, Тип, ОбъектИС)

РасширениеСохраняемойПечатнойФормы

Описание, пример вызова

// Возвращает расширение по типу файла сохраняемой печатной формы.
//
// Параметры:
//   ТипФайла - ПеречислениеСсылка.ТипыФайловСохраненияПечатныхФормОбъектов - тип сохраняемого файла.
//
// Возвращаемое значение:
//   Строка - расширение файла.
//
Функция РасширениеСохраняемойПечатнойФормы(ТипФайла) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.РасширениеСохраняемойПечатнойФормы(ТипФайла)

СоздатьФайлЗапрос

Описание, пример вызова

// Возвращает запрос для создания файла в Документообороте.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   ФайлXDTO - ОбъектXDTO - объект XDTO типа DMFile.
//   ВладелецID - Строка - идентификатор владельца файла в Документообороте.
//   ВладелецТип - Строка - тип владельца файла в Документообороте.
//   ВладелецПредставление - Строка - представление владельца файла в Документообороте.
//
// Возвращаемое значение:
//   ОбъектXDTO - объект XDTO типа DMAddFileRequest.
//
Функция СоздатьФайлЗапрос(Прокси, ФайлXDTO, ВладелецID, ВладелецТип, ВладелецПредставление = "") Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.СоздатьФайлЗапрос(Прокси, ФайлXDTO, ВладелецID, ВладелецТип, ВладелецПредставление);

ТипФайлаСохраняемойПечатнойФормыПоУмолчанию

Описание, пример вызова

// Возвращает тип файла сохраняемой печатной формы по умолчанию.
//
// Возвращаемое значение:
//   ПеречислениеСсылка.ТипыФайловСохраненияПечатныхФормОбъектов - тип по умолчанию.
//
Функция ТипФайлаСохраняемойПечатнойФормыПоУмолчанию() Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ТипФайлаСохраняемойПечатнойФормыПоУмолчанию()

ФайлXDTOИзПараметровСоздания

Описание, пример вызова

// Создает и заполняет объект XDTO типа DMFile по данным из параметров создания.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   ПараметрыСоздания - Структура - ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.НовыеПараметрыСозданияФайла
//
// Возвращаемое значение:
//   ОбъектXDTO - объект XDTO типа DMFile.
//
Функция ФайлXDTOИзПараметровСоздания(Прокси, ПараметрыСоздания) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ФайлXDTOИзПараметровСоздания(Прокси, ПараметрыСоздания)

ЗаполнитьПолнуюРоль

Описание, пример вызова

// Заполняет объект XDTO, описывающий полную роль.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   ПолнаяРольXDTO - ОбъектXDTO - объект XDTO типа DMCompleteRole.
//   Роль - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО
//   ОсновнойОбъектАдресации - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО
//   ДополнительныйОбъектАдресации - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО
//
Процедура ЗаполнитьПолнуюРоль(Прокси, ПолнаяРольXDTO, Роль, ОсновнойОбъектАдресации = Неопределено, Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЗаполнитьПолнуюРоль(Прокси, ПолнаяРольXDTO, Роль, ОсновнойОбъектАдресации, );

УчастникЗадач

Описание, пример вызова

// Формирует объект XDTO, описывающий участника задачи.
//
// Параметры:
//   Прокси - WSПрокси - объект для подключения к web-сервисам Документооборота.
//   Исполнитель - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО
//   ОсновнойОбъектАдресации - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО
//   ДополнительныйОбъектАдресации - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеСсылочногоОбъектаДО
//
// Возвращаемое значение:
//   ОбъектXDTO - объект XDTO типа DMTaskParticipant.
//
Функция УчастникЗадач(Прокси, Исполнитель, ОсновнойОбъектАдресации = Неопределено, Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.УчастникЗадач(Прокси, Исполнитель, ОсновнойОбъектАдресации, );

URIПространстваИменВебСервисаДокументооборота

Описание, пример вызова

// Возвращает URI пространства имен веб-сервиса 1С:Документооборот.
//
// Возвращаемое значение:
//   Строка
//
Функция URIПространстваИменВебСервисаДокументооборота() Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.URIПространстваИменВебСервисаДокументооборота()

ИмяВебСервисаДокументооборота

Описание, пример вызова

// Возвращает имя веб-сервиса 1С:Документооборот.
//
// Возвращаемое значение:
//   Строка
//
Функция ИмяВебСервисаДокументооборота() Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ИмяВебСервисаДокументооборота()

КлючСопоставленияПользователяТокенаДоступа

Описание, пример вызова

// Возвращает ключ сопоставления пользователя, который будет передан в токена доступа.
// Ключ зависит от текущих настроек, это может быть имя пользователя ИБ или пользователь ОС.
//
// Возвращаемое значение:
//   Строка
//
Функция КлючСопоставленияПользователяТокенаДоступа() Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.КлючСопоставленияПользователяТокенаДоступа()

ПараметрыТокенаДоступа

Описание, пример вызова

// Возвращает структуру параметров, необходимую для формирования токена доступа.
//
// Возвращаемое значение:
//   Структура:
//     * Эмитент - Строка
//     * ВремяСоздания - Число
//     * ВремяЖизни - Число
//     * Идентификатор - УникальныйИдентификатор
//     * Получатели - Массив из Строка
//     * КлючСопоставленияПользователя - Строка
//
Функция ПараметрыТокенаДоступа() Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПараметрыТокенаДоступа()

ПолучателиТокенаДоступа

Описание, пример вызова

// Возвращает массив получателей, необходимый для формирования токена доступа.
//
// Возвращаемое значение:
//   Массив из Строка
//
Функция ПолучателиТокенаДоступа() Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПолучателиТокенаДоступа()

ПсевдонимВебСервисаДокументооборота

Описание, пример вызова

// Возвращает псевдоним веб-сервиса 1С:Документооборот.
//
// Возвращаемое значение:
//   Строка
//
Функция ПсевдонимВебСервисаДокументооборота() Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПсевдонимВебСервисаДокументооборота()

ТекстТокенаДоступа

Описание, пример вызова

// Формирует текстовое представление JWT-токена для авторизации в веб-сервисе Документооборота.
//
// Возвращаемое значение:
//   Строка
//
Функция ТекстТокенаДоступа() Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ТекстТокенаДоступа()

ЭмитентТокенаДоступа

Описание, пример вызова

// Возвращает эмитента, необходимого для формирования токена доступа.
//
// Возвращаемое значение:
//   Строка
//
Функция ЭмитентТокенаДоступа() Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ЭмитентТокенаДоступа()

ДанныеПодписей

Описание, пример вызова

// Преобразует таблицу подписей на форме в массив структурированных данных подписей.
//
// Параметры:
//   ТаблицаПодписей - см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.СтруктураСтрокиДереваПодписей
//
// Возвращаемое значение:
//   Массив из см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеПодписи
//
Функция ДанныеПодписей(ТаблицаПодписей) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ДанныеПодписей(ТаблицаПодписей)

ДанныеПодписи

Описание, пример вызова

// Возвращает данные, из которых будет формироваться XDTO объект DMSignature, для передачи в ДО.
//
// Параметры:
//   Подпись - ДвоичныеДанные - двоичные данные подписи.
//   ДвоичныеДанныеСертификата - ДвоичныеДанные - двоичные данные сертификата.
//   СвойстваПодписи - Структура - тут может быть или структура СвойстваПодписи, которую возвращает БСП при
//     добавлении новой подписи, или строка таблицы подписей, если это уже существующая на стороне ДО подпись.
//
// Возвращаемое значение:
//   см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.ДанныеПодписи
//
Функция ДанныеПодписи(Подпись, ДвоичныеДанныеСертификата, СвойстваПодписи) Экспорт

Пример вызова

Результат = ИнтеграцияС1СДокументооборотБазоваяФункциональность.ДанныеПодписи(Подпись, ДвоичныеДанныеСертификата, СвойстваПодписи)

ПроверитьПодписи

Описание, пример вызова

// Проверяет подписи из массива ВыделенныеСтроки. Если массив выделенных строк не передан - проверяет все
// подписи из таблицы подписей.
//
// Параметры:
//   МенеджерКриптографии - МенеджерКриптографии - объект Менеджера криптографии.
//   ТаблицаПодписей - Массив из см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиентСервер.СтруктураСтрокиДереваПодписей
//   УникальныйИдентификатор - УникальныйИдентификатор - идентификатор управляемой формы объекта Документооборота.
//   ВыделенныеПодписи - Массив из см. ИнтеграцияС1СДокументооборотБазоваяФункциональностьКлиент.ВыделенныеПодписи
//   АдресСлепкаДокумента - Строка - адрес временного хранилища двоичных данных документа Документооборота.
//
Процедура ПроверитьПодписи(МенеджерКриптографии, ТаблицаПодписей, УникальныйИдентификатор, Экспорт

Пример вызова

ИнтеграцияС1СДокументооборотБазоваяФункциональность.ПроверитьПодписи(МенеджерКриптографии, ТаблицаПодписей, УникальныйИдентификатор, );

---

© 2024, ООО 1С-Софт
Все права защищены. Эта программа и сопроводительные материалы предоставляются
в соответствии с условиями лицензии Attribution 4.0 International (CC BY 4.0).

---