Click or drag to resize
Application Class DataPA OpenAnalytics
DataPA OpenAnalytics API Reference
Inheritance Hierarchy
SystemObject
  DataPA.Utils.QueryEngineApplication

Namespace: DataPA.Utils.QueryEngine
Assembly: DataPAQueryEngine (in DataPAQueryEngine.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
[SerializableAttribute]
public class Application : _Application

The Application type exposes the following members.

Constructors
  NameDescription
Public methodApplication
Initializes a new instance of the Application class
Public methodApplication(DataSet)
Initializes a new instance of the Application class
Top
Methods
  NameDescription
Public methodApplyAppServerFilterSystems
Public methodClearTempLocalFiles
Public methodConnectToDataLocationAppServer
Public methodEntSrv
Returns the EnterpriseServiceClient object this object uses to communicate with the server.
Public methodGetAuthToken
Public methodGetEnterpriseServiceClient
Get an instance of the EnterpriseService, using the currently authenticated token, AuthToken
Public methodStatic memberGetUserPrincipalName
Saearches LDAP for the User Principal name using the given name (e.g. searching 'paul' would return paul@datapa.local)
Public methodHandleAuthorisationFault
Handle an auhtorisation fault from the Enterprise Service by showing the login prompt and getting a new Auth Token
Public methodInitialise
Initialises the object.
Public methodInitialise(String, SessionManagerDataFileFormatEnum, Boolean)
Initialises the object.
Public methodInitialiseFromAppServer
Public methodInitialiseFromServer
Public methodStatic memberNumericTypeStringToObject
Returns a type object for a given type string
Public methodOpenQuery
Opens and return a query object from a file
Public methodOpenServerSetup
Public methodPublishDocument
Public methodRaiseConnectFail
Public methodRaiseEventRequireCredentials
Public methodRaiseShowErrorEvent
Public methodReloadSetup
Refreshes the setup files.
Public methodSecurityCode
Public methodServerSecurity
Gets the server security object.
Public methodSQLClient
Returns the SQL Client object used to run SQL queries.
Public methodSystemType
Public methodTmpDir
Public methodUpdateDataSet
Top
Fields
Properties
  NameDescription
Public propertyAppServerValidationFailed
Gets or sets a value that indicate if validation on the security appserver failed.
Public propertyAuthToken
Details of the token used to authenticate with the Enterprise Service
Public propertyConnection
Public propertyDataFileFormat
Gets and sets a value that indicates the file format used to store the setup.
Public propertyDataLocation
Gets and sets the data location
Public propertyDataLocationType
Gets a value that indicates what type of data location is currently set.
Public propertyDPALogging
Public propertyEnterpriseServiceEndpoint
Public propertyEnterpriseServiceHubPort
Gets a value that indicates the port being used to commincate with the Enteprise Service SignalR Hub.
Public propertyGroup
Gets the unique ID of the users group.
Public propertyInitialised
Gets a property that indicates if this clientconfig has been successfully initialised.
Public propertyLicenseInfo
Gets and sets the LicenseInfo object for this object.
Public propertyLockServerCode
Gets or sets the encrypted lockserver code.
Public propertyMaxJSONLength
Gets a value that indicates the maximum JSON document size permitted.
Public propertyStatic memberNumericTypeStrings
Gets a list of strings that identifies the types that will be treated as numeric
Public propertyObjectOnlyDataFileFormat
Gets and sets the object data file format
Public propertyObjectOnlyDataLocation
Gets and sets the object only data location
Public propertyPassword
Gets and sets the password the user has logged in with.
Public propertyPreviousLoginFailed
Gets and sets a value that indicates if the previous login attempt failed.
Public propertyRootObject
Gets and sets the root object used to provide AppServer connectivity to download dat files etc.
Public propertySchedulerClient
Gets and sets a property that indicates if the client should be checking for scheduler licenses rather than standard.
Public propertySecurity
Gets and sets the Security object for this object.
Public propertySecurityGUID
Gets a value that indicate the security GUID used to tell when the server security object on the server has changed.
Public propertySessionFreeDataLocationAppServer
Gets and sets a value that indicates if the Data Location AppServer is a session free AppServer
Public propertySessionLogins
Public propertySetupGUID
Gets a value that indicate the setup GUID used to tell when the setup on the server has changed.
Public propertySetupManager
Gets and sets a setup manager object for this objects.
Public propertySystemStructure
Gets a System Structure (DBs, Tables, Fields, Functions etc.) Object
Public propertyUsePreviousUsernameAndPasswordSet
Gets and sets a value that indicates if the previously used username and password should be used rather than prompting again.
Public propertyUserName
Gets and sets the username the user has logged in with.
Public propertyVersion
Gets the version of DataPA currently installed.
Top
Events
  NameDescription
Public eventConnectFail
Event raised when a connect error occurs
Public eventGetExecutablePathEvent
Event raised when the calling executable path is required
Public eventGetLicenceEvent
Event raised when a licence is required
Public eventHideSplashScreenEvent
Event raised when splash screen should be hidden
Public eventRequireCredentialsEvent
Event raised when login credentials required
Public eventSetupChanged
Event raised when some action changes the setup
Public eventShowErrorEvent
Event raised when an error should be shown
Public eventShowMessageEvent
Event raised a message should be shown
Public eventShowSplashScreenEvent
Event raised when splash screen should be shown
Public eventSplashScreenTextEvent
Event raised when some splash screen is read or needs set
Top
See Also