SAP SO_SUBSTITUTE_ACTIVATE Function Module for SAPoffice: Activate proxy

Search SAP Function Modules

SO_SUBSTITUTE_ACTIVATE is a standard so substitute activate 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: Activate proxy 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 substitute activate FM, simply by entering the name SO_SUBSTITUTE_ACTIVATE 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): Normal Function Module
Update:

Function SO_SUBSTITUTE_ACTIVATE 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_SUBSTITUTE_ACTIVATE'"SAPoffice: Activate proxy
  EXPORTING
   COUNTER =  "Counter of the activation time of the substitute
*  SUBBEGDAT = ' ' "Start date of active phase
*  SUBBEGTIM = ' ' "Starting time of active phase
*  SUBENDDAT = ' ' "End date of active phase
*  SUBENDTIM = ' ' "End time of active phase
*  SUBSTITUTE = ' ' "Substitute Office name
*  USER = ' ' "User Office name

EXCEPTIONS
   ACTIVE_USER_NOT_EXIST = 1    USER_NOT_EXIST = 10    COMPONENT_NOT_AVAILABLE = 2    NEW_DATE_WRONG = 3    OPERATION_NO_AUTHORIZATION = 4    SUBSTITUTE_EQUAL_USER = 5    SUBSTITUTE_NOT_DEFINED = 6    SUBSTITUTE_NOT_EXIST = 7    TIME_OVERLAPP = 8    X_ERROR = 9 

.

IMPORTING Parameters details for SO_SUBSTITUTE_ACTIVATE

COUNTER - Counter of the activation time of the substitute

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

SUBBEGDAT - Start date of active phase

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

SUBBEGTIM - Starting time of active phase

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

SUBENDDAT - End date of active phase

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

SUBENDTIM - End time of active phase

Data type: SOSU-SETIM
Default: SPACE
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)

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)

USER_NOT_EXIST -

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)

NEW_DATE_WRONG - Incorrect period

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

OPERATION_NO_AUTHORIZATION - No authorization for this operation

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

SUBSTITUTE_EQUAL_USER - SUBSTITUTE and USER are identical

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)

TIME_OVERLAPP - Time overlap with other data record

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_SUBSTITUTE_ACTIVATE 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_SUBSTITUTE_ACTIVATE

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