SAP ABAP Class CL_GRFN_NOTIFICATION (Notifications)

Hierarchy

☛ GRCFND_A (Software Component) GRC Foundation ABAP
   ⤷ GRC (Application Component) Governance, Risk and Compliance
     ⤷ GRFN_NOTIFICATION (Package) Notifications

Properties

Class	CL_GRFN_NOTIFICATION
Short Description	Notifications
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	GRFN_NOTIFICATION	Notifications
Created	20080925	SAP
Last change	20141106
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)
2	IF_GRFN_API_REGULATION	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_GRFN_NOTIFICATION has no interface implemented.

Friends

Class CL_GRFN_NOTIFICATION has no friend class.

Attributes

Class CL_GRFN_NOTIFICATION has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	GET_CUSTOM_DOCUMENTS	Static method	Public	Method	Get list of Customer defined messages for class and msg No.	20140505
2	GET_DOCUMENT	Static method	Public	Method	Retrieves the document	20110921
3	RAISE_EXCEPTION	Static method	Private	Method		20080926
4	SEND	Static method	Public	Method	Sends a notification (expert mode)	20080925
5	SEND_EXTENDED	Static method	Public	Method	Sends a notification preserving Docu Object Formating	20110428
6	SEND_TO_AGENTSLOT	Static method	Public	Method	Sends a notification with agent slot recipient determination	20090908
7	SEND_TO_EMAILADDRESS	Static method	Public	Method	Sends a notification to a list of email addresses	20090908
8	SEND_TO_USERNAME	Static method	Public	Method	Sends a notification to a list of users	20090908

Events

Class CL_GRFN_NOTIFICATION has no event.

Types

Class CL_GRFN_NOTIFICATION has no local type.

Method Signatures

Method GET_CUSTOM_DOCUMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_MSG_CLASS	Call by reference	☐	Type reference (TYPE)	SYMSGID		Message Class	20140505
2	Importing	IV_MSG_NO	Call by reference	☐	Type reference (TYPE)	SYMSGNO		Message Number	20140505
3	Returning	RT_MSG	Value transfer	☐	Type reference (TYPE)	GRFN_T_MSG_HEADER		Messages header	20140505

Method GET_CUSTOM_DOCUMENTS on class CL_GRFN_NOTIFICATION has no exception.

Method GET_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_MESSAGE_DATA	Call by reference	☐	Type reference (TYPE)	GRFNNOTIFYMSG		Notification Messages (Defaults)	20121208
2	Exporting	EV_ATTACHMENT_TITLE	Call by reference	☐	Type reference (TYPE)	STRING			20110921
3	Exporting	EV_DUMMY	Call by reference	☐	Type reference (TYPE)	AS4FLAG		Flag (X or Blank)	20140321
4	Exporting	EV_MESSAGE	Call by reference	☐	Type reference (TYPE)	STRING			20110921
5	Exporting	EV_SUBJECT	Call by reference	☐	Type reference (TYPE)	STRING			20110921
6	Importing	IT_VARIABLE	Call by reference	☑	Type reference (TYPE)	GRFN_T_MSG_VARIABLE		Variables used in notifications	20110921
7	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	LANGU	SY-LANGU	Language Key	20110921
8	Importing	IV_MESSAGE_CLASS	Call by reference	☐	Type reference (TYPE)	SYMSGID		Message Class	20110921
9	Importing	IV_MESSAGE_NO	Call by reference	☐	Type reference (TYPE)	SYMSGNO		Message Number	20110921
10	Importing	IV_TO_HTML	Call by reference	☐	Type reference (TYPE)	AS4FLAG	ABAP_TRUE	Flag (X or Blank)	20110921

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20110921

Method RAISE_EXCEPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_EXCEPTION	Call by reference	☑	Object reference (TYPE REF TO)	CX_BCS		BCS: General Exceptions	20080926
2	Importing	IV_MSG_NO	Call by reference	☑	Type reference (TYPE)	SYMSGNO		Message Number	20080926
3	Importing	IV_MSG_VAR1	Call by reference	☑	Type reference (TYPE)	SYMSGV		Message Variable	20080926
4	Importing	IV_MSG_VAR2	Call by reference	☑	Type reference (TYPE)	SYMSGV		Message Variable	20080926

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20080926

Method SEND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGE	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20111102
2	Exporting	ET_RECIPIENT_USER_EXCLUDED	Value transfer	☐	Type reference (TYPE)	GRFN_T_RECIPIENT_USER		Recipients defined by user name	20100723
3	Importing	IO_SESSION	Call by reference	☑	Object reference (TYPE REF TO)	CL_GRFN_API_SESSION		Session Management for GRC APIs	20080925
4	Importing	IT_ATTACHMENT	Call by reference	☑	Type reference (TYPE)	GRFN_T_NOTIFICATION_ATTACHMENT		Notification Attachments	20110908
5	Importing	IT_RECIPIENT_EMAIL	Call by reference	☑	Type reference (TYPE)	GRFN_T_RECIPIENT_EMAIL		Recipients defined by e-mail-address	20081022
6	Importing	IT_RECIPIENT_USER	Call by reference	☑	Type reference (TYPE)	GRFN_T_RECIPIENT_USER		Recipients defined by user name	20081022
7	Importing	IT_VARIABLE	Call by reference	☑	Type reference (TYPE)	GRFN_T_MSG_VARIABLE		Variables used in notifications	20080925
8	Importing	IV_AGENTSLOT	Call by reference	☑	Type reference (TYPE)	GRFN_AGENTSLOT		Business Event	20080925
9	Importing	IV_ALLOW_END_USER_SUPRESSION	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Allow end users to suppres this notification	20100723
10	Importing	IV_ATTACHMENT_DATA	Call by reference	☑	Type reference (TYPE)	XSTRING			20080929
11	Importing	IV_ATTACHMENT_SUBJECT	Value transfer	☑	Type reference (TYPE)	SO_OBJ_DES		Short description of contents	20100722
12	Importing	IV_ATTACHMENT_TYPE	Call by reference	☑	Type reference (TYPE)	SO_OBJ_TP		Code for document class	20080929
13	Importing	IV_COMMIT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Direct send	20100810
14	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	LANGU	SY-LANGU	Language Key	20080929
15	Importing	IV_MESSAGE_CLASS	Call by reference	☐	Type reference (TYPE)	SYMSGID		Message Class	20090225
16	Importing	IV_MESSAGE_NO	Call by reference	☐	Type reference (TYPE)	SYMSGNO		Message Number	20080929
17	Importing	IV_OBJECT_ID	Call by reference	☑	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20080926
18	Importing	IV_REGULATION_ID	Call by reference	☑	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20090225
19	Importing	IV_SENDER	Call by reference	☑	Type reference (TYPE)	UNAME		User Name	20080926

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20080925

Method SEND_EXTENDED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RECIPIENT_USER_EXCLUDED	Value transfer	☐	Type reference (TYPE)	GRFN_T_RECIPIENT_USER		Recipients defined by user name	20110428
2	Importing	IO_SESSION	Call by reference	☑	Object reference (TYPE REF TO)	CL_GRFN_API_SESSION		Session Management for GRC APIs	20110428
3	Importing	IT_RECIPIENT_EMAIL	Call by reference	☑	Type reference (TYPE)	GRFN_T_RECIPIENT_EMAIL		Recipients defined by e-mail-address	20110428
4	Importing	IT_RECIPIENT_USER	Call by reference	☑	Type reference (TYPE)	GRFN_T_RECIPIENT_USER		Recipients defined by user name	20110428
5	Importing	IT_VARIABLE	Call by reference	☑	Type reference (TYPE)	GRFN_T_MSG_VARIABLE		Variables used in notifications	20110428
6	Importing	IV_AGENTSLOT	Call by reference	☑	Type reference (TYPE)	GRFN_AGENTSLOT		Business Event	20110428
7	Importing	IV_ALLOW_END_USER_SUPRESSION	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Allow end users to suppres this notification	20110428
8	Importing	IV_ATTACHMENT_DATA	Call by reference	☑	Type reference (TYPE)	XSTRING			20110428
9	Importing	IV_ATTACHMENT_SUBJECT	Value transfer	☑	Type reference (TYPE)	SO_OBJ_DES		Short description of contents	20110428
10	Importing	IV_ATTACHMENT_TYPE	Call by reference	☑	Type reference (TYPE)	SO_OBJ_TP		Code for document class	20110428
11	Importing	IV_COMMIT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Direct send	20110428
12	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	LANGU	SY-LANGU	Language Key	20110428
13	Importing	IV_MESSAGE_CLASS	Call by reference	☐	Type reference (TYPE)	SYMSGID		Message Class	20110428
14	Importing	IV_MESSAGE_NO	Call by reference	☐	Type reference (TYPE)	SYMSGNO		Message Number	20110428
15	Importing	IV_OBJECT_ID	Call by reference	☑	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20110428
16	Importing	IV_REGULATION_ID	Call by reference	☑	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20110428
17	Importing	IV_SENDER	Call by reference	☑	Type reference (TYPE)	UNAME		User Name	20110428

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20110428

Method SEND_TO_AGENTSLOT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGE	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20111102
2	Exporting	ET_RECIPIENT_USER_EXCLUDED	Value transfer	☐	Type reference (TYPE)	GRFN_T_RECIPIENT_USER		Recipients defined by user name	20100723
3	Importing	IO_SESSION	Call by reference	☐	Object reference (TYPE REF TO)	CL_GRFN_API_SESSION		Session Management for GRC APIs	20090908
4	Importing	IT_VARIABLE	Call by reference	☑	Type reference (TYPE)	GRFN_T_MSG_VARIABLE		Variables used in notifications	20090908
5	Importing	IV_AGENTSLOT	Call by reference	☐	Type reference (TYPE)	GRFN_AGENTSLOT		Business Event	20090908
6	Importing	IV_ALLOW_END_USER_SUPRESSION	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20100723
7	Importing	IV_ATTACHMENT_DATA	Call by reference	☑	Type reference (TYPE)	XSTRING			20090908
8	Importing	IV_ATTACHMENT_TYPE	Call by reference	☑	Type reference (TYPE)	SO_OBJ_TP		Code for document class	20090908
9	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	LANGU	SY-LANGU	Language Key	20090908
10	Importing	IV_MESSAGE_CLASS	Call by reference	☐	Type reference (TYPE)	SYMSGID		Message Class	20090908
11	Importing	IV_MESSAGE_NO	Call by reference	☐	Type reference (TYPE)	SYMSGNO		Message Number	20090908
12	Importing	IV_OBJECT_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20090908
13	Importing	IV_REGULATION_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20090908
14	Importing	IV_SENDER	Call by reference	☑	Type reference (TYPE)	UNAME		User Name	20090908

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20090908

Method SEND_TO_EMAILADDRESS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGE	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20111102
2	Exporting	ET_RECIPIENT_USER_EXCLUDED	Value transfer	☐	Type reference (TYPE)	GRFN_T_RECIPIENT_USER		Recipients defined by user name	20100723
3	Importing	IT_RECIPIENT_EMAIL	Call by reference	☐	Type reference (TYPE)	GRFN_T_RECIPIENT_EMAIL		Recipients defined by e-mail-address	20090908
4	Importing	IT_VARIABLE	Call by reference	☑	Type reference (TYPE)	GRFN_T_MSG_VARIABLE		Variables used in notifications	20090908
5	Importing	IV_ALLOW_END_USER_SUPRESSION	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20100723
6	Importing	IV_ATTACHMENT_DATA	Call by reference	☑	Type reference (TYPE)	XSTRING			20090908
7	Importing	IV_ATTACHMENT_TYPE	Call by reference	☑	Type reference (TYPE)	SO_OBJ_TP		Code for document class	20090908
8	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	LANGU	SY-LANGU	Language Key	20090908
9	Importing	IV_MESSAGE_CLASS	Call by reference	☐	Type reference (TYPE)	SYMSGID		Message Class	20090908
10	Importing	IV_MESSAGE_NO	Call by reference	☐	Type reference (TYPE)	SYMSGNO		Message Number	20090908
11	Importing	IV_SENDER	Call by reference	☑	Type reference (TYPE)	UNAME		User Name	20090908

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20090908

Method SEND_TO_USERNAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGE	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20111102
2	Exporting	ET_RECIPIENT_USER_EXCLUDED	Value transfer	☐	Type reference (TYPE)	GRFN_T_RECIPIENT_USER		Recipients defined by user name	20100723
3	Importing	IT_RECIPIENT_USER	Call by reference	☐	Type reference (TYPE)	GRFN_T_RECIPIENT_USER		Recipients defined by user name	20090908
4	Importing	IT_VARIABLE	Call by reference	☑	Type reference (TYPE)	GRFN_T_MSG_VARIABLE		Variables used in notifications	20090908
5	Importing	IV_ALLOW_END_USER_SUPRESSION	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20100723
6	Importing	IV_ATTACHMENT_DATA	Call by reference	☑	Type reference (TYPE)	XSTRING			20090908
7	Importing	IV_ATTACHMENT_TYPE	Call by reference	☑	Type reference (TYPE)	SO_OBJ_TP		Code for document class	20090908
8	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	LANGU	SY-LANGU	Language Key	20090908
9	Importing	IV_MESSAGE_CLASS	Call by reference	☐	Type reference (TYPE)	SYMSGID		Message Class	20090908
10	Importing	IV_MESSAGE_NO	Call by reference	☐	Type reference (TYPE)	SYMSGNO		Message Number	20090908
11	Importing	IV_SENDER	Call by reference	☑	Type reference (TYPE)	UNAME		User Name	20090908

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20090908

History

Last changed by/on	SAP	20141106
SAP Release Created in	300