Click or drag to resize
ClientConfig Methods DataPA OpenAnalytics
DataPA OpenAnalytics API Reference

The ClientConfig type exposes the following members.

Methods
  Name Description
Public method CheckForUpdate
Public method Dispose
Disposes of the object
Public method EntSrv
Returns the EnterpriseServiceClient object this object uses to communicate with the server.
Public method GetAuthToken
Public method GetPublishedContent
Gets a PublishedContentCollection object representing the published content for a particular category.
Public method GetServerSecurityManifest
Gets a ServerSecurity Manifest object.
Public method GetUserNameAndPassword
Prompts the user for a username and password, updating the username and password properties.
Public method HandleAuthorisationFault
Handle an auhtorisation fault from the Enterprise Service by showing the login prompt and getting a new Auth Token
Public method HideSplashScreen
Hides the splash screen.
Public method ImportPAXFile
Shows the Import Export wizard for a given import file
Public method Initialise
Initialises the object.
Public method Initialise(String, SessionManagerDataFileFormatEnum, Boolean, Boolean)
Initialises the object.
Public method IsServerSecurityLockValid
Returns a value that indicates if the Server Security is locked by the current user.
Public method IsSetupLockValid
Returns a value that indicates if the setup files are locked by the current user.
Public method LockServerSecurityData
Attempts to lock the Server Security for editing.
Public method LockSetupData
Attempts to lock the setup files for editing.
Public method PubEntSrv
Returns the EnterpriseServiceClient object this object uses to communicate with the server for the purposes of publishing.
Public method PublishDocument
Publishes a Document (Report or Query) to DataPA Enterprise.
Public method ReloadSetup
Refreshes the setup files.
Public method RestoreSplashScreen
Shows the splash screen if it was hidden with allow restore set to true.
Public method RunQuery
Public method SaveServerSecurity
Saves any changes to the server security object back to the server
Public method SaveSetupData
Public method Search
Prompts user for search text
Public method SearchAndReplace
Prompts user for search and replace text
Public method ServerSecurity
Gets the server security object.
Public method SetCustomLoadingImageFromFile
Loads a custom loading image for this client session from a file on disk
Public method ShowAbout
Public method ShowChangePassword
Public method ShowLicenseWindow
Public method ShowManagePublished
Public method ShowManageServer
Shows the manage server screen
Public method ShowManageServer(String)
Shoes the manage server screen
Public method ShowOpenFromServer
Public method ShowProperties
Shows the properties screen
Public method ShowQueryString
Shows a dialog with the query string that will be executed on the server for a given query
Public method ShowQueryWizard
Public method ShowRunQueryWizardToCollectParametersOnly
Shows the run query wizard to collect parameter values
Public method ShowSecurity
Shows the security screen
Public method ShowSelectConnection
Public method ShowSelectConnection(String)
Public method ShowSetup
Shows the setup screen
Public method ShowSplashScreen
Shows the splash screen.
Public method ShowSubjectExplorer
Public method SQLClient
Returns the SQL Client object used to run SQL queries.
Public method SystemType
Public method TmpDir
Public method UnLockServerSecurityData
Attempts to unlock the Server Security.
Public method UnLockSetupData
Attempts to unlock the setup files.
Public method UseNewSetUp
Public method ViewData
Top
See Also