Script: Class dw.system.System

Class System

Represents the Commerce Cloud Digital server instance. An application server instance is configured to be of one of three types, "development system", "staging system" or "production system".

Constants

DEVELOPMENT_SYSTEM : Number=0

Represents the development system.

PRODUCTION_SYSTEM : Number=2

Represents the production system.

STAGING_SYSTEM : Number=1

Represents the staging system.

Properties

calendar : Calendar Read Only

A new Calendar object in the time zone of the current instance.

compatibilityMode : Number Read Only

The compatibility mode of the custom code version that is currently active. The compatibility mode is returned as a number, e.g. compatibility mode "15.5" is returned as 1505.

instanceHostname : String Read Only

Returns instance hostname.

instanceTimeZone : String Read Only

The instance time zone. The instance time zone is the time zone in which global actions like jobs or reporting are specified in the system. Keep in mind that the instance time zone is cached at the current session. Changes will affect only new sessions.

instanceType : Number Read Only

The type of the instance. An application server instance is configured to be of one of three types, "development system", "staging system" or "production system".
This method returns a constant representing the instance type of this application server.

preferences : OrganizationPreferences Read Only

This method returns a container of all global preferences of this organization (instance).

Constructor Summary

This class does not have a constructor, so you cannot create it directly.

Method Summary

static getCalendar() : Calendar

Returns a new Calendar object in the time zone of the current instance.

static getCompatibilityMode() : Number

Returns the compatibility mode of the custom code version that is currently active.

static getInstanceHostname() : String

Returns instance hostname.

static getInstanceTimeZone() : String

Returns the instance time zone.

static getInstanceType() : Number

Returns the type of the instance.

static getPreferences() : OrganizationPreferences

This method returns a container of all global preferences of this organization (instance).

Methods inherited from class Object

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

Method Detail

getCalendar

static getCalendar() : Calendar

Returns a new Calendar object in the time zone of the current instance.

Returns:

a Calendar object in the time zone of the instance.

getCompatibilityMode

static getCompatibilityMode() : Number

Returns the compatibility mode of the custom code version that is currently active. The compatibility mode is returned as a number, e.g. compatibility mode "15.5" is returned as 1505.

Returns:

The currently active compatibility mode.


getInstanceHostname

static getInstanceHostname() : String

Returns instance hostname.

Returns:

instance hostname.


getInstanceTimeZone

static getInstanceTimeZone() : String

Returns the instance time zone. The instance time zone is the time zone in which global actions like jobs or reporting are specified in the system. Keep in mind that the instance time zone is cached at the current session. Changes will affect only new sessions.

Returns:

the instance time zone.


getInstanceType

static getInstanceType() : Number

Returns the type of the instance. An application server instance is configured to be of one of three types, "development system", "staging system" or "production system".
This method returns a constant representing the instance type of this application server.

Returns:

the instance type of the application server where this method was called.

See Also:

DEVELOPMENT_SYSTEM

PRODUCTION_SYSTEM

STAGING_SYSTEM


getPreferences

static getPreferences() : OrganizationPreferences

This method returns a container of all global preferences of this organization (instance).

Returns:

a preferences object containing all global system and custom preferences of this instance