Общее описание (Overview)
==========================

Определение журнала
--------------------

**Журналы** - табличная форма представления объектов с возможностью настройки отображения столбцов, фильтрации и манипуляции объектами. Столбцы соответствует данным объекта или могут вычисляться на их основе.

См. подробно :ref:`пользовательское описание<user_description_journal>`

Citeck позволяет:

- создавать неограниченное количество журналов;
- настраивать и сохранять индивидуальные настройки журнала для каждого пользователя;
- сортировать отображаемые данные журнала в заданном порядке;
- формировать отчетность по заданным журнальным формам;
- регламентировать работу с данными журнала согласно заданным правам и ролям пользователей системы;
- использовать возможности расширенного поиска и фильтрации по любому полю из карточки документа;
- выгружать данные журналов в форматах HTML, PDF, Excel.

В качестве источников данных могут быть любые **RecordsDAO** (:ref:`ECOS Records<Records_API>`), которые поддерживают :ref:`Язык предикатов <ecos-predicate_main>`


Журнал «Журналы»
-----------------

Для просмотра существующих журналов и их редактирования создан журнал **Журналы (Рабочее пространство "Раздел администратора" - Конфигурация UI)**:

 .. image:: _static/new/new_1.png
       :width: 700
       :align: center

По умолчанию в журнале не отображаются системные журналы.

Для отображения **ТОЛЬКО** системных журналов перейдите в настройки таблицы, выставите **Системный тип - Да**:

 .. image:: _static/new/system_01.png
       :width: 700
       :align: center

Варианты получения экземпляра журнала
--------------------------------------

Журнал можно создать или загрузить уже созданный в систему.

Создание
~~~~~~~~~


Для создания журнала необходимо нажать **+ - Создать журнал**:

 .. image:: _static/new/new_2_1.png
       :width: 500
       :align: center

Откроется форма создания журнала:

 .. image:: _static/new/new_3.png
       :width: 500
       :align: center

Подробно см. :ref:`Создание нового журнала<new_journal>`

Загрузка
~~~~~~~~~

Для загрузки созданного журнала необходимо нажать **+ - Журнал**:

 .. image:: _static/new/new_2_2.png
       :width: 500
       :align: center

Файл формата .yaml

Пример описания журнала
-------------------------

.. code-block::

       ---
       id: hr-responsibilities-journal
       name:
        ru: Должностные обязанности
       typeRef: emodel/type@hr-responsibilities-type
       actions:
        - uiserv/action@delete
        - uiserv/action@edit
       columns:
        - id: responsibilitiesSimpleRoleTypeAssoc
         name:
          ru: Должность
         searchable: true
         sortable: true
         groupable: true
         editable: true
         visible: true
         hidden: false
        - id: responsibilitiesSubordination
         name:
          ru: Подчинение
         searchable: true
         sortable: true
         groupable: true
         editable: true
         visible: true
         hidden: false

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

 .. image:: _static/new/actions.png
       :width: 500
       :align: center

- скачать в виде json-файла;
- удалить;
- открыть на редактирование;
- редактировать json-файл;
- копировать;
- открыть карточку журнала в соседней вкладке. Карточка представляет собой :ref:`дашборд<dashboard>`:

 .. image:: _static/new/journal_dashboard.png
       :width: 600
       :align: center