Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?


Obtain information about the Caché or Ensemble server and its environment.

Background Information

Caché is an application server, which works in conjunction with a web server and with the CSP Gateway. For information on the CSP Gateway and on supported web servers, see “Introduction to the CSP Gateway” in the CSP Gateway Configuration Guide.

Because Ensemble is a superset of Caché, Ensemble is also an application server.

This topic discusses the application server, as opposed to the third-party web server.

Available Tools

Provides methods like the following:

  • GetInstanceName()

  • GetUniqueInstanceName()

  • GetNodeName()

  • TempDirectory()

  • And others

Availability: All namespaces.

Provides methods like the following:

  • BinaryDirectory()

  • InstallDirectory()

  • ManagerDirectory()

  • And others

Availability: All namespaces.


The special variable $SYSTEM is bound to the %SYSTEM package. This means that (for ObjectScript) instead of ##class(%SYSTEM.class).method(), you can use $SYSTEM.class.method().