Reference

The Salesforce integration retrieves and updates customer party data and manages activities (Task and Event) in Salesforce CRM through the Salesforce API v56.0. Banking OS delivers the integration as outbound (synchronous) connectors. For the environment details you send to Backbase, see Get started.

Connector	Property file	Purpose
`gc-salesforce-party-connector`	`party-v0.values.yaml`, `party-v2.values.yaml`	Outbound party retrieval and update for both party API versions
`gc-salesforce-activity-connector`	`activity-v0.values.yaml`	Outbound create, update, get activities by party, and get activities by employee

Configuration properties

Common properties

Set these properties in values.yaml. They apply across Salesforce connectors.

Property	Description	Default
`existingSecretName`	Name of the SOPS secret that holds the Salesforce OAuth credentials.	`salesforce`
`gc.sf.client.loginUrl`	Login URL for the Salesforce environment.	`https://login.salesforce.com`
`gc.sf.client.authType`	OAuth authentication type for the Salesforce client.	`USERNAME_PASSWORD`
`http.client.connect.timeout`	HTTP connect timeout, in milliseconds.	`5000`
`http.client.request.timeout`	HTTP request timeout, in milliseconds.	`10000`
`http.client.socket.timeout`	HTTP socket timeout, in milliseconds.	`5000`
`http.client.connection.max.per.route`	Maximum HTTP connections per route.	`200`
`http.client.connection.max.total`	Maximum total HTTP connections.	`200`
`retryFlag`	Enable automatic request retries on connection failure.	`false`
`retry.statuses`	HTTP status codes that trigger a retry.	`0`
`redelivery.maximumRetries`	Maximum number of redelivery attempts.	`3`
`redelivery.delay`	Initial delay between redelivery attempts, in milliseconds.	`200`
`redelivery.backOffMultiplier`	Backoff multiplier for redelivery attempts.	`2`

gc-salesforce-activity-connector

Set these properties in activity-v0.values.yaml. They configure create activity (POST /activities), update activity (PUT /activities/{activityId}), get activities by party (POST /activities/partyId), and get activities by employee (POST /activities/employeeId).

Property	Description	Default
`gc.sf.task.query.fields`	Comma-separated SOQL columns selected for Task rows on get-by-party and get-by-employee.	Environment-specific. Backbase sets this value.
`gc.sf.event.query.fields`	Comma-separated SOQL columns selected for Event rows on get-by-party and get-by-employee.	Environment-specific. Backbase sets this value.
`gc.sf.who.contact.fields`	Contact fields the connector reads using SOQL `TYPEOF Who WHEN Contact THEN ...` (appended to Task and Event queries).	`Name, Email, Phone`
`gc.sf.event.recurrence.frequency.units`	Maps RRULE `FREQ` tokens to Banking OS `frequency.unit` (create/update invert the same map).	`DAILY:Days,WEEKLY:Weeks,MONTHLY:Months,YEARLY:Years`
`gc.sf.task.recurrence.day.of.week.mask`	Maps Banking OS day-of-week names to Salesforce `RecurrenceDayOfWeekMask` bit values.	`SUNDAY:1,MONDAY:2,TUESDAY:4,WEDNESDAY:8,THURSDAY:16,FRIDAY:32,SATURDAY:64`
`gc.sf.event.recurrence.byday`	Maps Banking OS day-of-week names to RRULE `BYDAY` tokens.	`SUNDAY:SU,MONDAY:MO,TUESDAY:TU,WEDNESDAY:WE,THURSDAY:TH,FRIDAY:FR,SATURDAY:SA`
`regex.salesforce-record-id.pattern`	Validation pattern for Salesforce record IDs on get-by-party (`partyId` / `WhoId`) and get-by-employee (`employeeId` / `OwnerId`).	`^[a-zA-Z0-9]{15,18}$`
`regex.salesforce-record-id.failure-message`	Message the connector returns when party or employee ID validation fails.	`Id must be a 15 or 18 character Salesforce record id.`

Replace regex.party-id.pattern and regex.party-id.failure-message with regex.salesforce-record-id.pattern and regex.salesforce-record-id.failure-message. Migrate any tenant overrides in activity-v0.values.yaml before deploying a connector build that includes get-by-employee.

Create and update map Banking OS activity payloads to Salesforce Task or Event using JOLT specs in gc-salesforce-activity-connector, including SDK enrich transforms for Task recurrence bitmask/month and Event duration, start time, and RRULE. For get-by-party and get-by-employee, the connector runs SOQL against Task and Event using the field lists you set in configuration, then maps results to the Banking OS activity response contract. Set the recurrence map properties in activity-v0.values.yaml for create and update; they aren’t bundled as defaults in the connector JAR.

SOPS secrets

The connectors read the Salesforce OAuth 2.0 credentials from the salesforce SOPS secret. Which secret fields are required depends on gc.sf.client.authType (USERNAME_PASSWORD by default; also REFRESH_TOKEN or CLIENT_CREDENTIALS).

Variable	Description
`client ID`	Salesforce connected app client ID.
`client secret`	Salesforce connected app client secret.
`username`	Salesforce integration user name. Required for `USERNAME_PASSWORD`.
`password`	Salesforce integration user password. Required for `USERNAME_PASSWORD`.
`refresh token`	Salesforce OAuth refresh token. Add when using `REFRESH_TOKEN` auth (`gc.sf.client.refreshToken`).

Supported operations

The Salesforce connectors expose party and activity operations of the Banking OS Unified API. For the operation-to-endpoint tables, see Overview. For the full contract, see the API playground.

Method	Endpoint	Purpose
GET	`/parties/{partyId}`	Get party details.
PUT	`/parties/{partyId}`	Update party details.
POST	`/activities`	Create a Task or Event activity.
PUT	`/activities/{activityId}`	Update a Task or Event activity by ID.
POST	`/activities/partyId`	Get activities for a party (Contact `WhoId`).
POST	`/activities/employeeId`	Get activities for an employee (User `OwnerId`).

Get activities by party request fields

POST /activities/partyId accepts the following fields in the request body (from the Banking OS Unified API). For the full contract, see the API playground.

Field	Source	Description	Default
`partyId`	API request body	Salesforce Contact ID used as `WhoId` in Task and Event SOQL.	N/A (required)
`from`	API request body	Page number for pagination. If `from` is `0` or less, the connector uses page `1`.	`1`
`size`	API request body	Page size. Must be `1` or greater.	`20`
`fromDate`	API request body	Inclusive lower bound filter on Salesforce `ActivityDate`.	N/A (optional)
`toDate`	API request body	Inclusive upper bound filter on Salesforce `ActivityDate`.	N/A (optional)

Get activities by employee request fields

POST /activities/employeeId accepts the following fields in the request body (from the Banking OS Unified API). For the full contract, see the API playground. Pagination and date filtering behave the same as get-by-party.

Field	Source	Description	Default
`employeeId`	API request body	Salesforce User ID used as `OwnerId` in Task and Event SOQL.	N/A (required)
`from`	API request body	Page number for pagination. If `from` is `0` or less, the connector uses page `1`.	`1`
`size`	API request body	Page size. Must be `1` or greater.	`20`
`fromDate`	API request body	Inclusive lower bound filter on Salesforce `ActivityDate`.	N/A (optional)
`toDate`	API request body	Inclusive upper bound filter on Salesforce `ActivityDate`.	N/A (optional)

The connector queries Task and Event in parallel for both get operations, merges the results (Tasks then Events), then applies the from/size page slice. If from multiplied by size exceeds the fetch limit of 2000, the connector returns Banking OS error GC051.

Events

gc-salesforce-party-connector and gc-salesforce-activity-connector are synchronous and don’t publish or consume events.

Error mapping

The connectors map Salesforce error codes to Banking OS status codes. For the full list, see Error codes.

Dependencies

Salesforce API v56.0 (outbound), reachable through the environment configured by gc.sf.client.loginUrl.
salesforce-connector-sdk (shared HTTP configuration, Salesforce OAuth handling, and activity JOLT enrich transforms).

Get started

Core banking

Payments

Card management

KYC and KYB

Open Banking

CRM

Fraud detection

Financial data aggregation

Configuration properties

Common properties

gc-salesforce-activity-connector

SOPS secrets

Supported operations

Get activities by party request fields

Get activities by employee request fields

Events

Error mapping

Dependencies

​Configuration properties

​Common properties

​gc-salesforce-activity-connector

​SOPS secrets

​Supported operations

​Get activities by party request fields

​Get activities by employee request fields

​Events

​Error mapping

​Dependencies

Configuration properties

Common properties

gc-salesforce-activity-connector

SOPS secrets

Supported operations

Get activities by party request fields

Get activities by employee request fields

Events

Error mapping

Dependencies