Создание исходящей отправки¶

*"----------------------------------------------------------------------
*"*"Локальный интерфейс:
*"  IMPORTING
*"     VALUE(IV_OPERATOR) TYPE  /TRL/XDE_OED-ID_OED OPTIONAL
*"     VALUE(IV_PACKAGE_TYPE) TYPE  /TRL/XDE_ED_PACKAGE_TYPE OPTIONAL
*"     VALUE(IV_NEED_APPROVE) TYPE  XFELD OPTIONAL
*"     VALUE(IV_DIALOG) TYPE  XFELD DEFAULT ''
*"     VALUE(IS_OBJECT) TYPE  BORIDENT
*"     VALUE(IS_CERTIFICATE) TYPE  /TRL/XDE_S_SAP_DOC_TYPE_CERT
*"       OPTIONAL
*"     VALUE(IS_PARTNER_DATA) TYPE  /TRL/XDE_S_SHIP_PARTNER OPTIONAL
*"     VALUE(IS_DEPARTMENT_DATA) TYPE  /TRL/XDE_S_DEPARTMENT_DATA
*"       OPTIONAL
*"     VALUE(IS_SENDER_BOX) TYPE  /TRL/XDE_BOX_ID OPTIONAL
*"     VALUE(IS_RECEIVER_BOX) TYPE  /TRL/XDE_BOX_ID OPTIONAL
*"     VALUE(IS_CARRIER_BOX) TYPE  /TRL/XDE_BOX_ID OPTIONAL
*"     REFERENCE(IT_DOC_TYPE_DATA) TYPE  /TRL/XDE_T_DOC_TYPE_DATA
*"       OPTIONAL
*"     REFERENCE(IT_RELATIONS) TYPE  /TRL/XDE_T_RELATION_DATA OPTIONAL
*"     REFERENCE(IV_NREADY) TYPE  XFLD OPTIONAL
*"     REFERENCE(IV_BPROC) TYPE  /TRL/XDE_ED_PROCESS OPTIONAL
*"     REFERENCE(IV_COMMIT) TYPE  FLAG_X DEFAULT 'X'
*"     REFERENCE(IV_NO_SIGN) TYPE  FLAG_X OPTIONAL
*"  EXPORTING
*"     REFERENCE(ET_HEADER) TYPE  /TRL/XDE_T_HEADER
*"     REFERENCE(ET_RETURN) TYPE  BAPIRET2_T
*"----------------------------------------------------------------------

Функциональный модуль /TRL/XDE_API_SHIPM_OUT_ADD создает исходящие отправки.

Таблица 85 Описание интерфейса функционального модуля `/TRL/XDE_API_SHIPM_OUT_ADD`¶
Параметр	Описание
`IMPORTING`
`IV_OPERATOR`	Идентификатор оператора, через которого должна быть выполнена отправка документов. Параметр обязателен для заполнения при фоновой отправке.
`IV_PACKAGE_TYPE`	Способ отправки («» – одиночная/«PGR» – пакетная).
`IV_NEED_APPROVE`	Флаг: требуется согласование. Если передано значение «X», то отправка создается без подписания и не добавляется в очередь отправки. Статус отправки после создания задается настройкой `STATUS_O_NEED_APPROVE` (см. раздел Общие настройки Продукта) и может быть переопределен через расширение (см. настройку `FM_FCS` в разделе Настройка видов документов SAP).
`IV_DIALOG`	Флаг: создать отправки в диалоговом режиме. Если равен «X», то создание отправок выполняется в диалоговом режиме, иначе в фоновом.
`IS_OBJECT`	Тип и ключ бизнес-объекта SAP, для которого создаются отправки. Параметр должен быть заполнен.
`IS_CERTIFICATE`	Сертификат для подписания отправок. Если не заполнен и IV_NEED_APPROVE = «», то определяется автоматически на основе настроек подписания для пользователя. Если IV_NEED_APPROVE = «X», значение параметра игнорируется.
`IS_PARTNER_DATA`	Данные отправителя/получателя. Параметр обязателен для заполнения при фоновой отправке.
`IS_DEPARTMENT_DATA`	Данные о подразделении
`IS_SENDER_BOX`	Данные ящика отправителя в системе ОЭД. Параметр обязателен для заполнения при фоновой отправке.
`IS_RECEIVER_BOX`	Данные ящика получателя в системе ОЭД. Параметр обязателен для заполнения при фоновой отправке.
`IS_CARRIER_BOX`	Данные ящика перевозчика в системе ОЭД. Параметр обязателен для заполнения при фоновой отправке.
`IT_DOC_TYPE_DATA`	Список документов для отправки. Для каждой записи, указанной в таблице, будет создана отдельная отправка. Параметр обязателен для заполнения при фоновой отправке. Для каждого документа в таблице может быть указана следующая информация: Вид документа SAP (поле `DTYPE`). Должен быть заполнен обязательно. GUID отправки SAP (поле `REF_RECORD_ID`). Комментарий для отправки контрагенту (поле `ZCOMMENT`). Ссылка на структуру с данными документа (поле `DATA`): Акт сдачи-приемки работ (тип `/TRL/XDE_S_ACSR`). Корр. счет-фактура (тип `/TRL/XDE_S_INVO_COR`). Счет-фактура (тип `/TRL/XDE_S_INVO`). Неформализованное вложение (`/TRL/XDE_S_NONF`). Торг-12 (`/TRL/XDE_S_NT12`). Если указана ссылка на структуру с данными документа, то в настройках для данного вида документа SAP должны быть отключены стандартные модули сбора данных ( см. настройку `FM_BLD` в разделе Настройка видов документов SAP). Атрибуты отправки для отображения в отчетах `/TRL/XDE_INBOX//TRL/XDE_OUTBOX` (поле `ATTR`). Если используется стандартный сбор данных, то данные атрибуты заполняются при сборе данных. В противном случае требуется заполнение при вызове данного API. Метаданные документа (поле `MDATA`). Бинарные данные документа (поле `BIN_DATA`). Обязательно должны быть заполнены поля `BIN_DATA-BIN_DATA`, `BIN_DATA-BIN_DATA_SIZE`, `BIN_DATA-FILE_NAME`. Ссылка на документ в Архивном сервере (поле `DOC_DATA`). Обязательно должны быть заполнены поля `DOC_DATA-LINK`, `DOC_DATA-ASTYPE`, `DOC_DATA-FILE_NAME`. Для неформализованных документов обязательно должны быть заполнены либо бинарные данные документа (поле `BIN_DATA`), либо ссылка на документ в Архивном сервере (поле `DOC_DATA`). Для формализованных документов должны быть заполнены либо бинарные данные документа (поле `BIN_DATA`), либо ссылка на документ в Архивном сервере (поле `DOC_DATA`), либо ссылка на структуру с данными документа. Если не заполнено ни одно из перечисленных полей, то используются модули сбора данных (см. настройку `FM_BLD` в разделе Настройка видов документов SAP).
`IT_RELATIONS`	Список связанных отправок.
`IV_NREADY`	Отложенная отправка. Необходим для установки статуса R1.
`IV_BPROC`	Код бизнес-процесса. Используется для массовой отправки
`IV_COMMIT`	Флаг выполнения коммита. По умолчанию принимает значение «X»
`IV_NO_SIGN`	Флаг отправки без подписи. По умолчанию принимает пустое значение
`EXPORTING`
`ET_HEADER`	Список созданных отправок.
`ET_RETURN`	Таблица сообщений с результатами создания отправок.

Если стоит флаг диалогового режима – достаем данные по настройке PRD_MODULE, после чего создается объект логирования.

Выполняем проверку полномочий на действия «Подписать» и «Поставить в очередь отправки» вне зависимости от режима работы ФМ.

Если проверка полномочий провалится – в лог будет добавлено сообщением «Нет полномочий на выполнение операции» и работа ФМ закончится. Если при этом будет стоять флаг диалогового режима – сразу будет выведен лог.

Поиск ФМ для проверки возможности отправки для БО. Ищется по настройке FM_SHIP_OUT_CHKBEFORSEND. Если нашли – вызывается этот функциональный модуль.

Если настройка не заполнена – ошибки не возникнет.
Если в ходе работы настроенного ФМ возникнет ошибка – в лог будет добавлено текущее сообщение, сформированное в ФМ и произойдет выход из ФМ. В случае диалогового режима – сразу будет выведен лог.

Далее сильное разделение по функционалу в зависимости от режима.

В случае диалогового режима – определяем партнеров документооборота с помощью ФМ /TRL/XDE_GET_SHIP_OUT_PARTNERS. Этот ФМ достает имя модуля из настройки FM_SHIP_OUT_PARTNERS и делает вызов.

Если в ходе выполнения ФМ /TRL/XDE_GET_SHIP_OUT_PARTNERS возникнут ошибки – в лог будет добавлено системное сообщение, выведен лог и произойдет выход из ФМ.

Далее ищем ФМ создания отправки по имени настройки FM_SHIP_OUT_ADD_DIALOG.

Если ФМ не найден – будет выведен лог с сообщением «& & & Не задан ФМ постановки в очередь отправки (/TRL/XDE_SHIP_TY)», после произойдет выход из ФМ.

Вызов найденного ФМ создания отправки.

Если пользователь отменит создание – произойдет выход из ФМ

Если возникнет другая ошибка – будет выведен лог с текущим системным сообщением, после чего произойдет выход из ФМ

В случае если ФМ запущен не в диалоговом режиме – выполняем цикл по входной таблице IT_DOC_TYPE_DATA и ищем ФМ для проверки документа перед постановкой документа по имени настройки FM_BSET.

Если имя ФМ найдено – происходит вызов ФМ проверки документа перед постановкой.

Если в ходе выполнения ФМ была вызвана особая ситуация EXCLUDE_FROM_LIST – удаляем текущую запись из входной таблицы IT_DOC_TYPE_DATA.

Если в ходе выполнения ФМ возникла какая-либо другая ошибка – в лог добавляется текущее системное сообщение.

Далее выполняются шаги, независимые от режима запуска функционального модуля. Вызов ФМ /TRL/XDE_SHIPMENT_OUT_ADD. Этот ФМ для постановки единичного документа в очередь отправки. В цикле по списку документов для отправки – получаем настройки вида документа SAP и выполняем проверку, что для неформализованных документов должны быть заполнены бинарные данные или ссылка на документ в архиве.

Если не будут найдены настройки по типу пакетной отправки в /TRL/XDE_SOUT_TY – в лог будет добавлено сообщение «Осуществите ведение видов док-ов отправок ОЭД для вида док-та SAP & &»

Если для неформализованных документов не заполнены ни бинарные данные, ни ссылки на архив – добавляем в лог сообщение «& & & Нет документов для отправки». Это считается ошибкой и после такого ФМ закончит свою работу.

Далее для пакетной отправки – определяем номер пакета и позиции пакетной отправки. После чего в цикле по документам вызывается ФМ /TRL/XDE_ADD_SHIPMENTS_OUT, который добавляет исходящее отправление. Этот ФМ собирает данные, находит настраиваемые ФМ для постановки документов в очередь, выполняет проверку полномочий, определяет способ подписания и сертификата, выполняет сбор данных (или просто подставляет данные из бинарных данных/ссылок на документ в архиве), вызов ФМ изменений перед отправкой, вызов ФМ конвертации данных в формат передачи, подписывает документы, сохраняет в архив, связывает с БО, связывает с другими отправлениями, сохраняет длинные тексты, обновляет таблицы и вызывает ФМ обновления статуса.

Данная API-функция подразумевает возможность расширения для заказчика.

Важно

При использовании явных или неявных операторов COMMIT WORK и ROLLBACK WORK в расширениях корректная работа API-функций не гарантируется!

Функциональный модуль проверки возможности выполнения отправки для бизнес-объекта¶

Имя функционального модуля проверки возможности выполнения отправки для бизнес-объекта хранится в таблице /TRL/XDE_CUST по имени настройки FM_SHIP_OUT_CHKBEFORSEND.