Class %SYSTEM.Version

abstract class %SYSTEM.Version extends Help

This class provides various product version information.

You can use it via the special $system object:

	Write $system.Version.GetBuildOS()

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
		38

Summary

Methods
FeatureBits	Format	GetBuildDate	GetBuildNumber
GetBuildOS	GetBuildTime	GetCompBuild	GetCompBuildDate
GetCompBuildOS	GetCompBuildTime	GetCompPatchId	GetCompilerMajorVersion
GetCompilerMinorVersion	GetCompilerVersion	GetComponents	GetISCComponentVersion
GetISCComponentVersionList	GetISCComponents	GetISCProduct	GetKernelCompiler
GetKernelLinker	GetKernelOrigin	GetMajor	GetMinor
GetNumber	GetOS	GetPatchId	GetPlatform
GetPoint	GetProduct	GetVersion	Help
Is64Bits	IsBigEndian	IsSingleUser	IsUnicode
ListISCComponents	ListISCComponentsVersions	SystemMode

Methods

• 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.

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

• classmethod GetBuildDate(zv As %String = $zv) as %String

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

• classmethod GetBuildNumber(zv As %String = $zv) as %Integer

Returns the build number for the product.

• classmethod GetBuildOS(zv As %String = $zv) as %String

Returns the operating system for which the product was built.

• classmethod GetBuildTime(zv As %String = $zv) as %String

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

• deprecatedclassmethod GetCompBuild(component As %String = "SYS") as %Integer

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

• deprecatedclassmethod GetCompBuildDate(component As %String = "SYS") as %String

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

• deprecatedclassmethod GetCompBuildOS(component As %String = "SYS") as %String

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

• deprecatedclassmethod GetCompBuildTime(component As %String = "SYS") as %String

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

• deprecatedclassmethod GetCompPatchId(component As %String) as %String

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

• classmethod GetCompilerMajorVersion() as %Numeric

Returns the major version number of the language compiler.

• classmethod GetCompilerMinorVersion() as %Numeric

Returns the minor version number of the language compiler.

• 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.

• deprecatedclassmethod GetComponents() as %List

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

• 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.

• 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.

• 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.

• classmethod GetISCProduct() as %Integer

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

• classmethod GetKernelCompiler() as %String

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

• classmethod GetKernelLinker() as %String

Returns the version of the Linker used to link the kernel

• classmethod GetKernelOrigin() as %String

Returns the string identifying who linked the kernel
InterSystems or User

• classmethod GetMajor(zv As %String = $zv) as %String

Returns the major version number for the product.

• classmethod GetMinor(zv As %String = $zv) as %String

Returns the minor version number for the product.

• classmethod GetNumber(zv As %String = $zv) as %String

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

• classmethod GetOS(zv As %String = $zv) as %String

Returns the OS for which the product was built.

• classmethod GetPatchId(zv As %String = $zv) as %String

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

• classmethod GetPlatform(zv As %String = $zv) as %String

Returns the platform for which the product was built.

• classmethod GetPoint(zv As %String = $zv) as %String

Returns the point version number for the product.

• classmethod GetProduct(zv As %String = $zv) as %String

Returns the product name.

• classmethod GetVersion(zv As %String = $zv) as %String

Returns a string containing complete version information.

• classmethod Is64Bits() as %Boolean

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

• 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.

• 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.

• classmethod IsUnicode() as %Boolean

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())

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())

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

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.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search