Платформа 3V/Справочник: различия между версиями

Материал из 3v-wiki
Перейти к навигации Перейти к поиску
 
(не показано 6 промежуточных версий этого же участника)
Строка 1: Строка 1:
[[Файл:Справочник лого единообразное.png|40px|link=Платформа 3V/Методика]]  '''Справочник''' - способ хранения данных, при котором уникальную запись характеризует одно поле.
+
{{DISPLAYTITLE:Справочник}}
 +
[[Файл:Справочник лого единообразное.png|40px|link=Платформа 3V/Справочник]]  '''Справочник''' - способ хранения данных, при котором уникальную запись характеризует одно поле.
  
 
<div class="toccolours mw-collapsible" style="width:600px; background:#FFFFFF;">
 
<div class="toccolours mw-collapsible" style="width:600px; background:#FFFFFF;">
<div style="color:#CC2200">[[Платформа_3V/Справочник/Как настроить справочник%3F|<font style="color: #CC2200">Как настроить справочник?</font>]]</div>
+
<div style="color:#CC2200">[[Платформа 3V/Справочник/Как настроить справочник|<font style="color: #CC2200">Как настроить справочник?</font>]]</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
  
 
<div class="mw-collapsible mw-collapsed" style="width:600px;">
 
<div class="mw-collapsible mw-collapsed" style="width:600px;">
1. [[Платформа_3V/Справочник/Задание_атрибутов_в_справочнике|<font style="color: #CC2200">Задать атрибуты в справочнике</font>]]
+
1. [[Платформа_3V/Справочник/Задание_атрибутов_в_справочнике|<font style="color: #0645AD">Задать атрибуты в справочнике</font>]]
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 
#[[Платформа_3V/Справочник/Задание_атрибутов_в_справочнике/Выбор_необходимого_типа_данных_для_атрибутов|<font style="color: #CC2200">Выбрать необходимый тип данных для атрибутов</font>]]
 
#[[Платформа_3V/Справочник/Задание_атрибутов_в_справочнике/Выбор_необходимого_типа_данных_для_атрибутов|<font style="color: #CC2200">Выбрать необходимый тип данных для атрибутов</font>]]
 +
##[[Платформа_3V/Справочник/Задание_атрибутов_в_справочнике/Выбор_необходимого_типа_данных_для_атрибутов/Изменение_типа_атрибута_на_связанный|<font style="color: #0645AD">Задать и использовать связанные атрибуты</font>]]
 
#[[Платформа_3V/Справочник/Вычислимые_атрибуты|<font style="color: #0645AD">Задать и использовать вычислимый атрибут</font>]]
 
#[[Платформа_3V/Справочник/Вычислимые_атрибуты|<font style="color: #0645AD">Задать и использовать вычислимый атрибут</font>]]
#[[Платформа_3V/Справочник/Изменение_типа_атрибута_на_связанный|<font style="color: #0645AD">Задать и использовать связанные атрибуты</font>]]
+
#[[Платформа 3V/Справочник/Задание атрибутов в справочнике/Вычислимые значения файла|<font style="color: #0645AD">Вычислить значения атрибута файл</font>]]
 
</div></div>
 
</div></div>
 
<div class="mw-collapsible mw-collapsed" style="width:600px;">
 
<div class="mw-collapsible mw-collapsed" style="width:600px;">
2. [[Платформа_3V/Справочник/Добавление_новых_записей_в_справочник|<font style="color: #0645AD">Редактировать записи в справочнике</font>]]
+
2. [[Платформа_3V/Справочник/Добавление_новых_записей_в_справочник|<font style="color: #0645AD">Редактировать данные в справочнике</font>]]
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 
#[[Платформа_3V/Справочник/Добавление_новых_записей_в_справочник/Добавление_данных_вручную_пользователем|<font style="color: #CC2200">Редактировать данные вручную</font>]]
 
#[[Платформа_3V/Справочник/Добавление_новых_записей_в_справочник/Добавление_данных_вручную_пользователем|<font style="color: #CC2200">Редактировать данные вручную</font>]]
Строка 21: Строка 23:
 
</div></div>
 
</div></div>
 
<div class="mw-collapsible mw-collapsed" style="width:600px;">
 
<div class="mw-collapsible mw-collapsed" style="width:600px;">
3. Использовать и отображать в других объектах платформы
+
3. Доп. настройки в справочнике
 +
<div class="mw-collapsible-content">
 +
#[[Платформа_3V/Справочник/Настройка_уникального_индекса_в_справочнике|<font style="color: #0645AD">Настроить уникальный индекс в справочнике</font>]]
 +
#[[Платформа_3V/Справочник/Лимиты_элементов|<font style="color: #CC2200">Ограничить отображение количества элементов</font>]]
 +
#[[Платформа_3V/Справочник/Настройка_кэширования_справочника|<font style="color: #0645AD">Настроить кэширование справочника</font>]]
 +
</div></div>
 +
<div class="mw-collapsible mw-collapsed" style="width:600px;">
 +
4. Доп. настройки справочника для использования в других объектах 3V
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 
#[[Платформа_3V/Справочник/Связи_атрибутов_справочников|<font style="color: #0645AD">Настроить связи атрибутов(Собственный и транзитивный атрибуты)</font>]]
 
#[[Платформа_3V/Справочник/Связи_атрибутов_справочников|<font style="color: #0645AD">Настроить связи атрибутов(Собственный и транзитивный атрибуты)</font>]]
Строка 27: Строка 36:
 
#[[Платформа_3V/Справочник/Cортировка|<font style="color: #0645AD">Настроить сортировку элементов справочника(SortingOptions)</font>]]
 
#[[Платформа_3V/Справочник/Cортировка|<font style="color: #0645AD">Настроить сортировку элементов справочника(SortingOptions)</font>]]
 
#[[Платформа_3V/Справочник/Альтернативные_иерархии|<font style="color: #0645AD">Настроить альтернативную иерархию</font>]]
 
#[[Платформа_3V/Справочник/Альтернативные_иерархии|<font style="color: #0645AD">Настроить альтернативную иерархию</font>]]
#[[Платформа_3V/Справочник/Настройка_уникального_индекса_в_справочнике|<font style="color: #0645AD">Настроить уникальный индекс в справочнике</font>]]
+
</div></div>
 +
<div class="mw-collapsible mw-collapsed" style="width:600px;">
 +
5. [[Платформа_3V/Права_доступа/Права_доступа_на_справочники/Права_на_выполнение_действий_со_всеми_элементами_справочника|<font style="color: #CC2200">Настроить права доступа</font>]]
 +
<div class="mw-collapsible-content">
 +
#[[Платформа_3V/Права_доступа/Права_доступа_на_справочники/Права_доступа_на_элементы|<font style="color: #CC2200">Настроить права доступа на отдельные элементы</font>]]
 +
##[[Платформа_3V/Справочник/Атрибутивный_доступ|<font style="color: #0645AD">Настроить атрибутивный доступ</font>]]
 +
##[[Платформа_3V/Справочник/Поэлементный доступ|<font style="color: #CC2200">Настроить поэлементный доступ</font>]]
 
</div></div>
 
</div></div>
 
<div style="width:600px;">
 
<div style="width:600px;">
4. [[Платформа_3V/Права_доступа/Права_доступа_на_справочники|<font style="color: #CC2200">Настроить права доступа</font>]]
+
6. [[Платформа_3V/Внешний справочник|<font style="color: #0645AD">Внешний справочник</font>]]
</div>
 
<div style="width:600px;">
 
5. [[Платформа_3V/Справочник/Лимиты_элементов|<font style="color: #CC2200">Ограничить отображение количества элементов</font>]]
 
</div>
 
<div style="width:600px;">
 
6. [[Платформа_3V/Справочник/Настройка_кэширования_справочника|<font style="color: #0645AD">Настроить кэширование справочника</font>]]
 
</div>
 
<div style="width:600px;">
 
7. [[Платформа_3V/Внешний справочник|<font style="color: #0645AD">Внешний справочник</font>]]
 
 
</div>
 
</div>
 
<div style="width:600px;">
 
<div style="width:600px;">
8. [[Платформа_3V/Календарный справочник|<font style="color: #0645AD">Календарный справочник</font>]]
+
7. [[Платформа_3V/Календарный справочник|<font style="color: #0645AD">Календарный справочник</font>]]
 
</div></div></div>
 
</div></div></div>
  
Строка 59: Строка 65:
 
#'''Названия атрибутов''' (жарг. Шапка) - это заголовок столбца, который задаётся в конструкторе. <br><br>
 
#'''Названия атрибутов''' (жарг. Шапка) - это заголовок столбца, который задаётся в конструкторе. <br><br>
 
#'''Область данных''' (Элементы справочника) - это заполненные значениями ячейки атрибутов.<br><br>
 
#'''Область данных''' (Элементы справочника) - это заполненные значениями ячейки атрибутов.<br><br>
 
Каждый справочник колонки - атрибуты с данными и структура JSON атрибута справочника:
 
 
{| class="wikitable"
 
|-
 
! "attributes": [...]
 
|-
 
| <syntaxhighlight lang="JSON" line>
 
{
 
        "id": 1,
 
        "name": "...",
 
        "code": "...",
 
        "description": "",
 
        "dataType": "...",
 
        "type": "...",
 
        "isNullable": false,
 
        "hasMultipleValues": false,
 
        "isVisible": false,
 
        "isReadOnly": true,
 
        "formula": null,
 
        "tableName": "",
 
        "identIndex": {
 
          "code": null,
 
          "isUnique": false,
 
          "dbIndexName": null,
 
          "fields": [],
 
          "isNew": true
 
        },
 
        "referenceIndex": {
 
          "code": null,
 
          "isUnique": false,
 
          "dbIndexName": null,
 
          "fields": [],
 
          "isNew": true
 
        },
 
        "attributeLink": null,
 
        "defaultValue": null,
 
        "defaultValueExpression": null,
 
        "userAttributePermissions": null,
 
        "component": null
 
      }
 
</syntaxhighlight>
 
|}
 
 
== Описание свойств атрибута ==
 
{| class="wikitable"
 
|-
 
! Свойство !! Описание
 
|-
 
| id || Уникальный идентификатор атрибута справочника (базовые атрибуты имеют идентификаторы от 1 до 4, нумерация дополнительных атрибутов начинается с 20)
 
|-
 
| name || Наименование атрибута, которое будет по умолчанию отображаться у атрибута
 
|-
 
| code || Код атрибута в таблице в базе данных
 
|-
 
| description || описание хранимых данных атрибута
 
|-
 
| dataType || тип данных (список доступных типов данных см. ниже)
 
|-
 
| type || тип атрибута (список доступных типов атрибутов см. ниже)
 
|-
 
| isNullable || флаг о возможности пустого значения
 
|-
 
| hasMultipleValues || для атрибутов в типом данных "Связанный" флаг на возможность множественной отметки
 
|-
 
| isVisible || флаг о видимости атрибута
 
|-
 
| isReadOnly || флаг о возможности только чтения или редактирования атрибута
 
|-
 
| formula || формула расчета для [[Платформа_3V/Справочник/Вычислимые атрибуты|'''вычислимых атрибутов''']]
 
|-
 
| tableName || Физическое имя связанной таблицы для множественного атрибута
 
|-
 
| attributeLink || блок свойств предназначенных для указания [[Платформа 3V/Справочник/Изменение типа атрибута на связанный|'''связи между двумя справочниками''']]
 
|-
 
| attributeLink.name || наименование связанного справочника
 
|-
 
| attributeLink.linkedDictionaryId || идентификатор связанного справочника
 
|-
 
| attributeLink.linkedAttributeId || в связанном справочнике идентификатор атрибута, по которому необходимо связать данные
 
|-
 
| attributeLink.linkedAttributeNameId || в связанном справочнике идентификатор атрибута, значения которого необходимо отобразить в текущем справочнике
 
|-
 
| attributeLink.canSelect || связь атрибутов, по которой будет происходить [[Платформа_3V/Отчет/Блокировка_для_выбора_элементов_в_выпадающих_списках|'''блокировка элементов в столбцах отчета''']]
 
|-
 
| defaultValue || [[Платформа_3V/Отчет/Установка_значения_по_умолчанию|'''постоянное значение атрибута по умолчанию''']]
 
|-
 
| defaultValueExpression ||  [[Платформа_3V/Отчет/Установка_значения_по_умолчанию|'''значение атрибута по умолчанию на основании выражения''']]
 
|-
 
| component || наименование компонента (веб), который должен использоваться для работы с данными. Например, используется для [[Платформа_3V/Отчет/Логический атрибут в 3х состояниях (True/False/null)|'''отображения в отчетах логических атрибутов в трех возможных состояниях (True/False/null)''']]
 
|}
 
 
 
 
Базовыми атрибутами справочника является:
 
{| class="wikitable"
 
|-
 
! Наименование атрибута (name) !! Идентификатор (id) !! Код (code) !!  Тип атрибута (type) !!  Тип данных (dataType)
 
|-
 
| Идентификатор || 1 || ID || Id || Integer/String/DateTime/Guid
 
|-
 
| Наименование || 2 || NAME || Name || String
 
|-
 
| Порядок || 3 || ORD || Ord || Integer
 
|-
 
| Родитель || 4 || PARENT_ID || ParentId || Integer/String/DateTime/Guid
 
|}
 
 
Типы данных:
 
{| class="wikitable"
 
|-
 
! Тип данных (dataType) !! Описание
 
|-
 
| Boolean || Логическое значение (да/нет)
 
|-
 
| Clob || Двоичные данные
 
|-
 
| DateTime || Дата и время
 
|-
 
| Double || Вещественное число
 
|-
 
| Integer|| Целое число (32 разряда)
 
|-
 
| Guid || Гарантированный уникальный идентификатор
 
|-
 
| Json || Данные в формате JSON
 
|-
 
| Long || Целое число (64 разряда)
 
|-
 
| String || Строка
 
|}
 
 
'''NB!''' Поддержка атрибутов типа DateTime, String и guid в качестве первичного ключа справочника - идентификатора поддерживается только чтения, без изменения элементов. Если в справочнике есть атрибут с типом "родитель", то ему необходимо обязательно указывать тип данных такой же как у идентификатора!
 

Текущая версия на 11:23, 23 декабря 2021

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


Для чего?

Справочник нужен для хранения данных.

Из чего состоит?

Справочник состоит из следующих частей:

Справочник области.png


  1. Названия атрибутов (жарг. Шапка) - это заголовок столбца, который задаётся в конструкторе.

  2. Область данных (Элементы справочника) - это заполненные значениями ячейки атрибутов.