User Exits

Some of the process definitions provided by the System Copy module observe user exits.

User exits are defined as special tables. Each user exit is represented by a table SAPSystemCopy_UserExit_<User exit name> eg. user exit BatchJob will be represented by table SAPSystemCopy_UserExit_BatchJobs.

Each user exit table must only be created from the user exit specific table definition. A new table can be created by right clicking on the applicable table definition. It is important to use exactly the same name as the table definition name and matching case. It is also important to create the table in the partition System Copy was installed.

After you have configured the user exists you want to use, you can verify your settings by submitting the process definition SCP_Verify_Configuration. You should see all the rows defined in the user exist in the output of the verify process.

User exit: BatchJob

This user exit is called when the System Copy module deletes SAP jobs.

Table SAPSystemCopy_UserExit_BatchJobs

Display Order	Column Name	Nullable	Data Type
1	CONFIG_NAME	true	String
2	OPTION	false	String
3	CLIENT	true	String
4	JOBNAME	true	String
5	CREATOR	true	String
6	JOBCLASS	true	String
7	STATUS	true	String
8	ACTION	true	String

By default, that is if the user exit is not defined, all SAP jobs are deleted except those, which fulfill one of the following criteria:

• The Process name starts with
  • RDDIMPDP
  • SWEQSRV
  • SWWCLEAR
  • SWWCOND
  • SWWDHEX
  • SWWERRE
  • SAP_REORG_
  • SAP_SLD
  • SAP_CCMS
  • RSBKCHECKBUFFER
  • EU_PUT
  • EU_REORG
• The process was created by
  • DDIC
  • SAP*
  • SPAMUSER
  • EARLYWATCH
  • TMSADM
  • WF_BATCH
  • WF-BATCH

These criteria are also applied before consulting the user exit. For instance a process with the name starting with "RDDIMPDP" is never deleted.

Column CONFIG_NAME is optional and all other columns may be completed with a full or wildcard string. The data in these columns will be used to match the jobs to be deleted. The OPTION column must contain I to include or E to exclude the row data.

User exit: BDLS

This user exit is called during BDLS.

The table for this user exit is SAPSystemCopy_UserExit_BDLS. Create this table by using the table definition SAP_SystemCopy_UserExit_BDLS, which is part of the System Copy module.

During the post-processing, all logical systems defined in BD54 in the target system (which typically would have come over from the source system) are examined and for each the BDLS user exit is called.

Table SAPSystemCopy_UserExit_BDLS

Display Order	Column Name	Nullable	Data Type
1	CONFIG_NAME	true	String
2	OLD_LSN	false	String
3	NEW_LSN	false	String
4	NEW_DESCRIPTION	true	String
5	STRATEGY	true	String

The value of the CONFIG_NAME column determines to which configurations the remaining values of the record are applied. It is possible to use the character '*' (star) as a wildcard. If this value is left empty, then the record is considered to apply to all configurations.

The value OLD_LSN determines the name of the logical system name which comes over from the source SAP system and needs to be converted to the value defined in the NEW_LSN field.

If the value of the field NEW_DESCRIPTION is set, then this value is set as the description of the logical system of the target SAP system after the BDLS run.

The field STRATEGY is reserved for future use and is best left empty for the moment.

note

The old logical system needs to be defined in the target system before BDLS. The user exit is called only for logical systems defined in BD54.

Example

Key	CONFIG_NAME	OLD_LSN	NEW_LSN
1	PEA_TO_QEA	PEACLNT300	QEACLNT300

When running BDLS through the System Copy module for the configuration PEA_TO_QUE the following steps will be performed in the target SAP system:

1. The logical system QEACLNT300 will be deleted from BD54
2. The logical system PEACLNT300 will be converted to QEACLNT300
3. The description of the logical system QEACLNT300 will be set to 'QEA Client 300'

All other logical systems in the target SAP system will NOT be converted.

User exit: BW_Connect

This user exit is called when the BW source systems are reconnected through the System Copy module.

Display Order	Column Name	Nullable	Data Type
1	CONFIG_NAME	true	String
2	SLOGSYS	false	String
3	RLOGSYS	false	String

All BW source systems defined by this user exit are reconnected to the refreshed BW system.

User exit: BW_Disconnect

This user exit is called when the BW source systems are disconnected or reconnected through the System Copy module.

Display Order	Column Name	Nullable	Data Type
1	CONFIG_NAME	true	String
2	SLOGSYS	false	String
3	RLOGSYS	false	String

BW source systems are stored in the SAP table RSBASIDOC. As part of the refresh process, all BW source systems configured via this user exit are automatically disconnected.

User exit: IDocFile

This user exit is called when the System Copy module converts directories.

Display Order	Column Name	Nullable	Data Type
1	CONFIG_NAME	true	String
2	FILE_PORT	false	String
3	INPUT_DIRECTORY	true	String
4	NEW_INPUT_DIRECTORY	true	String
5	OUTPUT_DIRECTORY	true	String
6	NEW_OUTPUT_DIRECTORY	true	String

This user exit is used to convert the input and output directories and their respective descriptions from the target system to the source system.

The value of the CONFIG_NAME column determines to which configurations the remaining values of the record are applied. It is possible to use the character '*' (star) as a wildcard. If this value is left empty, then the record is considered to apply to all configurations.

The field FILE_PORT determines the file port of the SAP system which needs to be converted.

User exit: LogonGroups

This user exit is called when the System Copy module manipulates logon groups.

Display Order	Column Name	Nullable	Data Type
1	CONFIG_NAME	true	String
2	GROUP	false	String
3	SERVER	true	String

This user exit is used to fix the logon groups of the target system.

This process is performed in two steps:

1. Loop over all configured logon groups in the target system, which at this stage typically reflect those from the source system. All assignments of application server to logon groups NOT matching the ones configured by this user exit are removed.
2. Loop over all application servers of the target system and check if they need to be assigned to a logon group. Create the assignment if it doesn't exist yet.

User exit: OutputDevices

This user exit is called when the System Copy module converts spool servers of the output devices.

Display Order	Column Name	Nullable	Data Type
1	CONFIG_NAME	true	String
2	OUTPUT_DEVICE	false	String
3	SPOOL_SERVER	false	String
4	NEW_SPOOL_SERVER	false	String

User exit: ProfileActivation

As part of the refresh process the profiles of all active application servers of a target SAP system are imported. Quite often these profiles contain obsolete or wrong values. These values result in errors in RZ10, which are typically ignored by users. This user exit allows defining which errors in profiles can be safely ignored.

Display Order	Column Name	Nullable	Data Type
1	CONFIG_NAME	true	String
2	MESSAGE_TYPE	true	String
3	MESSAGE_TEXT	false	String
4	ACTION	true	String

Possible actions are "Ignore" and "Error".

By default the System Copy module creates a predefined user exit, which specifies that the error messages starting with j2ee/dbname change not permitted be ignored for all refresh configurations.

In general, errors in RZ10 should be investigated and fixed rather than ignored.

User exit: QRFC

This user exit is called when the System Copy module converts QRFC settings.

Display Order	Column Name	Nullable	Data Type
1	CONFIG_NAME	true	String
2	DESTINATION	false	String

User exit: ServerGroups

This user exit is called when the System Copy module manipulates server groups.

Display Order	Column Name	Nullable	Data Type
1	CONFIG_NAME	true	String
2	GROUP	false	String
3	SERVER	true	String

This user exit is used to fix the server groups of the target system.

This process is performed in two steps:

1. Loop over all configured server groups in the target system, which at this stage typically reflect those from the source system. All assignments of application server to server groups NOT matching the ones configured by this user exit are removed.
2. Loop over all application servers of the target system and check if they need to be assigned to a server group. Create the assignment if it doesn't exist yet.

User exit: SPRO

This user exit is called when the System Copy module converts SPRO settings.

Display Order	Column Name	Nullable	Data Type
1	CONFIG_NAME	true	String
2	LSN	false	String
3	OLD_DESTINATION	false	String
4	NEW_DESTINATION	true	String

User exit: User

This user exit is called when the System Copy module locks or unlocks SAP users.

Display Order	Column Name	Nullable	Data Type
1	CONFIG_NAME	true	String
2	OPTION	false	String
3	USERNAME	false	String
4	AUTHORIZATION_GROUP	true	String
5	CONTEXT	true	String

Example

Key	CONFIG_NAME	OPTION	USERNAME	AUTHORIZATION_GROUP
010		E	USERNAME1
011		E	USERNAME2
012		E	BKU*
015		E	*	SAPBASIS

This will lock all users but

• users with the user names USERNAME1 and USERNAME2
• users whose user names start with BKU
• users who belong to the authorization group SAPBASIS

The OPTION column must contain I to include or E to exclude the row data. The CONTEXT column can be used to group rows of data together when manually running the lock/unlock process definitions (SCP_SU01_Control_Users) but can be left blank by default.

See Also

SAP System Copy

sscpTopic