Kontakt

Ansicht
Dokumentation

/SAPTRX/CREATE_ALERT - Create an Alert in the Alert Framework

/SAPTRX/CREATE_ALERT - Create an Alert in the Alert Framework

SUBST_MERGE_LIST - merge external lists to one complete list with #if... logic for R3up   PERFORM Short Reference  
This documentation is copyright by SAP AG.
SAP E-Book

Functionality

This function module creates an alert in the Alert Framework. Specify the alert category and other required settings in Customizing for SAP Event Management (SAP EM) under Define Alert Framework Integration to SAP Event Management.

This function module can be used in all activity types.

  • Parameter-2 (Optional): Enter the page type (1. = admin., 2. = EH search, 3. = my list, 4. = quick search).
  • Parameter-3 (Optional): Enter the language.
  • Parameter-4 (Optional): Enter the text header Tracking ID Type and the description Configured field - tracking ID code set.
  • Parameter-5 (Optional): Enter the text header Tracking ID and the description Configured field - tracking ID.
  • Parameter-6 (Optional): Enter an X here if you want to call the Alert Framework synchronously.
  • Parameter-7(Optional): Enter TMS , if you want to call the Alert Framework in the Transportation Management system.

The first parameter is required and defines the activity parameter ID for Alert Framework integration.

Parameters 2 and 3 are optional.

Parameter 2, if specified, defines the dynamic URL link that is used by the Alert Framework and is sent within the e-mail.

Use one of the following values for the dynamic URL link for the Web interface (classic):

  • 1 = Administration page
  • 2 = EH search page
  • 3 = My list page
  • 4 = Quick search page

Use one of the following values for the dynamic URL link for the Web interface (Web Dynpro ABAP):

  • 2 = EH search page
  • 4 = Direct page

If you want to create the URL link for the Web interface (Web Dynpro ABAP), set the Link (Web Interface) field in Customizing for SAP EM under Define Alert Framework Integration to SAP Event Management.

You can use one of the following combinations:

  • Creation of a link for the search page (with logon data):
  • Select 1 Link for Search in the Link (Web Interface) field and do not use Parameter-2 in this activity.

  • Select 3 Link for Search or Direct Link Using Rule Activity in the Link (Web Interface) field and select 2 in Parameter-2 in this activity.

  • Creation of a direct page (without logon data):
  • Select 2 Direct Link in the Link (Web Interface) field and do not use Parameter-2 in this activity.

  • Select 3 Link for Search or Direct Link Using Rule Activity in the Link (Web Interface) field and select 4 in Parameter-2 in this activity.

  • Creation of both a search page and a direct page:
  • Select 2 Direct Link in the Link (Web Interface) field and select 2 in Parameter-2 in this activity.

Parameter 3, if specified, defines the language in which the e-mail is sent by the Alert Framework. You can specify a constant (such as DE for German) or a dynamic value from the metadata (for example, an info or control parameter that contains the language of the user).

Parameters 4 and 5 are optional and define the configured fields for the tracking ID code set and the tracking ID used when parameter 2 has the value 4 = quick search page (dynamic URL link). The quick search function uses these two parameters to access the event handler directly. When you use this activity with these specific parameters, the Alert Framework sends the dynamic URL link to the e-mail recipients, and the users can access the event handler directly without a search.

As a prerequisite, the configured fields should be part of the quick search selection profile.

Parameter 6 should be used for debugging or test purposes only, or in cases where you parallelize event message processing. The default setting is to call the Alert Framework asynchronously.

Return code:

  • 0 - Alert created successfully
  • 1 - Alert creation failed
  • 4 - Customizing for Alert Framework not found
  • 6 - Internet Communication Framework (ICF) configuration is missing
For more information, see Define Alert Framework Integration to SAP Event Management.
  • 8 - ICF configuration and alert configuration do not match
For more information, see Define Alert Framework Integration to SAP Event Management.

Example

Notes

Further information





Parameters

E_RETURN_CODE
I_EAI

Exceptions

Function Group

TRX/SAPLAFINTEGRATION

PERFORM Short Reference   BAL Application Log Documentation  
This documentation is copyright by SAP AG.

Length: 6951 Date: 20240425 Time: 072038     sap01-206 ( 55 ms )