SystemInfo

Class finesse.restservices.SystemInfo

Represents the SystemInfo object. For more information, see SystemInfo.

Example

Copyvar systeminfo = new finesse.restservices.SystemInfo('',{ 

    onLoad: handleSystemInfoOnLoad,
    onChange: handleSystemInfoOnChange
});

systeminfo.getCtiMMode();

Methods

getAlternateHost()

Retrieves the FQDN of the alternate Finesse host and this is used for failover purposes.

Returns

{String} The FQDN (if properly configured) of the alternate node, defaults to primary if no match is found, and undefined for the single-node deployments. For example, if the desktop is connected to the primary Finesse node, this method will return FQDN of the secondary Finesse node, and vice-versa.

getCtiMMode()

Retrieves the status of the CTI server in maintenance mode.

Example

systeminfo.getCtiMMode();

Returns

{Boolean} True if the CTI server is in maintenance mode, else false.

getCtiTimeInMMode()

Retrieves the total time (in seconds) that the CTI server has been in maintenance mode.

The time will be negative if the CTI server to which Finesse is connected is not in maintenance mode.

Example

systeminfo.getCtiTimeInMMode();

Returns

{Number} The total time (in seconds) that the CTI server is in maintenance mode.

getCtiServers()

Retrieves the list of CTI servers that Cisco Finesse is connected to.

Example

systeminfo.getCtiServers();

Returns

{Obejct} The list of CTI servers that Cisco Finesse is connected to with the following details:

• hostname—The hostname of the CTI server.

• connectedDuration—The total time (in seconds) that the Cisco Finesse is connected to this particular CTI server.

• active—True if the Cisco Finesse is connected to the active CTI server, else false.

  Note

  Indicates whether the Cisco Finesse is connected to the active or stand-by CTI server, for Unified CCE deployments with CTI protocol version 24 and above. Indicates the CTI server on which the Cisco Finesse is connected, for Unified CCX and Unified CCE deployments with CTI protocol version prior to 24.

getCtiVersion()

Retrieves the CTI version for the current deployment.

Example

systeminfo.getCtiVersion();

Returns

{String} The CTI version used in the Cisco Finesse to connect the CTI server.

getCurrentTimestamp()

Retrieves the current timestamp from the SystemInfo object. This is used to calculate the time drift between the server and the client.

Example

systeminfo.getCurrentTimestamp();

Returns

{String} The time (GMT) in the format: yyyy-MM-dd'T'HH:mm:ss'Z'

getDeploymentType()

Retrieves the deployment type Unified CCE or Unified CCX.

Example

systeminfo.getDeploymentType();

Returns

{String} The deployment type, which is either Unified CCE or Unified CCX.

getFinesseMMode()

Retrieves the status of the maintenance mode for the particular Cisco Finesse server.

Example

systeminfo.getFinesseMMode();

Returns

{Boolean} True if the Cisco Finesse server is in maintenance mode, else false.

getFinesseTimeInMMode()

Retrieves the total time (in seconds) that the Cisco Finesse server is in maintenance mode.

The time will be negative if the Cisco Finesse server is not in Finesse maintenance mode.

Example

systeminfo.getFinesseTimeInMMode();

Returns

{Number} The total time (in seconds) that the Cisco Finesse server is in maintenance mode.

getHeartbeatInterval()

Retrieves the ctiHeartbeatInterval for the current deployment. This represents the interval of heartbeats between the Cisco Finesse server and CTI server (in seconds) that helps in failover time calculation.

Returns

{String} The ctiHeartbeatInterval between the Cisco Finesse server and the CTI server.

getLastCTIHeartbeatStatus()

Retrieves the lastCTIHeartbeatStatus. The lastCTIHeartbeatStatus provides the success or failure of the last heartbeat sent to the CTI server. This can be used to determine whether the Cisco Finesse side is healthy or not. If three consecutive heartbeats fail, the CTI server gets disconnected.

• success—The last CTI heartbeat was successful.

• failure—The last CTI heartbeat was unsuccessful.

Returns

{finesse.restservices.SystemInfo.lastCTIHeartbeatStatus} The last Heartbeat status (success or failure) to CTI.

getlicense()

Retrieves the license and is applicable only to Unified CCX deployment.

Returns

{String} The Unified CCX deployment license details. Otherwise, an empty string.

getPeripheralId()

Retrieves the peripheral Id that Cisco Finesse is connected to. The peripheral Id refers to the Id of the PG Routing Client (PIM).

Returns

{String} The Id of the Unified CCE peripheral to which Cisco Finesse is connected. For Unified CCX, it returns an empty string.

getStatus()

Retrieves the status of the Cisco Finesse server. The possible values are:

• IN_SERVICE

• OUT_OF_SERVICE

Returns

{finesse.restservices.SystemInfo.Statuses} The system status.

getStatusReason()

Retrieves the reason for Cisco Finesse being OUT_OF_SERVICE.

Returns

{String} Returns the status reason if the Cisco Finesse is OUT_OF_SERVICE. Otherwise, an empty string when Cisco Finesse status is IN_SERVICE.

getSystemAuthMode()

Retrieves the system authentication mode for the current deployment. The possible values are SSO or non-SSO.

Returns

{String} The system authentication mode for the current deployment.

getXmppDomain()

Retrieves the XMPP domain of the system. The XMPP servers such as Openfire require to identify the domain that they serve. Hence, configure the XMPP domain which is the JID value.

Returns

{String} The XMPP domain.

getXmppPubSubDomain()

Retrieves the XMPP PubSub domain of the system. For third-party applications to identify the domain of the server PubSubDomain is required.

Returns

{String} The XMPP PubSub domain.

isSingleNode()

Confirms whether the deployment is a single-node deployment by checking for the existence of the secondary node in the SystemInfo.

Returns

{Boolean} True for single-node deployments, else false.