DataPA OpenAnalytics API Reference
Namespaces
DataPA.Utils.QueryEngine
Application Class
Application.ConnectFailEventHandler Delegate
Application.ContentTypeEnum Enumeration
Application.DataLocationTypeEnum Enumeration
Application.GetExecutablePathEventArgs Class
Application.GetExecutablePathEventEventHandler Delegate
Application.GetLicenceEventArgs Class
Application.GetLicenceEventEventHandler Delegate
Application.HideSplashScreenEventEventHandler Delegate
Application.InitialiseEventTypeEnum Enumeration
Application.RequireCredentialsEventArgs Class
Application.RequireCredentialsEventEventHandler Delegate
Application.SetupChangedEventHandler Delegate
Application.ShowErrorEventArgs Class
Application.ShowErrorEventEventHandler Delegate
Application.ShowMessageEventArgs Class
Application.ShowMessageEventEventHandler Delegate
Application.ShowSplashScreenEventEventHandler Delegate
Application.SplashScreenTextEventArgs Class
Application.SplashScreenTextEventEventHandler Delegate
ApplicationHelper Class
ASM_DISPLAY_FLAGS Enumeration
ASM_NAME Enumeration
AssemblyCache Class
BlendingDetails Class
BlendingDetails._BlendingDetails Interface
BlendingSourceDefinition Class
BlendingSourceDefinition._BlendingSourceDefinition Interface
BlendingSourceDefinition.BlendingSourceRefreshTypeEnum Enumeration
BlendingSourceDefinition.BlendingSourceTypeEnum Enumeration
Condition Class
Conditions Class
Connection Class
Connections Class
DataAvailableEventArgs Class
DataAvailableEventArgs._DataAvailableEventArgs Interface
DateTimeFilterValue Class
DateTimeFilterValue.DateTimeFilterType Enumeration
DateTimeFilterValue.DateTimeFilterValueType Enumeration
ExcelExportProperties Class
ExcelExportProperties.SubTotalDefinition Class
ExcelImportProperties Class
ExcelImportProperties.ColumnTypeEnum Enumeration
Field Class
Field.AnalyticsTypeEnum Enumeration
Field.DateGroupTypeEnum Enumeration
Field.ShowGroupTypeEnum Enumeration
Field.SummaryTypeEnum Enumeration
Fields Class
FunctionParameter Class
FunctionParameters Class
GDC Class
GoogleAnalyticsDetails Class
GoogleAnalyticsDetails._GoogleAnalyticsDetails Interface
GoogleDateParameter Class
GoogleDateParameter._GoogleDateParameter Interface
GoogleDateParameter.GoogleDateParameterValueSourceEnum Enumeration
IAssemblyEnum Interface
IAssemblyName Interface
ImportSubjectArgs Class
ImportSystemArgs Class
LicenseChangedEventArgs Class
LicenseChangedEventArgs._LicenseChangedEventArgs Interface
LicenseInfo Class
LicenseInfo.LicenseChangedEventHandler Delegate
Link Class
Links Class
Lookup Class
Lookups Class
PAConnection Class
PAConnection.AfterConnectEventHandler Delegate
PAConnection.AfterDisconnectEventHandler Delegate
PAConnection.BeforeConnectEventHandler Delegate
PAConnection.BeforeDisconnectEventHandler Delegate
PAConnection.ConnectFailEventHandler Delegate
PasswordHash Class
PublishedContent Class
PublishedContentCollection Class
Queries Class
Query Class
Query.__Query Interface
Query.DataAvailableEventHandler Delegate
Query.ParameterValueRequestEventHandler Delegate
Query.QueryLookup Structure
Query.QueryProgressEventHandler Delegate
Query.QueryTypeEnum Enumeration
Query.SourceDataRequestEventHandler Delegate
Query.SubjectTypeENum Enumeration
QueryCondition Class
QueryConditions Class
QueryDataset Class
QueryDataset._QueryDataset Interface
QueryManager Class
QueryParameter Class
QueryParameters Class
QueryProgressEventArgs Class
QueryProgressEventArgs._QueryProgressEventArgs Interface
QueryRequiredFieldValueRequestEventArgs Class
RunLookup Class
RunLookup.DataBuildCompleteEventHandler Delegate
RunQuery Class
SDC Class
SDC.CloseDataCompleteEventHandler Delegate
SDC.MoveCompleteEventHandler Delegate
SDC.OpenDataCompleteEventHandler Delegate
SecurityInfo Class
ServerUtils Class
SessionLogin Class
SessionLoginCollection Class
SessionManager Class
SessionManager.DataFileFormatEnum Enumeration
SetupEventArgs Class
SetupManager Class
SetupManager.SetupChangedEventHandler Delegate
SignalRMessageEventArgs Class
SourceDataRequestEventArgs Class
SourceDataRequestEventArgs._SourceDataRequestEventArgs Interface
Subject Class
Subject.SubjectTypeEnum Enumeration
Subjects Class
SystemObject Class
SystemObject.SystemType Enumeration
Systems Class
Systems.SQLImportAction Enumeration
SystemStructure Class
SystemStructure.StructureFetchCompletedEventHandler Delegate
SystemStructure.StructureFetchStartedEventHandler Delegate
Table Class
Tables Class
TrendingDetails Class
TrendingDetails.TrendingTopBottomEnum Enumeration
TrendingDetails.TrendingVariableEnum Enumeration
UserDefinedFunction Class
UserDefinedFunctions Class
Click or drag to resize
DataPA.Utils.QueryEngine Namespace DataPA OpenAnalytics
DataPA OpenAnalytics API Reference
Contains all objects to manage and run queries (including the Analytics Engine)
Classes
  Class Description
Public class Application
Public class ApplicationGetExecutablePathEventArgs
Event arguments for GetExecutablePath event.
Public class ApplicationGetLicenceEventArgs
Event arguments for GetLicence event.
Public class ApplicationRequireCredentialsEventArgs
Event arguments for RequireCredentials event.
Public class ApplicationShowErrorEventArgs
Event arguments for ShowError event.
Public class ApplicationShowMessageEventArgs
Event arguments for ShowMessage event.
Public class ApplicationSplashScreenTextEventArgs
Event aurguments for SplashScreenTextEventArgs event.
Public class ApplicationHelper
Public class AssemblyCache
Public class BlendingDetails
Object representing blending details for a query.
Public class BlendingSourceDefinition
Object that defines a source data table for a blending query.
Public class Condition
Public class Conditions
Public class Connection
Public class Connections
Public class DataAvailableEventArgs
Event aurguments for the DataAvailable event.
Public class DateTimeFilterValue
Specifies the date time value to be used in a filter condition.
Public class ExcelExportProperties
Object that describes the export properties required to export an excel worksheet.
Public class ExcelExportPropertiesSubTotalDefinition
Structure to define the group and sum columns for a sub total definition
Public class ExcelImportProperties
Object that describes the import properties required to import an excel worksheet.
Public class Field
Public class Fields
Public class FunctionParameter
Public class FunctionParameters
Public class GDC
Public class GoogleAnalyticsDetails
Object representing a properties for a Google Analytics query.
Public class GoogleDateParameter
Object representing a date parameter for a Google Analytics query.
Public class ImportSubjectArgs
Arguments for ImportSubject method.
Public class ImportSystemArgs
Arguments for ImportSystem method.
Public class LicenseChangedEventArgs
Event aurguments for LicenseChanged event.
Public class LicenseInfo
Class contains information relating to the currently installed or loaded license on the client.
Public class Link
Public class Links
Public class Lookup
Public class Lookups
Public class PAConnection
Public class PasswordHash
Salted password hashing with PBKDF2-SHA1. Author: havoc AT defuse.ca www: http://crackstation.net/hashing-security.htm Compatibility: .NET 3.0 and later.
Public class PublishedContent
Class that represents a published dashboard, report or query on the server.
Public class PublishedContentCollection
Class that represents a collection of published dashboards, reports or queries on the server.
Public class Queries
An enumerated collection of Queries.
Public class Query
Object representing a query.
Public class QueryCondition
Public class QueryConditions
Public class QueryDataset
Public class QueryManager
Public class QueryParameter
Public class QueryParameters
An enumerated collection of QueryParameters.
Public class QueryProgressEventArgs
Event aurguments for the QueryProgress event.
Public class QueryRequiredFieldValueRequestEventArgs
Public class RunLookup
Public class RunQuery
Public class SDC
Public class SecurityInfo
Class provides properties and methods to retrieve security settings from the AppServer or Enterprise Service to be applied to the client.
Public class ServerUtils
Public class SessionLogin
Class that represents a published dashboard, report or query on the server.
Public class SessionLoginCollection
Class that represents a collection of session login relating to this session.
Public class SessionManager
Public class SetupEventArgs
Event aurguments for SetupChanged event.
Public class SetupManager
Class provides access to the setup files that define systems, links, lookups and subjects. The class handles retrieving these files from the AppServer, WebServer, DataPA Enterprise Server or local disk depending on the data location settings. It also handles the writing and transaction locking on these files for each of the different location types.
Public class SignalRMessageEventArgs
Event arguments for MessageReceived event.
Public class SourceDataRequestEventArgs
Event aurguments for the SourceDataRequestEvent event.
Public class Subject
Public class Subjects
Public class SystemObject
Public class Systems
Public class SystemStructure
Class provides access to the structures that make up systems: databases, tables, fields and business logic procedures. The class handles retrieving these structures from the AppServer or Local Cache.
Public class Table
Public class Tables
Public class TrendingDetails
Object representing trending details for a query.
Public class UserDefinedFunction
Public class UserDefinedFunctions
Structures
  Structure Description
Public structure QueryQueryLookup
Enumerated type that cross references query fields and lookups
Interfaces
Delegates
  Delegate Description
Public delegate ApplicationConnectFailEventHandler
Public delegate ApplicationGetExecutablePathEventEventHandler
Public delegate ApplicationGetLicenceEventEventHandler
Public delegate ApplicationHideSplashScreenEventEventHandler
Public delegate ApplicationRequireCredentialsEventEventHandler
Public delegate ApplicationSetupChangedEventHandler
Public delegate ApplicationShowErrorEventEventHandler
Public delegate ApplicationShowMessageEventEventHandler
Public delegate ApplicationShowSplashScreenEventEventHandler
Public delegate ApplicationSplashScreenTextEventEventHandler
Public delegate LicenseInfoLicenseChangedEventHandler
Public delegate PAConnectionAfterConnectEventHandler
Public delegate PAConnectionAfterDisconnectEventHandler
Public delegate PAConnectionBeforeConnectEventHandler
Public delegate PAConnectionBeforeDisconnectEventHandler
Public delegate PAConnectionConnectFailEventHandler
Public delegate QueryDataAvailableEventHandler
Public delegate QueryParameterValueRequestEventHandler
Public delegate QueryQueryProgressEventHandler
Public delegate QuerySourceDataRequestEventHandler
Public delegate RunLookupDataBuildCompleteEventHandler
Public delegate SDCCloseDataCompleteEventHandler
Public delegate SDCMoveCompleteEventHandler
Public delegate SDCOpenDataCompleteEventHandler
Public delegate SetupManagerSetupChangedEventHandler
Public delegate SystemStructureStructureFetchCompletedEventHandler
Public delegate SystemStructureStructureFetchStartedEventHandler
Enumerations
  Enumeration Description
Public enumeration ApplicationContentTypeEnum
The type content
Public enumeration ApplicationDataLocationTypeEnum
The type of data location
Public enumeration ApplicationInitialiseEventTypeEnum
Public enumeration ASM_DISPLAY_FLAGS
Public enumeration ASM_NAME
Public enumeration BlendingSourceDefinitionBlendingSourceRefreshTypeEnum
Enumerated type that describes when the source data table will be refreshed
Public enumeration BlendingSourceDefinitionBlendingSourceTypeEnum
Enumerated type that describes how the source data table will be derived
Public enumeration DateTimeFilterValueDateTimeFilterType
Types of date time filters.
Public enumeration DateTimeFilterValueDateTimeFilterValueType
Types of date time filter values.
Public enumeration ExcelImportPropertiesColumnTypeEnum
Enumerated type that defines the type of each column
Public enumeration FieldAnalyticsTypeEnum
Enumerated type that determines the analytics type of this field
Public enumeration FieldDateGroupTypeEnum
Date display type.
Public enumeration FieldShowGroupTypeEnum
Type of grouping.
Public enumeration FieldSummaryTypeEnum
Enumerated type that expresses whether a column is used to group by, or how its summary value is calculated
Public enumeration GoogleDateParameterGoogleDateParameterValueSourceEnum
Enumerated type that determines how the date value will be derived
Public enumeration QueryQueryTypeEnum
Enumerated type that indicates the type of query
Public enumeration QuerySubjectTypeENum
Enumerated type that defines the type of Subject the query uses
Public enumeration SessionManagerDataFileFormatEnum
Data file format
Public enumeration SubjectSubjectTypeEnum
Enumerated type that expresses the type of query
Public enumeration SystemObjectSystemType
System type enumerator
Public enumeration SystemsSQLImportAction
System type enumerator
Public enumeration TrendingDetailsTrendingTopBottomEnum
Enumerated type that expresses whether top or bottom percentage or items is used to calculate which trending groups to include
Public enumeration TrendingDetailsTrendingVariableEnum
Enumerated type that expresses the method used to calculate which trending groups to include