WebReports.Api.Reports Namespace

Exago .NET API Documentation

WebReports.Api.Reports Namespace

Inheritance Hierarchy Collapse All

The Reports namespace contains classes used to interact with reports, entities (data objects) and joins.

Since Entities (Data Objects) and Joins can be system-level or report-level, they are included in this namespace.

Classes

	Class	Description
	Entity	An Entity object represents an Exago Data Object. Data Objects are the tables, views, methods, stored procedures, functions and custom SQL made accessible from the Data Sources for reports.
	EntityColumn	An EntityColumn object represents a column in an Entity (Data Object).
	EntityColumnMetadata	An EntityColumnMetadata object contains all of the column metadata properties for a column in an Entity (Data Object).
	EntityColumnMetadataCollection	A collection of metadata objects, one for each column in an Entity (Data Object). Do not instantiate this collection, instead access the metadata through the Entity.ColumnMetadatas Property.
	EntityParameter	Each Parameter for a Data Object is represented by an EntityParameter object.
	EntityParameterCollection	The collection of Parameters on an Entity (Data Object) in the configuration. Do not instantiate this collection, access the collection via the Entity.Parameters Property. 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. Click the Add button and select the parameter from the drop-down list.
	EntityTenant	A Tenant Column for a Data Object.
	EntityTenantCollection	Represents all of the Tenant Columns, as EntityTenant Objects on a Data Object. Do not instantiate this collection, access it through the Tenants Property of the Entity Class.
	Join	Joins specify to Exago the relationship between Entities (Data Objects).
	JoinColumn	A JoinColumn defines the relationship between columns in a Join.
	JoinColumnCollection	The collection of JoinColumn objects that form a Join Object. Do not instantiate this collection, instead access it via the JoinColumns Property of the Join Class.
	KeyColumn	This object represents a unique key field in an Entity (Data Object). Unique key fields are columns that uniquely identify a record in an Entity (Data Object). Each entity requires at least one Key Column. KeyColumn objects are also used when constructing Joins between Entities (Data Objects).
	KeyColumnCollection	A collection of the Unique Key Fields of an Entity (Data Object). Do not instantiate this collection, access the collection with the KeyColumns Property of the Entity Class. Each unique key field is represented by a KeyColumn Object in the collection.
	Report	The Report class allows Advanced and Express Reports to be executed directly from the host application. This class does not need to be instantiated, it should be retrieved using methods defined in ReportObjectFactory. The Report class is derived from the ReportObject abstract class.
	ReportObject	An abstract representation of a report in the system.
	ReportObjectFactory	A Report is normally loaded via API in order to launch directly into the execution or editing of the report. In most cases, report loading is handled by the Exago runtime via the `LoadFromRepository` call. `LoadFromRepository` returns an object of type ReportObject. In order for the load to complete, a corresponding SaveToApi is done. `SaveToApi` will save the `ReportObject`, including any modifications back to the API for loading (for execution or editing). Both `LoadFromRepository` and `SaveToApi` should be accessed via the `Api.ReportObjectFactory` property. Both `LoadFromRepository` and `SaveToApi` return and store a `ReportObject` respectively. Most modifications made to a report loaded at runtime (such as changing filter values) are performed on properties defined within the child types (such as `Report` or `DashboardReport`). Such modifications would require a cast of the `ReportObject` to the appropriate child type. If modifications are desired, it is necessary to cast the value returned by `LoadFromRepository` to the appropriate base type. Supported base types include: `WebReports.Api.Reports.Report` for Advanced, CrossTab and Express Reports. `WebReports.Api.Composite.Dashboard.DashboardReport` for Dashboards. `WebReports.Api.Composite.Chained.ChainedReport` for Chained Reports.

Enumerations

	Enumeration	Description
	EntityColumnSource	The Column Source of an Entity (Data Object) determines if the column comes from a data source, an Exago formula or a SQL statement.
	JoinType	The type of join used in the Type Property of the Join Class.

See Also

Reference

WebReportsApi Assembly

Version: 2021.2.6 Last published: 5/18/2022

Contact Exago Support