.. _configuring-type:

Настройка взаимодействия с интеграционным модулем
=================================================

Для обеспечения передачи данных между модулем xDE для SAP и ИМ в системе SAP необходимо 
указать тип взаимодействия с ИМ (WS), а затем выбрать тип веб-сервиса, который будет использоваться (REST).

Кроме того, должны быть выполнены следующие настройки:

* настроена авторизация;
* создан системный пользователь;
* запланировано фоновое задание отправки документов;
* запланировано фоновое задание получения статусов.

При необходимости раздельного получения документа и печатной формы необходимо выполнить дополнительную настройку.


Выбор типа взаимодействия с ИМ 
------------------------------

В xDE для SAP ERP предусмотрено два способа взаимодействия с ИМ:

* веб-сервис (REST API);
* технология RFC - Remote Function Call (не используется).


Для выбора необходимого типа взаимодействия выполните следующие действия.

#. Запустите транзакцию ``SM30``.

   .. image:: ris37.png
      :scale: 84
      :align: center
      :alt: Запуск транзакции SM30


#. Откроется страница ``Ведение ракурса таблицы: первый экран``. Введите имя таблицы ``/TRL/XDE_CUST`` и нажмите ``Ведение``.

   .. image:: ris42.png
      :scale: 74
      :align: center
      :alt: Открытие таблицы со списком общих настроек xDE для SAP


#. Для того чтобы выбрать тип взаимодействия с ИМ, требуется указать в настроечной таблице необходимое значение параметра ``IM.INTEGRATION_TYPE``. Для этого нажмите |search2| и перейдите 
   к окну подробного ведения настройки.

   .. image:: ris43.png
      :scale: 79
      :align: center
      :alt: Переход к подробному ведению настройки IM.INTEGRATION_TYPE


#. В открывшемся окне в поле ``Значение настройки`` укажите требуемый
   тип взаимодействия для интеграции посредством веб-сервиса - WS.


    Нажмите |save|.

   .. image:: ris44.png
      :scale: 79
      :align: center
      :alt: Выбор типа взаимодействия с ИМ

#. Затем необходимо выбрать тип веб-сервиса, который будет использоваться (REST). Для этого укажите в настроечной таблице ``/TRL/XDE_CUST`` соответствующее значение параметра ``IM.WS_INTEGRATION`` - REST.


Подробнее см. :ref:`Configuring-REST`.


Настройка авторизации
--------------------------

Настройку авторизации можно выполнить либо запустив транзакцию ``/TRL/XDE_REST_SV``,
либо перейдя к ведению ракурса таблицы ``/TRL/XDE_VRESTSV`` из транзакции ``SM30``.

Необходимо заполнить поля таблицы:

* HTTP адрес для обращения к REST;
* Имя пользователя;
* Пароль.


.. image:: authorization.png
   :scale: 78
   :align: center
   :alt: Настройка авторизации

Для настроек веб-сервиса для работы с интеграционным модулем (Integration API) используется тип REST сервиса ``REST_IM``.
Настройка данного типа веб-сервиса является обязательной.

При необходимости таким же образом настраиваются:

* ``REST_ARCH`` - веб-сервис для работы с архивом (Archive API)
* ``REST_CRYPT`` - веб-сервис для работы с криптографией (Crypto API).


Создание системного пользователя XDEWSUSER
---------------------------------------------

В системе SAP должен быть создан системный пользователь **XDEWSUSER** с постоянно действующим паролем. Для создания системного пользователя необходимо выполнить следующие действия.

#. Запустите транзакцию ``SU01``.
        
#. Откроется страница ``Ведение пользователей: первый экран``. Введите техническое имя пользователя и нажмите |new| (Создать).

   .. image:: rest77.png
      :scale: 90
      :align: center
      :alt: Переход к созданию пользователя


#. В открывшемся окне ``Ведение пользователей`` на закладке ``Адрес`` заполните соответствующие поля данными о пользователе, указанными в таблице ниже.

   .. image:: rest78.png
      :scale: 54
      :align: center
      :alt: Ведение системного пользователя XDEWSUSER (Адрес)


#. Перейдите на закладку ``Данные входа`` и заполните соответствующие поля данными, указанными в таблице ниже.

   .. image:: rest79.png
      :scale: 54
      :align: center
      :alt: Ведение системного пользователя XDEWSUSER (Данные входа)


#. Перейдите на закладку ``Роли`` и присвойте пользователю роль ``/TRL/XDE_SERVICEUSER``. Нажмите |save|.

   .. image:: rest80.png
      :scale: 67
      :align: center
      :alt: Ведение системного пользователя XDEWSUSER (Роли)


       
   .. table:: Данные о системном пользователе XDEWSUSER
        :align: center
        :widths: 8 8

        +-------------------------------+---------------------------------------------+
        | Имя поля                      | Значение                                    |
        +===============================+=============================================+
        | Закладка ``Адрес``                                                          |
        +-------------------------------+---------------------------------------------+
        | Фамилия                       | TerraLink xDE                               |
        +-------------------------------+---------------------------------------------+
        | Полное имя                    | TerraLink xDE (заполняется автоматически)   |
        +-------------------------------+---------------------------------------------+
        | Язык                          | Русский                                     |
        +-------------------------------+---------------------------------------------+
        | Функция                       | Системный пользователь                      |
        +-------------------------------+---------------------------------------------+
        | Закладка ``Данные входа``                                                   |
        +-------------------------------+---------------------------------------------+
        | ТипПользов                    | Система                                     |
        +-------------------------------+---------------------------------------------+
        | Пароль                        | <произвольный>                              |
        +-------------------------------+---------------------------------------------+
        | Закладка ``Роли``                                                           |
        +-------------------------------+---------------------------------------------+
        | Роль                          | /TRL/XDE_SERVICEUSER                        |
        +-------------------------------+---------------------------------------------+


Планирование фонового задания для отправки исходящих документов
-------------------------------------------------------------------

Для отправки исходящих документов в системе SAP должно быть запланировано фоновое задание отправки.

.. important:: Для реализации параллельной отправки рекомендуется для каждого ящика системы SAP запланировать отдельное фоновое задание.

Для планирования фонового задания выполните следующие действия.

#. Запустите транзакцию ``SA38``.

   .. image:: rest81.png
      :scale: 79
      :align: center
      :alt: Запуск транзакции ``SA38``


#. Введите имя отчета ``/TRL/XDE_WS_OUTBOUND_PROC`` и нажмите |run| (Выполнить).

   .. image:: rest82.png
      :scale: 70
      :align: center
      :alt: Переход к выполнению отчета ``/TRL/XDE_WS_OUTBOUND_PROC``


#. В открывшемся окне укажите значения следующих полей:

   *  **Код оператора ЭД** – уникальный идентификатор оператора ЭДО, присвоенный ФНС (подробнее см. :ref:`list-operators`);
   *  **Адрес в системе ОЭД** – адрес ящика контрагента в системе оператора ЭДО (подробнее см. :ref:`Идентификаторы`).

   .. image:: rest83.png
      :scale: 88
      :align: center
      :alt: Заполнение полей программы отправки документов


#. Выберите в меню ``Перейти к`` -> ``Варианты`` -> ``Сохранить как вариант…``.

   .. image:: rest84.png
      :scale: 75
      :align: center
      :alt: Переход к сохранению варианта


#. Откроется страница ``Атрибуты варианта``. Заполните поля данными, указанными в таблице, и нажмите |save|.

   .. _Данные варианта отчета:
   
   .. list-table:: Данные варианта отчета
        :align: center
        :widths: 10 10
        :header-rows: 1

        * - Имя поля
          - Описание
        * - Имя варианта
          - Произвольное уникальное имя варианта
        * - Значение
          - Произвольное наименование варианта
        * - Флаг: Защитить вариант
          - Установить флаг для защиты варианта
          
   .. image:: rest85.png
      :scale: 63
      :align: center
      :alt: Заполнение полей для варианта отчета отправки документов

#. Перейдите в транзакцию ``SM36``.

   .. image:: rest86.png
      :scale: 67
      :align: center
      :alt: Запуск транзакции ``SM36``


#. Откроется страница ``Определение задания``. Заполните поля данными, указанными в таблице, и нажмите кнопку ``Шаг``.

   .. list-table:: Определение задания для отправки документов
        :align: center
        :widths: 5 15
        :header-rows: 1

        * - Имя поля 
          - Значение
        * - Имя задания
          - Произвольное уникальное имя фонового задания.

            Рекомендуется использовать следующий формат:
            
            *XDE_SND_[Код оператора]_[Последовательный номер задания для текущего оператора]*
            
            Например, *XDE_SND_2BM_01*
        * - Класс задания
          - C

   .. image:: rest87.png
      :scale: 65
      :align: center
      :alt: Определение задания для отправки документов


#. В окне создания шага заполните поля данными, указанными в таблице, и нажмите |save|.

   .. list-table:: Данные создания шага задания для отправки документов
        :align: center
        :widths: 5 15
        :header-rows: 1

        * - Имя поля 
          - Описание
        * - Пользователь
          - XDEWSUSER (созданный системный пользователь)
        * - Имя
          - TRL/XDE_WS_OUTBOUND_PROC 
        * - Вариант
          - Имя варианта
        * - Язык
          - RU

   .. image:: rest88.png
      :scale: 95
      :align: center
      :alt: Создание шага задания для отправки документов


#. На странице ``Обзор списка шагов`` нажмите |back| (Назад).

   .. image:: rest89.png
      :scale: 72
      :align: center
      :alt: Обзор списка шагов


#. Вы снова окажетесь на странице ``Определение задания``. Нажмите кнопку ``Условие запуска``.

   .. image:: rest90.png
      :scale: 62
      :align: center
      :alt: Переход к условиям запуска


#. В окне ``Значения срока запуска`` нажмите кнопку ``Немедленно``.

   .. image:: rest91.png
      :scale: 99
      :align: center
      :alt: Значения срока запуска


#. Выберите опцию ``Выполнять задание периодически`` и нажмите кнопку ``Значения периодов``.

   .. image:: rest92.png
      :scale: 99
      :align: center
      :alt: Переход к значениям периодов вызова задания


#. В окне ``Значения периодов`` нажмите ``Другой период``.

   .. image:: rest93.png
      :scale: 100 %
      :align: center
      :alt: Значения периодов вызова задания


#. В открывшемся окне введите необходимое значение и нажмите |save|.

   .. note:: Значение периода вызова задания необходимо указывать, исходя из конфигурации и мощностей используемой системы.

   .. image:: rest94.png
      :scale: 100 %
      :align: center
      :alt: Выбор значения периода вызова задания


#. В окне ``Значения периодов`` нажмите |save|.

   .. image:: rest95.png
      :scale: 100 %
      :align: center
      :alt: Сохранение значения периодов вызова задания


#. На странице ``Значения срока запуска`` нажмите |save|.

   .. image:: rest96.png
      :scale: 99
      :align: center
      :alt: Сохранение значения срока запуска


#. На странице ``Определение задания`` нажмите |save|.

   .. image:: rest97.png
      :scale: 72
      :align: center
      :alt: Сохранение задания для отправки документов


Фоновое задание для отправки исходящих документов создано.

Планирование фонового задания для получения статусов документов
-------------------------------------------------------------------

Для получения статусов входящих и исходящих документов из ИМ в системе SAP должно быть запланировано фоновое задание.

.. important:: Для реализации параллельного получения и обработки статусов рекомендуется для каждого ящика системы SAP запланировать отдельное фоновое задание.

Для планирования фонового задания выполните следующие действия.

#. Запустите транзакцию ``SA38``.

   .. image:: rest81.png
      :scale: 83
      :align: center
      :alt: Запуск транзакции ``SA38``


#. Введите имя отчета ``/TRL/XDE_WS_INBOUND_PROC`` и нажмите |run| (Выполнить).

   .. image:: rest98.png
      :scale: 75
      :align: center
      :alt: Переход к выполнению отчета ``/TRL/XDE_WS_INBOUND_PROC``


#. В открывшемся окне укажите значения следующих полей:

   *  **Код оператора ЭД** – уникальный идентификатор оператора ЭДО, присвоенный ФНС (подробнее см. :ref:`list-operators`);
   *  **Адрес в системе ОЭД** – адрес ящика контрагента в системе оператора ЭДО (подробнее см. :ref:`Идентификаторы`).

   .. image:: rest99.png
      :scale: 60
      :align: center
      :alt: Заполнение полей программы получения статусов


#. Выберите в меню ``Перейти к`` -> ``Варианты`` -> ``Сохранить как вариант…``.

      .. image:: rest84.png
         :scale: 75
         :align: center
         :alt: Переход к сохранению варианта

   
#. Откроется страница ``Атрибуты варианта``. Заполните поля данными, указанными в таблице :ref:`Данные варианта отчета`, и нажмите |save|.

   .. image:: rest100.png
      :scale: 61
      :align: center
      :alt: Заполнение полей для варианта отчета получения статусов


#. Перейдите в транзакцию ``SM36``.

   .. image:: rest86.png
      :scale: 67
      :align: center
      :alt: Запуск транзакции ``SM36``


#. Откроется страница ``Определение задания``. Заполните поля данными, указанными в таблице и нажмите кнопку ``Шаг``.

   .. list-table:: Определение задания для получения статусов
        :align: center
        :widths: 5 15
        :header-rows: 1

        * - Имя поля
          - Значение                                                                                   
        * - Имя задания
          - Произвольное уникальное имя фонового задания.                                              
            
            Рекомендуется использовать следующий формат:  
            
            *XDE_RCV_[Код оператора]_[Последовательный номер задания для текущего оператора]*
            
            Например, *XDE_ RCV_2BM_01*                                                             
        * - Класс задания
          - C                                                                                          

   .. image:: rest101.png
      :scale: 68
      :align: center
      :alt: Определение задания для получения статусов


#. В окне создания шага заполните поля данными, указанными в таблице, и нажмите |save|.

   .. list-table:: Данные создания шага задания для получения статусов
        :align: center
        :widths: 5 15
        :header-rows: 1
        
        * - Имя поля
          - Описание 
        * - Пользователь
          - XDEWSUSER (созданный системный пользователь)
        * - Имя
          - TRL/XDE_WS_INBOUND_PROC
        * - Вариант
          - Имя варианта, созданного в пп. 1–5 (см. Таблицу  :ref:`Данные варианта отчета`)
        * - Язык
          - RU


   .. image:: rest102.png
      :scale: 98
      :align: center
      :alt: Создание шага задания для получения статусов


#. На странице ``Обзор списка шагов`` нажмите |back| (Назад).

   .. image:: rest103.png
      :scale: 88
      :align: center
      :alt: Обзор списка шагов



#. Вы снова окажетесь на странице ``Определение задания``. Нажмите кнопку ``Условие запуска``.

   .. image:: rest104.png
      :scale: 69
      :align: center 
      :alt: Переход к условиям запуска


#. В окне ``Значения срока запуска`` нажмите кнопку ``Немедленно``.

    .. image:: rest91.png
       :scale: 97
       :align: center
       :alt: Значения срока запуска

   
#. Выберите опцию ``Выполнять задание периодически`` и нажмите кнопку ``Значения периодов``.

   .. image:: rest92.png
      :scale: 99
      :align: center
      :alt: Переход к значениям периодов вызова задания

   
#. В окне ``Значения периодов`` нажмите ``Другой период``.
   
   .. image:: rest93.png
      :scale: 100 %
      :align: center
      :alt: Значения периодов вызова задания


#. В открывшемся окне введите необходимое значение и нажмите |save|.

   .. note:: Значение периода вызова задания необходимо указывать, исходя из конфигурации и мощностей используемой системы.
    
   .. image:: rest94.png
      :scale: 100 %
      :align: center
      :alt: Выбор значения периода вызова задания


#. В окне ``Значения периодов`` нажмите |save|.

   .. image:: rest95.png
      :scale: 100 %
      :align: center
      :alt: Сохранение значения периодов вызова задания


#. На странице ``Значения срока запуска`` нажмите |save|.

    .. image:: rest96.png
       :scale: 97
       :align: center
       :alt: Сохранение значения срока запуска

   
#. На странице ``Определение задания`` нажмите |save|.

  .. image:: rest105.png
     :scale: 71
     :align: center
     :alt: Сохранение задания для получения статусов


Фоновое задание для получения статусов документов создано.


.. _settings-integration-type-pf:

Настройка интеграции с ИМ при раздельном получении документа и печатной формы
------------------------------------------------------------------------------

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

.. important:: 

     В случае работы с :ref:`модулем обмена EDI-сообщениями<edi>` данная настройка является обязательной.

Для подключения данного типа интеграции используется настройка ``GET_DOC_STS_NEW``. 
Эта настройка находится в таблице ``/TRL/XDE_CUST``, которую можно просмотреть через транзакцию ``sm30``.

Чтобы получение/отправка непосредственно файла электронного документа с ЭП и создание печатной формы к нему были разделены,
в настройке ``GET_DOC_STS_NEW`` необходимо установить значение "X".
В этом случае получение печатной формы для электронных документов будет обозначаться отдельным статусом с постфиксом "PF/P". 
Перечень этих статусов указан в разделе :ref:`pf_status_schemes`.

В случае если в настройке ``GET_DOC_STS_NEW`` будет установлено «пустое» значение, то получение/отправка непосредственно файла 
электронного документа с ЭП и создание печатной формы разделены не будут, статусная схема документооборота не изменится.


.. |save| image:: save.png     
   :width: 29
   :height: 27

.. |new| image:: new.png     
   :width: 28
   :height: 28

.. |run| image:: run.png     
   :width: 27
   :height: 28

.. |back| image:: back.png     
   :width: 24
   :height: 33

.. |search2| image:: search2.png     
   :width: 42
   :height: 36