Salesforce - Download Data to Shipyard

Overview

Before using the blueprint, gather the following:

Salesforce Credentials: Including the access token, consumer key, consumer secret, username, password, security token, and domain. CSV File Parameters: Desired filename for the resulting CSV. List of field names you want to export. The Salesforce object type you're exporting from (e.g., Account, Contact).

Workflow: The blueprint first establishes a connection with Salesforce using the provided credentials. It then requests the data from the specified Salesforce object and fields. The extracted data is saved into a CSV file, which will be named as per your input and given a ".csv" extension if not already present. Error Handling:

Should there be any issues with authentication or data extraction, the blueprint will provide clear feedback, ensuring you're always informed.

Variables

Name	Reference	Type	Required	Default	Options	Description
Domain URL	SALESFORCE_DOMAIN	Alphanumeric	✅	-	-	The domain used to access your Salesforce instance.
Access Token	SALESFORCE_ACCESS_TOKEN	Password	➖	-	-	Token provided by Salesforce to securely authenticate and access their API.
Consumer Key	SALESFORCE_CONSUMER_KEY	Alphanumeric	➖	-	-	Unique key to identify and authenticate your application's integration.
Consumer Secret	SALESFORCE_CONSUMER_SECRET	Password	➖	-	-	Secret key used in tandem with the consumer key to authenticate your application.
Username	SALESFORCE_USERNAME	Alphanumeric	➖	-	-	Your Salesforce account's username.
Password	SALESFORCE_PASSWORD	Password	➖	-	-	Your Salesforce account's password.
Security Token	SALESFORCE_SECURITY_TOKEN	Password	➖	-	-	Additional security token provided by Salesforce to enhance protection.
Output Filename	SALESFORCE_FILENAME	Alphanumeric	✅	`output.csv`	-	The desired name/path for the resulting CSV file.
Desired Field Names	SALESFORCE_FIELD_NAMES	Alphanumeric	✅	-	-	List of field names from the Salesforce object you want to export.
Object Type	SALESFORCE_OBJECT_TYPE	Alphanumeric	✅	-	-	The specific Salesforce object type (e.g., Account, Customer) you want to export data from. This name must match Salesforce's API Name from their object manager view.

YAML

Below is the YAML template for this Blueprint and can be used in the Fleet YAML Editor.

source:
  blueprint: Salesforce - Download Data to Shipyard
  inputs:
    SALESFORCE_DOMAIN: null  ## REQUIRED
    SALESFORCE_ACCESS_TOKEN: null
    SALESFORCE_CONSUMER_KEY: null
    SALESFORCE_CONSUMER_SECRET: null
    SALESFORCE_USERNAME: null
    SALESFORCE_PASSWORD: null
    SALESFORCE_SECURITY_TOKEN: null
    SALESFORCE_FILENAME: output.csv ## REQUIRED
    SALESFORCE_FIELD_NAMES: null ## REQUIRED
    SALESFORCE_OBJECT_TYPE: null ## REQUIRED
  type: BLUEPRINT
guardrails:
  retry_count: 1
  retry_wait: 0h0m0s
  runtime_cutoff: 1h0m0s
  exclude_exit_code_ranges:
    - '102'
    - '103'
    - '201'
    - '202'
    - '206'

Salesforce - Download Data to Shipyard

Overview​

Variables​

YAML​

Overview

Variables

YAML