DBA_ALERT_CHECK_CONNECTION SAP Function module - DBA: EFWK Wrapper for Database Alert Metrics

DBA_ALERT_CHECK_CONNECTION is a standard SAP function module available within R/3 SAP systems depending on your version and release level. Below is the pattern details for this FM showing its interface including any import and export parameters, exceptions etc as well as any documentation contributions (Comments) specific to the object.

See here to view full function module documentation and code listing, simply by entering the name DBA_ALERT_CHECK_CONNECTION into the relevant SAP transaction such as SE37 or SE80.

Associated Function Group: SDBA_SOLMAN
Released Date: Not Released
Processing type: Remote-Enabled

Pattern for FM DBA_ALERT_CHECK_CONNECTION - DBA ALERT CHECK CONNECTION

CALL FUNCTION 'DBA_ALERT_CHECK_CONNECTION' "DBA: EFWK Wrapper for Database Alert Metrics
  EXPORTING
    dbcname =                   " dbcon_name    Logical name for a database connection
*   bypass_dispatching = ABAP_FALSE  " char1    Bypass dispatching to correct AS for DB type
  IMPORTING
    return_status =             " dba_dbh_return_status  DBA-DBH: Return Status (RC and Message)
    db_is_available =           " alvalue       Alert: alert value (1 = green, 2 = yellow, ....)
    .  "  DBA_ALERT_CHECK_CONNECTION

ABAP code example for Function Module DBA_ALERT_CHECK_CONNECTION

The ABAP code below is a full code listing to execute function module DBA_ALERT_CHECK_CONNECTION including all data declarations. The code uses the latest in-line data DECLARATION SYNTAX but I have included an ABAP code snippet at the end to show how declarations would look using the original method of declaring data variables up front. This will allow you to compare and fully understand the new inline method. Please note some of the newer syntax such as the @DATA is not available until a later 4.70 service pack (SP8).

DATA:
ld_return_status  
 
 TYPE DBA_DBH_RETURN_STATUS
,
ld_db_is_available  
 
 TYPE ALVALUE
.


DATA(ld_dbcname) = 'Check type of data required'.

DATA(ld_bypass_dispatching) = 'Check type of data required'.
.

CALL FUNCTION 'DBA_ALERT_CHECK_CONNECTION'
  EXPORTING
    dbcname =                    ld_dbcname
*   bypass_dispatching =         ld_bypass_dispatching
  IMPORTING
    return_status =              ld_return_status
    db_is_available =            ld_db_is_available
    .  "  DBA_ALERT_CHECK_CONNECTION

IF SY-SUBRC EQ 0.
  "All OK
ENDIF.

ABAP code to compare 7.40 inline data declaration with original syntax

The below ABAP code uses the older none in-line data declarations. This allows you to see the coding differences/benefits of the later inline syntax. It may also be useful if you are using an older version of SAP as some of the newer syntax above, such as the @DATA is not available until 4.70 EHP 8.

DATA:

ld_return_status
 
 TYPE DBA_DBH_RETURN_STATUS ,
ld_dbcname
 
 TYPE DBCON_NAME ,
ld_db_is_available
 
 TYPE ALVALUE ,
ld_bypass_dispatching
 
 TYPE CHAR1 .


ld_dbcname = 'Check type of data required'.
ld_bypass_dispatching = 'Check type of data required'.