Click or drag to resize
SystemStructure Class DataPA OpenAnalytics
DataPA OpenAnalytics API Reference
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.
Inheritance Hierarchy
SystemObject
  DataPA.Utils.QueryEngineSystemStructure

Namespace: DataPA.Utils.QueryEngine
Assembly: DataPAQueryEngine (in DataPAQueryEngine.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
Copy
public class SystemStructure

The SystemStructure type exposes the following members.

Constructors
  NameDescription
Public methodSystemStructure
Constructor, set system handles.
Top
Methods
  NameDescription
Public methodLoadStructure
Decide whether to load from cache or hit the AppServer, then do it.
Public methodResetFailedConnections
Top
Properties
  NameDescription
Public propertyConnectError
If ConnectSuccess = False, the Error Message returned by the connection attempt.
Public propertyConnectionName
The connection to be used for retrieving the structure.
Public propertyConnectSuccess
TRUE indicates the last connection attempt to the AppServer was successful.
Public propertyDataBase
DataTable detailing the databases of the current system.
Public propertyDbField
DataTable detailing the database fields of the current system.
Public propertyDbIdxField
DataTable detailing the database index fields of the current system.
Public propertyDbIndex
DataTable detailing the database indices of the current system.
Public propertyDbTable
DataTable detailing the database tables of the current system.
Public propertyForceReload
If TRUE the next GET of structure will reload from the AppServer, rather than the local cache.
Public propertyFullStructure
DataSet containing database schema and available business logic functions of the current System.
Public propertyFunctions
DataTable detailing the Business Logic Functions available in the current System.
Public propertyLastLoadError
If last load failed, the Error Message.
Public propertyLastLoadFromCache
Indicates whether the previous load was from cache or system connection
Public propertyLastRefresh
The modified date of the Schema Cache file
Public propertyPAConnection
The RunDataPA Connection Object used to retreive the system structure
Public propertyRelation
DataTable detailing the Database Relations in the current System.
Public propertyStructureAvailable
Indicates whether the structure was successfully loaded
Public propertySystemName
The system's name whose structure this class will return.
Public propertySystemType
The type of system whose structure this class will return.
Top
Events
Remarks