.. _DashboardSettingsOperators: Настройки операторов ======================== Для просмотра и редактирования настроек операторов необходимо на странице с настройками выбрать пункт меню ``Операторы`` или перейти по адресу: ``{адрес:порт}/settings/operators``. Откроется страница, на которой находится таблица, содержащая всех добавленных операторов. .. image:: ris6.png :scale: 55 :align: center :alt: Настройки операторов Добавление нового оператора ------------------------------- Для добавления нового оператора необходимо на странице с настройками операторов нажать кнопку ``Добавить``. После этого появится выпадающий список, содержащий всех доступных операторов согласно текущей лицензии. Выберите необходимого оператора из списка. .. note:: Работа с лицензиями описана в разделе :ref:`Руководство по работе с лицензиями `. .. image:: ris7.png :scale: 94 % :align: center :alt: Добавление нового оператора Откроется страница с формой для добавления нового оператора. На форме находятся четыре вкладки: - :ref:`DashboardSettingsOperators-General`; - :ref:`DashboardSettingsOperators-Boxes`; - :ref:`DashboardSettingsOperators-CustomDocumentTypes`; - :ref:`DashboardSettingsOperators-Features`. .. _DashboardSettingsOperators-General: Оператор ~~~~~~~~~~~~~~~~ На вкладке ``Оператор`` находятся поля для ввода настроек оператора (код оператора, название оператора, ИНН оператора и т.д.). .. note:: Описание параметров всех операторов см. `Параметры операторов`_. .. image:: img/DashboardSettingsOperators-1.png :scale: 79 % :align: center :alt: Настройки оператора .. note:: Код оператора должен быть уникальным. Нельзя добавить несколько операторов с одинаковым кодом. Для сохранения введенных параметров нажмите кнопку ``Сохранить``. В случае если сохранять введенные данные не требуется, нажмите кнопку ``Отмена``. .. _DashboardSettingsOperators-Boxes: Ящики ~~~~~~~~~~~~~~~~ На вкладке ``Ящики`` находится таблица с ящиками данного оператора. .. image:: img/DashboardSettingsOperators-2.png :scale: 44 :align: center :alt: Ящики оператора Для добавления нового ящика нажмите кнопку ``Добавить``. Откроется страница с формой для добавления нового ящика. Заполните поля с параметрами ящика. .. note:: Описание параметров всех ящиков операторов см. `Параметры ящиков операторов`_. .. image:: img/DashboardSettingsOperators-3.png :scale: 60 :align: center :alt: Добавление нового ящика .. note:: Идентификатор ящика должен быть уникальным. Нельзя добавить несколько ящиков с одинаковым идентификатором. Если на форме присутствует кнопка ``Доверенность``, то можно задать параметры доверенности, если в качестве технического сертификата выбран сертификат физического лица. .. image:: img/DashboardSettingsOperators-PowerOfAttorney.png :scale: 60 :align: center :alt: Добавление нового ящика Задается либо идентификационная информация доверенности (идентификатор доверенности и ИНН доверителя), либо подгружаются файлы доверенности. Для сохранения введенных параметров нажмите кнопку ``Сохранить``. В случае если сохранять введенные данные не требуется, нажмите кнопку ``Отмена``. Для изменения типа ящика нужно на странице с ящиками оператора в таблице выбрать необходимый ящик и нажать кнопку ``Изменить``. Откроется страница с формой для изменения ящика. Данная форма аналогична форме добавления нового ящика. Для удаления ящика нужно на странице с ящиками оператора в таблице выбрать необходимый ящик и нажать кнопку ``Удалить``. Появится всплывающее окно с подтверждением удаления. .. _DashboardSettingsOperators-CustomDocumentTypes: Полуформализованные типы ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ На вкладке ``Полуформализованные типы`` находится таблица с полуформализованными типами документов данного оператора. .. image:: ris88.png :scale: 40 % :align: center :alt: Полуформализованные типы оператора Для добавления нового типа нажмите кнопку ``Добавить``. Откроется страница с формой для добавления нового типа. Заполните поля с параметрами типа. .. note:: Описание параметров полуформализованных типов см. :ref:`parameters_halfformal`. .. image:: img/DashboardSettingsOperators-4.png :scale: 53 :align: center :alt: Добавление нового типа Для сохранения введенных параметров нажмите кнопку ``Сохранить``. В случае если сохранять введенные данные не требуется, нажмите кнопку ``Отмена``. Для изменения типа нужно на странице с типами оператора в таблице выбрать необходимый тип и нажать кнопку ``Изменить``. Откроется страница с формой для изменения типа. Данная форма аналогична форме добавления нового типа. Для удаления типа нужно на странице с типами оператора в таблице выбрать необходимый тип и нажать кнопку ``Удалить``. Появится всплывающее окно с подтверждением удаления. .. _DashboardSettingsOperators-Features: Особенности ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ На вкладке ``Особенности`` находится таблица с информацией о особеностях работы данного оператора. Таблица содержит следующие значения: - ``Работа с пакетами документов``; - ``Вариант блокировки пакета документов`` (если поддерживается работа с пакетами документов); - ``Отзыв приглашений``; - ``Прекращение отношений партнерства``; - ``Загрузка zip-архива``; - ``Аннулирование документов``; - ``Метаданные документов``; - ``Приемка ТОРГ-2``; - ``Содержимое приемки ТОРГ-2``. .. image:: img/DashboardSettingsOperators-5.png :scale: 94 :align: center :alt: Особенности оператора Изменение добавленного оператора ------------------------------------ Для изменения оператора нужно на странице с настройками операторов в таблице выбрать необходимого оператора и нажать кнопку ``Изменить``. Откроется страница с формой для изменения оператора. .. image:: img/DashboardSettingsOperators-6.png :scale: 78 % :align: center :alt: Форма изменения оператора Данная форма аналогична форме добавления нового оператора. Подробное описание порядка действий с формой см. `Добавление нового оператора`_. Удаление добавленного оператора ----------------------------------- Для удаления оператора нужно на странице с настройками операторов в таблице выбрать необходимого оператора и нажать кнопку ``Удалить``. Появится всплывающее окно с подтверждением удаления. .. image:: img/Dashboard_DeleteConfirmation.png :scale: 100 % :align: center :alt: Подтверждение удаления оператора Параметры операторов ------------------------ .. _general_operator_parameters: Описание параметров операторов, которые являются общими для всех операторов, приведено в таблице ниже. .. list-table:: Общие параметры операторов :widths: 10 40 10 :header-rows: 1 * - Название параметра - Описание - Обязательность * - Код оператора - Код оператора. Код оператора должен быть уникальным. Нельзя добавить нескольких операторов с одинаковым кодом - Да * - Название оператора - Название оператора - Да * - Наименование юр. лица - Наименование юр. лица оператора - Да * - ИНН оператора - ИНН оператора - Да * - Адрес API оператора - URL для доступа к API оператора - Да * - Режим загрузки печатных форм в формате PDF - Возможные режимы: * Не загружать - печатные формы не будут загружаться или генерироваться * Загружать от оператора ЭДО - загружать печатные формы, генерируемые оператором * Генерировать, если не поддерживается оператором - генерировать через :ref:`сервиc печатных форм` в том случае, если оператор не поддерживает генерацию печатных форм * Генерировать самостоятельно - генерация печатных форм будет происходить только через :ref:`сервиc печатных форм` - Да * - Запрашивать ПФ в формате HTML - Включает генерацию печатных форм в HTML для отображения в :ref:`карточке документа` - Да Помимо :ref:`параметров, общих для всех операторов`, для оператора **Диадок** выполняются следующие настройки. .. list-table:: Параметры оператора Диадок :widths: 10 40 10 :header-rows: 1 * - Название параметра - Описание - Обязательность * - Идентификатор клиента - Идентификатор интеграционного решения ИМ - Да Помимо :ref:`параметров, общих для всех операторов`, для оператора **Такском-Файлер** выполняются следующие настройки. .. list-table:: Параметры оператора Такском-Файлер :widths: 10 40 10 :header-rows: 1 * - Название параметра - Описание - Обязательность * - Идентификатор клиента - Идентификатор интеграционного решения ИМ - Да Помимо :ref:`параметров, общих для всех операторов`, для оператора **СБИС** выполняются следующие настройки. .. list-table:: Параметры оператора СБИС :widths: 10 40 10 :header-rows: 1 * - Название параметра - Описание - Обязательность * - Адрес оператора для выполнения запросов на аутентификацию - URL веб-сервиса оператора для авторизации к ящику на заданной зоне (тест, продуктив) - Да * - Использовать составной тип полуформализованных документов - Признак того, что при отправке полуформализованных документов тип полуформализованного документа должен быть указан как "{ТипРегламента}.{ТипДокумента}", где {ТипРегламента} - это тип документа оператора, а {ТипДокумента} - тип вложения оператора. - Да .. _cdf-im-settings-operator: Помимо :ref:`параметров, общих для всех операторов`, для **оператора внутрикорпоративного ЭДО** выполняются следующие настройки. .. list-table:: Параметры оператора внутрикорпоративного ЭДО :widths: 10 40 10 :header-rows: 1 * - Название параметра - Описание - Обязательность * - Наименование типа неформализованных документов - Указанное наименование типа будет использоваться для отправки неформализованных документов. Для успешной отправки необходимо, чтобы в настройках оператора внутрикорпоративного ЭДО присутствовал указанный тип. Настройка типов документов оператора внутрикорпоративного ЭДО описана в разделе :ref:`Cdf-Dashboard-DocflowTypes`. - Нет .. _dashboard-settings-boxes-parameters: Параметры ящиков операторов ------------------------------- .. _general_boxes_parameters: Описание параметров ящиков операторов, которые являются общими для всех операторов, приведено в таблице ниже. .. list-table:: Общие параметры ящиков операторов :widths: 10 40 10 :header-rows: 1 * - Название параметра - Описание - Обязательность * - Наименование организации - Наименование организации, использующей данный ящик - Нет * - ИНН - ИНН организации - Да * - КПП - КПП организации - Да * - Идентификатор ящика - Идентификатор ящика у оператора (BoxID) - Да * - ФНС-идентификатор ящика - ФНС-идентификатор ящика - Нет * - Отпечаток технического сертификата - Отпечаток сертификата, который используется для аутентификации в сервисе оператора и для подписания технических квитанций в случае серверного подписания ИОП - Нет * - Должность технического подписанта - Должность владельца технического сертификата - Нет * - Режим работы с ИОП - Выбор режима работы с извещениями о получении: * Серверное подписание * Локальное подписание * Отключить генерацию ИОП Из-за специфики работы оператора либо локальное подписание, либо в целом подписание ИОП может быть недоступно - Да * - Использовать ящик - Включение или выключение ящика - Да * - Расширенное логирование - Включение или выключение расширенного логирования при работе с ящиком - Да * - Логировать бинарные данные - Включение или выключение логирования бинарных данных при включенном расширенном логировании - Да .. note:: Идентификаторы ящиков нужно указывать в том же регистре, что и в учетной системе. Помимо :ref:`параметров ящиков, общих для всех операторов`, для ящиков оператора **СФЕРА Курьер** выполняются следующие настройки. .. list-table:: Параметры ящиков оператора СФЕРА Курьер :widths: 10 40 10 :header-rows: 1 * - Название параметра - Описание - Обязательность * - API-key - Ключ доступа к API оператора для данного ящика - Да Помимо :ref:`параметров ящиков, общих для всех операторов`, для ящиков оператора **Такском-Файлер** выполняются следующие настройки. .. list-table:: Параметры ящиков оператора Такском-Файлер :widths: 10 40 10 :header-rows: 1 * - Название параметра - Описание - Обязательность * - Вариант интеграции - Вариант интеграции ящика определяется оператором. Доступно 2 варианта интеграции: * SDK; * Web API. - Да Помимо :ref:`параметров ящиков, общих для всех операторов`, для ящиков операторов **Эдисофт**, **Docrobot** и **Doclink** выполняются следующие настройки. .. list-table:: Параметры ящиков операторов Эдисофт, Docrobot и Doclink :widths: 10 40 10 :header-rows: 1 * - Название параметра - Описание - Обязательность * - Логин для аутентификации - Логин для аутентификации в сервисе оператора - Да * - Пароль для аутентификации - Пароль для аутентификации в сервисе оператора - Да .. _cdf-im-settings-operator-boxes: Помимо :ref:`параметров ящиков, общих для всех операторов`, для ящиков **оператора внутрикорпоративного ЭДО** выполняются следующие настройки. .. list-table:: Параметры ящиков оператора внутрикорпоративного ЭДО :widths: 10 40 10 :header-rows: 1 * - Название параметра - Описание - Обязательность * - Логин для аутентификации - Логин для аутентификации в сервисе оператора внутрикорпоративного ЭДО. Настройка пользователей оператора внутрикорпоративного ЭДО описана в разделе :ref:`Cdf-Dashboard-UsersAndRoles-Users`. - Да * - Пароль для аутентификации - Пароль для аутентификации в сервисе оператора внутрикорпоративного ЭДО - Да .. _parameters_halfformal: Параметры полуформализованных типов документов -------------------------------------------------------------- Описание параметров полуформализованных типов документов, которые являются общими для всех операторов, приведено в таблице ниже. .. list-table:: Параметры полуформализованных типов документов :widths: 10 40 10 :header-rows: 1 * - Название параметра - Описание - Обязательность * - Наименование - Наименование типа документов - Да * - Наименование в API - Наименование типа документов для использования в API - Да * - Используется - Признак того, что тип документов может быть использован - Да * - Атрибуты - Перечень атрибутов типа документов. Описание параметров атрибутов описано в разделе `Параметры атрибутов полуформализованных типов документов`_ - Нет Параметры атрибутов полуформализованных типов документов ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Описание параметров атрибутов полуформализованных типов документов, которые являются общими для всех операторов, приведено в таблице ниже. .. list-table:: Параметры атрибутов полуформализованных типов документов :widths: 10 40 10 :header-rows: 1 * - Название параметра - Описание - Обязательность * - Наименование - Наименование атрибута - Да * - Наименование в API - Наименование атрибута для использования в API - Да * - Обязательный - Признак того, что атрибут является обязательным - Да * - Тип данных - Тип данных атрибута. Допустимые значения описаны в разделе `Типы данных атрибутов полуформализованных типов документов`_ - Да Типы данных атрибутов полуформализованных типов документов ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Тип данных атрибута может принимать следующие значения: - ``Строка``; - ``Целое число``; - ``Дробное число``; - ``Дата/время``; - ``Пользовательский тип``.