Class finesse.restservices.SystemInfo

Extends finesse.restservices.RestBase.
JavaScript representation of a SystemInfo object.
Defined in: finesse.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	finesse.restservices.SystemInfo()

Fields borrowed from class finesse.restservices.RestBase:: ajaxRequestTimeout, restResponseStatus

Method Summary
Method Attributes	Method Name and Description
	getAlternateHost(arguments) This is useful for getting the FQDN of the other Finesse server, i.e.
	getCtiVersion() Gets the ctiVersion for the current deployment
	getCurrentTimestamp() Returns the current timestamp from this SystemInfo object.
	getDeploymentType() Getter for the deployment type (UCCE or UCCX).
	getFailoverTimeSlot() Gets the failover time slot assigned to an agent.
	getHeartbeatInterval() Gets the ctiHeartbeatInterval for the current deployment
	getLastCTIHeartbeatStatus() Returns the lastCTIHeartbeatStatus success - last CTI heartbeat status was successful.
	getlicense() Gets the license.
	getPeripheralId() Gets the peripheral ID that Finesse is connected to.
	getStatus() Returns the status of the Finesse system.
	getStatusReason() Returns the reason due to which Finesse is OUT OF SERVICE.
	getSystemAuthMode() Gets the systemAuthMode for the current deployment
	getTimeZoneOffset() Gets the time zone offset
	getXmppDomain() Getter for the xmpp domain of the system.
	getXmppPubSubDomain() Getter for the xmpp pubsub domain of the system.
	isSingleNode() Returns whether this is a single node deployment or not by checking for the existence of the secondary node in SystemInfo.

Methods borrowed from class finesse.restservices.RestBase:: addHandler, getBaseRestUrl, getData, getId, getProperty, getRestUrlAdditionalParameters, hasProperty, isLoaded, refresh, removeHandler

Class Detail

finesse.restservices.SystemInfo()

See:: finesse.restservices.SystemInfo.Statuses

Method Detail

{String} getAlternateHost(arguments)

This is useful for getting the FQDN of the other Finesse server, i.e. for failover purposes.

Parameters:
{String} arguments: - any number of arguments to match against

Returns:: {String} FQDN (if properly configured) of the alternate node, defaults to primary if no match is found, undefined for single node deployments.

{String} getCtiVersion()

Gets the ctiVersion for the current deployment

Returns:: {String} The CTI version used in finesse to connect CTI server

{String} getCurrentTimestamp()

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

Returns:: {String} Time (GMT): yyyy-MM-dd'T'HH:mm:ss'Z'

{String} getDeploymentType()

Getter for the deployment type (UCCE or UCCX).

Returns:: {String} "UCCE" or "UCCX"

{String} getFailoverTimeSlot()

Gets the failover time slot assigned to an agent. It is used in the client side failover logic.

Returns:: {String} A sequence number

{String} getHeartbeatInterval()

Gets the ctiHeartbeatInterval for the current deployment

Returns:: {String} The ctiHeartbeatInterval used in finesse to connect CTI server

{finesse.restservices.SystemInfo.lastCTIHeartbeatStatus} getLastCTIHeartbeatStatus()

Returns the lastCTIHeartbeatStatus success - last CTI heartbeat status was successful. failure - last CTI heartbeat status was unsuccessful.

Returns:: {finesse.restservices.SystemInfo.lastCTIHeartbeatStatus} Last Heartbeat to CTI was successful or not.

{String} getlicense()

Gets the license. Only apply to UCCX.

Returns:: {String} The license if UCCX, or empty string otherwise.

{String} getPeripheralId()

Gets the peripheral ID that Finesse is connected to. The peripheral ID is the ID of the PG Routing Client (PIM).

Returns:: {String} The peripheral Id if UCCE, or empty string otherwise.

{finesse.restservices.SystemInfo.Statuses} getStatus()

Returns the status of the Finesse system. IN_SERVICE if the Finesse API reports that it is in service, OUT_OF_SERVICE otherwise.

Returns:: {finesse.restservices.SystemInfo.Statuses} System Status

{String} getStatusReason()

Returns the reason due to which Finesse is OUT OF SERVICE. It returns empty string when Finesse status is IN_SERVICE.

Returns:: {String} statusReason if finesse is OUT OF SERVICE , or empty string otherwise.

{String} getSystemAuthMode()

Gets the systemAuthMode for the current deployment

Returns:: {String} The System auth mode for current deployment

{String} getTimeZoneOffset()

Gets the time zone offset

Returns:: {String} time zone offset

{String} getXmppDomain()

Getter for the xmpp domain of the system.

Returns:: {String} The xmpp domain corresponding to this SystemInfo object.

{String} getXmppPubSubDomain()

Getter for the xmpp pubsub domain of the system.

Returns:: {String} The xmpp pubsub domain corresponding to this SystemInfo object.

{Boolean} isSingleNode()

Returns whether this is a single node deployment or not by checking for the existence of the secondary node in SystemInfo.

Returns:: {Boolean} True for single node deployments, false otherwise.

Classes

Class finesse.restservices.SystemInfo