SAP ARCHIVE_PROTOCOL_COLLECT Function Module for Transfer Message for the Object Log

Search SAP Function Modules

ARCHIVE_PROTOCOL_COLLECT is a standard archive protocol collect SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Transfer Message for the Object Log 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 archive protocol collect FM, simply by entering the name ARCHIVE_PROTOCOL_COLLECT into the relevant SAP transaction such as SE37 or SE38.

Function Group: APROT
Program Name: SAPLAPROT
Main Program: SAPLAPROT
Appliation area:
Release date: N/A
Mode(Normal, Remote etc): Normal Function Module
Update:

Function ARCHIVE_PROTOCOL_COLLECT 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 'ARCHIVE_PROTOCOL_COLLECT'"Transfer Message for the Object Log
  EXPORTING
*  I_OBJECT =  "Object (Document, Order, and So On) for Which a Message Is Transferred
*  I_CALLBACK_PARAMETER =  "Callback Parameter for Object Details
*  I_PROTOCOL_DATA =  "Special Function: Transfer of Log Data (for Example, from aRFC Child Processes)
*  I_PROTOCOL_HANDLE =  "Special Function: Handle on a Log, If More Than One Is Created
*  I_TEXT =  "Message Text (If I_MSGID and I_MSGNO Are Not Used)
*  I_MSGTYPE =  "Message Type (1= Processed, 2= Not Processed, 3= Other)
*  I_MSGID =  "Message Class (If I_TEXT Is Not Used)
*  I_MSGNO =  "Message Number (If I_TEXT Is Not Used)
*  I_MSGV1 =  "Message Variable
*  I_MSGV2 =  "Message Variable
*  I_MSGV3 =  "Message Variable
*  I_MSGV4 =  "Message Variable

EXCEPTIONS
   PROTOCOL_NOT_YET_INITIALIZED = 1 

.

IMPORTING Parameters details for ARCHIVE_PROTOCOL_COLLECT

I_OBJECT - Object (Document, Order, and So On) for Which a Message Is Transferred

Data type: ANY
Optional: Yes
Call by Reference: Yes

I_CALLBACK_PARAMETER - Callback Parameter for Object Details

Data type: BAL_S_PARM
Optional: Yes
Call by Reference: Yes

I_PROTOCOL_DATA - Special Function: Transfer of Log Data (for Example, from aRFC Child Processes)

Data type: XSTRING
Optional: Yes
Call by Reference: Yes

I_PROTOCOL_HANDLE - Special Function: Handle on a Log, If More Than One Is Created

Data type: BALLOGHNDL
Optional: Yes
Call by Reference: Yes

I_TEXT - Message Text (If I_MSGID and I_MSGNO Are Not Used)

Data type: ANY
Optional: Yes
Call by Reference: Yes

I_MSGTYPE - Message Type (1= Processed, 2= Not Processed, 3= Other)

Data type: ANY
Optional: Yes
Call by Reference: Yes

I_MSGID - Message Class (If I_TEXT Is Not Used)

Data type: SY-MSGID
Optional: Yes
Call by Reference: Yes

I_MSGNO - Message Number (If I_TEXT Is Not Used)

Data type: SY-MSGNO
Optional: Yes
Call by Reference: Yes

I_MSGV1 - Message Variable

Data type: ANY
Optional: Yes
Call by Reference: Yes

I_MSGV2 - Message Variable

Data type: ANY
Optional: Yes
Call by Reference: Yes

I_MSGV3 - Message Variable

Data type: ANY
Optional: Yes
Call by Reference: Yes

I_MSGV4 - Message Variable

Data type: ANY
Optional: Yes
Call by Reference: Yes

EXCEPTIONS details

PROTOCOL_NOT_YET_INITIALIZED - No Log Exists for the Transferred Handle

Data type:
Optional: No
Call by Reference: Yes

Copy and paste ABAP code example for ARCHIVE_PROTOCOL_COLLECT 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 ARCHIVE_PROTOCOL_COLLECT

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