SAP /IXOS/RSA_API_STREAM Function Module for Render document to file: single processing (RFC enabled)

Search SAP Function Modules

/IXOS/RSA_API_STREAM is a standard /ixos/rsa api stream SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Render document to file: single processing (RFC enabled) 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 /ixos/rsa api stream FM, simply by entering the name /IXOS/RSA_API_STREAM into the relevant SAP transaction such as SE37 or SE38.

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

Function /IXOS/RSA_API_STREAM 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 '/IXOS/RSA_API_STREAM'"Render document to file: single processing (RFC enabled)
  EXPORTING
*  PI_TARGET_DIRECTORY =  "Data element: UNC path, CHAR 255 cs
*  PIS_FILE =  "Structure: Stream Documents
*  PIT_EMAIL =  "Not in USE anymore
*  PIT_PRINTER =  "Not in USE anymore
   PI_RS_ID =  "Not in USE anymore
*  PIT_CUST_HEADER =  "Table type for Rendition Service header properties
*  PIT_CUST_BODY =  "HTTP Framework (iHTTP) Table Name/Value Pairs
*  PIT_DOC_CHAR =  "Document
*  PI_SOURCE_TYPE =  "X-Content Type
*  PI_OUTPUT_TYPE =  "Data Element: Target
*  PI_TARGET_TYPE = 'application/pdf' "X-Content Type
*  PI_FILELENGTH =  "Filelength
*  PI_CONTENT_TYPE =  "X-Content Type
*  PI_DOC_MODE = 'C' "Not in USE anymore
*  PIT_DOC_RAW =  "Not in USE anymore

 IMPORTING
   PES_RETURN =  "Return parameter
   PET_RESPONSE =  "Table Type: HTTP Response
   PE_RESPONSE_LENGTH =  "Response Length
   PE_RSA_PROT_GUID =  "Main job GUID as used in table /IXOS/RSA_T_PROT

CHANGING
*  PCT_SESSION =  "Table type for RSA structure session

EXCEPTIONS
   EX_RS_ERROR = 1    EX_PROTOCOL = 10    EX_HOSTNAME = 11    EX_PORT = 12    EX_SERVICE = 13    EX_VERSION = 14    EX_CUSTOM = 15    EX_TIMEOUT = 16    ERROR_SIGNATURE = 17    ERROR_PARAMETER = 18    UNDEFINED = 19    EX_NO_CONFIGURATION = 2    EX_NO_PRINTER_CONFIGURED = 20    EX_TOO_MANY_DOCUMENTS = 21    MIME_TYPE_NOT_ALLOWED = 22    HTTP_COMMUNICATION_FAILURE = 3    HTTP_INVALID_STATE = 4    HTTP_PROCESSING_FAILED = 5    HTTP_INVALID_TIMEOUT = 6    ARGUMENT_NOT_FOUND = 7    PLUGIN_NOT_ACTIVE = 8    INTERNAL_ERROR = 9 

.

IMPORTING Parameters details for /IXOS/RSA_API_STREAM

PI_TARGET_DIRECTORY - Data element: UNC path, CHAR 255 cs

Data type: /IXOS/DC_E_UNC_PATH
Optional: Yes
Call by Reference: No ( called with pass by value option)

PIS_FILE - Structure: Stream Documents

Data type: /IXOS/RSA_S_SOURCE_DOC_STREAM
Optional: Yes
Call by Reference: No ( called with pass by value option)

PIT_EMAIL - Not in USE anymore

Data type: /IXOS/RSA_TT_EMAIL_OPTIONS
Optional: Yes
Call by Reference: No ( called with pass by value option)

PIT_PRINTER - Not in USE anymore

Data type: /IXOS/RSA_TT_PRINTER_OPTIONS
Optional: Yes
Call by Reference: No ( called with pass by value option)

PI_RS_ID - Not in USE anymore

Data type: /IXOS/RSA_E_RS_ID
Optional: No
Call by Reference: Yes

PIT_CUST_HEADER - Table type for Rendition Service header properties

Data type: /IXOS/RSA_T_IHTTP
Optional: Yes
Call by Reference: No ( called with pass by value option)

PIT_CUST_BODY - HTTP Framework (iHTTP) Table Name/Value Pairs

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

PIT_DOC_CHAR - Document

Data type: /IXOS/RSA_TT_DOCUMENT
Optional: Yes
Call by Reference: No ( called with pass by value option)

PI_SOURCE_TYPE - X-Content Type

Data type: /IXOS/RSA_E_XCONTENTTYPE
Optional: Yes
Call by Reference: No ( called with pass by value option)

PI_OUTPUT_TYPE - Data Element: Target

Data type: /IXOS/RSA_E_TARGET
Optional: Yes
Call by Reference: No ( called with pass by value option)

PI_TARGET_TYPE - X-Content Type

Data type: /IXOS/RSA_E_XCONTENTTYPE
Default: 'application/pdf'
Optional: Yes
Call by Reference: No ( called with pass by value option)

PI_FILELENGTH - Filelength

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

PI_CONTENT_TYPE - X-Content Type

Data type: /IXOS/RSA_E_XCONTENTTYPE
Optional: Yes
Call by Reference: No ( called with pass by value option)

PI_DOC_MODE - Not in USE anymore

Data type: C
Default: 'C'
Optional: Yes
Call by Reference: No ( called with pass by value option)

PIT_DOC_RAW - Not in USE anymore

Data type: /IXOS/RSA_TT_TBL1024
Optional: Yes
Call by Reference: No ( called with pass by value option)

EXPORTING Parameters details for /IXOS/RSA_API_STREAM

PES_RETURN - Return parameter

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

PET_RESPONSE - Table Type: HTTP Response

Data type: STANDARD TABLE
Optional: No
Call by Reference: Yes

PE_RESPONSE_LENGTH - Response Length

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

PE_RSA_PROT_GUID - Main job GUID as used in table /IXOS/RSA_T_PROT

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

CHANGING Parameters details for /IXOS/RSA_API_STREAM

PCT_SESSION - Table type for RSA structure session

Data type: /IXOS/RSA_ENT_TT_SESSION
Optional: Yes
Call by Reference: No ( called with pass by value option)

EXCEPTIONS details

EX_RS_ERROR - Error Rendition Server

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

EX_PROTOCOL - Protocol not maintained

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

EX_HOSTNAME - Hostname not maintained

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

EX_PORT - Port not maintained

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

EX_SERVICE - Service not maintained

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

EX_VERSION - Version not maintained

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

EX_CUSTOM - No RS Customizing found

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

EX_TIMEOUT - Timeout not maintained

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

ERROR_SIGNATURE - Archivelink Signature

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

ERROR_PARAMETER - Archivelink parameter

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

UNDEFINED - Archivelink other

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

EX_NO_CONFIGURATION - No Configuration for Rendition Server found

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

EX_NO_PRINTER_CONFIGURED - No printer configured

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

EX_TOO_MANY_DOCUMENTS - too many documents choosen

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

MIME_TYPE_NOT_ALLOWED - Mime_Type_Not_alowed

Data type:
Optional: No
Call by Reference: Yes

HTTP_COMMUNICATION_FAILURE - Communication Error

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

HTTP_INVALID_STATE - Invalid Status

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

HTTP_PROCESSING_FAILED - Error When Processing Method

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

HTTP_INVALID_TIMEOUT - Invalid Time Entry

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

ARGUMENT_NOT_FOUND - Communication Parameters (Host or Service) Not Available

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

PLUGIN_NOT_ACTIVE - HTTP/HTTPS Communication Not Available

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

INTERNAL_ERROR - Internal Error (e.g. name too long)

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

Copy and paste ABAP code example for /IXOS/RSA_API_STREAM 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 /IXOS/RSA_API_STREAM

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