Требования к именованию метаданных

Рекомендации по именам сущностей метаданных

При создании структуры данных для оптимальной работы ViTalk рекомендуется руководствоваться описанными в этом документе принципами. Если их не получается соблюдать на уровне БД, имена сущностей можно отредактировать при настройке.

Старайтесь не использовать одну и ту же фразу для названия одновременно у нескольких сущностей (групп показателей, показателей, измерений и их ссылок, атрибутов измерений и значений фильтров). Например, название показателя не должно совпадать с названием группы показателей. В случае невозможности соблюдения этого условия, данные, запрашиваемые несколькими способами, с использованием повторяющихся имен, должны совпадать.

Примеры НЕверного именования.

Пример 1: Необходимо узнать количество заказов на закупку за какой-либо период, это возможно сделать двумя способами:

a. Выбрать показатель “Количество заказов на закупку, шт” из группы показателей “Заказы”.

b. Выбрать показатель “Количество заказов, шт” из группы показателей “Заказы на закупку”.

При этом получаемые агрегированные значения будут различны.  

Пример 2: Группа показателей “Заказы” имеет показатели: “Количество заказов, шт”, “Количество заказов,шт”, “Количество заказов” и “кол-во заказов”.

Уникальные значения в пределах одной сущности: старайтесь не использовать одну фразу (одинаковый идентификатор) для называния сущностей в пределах типа. Все группы показателей должны быть уникальны, показатели в рамках группы показателя и т.п.

Должны быть уникальны:

1. Названия групп показателей в пределах базы.

2. Названия показателей и измерений в рамках группы показателей:

   1. Названия ролей не должны совпадать с названиями соответствующих измерений.

3. Названия атрибутов в рамках измерения.

4. Названия значений атрибутов в рамках атрибута измерения.

Уникальность наименований требуется для поиска: ViTalk будет производить поиск по наименованиям, и при совпадении в пределах одного уровня будет выбран произвольный вариант, т.е. часть данных будет недоступна.

Коды и расшифровки:

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

Написание

1. Желательно отсутствие опечаток (могут привести к некорректному распознаванию запросов). 

2. Желательно отсутствие двойных пробелов. 

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

3. Желательно отсутствие двойных знаков пунктуации.

   1. Например, коды 1234.123.12 и 1234..123..12 будут обработаны различно: в первом случае код останется неизменным, во втором будет разбит на три числа, что с большой вероятностью исключает его из поиска.

4. Сокращения в названиях сущностей должны быть оформлены в едином стиле (с использование или без использования точки).  

   1. Пример: ”оконч.” и “оконч”.  

5. Наличие в названии сущности цифр может приводить к неочевидному приведению к начальной форме:

   1. "сахар2" → "сантиахаретр".

Показатели

Старайтесь не использовать названия стандартных агрегаций в названиях показателей (например, “Минимальное ценовое предложение, руб”). Но если название является некоторым устойчивым выражением (например, “Начальная минимальная цена”), то такое наименование допустимо. При использовании в названии показателя агрегации необходимо дополнительно настроить виртуальные показатели в соответствии с инструкцией.

Пример нерекомендуемого наименования: в ГП “Ценовые предложения” существует несколько показателей (“Максимальное ценовое предложение”, “Минимальное ценовое предложение” и “Сумма ценовых предложений”) вместо одного с различными агрегациями.  

Другой пример: в ГП “Лоты” значения показателя “Количество заявок на лоты, шт” с агрегацией “Среднее” не совпадает со значением показателя “Среднее количество заявок на лот, шт” с агрегацией “Среднее”. 

Не рекомендуется использовать в названиях показателей коды и/или цифры. Например: 

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

Разные показатели должны содержать различные данные, т.е. не дублироваться.

Примечание: число может быть добавлено автоматически, если показатель (или любая другая сущность) была скопирована.

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

Пример: Требуется найти объем транзакций по тарифам за период. Вместо использования ГП “Транзакции” требуется использовать ГП “Заявки на активацию тарифов”, показатель  “Сумма транзакций списания, руб.” 

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

Измерения и фильтры

Не рекомендуется дублировать в названии атрибута название соответствующего измерения: 

Измерение "Филиалы" - атрибут "Код филиала" лучше заменить на "Филиалы" - "Код" .

Измерение "Транзакция", атрибуты “Статус транзакции” и “Описание транзакции” лучше привести к "Транзакция" - ("Статус", "Описание").

Не рекомендуется иметь отрицание в названии бинарного атрибута. Следует в бинарных атрибутах (т.е. содержащих 2 значения) указывать только вариант "да/нет".

Пример нерекомендуемого наименования:  “Резидент РФ” - (“Не резидент РФ”, “Резидент РФ”) 

Рекомендуемое наименование: “Резидент РФ” - (“да”, “нет”)

Вместо нескольких пар лучше согласовать единственный вариант.

При использовании измерения, по смыслу являющегося календарным, отмечать его соответствующим образом (связать с календарём).

Из-за наличия атрибутов со значениями, похожими на даты (2019 как год, 01.01.2019 как дата), точность работы может снизиться.

Заметки

Измерения и группы показателей

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

Известные ошибки

При попытке расчета некоторых измерений происходит ошибка: 

А) группа показателей "Валютные лоты",  ссылка на измерение "Валютный лот" -> атрибут измерения "Валюта процедуры". 

Б) группа показателей "Заявки на лоты",  ссылка на измерение "Статус лота" -> атрибут измерения "Статус".