v5.0 - v5.5 Data Sync Documentation
  • Overview
  • Release Notes
    • V4.5
    • V4.6
    • v4.7
    • v4.8
    • v4.9
    • v4.10
    • v4.12
    • v4.13
  • v4 Connections Installation Guide
    • v5 Connections and CLI Installation Guide
  • v4 Worker/Listener Installation Guide
    • v5 Worker/Listener Installation Guide
  • Upgrades & Config Changes
  • Builder Guide
    • Overview
    • Types of Data Syncs
    • Subscribing to Event Streams
      • Supported Stream Sources
        • Amazon Simple Queue Service (SQS)
        • Cinchy Change Data Capture
        • Data Polling
        • Kafka Topic
        • MongoDB
        • Salesforce
          • Push Topic
          • Platform Event
    • Configuring a Data Sync
      • Connections Experience & XML Config Reference
        • Info
          • Parameters
            • String Escape
        • Source Config Reference
          • Schema Columns
            • Calculated Column Examples
          • Auth Requests
          • Request Headers
          • Pagination
          • Source Filter
        • Target Destination Config Reference
          • Column Mappings
          • Target Destination Filter
        • Sync Behaviour
        • Post Sync
        • Permissions
        • Jobs
        • Connections Usage Example
      • Data Validation
      • Transformations
        • StringReplacement
      • Supported Data Sources
        • File Based Source
          • Binary File
            • Binary File Data Source Example
          • Delimited File
            • Delimited File Data Source XML Example
          • Fixed Width File
          • Excel
            • Excel Source XML Example
        • Cinchy Event Broker/CDC
          • Cinchy Event Broker/CDC XML Config Example
        • Cinchy Table
          • Cinchy Table XML Config Example
        • Cinchy Query
          • Cinchy Query Data Source Example
        • Copper
        • DB2
        • Dynamics 2015
        • Dynamics
        • DynamoDB
        • Kafka Topic
          • Apache AVRO Data Format
          • Kafka Topic Source Example
        • LDAP
        • MongoDB Collection
          • MongoDB Collection Source XML Example
        • MongoDB Collection (Cinchy Event Triggered)
        • MS SQL Server Query
        • MS SQL Server Table
        • ODBC Table
        • ODBC Query
        • Oracle Table
        • Oracle Query
        • Parquet
        • Polling Event
          • Polling Event Example
        • REST API (Cinchy Event Triggered)
        • REST API
          • REST API XML Example
        • SAP SuccessFactors
        • Salesforce Object (Bulk API)
        • Salesforce Platform Event
        • Salesforce Push Topic
        • Snowflake
          • Snowflake Source XML Example
        • SOAP 1.2 Web Service
      • Supported Sync Targets
        • Cinchy Table
        • DB2 Table
        • Dynamics
        • Kafka Topic
        • MongoDB Collection (Column Based)
        • MS SQL Server Table
        • Oracle Table
        • REST API
        • Salesforce
        • Salesforce Object
        • Snowflake Table
          • Snowflake Table Target XML Example
        • SOAP 1.2 Web Service
    • Common Design Patterns
    • Testing a Data Sync
    • Promoting a Data Sync
    • Scheduling a Data Sync
    • CLI Command List
    • Connections Functions
    • Monitoring
  • Cinchy Platform Documentation
Powered by GitBook
On this page
  • Data Sync Configuration
  • Sample Data Sync Config

Was this helpful?

  1. Builder Guide
  2. Configuring a Data Sync
  3. Supported Data Sources

Salesforce Platform Event

PreviousSalesforce Object (Bulk API)NextSalesforce Push Topic

Last updated 3 years ago

Was this helpful?

Parameter

Value

object

the salesforce object name auth

authUrl

clientId

the encrypted client id for the connected app

clientSecret

the encrypted client secret for the connected app

username

the encrypted salesforce user account

password

the encrypted salesforce user account password

autoOffsetReset

Earliest, Latest or None

topic

Add the Topic

connectionAttributes

Add Connection Attributes

Data Sync Configuration

Use SalesforcePlatformEventDataSource as the source for platform events.

The Id column is mandatory in the source.

Sample Data Sync Config

<?xml version="1.0" encoding="utf-16" ?>
<BatchDataSyncConfig name="Platform Events" version="1.0.0" xmlns="http://www.cinchy.co">
	<SalesforcePlatformEventDataSource type="Event">
		<Schema>
			<Column ordinal="1" name="Id__c" dataType="Text"   maxLength="100" />
			<Column ordinal="2" name="TestField__c" dataType="Text"   maxLength="100" />
			<Column ordinal="3" name="Message__c" dataType="Text"   maxLength="100" />
		</Schema>
	</SalesforcePlatformEventDataSource>
	<CinchyTableTarget model="" domain="Events" table="SF Platform Event">
		<ColumnMappings>
			<ColumnMapping sourceColumn="Id__c" targetColumn="Id" />
			<ColumnMapping sourceColumn="TestField__c" targetColumn="TestField" />
			<ColumnMapping sourceColumn="Message__c" targetColumn="Message" />
		</ColumnMappings>
		<SyncKey>
		  <SyncKeyColumnReference name="Id" />
		</SyncKey>
		<NewRecordBehaviour     type="INSERT" />
		<ChangedRecordBehaviour type="UPDATE" />
		<DroppedRecordBehaviour type="DELETE" />
	</CinchyTableTarget>
</BatchDataSyncConfig>

the url that issues the token, e.g.

https://test.salesforce.com/services/oauth2/token