To natively execute remote function calls on an SAP BAPI® instance, add a step with an SAP BAPI RFC connection command. For example:
- Interact with SAP BAPI programs
- Stream multidimensional expression (MDX) data extraction queries
Connection Properties
To enable these commands, an IT admin first enables web services for the remote function call (RFC) service to interact with, creates an SAP BAPI RFC connection, and configures its credentials and properties:
| Input |
Detail |
| Username |
Enter the username to authenticate with |
| Password |
Enter the password for the Username input |
| Base URL |
Enter the base URL of the web servics-enabled SAP server, such as https://sap.organization.com
|
Note: All sensitive credentials are automatically encrypted and stored at 2,048-bit encryption.
BAPI_XBP_JOB_ADD_ABAP_STEP
Adds a job step with an Advanced Buisness Application Programming (ABAP) program to a job
Inputs
| Input |
Detail |
| Cookies |
Enter the cookies from the initial BAPI_XMI_LOGON command |
| External Username |
Enter the external username to use with the request; in the XML, the EXTERNAL_USER_NAME value |
| Job Count |
Enter the count of the job to add a step to; in the XML, the JOBCOUNT value |
| Job Name |
Enter the name of the job to add a step to; in the XML, the JOBNAME value |
| Program Name |
Enter the name of the program to add to the job |
| Variant Name |
Enter the name of the variant |
| SAP Username |
Enter the username of the SAP user to use |
Outputs
| Output |
Output Type |
| Response |
JSON |
| Return |
JSON |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
The command failed to execute |
| 2 |
Error |
Unable to authenticate with the SAP server |
BAPI_XBP_JOB_JOBLOG_READ
Gets the logs of a job
Inputs
| Input |
Detail |
| Cookies |
Enter the cookies from the initial BAPI_XMI_LOGON command |
| External Username |
Enter the external username to use with the request; in the XML, the EXTERNAL_USER_NAME value |
| Job Count |
Enter the count of the job to get logs for; in the XML, the JOBCOUNT value |
| Job Name |
Enter the name of the job to get logs for; in the XML, the JOBNAME value |
Outputs
| Output |
Output Type |
| Return |
JSON |
| Job Protocol Log |
File |
| Job Protocol New Log |
File |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
The command failed to execute |
| 2 |
Error |
Unable to authenticate with the SAP server |
BAPI_XBP_JOB_OPEN
Creates a job
Inputs
| Input |
Detail |
| Cookies |
Enter the cookies from the initial BAPI_XMI_LOGON command |
| External Username |
Enter the external username to use with the request; in the XML, the EXTERNAL_USER_NAME value |
| Job Class |
Enter the class of the new job; in the XML, the JOBCLASS value |
| Job Name |
Enter the name of the new job; in the XML, the JOBNAME value |
Outputs
| Output |
Output Type |
| Job Count |
String |
| Return |
JSON |
| Job Name |
String |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
The command failed to execute |
| 2 |
Error |
Unable to authenticate with the SAP server |
BAPI_XBP_JOB_READ
Reads the content of a job
Inputs
| Input |
Detail |
| Cookies |
Enter the cookies from the initial BAPI_XMI_LOGON command |
| External Username |
Enter the external username to use with the request; in the XML, the EXTERNAL_USER_NAME value |
| Job Count |
Enter the count of the job to read; in the XML, the JOBCOUNT value |
| Job Name |
Enter the name of the job to read; in the XML, the JOBNAME value |
Outputs
| Output |
Output Type |
| Return |
JSON |
| Contents |
JSON |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
The command failed to execute |
| 2 |
Error |
Unable to authenticate with the SAP server |
BAPI_XBP_JOB_SPOOLLIST_READ
Reads the spool list of an ABAP job step
Inputs
| Input |
Detail |
| Cookies |
Enter the cookies from the initial BAPI_XMI_LOGON command |
| External Username |
Enter the external username to use with the request; in the XML, the EXTERNAL_USER_NAME value |
| Job Count |
Enter the count of the job to read; in the XML, the JOBCOUNT value |
| Job Name |
Enter the name of the job to read; in the XML, the JOBNAME value |
| Step Number |
Enter the step number to get the spool from |
Outputs
| Output |
Output Type |
| Return |
JSON |
| Spool Contents |
File |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
The command failed to execute |
| 2 |
Error |
Unable to authenticate with the SAP server |
BAPI_XBP_JOB_START_IMMEDIATELY
Starts a job immediately
Inputs
| Input |
Detail |
| Cookies |
Enter the cookies from the initial BAPI_XMI_LOGON command |
| External Username |
Enter the external username to use with the request; in the XML, the EXTERNAL_USER_NAME value |
| Job Count |
Enter the count of the job to run; in the XML, the JOBCOUNT value |
| Job Name |
Enter the name of the job to run; in the XML, the JOBNAME value |
| Target Group |
Enter the target group |
| Target Server |
Enter the target server |
| Run Synchronously |
To run the job synchronously and wait for it to finish, check this box |
Outputs
| Output |
Output Type |
| Return |
JSON |
| Logs |
File |
| Job Status |
String |
| Has Child |
String |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
The command failed to execute |
| 2 |
Error |
Unable to authenticate with the SAP server |
BAPI_XBP_JOB_STATUS_GET
Gets the status of a job
Inputs
| Input |
Detail |
| Cookies |
Enter the cookies from the initial BAPI_XMI_LOGON command |
| External Username |
Enter the external username to use with the request; in the XML, the EXTERNAL_USER_NAME value |
| Job Count |
Enter the count of the job to get the status of; in the XML, the JOBCOUNT value |
| Job Name |
Enter the name of the job to get the status of; in the XML, the JOBNAME value |
Outputs
| Output |
Output Type |
| Return |
JSON |
| Job Status |
String |
| Has Child |
String |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
The command failed to execute |
| 2 |
Error |
Unable to authenticate with the SAP server |
BAPI_XBP_REPORT_SEARCH
Searches for a report
Inputs
| Input |
Detail |
| Cookies |
Enter the cookies from the initial BAPI_XMI_LOGON command |
| External Username |
Enter the external username to use with the request; in the XML, the EXTERNAL_USER_NAME value |
| Report |
Enter the search string for the reports, such as report*; in the XML, the REPORT value |
| Count |
Enter the maximum number of results to return; in the XML, the COUNT value |
| Report Items |
Enter a list of the items to add to the search; in the XML, the REPORTS->Item value |
Outputs
| Output |
Output Type |
| Return |
JSON |
| Reports |
JSON |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
The command failed to execute |
| 2 |
Error |
Unable to authenticate with the SAP server |
BAPI_XMI_LOGOFF
Logs off of an external management tool
Inputs
| Input |
Detail |
| Cookies |
Enter the cookies from the initial BAPI_XMI_LOGON command |
| Interface |
Enter the service to log off and end the session of; in the XML, the INTERFACE value |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
The command failed to execute |
| 2 |
Error |
Unable to authenticate with the SAP server |
BAPI_XMI_LOGON
Logs on to an external management tool
Inputs
| Input |
Detail |
| Company |
Enter the company to log on with; in the XML, the EXTCOMPANY value |
| Product |
Enter the product to log on to; in the XML, the EXTPRODUCT value |
| Version |
Enter the version of the BAPI call and service; in the XML, the VERSION value |
| Interface |
Enter the service to log on to and create a session with; in the XML, the INTERFACE value |
Outputs
| Output |
Output Type |
| Cookies |
JSON |
| Session ID |
String |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
The command failed to execute |
| 2 |
Error |
Unable to authenticate with the SAP server |
Generic Function Call
Calls any web service-enabled RFC function in the SAP environment
Inputs
| Input |
Detail |
| Cookies |
Enter the cookies from the initial BAPI_XMI_LOGON command |
| Body XML |
Enter the payload of the request. Don't include the XML element for the function itself; include only the contents of the element. |
| Function Name |
Enter the name of the function, such as BAPI_XMI_LOGON
|
Outputs
| Output |
Output Type |
| XML Response |
File |
| Return |
JSON |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
The command failed to execute |
| 2 |
Error |
Unable to authenticate with the SAP server |