Scroll

Constants and Enumerators

There are many variables in the APIs that require a specific type of value from a set of values. These sets of values are called enumerated types, and each value in a type is called an enumerator, or enum. Enumerated types are no more than a set of named values, which act as Constants in the API.

When an API variable requires an enum, it must be set to one of the constants that are defined in the specified enumerated type. For example, if a variable requires a Report Type enum, it accepts the values "Advanced", "Express", "Dashboard", "Chained", or "ExpressView". Other values will cause an invalid type error.

Some API variables are not enumerated types, but may require a set of constants regardless. These constants have no numeric equivalent.

The following article is a reference guide that lists the most important enumerated types and lists of constants that are used throughout the API.

Caution: Numeric values should not be used as enum types as these values are not constants.

 

Report Type

Enum Name
Numeric Value Description
Advanced 0 Advanced Report (CrossTab Reports are considered Advanced Reports)
Standard 0 Deprecated: Use Advanced instead.
Express 1 Express Report
Dashboard 2 Dashboard
Chained 3 Chained Report
ExpressView 5 ExpressView

 

Api Action

Enum Name Numeric Value Description
Default 0 If a report is loaded, this is equivalent to ExecuteReport. Otherwise, this is equivalent to Home. 
Home 1 Open the home page.
ExecuteReport 2 Execute the loaded report (specify format with wrExportType).
EditReport 3 Open the loaded report in the appropriate editor.
NewAdvancedReport 4 Open the New Advanced Report Wizard.
NewReport 4 Deprecated: Use NewAdvancedReport instead.
NewCrossTabReport 5 Open the New CrossTab Report Wizard.
NewExpressReport 6 Open the New Express Report Wizard.
NewDashboardReport 7 Open the Dashboard Designer for a new dashboard.
NewExpressView 8 Open the ExpressView Designer for a new ExpressView.
ScheduleReport 9 Open the Schedule Report Wizard for the loaded report.
ScheduledReportsManager 10 Open the Scheduled Report Manager.

 

Export Type

Enum Name Numeric Value Description
Html 0 Run in the browser, using the appropriate viewer.
Excel 1 Export as an Excel file.
Pdf 2 Export as a PDF file.
Rtf 3 Export as an RTF file.
Csv 4 Export as a CSV file.
Word 5 Export as a Word file.
Default 6 Default type specified by the loaded report; if not specified, default type specified by the current config.

 

Data Source Type

Enum Name Numeric Value Description
MsSql 0 Microsoft SQL Server
MySql 1 MySQL
ODBC 2 ODBC
Postgres 3 PostreSQL
Oracle 4 Oracle
DB2 5 IBM DB2
Informix 6 IBM Informix
Assembly 7 .NET Assembly
WebService 8 Web Service
File 9 Excel file
MsOlap 10 OLAP

 

Data Field Type

Enum Name Numeric Value Description
String 0 String
Date 1 Date, i.e. day, month, year
DateTime 2 Date & time
Time 3 Time, i.e. hour, minute, second (am/pm)
Integer 4 Integer number
Decimal 5 Decimal number
Float 6 Floating-point number
Bit 7 Bit
Guid 8 Globally (universally) unique identifier, aka. UUID
Image 9 Image
Currency 10 Currency

 

Data Object Type

Enum Name Description
Assembly .NET Assembly method
File Excel file
Function User-defined function
Procedure Stored procedure
SqlStmt Custom SQL statement
Table Data table
View SQL view 
WebSvc Web Service method
MdxStmt MDX query (OLAP)

 

Join Type

Enum Name Description
Inner Inner join
LeftOuter Left outer join
RightOuter Right outer join
FullOuter Full outer join (left outer join + right outer join)

 

Join Relation Type

Enum Name Description
OneToOne One-to-one relationship
OneToMany One-to-many relationship

 

Schedule Manager View Level

Enum Name Numeric Value Description
User 0 Filter schedules by current UserId parameter
Company 1 Filter schedules by current CompanyId parameter
All 2 Show all schedules

 

Parameter Type

Enum Name Numeric Value Description
String 0 String
Date 1 Date, i.e. day, month, year
Integer 2 Integer number
Decimal 3 Decimal number 

 

Code Language

Note: Each value has multiple names.
Enum Name Numeric Value Description
c#
cs
csharp
0 C Sharp
js
javascript
1 JavaScript
vb
visualbasic
2 Visual Basic

 

Filter Operator Type

Enum Name Numeric Value Description
EqualTo 0 Data value is equal to the filter value
LessThan 1 Data value is less than the filter value (number, date)
LessThanOrEqualTo 2 Data value is less than or equal to the filter value (number, date)
GreaterThan 3 Data value is greater than the filter value (number, date)
GreaterThanOrEqualTo 4 Data value is greater than or equal to the filter value (number, date)
NotEqualTo 5 Data value is not equal to the filter value
StartsWith 6 Data value starts with the filter value (string, number)
NotStartsWith 7 Data value does not start with the filter value (string, number)
EndsWith 8 Data value ends with the filter value (string, number)
NotEndsWith 9 Data value does not end with the filter value (string, number)
Contains 10 Data value contains the filter value (string, number)
NotContains 11 Data value does not contain the filter value (string, number)
Between 12 Data value is between the two filter values
NotBetween 13 Data value is not between the two filter values
OneOf 14 Data value is equal to one of the filter values
NotOneOf 15 Data value is not equal to any of the filter values

 

Folder Status

Enum Name Description
Exists This folder exists
DoesNotExist This folder does not exist
Created This folder was successfully created
Deleted This folder was successfully deleted
Renamed This folder was successfully renamed

 

Report Validation Errors

Enum Name
DataObjectNotFound
SortDataFieldNotFound
FilterDataFieldNotFound
LinkedDataFieldNotFound
MinMaxFilterDataFieldNotFound
JoinDataObjectNotFound
JoinNotFound
JoinDataFieldNotFound
ChartDataFieldNotFound
MapDataFieldNotFound
CellDataFieldNotFound
RowGroupNameNotFound
RowGroupFormulaNameNotFound
ChartCellIdNotFound
MapCellIdNotFound
MergedCellsAcrossSections
CrossTabIdNotFound
CrossTabCellIdNotFound
ColumnSortByFieldNotFound
ChildReportNotFound
ExpressViewColumnMissingEntity
ExpressViewColumnMissingField
ExpressViewGroupMissingField
ExpressViewFilterMissingField

 

Filterable Type

Enum Name Description
All Field supports all filter types
True Field supports all filter types
None Field cannot be filtered
False Field cannot be filtered
Dynamic Field supports only dynamic (interactive) filters
Static Field supports only static (report) filters

 

Range Limit

Enum Name Description
None Disable range limiting SQL.
LimitOffset SELECT ... LIMIT rangeSize OFFSET offsetRow
OffsetFetch SELECT ... OFFSET offsetRow ROWS FETCH NEXT rangeSize ROWS ONLY
RowNumberWithTop SELECT TOP endingRow ROW_NUMBER() Over(Order By (...)) as wrRowNum ... as wrRowNumbered WHERE wrRowNumbered.wrRowNum BETWEEN startingRow AND endingRowField
RowNumber SELECT ROW_NUMBER() Over(Order By (...)) as wrRowNum ... as wrRowNumbered WHERE wrRowNumbered.wrRowNum BETWEEN startingRow AND endingRowField
RowNumberNoAlias SELECT ROW_NUMBER() Over(Order By (...)) as wrRowNum ... WHERE wrRowNum BETWEEN startingRow AND endingRowField

Hidden Article Information

Article Author
Exago Development
created 2017-03-16 17:28:24 UTC
updated 2019-01-15 18:06:57 UTC

Labels
no labels yet!
Have more questions? Submit a request