SAP SO_SUBSTITUTION_ACTIVE Function Module for SAPoffice: Active Substitutions

Search SAP Function Modules

SO_SUBSTITUTION_ACTIVE is a standard so substitution active SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for SAPoffice: Active Substitutions processing and below is the pattern details for this FM, showing its interface including any import and export parameters, exceptions etc. there is also a full "cut and paste" ABAP pattern code example, along with implementation ABAP coding, documentation and contribution comments specific to this or related objects.

See here to view full function module documentation and code listing for so substitution active FM, simply by entering the name SO_SUBSTITUTION_ACTIVE into the relevant SAP transaction such as SE37 or SE38.

Function Group: SOA4
Program Name: SAPLSOA4
Main Program:
Appliation area: S
Release date: N/A
Mode(Normal, Remote etc): Remote-Enabled
Update:

Function SO_SUBSTITUTION_ACTIVE pattern details

In-order to call this FM within your sap programs, simply using the below ABAP pattern details to trigger the function call...or see the full ABAP code listing at the end of this article. You can simply cut and paste this code into your ABAP progrom as it is, including variable declarations.

CALL FUNCTION 'SO_SUBSTITUTION_ACTIVE'"SAPoffice: Active Substitutions
  EXPORTING
*  DATUM = SY-DATUM "Date of the desired active phase
*  SUBSTITUTE = ' ' "Substitute Office name
*  USER = ' ' "User Office name
*  UZEIT = SY-UZEIT "Time of day of desired active phase

TABLES
   SUBSTITUTIONS =  "All active substitutions

EXCEPTIONS
   ACTIVE_USER_NOT_EXIST = 1    COMMUNICATION_FAILURE = 2    COMPONENT_NOT_AVAILABLE = 3    SUBSTITUTE_NOT_ACTIVE = 4    SUBSTITUTE_NOT_DEFINED = 5    SUBSTITUTE_NOT_EXIST = 6    SYSTEM_FAILURE = 7    USER_NOT_EXIST = 8    X_ERROR = 9 

.

IMPORTING Parameters details for SO_SUBSTITUTION_ACTIVE

DATUM - Date of the desired active phase

Data type: SY-DATUM
Default: SY-DATUM
Optional: Yes
Call by Reference: No ( called with pass by value option)

SUBSTITUTE - Substitute Office name

Data type: SOUD-USRNAM
Default: SPACE
Optional: Yes
Call by Reference: No ( called with pass by value option)

USER - User Office name

Data type: SOUD-USRNAM
Default: SPACE
Optional: Yes
Call by Reference: No ( called with pass by value option)

UZEIT - Time of day of desired active phase

Data type: SY-UZEIT
Default: SY-UZEIT
Optional: Yes
Call by Reference: No ( called with pass by value option)

TABLES Parameters details for SO_SUBSTITUTION_ACTIVE

SUBSTITUTIONS - All active substitutions

Data type: SOSUY
Optional: No
Call by Reference: No ( called with pass by value option)

EXCEPTIONS details

ACTIVE_USER_NOT_EXIST - Active user does not exist as an Office user

Data type:
Optional: No
Call by Reference: No ( called with pass by value option)

COMMUNICATION_FAILURE -

Data type:
Optional: No
Call by Reference: No ( called with pass by value option)

COMPONENT_NOT_AVAILABLE - SAPoffice component is inactive

Data type:
Optional: No
Call by Reference: No ( called with pass by value option)

SUBSTITUTE_NOT_ACTIVE - Substitute is inactive

Data type:
Optional: No
Call by Reference: No ( called with pass by value option)

SUBSTITUTE_NOT_DEFINED - SUBSTITUTE is a substitute of USER

Data type:
Optional: No
Call by Reference: No ( called with pass by value option)

SUBSTITUTE_NOT_EXIST - Substitute does not exist as Office user

Data type:
Optional: No
Call by Reference: No ( called with pass by value option)

SYSTEM_FAILURE -

Data type:
Optional: No
Call by Reference: No ( called with pass by value option)

USER_NOT_EXIST - Person to be substituted does not exist

Data type:
Optional: No
Call by Reference: No ( called with pass by value option)

X_ERROR - DB error

Data type:
Optional: No
Call by Reference: No ( called with pass by value option)

Copy and paste ABAP code example for SO_SUBSTITUTION_ACTIVE Function Module

The ABAP code below is a full code listing to execute function module POPUP_TO_CONFIRM including all data declarations. The code uses the original data declarations rather than 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 newer method of declaring data variables on the fly. 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), which i why i have stuck to the origianl for this example.

ABAP code using 7.40 inline data declarations to call FM SO_SUBSTITUTION_ACTIVE

The below ABAP code uses the newer in-line data declarations. This allows you to see the coding differences/benefits of the later inline syntax. Please note some of the newer syntax below, such as the @DATA is not available until 4.70 EHP 8.

Search for further information about these or an SAP related objects