Skip to main content

%SYSTEM.Version

Class %SYSTEM.Version Extends Help [ Abstract, System = 3 ]

This class provides various product version information.

You can use it via the special $system object: Write $system.Version.GetBuildOS()

Methods​

Format​

ClassMethod Format(Format As %Numeric = 0, zv As %String = {$zv}) As %String

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 - ""

GetBuildNumber​

ClassMethod GetBuildNumber(zv As %String = {$zv}) As %Integer

Returns the build number for the product.

GetBuildDate​

ClassMethod GetBuildDate(zv As %String = {$zv}) As %String

Returns the date the product was built in $HOROLOG format.

GetBuildOS​

ClassMethod GetBuildOS(zv As %String = {$zv}) As %String

Returns the operating system for which the product was built.

GetBuildTime​

ClassMethod GetBuildTime(zv As %String = {$zv}) As %String

Returns the time of day the product was built in $HOROLOG format.

GetISCComponentVersionList​

ClassMethod GetISCComponentVersionList(Product As %Integer = 0) As %List

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.

GetISCComponents​

ClassMethod GetISCComponents(Product As %Integer = {..GetISCProduct()}) As %List

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.

GetISCComponentVersion​

ClassMethod GetISCComponentVersion(Product As %Integer = {..GetISCProduct()}, Component As %String = "") As %String

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.

GetISCProduct​

ClassMethod GetISCProduct() As %Integer

Returns the installed ISC product code. HealthShare = 3, InterSystems IRIS = 4

ListISCComponents​

ClassMethod ListISCComponents(Product As %Integer = {..GetISCProduct()})

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.

ListISCComponentsVersions​

ClassMethod ListISCComponentsVersions(Product As %Integer = {..GetISCProduct()})

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.

GetPatchId​

ClassMethod GetPatchId(zv As %String = {$zv}) As %String

Returns the patch ID[s] included in this version of the product;

GetMajor​

ClassMethod GetMajor(zv As %String = {$zv}) As %String

Returns the major version number for the product.

GetMinor​

ClassMethod GetMinor(zv As %String = {$zv}) As %String

Returns the minor version number for the product.

GetNumber​

ClassMethod GetNumber(zv As %String = {$zv}) As %String

Returns the major.minor[.point] version number for the product.

GetOS​

ClassMethod GetOS(zv As %String = {$zv}) As %String

Returns the OS for which the product was built.

GetPlatform​

ClassMethod GetPlatform(zv As %String = {$zv}) As %String

Returns the platform for which the product was built.

GetPoint​

ClassMethod GetPoint(zv As %String = {$zv}) As %String

Returns the point version number for the product.

GetProduct​

ClassMethod GetProduct(zv As %String = {$zv}) As %String

Returns the product name.

GetVersion​

ClassMethod GetVersion(zv As %String = {$zv}) As %String [ CodeMode = expression ]

Returns a string containing complete version information.

Is64Bits​

ClassMethod Is64Bits() As %Boolean

Is this a 64-bit platform?

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

IsBigEndian​

ClassMethod IsBigEndian() As %Boolean

Is this system built for a big endian platform?

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

IsSingleUser​

ClassMethod IsSingleUser() As %Boolean

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.

IsUnicode​

ClassMethod IsUnicode() As %Boolean

Is this a UNICODE system?

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

FeatureBits​

ClassMethod FeatureBits(bit As %Integer = "") As %Binary

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.

GetCompBuild​

ClassMethod GetCompBuild(component As %String = "SYS") As %Integer [ Deprecated ]

Returns the build number for the specified component. (Deprecated)

GetCompBuildDate​

ClassMethod GetCompBuildDate(component As %String = "SYS") As %String [ Deprecated ]

Returns the build date for the specified component. (Deprecated)

GetCompBuildOS​

ClassMethod GetCompBuildOS(component As %String = "SYS") As %String [ Deprecated ]

Returns the operating system a product component was built for. (Deprecated)

GetCompBuildTime​

ClassMethod GetCompBuildTime(component As %String = "SYS") As %String [ Deprecated ]

Returns the Time of build for a product component. (Deprecated)

GetCompPatchId​

ClassMethod GetCompPatchId(component As %String) As %String [ Deprecated ]

Returns the patch ID[s] included in a component of this version of the product (Deprecated)

GetComponents​

ClassMethod GetComponents() As %List [ Deprecated ]

Returns a list of components used by the %Version class. (Deprecated)

GetCompilerVersion​

ClassMethod GetCompilerVersion() As %Numeric

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.

GetCompilerMajorVersion​

ClassMethod GetCompilerMajorVersion() As %Numeric

Returns the major version number of the language compiler.

GetCompilerMinorVersion​

ClassMethod GetCompilerMinorVersion() As %Numeric

Returns the minor version number of the language compiler.

GetKernelCompiler​

ClassMethod GetKernelCompiler() As %String

Returns the version of the C compiler used to build the kernel

GetKernelLinker​

ClassMethod GetKernelLinker() As %String

Returns the version of the Linker used to link the kernel

GetKernelOrigin​

ClassMethod GetKernelOrigin() As %String

Returns the string identifying who linked the kernel

InterSystems or User

SystemMode​

ClassMethod SystemMode(mode As %String) As %String

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.