Источники данных

Материал из 3v-wiki
Перейти к навигации Перейти к поиску


Все источники данных в серверной карточке описываются в коллекции entryDataSources.

1 {
2   ...
3   "entryDataSources": [
4     ...
5   ],
6   ...
7 }

Базовые свойства источников данных

Все источники данных имеют свойства перечисленные ниже.

Свойство Описание
id Идентификатор источника данных
name Наименование источника данных
isReadOnly Признак, что источник данных доступен только для чтения
dataEditRuleIds Коллекция идентификаторов правил BinaryConditionRule, которые определяют доступность редактирования источника
beforeSaveDataActions Коллекция идентификаторов действий Action, которые выполняются перед сохранением источника данных
afterSaveDataActions Коллекция идентификаторов действий Action, которые выполняются после сохранения источника данных

Источник данных на справочнике (DictionaryDataSource)

 1     {
 2       "id": 1,
 3       "name": "Источник на справочнике",
 4       "dictionaryId": 14040,
 5       "hierarchyId": null,
 6       "filter": [
 7         {
 8           "id": 1,
 9           "expressionId": 1,
10           "value": 33
11         }
12       ],
13       "sortingOptions": null,
14       "groupingOptions": null,
15       "dictionaryAttributes": null,
16       "defaultValue": null,
17       "defaultValueExpressionId": null,
18       "parameterId": null,
19       "dictionarySourceSelectionMode": "None",
20       "dataSourceAttributesAdditionsSettings": null,
21       "externalFileStorageUrl": null,
22       "filePrefix": null,
23       "discriminator": "DictionaryDataSource"
24     }
Свойство Описание
dictionaryId Идентификатор справочника (объект репозитория)
hierarchyId Идентификатор альтернативной иерархии справочника DictionaryHierarchyDto
filter Фильтр справочника DictionaryFilterDto
sortingOptions Настройки сортировки справочника SortingOptionsDto
groupingOptions Настройки группировки справочника IDictionaryGroupingOptions
dictionaryAttributes Коллекция загружаемых атрибутов AttributeDefinitionDto
dictionarySourceSelectionMode Режим выставления отметки справочника при первом его открытии DictionarySourceSelectionMode
defaultValueExpressionId Идентификатор выражения, результат которого будет использоваться как значение по умолчанию при соответствующем значении DictionarySourceSelectionMode (DefaultValueByExpression , DefaultValueByExpressionOrSelectFirst )
parameterId Идентификатор параметра, значения которого будут использоваться как значение по умолчанию при соответствующем значении DictionarySourceSelectionMode (ParameterValue, ParameterValueOrSelectFirst)
defaultValue Коллекция идентификаторов элементов справочника, которые будут использоваться как значение по умолчанию при соответствующем значении DictionarySourceSelectionMode (DefaultValue, DefaultValueByExpressionOrSelectFirst)
dataSourceAttributesAdditionsSettings Коллекция дополнительных настроек для атрибутов справочника DataSourceAttributesAdditionsSettings
externalFileStorageUrl Ссылка на внешнее хранилище файлов. Хранилище должно иметь апи на загрузку файлов через put "upload/fileName" и на получение через get "get/fileName".
filePrefix Префикс для файлов, загружаемых в externalFileStorageUrl. Может использоваться для задания пути файла, например префикс "folder/" будет означать, что файлы будут складываться в папку "folder".

Режимы выставления отметки справочника при открытии справочника (DictionarySourceSelectionMode)

Значение Описание
None (0) -
SelectFirst (1) Будет выбран первый элемент справочника
SelectAll (2) Будут выбраны все элементы справочника
DefaultValue (3) Будут выбраны элементы по умолчанию
ParameterValue (4) Будут выбраны элементы по значению параметра
SelectAllEver (5) Будут выбраны все элементы справочника, в отличии от SelectAll, при обновлении источника отметка сбрасывается всегда до полной, позволяет решить вопрос, когда при нескольких перестроений зависимых источников некоторые из элементов оказываются не выбраны
DefaultValueByExpression (6) Будут выбраны элементы по результату вычисления выражения
DefaultValueOrSelectFirst (103) Будут выбраны элементы по умолчанию или первый элемент
ParameterValueOrSelectFirst(104) Будут выбраны элементы по значению параметра или первый элемент
DefaultValueByExpressionOrSelectFirst (106) Будут выбраны элементы по результату вычисления выражения или первый элемент

Источник данных на отчете (PivotDataSource)

1     {
2       "id": 1,
3       "name": "Источник на отчёте",
4       "pivotId": 14040,
5       "parameters": [
6       ...
7       ],
8       "discriminator": "PivotDataSource"
9     }
Свойство Описание
pivotId Идентификатор отчёта (объект репозитория)
parameters Коллекция параметров с которыми должен открываться отчёт EntryExpressionParameterDto

Источник данных на показателе (DataIndicatorDataSource)

1     {
2       "id": 1,
3       "name": "Источник на показателе",
4       "indicatorId": 14040,
5       "selectionSetId": 1,
6       "discriminator": "DataIndicatorDataSource"
7     }
Свойство Описание
indicatorId Идентификатор показателя (объект репозитория)
selectionSetId Идентификатор отметки EntrySelectionSetDto по которой будет открыт показатель

Источник данных на согласовании (WorkflowDataSource)

 1     {
 2       "id": 1,
 3       "name": "Источник на согласовании",
 4       "workflowId": 14040,
 5       "parameters": [
 6         {
 7           "id": 1,
 8           "expressionId": 1,
 9           "value": 33
10         }
11       ],
12       "stateChangeActions": [
13         1
14       ],
15       "discriminator": "WorkflowDataSource"
16     }
Свойство Описание
workflowId Идентификатор согласования (объект репозитория)
parameters Коллекция параметров согласования ValueParameter
stateChangeActions Коллекция идентификаторов действий по условию ConditionalAction, которые выполняются при изменении состояния согласования

Источник данных на Json (JsonDataSource)

1     {
2       "id": 1,
3       "name": "Источник на Json",
4       "jsonExpressionId": 1,   
5       "discriminator": "JsonDataSource"
6     }
Свойство Описание
jsonExpressionId Идентификатор выражения EntryExpressionDto для вычисления/получения Json значения.

Источник данных на справочнике с возможностью фильтрации элементов (ViewDictionaryDataSource)

 1     {
 2       "id": 1,
 3       "name": "Источник на справочнике",
 4       "dictionaryDataSourceId": 1,   
 5       "selectAllElements": false, 
 6       "filters": [...],
 7       "useBaseDataSourceValue": false,
 8       "dataSourceAttributesAdditionsSettings": null,
 9       "discriminator": "ViewDictionaryDataSource"
10     }
Свойство Описание
dictionaryDataSourceId Идентификатор базового источника данных на справочнике
selectAllElements Признак, что будут отмечены все элементы справочника
filters Коллекция фильтров ViewDictionaryDataSourceBaseFilter
useBaseDataSourceValue Признак, что при построении инстанса значение будет формироваться на основе базового источника данных
dataSourceAttributesAdditionsSettings Коллекция дополнительных настроек для атрибутов справочника DataSourceAttributesAdditionsSettings