Home

Getting Started

For an Overview on what it is, what it does for you and how to install it, please see the README:

• What is it?
• Why would you need it?
• How does it look like?
• How to get it?

Refer to the various HOW-TO articles to get an overview of the basic steps:

• HOW TO #1 – Authorize an Org
• HOW TO #2 – Export Data
• HOW TO #3 – Import Data
• HOW TO #4 – Mass (Hard) Delete Data

Refer to the use case examples for some typical admin tasks:

• Use Case – Reset Data in Sandbox Org
• Use Case – Scheduled Data Backup

Overview of Commands

For detailed explanations of each command, see the Command Reference. All commands support the standard PowerShell means of getting help, e.g.:

Get-SfAuthToken -?
Get-Help Get-SfAuthToken
Get-Help Get-SfAuthToken -Detailed
Get-Help Get-SfAuthToken -Examples

The commands can be grouped into the following types:

• Authentication Handling
  • Get-SfAuthToken (Alias: sfauth) Offers various options to authorize an Org in order to get credentials suitable for data loader.
  • New-SfEncryptionKeyFile
  • ConvertTo-SfEncryptedString
• Data Loader Operations
  • Add-SfRecords (Alias: sfinsert) Invokes Salesforce Data Loader with an INSERT operation to create records from a '.csv' file.
  • Export-SfRecords (Alias: sfextract) Invokes Salesforce Data Loader for a QUERY (EXTRACT) operation and store data in a .csv file.
  • Import-SfRecords (Alias: sfupsert) Invokes Salesforce Data Loader with an UPSERT operation to create/update records from a '.csv' file.
  • Remove-SfRecords Invokes Salesforce Data Loader with an DELETE or HARD_DELETE operation to delete records as given in a '.csv' file.
  • Update-SfRecords (Alias: sfupdate) Invokes Salesforce Data Loader with an UPDATE operation to create/update records from a '.csv' file.
• Utility/Helper Commands
  • ConvertTo-SfFieldList Takes a list (array) of field names converts to a comma-separated list to be used in a SOQL statement.
  • ConvertTo-SfMappingFile
  • Get-SfFieldNames Collects a list of field names from various source file formats and returns as a list (array) of field names.