Proficy Historian Client Access API
Proficy.Historian.ClientAccess.API Namespace / IArchives Interface
Methods Events

In This Topic
    IArchives Interface Members
    In This Topic

    The following tables list the members exposed by IArchives.

    Public Methods
     NameDescription
     Method Add an archive to a Historian server. An archive may be newly created by the server or an existing, previously removed archive file.  
     Method Request a backup of an archive from a Historian server.  
     Method Create a backup of the configuration.  
     Method Close the current archive. Normally a Historian server automatically closes the current archive when it becomes full. This method allows manual control over the amount of data in the current archive.  
     Method Drop all the archive subscriptions.  
     Method Retrieve all properties for the archive of the given name. Archives are uniquely identified by name.  
     Method Retrieve archive statistics from a Historian server.  
     MethodRetrieve a list of archives in a Historian server matching an archive name wildcard expression.

    For large servers clients can optionally rely on large message sizes or result-paging or a combination of both to retrieve properties for a large number of archives. Maximum message size is straight-forward and controlled by ConnectionProperties.MaxReceivedMessageSize - it must be matched on both client and server.

    Result-paging enables large result sets to be retrieved across multiple server requests with timing and size controlled by the client. The number of results retrieved per request is controlled via the query's PageSize property. To utilize result-paging, specify a non-zero PageSize and continue calling the same query while the return code is true to retrieve all results from a server. To protect the server and limit excessive server-memory utilization initiating a second query without first retrieving all results for a first query generates a fault.

     
     Method Remove an archive from a server for off-line storage. The archive contents become unavailable for query.  
     Method Set the properties of an archive in a Historian server. Archives are uniquely identifed by name.  
     MethodSubscribe to archive changes in a Historian server such as: load, remove, modify or backup. Fires %% with details of the archive change.  
     Method Clear any established archive subscriptions.  
    Top
    Public Events
     NameDescription
     Event Occurs in response to archive subscriptions when an archive has been added, deleted or modified.  
    Top
    See Also