Шаблоны нумерации

Описание

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

Шаблон задаёт правило формирования ключа счётчика, а счётчик хранит текущее значение и автоматически инкрементируется при создании каждой новой записи. Шаблоны и счётчики хранятся в сервисе ecos-model.

На этой странице описаны:

  • структура сущностей Number template и Number counter;

  • алгоритм работы механизма нумерации;

  • настройка шаблона через интерфейс;

  • привязка шаблона к типу данных;

  • использование счётчика в шаблоне отображения имени;

  • изменение текущего значения счётчика.

Шаблон нумерации

Файлы шаблонов создаются и сохраняются в формате: graphml

Number template

Сущность, которая определяет шаблон счетчика на основе текущей даты или полей в сущности, которую мы хотим пронумеровать.

Поля:

  • id - идентификатор сущности

  • name - произвольное имя. Справочная информация

  • counterKey - шаблон ключа счетчика. Может быть как константой (будет создан только 1 счетчик для шаблона), так и с вставками в формате ${атрибут_из_нумеруемой_сущности}.

Number counter

Сущность, в которой ведется счет.

Поля:

  • key - ключ счетчика. Константное значение, которое получилось после вычисления counterKey в шаблоне нумерации.

  • counter - значение счетчика

Алгоритм работы

В приложении, которое использует шаблоны нумерации, настраивается синхронизация с загрузкой всех шаблонов из ecos-model с целью получения списка атрибутов, которые нужны шаблону.

При создании новой сущности мы берем её тип, из типа получаем шаблон нумерации и если он задан, то достаем список необходимых для шаблона атрибутов. Далее отправляем команду с необходимыми атрибутами в ecos-model для получения следующего значения счетчика. Получив значение счетчика, сохраняем его в одном из полей.

Для получения значения счетчика следует всегда использовать системный атрибут _docNum (каждый источник ответственен за возвращение актуального значения нумерации по этому атрибуту).

Настройка шаблона в интерфейсе

  1. Перейти в журнал «Шаблоны нумерации» (Рабочее пространство «Раздел администратора» - Модель) .

../_images/Number_template_2.png

  1. Нажать + и выбрать «Создать новый шаблон»

  2. Ввести Id, name и counterKey и нажать Submit

Рассмотрим пример с использованием текущего месяца для шаблона (нумерация стартует с 0 каждый месяц):

../_images/Number_template_3.png

Новый шаблон нумерации создан.

Привязка к типу данных

Шаблон нумерации можно привязать к типу данных по любому из двух вариантов:

  1. C использованием системного атрибута _docNum, содержащего номер, который генерируется по шаблону:

../_images/Number_template_4.png

  1. с привязкой счетчика к конкретному атрибуту. В поле будет записываться номер из счетчика:

    • Перейти в настройки атрибута:

    • Указать тип Counter, storing type On create, выбрать созданный ранее шаблон нумерации, подтвердить:

Использование данных счетчика в шаблоне отображения имени

В шаблоне отображения имени можно задать данные счетчика. Например:

Для 1 случая указывается системный атрибут _docNum:

../_images/Display_name_1.png

Для получения следующего отображения имени Заявка № 17

Для 2 случая указывается атрибут/-ы, к которому привязан счетчик.

../_images/Display_name_3.png

Возможно указать количество символов (заполнение лидирующими нулями): Test №${_docNum|fmt('00000')}

Реализована поддержка для чисел и дат в fmt:

fmt('YYYY.MM', 'en', 'GMT+0')

fmt('00000', 'en')

Например: Заметка №${$now|fmt('yyyy-MM-dd')} ${noteNumber}

Где:

  • now|fmt('yyyy-MM-dd') – текущая дата;

  • noteNumber – атрибут «Регистрационный номер», к которому привязан счетчик.

для получения следующего отображения имени Заметка №2023-02-23 15

Для получения следующего отображения имени Заявка № 2025-07-1 используйте: Заявка № ${_created|fmt('yyyy-MM')}-${_docNum}

Изменение текущего значения счетчика

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

Template:

---
id: ept-issue-num-template
name: ept-issue-num-template
counterKey: '${link-project:project?id}'

Изменение счетчика:

const record = Records.get("emodel/num-template-action@");
record.att("type", "set-next-number");
record.att("args",
{
       "templateRef": "emodel/num-template@ept-issue-num-template",
       "counterKey": "emodel/ept-project@3059e6bc-1915-4afc-a36e-39effb8a04d9",
       "nextNumber": 113
})
record.save();