FM_CTS_CONFIG_WD_VAL_SYSTEM SAP Function module - Central CTS Configuration - Function Module for Validating Systems

FM_CTS_CONFIG_WD_VAL_SYSTEM 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 FM_CTS_CONFIG_WD_VAL_SYSTEM into the relevant SAP transaction such as SE37 or SE80.

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

Pattern for FM FM_CTS_CONFIG_WD_VAL_SYSTEM - FM CTS CONFIG WD VAL SYSTEM

CALL FUNCTION 'FM_CTS_CONFIG_WD_VAL_SYSTEM' "Central CTS Configuration - Function Module for Validating Systems
  EXPORTING
    iv_session_id =             " guid_16       Session ID
    iv_event_id =               " wdr_notification_id  Unique ID of Registration (= Event ID)
    iv_instance_name =          " shm_inst_name  Name of a Shared Object Instance of an Area
    iv_system_to_be_validated =   " sysysid     Name/ID of the SAP System to be validated
    iv_cluster_to_be_validated =   " sysysid    Name/ID of the Cluster to be validated
    iv_system_domain =          " tmsdomnam     Domain of the System
    iv_cluster_domain =         " tmsdomnam     Domain of the Cluster
    iv_client =                 " symandt       Client ID
  EXCEPTIONS
    SHARED_MEMORY_INCONSISTENT = 1  "           Shared Memory - Differing Definitions between Program and Area
    SHARED_MEMORY_EXCL_LOCK_ACTIVE = 2  "       Shared Memory - The Instance is already locked
    SHARED_MEMORY_VERSION_LIMIT = 3  "          Shared Memory - The Version Limit has been exceeded
    SHARED_MEMORY_CHAN_LOCK_ACTIVE = 4  "       Shared Memory - A Change Lock is already active
    SHARED_MEMORY_PARAMETER_ERROR = 5  "        Shared Memory - Incorrect Parameter(s) transferred
    SHARED_MEMORY_LOCK_REMOVED = 6  "           Shared Memory - A waiting Lock was deleted
    SHARED_MEMORY_UPDATE_FAILED = 7  "          Shared Memory - The Update on the Shared Memory failed
    .  "  FM_CTS_CONFIG_WD_VAL_SYSTEM

ABAP code example for Function Module FM_CTS_CONFIG_WD_VAL_SYSTEM

The ABAP code below is a full code listing to execute function module FM_CTS_CONFIG_WD_VAL_SYSTEM 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_iv_session_id) = 'Check type of data required'.

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

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

DATA(ld_iv_system_to_be_validated) = '20210129'.

DATA(ld_iv_cluster_to_be_validated) = '20210129'.

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

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

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

CALL FUNCTION 'FM_CTS_CONFIG_WD_VAL_SYSTEM'
  EXPORTING
    iv_session_id =              ld_iv_session_id
    iv_event_id =                ld_iv_event_id
    iv_instance_name =           ld_iv_instance_name
    iv_system_to_be_validated =    ld_iv_system_to_be_validated
    iv_cluster_to_be_validated =    ld_iv_cluster_to_be_validated
    iv_system_domain =           ld_iv_system_domain
    iv_cluster_domain =          ld_iv_cluster_domain
    iv_client =                  ld_iv_client
  EXCEPTIONS
    SHARED_MEMORY_INCONSISTENT =    1
    SHARED_MEMORY_EXCL_LOCK_ACTIVE =    2
    SHARED_MEMORY_VERSION_LIMIT =    3
    SHARED_MEMORY_CHAN_LOCK_ACTIVE =    4
    SHARED_MEMORY_PARAMETER_ERROR =    5
    SHARED_MEMORY_LOCK_REMOVED =    6
    SHARED_MEMORY_UPDATE_FAILED =    7
    .  "  FM_CTS_CONFIG_WD_VAL_SYSTEM

IF SY-SUBRC EQ 0.
  "All OK
ELSEIF SY-SUBRC EQ 1. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 2. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 3. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 4. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 5. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 6. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 7. "Exception
  "Add code for exception here
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_iv_session_id
 
 TYPE GUID_16 ,
ld_iv_event_id
 
 TYPE WDR_NOTIFICATION_ID ,
ld_iv_instance_name
 
 TYPE SHM_INST_NAME ,
ld_iv_system_to_be_validated
 
 TYPE SYSYSID ,
ld_iv_cluster_to_be_validated
 
 TYPE SYSYSID ,
ld_iv_system_domain
 
 TYPE TMSDOMNAM ,
ld_iv_cluster_domain
 
 TYPE TMSDOMNAM ,
ld_iv_client
 
 TYPE SYMANDT .


ld_iv_session_id = 'Check type of data required'.
ld_iv_event_id = 'Check type of data required'.
ld_iv_instance_name = 'Check type of data required'.
ld_iv_system_to_be_validated = 'Check type of data required'.
ld_iv_cluster_to_be_validated = 'Check type of data required'.
ld_iv_system_domain = 'Check type of data required'.
ld_iv_cluster_domain = 'Check type of data required'.
ld_iv_client = 'Check type of data required'.