Home > Class Reference > %SYS namespace > %Archive.Session


class %Archive.Session extends %Library.RegisteredObject

API for data archiving

Sample script that initiates a connection to an archive server

     Set SessionOref = ##class(%Archive.Session).%New() 
     Set SessionOref.Host = // IP address of the archive server 
     Set SessionOref.AuthFile = AuthFilePath // path of the .pea file (for Centera) 
     Set Status = SessionOref.Connect() 
Once connected, here is a sample script that stores a content (cf. %Archive.Content):
     // create a content object as source, whose handle is ContentOref (see %Archive.Content)
     Set Status = SessionOref.Store(ContentOref, .ContentUID) 
After Store() returns successfully, you need to save the ContentUID value somewhere (say, in a database) for future retrieval purpose.
Here is a sample script to retrieve the file from the archive server, using the ContentUID and open connection above:
     // create a content object as target, whose handle is ContentOref (see %Archive.Content)
     Set Status = SessionOref.Retrieve(ContentOref, ContentUID) 

Property Inventory

Method Inventory


parameter TYPE = Centera;
Type of the archive system (EMC Centera)
parameter VERSION = 0.1;
Version of the API


property ApplicationName as %String;
Name of the application, default to something like "Cache for Windows (x86-32)" (from $zv)
Property methods: ApplicationNameDisplayToLogical(), ApplicationNameGet(), ApplicationNameIsValid(), ApplicationNameLogicalToDisplay(), ApplicationNameLogicalToOdbc(), ApplicationNameNormalize(), ApplicationNameSet()
property ApplicationVersion as %String;
Version of the application, default to something like "2008.2 (Build 366U)" (from $zv)
Property methods: ApplicationVersionDisplayToLogical(), ApplicationVersionGet(), ApplicationVersionIsValid(), ApplicationVersionLogicalToDisplay(), ApplicationVersionLogicalToOdbc(), ApplicationVersionNormalize(), ApplicationVersionSet()
property AuthFile as %String;
The path of a Pool Entry Authorization file (*.pea)
Property methods: AuthFileDisplayToLogical(), AuthFileGet(), AuthFileIsValid(), AuthFileLogicalToDisplay(), AuthFileLogicalToOdbc(), AuthFileNormalize(), AuthFileSet()
property Host as %String;
Connection information, a comma-delimited list of IP addresses
For example, ","
Property methods: HostDisplayToLogical(), HostGet(), HostIsValid(), HostLogicalToDisplay(), HostLogicalToOdbc(), HostNormalize(), HostSet()
property Password as %String;
Property methods: PasswordDisplayToLogical(), PasswordGet(), PasswordIsValid(), PasswordLogicalToDisplay(), PasswordLogicalToOdbc(), PasswordNormalize(), PasswordSet()
property UserName as %Library.Username;
An alternative to a PEA file is a pair of UserName and Password
Property methods: UserNameDisplayToLogical(), UserNameGet(), UserNameIsValid(), UserNameLogicalToDisplay(), UserNameLogicalToOdbc(), UserNameNormalize(), UserNameSet()


method AccessContent(ContentUID As %String) as %Status [ Language = objectscript ]
Test the existence of a content (C-Clip) by its UID (ContentAddress)
method Connect() as %Status [ Language = objectscript ]
Connect to the server
method DeleteContent(ContentUID As %String) as %Status [ Language = objectscript ]
Delete a content (C-Clip) by its UID (ContentAddress)
method Disconnect() as %Status [ Language = objectscript ]
Disconnect from the server
method Retrieve(ContentOref As %Archive.Content, ContentUID As %String) as %Status [ Language = objectscript ]
Retrieve an entire content from server
method Store(ContentOref As %Archive.Content, ByRef ContentUID As %String) as %Status [ Language = objectscript ]
Store an entire content to server, commit and return a UID by reference

Inherited Members

Inherited Methods