2. SkyvvaSalesforce Sender Adapter in SAP Cloud Platform Integration

This document introduces the SkyvvaSalesforce Sender Adapter, which is used to bring data from Salesforce into SAP Cloud Integration (SAP CPI).

The adapter is configured on the sender side of an integration flow. It supports two independent ways of getting data out of Salesforce: subscribing to Salesforce events (PushTopic, Generic Events, Platform Events, or Change Data Capture) over CometD, or scheduling a recurring SOQL query against a SKYVVA Interface.

The following example shows a simple end-to-end integration flow:

Context Before You Start

In short: this adapter is the entry point on the SAP CPI side for data coming out of Salesforce — an iFlow's sender channel, configured either to subscribe to a Salesforce event stream or to poll a SKYVVA Interface's own SOQL query on a schedule, so that Salesforce activity or record data starts an iFlow run in CPI.

Reasons to reach for it:

• You need SAP CPI to react to something happening in Salesforce (a record change, a platform event) as it happens, without CPI having to ask.
• You need SAP CPI to pull a set of Salesforce records on a recurring schedule (e.g. every night, every 15 minutes) using a query you control from a SKYVVA Interface record, rather than hand-building a Query REST call in the iFlow.

• Outbound-from-Salesforce scenarios where Salesforce is the source of truth and CPI (or a system behind it) needs to be notified or kept in sync — see Outbound Asynchronous Interface: Salesforce Account to SAP CPI and Outbound Synchronous Interface: Salesforce Account to SAP CPI (Request/Response) for the interface-side setup this channel calls into.
• Teams that need to understand every tab/field on this channel before choosing between event-driven and schedule-driven extraction.

2. Sender Adapter Configuration

Select SkyvvaSalesforce as the sender adapter in the SAP Cloud Integration integration flow.

The sender adapter includes the following main configuration areas:

• General
• Connection
• Processing
• Scheduler (a standard SAP-provided tab, relevant only for some Processing Mode/Operation combinations — see §9)

3. Connection Tab

The Connection tab is used to configure authentication for the Salesforce connection. It works exactly the same way as on the receiver channel.

Configure the following settings:

3.1 Authentication Type

The Authentication Type is currently fixed to: OAuth2

3.2 OAuth2 Flow

Select one of the following OAuth2 flows:

• Username-Password Credential (default)
• Client Credential

3.3 Login URL

Enter the URL of the Salesforce organization.

Examples:

3.4 User Credential

The User Credential field is displayed when: OAuth2 Flow = Username-Password Credential

Enter the name of the User Credential artifact deployed in SAP CPI.

The credential is configured under: Monitoring → Manage Security → Security Material

The User Credential contains the Salesforce username, password, and security token when required.

3.5 Client Credential

The Client Credential field specifies the OAuth2 Client Credentials artifact deployed in the SAP CPI keystore.

The credential contains the Salesforce Connected App or External Client App credentials, including:

• Consumer Key
• Consumer Secret

4. Processing Tab

The Processing tab opens with one top-level field that determines everything else on the tab:

5. Event Processing

When Processing Mode is set to Event Processing (the default), the Event Processing Details group appears:

5.1 Event Type

Select the kind of Salesforce event to subscribe to:

5.2 Replay Id Approach

Select where in the event stream the subscription should start:

5.3 Replay Id

Shown only when Replay Id Approach = Events from a specific position (Custom).

Enter the exact Replay ID to resume the subscription from. The Replay ID is populated by Salesforce and refers to the position of an event within its stream, e.g. 9.

5.4 Operation

Select how the subscription itself is driven:

5.5 Poll Wait Time (in ms)

Shown only when Operation = Topic - Polling.

Specifies how long, in milliseconds, each scheduled poll stays subscribed and collects events before disconnecting.

Example: 30000 (30 seconds)

5.6 Channel Name

Enter the Salesforce channel to subscribe to. The field shown, and the prefix it expects, depends on the selected Event Type:

5.7 Max Buffer Size (in bytes)

Specifies the maximum capacity reserved for buffering incoming events.

Example: 10485760 (10 MB)

5.8 Message Expiration (in ms)

Specifies how long, in milliseconds, a processed event's replay ID is kept for duplicate-detection purposes. Minimum value: 300000 (5 minutes).

5.9 Subscription Mechanism

Select how the subscription is distributed across runtime nodes:

5.10 Subscription Behaviour On Reset

Select where a resubscription resumes from. Resubscription can happen for several reasons — an error in the subscription listener, a worker node restart, an iFlow redeployment, etc.

5.11 Max Network Delay (in ms)

Specifies the maximum time, in milliseconds, the client waits for a response to a connect request before timing out.

Example: 120000 (2 minutes)

6. Schedule Processing

When Processing Mode is set to Schedule Processing, the Schedule Processing group appears, and the channel is driven by the standard SAP Scheduler tab (§9) instead of any event subscription:

6.1 Integration

Enter the name of the SKYVVA Integration record in Salesforce that owns the Interface to be polled.

6.2 Interface

Enter the name of the SKYVVA Interface record in Salesforce to poll. The channel looks this Interface up by name (scoped to the selected Integration) and runs the SOQL query configured on that Interface record itself — the query is maintained in Salesforce, not typed into this adapter.

6.3 Operation

Select how the query behaves with respect to deleted/archived records:

6.4 Processing Package Size

Select how the records from a scheduled run are grouped into messages:

Note: Salesforce returns query results in pages of up to 2000 records. When a query matches more records than fit in one page, the channel automatically continues fetching subsequent pages until Salesforce reports the query complete, regardless of the Processing Package Size setting.

6.5 Custom Package Size

Shown only when Processing Package Size = Custom Package Size.

Enter the number of records that should go into each emitted message.

Example: 50

7. Format

The Format group applies regardless of the selected Processing Mode:

7.1 Payload Format

Select the format of the message body:

7.2 Pretty Print

Enable to format the outgoing payload for readability.

8. Adapter Setting

The Adapter Setting group applies regardless of the selected Processing Mode:

8.1 Logging option

Select the logging level for the channel.

Available options:

8.2 Salesforce Api Version

Specifies the Salesforce API version used for requests made by this channel.

Example: 53.0

Note: The sender channel requires the configured Salesforce API version to be 52.0 or higher, regardless of Processing Mode.

9. Scheduler Tab

Alongside General/Connection/Processing, the channel also exposes the standard SAP-provided Scheduler tab (the same one used by other SAP CPI adapters), offering the usual Schedule on Day and Schedule to Recur timer options.

Whether the Scheduler tab actually drives anything depends on the Processing Mode/Operation combination chosen on the Processing tab:

10. Summary

The SkyvvaSalesforce Sender Adapter enables SAP Cloud Integration to receive data from Salesforce, either through event subscription or scheduled querying.

The main configuration areas are: