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
To enable these commands, an IT admin first creates an SAP BAPI RFC connector.
BAPI_XBP_JOB_ADD_ABAP_STEP
To add a step with an Advanced Buisness Application Programming (ABAP) program to a job, use a BAPI_XBP_JOB_ADD_ABAP_STEP command.
Properties
| Property |
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
To retrieve the logs of a job, use a BAPI_XBP_JOB_JOBLOG_READ command.
Properties
| Property |
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
To create a job, use a BAPI_XBP_JOB_OPEN command.
Properties
| Property |
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
To read the content of a job, use a BAPI_XBP_JOB_READ command.
Properties
| Property |
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
To read the spool list of an ABAP job step, use a BAPI_XBP_JOB_SPOOLLIST_READ command.
Properties
| Property |
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
To start a job immediately, use an BAPI_XPBI_JOB_START_IMMEDIATELY command.
Properties
| Property |
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
To retrieve the status of a job, use a BAPI_XBP_JOB_STATUS_GET command.
Properties
| Property |
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
To search for a report, use a BAPI_XBP_REPORT_SEARCH command.
Properties
| Property |
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
To log off of an external management tool, use a BAPI_XMI_LOGOFF command.
Properties
| Property |
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
To log on to an external management tool, use a BAPI_XMI_LOGON command.
Properties
| Property |
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
To call any web service-enabled RFC function in the SAP environment, use a Generic function call command.
Properties
| Property |
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 |