Report |
The ReportModel type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AggregateRestriction | The aggregate restriction text of the model |
| AggregateRestrictions | List of aggregate restrictions of the model |
| Alias | Alias name used for the table defining the select |
| AllExecutionRestrictions | List of all restrictions of the model (including aggregate and common restrictions) |
| BuildTimeout | Timeout in milliseconds to set the maximum duration used to build the SQL (may be used if many joins are defined) |
| CommandTimeout | "Default Timeout in seconds for the SQL Statements executed to load the model. -1 means the use of the Timeout defined in the connection. 0 means no Timeout. |
| CommonRestrictions | List of common restrictions and values involved in the model. Common Restrictions or Values are defined in the SQL (Pre, Post, Table SQL, Where Clause, etc.) with the '{CommonRestriction_' or '{CommonValue_' keywords (e.g. {CommonRestriction_Amount} to create a common restriction named 'Amount') |
| Connection | The current MetaConnection of the model |
| ConnectionGUID | The connection used to build the model |
| Elements | Elements selected for the model |
| ExecutionAggregateRestrictions | List of aggregate restrictions of the model |
| ExecutionCommonRestrictions | List of Common Restrictions of the model |
| ExecutionRestrictions | List of restrictions of the model |
| ExecutionSet | During the models generation, the models of the same Set Number are generated in parallel at the same time. The models with Set 1 are executed first at the same time, then models with Set 2, etc. This can be used if models depends on other models. |
| FinalScript | Optional Razor Script to modify the model after its generation |
| FromTables | List of tables involved in the model |
| GUID |
The unique identifier
(Inherited from RootComponent) |
| HasCellScript | True if the model has cell script defined for one of its element |
| HasChartJSSerie | True if the model has a Chart JS serie |
| HasEmptyRepeated | True if the model has elements with EmptyRepeated |
| HasNVD3Serie | True if the model has a NVD3 serie |
| HasPlotlySerie | True if the model has a Plotly serie |
| HasPrimaryYAxis | True if the model has a primary axis for a serie |
| HasScottPlotSerie | True if the model has a Chart ScottPlot serie |
| HasSecondaryYAxis | True if the model has a secondary axis for a serie |
| HasSerie | True if the model has series defined |
| HasStandardAggregateRestrictions | Return true if the aggregate restrictions are standards (simple list with AND) |
| HasStandardRestrictions | Return true if the restrictions are standards (simple list with AND) |
| HasSubTotals | True if the model has subtotals |
| HasTotals | True if the model has totals |
| HelperViewJoins | Helper to view joins evaluated for the model |
| IgnorePrePostError | If true, errors occuring during the Pre or Post SQL statements are ignored and the execution continues |
| IsLINQ | True is it is a Model based on a LINQ source |
| IsSQLModel | True is it is a SQL Model (not standard based on the metadata) |
| IsSubModel | True is it is a Sub-Model used for a LINQ Query |
| JoinsToSelect | Helper to select Join preferences |
| JoinsToUse | List of Joins used to perform the query and joins the tables involved. By default, all Joins available in the Data Source are used. |
| KeepColNames | If true, the column names of the source a kept when building the metadata columns |
| LINQLoadScript | Default LINQ Load Script used for the model |
| LINQQueryScript | If not empty, overwrites default query script template used to generate the LINQ query |
| LINQSubModels | List of SQL Sub-models involved in a LINQ Model |
| LINQSubTables | List of SQL Sub-tables involved in a LINQ Model |
| LoadScript | The Razor Script used to load the data in the table. If empty, the load script defined in the master table is used. |
| MaxNumberOfRecords | Limit the number of records loaded for the model. A value of 0 means no limitation. The implementation at server side is only done for MS SQLServer, Oracle and MYSQL |
| Name |
The name
(Inherited from RootComponent) |
| PostSQL | SQL Statement executed after the main query. The statement may contain Razor script if it starts with '@'. |
| PreLoadScript | Optional Razor Script to modify the result table of the model just before the database load |
| PreSQL | SQL Statement executed before the main query. The statement may contain Razor script if it starts with '@'. |
| PrintQuery | If true, the query is printed in the report messages (for debug purpose). |
| ReferenceModel | Current reference model if any |
| ReferenceModelGUID | If set, restrictions and elements from the referenced model are inserted to the current model. This enables the sharing of restrictions and elements among different models. The position of the element inserted can be specified in the element property 'Insert position' in the referenced model. |
| Report |
The current report
(Inherited from ReportComponent) |
| Restriction | The restriction text of the model |
| Restrictions | List of restrictions of the model |
| ResultTableTranslated | Result DataTable got from the SQL query with the original column names and without hidden columns |
| SerializedTag | Custom string serialized (saved with the report definition) |
| SerializedTag2 | Custom string serialized (saved with the report definition) |
| ShareResultTable | If true and several models have the same SQL or Script definiton, one result table is generated and shared for those models (Optimization). |
| ShowFirstLine | If true and the table has column values, the first line used for titles is generated in the table header |
| Source | Current report source |
| SourceGUID | The source used to build the model |
| Sql | SELECT Sql used for the model |
| SqlCTE | If not empty, overwrite the CTE (Common Table Expressions) clause in the generated SQL statement |
| SqlFrom | If not empty, overwrite the FROM clause in the generated SQL statement |
| SqlGroupBy | If not empty, overwrite the GROUP BY clause in the generated SQL statement |
| SqlOrderBy | If not empty, overwrite the ORDER BY clause in the generated SQL statement |
| SqlSelect | If not empty, overwrite the SELECT clause in the generated SQL statement (e.g 'SELECT TOP 10', 'SELECT') |
| SubModelsSetAggr | If true, aggregates are copied to sub-models elements, otherwise the sub-models elements have no aggregate. This may impact the final performances and results (especially for Count or Average aggregates). |
| SubModelsSetRestr | If true, restrictions and theirs values defined for the LINQ model are automatically copied to the sub-models. |
| Table | Table definition for a SQL Model |
| UseRawSQL | If true, the raw source SQL is used to generate the result table instead of using a 'select * from (Source SQL) a' statement. In this case, aggregations, restrictions and custom SQL are not applied |
| UseSelectDistinct | If true, SELECT DISTINCT clause clause is used by default for the model if no aggregate is defined |
See Also