Technical Specification: SAP_POLineItemFact_2_AribaJobPaging

Version: 4.8

1. Purpose & Scope

This integration flow demonstrates the pattern for authenticating against SAP Ariba's OAuth token endpoint and submitting/paging through an Ariba Open API job (e.g., an Invoice Line Item Fact / analytics-reporting job, based on parameter names such as InvoiceLineItemFactSystemView, job_status_url, and api_url). The flow is invoked via a ProcessDirect sender call, retrieves an OAuth access token from Ariba, uses that token to submit a reporting job to the Ariba Open API, converts the JSON response to XML, extracts the returned Job ID, and constructs a "next page" / job-status polling URL from it. A parallel exception-handling sub-process logs error payloads when the main process fails.

The flow name and description ("...illustrates how to fetch Ariba API Token and communicate with the Ariba Open API") confirm this is a reference/template implementation for the Ariba token-and-job-submission pattern, rather than a full end-to-end business process (e.g., no explicit polling loop or SAP-side data delivery step is present in this flow).

2. Systems & Interfaces

Participants

Adapters / Message Flows

3. Processing Logic

The flow contains two branches: a main process (starting at StartEvent_821467) and an exception sub-process (starting at StartEvent_177).

Main Process (sequential order)

1. StartEvent_821467 — Entry point, triggered via ProcessDirect from Sender1.
2. Init Params (CallActivity_5, Content Modifier) — Sets/initializes header and property values needed downstream (e.g., realm, dates, credentials) — exact fields not detailed in facts, but this precedes query-parameter construction.
3. Build NextPage FQDN (CallActivity_821471, Groovy: setQueryParams.groovy) — Parses an input body of pipe-delimited (@) tokens into InvoiceLineItemFactSystemView, updatedDateFrom, updatedDateTo, pageToken, and builds a queryParams property combining realm and pageToken.
4. Get Token (ServiceTask_7, HTTP Request-Reply) — Calls the Ariba OAuth token endpoint (getToken receiver, using oauth_address, grant_type, credential) to obtain an access token.
5. Access Token Log (CallActivity_173, Groovy: accessToken_log.groovy) — Conditionally logs the raw token response body as a message attachment for traceability.
6. JSON to XML Converter (CallActivity_13) — Converts the JSON token response into XML for downstream processing/property extraction.
7. Set Token (CallActivity_16, Content Modifier) — Extracts the access token from the converted XML and stores it (e.g., as header/property) for use in the Authorization header of the next call.
8. Set Auth (CallActivity_156, Content Modifier) — Sets the Authorization header (using the retrieved token) for the job submission call.
9. Submit Job (ServiceTask_158, HTTP Request-Reply) — Calls the Ariba Open API (api_url) to submit the reporting job, using the SubmitJob receiver endpoint.
10. JSON to XML Converter (CallActivity_163) — Converts the job submission JSON response into XML.
11. Add Additional Root (CallActivity_821452, Groovy: addNewRootElement.groovy) — Wraps the XML payload with an additional root node (rootNode) to simplify subsequent element navigation/manipulation.
12. Set Job ID (CallActivity_821458, Groovy: CollectJobID.groovy) — Parses the wrapped XML to extract jobId and status, then builds a nextURL property by concatenating job_status_url with the extracted job ID (used for later job-status polling, outside this flow's scope).
13. Set Body (CallActivity_821465, Content Modifier) — Prepares the outgoing message body for the next internal call.
14. Request Reply (ServiceTask_821460, ProcessDirect Request-Reply) — Sends the message to another internal process (Receiver participant) for further handling.
15. EndEvent_821474 — Ends the main process.

Exception Sub-Process

1. StartEvent_177 — Triggered on exception within the main process (standard CPI exception sub-process pattern).
2. Handle Exception (CallActivity_180, Content Modifier) — Prepares/enriches the error message content (e.g., extracting exception details into the body/properties).
3. Handle Exception (CallActivity_821456, Groovy: handleError.groovy) — Conditionally logs the error body as a message attachment (Error_Body) for diagnostics.
4. EndEvent_178 — Ends the exception sub-process.

4. Scripts

setQueryParams.groovy

Reads the message body, expecting a @-delimited string in the fixed order: InvoiceLineItemFactSystemView@updatedDateFrom@updatedDateTo@pageToken@. Splits the body on @ and assigns each segment to a variable (note: the loop re-assigns all four variables on every iteration rather than incrementally — effectively only the final iteration's assignment matters, but since the token positions are fixed by index, the result is deterministic regardless of loop count). Builds queryParams by concatenating the realm property with &pageToken=<pageToken>, and sets queryParams, InvoiceLineItemFactSystemView, updatedDateFrom, updatedDateTo as message properties. Includes commented-out logging.

accessToken_log.groovy

Reads the logger property and message body. If a message log is available and logger is "true" (case-insensitive), attaches the full response body as a string attachment named accessToken with MIME type text/xml — used for tracing the token response in Message Processing Logs.

addNewRootElement.groovy

Parses the message body as XML using XmlSlurper, then rebuilds it wrapped inside a new rootNode element using StreamingMarkupBuilder, serializing the result back to a string via XmlUtil.serialize. This normalizes the XML structure so that subsequent scripts (e.g., CollectJobID.groovy) can reliably navigate rootNode.root.... Logging code is present but commented out.

CollectJobID.groovy

Parses the (now root-wrapped) XML body with XmlSlurper. Iterates over rootNode.root elements, capturing status and jobId text values (the loop overwrites jobID on each iteration, so the final matched element's jobId is retained). Builds nextURL by concatenating the job_status_url property with the extracted jobID, and stores it as the nextURL message property — this URL is intended for a subsequent job-status polling call (not shown in this flow). If logging is enabled, attaches nextURL as a text/plain attachment named nextPageURL.

handleError.groovy

Used in the exception sub-process. Reads the logger property and message body; if logging is enabled and a message log exists, attaches the current body as Error_Body (text/plain) — providing visibility into the failing payload at the point of exception.

5. Configuration

The following externalized parameters must be reviewed/set on deployment. Redacted values must be supplied via Secure Parameters/Credentials in the target tenant.