Home > Class Reference > %SYS namespace > %SYSTEM.Version

%SYSTEM.Version

abstract class %SYSTEM.Version extends %SYSTEM.Help

This class provides various product version information.

You can use it via the special $system object:

  Write $system.Version.GetBuildOS()
  

Method Inventory

Methods

classmethod FeatureBits(bit As %Integer = "") as %Binary [ Language = objectscript ]
Return all the feature codes stored in $zversion(0)

You can then test this for specific features using $zbitget(return,bit)

If you pass in a value for bit then this will test for this specific bit and return 1 if it is set otherwise 0.

classmethod Format(Format As %Numeric = 0, zv As %String = $zv) as %String [ Language = objectscript ]
Formats the version info according to the following format types:
  • 0 - $ZV
  • 1 - Product
  • 2 - Product (Platform)
  • 3 - Product (Platform) Version
  • 4 - Product (Platform) Version (Build)
  • 5 - Version (Build)
  • Other - ""
classmethod GetBuildDate(zv As %String = $zv) as %String [ Language = objectscript ]
Returns the date the product was built in $HOROLOG format.
classmethod GetBuildNumber(zv As %String = $zv) as %Integer [ Language = objectscript ]
Returns the build number for the product.
classmethod GetBuildOS(zv As %String = $zv) as %String [ Language = objectscript ]
Returns the operating system for which the product was built.
classmethod GetBuildTime(zv As %String = $zv) as %String [ Language = objectscript ]
Returns the time of day the product was built in $HOROLOG format.
classmethod GetCompBuild(component As %String = "SYS") as %Integer [ Language = objectscript ]
Returns the build number for the specified component. (Deprecated)
classmethod GetCompBuildDate(component As %String = "SYS") as %String [ Language = objectscript ]
Returns the build date for the specified component. (Deprecated)
classmethod GetCompBuildOS(component As %String = "SYS") as %String [ Language = objectscript ]
Returns the operating system a product component was built for. (Deprecated)
classmethod GetCompBuildTime(component As %String = "SYS") as %String [ Language = objectscript ]
Returns the Time of build for a product component. (Deprecated)
classmethod GetCompPatchId(component As %String) as %String [ Language = objectscript ]
Returns the patch ID[s] included in a component of this version of the product (Deprecated)
classmethod GetCompilerMajorVersion() as %Numeric [ Language = objectscript ]
Returns the major version number of the language compiler.
classmethod GetCompilerMinorVersion() as %Numeric [ Language = objectscript ]
Returns the minor version number of the language compiler.
classmethod GetCompilerVersion() as %Numeric [ Language = objectscript ]
Returns the major.minor version number of the language compiler.

The system can only execute object code compiled with the same major version number. It can execute object code compiled with any minor version number that is less than or equal to the current minor version.

classmethod GetComponents() as %List [ Language = objectscript ]
Returns a list of components used by the %Version class. (Deprecated)
classmethod GetISCComponentVersion(Product As %Integer = {..GetISCProduct()}, Component As %String = "") as %String [ Language = objectscript ]
Returns the ISC Product component's installed version string.
Product: HealthShare = 3, InterSystems IRIS = 4
At this time, InterSystems IRIS does not have components, so this method does not return anything for this product.
classmethod GetISCComponentVersionList(Product As %Integer = 0) as %List [ Language = objectscript ]
Return a %List of Component:Version for all components of ISC Product.
At this time, InterSystems IRIS does not have components, so this method does not return anything for this product.
classmethod GetISCComponents(Product As %Integer = {..GetISCProduct()}) as %List [ Language = objectscript ]
Returns the installed components for the ISC Product as a %List.
Product: HealthShare = 3, InterSystems IRIS = 4
At this time, InterSystems IRIS does not have components, so this method does not return anything for this product.
classmethod GetISCProduct() as %Integer [ Language = objectscript ]
Returns the installed ISC product code. HealthShare = 3, InterSystems IRIS = 4
classmethod GetKernelCompiler() as %String [ Language = objectscript ]
Returns the version of the C compiler used to build the kernel
classmethod GetKernelLinker() as %String [ Language = objectscript ]
Returns the version of the Linker used to link the kernel
classmethod GetKernelOrigin() as %String [ Language = objectscript ]
Returns the string identifying who linked the kernel

InterSystems or User

classmethod GetMajor(zv As %String = $zv) as %String [ Language = objectscript ]
Returns the major version number for the product.
classmethod GetMinor(zv As %String = $zv) as %String [ Language = objectscript ]
Returns the minor version number for the product.
classmethod GetNumber(zv As %String = $zv) as %String [ Language = objectscript ]
Returns the major.minor[.point] version number for the product.
classmethod GetOS(zv As %String = $zv) as %String [ Language = objectscript ]
Returns the OS for which the product was built.
classmethod GetPatchId(zv As %String = $zv) as %String [ Language = objectscript ]
Returns the patch ID[s] included in this version of the product;
classmethod GetPlatform(zv As %String = $zv) as %String [ Language = objectscript ]
Returns the platform for which the product was built.
classmethod GetPoint(zv As %String = $zv) as %String [ Language = objectscript ]
Returns the point version number for the product.
classmethod GetProduct(zv As %String = $zv) as %String [ Language = objectscript ]
Returns the product name.
classmethod GetVersion(zv As %String = $zv) as %String [ Language = objectscript ]
Returns a string containing complete version information.
classmethod Is64Bits() as %Boolean [ Language = objectscript ]
Is this a 64-bit platform?

Returns a boolean value which tells if the kernel is 64-bit platform.

classmethod IsBigEndian() as %Boolean [ Language = objectscript ]
Is this system built for a big endian platform?

Returns a boolean value which tells if the platform uses big endian bit ordering.

classmethod IsSingleUser() as %Boolean [ Language = objectscript ]
Is this a single-user server kit?

Returns a boolean value which tells if the product server is running a single-user evaluation (_SU) kit.

classmethod IsUnicode() as %Boolean [ Language = objectscript ]
Is this a UNICODE system?

Returns a boolean value which tells if the product server is a UNICODE system.

classmethod ListISCComponents(Product As %Integer = {..GetISCProduct()}) [ Language = objectscript ]
Displays all Components for the ISC Product to the current I/O Device.
Product: HealthShare = 3, InterSystems IRIS = 4
At this time, InterSystems IRIS does not have components, so this method does not return anything for this product.
classmethod ListISCComponentsVersions(Product As %Integer = {..GetISCProduct()}) [ Language = objectscript ]
Displays all Components:Version for the ISC Product to the current I/O Device.
Product: HealthShare = 3, InterSystems IRIS = 4
At this time, InterSystems IRIS does not have components, so this method does not return anything for this product.
classmethod SystemMode(mode As %String) as %String [ Language = objectscript ]
The SystemMode string is usually set by the System Management Portal but it can also be set by calling the $SYSTEM.Version.SystemMode(mode) method. The currently supported SystemMode strings are: "LIVE", "TEST", "DEVELOPMENT" and "FAILOVER". The SystemMode of the current instance is displayed in the Title of the System Management Portal web page. Attempting to set a nonsupported SystemMode string will clear out the currently set SystemMode.

Parameters

mode -- The new SystemMode string for the current instance

Invoking $SYSTEM.Version.SystemMode() without specifiying the mode parameter returns the current SystemMode string without changing it.

Return value -- the SystemMode value prior to calling the $SYSTEM.Version.SystemMode method. Returns the empty string when a SystemMode has not been previously set.

Inherited Methods