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 > ENSLIB namespace > %EM.InstanceData

%EM.InstanceData

class %EM.InstanceData extends %Library.RegisteredObject, %XML.Adaptor

The %EM.InstanceData class represents the descriptive instance data for an Enterprise Manager instance for the remote API

Property Inventory

Properties

property Charset as %String;
default charset for this instance
Property methods: CharsetDisplayToLogical(), CharsetGet(), CharsetIsValid(), CharsetLogicalToDisplay(), CharsetLogicalToOdbc(), CharsetNormalize(), CharsetSet()
property Description as %String (MAXLEN = 128);
Description of the Client.
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property EMSVersionNumber as %Float (XMLNAME = "Version");
EMS Software version of client. XMLNAME is version for compatibility with older InstannceData
Property methods: EMSVersionNumberDisplayToLogical(), EMSVersionNumberGet(), EMSVersionNumberIsValid(), EMSVersionNumberLogicalToDisplay(), EMSVersionNumberNormalize(), EMSVersionNumberSet(), EMSVersionNumberXSDToLogical()
property InstallDir as %SysPath (MAXLEN = 256);
Base installation directory of the Instance. Primarily used for remote start/stop. The call to ISCAgent can get this if we don't have it and stores it here.
Property methods: InstallDirDisplayToLogical(), InstallDirGet(), InstallDirIsValid(), InstallDirLogicalToDisplay(), InstallDirLogicalToOdbc(), InstallDirNormalize(), InstallDirSet()
property InstanceName as %String (MAXLEN = 64);
Instance name of the Client.
Property methods: InstanceNameDisplayToLogical(), InstanceNameGet(), InstanceNameIsValid(), InstanceNameLogicalToDisplay(), InstanceNameLogicalToOdbc(), InstanceNameNormalize(), InstanceNameSet()
property IsUnicode as %Boolean;
Whether system is Unicode
Property methods: IsUnicodeDisplayToLogical(), IsUnicodeGet(), IsUnicodeIsValid(), IsUnicodeLogicalToDisplay(), IsUnicodeLogicalToXSD(), IsUnicodeNormalize(), IsUnicodeSet(), IsUnicodeXSDToLogical()
property NodeName as %String (MAXLEN = 64);
Node name of the client.
Property methods: NodeNameDisplayToLogical(), NodeNameGet(), NodeNameIsValid(), NodeNameLogicalToDisplay(), NodeNameLogicalToOdbc(), NodeNameNormalize(), NodeNameSet()
property Product as %String;
Product name (Cache, Ensemble, HealthShare)
Property methods: ProductDisplayToLogical(), ProductGet(), ProductIsValid(), ProductLogicalToDisplay(), ProductLogicalToOdbc(), ProductNormalize(), ProductSet()
property SuperServer as %NetworkAddress;
Network address (Address|Port) used to communicate to the client's SuperServer.
Property methods: SuperServerDisplayToLogical(), SuperServerFormatForHttp(), SuperServerGet(), SuperServerIsValid(), SuperServerLogicalToDisplay(), SuperServerLogicalToOdbc(), SuperServerNormalize(), SuperServerSet()
property SystemBuildNumber as %String;
Build number of the system.
Property methods: SystemBuildNumberDisplayToLogical(), SystemBuildNumberGet(), SystemBuildNumberIsValid(), SystemBuildNumberLogicalToDisplay(), SystemBuildNumberLogicalToOdbc(), SystemBuildNumberNormalize(), SystemBuildNumberSet()
property SystemOS as %String;
O/S for which the system was built for.
Property methods: SystemOSDisplayToLogical(), SystemOSGet(), SystemOSIsValid(), SystemOSLogicalToDisplay(), SystemOSLogicalToOdbc(), SystemOSNormalize(), SystemOSSet()
property SystemPlatform as %String;
Platform for which the system was built for.
Property methods: SystemPlatformDisplayToLogical(), SystemPlatformGet(), SystemPlatformIsValid(), SystemPlatformLogicalToDisplay(), SystemPlatformLogicalToOdbc(), SystemPlatformNormalize(), SystemPlatformSet()
property SystemVersion as %String;
Version of the system.
Property methods: SystemVersionDisplayToLogical(), SystemVersionGet(), SystemVersionIsValid(), SystemVersionLogicalToDisplay(), SystemVersionLogicalToOdbc(), SystemVersionNormalize(), SystemVersionSet()
property WebServerName as %String;
Internal web server name. If localhost, then value is ""
Property methods: WebServerNameDisplayToLogical(), WebServerNameGet(), WebServerNameIsValid(), WebServerNameLogicalToDisplay(), WebServerNameLogicalToOdbc(), WebServerNameNormalize(), WebServerNameSet()
property WebServerPort as %Integer;
Internal web server port
Property methods: WebServerPortDisplayToLogical(), WebServerPortGet(), WebServerPortIsValid(), WebServerPortLogicalToDisplay(), WebServerPortNormalize(), WebServerPortSet(), WebServerPortXSDToLogical()
property ZVersion as %String (MAXLEN = 256);
$zv of the instance.
Property methods: ZVersion0Get(), ZVersion0IsValid(), ZVersion0LogicalToXSD(), ZVersion0Set(), ZVersion0XSDToLogical(), ZVersionDisplayToLogical(), ZVersionGet(), ZVersionIsValid(), ZVersionLogicalToDisplay(), ZVersionLogicalToOdbc(), ZVersionNormalize(), ZVersionSet()
property ZVersion0 as %Binary;
$zversion(0) of the instance.
Property methods: ZVersion0Get(), ZVersion0IsValid(), ZVersion0LogicalToXSD(), ZVersion0Set(), ZVersion0XSDToLogical()

Inherited Members

Inherited Methods