Document SAP JCo transactional RFC operations and add an example page - #628
Open
RDPerera wants to merge 1 commit into
Open
Document SAP JCo transactional RFC operations and add an example page#628RDPerera wants to merge 1 commit into
RDPerera wants to merge 1 commit into
Conversation
The SAP JCo action reference covered execute, sendIDoc, and close. It now also documents the transactional operations for calling function modules: sendTRfc and sendQRfc, bgRFC units through sendBgRfcUnit with getBgRfcUnitState and confirmBgRfcUnit, and the TID lifecycle through createTid and confirmTid. Adds the example page that this connector was missing while every sibling SAP connector has one. It walks through calling an RFC-enabled function module with execute, then shows the same call made exactly once with sendTRfc for interfaces that must never post a document twice. Registers the new page in the sidebar and mentions transactional RFC in the overview's key features and actions table. Every Ballerina snippet on both pages was compiled against the connector, and the example page's output was captured from a real SAP system rather than written by hand.
RDPerera
requested review from
KavinduZoysa,
NipunaRanasinghe,
anupama-pathirage and
rosensilva
as code owners
August 19, 2026 07:14
Contributor
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Broken links, images & orphan pages
Links/images come from one crawl of the production build (baseUrl-aware). Orphans are docs not referenced by Summary
Broken links & imagesIntroduced by this PRNo new broken link(s)/image(s) introduced by this PR. ✅ Already on
|
This was referenced Aug 19, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
Documents the transactional RFC operations on the SAP JCo action reference, and adds the example page this connector was missing.
sap.jcois currently the only SAP connector in the catalog without anexample.md— every sibling (sap.businessone.*,sap.signavio,sap.commerce.webservices) has one.Changes
action-reference.md— new Transactional RFC operation group covering the operations for calling a function module with a delivery guarantee:sendTRfcsendQRfcsendBgRfcUnitTorQ)getBgRfcUnitState/confirmBgRfcUnitcreateTid/confirmTidEach follows the page's existing structure: a
<details>block with a parameter table, Returns, and sample code. The prose explains the parts that are easy to get wrong — that these calls are asynchronous so export values are discarded, thatautoConfirm = falseis what makes a retry safe, that a confirmed TID must never be reused, and thatCONFIRMEDonly exists after the client confirms, so polling for it before confirming would never return.example.md(new) — walks through calling an RFC-enabled function module withexecuteagainstSTFC_CONNECTION, which exists on every ABAP system so the example runs anywhere. A second section shows the same call made exactly once withsendTRfc, for interfaces that post business documents and must never post them twice.overview.md— key features and the actions table now mention transactional RFC.en/sidebars.ts— registers the new example page. Placed aftertrigger-reference, matching the ordering used by other connectors that have both.Verification
Note on release timing
The transactional operations are added by ballerina-platform/module-ballerinax-sap.jco#79 and are not released yet, so this documentation PR should merge only after that connector change ships.
The example page is written as a code-first guide and does not include the six low-code UI screenshots that sibling example pages carry. Happy to regenerate it in that format if preferred.