Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Excerpt
hiddentrue

Keep the introduction brief. The customer is looking for this integration because they already have the product.

Example: This data connector for Amazon S3 enables you to import the data from your JSON, TSV, and CSV files stored in an S3 bucket.

Salesforce Pardot B2B is a marketing automation tool by Salesforce designed for organizations that primarily focus on business-to-business (B2B) sales and marketing automation. This email marketing system offers automated support for the longer timespan and multi-step decisions associated with B2B sales and helps marketers create more leads, generate more pipelines, and empower sales to close more deals.

Info

This Data Connector is in Beta. For more information, contact support@treasuredata.com.


Excerpt
hiddentrue

Replace the product name in the following sentence:

Example: This TD export integration allows you to write job results from Treasure Data directly to <product name>.

The Salesforce Pardot input connector automates the end-to-end solution for our customers, which is ingesting data from Pardot into the Treasure Data database and activating a custom segment back to Pardot.

This topic includes:

Table of Contents
maxLevel1

Prerequisites

Excerpt
hiddentrue

Include a bulleted list of prerequisites the customer needs to successfully implement this export integration.

Example:

  • Basic knowledge of Treasure Data.

  • Basic knowledge of Salesforce Pardot

  • You have the ability to create your own Salesforce Pardot connected app, or you have permission to grant access to Treasure Data app to access your Pardot data.
  • Basic Knowledge of Treasure Data.

  • Basic knowledge of Salesforce Pardot.

  • A working Salesforce Pardot account.
  • Your Business Unit ID.

  • You have the ability to create your own Salesforce Pardot connected app, or you have permission to grant access to the Treasure Data app to access your Pardot data.

Requirements and Limitations

Excerpt
hiddentrue

List any product or integration limitations that affect the function of the integration.

Example:

  • The imported values for timestamp columns are saved as string types in the Treasure Data database; the timezone is not available.
  • Use Export API for importing large amounts of data and does not support incremental loading.

Static IP Address of Treasure Data

The static IP address of Treasure Data is the access point and source of the linkage for this Integration. To determine the static IP address, contact your Customer Success representative or Technical support.


Excerpt

Obtain the Pardot Business Unit ID

Follows steps in the Pardot Export document to obtain the Business Unit ID.

Import from Salesforce Pardot via TD Console

Excerpt
hiddentrue

If the customer needs to obtain any key or secret key required to access the Integration, put that information here. To display, edit the Excerpt and remove the checkbox from hidden.

Create Authentication

Numbered Headings
start-numbering-with1
start-numbering-ath5

Follows steps in the Salesforce Pardot Export document to create an authentication.

Create a Source

Numbered Headings
start-numbering-with1
start-numbering-ath5
Open TD Console.
Navigate to Integrations Hub > Authentications.
Locate your new authentication and select New Source.

Create a Connection

Numbered Headings
start-numbering-ath5


Excerpt
hiddentrue
Complete the following table for the source.


ParameterDescription
Data Transfer NameYou can define the name of your transfer.
AuthenticationThe authentication name that is used for a transfer.
Type a source name in the Data Transfer Name field.
Select Next.

The Create Source page displays with the Source Table tab selected.

Identify a Source Table

Excerpt
hiddentrue

Each import integration has a unique set of information that is required to identify a source table. Use the following table to name the field and the required information for that field.

ParameterDescription
Data Object

Pardot Object to import supported objects:

  • CAMPAIGN
  • FORM
  • LIST
  • LIST_MEMBERSHIP
  • OPPORTUNITY
  • PROSPECT
  • PROSPECT_ACCOUNT
  • VISITOR
  • VISITOR_ACTIVITY


Use Export APIUse Export API to import data. When you have a large number of data to import, Export API is more efficient. Additionally, Export API can help you avoid meeting the API rate limit to your account.
Filter by

Filter the data by CREATED_AT, UPDATE_AT, or PROSPECT_UPDATED_AT. 

Info

The PROSPECT_UPDATED_AT is supported by PROSPECT_ACCOUNT and VISITOR Data Object in Export API mode only.


Start TimeImport data since this start time. The format must match: "yyyy-MM-dd HH:mm:ss". If not specified, data will be imported for one year to the specified End Time for Export API mode.
End TimeImport data to this time. The format must match: "yyyy-MM-dd HH:mm:ss". If not specified, data will be imported for one year from the specified Start Time for Export API mode.
Incremental LoadingOnly import new data from the last import. This option is not available when Export API mode is used.

Select Next.

Excerpt
hiddentrue

Enter the data settings if needed. If not needed, delete this section.

Config the Data Settings

The Data Settings allows you to fine-tune the HTTP request to Salesforce Pardot. Update your designed config settings and select Next.


Excerpt
hiddentrue

Do not include for Beta releases.

Define Filters

Integration Filters allow you to modify your imported data after you have completed the data settings for your import.

Review the following links to understand how the filters work:

Preview Your Data

You can see a preview of your data before running the import. The data that displays in the data preview is approximated from your source and no filter is applied. It is not the actual data that is imported.

  1. Select Next.
    Data preview is optional; skip to the next page of the dialog if you want.
  2. To preview your data, select Generate Preview. Optionally, select Next.
  3. Verify that the data meets your expectations.
  4. Select Next.

Define Your Data Placement

Select the target database and table where you want your data placed, and then indicate how often the import should run.

  1. Select Data Placement.
  2. Select a Database > Selectan existing or Create New Database. Optionally, enter a database name.
  3. Select a Table> Select an existing or Create New Table. Optionally, type a table name.
  4. Choose the method for importing the data.
    • Append (default): Data import results are appended to the table.
      If the table does not exist, it will be created.
    • Always Replace: Replaces the entire content of an existing table with the result output of the query. If the table does not exist, a new table is created. 
    • Replace on New Data: Only replace the entire content of an existing table with the result output when there is new data.
  5. Select the Timestamp-based Partition Key column.
    If you want to set a different partition key seed than the default key, you can specify the long or timestamp column as the partitioning time. As a default time column, it uses upload_time with the add_time filter.
  6. Select the Timezone for your data storage.
  7. Choose when and how often you want to run this query:
    • Run once:
      • Select Off.
      • Select Scheduling Timezone.
      • Select Create & Run Now.
    • Repeat the query:
      • Select On.
      • Select the Schedule. The UI provides these four options: @hourly, @daily, and @monthly or custom cron.
      • You can also select Delay Transfer and add a delay of execution time.
      • Select Scheduling Timezone.
      • Select Create & Run Now.

To see the results of your transfer, go to Data Workbench > Databases.

Import from Salesforce Pardot via Workflow

You can import data from Salesforce Pardot by using td_load>: operator of workflow. If you have already created a SOURCE, you can run it; if you don't want to create a SOURCE, you can import it using a yml file.

Using a Source or YML File 

Excerpt
hiddentrue

Describe the pros and cons for each type of data to help the customer decide which to use.


Data TypeProsCons
Source
  • You can use an existing source to set up your workflow.
  • You can use the Treasure Data Connected app if you don't have permission to create your custom Connected app.
  • Intuitive and easy to set up.
  • You must have access permission to TD console.
yml file
  • You have full control of the config.
  • Only workflow access permission is required.
  • You can't use the Treasure Data Connected app.

Using a Source

Numbered Headings
start-numbering-ath5
Identify your source.
To obtain a unique ID, open the Source list and then filter by Salesforce Pardot.
Open the menu and select Copy Unique ID.


Define a workflow task using td_load> operator.
Code Block
linenumberstrue
+load:
  td_load>: unique_id_of_your_source
  database: ${td.dest_db}
  Table: ${td.dest_table}
Run a workflow.

Using a yml file

Numbered Headings
start-numbering-ath5
Identify your yml file. If you need to create the yml file, review Amazon S3 Import Integration Using CLI as a reference.
Define a workflow task using td_load> operator.
Code Block
linenumberstrue
+load:
  td_load>: config/daily_load.yml
  database: ${td.dest_db}
  Table: ${td.dest_table}
Run a workflow.

Parameters Reference

See the CLI Parameter Reference.

Sample Workflow Code

Visit Treasure Boxes for sample workflow code.

Import from Salesforce Pardotvia CLI (Toolbelt)

Numbered Headings
start-numbering-ath5

Before setting up the connector, install the most current TD Toolbelt.

Create Configuration File (load.yml)

Excerpt
hiddentrue

The following is an AWS example to prepare a seed.yml file. Replace the code with the correct code for your <product>.


Code Block
linenumberstrue
in:
  type: salesforce_pardot
  client_id: xxxx
  client_secret: yyyy
  refresh_token: zzzz
  data_object: prospect
  business_unit: 0Uv4W00000111111
  filter_by: 'created_at'
  incremental: true
  #  use_export_api: true
  start_time: "2020-12-13 03:20:00"
  end_time: "2021-12-20 03:30:00"
out:
  mode: append

Parameters Reference

NameDescriptionValueDefault ValueRequired
typeThe connector type.salesforce_pardot
yes
client_idThe connected app consumer key. 

yes
client_secretThe connected app consumer secret.

yes
refresh_tokenThe refresh token after completing the steps described in Using Your Custom Connected App.

yes
business_unitYour Salesforce Pardot Business unit. See Obtain the Pardot Business Unit ID.

yes
data_object

Pardot Object to import, supported objects:

  • CAMPAIGN
  • FORM
  • LIST
  • LIST_MEMBERSHIP
  • OPPORTUNITY
  • PROSPECT
  • PROSPECT_ACCOUNT
  • VISITOR
  • VISITOR_ACTIVITY


yes
use_export_api

Use Export API to import data. When you have a large number of data to import, Export API is more efficient.


falseno
filter_by

Filter the data by CREATED_AT, UPDATE_AT, or PROSPECT_UPDATED_AT. Note, the PROSPECT_UPDATED_AT is supported by PROSPECT_ACCOUNT and VISITOR Data Object in Export API mode only.



no
start_time

Import data since this time, the format must match: "yyyy-MM-dd HH:mm:ss". If not specified, data will be imported for one year to the specified End Time for Export API mode.



no
end_time

Import data to this time, the format must match: "yyyy-MM-dd HH:mm:ss". If not specified, data will be imported for one year from the specified Start Time for Export API mode.



no
incremental

Only import new data from the last import. This option is not available when Export API mode is used.


falseno
maximum_retriesThe maximum number of retries when the request failed.
8no
initial_retry_wait
The initial amount of time before the first retry in seconds.
120no
maximum_retry_wait
The maximum amount of time to wait for a retry in seconds.
300no

connection_timeout

The HTTP connection time out for a request to Pardot in seconds.
300no


To preview the data, use the td connector:preview command.

Code Block
linenumberstrue
$ td connector:preview load.yml
+-------+---------+----------+---------------------+
| id    | company | customer | created_at          |
+-------+---------+----------+---------------------+
| 11200 | AA Inc. |    David | 2015-03-31 06:12:37 |
| 20313 | BB Imc. |      Tom | 2015-04-01 01:00:07 |
| 32132 | CC Inc. | Fernando | 2015-04-01 10:33:41 |
| 40133 | DD Inc. |    Cesar | 2015-04-02 05:12:32 |
| 93133 | EE Inc. |     Jake | 2015-04-02 14:11:13 |
+-------+---------+----------+---------------------+


Execute Load Job

Submit the load job.
It might take a couple of hours depending on the size of the data. Be sure to specify the Treasure Data database and table where the data should be stored.

Treasure Data also recommends specifying --time-column option because Treasure Data’s storage is partitioned by time (see data partitioning). If this option is not provided, the data connector chooses the first long or timestamp column as the partitioning time. The type of the column specified by --time-column must be either of long and timestamp type.

If your data doesn’t have a time column, you can add a time column by using add_time filter option. For more details see add_time filter plugin.

Code Block
linenumberstrue
$ td connector:issue load.yml --database td_sample_db --table td_sample_table \
  --time-column created_at

The connector:issue command assumes that you have already created a database(td_sample_db)and a table(td_sample_table). If the database or the table does not exist in TD, this command fails. Create the database and table manually or use --auto-create-table option with td connector:issue command to auto-create the database and table.

Code Block
linenumberstrue
$ td connector:issue load.yml --database td_sample_db --table td_sample_table
 --time-column created_at --auto-create-table

The data connector does not sort records on the server-side. To use time-based partitioning effectively, sort records in files beforehand.

If you have a field called time, you don’t have to specify the --time-column option.

Code Block
linenumberstrue
$ td connector:issue load.yml --database td_sample_db --table td_sample_table

Import Modes

You can specify file import mode in the out section of the load.yml file. The out: section controls how data is imported into a Treasure Data table. For example, you may choose to append data or replace data in an existing table in Treasure Data.

Mode

Description

Examples

Append

Records are appended to the target table.

in:

  ...

out:

  mode: append

Always
Replace
Replaces data in the target table.
Any manual schema changes made to the target table remain intact.

in:

  ...

out:

  mode: replace

Replace on new dataReplaces data in the target table only when there is new data to import.

in:

  ...

out:

  mode: replace_on_new_data

Scheduling Executions

Create a Schedule Using the TD Toolbelt

A new schedule can be created using the td connector:create command.

Code Block
linenumberstrue
$ td connector:create daily_import "10 0 * * *" \
    td_sample_db td_sample_table load.yml

Treasure Data also recommends that you specify the --time-column option, because Treasure Data’s storage is partitioned by time (see also data partitioning).

Code Block
linenumberstrue
$ td connector:create daily_import "10 0 * * *" \
    td_sample_db td_sample_table load.yml \
    --time-column created_at

The `cron` parameter also accepts three special options: `@hourly`, `@daily`, and `@monthly`.

By default, the schedule is set up in the UTC timezone. You can set the schedule in a timezone using -t or --timezone option. `--timezone` option supports only extended timezone formats like 'Asia/Tokyo', 'America/Los_Angeles', etc.

Info

Timezone abbreviations like PST, CST are not supported and might lead to unexpected schedules.

List All Schedules

You can see the list of currently scheduled entries by running the command td connector:list.

Code Block
$ td connector:list
+--------------+--------------+----------+-------+--------------+-----------------+------------------------- ------+
| Name         | Cron         | Timezone | Delay | Database     | Table           | Config                         |
+--------------+--------------+----------+-------+--------------+-----------------+--------------------------------+
| daily_import | 10 0 * * *   | UTC      | 0     | td_sample_db | td_sample_table | {"in"=>{"type"=>"..","acces... |
+--------------+--------------+----------+-------+--------------+-----------------+--------------------------------+

Show Schedule Settings and History

td connector:show shows the execution setting of a schedule entry.

Code Block
linenumberstrue
% td connector:show daily_import
Name     : daily_import
Cron     : 10 0 * * *
Timezone : UTC
Delay    : 0
Database : td_sample_db
Table    : td_sample_table
Config
---
in:
  type: salesforce_pardot
  client_id: xxxx
  client_secret: yyyy
  refresh_token: zzzz
  data_object: prospect
  business_unit: 0Uv4W00000111111
  filter_by: 'created_at'
  incremental: true
  ...

td connector:history shows the execution history of a scheduled entry. To investigate the results of each individual run, use td job <jobid>.

Code Block
% td connector:history daily_import
+--------+---------+---------+--------------+-----------------+----------+---------------------------+----------+
| JobID  | Status  | Records | Database     | Table           | Priority | Started                   | Duration |
+--------+---------+---------+--------------+-----------------+----------+---------------------------+----------+
| 578066 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-18 00:10:05 +0000 | 160      |
| 577968 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-17 00:10:07 +0000 | 161      |
| 577914 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-16 00:10:03 +0000 | 152      |
| 577872 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-15 00:10:04 +0000 | 163      |
| 577810 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-14 00:10:04 +0000 | 164      |
| 577766 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-13 00:10:04 +0000 | 155      |
| 577710 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-12 00:10:05 +0000 | 156      |
| 577610 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-11 00:10:04 +0000 | 157      |
+--------+---------+---------+--------------+-----------------+----------+---------------------------+----------+
8 rows in set

Delete Schedule

td connector:delete removes the schedule.

Code Block
linenumberstrue
$ td connector:delete daily_import

FAQs for the Salesforce Pardot Integration

Excerpt
hiddentrue

Insert any FAQs that you think will help the customer use this integration efficiently. If there are no FAQs, delete the heading.

How can I schedule an incremental import for a large data set?

As recommended, when importing a large dataset from Pardot you should use the Export API. However, export API doesn't support incremental import. To solve this issue:

  • Use Export API to import to a recent date. For example, today by specifying the Filter By and End Time will import all data to the End Time value.
  • Modify the job config, uncheck the Use Export API checkbox, set the Start Time equals the End Time from the previous execution, and set enable the Incremental Loading.