| Name | Description | |
|---|---|---|
 | Category | The folder that this Entity (Data Object) will appear in. To create a hierarchy of folders, include slashes. |
| ClonedFrom | If this Entity (Data Object) is a clone of another one, this property must contain the name of the "parent" object from which this one was cloned. When creating a cloned data object, this property must be set otherwise the system will not recognize it as a clone. |
| ColumnMetadatas | A collection of the column metadata for all columns in this Entity (Data Object). |
| DataSourceId | The ID of the Data Source that this Entity (Data Object) is a member of. |
| DbName | The name of the object in the data source that corresponds with this data object. For example, the name of the table or view. If this Entity is a Custom SQL Object, this is the Object Name property of the Custom SQL Object. |
| FilterDataSourceId | When creating a Custom Filter Dropdown Object, this is the ID of the data source that contains the Entity (Data Object) that has the filter dropdown values. |
| FilterDbName | When creating a Custom Filter Dropdown Object, this is the DbName property of the Entity (Data Object) that has the filter dropdown values. For example, the table, view or stored procedure in the Data Source that contains the filter values. |
| FilterObjectType | When creating a Custom Filter Dropdown Object, this is the type of data object (e.g. table, view, etc...) that is the source of the dropdown values. |
| FilterSqlStmt | When creating a Custom Filter Dropdown Object, and the object will utilize a custom SQL statement (i.e. FilterObjectType is DataObjectType.SqlStmt), this property represents the SQL statement of the object. |
| HasInheritedCategory | Set to true to copy the folder location of the object that this clone was created from. Set to false to provide a different folder location in the Category Property. |
| HasInheritedDescription | Set to true to copy the description text of the object that this clone was created from. Set to false to provide a unique description in the ObjectDescription Property. |
| Id | An application-wide unique identifier for the Entity (Data Object). IDs are required when creating multiple data objects with that have the same name but come from distinct data sources. IDs can also be used to optimize Web Service and .NET Assembly calls. For more information see Data Object IDs. |
| KeyColumns | A collection of the Unique Key Fields on an Entity (Data Object). Unique Key Fields are columns which uniquely identify a record in this data object. |
| Name | The user friendly name for the data object. The alias will be displayed to end-users. This field is required. |
| ObjectDescription | Provide an optional user-friendly description of this Entity (Data Object). When this object is hovered over in the Data Fields Pane, the description text will pop up in a tooltip. |
| ObjectType | The type of object that this Entity (Data Object) is (e.g. table, view, etc...) |
| Parameters | Parameters that are passed to stored procedures, table functions, Web Services or .NET Assembly methods. Clicking in the drop-down will bring up a menu. For more information see Stored Procedures and Web Services & .NET Assemblies. Parameter values are passed in the order in which they are listed in the data object. It is critical to ensure that the order is correct. |
| SchemaAccessType | Determines how Exago will retrieve the schema information from the Entity (Data Object). Either use the system default, the configured column metadata (recommended) or read it from the data source each time it is needed. In v2019.1+, the system default is to use the configured column metadata. |
| SqlStmt | If this Entity (Data Object) is a Custom SQL Object, (i.e. ObjectType is DataObjectType.SqlStmt), this property represents the SQL statement of the object. |
| SuppressSortAndFilter | If this Entity (Data Object) is a programmable object (Stored Procedure or .NET Assembly Method), select whether to suppress the application sorting and filtering for report execution queries. Enable this if the programmable object uses Programmable Object parameters to do sorting and filtering in code, as application processing would be redundant and unnecessary. This can allow for better performance for programmable objects. If the application requires sorting/filtering in memory, it will not be suppressed. For instance, a report with this object has a cross-source join, an advanced join, a Cartesian join, or a formula sort or filter. Multiple tables from the same programmable data object can be joined with suppressed filtering & sorting if this setting is enabled for all of them. |
| Tenants | A collection of the tenant columns on this data object. Specify which columns contain tenant information and link the parameters accordingly. Tenant Columns used to filter data when multiple users’ information is held within the same table or view, and a column holds information identifying each user. Exago will only retrieve the rows where the column value matches the corresponding parameter. |
Exago .NET API Documentation
Entity Class Properties