Термины и типы данных

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

Сокращения названий колонок таблиц

Сокращение Полное название
Авт. Автоматическое заполнение поле. Например, атоматически увеличивающийся индекс в таблице
Обяз. Обязательность поля
Повт. Повторяемость поля
Уник. Уникальность поля

Термины

Термин Определение
Направление сделки Множество с двумя возможными значениями – Покупка и Продажа
Система Набор микросервисов, в совокупности предоставляющих пользователям описываемую в настоящей документации функциональность
Сумма Составной тип данных, включающий десятичное число с плавающей точкой и валюту
Чекбокс Элемент управления Флажок
Экземпляр системы Система, развёрнутая у отдельного клиента

Типы данных

Строка

Последовательность любых печатных символов.

int: целое число

Ограничение Описание
float Любое целое число, любого знака. Ноль включён.
float > 0 Целов число большее нуля
float >= 0 Целов число большее или равное нулю
float < 0 Целов число меньшее нуля
float <= 0 Целов число меньшее или равное нулю

float: десятичное число

Ограничение Описание
float Любое десятичное число, любого знака. Ноль включён.
float > 0 Десятичное число большее нуля
float >= 0 Десятичное число большее или равное нулю
float < 0 Десятичное число меньшее нуля
float <= 0 Десятичное число меньшее или равное нулю

bool: логический тип

Переменная может принимать два значения - да и нет.

date: Дата

Дата, без указания времени.

datetime: Дата и время

Дата и время в пределах этой даты.

Сумма

Положительное десятичное число и код валюты.

Период времени

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

Атомарные периоды:

  • y – год
  • M – месяц (прописная буква)
  • d – день
  • h – час
  • m – минута (строчная буква)
  • s – секунда

Примеры:

  • 1h – один час
  • 2d 4h 5m – два дня, четыре часа и пять минут
  • 1y 6M – полтора года
  • 24h – один день

Комментарий

Система позволят оставлять комментарии под некоторыми объектами. Комментарий содержит следующие параметры:

Параметр Тип данных Описание
Время Время Момент времени, когда был оставлен комментарий
Автор Пользователь Ссылка на пользователя, оставившего комментарий
Текст Строка Текст комментария
Вложение Файл Добавленный к комментарию файл. Файлов может быть несколько

Метки

Система позволяет добавлять к объектам (сделки, участники и др.) метки (label). Метка является строкой без пробелов и специальных символов. Допускается использование только букв, цифр, знаков подчёркивания (_) и дефис (-).

Метки глобальны, то есть одни и те же метки используются для разных объектов. Если проставить метку тестовая_метка OTC сделки, то она будет доступна в выпадающей подсказке при проставлении метки, например, клиенту.