Configuration

This section explains each of the properties in the configuration blade.

General

PropertyDescription

Collection

This associates the Agent to a specific Collection (default to that of the current Data Stream).

Polling Interval (seconds)

A timespan to specify how often should the Agent check for new data/changes or update its cache.

Refer to Collections and Stream Hosts to understand more about Collections.

Salesforce Login Details

PropertyDescription

Use Variables?

Tick to use saved variables for authentication properties; or enter the text manually.

Username

The username for the Salesforce login.

Password

The password for the Salesforce login.

Is Sandbox?

Tick to connect to a Salesforce Test Environment; or leave unticked to connect to a Salesforce Production Environment.

Custom API OAuth Setting

PropertyDescription

Consumer Key

The consumer key of the Salesforce Connected App.

Consumer Secret

The consumer secret of the Salesforce Connected App.

Please select an object

PropertyDescription

Object

The Salesforce object, e.g. Account or Work Order.

Return Count

Tick to return the total record count.

Columns To Return

The columns which the Agent should return. If no columns are specified, the Agent will return all the columns from the Salesforce Object.

Filtering

PropertyDescription

Filter

Rules for filtering the returned results.

Limit Rows Returned

An optional limit on the number of rows retrieved from Salesforce per poll.

Date Field To Filter

An optional Date Field applied in Last n Days.

Last n Days

An optional limit for filtering for the last number of days of the selected Date Field to Filter.

Sort By

The columns that the results should be sorted by. Multiple columns and directions can be specified.

Endpoints

NameDescription

Output

An event per read row will be made available to this endpoint with attributes matching the Salesforce object.

Error

Errors encountered during the execution of this Agent will be published on this endpoint.

Last updated