Show / Hide Table of Contents

    General.ReportQueries Entity

    Namespace: General

    Contains the sub-queries, which a report contains. Entity: Gen_Report_Queries

    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:
    General.Reports
    Aggregate Root:
    General.Reports

    Attributes

    Name Type Description
    DependsOnChildRows boolean If True the data in the current report table contains only the rows that have child rows in sub-tables. Required Default(false)
    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.
    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 (512) 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
    ShowCustomProperties boolean True to include the custom properties. Required Default(false)
    ShowTextColumns boolean True to include text descriptions for certain columns. Required Default(false)
    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
    Report Reports OBSOLETE! Do not use! The to which this ReportQuery belongs. Obsolete Required Filter(multi eq) Obsoleted in version 23.1.2.43 Obsolete Owner

    Attribute Details

    DependsOnChildRows

    If True the data in the current report table contains only the rows that have child rows in sub-tables. Required Default(false)

    Type: boolean
    Category: System
    Supported Filters: NotFilterable
    Supports Order By: False
    Default Value: False
    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

    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 (512)
    Category: System
    Supported Filters: NotFilterable
    Supports Order By: False
    Maximum Length: 512
    Show in UI: ShownByDefault

    ShowCustomProperties

    True to include the custom properties. Required Default(false)

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

    ShowTextColumns

    True to include text descriptions for certain columns. Required Default(false)

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

    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

    Report

    OBSOLETE! Do not use! The to which this ReportQuery belongs. Obsolete Required Filter(multi eq) Obsoleted in version 23.1.2.43 Obsolete Owner

    Type: Reports
    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

    Creates a notification and sends a real time event to the user.
    Return Type: void
    Declaring Type: EntityObject
    Domain API Request: POST

    Parameters

    • user
      The user.
      Type: Users

    • notificationClass
      The notification class.
      Type: string

    • subject
      The subject.
      Type: string

    CreateCopy

    Duplicates the object and its child objects belonging to the same aggregate. The duplicated objects are not saved to the data source but remain in the same transaction as the original object.
    Return Type: EntityObject
    Declaring Type: EntityObject
    Domain API Request: POST

    Business Rules

    None

    Front-End Business Rules

    None

    API

    Domain API Query: https://demodb.my.erp.net/api/domain/odata/General_ReportQueries?$top=10

    Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#General_ReportQueries?$top=10

    • Improve this Doc
    Back to top Generated by DocFX