Systems.Documents.DataSourceQueries Entity

Represents a query within a data source. Entity: Sys_Data_Source_Queries

Renames

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

Default Visualization

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

Aggregate

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

Aggregate Parent:
Systems.Documents.DataSources
Aggregate Root:
Systems.Documents.DataSources

Attributes

Name	Type	Description
DependsOnChildRows	DependsOnChildRows	Determines the visibility of rows in this table. 0 - allways visible; 1 - the row is visible if there is at least one child row; 2 - the row is visible if all sub-tables contain child rows. `Required` `Default(0)`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
ExtensionsList	string (max) nullable	A comma separated list of report extension names. An extension is set of additional fields that participate in the query.
FilterXml	dataaccessfilter nullable	Filter for the loaded table.
FirstRow	boolean	Specifies, that only the first row of the current query will be retrieved. Used and applied only when the data source type is not multitable. `Required` `Default(false)`
Id	guid
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.
ReferencePath	string (max)	A sequence of table names and foreign key columns that define how the data will be loaded by this query. For example - Gen_Documents/ Enterprise_Company_ Id/Company_Id - will load the definition of the company for the enterprise company of a document. `Required`
TableName	string (64) nullable	The name of the report query. A Reference_Path can participate more than one time in the report but with different Report_Query_Name. This can be used to specify different filter for the same query. Can be null.
UniqueName	string (64) nullable	The name of the data table in the printout datasource. If null the Reference_Path is used.

References

Name	Type	Description
DataSource	DataSources	The report of the query. `Required` `Filter(multi eq)` `Owner`

Attribute Details

DependsOnChildRows

Determines the visibility of rows in this table. 0 - allways visible; 1 - the row is visible if there is at least one child row; 2 - the row is visible if all sub-tables contain child rows. Required Default(0)

Type: DependsOnChildRows
Category: System
Allowed values for the DependsOnChildRows(Systems.Documents.DataSourceQueries.md#dependsonchildrows) data attribute
Allowed Values (Systems.Documents.DataSourceQueriesRepository.DependsOnChildRows Enum Members)

Value	Description
NoChildRowDependency	NoChildRowDependency value. Stored as 0. Database Value: 0 Model Value: 0 Domain API Value: 'NoChildRowDependency'
TheRowIsVisible IfThereIsAtLeast OneChildRow	TheRowIsVisible IfThereIsAtLeast OneChildRow value. Stored as 1. Database Value: 1 Model Value: 1 Domain API Value: 'TheRowIsVisible IfThereIsAtLeast OneChildRow'
TheRowIsVisible IfAllSubTables ContainChildRows	TheRowIsVisible IfAllSubTables ContainChildRows value. Stored as 2. Database Value: 2 Model Value: 2 Domain API Value: 'TheRowIsVisible IfAllSubTables ContainChildRows'

Supported Filters: NotFilterable
Supports Order By: False
Default Value: 0
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

ExtensionsList

A comma separated list of report extension names. An extension is set of additional fields that participate in the query.

Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
Show in UI: ShownByDefault

FilterXml

Filter for the loaded table.

Type: dataaccessfilter nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

FirstRow

Specifies, that only the first row of the current query will be retrieved. Used and applied only when the data source type is not multitable. Required Default(false)

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

Id

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

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

ReferencePath

A sequence of table names and foreign key columns that define how the data will be loaded by this query. For example - Gen_Documents/Enterprise_Company_Id/Company_Id - will load the definition of the company for the enterprise company of a document. Required

Type: string (max)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
Show in UI: ShownByDefault

TableName

The name of the report query. A Reference_Path can participate more than one time in the report but with different Report_Query_Name. This can be used to specify different filter for the same query. Can be null.

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

UniqueName

The name of the data table in the printout datasource. If null the Reference_Path is used.

Type: string (64) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 64
Show in UI: HiddenByDefault

Reference Details

DataSource

The report of the query. Required Filter(multi eq) Owner

Type: DataSources
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
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