.. _routes-settings: 

Настройки маршрутов
=========================================

Для просмотра и редактирования настроек маршрутов необходимо на странице с настройками выбрать пункт меню ``Маршруты`` или перейти по адресу: ``{адрес:порт}/settings/routes``. 
Откроется страница, на которой находится таблица, содержащая все добавленные маршруты. 

.. image:: img/routes-settings-list.png
   :scale: 64
   :align: center
   :alt: Настройки маршрутов
   
.. _routes-settings-add:   

Добавление нового маршрута
-------------------------------

Для добавления нового маршрута необходимо на странице с настройками маршрутов нажать кнопку ``Добавить``. Откроется страница с формой для добавления нового маршрута.

.. image:: img/routes-settings-add.png
   :scale: 100
   :align: center
   :alt: Добавление нового маршрута
   
   
На форме находятся три вкладки:

- :ref:`routes-settings-route`
- :ref:`routes-settings-tags`
- :ref:`routes-settings-stages`

.. _routes-settings-route:

Маршрут
~~~~~~~~~~~~~~~~

На вкладке ``Маршрут`` находятся поля для ввода настроек маршрута. 

.. note:: 
    
    Описание параметров маршрута см. :ref:`routes-settings-route-parameters`.

.. image:: img/routes-settings-route.png
   :scale: 100
   :align: center
   :alt: Вклдака 'Маршрут'


Для сохранения введенных параметров нажмите кнопку ``Сохранить``.


В случае если сохранять введенные данные не требуется, нажмите кнопку ``Отмена``.


.. _routes-settings-tags:

Тэги маршрута
~~~~~~~~~~~~~~~~

На вкладке ``Тэги маршрута`` находится форма для редактирования перечня тэгов данного маршрута. Вкладка становится доступной после сохранения маршрута на вкладке ``Маршрут``.

.. image:: img/routes-settings-tags.png
   :scale: 100
   :align: center
   :alt: Вклдака 'Тэги маршрута'

.. note:: Информацию по настройке тэгов см. в разделе :ref:`tags-settings`.

Для добавления роли необходимо нажать кнопку ``Добавить``. Откроется окно для выбора тэга.
В этом окне можно ввести описание или наименование тэга и нажать кнопку ``Поиск``. 
После этого выбрать нужный тэг, нажав кнопку ``Выбрать``.

.. image:: img/routes-settings-add-tag.png
   :align: center
   :alt: Форма добавления тэга

Для изменения тэга нужно нажать кнопку |routes-settings-settings-icon| рядом с выбранным тэгом. После этого откроется окно с выбором нового тэга.

Для удаления тэга нужно нажать кнопку |routes-settings-delete-icon| рядом с выбранным тэгом.

Для сохранения данных нажмите кнопку ``Сохранить``.

В случае если сохранять введенные данные не требуется, нажмите кнопку ``Отмена``.

.. _routes-settings-stages:

Этапы маршрута
~~~~~~~~~~~~~~~~

На вкладке ``Этапы маршрута`` находится таблица с этапами данного маршрута. Вкладка становится доступной после сохранения маршрута на вкладке ``Маршрут``.

.. image:: img/routes-settings-stages.png
   :scale: 39
   :align: center
   :alt: Вклдака 'Этапы маршрута'

Добавление нового этапа маршрута
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Для добавления нового этапа нажмите кнопку ``Добавить``. Откроется страница с формой для добавления нового этапа. Заполните поля с параметрами этапа.

.. note:: 
    
    Описание параметров этапов маршрутов см. :ref:`routes-settings-stages-parameters`.
	
.. image:: img/routes-settings-stages-add.png
   :scale: 100
   :align: center
   :alt: Добавление нового этап

Для изменения роли нужно нажать кнопку |routes-settings-settings-icon|. Откроется окно с выбором роли.
В этом окне можно ввести описание или название роли и нажать кнопку ``Поиск``. После этого выбрать нужную роль, нажав кнопку ``Выбрать``.

.. image:: img/routes-settings-stages-search-role.png
   :align: center
   :alt: Форма выбора роли

Для добавления делегата необходимо нажать кнопку ``Добавить``. После этого откроется окно для выбора роли делегата.

Для сохранения всех введенных параметров нажмите кнопку ``Сохранить``.


В случае если сохранять введенные данные не требуется, нажмите кнопку ``Отмена``.

Изменение этапа маршрута
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Для изменения этапа нужно на странице с этапами в таблице выбрать необходимый этап и нажать кнопку ``Изменить``. 
Откроется страница с формой для изменения этапа. Данная форма аналогична форме добавления нового этапа.

Изменения порядка этапа маршрута
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Для изменения порядка этапа нужно на странице с этапами в таблице выбрать необходимый этап и нажать кнопку:

* |routes-settings-stages-up| - если необходимо поднять этап выше;
* |routes-settings-stages-down| - если необходимо опустить этап ниже.

Удаление этапа маршрута
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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


Изменение добавленного маршрута 
------------------------------------

Для изменения маршрута нужно на странице с настройками маршрутов в таблице выбрать необходимый маршрут и нажать кнопку ``Изменить``. Откроется страница с формой для изменения маршрута.

.. image:: img/routes-settings-update.png
   :scale: 100
   :align: center
   :alt: Форма изменения маршрута

 
Данная форма аналогична форме добавления нового маршрута. Подробное описание порядка действий с формой см. :ref:`routes-settings-add`.

Удаление добавленного маршрута
-----------------------------------

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

.. image:: img/routes-settings-delete-confirmation.png
   :scale: 100 %
   :align: center
   :alt: Подтверждение удаления маршрута

.. note:: 
    
    Нельзя удалить маршрут, если он используется для документов.

Перевод маршрута в режим "только для чтения"
--------------------------------------------------

Если маршрут уже используется для документов, то изменение его параметров может привести к ошибкам при анализе исторических данных.
Для устанения указанных проблем для маршрутов доступен перевод в режим "только для чтения". 
После перевода маршрута в режим "только для чтения" его редактирование будет невозможно.

Для перевода маршрута в режим "только для чтения" нужно на странице с настройками маршрутов в таблице выбрать необходимый маршрут 
и нажать кнопку ``Только для чтения``. Появится всплывающее окно с подтверждением. 
Для перевода в режим "только для чтения" нажмите кнопку ``Да``.

.. image:: img/routes-settings-readonly.png
   :scale: 100 %
   :align: center
   :alt: Подтверждение перевода маршрута в режим "только для чтения"
   
.. note:: 
    
    Данное действие необратимо. После перевода маршрута в режим "только для чтения" его уже нельзя будет вернуть в режим редактирования.


После перевода маршрута в режим "только для чтения" доступен только просмотр настроек маршрута без возможности его редактирования.
Для просмотра настроек маршрута нужно на странице с настройками маршрутов в таблице выбрать необходимый маршрут и нажать кнопку ``Просмотр``.
Откроется страница с формой для просмотра настроек маршрута.

.. image:: img/routes-settings-show.png
   :scale: 100 %
   :align: center
   :alt: Просмотр маршрута

Включение или выключение маршрута в режиме "только для чтения"
------------------------------------------------------------------------

В режиме "только для чтения" редактирование маршрута недоступно.
Для включения или выключения маршрута нужно на странице с настройками маршрутов в таблице выбрать необходимый маршрут и нажать кнопку ``Включить`` или ``Выключить`` в зависимости от текущего состояния маршрута.

Ошибки в настройках маршрута
------------------------------------------------------------------------

Если в настройках маршрута присутствуют ошибки, то в таблице маршрутов появится соответствующее предупреждение.

.. image:: img/routes-settings-errors.png
   :scale: 38 %
   :align: center
   :alt: Ошибки в настройках маршрута

Для просмотра ошибок в настройках нужно на странице с маршрутами в таблице выбрать необходимый маршрут и нажать кнопку ``Ошибки валидации``. 
Откроется форма с информацией об ошибках.

.. image:: img/routes-settings-errors-list.png
   :scale: 100 %
   :align: center
   :alt: Просмотр ошибок в настройках маршрута

.. _routes-settings-route-parameters:

Параметры маршрутов
------------------------

Описание параметров маршрутов приведено в таблице ниже.

.. list-table:: Параметры маршрутов
    :widths: 10 40 10
    :header-rows: 1 
    
    * - Название параметра
      - Описание 
      - Обязательность
    * - Действие
      - Действие для маршрута
      - Да
    * - Используется
      - Признак того, что маршрут используется
      - Да

.. _routes-settings-stages-parameters:

Параметры этапов маршрутов
------------------------------------------

Описание параметров этапов маршрутов приведено в таблице ниже.

.. list-table:: Параметры этапов маршрутов
    :widths: 10 40 10
    :header-rows: 1 
    
    * - Название параметра
      - Описание 
      - Обязательность
    * - Тип подписи
      - Доступны три варианта:
        
        * "Отсутствует" - подпись не используется;
        * "Согласующая" - подпись используется для согласования этапа;
        * "Основная" - подпись используется для отправки оператору ЭДО.
        
      - Да
    * - Роль
      - Роль основного пользователя, согласующего этап.
      - Да
    * - Длительность, часы
      - Интервал времени в часах, в течение которого этап должен быть согласован.
      - Да
    * - Делегаты
      - Роли пользователей, на которые возможно делегирование согласования этапа.
      - Да
    * - Разрешить эскалацию на следующий этап
      - Признак того, что исполнитель может эскалировать переход на следующий этап маршрута. Не доступно для основной подписи.
      - Да

.. |routes-settings-settings-icon| image:: img/routes-settings-settings-icon.png
.. |routes-settings-delete-icon| image:: img/routes-settings-delete-icon.png
.. |routes-settings-stages-up| image:: img/routes-settings-stages-up.png
.. |routes-settings-stages-down| image:: img/routes-settings-stages-down.png