This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?


class %CSP.UI.Portal.DatabaseFreespaceCompact extends %CSP.UI.Portal.Template

Zen page for System Management Portal - Show Databases Freespace

Property Inventory

Method Inventory


parameter AUTONS = 0;
Do not switch namespace for this page: it needs to stay in %SYS
parameter CSPURL = /csp/sys/op/%CSP.UI.Portal.DatabaseFreespaceCompact.zen;
Inherited description: This parameter is used to make sure that if multiple CSP applications are mapped to the same namespace that the CSP engine can correctly identify which class corresponds with which URL. If 'LockCSPName' is true (the default, defined in the CSP application) then you can only access this page if the url exactly matches this 'CSPURL'. You can set this parameter to "" if you wish to disable this check for this class. This check is applied for all CSP urls (cls/csp/zen).
If this page was compiled from a .csp file, then this parameter is automatically set to contain the url of this file used for compilation.
parameter HELPADDRESS = Home,Databases,Freespace,Compact;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter PAGENAME = Cleanup;
Displayed name of this page.
parameter PARENTPAGE = /csp/sys/op/%CSP.UI.Portal.DatabaseFreespace.zen;
Inherited description: This parameter defines the parent page for this page.
If the name ends in .csp, then the parent is assumed to be an autopage-enabled CSP page.
If the name ends in .cls, then the parent is assumed to be a Zen page.
This is used to automate the construction of the locator bar for this page and to build the index between portal pages and documentation.
The %GetLocatorInfo method is used to get this information.
parameter RECENT = 0;
Inherited description: If true, register visits to this page in the recent list.
parameter RESOURCE = %Admin_Operate;
Security requirement


property Directory as %String (ZENURL = "Directory");
DBDirectory passed in.
Property methods: DirectoryDisplayToLogical(), DirectoryGet(), DirectoryIsValid(), DirectoryLogicalToDisplay(), DirectoryLogicalToOdbc(), DirectoryNormalize(), DirectorySet()
property EndFree as %Integer;
Amount free at end
Property methods: EndFreeDisplayToLogical(), EndFreeGet(), EndFreeIsValid(), EndFreeLogicalToDisplay(), EndFreeNormalize(), EndFreeSet(), EndFreeXSDToLogical()
property FreeSpace as %String;
Total available freespace.
Property methods: FreeSpaceDisplayToLogical(), FreeSpaceGet(), FreeSpaceIsValid(), FreeSpaceLogicalToDisplay(), FreeSpaceLogicalToOdbc(), FreeSpaceNormalize(), FreeSpaceSet()
property PID as %String (ZENURL = "DBName");
ID for edit. DBName for this page.
Property methods: PIDDisplayToLogical(), PIDGet(), PIDIsValid(), PIDLogicalToDisplay(), PIDLogicalToOdbc(), PIDNormalize(), PIDSet()


Return the array of links to show in the locator bar.
method %OnAfterCreatePage() as %Status
Inherited description: Be sure to do ##super() when overriding.
method %OnGetPageName() as %String
Inherited description: Get the (localized) name of the page. This should be implemented in a subclass.
method %OnGetTitle() as %String
Get the (localized) title string for the page.
method DrawAbortError(seed As %String) as %Status
method DrawResult(seed As %String) as %Status
Actually write out result. When the page is first opened, seed is null. When it's called from Prepare, seed = action^the selected locale.
classmethod GetFreeSpace(Directory As %String, Output FreeSpace As %Integer, Output EndFree As %Integer, Output CurrSize As %Integer) as %String
Return available FreeSpace
classmethod StartCompact(DBName, Directory, Target) as %String [ ZenMethod ]
Start background job to compact a selected directory
clientmethod doFinish(isFinish) [ Language = javascript ]
User clicked "OK" to cleanup. Call server method to job off in the background.
clientmethod validate(target, sizemin, sizemax) as %Boolean [ Language = javascript ]
Make sure that the Target size is smaller than that of the current available freespace

Inherited Members

Inherited Properties

Inherited Methods