SAP ABAP Class CL_CRM_IC_HBT_UTILITY (Utility class for heartbeat check)

Hierarchy

☛ WEBCUIF (Software Component) SAP Web UI Framework
   ⤷ CA-GTF-IC (Application Component) Interaction Center WebClient
     ⤷ CRM_IC_CUSTOMIZING2 (Package) IC WebClient customizing

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ICI_CONSTANTS	temporary solution for constants in ICI	20080320

Properties

Class	CL_CRM_IC_HBT_UTILITY
Short Description	Utility class for heartbeat check
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	CRM_IC_CUSTOMIZING2	IC WebClient customizing
Created	20080320	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_ICI_CONSTANTS	☐	☐	temporary solution for constants in ICI	20080320

Friends

Class CL_CRM_IC_HBT_UTILITY has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_CMS_PING_INTERVAL	Constant	Public	☐	Type reference (TYPE)	STRING	'wd_cms_ping_int'	CMS Ping Interval	20110418
2	CO_HBT_LAG	Static Attribute	Public	☐	Type reference (TYPE)	STRING	'heartbeat_lag'	Heartbeat lag	20080320
3	CO_PING_INTERVAL	Static Attribute	Public	☐	Type reference (TYPE)	STRING	'ping_interval'	Ping interval	20080320
4	CO_TOL_PING_DELAY	Static Attribute	Public	☐	Type reference (TYPE)	STRING	'tol_ping_delay'	ping delay	20080320
5	CO_WD_ACTIVE	Static Attribute	Public	☐	Type reference (TYPE)	STRING	'wd_active'	flag for wd active	20080320
6	CO_WD_SLEEP_TIME	Static Attribute	Public	☐	Type reference (TYPE)	STRING	'wd_sleep_time'	wd sleep time	20080320
7	GV_TRACE_LEVEL	Static Attribute	Public	☐	Type reference (TYPE)	STRING			20110712
8	GV_TRACE_LEVEL_READ	Static Attribute	Public	☐	Type reference (TYPE)	ABAP_BOOL			20110712
9	MT_HBT_PROFILE	Static Attribute	Private	☐	Type reference (TYPE)	TYPE_HBT_PROFILE			20080320

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	GET_ALLOWED_PING_DELAY	Static method	Public	Method	Get the customizing value for allowed delay time for ping	20080320
2	GET_CMS_PING_INTERVAL	Static method	Public	Method	Get CMS Ping Interval	20110418
3	GET_HEARTBEAT_LAG	Static method	Public	Method	Get the customizing value for heartbeat lag	20080320
4	GET_PING_INTERVAL	Static method	Public	Method	Get the customizing value for browser ping message interval	20080320
5	GET_VALUE_BY_COL	Static method	Public	Method	help method to get the customizing value by the column name	20080320
6	GET_WD_ACTIVE_FLAG	Static method	Public	Method	Get the customizing value for watch dog activation flag	20080320
7	GET_WD_SLEEP_TIME	Static method	Public	Method	Get the customizing value for watch dog sleep time	20080320
8	LOGOFF_CMS	Static method	Public	Method	Helper method to log off CMS using SOAP message	20080320
9	READ_HBT_PROFILE	Static method	Private	Method	Read customizing table for heartbeat profile	20080320
10	SET_CHANNELS_EMPTY	Static method	Public	Method	Helper method to log off CMS using SOAP message	20080326
11	SET_QUEUE_EMPTY	Static method	Public	Method	Helper method to log off CMS using SOAP message	20080326
12	SET_WORKMODE	Static method	Public	Method		20110810
13	SINGLE_LOGOFF_CMS	Static method	Public	Method	Helper method to log off CMS using SOAP message	20080325

Events

Class CL_CRM_IC_HBT_UTILITY has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TYPE_HBT_PROFILE	Private	See coding			20080320	TYPE_HBT_PROFILE TYPE TABLE OF CRMC_IC_HBT_PROF

Method Signatures

Method GET_ALLOWED_PING_DELAY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CLIENT	Call by reference	☐	Type reference (TYPE)	MANDT		Client	20080320
2	Importing	IV_PROFILE	Call by reference	☐	Type reference (TYPE)	CRM_IC_HBT_PROFILE		IC WebClient Heartbeat Check Profile	20080320
3	Exporting	RV_VALUE	Call by reference	☐	Type reference (TYPE)	CRM_IC_HBT_PING_DELAY		Ping message delayed time the user can tolerant	20080320

Method GET_ALLOWED_PING_DELAY on class CL_CRM_IC_HBT_UTILITY has no exception.

Method GET_CMS_PING_INTERVAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CLIENT	Call by reference	☐	Type reference (TYPE)	MANDT		Client	20110418
2	Importing	IV_PROFILE	Call by reference	☐	Type reference (TYPE)	CRM_IC_HBT_PROFILE		IC WebClient Heartbeat Check Profile	20110418
3	Exporting	RV_VALUE	Call by reference	☐	Type reference (TYPE)	CRM_IC_HBT_CMS_PING_INTERVAL		Interval Between Two CMS Ping Messages	20110418

Method GET_CMS_PING_INTERVAL on class CL_CRM_IC_HBT_UTILITY has no exception.

Method GET_HEARTBEAT_LAG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CLIENT	Call by reference	☐	Type reference (TYPE)	MANDT		Client	20080320
2	Importing	IV_PROFILE	Call by reference	☐	Type reference (TYPE)	CRM_IC_HBT_PROFILE		IC WebClient Heartbeat Check Profile	20080320
3	Exporting	RV_VALUE	Call by reference	☐	Type reference (TYPE)	CRM_IC_HBT_BEAT_LAG		The heartbeat lag used to tell if the browser still live	20080320

Method GET_HEARTBEAT_LAG on class CL_CRM_IC_HBT_UTILITY has no exception.

Method GET_PING_INTERVAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CLIENT	Call by reference	☐	Type reference (TYPE)	MANDT		Client	20080320
2	Importing	IV_PROFILE	Call by reference	☐	Type reference (TYPE)	CRM_IC_HBT_PROFILE		IC WebClient Heartbeat Check Profile	20080320
3	Exporting	RV_VALUE	Call by reference	☐	Type reference (TYPE)	CRM_IC_HBT_PING_INTERVAL		Interval between two ping messages	20080320

Method GET_PING_INTERVAL on class CL_CRM_IC_HBT_UTILITY has no exception.

Method GET_VALUE_BY_COL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CLIENT	Call by reference	☐	Type reference (TYPE)	MANDT		Client	20080320
2	Importing	IV_COL_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Column name	20080320
3	Importing	IV_PROFILE	Call by reference	☐	Type reference (TYPE)	CRM_IC_HBT_PROFILE		IC WebClient Heartbeat Check Profile	20080320
4	Exporting	RV_VALUE	Call by reference	☐	Type reference (TYPE)	DATA		retunr value	20080320

Method GET_VALUE_BY_COL on class CL_CRM_IC_HBT_UTILITY has no exception.

Method GET_WD_ACTIVE_FLAG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CLIENT	Call by reference	☐	Type reference (TYPE)	MANDT		Client	20080320
2	Importing	IV_PROFILE	Call by reference	☐	Type reference (TYPE)	CRM_IC_HBT_PROFILE		IC WebClient Heartbeat Check Profile	20080320
3	Exporting	RV_VALUE	Call by reference	☐	Type reference (TYPE)	CRM_IC_HBT_WD_ACTIVE		Flag to set the watch dog session active or not	20080320

Method GET_WD_ACTIVE_FLAG on class CL_CRM_IC_HBT_UTILITY has no exception.

Method GET_WD_SLEEP_TIME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CLIENT	Call by reference	☐	Type reference (TYPE)	MANDT		Client	20080320
2	Importing	IV_PROFILE	Call by reference	☐	Type reference (TYPE)	CRM_IC_HBT_PROFILE		IC WebClient Heartbeat Check Profile	20080320
3	Exporting	RV_VALUE	Call by reference	☐	Type reference (TYPE)	CRM_IC_HBT_WD_SLEEP		Heartbeat Watch Dog Session Sleeping Time	20080320

Method GET_WD_SLEEP_TIME on class CL_CRM_IC_HBT_UTILITY has no exception.

Method LOGOFF_CMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_FLAG	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20080702
2	Importing	IV_APPID	Call by reference	☐	Type reference (TYPE)	CRMT_IC_MCM_APPLICATION_IDS		Application Ids for each channels	20080320
3	Importing	IV_APPURL	Call by reference	☐	Type reference (TYPE)	STRING			20080320
4	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	STRING			20080320
5	Importing	IV_SOAP_DEST	Call by reference	☐	Type reference (TYPE)	RFCDEST		Logical Destination (Specified in Function Call)	20080321
6	Importing	IV_USER	Call by reference	☐	Type reference (TYPE)	STRING			20080320

Method LOGOFF_CMS on class CL_CRM_IC_HBT_UTILITY has no exception.

Method READ_HBT_PROFILE Signature

Method READ_HBT_PROFILE on class CL_CRM_IC_HBT_UTILITY has no parameter.
Method READ_HBT_PROFILE on class CL_CRM_IC_HBT_UTILITY has no exception.

Method SET_CHANNELS_EMPTY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_APPID	Call by reference	☐	Type reference (TYPE)	STRING			20080326
2	Importing	IV_APPURL	Call by reference	☐	Type reference (TYPE)	STRING			20080326
3	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	STRING			20080326
4	Importing	IV_SOAP_DEST	Call by reference	☐	Type reference (TYPE)	RFCDEST		Logical Destination (Specified in Function Call)	20080326
5	Importing	IV_USER	Call by reference	☐	Type reference (TYPE)	STRING			20080326

#	Exception	Resumable	Description	Created on
1	CX_CRM_ICI_EXCEPTION	☐	Exception class for CRM ICI	20080718

Method SET_QUEUE_EMPTY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_APPID	Call by reference	☐	Type reference (TYPE)	STRING			20080326
2	Importing	IV_APPURL	Call by reference	☐	Type reference (TYPE)	STRING			20080326
3	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	STRING			20080326
4	Importing	IV_SOAP_DEST	Call by reference	☐	Type reference (TYPE)	RFCDEST		Logical Destination (Specified in Function Call)	20080326
5	Importing	IV_USER	Call by reference	☐	Type reference (TYPE)	STRING			20080326

#	Exception	Resumable	Description	Created on
1	CX_CRM_ICI_EXCEPTION	☐	Exception class for CRM ICI	20080702

Method SET_WORKMODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	STRING			20110810
2	Importing	IV_SOAP_DEST	Call by reference	☐	Type reference (TYPE)	RFCDEST		Logical Destination (Specified in Function Call)	20110810
3	Importing	IV_USERID	Call by reference	☐	Type reference (TYPE)	STRING			20110810
4	Importing	IV_WORKMODE	Call by reference	☐	Type reference (TYPE)	STRING			20110810

#	Exception	Resumable	Description	Created on
1	CX_CRM_ICI_EXCEPTION	☐	Exception class for CRM ICI	20110810

Method SINGLE_LOGOFF_CMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_APPID	Call by reference	☐	Type reference (TYPE)	STRING			20080325
2	Importing	IV_APPURL	Call by reference	☐	Type reference (TYPE)	STRING			20080325
3	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	STRING			20080325
4	Importing	IV_SOAP_DEST	Call by reference	☐	Type reference (TYPE)	RFCDEST		Logical Destination (Specified in Function Call)	20080325
5	Importing	IV_USER	Call by reference	☐	Type reference (TYPE)	STRING			20080325

#	Exception	Resumable	Description	Created on
1	CX_CRM_ICI_EXCEPTION	☐	Exception class for CRM ICI	20080718

History

Last changed by/on	SAP	20130531
SAP Release Created in	701