Exago Logo
Search
Generic filters
Exact matches only

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.

wrApiAction

Enum NameNumeric ValueDescription
Default0If a report is loaded, this is equivalent to ExecuteReport. Otherwise, this is equivalent to Home.
Home1Open the home page.
ExecuteReport2Execute the loaded report (specify format with wrExportType).
EditReport3Open the loaded report in the appropriate editor.
NewAdvancedReport4Open the New Advanced Report Wizard.
NewReport4Deprecated: Use NewAdvancedReport instead.
NewCrossTabReport5Open the New CrossTab Report Wizard.
NewExpressReport6Open the New Express Report Wizard.
NewDashboardReport7Open the Dashboard Designer for a new dashboard.
NewExpressView8Open the ExpressView Designer for a new ExpressView.
ScheduleReport9Open the Schedule Report Wizard for the loaded report.
ScheduledReportsManager10Open the Scheduled Report Manager.

Cache Visibility Level

Enum NameNumeric ValueDescription
User1Cache visibility set at the UserId parameter level
Company2Cache visibility set at the CompanyId parameter level
Global3Global cache visibility

Code Language

Note

Each value has multiple names.

Enum NameNumeric ValueDescription
c#
cs
csharp
0C Sharp
js
javascript
1JavaScript
vb
visualbasic
2Visual Basic

ConfigStorageType v2021.2+

Used in the Configuration Management system to describe the type of configuration storage mechanism in use. Most users encounter these values when creating or editing a bootstrap configuration file.

Enum NameNumeric ValueDescription
FileSystem0Configuration files are stored on the server’s file system. This is the pre-v2021.2 behavior.
Database1Configuration files are stored in a Storage Management database. This is the recommended value for all installations.
Cloud2Configuration files are stored on a cloud service such as Amazon S3 or Azure.

wrContentType v2020.1+

Enum NameNumeric ValueDescription
Report0Item is a report.
Folder1Item is a folder.
Theme2Item is a chart or map theme.
Template3Item is a template file.
All99Reference all content types.

ContentPermission v2020.1–v2021.1

Used in the Storage Management system for v2020.1—v2021.1. Review the Access Flags part of the Permissions section of the Storage Management: Introduction article for more detailed descriptions of each of these access flags and their impact on the user experience. For the ContentPermission enumeration in v2021.1+, see ContentPermission below.

<th

Enum NameDescription
NoneHex: 0x0000
Dec: 0
User has no access to the content.
CanEditHex: 0x0001
Dec: 1
User can edit the content.
CanSaveHex: 0x0002
Dec: 2
User can save the content.
CanRenameHex: 0x0004
Dec: 4
User can rename the content.
CanShareHex: 0x0008
Dec: 8
User can share the content.
CanDeleteHex: 0x0010
Dec: 16
User can delete the content.
CanExecuteHex: 0x0020
Dec: 32
User can delete the content.
CanCopyHex: 0x0040
Dec: 64
User can duplicate the content.
CanDownloadHex: 0x0080
Dec: 128
User can download the content.
CanViewHex: 0x0100
Dec: 256
The content appears in the user’s Report Tree.
FullAccessHex: 0xFFF
Dec: 65535
All access is granted.

ContentPermission v2021.1

The ContentPermission enumeration was updated in v2021.1. Review the Access Flags part of the Permissions section of the Storage Management: Introduction article for more detailed descriptions of each of these access flags and their impact on the user experience.

Tip

To determine the content_access.access_flags value, sum the decimal values of the desired flags from the table below. For example, to only allow renaming and deleting, the value is 20 since 4+16=20.

Enum NameNumeric ValueDescription
NoneHex: 0x0000
Dec: 0
User has no access to the content.
CanEditHex: 0x0001
Dec: 1
User can edit the content.
ReservedHex: 0x0002
Dec: 2
This enum is reserved for future use.
CanRenameHex: 0x0004
Dec: 4
User can rename the content.
CanShareHex: 0x0008
Dec: 8
User can share the content.
CanDeleteHex: 0x0010
Dec: 16
User can delete the content.
ReservedHex: 0x0020
Dec: 32
This enum is reserved for future use.
CanCopyHex: 0x0040
Dec: 64
User can duplicate the content.
ReservedHex: 0x0080
Dec: 128
This enum is reserved for future use.
CanViewHex: 0x0100
Dec: 256
The content appears in the user’s Report Tree.
CanScheduleHex: 0x0200
Dec: 512
The user may schedule or e-mail the report.
CanMoveHex: 0x0400
Dec: 1024
The user may move this item to another folder.
FullAccessHex: 0xFFFF
Dec: 65535
All access is granted.
ReadOnlyHex: 0x0348
Dec: 840
The user may view, copy, schedule it and share the item but nothing else.

Data Source Type

Enum NameNumeric ValueDescription
MsSql0Microsoft SQL Server
MySql1MySQL
ODBC2ODBC
Postgres3PostreSQL
Oracle4Oracle
DB25IBM DB2
Informix6IBM Informix
Assembly7.NET Assembly
WebService8Web Service
File9Excel file
MsOlap10OLAP
Sqlite11SQLite v2021.1.8+

DataType

The DataType enumeration is used in the REST Web Service API when processing data object column metadata and when getting the the value of the EntityColumn.DataTypeEnum property in the .NET API.

Enum NameNumeric ValueDescription
String0String
Date1Date, i.e. day, month, year
DateTime2Date & time
Time3Time, i.e. hour, minute, second (am/pm)
Integer4Integer number
Decimal5Decimal number
Float6Floating-point number
Bit7Bit
Guid8Globally (universally) unique identifier, aka. UUID
Image9Image
Currency10Currency

DataType

The DataType constants are used throughout the application including when defining the return type (the <return_data_type>) of Quick Functions.

Constant NameInteger ValueDescription
StringDataType0A string
DateDataType1A date
IntegerDataType2An integer
OldBitDataType3Deprecated — a single bit. Users should use BitDataType (13) instead
NumericDataType4A number
FloatDataType5A floating point number
DecimalDataType6A decimal number
GuidDataType7Globally (universally) unique identifier, aka. UUID
DateTimeDataType8A DateTime
TimeDataType9Time — this data type is currently not in use in the application
ImageDataType10An binary image
CurrencyDataType11A currency value
AmbiguousFormulaDataType12A formula returns a different data type based on its outcome (e.g. =if(temperature > 98.6, temperature, false)
BooleanDataType13A boolean (true/false) value
BitDataType13A single bit

DataObjectType

Constant NameDescription
Assembly.NET Assembly
FileExcel file
FunctionUser-defined function
ProcedureStored procedure
SqlStmtCustom SQL statement
TableData table
ViewSQL view
WebSvcWeb Service method
MdxStmtOLAP MDX query

DashboardLayoutFit

Enum NameDescription
AllAll tiles are resized horizontally and vertically to fit on the canvas

Same as selecting Scale to Screen in the Dashboard Designer Canvas Format menu
WidthTiles are resized horizontally to fit within a specified canvas width

Same as selecting Specify Height in the Dashboard Designer Canvas Format menu
NoneThe tiles are not resized. The canvas has a specified height and width

Same as selecting Specify Height and Width in the Dashboard Designer Canvas Format menu

wrDockLocation

Used to set the location of the interactive dock in the Report Viewer with the .NET API’s SetupData.General.DockPlacement setting.

Enum NameNumeric ValueDescription
Left0The pane is docked on the left.
Right1The pane is docked on the right.

ExecuteDataType

Used in the REST Web Service API GetExecute() methods to determine how to return the data to the host application.

Enum NameNumeric ValueDescription
Auto0Automatically determine the apprpriate return data action. This is the default if no other value is explicity chosen.
Data1Return a base64 encoded representation of the output file. To display the output data, process the information from the ExecuteData property and send it to the browser. When deploying Exago in a web farm architecture, this is the only acceptable value when using GetExecute() methods.
Url2Return a URL that can be passed back to the browser. The browser can then display or download the resulting file.

ExportFlag v2020.1+

Used in the Storage Management System.

Enum NameNumeric ValueDescription
Default0Use the system default export type.
None0There is no default export type, so revert to the system default.
Html1Run in the browser, using the appropriate viewer.
Pdf2Export as a PDF file.
Rtf4Export as an RTF file.
Csv8Export as a comma-separated value text file.
Excel16Export as a Microsoft Excel workbook.

wrExportType

Enum NameNumeric ValueDescription
Html0Run in the browser, using the appropriate viewer.
Excel1Export as an Excel file.
Pdf2Export as a PDF file.
Rtf3Export as an RTF file.
Csv4Export as a comma-separated value text file.
Word5Export as a Word file.
Default6Default type specified by the loaded report; if not specified, default type specified by the current config.
PdfSnapshot10Export a Dashboard screenshot as a PDF file. See Exporting Dashboards (v2019.2+) for more information.

Filterable Type

Enum NameDescription
AllField supports all filter types
TrueField supports all filter types
NoneField cannot be filtered
FalseField cannot be filtered
DynamicField supports only dynamic (interactive) filters
StaticField supports only static (report) filters

Filter Operator Type

Enum NameNumeric ValueDescription
EqualTo0Data value is equal to the filter value
NotEqualTo1Data value is less than the filter value (number, date)
LessThan2Data value is less than or equal to the filter value (number, date)
LessThanOrEqualTo3Data value is greater than the filter value (number, date)
GreaterThan4Data value is greater than or equal to the filter value (number, date)
GreaterThanOrEqualTo5Data value is not equal to the filter value
StartsWith6Data value starts with the filter value (string, number)
NotStartsWith7Data value does not start with the filter value (string, number)
EndsWith8Data value ends with the filter value (string, number)
NotEndsWith9Data value does not end with the filter value (string, number)
Contains10Data value contains the filter value (string, number)
NotContains11Data value does not contain the filter value (string, number)
Between12Data value is between the two filter values
NotBetween13Data value is not between the two filter values
OneOf14Data value is equal to one of the filter values
NotOneOf15Data value is not equal to any of the filter values

FolderStatus

Enum NameDescription
ExistsThis folder exists
DoesNotExistThis folder does not exist
CreatedThis folder was successfully created
DeletedThis folder was successfully deleted
RenamedThis folder was successfully renamed

<

JobStatus v2019.2+

A read-only property showing the current status of a schedule. Used in REST – Schedules.

Enum NameNumeric ValueDescription
Ready0The schedule will run at its next scheduled run time.
Running1The schedule is currently running and the reports are executing.
Completed2The schedule has completed its final event, and will not run again. It will be removed from the list when the scheduler is flushed.
Suspended3The schedule has been suspended and will not be run again.
Deleted4The schedule has been deleted, and will be removed from the list when the cache is flushed.
Abended5The last run failed due to an error. The schedule will not run again.
UserAbort6Schedule is running, but user has requested to delete it.
Transmitting7Schedule is finished and waiting for data to be transmitted to client for synchronous execution.
Removed8Schedule should be removed if it hasn’t already.
Immediate9As soon as resources are available, the schedule will be run.
Timedout v2019.2.32+v2020.1.15+v2021.1.3+10The job has hit the execution time out set in the Scheduler Service’s configuration file.

Join Type

Enum NameDescription
InnerInner join
LeftOuterLeft outer join
RightOuterRight outer join
FullOuterFull outer join (left outer join + right outer join)

Join Relation Type

Enum NameDescription
OneToOneOne-to-one relationship
OneToManyOne-to-many relationship

Parameter Type

Enum NameNumeric ValueDescription
String0String
Date1Date, i.e. day, month, year
Integer2Integer number
Decimal3Decimal number

QuickFunctionDataType v2021.1+

Used for defining the input type (the <supported_data_types>) of a Quick Function.

Enum NameDescription
DateA Date or DateTime
NumberA numeric value
TextText

wrRowRangeSqlMethod

Used in the dbconfigs.json file. See Managing the dbconfigs.json File.

Enum NameDescription
NoneDisable range limiting SQL.
LimitOffsetSELECT ... LIMIT rangeSize OFFSET offsetRow
OffsetFetchSELECT ... OFFSET offsetRow ROWS FETCH NEXT rangeSize ROWS ONLY
RowNumberWithTopSELECT TOP endingRow ROW_NUMBER() Over(Order By (...)) as wrRowNum ... as wrRowNumbered WHERE wrRowNumbered.wrRowNum BETWEEN startingRow AND endingRowField
RowNumberSELECT ROW_NUMBER() Over(Order By (...)) as wrRowNum ... as wrRowNumbered WHERE wrRowNumbered.wrRowNum BETWEEN startingRow AND endingRowField
RowNumberNoAliasSELECT ROW_NUMBER() Over(Order By (...)) as wrRowNum ... WHERE wrRowNum BETWEEN startingRow AND endingRowField

RecurrenceRange v2019.2+

Determines the ending of a scheduled report recurrence. Used in REST – Schedules.

Enum NameDescription
NoEndDateThis schedule has no end date and will recur indefinitely.
EndAfterNOccurencesThis schedule shall run only for a specified number of instances.
The number of instances is specified in the OccurencesToEnd property.
EndByDateThis schedule shall run until a specified date is reached.
The date is specified in the RangeEndDate property.

RecurrenceType v2019.2+

Determines the frequency of scheduled report recurrence. Used in REST – Schedules.

Enum ValueDescription
OnceThis schedule will only run one time.
DailyThe schedule will repeat every day, every weekday, or every number of days.
WeeklyThe schedule will repeat every week, or every number of weeks, on one or more days
MonthlyThe schedule will repeat every month, or every number of months, on a certain day.
YearlyThe schedule will repeat every year on a certain day.

wrReportType

Enum NameNumeric ValueDescription
Advanced0Advanced Report (CrossTab Reports are also considered Advanced Reports)
Standard0Deprecated: Use Advanced instead.
Express1Express Report
Dashboard2Dashboard
Chained3Chained Report
ExpressView5ExpressView
Folder6Report Folder

ReportValidationErrorType

The types of report validation errors that can happen. Not all validation error types are applicable to all report objects.

Enum Name
SortFormulaSyntaxError
FilterFormulaSyntaxError
DataObjectNotFound
SortDataFieldNotFound
FilterDataFieldNotFound
LinkedDataFieldNotFound
MinMaxFilterDataFieldNotFound
JoinDataObjectNotFound
JoinNotFound
JoinDataFieldNotFound
ChartDataFieldNotFound
MapDataFieldNotFound
CellDataFieldNotFound
RowGroupNameNotFound
RowGroupFormulaNameNotFound
ChartCellIdNotFound
MapCellIdNotFound
MergedCellsAcrossSections
CrossTabIdNotFound
CrossTabCellIdNotFound
ColumnSortByFieldNotFound
ChildReportNotFound
ExpressViewColumnMissingEntity
ExpressViewColumnMissingField
ExpressViewGroupMissingField
ExpressViewFilterMissingField
ExpressViewChartMissingField
EtlReportDesignerModeNotEtl
EtlReportTypeNotAdvanced
EtlDataTypeNotSet
EtlDataTypeNotFound
EtlReportFormatInvalid
EtlCellBlank
EtlHeaderCellValueDuplicate
EtlPossibleDataTypeError
EtlCellSpan
None
ReportParameterNameUsed

ScheduleExportType v2019.2+

The export type for a report run on a schedule. Used in REST – Schedules.

Enum NameDescription
PdfExport as a PDF file.
RtfExport as an RTF file.
ExcelExport as a Microsoft Excel workbook file.
CsvExport as a CSV text file.

ScheduleFilterOperator v2019.2+

Utilized when adding filters to scheduled reports via the REST Web Service API. Used in REST – Schedules.

Enum NameDescription
EqualToEvaluates as true when FilterText is equal to Values, otherwise false.
NotEqualToEvaluates as true when FilterText is not equal to Values, otherwise false.
LessThanEvaluates as true when FilterText is less than Values, otherwise false.
LessThanOrEqualToEvaluates as true when FilterText is less than or equal to Values, othwerwise false.
GreaterThanEvaluates as true when FilterText is greater than Values, otherwise false.
GreaterThanOrEqualToEvaluates as true when FilterText is greater than or equal too Values, otherwise false.
StartsWithEvaluates as true when FilterText starts with Values, otherwise false.
NotStartsWithEvaluates as true when FilterText does not start with Values, otherwise false.
EndsWithEvaluates as true when FilterText ends with Values, otherwise false.
NotEndsWithEvaluates as true when FilterText does not end with Values, otherwise false.
ContainsEvaluates as true when Values is contained within FilterText, otherwise false.
NotContainsEvaluates as true when Values is not contained within FilterText, otherwise false.
BetweenEvaluates as true when FilterText is between two values contained in Values, otherwise false.
NotBetweenEvaluates as true when FilterText is not between two values contained in Values, otherwiese false.
OneOfEvaluates as true when FilterText matches at least one of Values, othwerwise false.
NotOneOfEvaluates as true when FilterText does not match any of Values, otherwise false.

ScheduleJobType v2019.2+

A read-only property that shows the type of job assigned to a schedule. Used in REST – Schedules.

Enum NameDescription
ReportThis job runs a report.
BatchThis job runs a batch report.
EmailThis job handles the disposition of a Report or Batch job by sending the output as an e-mail.
DiskThis job handles the disposition of a Report or Batch job by saving the output to disk.

ScheduleRecurrenceType v2019.2+

A read-only property that shows the type of job recurrence assigned to a schedule. Used in REST – Schedules.

Enum NameDescription
OnceThis schedule only runs once.
DailyThis schedule recurs daily.
WeeklyThis schedule recurs weekly.
MonthlyThis schedule recurs monthly.
YearlyThis schedule recurs yearly.

ScheduleManagerViewLevel

Enum NameNumeric ValueDescription
User1Filter schedules by current UserId parameter
Company2Filter schedules by current CompanyId parameter
All3Show all schedules

TreeShortcut

Used in the Storage Management System.

Enum NameNumeric ValueDescription
Default0The report will take the default action defined in the system’s configuration.
Run1The report will run in the Report Viewer
Export2The report will be exported

wrUserMessageType

Used when Displaying User Messages.

Enum NameNumeric ValueDescription
Id0The user message will display the string associated with the Id in the Language Files.
Text1The user message will display the string message

wrUserPreferenceStorage

Used when setting the User Preference Storage Method setting programatically.

Enum NameNumeric ValueDescription
Cookie0User preferences are stored in the user’s local browser storage.
ExternalInterface1User Preferences are stored and retrieved via an External Interface.

This refers to a deprecated extensibility feature that is no longer supported. It should not be used in new installations.

ServerEvent2User Preferences are stored and retrieved via Server Events.
None3Users cannot modify User Preference features, and the user interface icon is hidden.
Was this article helpful?
0 out of 5 stars
5 Stars 0%
4 Stars 0%
3 Stars 0%
2 Stars 0%
1 Stars 0%
How can we improve this article?
Please submit the reason for your vote so that we can improve the article.
Table of Contents