Programmer's reference for Salesforce Pardot Reader

Account

Initial Load

Insert

Campaign

Initial Load

Insert

CustomField

All

Insert

CustomRedirect

All

Insert, Update

DynamicContent

All

Insert, Update

Email

Initial Load

Insert

EmailClicks

All

Insert

EmailTemplate

Initial Load

Insert

Form

All

Insert, Update

LifecycleHistory

All

Insert

LifecycleStage

Initial Load

Insert

ListMembership

All

Insert

List

All

Insert, Update

Opportunity

All

Insert

Prospect

All

Insert, Update

ProspectAccount

Initial Load

Insert

Tag

All

Insert, Update

TagObject

All

Insert

User

All

Insert

Visit

InitialLoad

Insert

Visitor

All

Insert, Update

VisitorActivity

All

Insert

Auth Token

com.webaction. security.Password

If autoAuthTokenRenewal is set to false , specify your Salesforce access token (see Set Up Authorization on developer.salesforce.com: the first section, "Setting Up OAuth 2.0," explains how to create a "connected app"; the second section, "Session ID Authorization," explains how to get the token using curl).

When Auto Auth Token Renewal is True, this property is ignored and does not appear in Flow Designer.

Auto Auth Token Renewal

Boolean

False

With the default value of False, when the specified Auth Token expires the application will halt and you will need to modify it to update the auth token before restarting. This setting is recommended only for development and testing, not in a production environment. When this property is False, you must specify Auth Token, Password, and Username.

Set to True to renew the auth token automatically. In this case, leave Auth Token blank and set the Consumer Key, Consumer Secret, Password, Security Token, and Username properties.

Business Unit ID

String

Specify the Account Engagement instance from which the adapter will read (see Find my Account Engagement Account ID).

Connection Retry Policy

String

retryInterval=30, maxRetries=3

With the default setting, if a connection attempt is unsuccessful, the adapter will try again in 30 seconds (retryInterval. If the second attempt is unsuccessful, in 30 seconds it will try a third time (maxRetries). If that is unsuccessful, the adapter will fail and log an exception. Negative values are not supported.

Consumer Key

String

If Auto Auth Token Renewal is set to true, specify the Consumer Key (see Set Up Authorization on developer.salesforce.com).

Consumer Secret

String

If Auto Auth Token Renewal is set to true, specify the Consumer Key (see Set Up Authorization on developer.salesforce.com).

When Auto Auth Token Renewal is False, this property is ignored and does not appear in Flow Designer.

Custom Params

String

This property optionally enables overrides for individual source parameters while fetching records. Salesforce documentation provides a complete list of parameters for different objects.

The parameter format is <Object_name>=<param1>:<param1_value>|<param2>:<param2_value>. Separate multiple objects with the ; character. For example, when Use Bulk Export is True,, Prospect=created_after:2021-01-01; VisitorActivity=created_before:2023-01-01. The date format must be YYYY-MM-DD.

Exclude Objects

String

Optionally, specify a list of objects, separated by semicolons, to be excluded from any wildcard selection specified in sObjects. This property does not support wildcards.

Export Status Check interval

String

120s

This property specifies how often, in seconds, Striim will check the status of a bulk export job. Higher values result in fewer API calls and directly affect the performance of an export job.

When Use Bulk Export is False, this property is ignored and does not appear in Flow Designer.

JWT Certificate Name

String

See Salesforce Help> Docs> Identify Your Users and Manage Access > OAuth 2.0 JWT Bearer Flow for Server-to-Server Integration.

When Auto Auth Token is False or OAuth Authorization Flows is PASSWORD, this property is ignored and not visible in the Flow Designer.

JWT Keystore Password

com.webaction. security.Password

See Salesforce Help> Docs> Identify Your Users and Manage Access > OAuth 2.0 JWT Bearer Flow for Server-to-Server Integration.

When Auto Auth Token is False or OAuth Authorization Flows is PASSWORD, this property is ignored and not visible in the Flow Designer.

JWT Keystore Path

String

See Salesforce Help> Docs> Identify Your Users and Manage Access > OAuth 2.0 JWT Bearer Flow for Server-to-Server Integration.

When Auto Auth Token is False or OAuth Authorization Flows is PASSWORD, this property is ignored and not visible in the Flow Designer.

Migrate Schema

Boolean

False

Do not change this setting. It is reserved for use by applications created using Auto Schema Conversion wizards (see Using Auto Schema Conversion).

Mode

Enum

InitialLoad

This setting controls the basic behavior or the adapter.

Use the default value of InitialLoad to read all existing data and stop.

Set to IncrementalLoad to read all new data continuously.

OAuth Authorization Flows

enum

PASSWORD

This property selects the authorization method the adapter will use.

With the default value of PASSWORD, Salesforce Writer will authorize using OAuth 2.0 username and password (see Salesforce Help> Docs> Identify Your Users and Manage Access > OAuth 2.0 Username-Password Flow for Special Scenarios). In this case, you must specify values for the Consumer Key, Consumer Secret, Password, Security Token, and Username properties.

Set to JWT_BEARER to authorize using OAuth 2.0 JWT bearer tokens instead (see Salesforce Help> Docs> Identify Your Users and Manage Access > OAuth 2.0 JWT Bearer Flow for Server-to-Server Integration). In this case, you must specify the Consumer Key, JWT Certificate Name, JWT Keystore Password, JWT Keystore Path, and Username properties.

Objects

See sObjects.

Pardot API Version

Enum

V4

With the default value of V4, the reader will use Salesforce Pardot API version 4.

Set to V3 to use API version 3.

Password

com.webaction. security.Password

When Auto Auth Token Renewal is set to true, specify the password for the specified Username (see Encrypted passwords).

When Auto Auth Token Renewal is False or OAuth Authorization Flows is JWT_BEARER, this property is ignored and not visible in the Flow Designer.

Polling Interval

String

120s

This property controls how often the adapter reads from the source. By default, it checks the source for new data every two minutes (120 seconds). If there is new data, the adapter reads it and sends it to the adapter's output stream. If you encounter Salesforce REQUEST_LIMIT_EXCEEDED errors, you may need to increase this value or contact Salesforce to raise your API limits (see Salesforce Developer Limits and Allocations Quick Reference).

When Mode is InitialLoad, this property is ignored and not displayed in the Flow Designer.

The specified polling interval should be always greater than 2 minutes or 120s in order to avoid data loss due to API inconsistency.

Security Token

com.webaction. security.Password

When Auto Auth Token Renewal is set to true, specify the security token for the specified username (see Reset Your Security Tokenon help.salesforce.com).

When Auto Auth Token Renewal is False or OAuth Authorization Flows is JWT_BEARER, this property is ignored and not visible in the Flow Designer.

sObjects

String

Specify which standard objects to be read from Salesforce Pardot. To read all objects, use the % wildcard. Alternatively, list multiple objects separated by semicolons. Do not modify this property when recovery is enabled for the application.

In the Flow Designer this property is shown as Objects.

For more information, see Account Engagement API / Get Started / Object Field References.

Start Timestamp

String

By default, Salesforce Pardot Reader reads only new events. Optionally, specify the time (based on LastModifiedDate) from which to start reading older events in the format yyyy-MM-dd HH:mm:ss. If the Salesforce organization's time zone is not the same as Striim's, convert the Salesforce start time to UTC (GMT+00:00) and include a Z at the end of the string. See SimpleDateFormat for more information.

Thread Pool Count

Integer

0

With the default value of 0, the reader uses a single thread in the Striim JVM. Set this number to match the number of concurrent transactions for your Account Engagement API (see Get Started with Account Engagement API > Rate Limits).

Use Bulk Export

Boolean

False

When Mode is InitialLoad, this controls which API the adapter will use. (When Mode is IncrementalLoad, this property is ignored and not displayed in the Flow Designer.)

With the default value of False, the reader uses the Account Engagement API.

Set to true to use the asynchronous bulk export API (see Version 4 Docs / Export / Export API Overview) during initial load.

The following objects support bulk export:

Bulk export is limited to one year of historical data. Use the created_after and created_before in the Custom Params property to specify a custom export window (see Version 4 Docs / Export / Export API Overview / Query).

When Use Bulk Export is True, the Export Status Check Interval property is enabled.

Username

String

If Auto Auth Token Renewal is set to true, specify an appropriate username (see Add a Single User on help.salesforce.com).

When Auto Auth Token Renewal is False, this property is ignored and does not appear in Flow Designer.