DataPA Enterprise Dashboard Controls API Reference 
        
        
          
            
        
          
            
        
        
          
            
        
          
            
        
        
          
            
        
          
            
        
        
          
            
        
          
            
        
        
          
            
        
      
      
    The ServerSecurity type exposes the following members.
          
             Constructors
Constructors
        
        | Name | Description | |
|---|---|---|
|   | ServerSecurity()()()() | 
 Creates and returns a new ServerSecurity object.
  | 
|   | ServerSecurity(Boolean) | 
 Creates and returns a new ServerSecurity object.
  | 
          
             Methods
Methods
        
        | Name | Description | |
|---|---|---|
|   | ApplyEnterpriseLicense | 
 Applies an Enterprise licence to the server.
  | 
|   | GenerateSetupGUID | 
 Generates a new Setup GUID. Called when the setup is changed.
  | 
|   | GetAgent | 
 Gets a DataPA Enterprise Agent.
  | 
|   | GetObjectData | |
|   | ReleaseAgent | 
 Releases the DataPA Enterprise Agent.
  | 
|   | SetObjectData | 
          
             Fields
Fields
        
        | Name | Description | |
|---|---|---|
|     | ClassId | |
|     | EventsId | |
|     | InitialDefaultHomePage | |
|     | InterfaceId | 
          
             Properties
Properties
        
        | Name | Description | |
|---|---|---|
|   | AdditionalHeaderText | 
 Gets and sets additional text that will be added to each page in the DataPA Enterprise Web application.
  | 
|   | AgentLogging | 
 Gets and sets a value that indicates whether Agent logging is enabled.
  | 
|   | AgentRetryInterval | 
 Gets and sets a value that indicates the number of seconds to wait before retrying an agent loack after it has failed.
  | 
|   | AlertImagePath | 
 Gets and sets the folder which the alert images will be stored in 
  | 
|   | AllowAnonymousWebAccess | 
 Gets and sets a property that indicates if this implementation of DataPA Enterprise allows anonymous web access.
  | 
|   | AllowPersonalHomePage | 
 Gets and sets a property that indicates if users are allowed to set their own home page.
  | 
|   | AppendToLogFile | 
 Gets and sets a property to indicate if the log file shown be appended to.
  | 
|   | ApplyUserSecurity | 
 Gets and sets a value that indicates if user security should be applied to this server.
  | 
|   | AutoRefreshInWeb | 
 Gets and sets a property that indicates if dashboards will be automatically refreshed in a web page when refreshed by the server.
  | 
|   | AutoRefreshRetry | 
 Gets and sets the interval that a web page waits between repeated attempts to refresh a dashboard.
  | 
|   | BackupOnSave | 
 Gets and sets a property to indicate if the service will take a backup copy of the security settings and setup files before each save operation.
  | 
|   | BLToAssignGroupPrivileges | 
 Gets and sets a value that indicates if a business logic routine on the server should be used to assign privileges to groups.
  | 
|   | BLToAssignUserGroups | 
 Gets and sets a value that indicates if a business logic routine on the appserver should be used to assign users to groups.
  | 
|   | BLToDefineGroups | 
 Gets and sets a value that indicates if a business logic routine on the server should be used to define groups.
  | 
|   | BLToFilterConnections | 
 Gets and sets a value that indicates if a business logic routine on the appserver should be used to filter the connections available to a user.
  | 
|   | BLToFilterSubjects | 
 Gets and sets a value that indicates if a business logic routine on the appserver should be used to filter the subjects available to a user.
  | 
|   | Categories | 
 Gets and sets the CategoriesCollection that represents the categories defined for this server.
  | 
|   | Clone | 
 Gets a clone of this object.
  | 
|   | CollaborationLogging | 
 Gets and sets a value that indicates whether Collaboration logging is enabled.
  | 
|   | ContentBarTitle | 
 Gets and sets a property that determines the string used to identify the settings bar in the DataPA Enterprise Web page.
  | 
|   | DashboardObjectJsonMaxSize | 
 Gets and sets a property that indicates the maximum data size in kilobytes of a dashboard object.
 This limit exists to prevent data that is too large affecting performance and security.
  | 
|   | DashboardStyle | 
 Gets and sets a value that indicates the dashboard style to be used when rendering dashboards in the web
  | 
|   | DaysToKeepAlertImages | 
 Gets and sets a property that indicates how many days to keep alert images for before they are deleted.
  | 
|   | DefaultHomePage | 
 Gets and sets a property that indicates the dafault home page for the web interface.
  | 
|   | DefaultHostURL | 
 Gets and sets a host URL used for links in alerts
  | 
|   | DocumentFileStorePath | 
 Gets and sets the folder which the document files will be stored in 
  | 
|   | EmailErrors | 
 Gets and sets a value that indicates whether users should be alerted of errors via email.
  | 
|   | EnterpriseDataFileFormat | 
 Gets and sets a property that indicates the Enterprise Data Location File Format.
  | 
|   | EnterpriseDataLocationType | 
 Gets and sets a property that indicates the Enterprise Data Location Type.
  | 
|   | EnterpriseExpiryDate | 
 Gets the Enterprise License Expiry Date that has been applied to this server.
  | 
|   | EnterpriseLicenseType | 
 Gets a value that indicates the type of the Enterprise license that has been installed on this server.
  | 
|   | EnterpriseLicenseValid | 
 Gets a value that indicates if a valid Enterprise license has been installed on this server.
  | 
|   | EnterpriseNumAgents | 
 Gets the number of Enterprise License Agents that are licensed on this server.
  | 
|   | EnterpriseSerialNum | 
 Gets the Enterprise Serial Number that has been applied to this server.
  | 
|   | ErrorFromDisplayName | 
 Gets and sets the email display name that error emails will be sent to when an error occurs
  | 
|   | ErrorFromEmail | 
 Gets and sets the email address that error emails will be sent to when an error occurs
  | 
|   | ErrorToEmail | 
 Gets and sets the email address that will be used to send emails sent when an error occurs
  | 
|   | Groups | 
 Gets and sets the GroupsCollection that represents the groups for the server.
  | 
|   | GUID | 
 Gets and sets a GUID that uniquely identifies this object.
  | 
|   | ID | 
 Gets a value that indicates the Unique ID of this object.
  | 
|   | InfoFileStorePath | 
 Gets and sets the folder which the information store file will be stored in 
  | 
|   | LogFileThresholdSize | 
 Gets and sets the size in bytes that will be the log file threshold.
  | 
|   | LoggingCategories | 
 Gets and sets the logging categories setting.
  | 
|   | LoggingMethods | 
 Gets and sets the logging methods setting.
  | 
|   | LoggingTypes | 
 Gets and sets the logging types setting.
  | 
|   | MaxDashboardsinMemory | 
 Gets and sets the maximum number of Dashboards that can be loaded into memory as objects which can then refresh themselves at the intervals set.
  | 
|   | MaxDashboardsinMMF | 
 Gets and sets the maximum number of Dashboards that can be loaded into memory as memory mapped files.
  | 
|   | MaxInfoFileSize | 
 Gets and sets the maximum size in bytes that will be allocated in memory for the info file that contains details of the published content. This is stored as a Memory Mapped File and size needs to be pre allocated.
  | 
|   | MaxNumLogFiles | 
 Gets and sets the maximum number of log files that should be created.
  | 
|   | MaxUserDirSize | 
 Gets and sets the maximum size in bytes that will be allocated to each users for report and query results.
  | 
|   | MMFInactiveTimeout | 
 Gets and sets the number of seconds after which inactive Dashboards will be unloaded from their memory mapped file.
  | 
|   | PageTitle | 
 Gets and sets a string that determines the page header for the DataPA Enterprise Web page.
  | 
|   | SecurityAppServer | 
 Gets and sets the security AppServer URL.
  | 
|   | SecurityFileStorePath | 
 Gets and sets the folder which the security store file will be stored in 
  | 
|   | ServerID | 
 Gets a unique identifer for this server
  | 
|   | ServerLockCode | 
 Gets and sets the server lock code
  | 
|   | ServerPassword | 
 Gets and sets the Password used by the service when connecting to an AppServer to refresh a query set to auto refresh.
  | 
|   | ServerUserName | 
 Gets and sets the username used by the service when connecting to an AppServer to refresh a query set to auto refresh.
  | 
|   | SessionFreeEnterpriseDataLocationAppServer | 
 Gets and sets a property that indicates if the Enterprise Data Location AppServer used operates session free.
  | 
|   | SettingsBarTitle | 
 Gets and sets a property that determines the string used to identify the contents bar in the DataPA Enterprise Web page.
  | 
|   | SetupCRC | 
 Gets a value that identifies the last saved time and size for the setup files.
  | 
|   | SetupFileStorePath | 
 Gets and sets the folder which the setup files will be stored in 
  | 
|   | SetupGUID | 
 Gets a value that is a unique identifier that changes each time the setup stored on the server changes.
  | 
|   | ShowSignInWhenGuest | 
 Gets and sets a property that indicates if the sign in buttons are shown when a user is logged into the web site as a guest. 
  | 
|   | SMTPAuthenticate | 
 Gets and sets a value that indicates whether authentication is required for the SMTP server.
  | 
|   | SMTPPassword | 
 Gets and sets the password to be used when authenticating the SMTP Server.
  | 
|   | SMTPServer | 
 Gets and sets the SMTP Server which will be used to send email 
  | 
|   | SMTPServerPort | 
 Gets and sets the SMTP Server Port Number which will be used to send email 
  | 
|   | SMTPSSL | 
 Gets and sets a value that indicates whether SSL should be used for communication with the SMTP server.
  | 
|   | SMTPUserName | 
 Gets and sets the username to be used when authenticating the SMTP Server.
  | 
|   | StartAutoRefreshDelay | 
 Gets and sets a value that indicates the number of seconds to wait before starting the auto refresh of Dashboards after the DataPA Enterprise Service has started.
  | 
|   | StateFreeSecurityAppServer | 
 Gets and sets a value that indicates if the security appserver is state free.
  | 
|   | SuspendAutoRefresh | 
 Gets and sets a property that indicates if the auto refreshing of dashboards should be suspended.
  | 
|   | TreeViewNodeClickDelay | 
 Gets and sets a value that indicates the number of milliseconds delay between a user clicking on a treeview node and the request being processed.
  | 
|   | TwitterAccounts | 
 Gets and sets the TwitterAccounts object that defines twitter accounts this server can post to.
  | 
|   | UserAgentRetry | 
 Gets and sets a value that indicates the number times to retry the getting of an agent lock for a user request.
  | 
|   | UserAgentRetryInterval | 
 Gets and sets a value that indicates the number of milliseconds to wait before retrying an agent lock from a user request after it has failed.
  | 
|   | Users | 
 Gets and sets the UsersCollection object that represents the users that have access to this server.
  | 
|   | UseSecurityAppServer | 
 Gets and sets a value that indicates whether the server uses an AppServer to validate users.
  | 
|   | UseSSL | 
 Gets and sets a property to indicate if SSL should be used with the mobile apps.
  | 
 
     
     
     
     
     
           
          