Типы данных

Тип данных — центральный артефакт модели Citeck, описывающий структуру и поведение объектов в системе. Он определяет набор атрибутов, роли, статусы жизненного цикла и связывает объект с формой и журналом. На основе типов данных строится вся логика работы с документами и бизнес-объектами — от создания до участия в бизнес-процессах.

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

Общий обзор (Overview)

Типы данных — артефакты с типом model/type.

Для работы с объектами типа данных используются:

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

Иерархия системных типов и логика их наследования

Типы образуют иерархию с корневым типом base. Для пользовательского типа выбирают родителя; в форме создания по умолчанию выбран case. Если родитель в определении не указан, при разрешении типа используется base (кроме самого корневого типа).

Ниже показана часть иерархии базовых типов:

Иерархия типов: base, затем user-base, от которого наследуются case и data-list.

Кейс (case) — базовый тип для бизнес-объектов, с которыми работают через карточку и которые могут участвовать в бизнес-процессах. Связь с процессом настраивается по задаче; выбор родителя case сам по себе не требует прикрепления процесса.

Элемент справочника (data-list) — базовый тип для справочных бизнес-данных, используемых другими объектами системы. Он отличается начальными настройками действий, в том числе отсутствием перехода на карточку после создания. Его настройка не ограничена общей информацией и атрибутами: при необходимости можно задать роли, статусы и права.

В форме также доступны родители «Документ» (document), «Файл библиотеки документов» (workspace-file), «Публикация» (publication) и вариант «Остальное» для выбора другого существующего типа.

Родителем может быть глобальный тип или тип из того же рабочего пространства. Глобальный тип не может наследоваться от типа рабочего пространства. Циклическое наследование не допускается.

Родительские атрибуты попадают в список наследуемых атрибутов (Атрибуты). Отдельные флаги позволяют наследовать форму, действия и шаблон нумерации. Для наследования формы или шаблона нумерации собственная ссылка должна быть пустой. При наследовании действий родительский список объединяется с собственным.

Описание перехода к разделу через интерфейс

Для просмотра существующих типов и их редактирования создан журнал «Типы данных» (Рабочее пространство «Раздел администратора» - Модель):

../_images/type_21.png

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

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

../_images/system_types.png

Создание и загрузка описания типа

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

Создание

Для создания типа данных необходимо нажать + - Создать новый тип:

../_images/new_type_1.png

Откроется форма создания типа данных:

../_images/new_type.png

Загрузка

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

../_images/download_type.png

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

Пример описания типа

id: hr-offices-type
name:
  ru: Офисы
storageType: ECOS_MODEL
parentRef: emodel/type@data-list
formRef: uiserv/form@hr-offices-form
journalRef: uiserv/journal@hr-offices-journal
inheritActions: false
defaultCreateVariant: true
model:
  attributes:
    - id: officesCode
      name:
        ru: Код
    - id: officesCity
      name:
        ru: Город
    - id: officesAddress
      name:
        ru: Адрес

Форма hr-offices-form и журнал hr-offices-journal из примера должны существовать в системе. Для автоматически формируемых артефактов используйте ссылки uiserv/form@DEFAULT_FORM и uiserv/journal@DEFAULT_JOURNAL.

Доступные действия с записью

../_images/actions4.png

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

  • редактировать права;

  • скачать описание типа в формате YAML;

  • удалить;

  • открыть карточку в соседней вкладке;

  • открыть на редактирование;

  • редактировать JSON-представление типа;

  • копировать.

Создание нового типа

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

../_images/tabs.png
  • Основной – основные характеристики типа данных.

  • Атрибуты – характеристика, определяющая свойства объекта.

  • Аспекты – функционал расширения типа данных без изменения самого типа.

  • Роли – роли, которые участвуют в работе с объектом.

  • Статусы – состояния объекта в его жизненном цикле.

  • Стадии – этапы жизненного цикла документа.

  • Варианты создания – настройка поддержки выбора варианта создания после выбора типа.

  • Связи – настраиваются для отображения, добавления и удаления связанных объектов в виджете «Связи» на карточке объекта.

  • Конфигурация контента – настройки работы с содержимым (контентом).

  • Представления – настройки списка, плиток и библиотеки документов.