This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > SYS.WSMon.wsSystem


class SYS.WSMon.wsSystem extends SYS.WSMon.wsResource

General information about a Cache instance.

Property Inventory

Method Inventory


property ConfigFile as %String;
The path and file name of the current configuration file used by this Cache instance.
Property methods: ConfigFileDisplayToLogical(), ConfigFileGet(), ConfigFileIsValid(), ConfigFileLogicalToDisplay(), ConfigFileLogicalToOdbc(), ConfigFileNormalize(), ConfigFileSet()
property CurrentUsers as %String;
The number of current users on this Cache instance.
Property methods: CurrentUsersDisplayToLogical(), CurrentUsersGet(), CurrentUsersIsValid(), CurrentUsersLogicalToDisplay(), CurrentUsersLogicalToOdbc(), CurrentUsersNormalize(), CurrentUsersSet()
property DatabaseCache as %Integer;
The size of the database cache in MB for this Cache instance.
Property methods: DatabaseCacheDisplayToLogical(), DatabaseCacheGet(), DatabaseCacheIsValid(), DatabaseCacheLogicalToDisplay(), DatabaseCacheNormalize(), DatabaseCacheSet(), DatabaseCacheXSDToLogical()
property Directory as %String;
The path for the directory where this Cache instance is installed.
Property methods: DirectoryDisplayToLogical(), DirectoryGet(), DirectoryIsValid(), DirectoryLogicalToDisplay(), DirectoryLogicalToOdbc(), DirectoryNormalize(), DirectorySet()
property LicenseAvailable as %Integer;
The current number of licenses available on this Cache instance.
Property methods: LicenseAvailableDisplayToLogical(), LicenseAvailableGet(), LicenseAvailableIsValid(), LicenseAvailableLogicalToDisplay(), LicenseAvailableNormalize(), LicenseAvailableSet(), LicenseAvailableXSDToLogical()
property LicenseHigh as %Integer;
The high-water mark for licenses used on this Cache instance.
Property methods: LicenseHighDisplayToLogical(), LicenseHighGet(), LicenseHighIsValid(), LicenseHighLogicalToDisplay(), LicenseHighNormalize(), LicenseHighSet(), LicenseHighXSDToLogical()
property LicenseUsed as %Integer;
The current number of licenses used on this Cache instance.
Property methods: LicenseUsedDisplayToLogical(), LicenseUsedGet(), LicenseUsedIsValid(), LicenseUsedLogicalToDisplay(), LicenseUsedNormalize(), LicenseUsedSet(), LicenseUsedXSDToLogical()
property Name as %String;
The name given to the Cache instance.
Property methods: NameDisplayToLogical(), NameGet(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()
property RoutineCache as %Integer;
The size of the routine cache in MB for this Cache instance .
Property methods: RoutineCacheDisplayToLogical(), RoutineCacheGet(), RoutineCacheIsValid(), RoutineCacheLogicalToDisplay(), RoutineCacheNormalize(), RoutineCacheSet(), RoutineCacheXSDToLogical()
property System as %String;
The system name where the Cache instance is installed.
Property methods: SystemDisplayToLogical(), SystemGet(), SystemIsValid(), SystemLogicalToDisplay(), SystemLogicalToOdbc(), SystemNormalize(), SystemSet()
property Version as %String (MAXLEN = 256);
Version string ($ZV) for this Cache instance.
Property methods: VersionDisplayToLogical(), VersionGet(), VersionIsValid(), VersionLogicalToDisplay(), VersionLogicalToOdbc(), VersionNormalize(), VersionSet()


classmethod Sample() as SYS.WSMon.wsSystem
Instantiate the class and fill in current values for all properties.

Inherited Members

Inherited Methods