Systems.Documents.DataSources Entity

Contains user-defined data sources, which retrieve rows from multiple queries. Entity: Sys_Data_Sources

Renames

Old name: Systems.Reporting.DataSources
New name: Systems.Documents.DataSources
Version: 24.1.5.35
Case: 35911

Default Visualization

Default Display Text Format:
{Name}
Default Search Members:
Name
Name Data Member:
Name
Category: Settings
Show in UI: ShownByDefault

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Tree

Systems.Documents.DataSources
- Systems.Documents.DataSourceQueries

Attributes

Name	Type	Description
BaseQueryName	string (128)	The name of the query or table that is used for root reference point of the loaded data. `Required` `Filter(eq;like)`
DataSourceType	DataSourceType	'M' = MULTI-TABLE (many tables); 'D' = MASTER-DETAIL (two tables); 'S' = SINGLE-TABLE . `Required` `Default("M")` `Filter(eq)`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
Name	string (64)	The name of the data source. `Required` `Filter(eq;like)`
ObjectVersion	int32	The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.
ShowParentTables	boolean	Indicates whether the parent nodes in the Reference_Path in Sys_Data_Source_ Queries_Table are automaticaly included in the report or not. `Required` `Default(false)`

Child Collections

Name	Type	Description
Queries	DataSourceQueries	List of `DataSourceQuery`(Systems.Documents.DataSourceQueries.md) child objects, based on the `Systems.Documents.DataSourceQuery.DataSource`(Systems.Documents.DataSourceQueries.md#datasource) back reference

Attribute Details

BaseQueryName

The name of the query or table that is used for root reference point of the loaded data. Required Filter(eq;like)

Type: string (128)
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 128
Show in UI: ShownByDefault

DataSourceType

'M' = MULTI-TABLE (many tables); 'D' = MASTER-DETAIL (two tables); 'S' = SINGLE-TABLE . Required Default("M") Filter(eq)

Type: DataSourceType
Category: System
Allowed values for the DataSourceType(Systems.Documents.DataSources.md#datasourcetype) data attribute
Allowed Values (Systems.Documents.DataSourcesRepository.DataSourceType Enum Members)

Value	Description
MultiTable	MultiTable value. Stored as 'M'. Database Value: 'M' Model Value: 0 Domain API Value: 'MultiTable'
MasterDetail	MasterDetail value. Stored as 'D'. Database Value: 'D' Model Value: 1 Domain API Value: 'MasterDetail'
SingleTable	SingleTable value. Stored as 'S'. Database Value: 'S' Model Value: 2 Domain API Value: 'SingleTable'

Supported Filters: Equals
Supports Order By: False
Default Value: MultiTable
Show in UI: ShownByDefault

DisplayText

Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown

Name

The name of the data source. Required Filter(eq;like)

Type: string (64)
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 64
Show in UI: ShownByDefault

ObjectVersion

The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

ShowParentTables

Indicates whether the parent nodes in the Reference_Path in Sys_Data_Source_Queries_Table are automaticaly included in the report or not. Required Default(false)

Type: boolean
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: False
Show in UI: ShownByDefault

API Methods

Methods that can be invoked in public APIs.

GetAllowedCustomPropertyValues

Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET

Parameters

customPropertyCode
The code of the custom property
Type: string
search
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: null
exactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: False
orderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: False
top
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10
skip
The skip clause - default is 0
Type: int32
Optional: True
Default Value: 0

CreateNotification

Create a notification immediately in a separate transaction, and send a real-time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST