Data Export Command Line

The FuseIT.G4S.DataExportConsole.exe application can be executed directly from the command prompt (via cmd window) or you can embed the command line in a script file.

Prerequisites

The Data Export Command Line tool requires the .NET Framework 3.5 to be available.

Without it you may see a message like:

"This app can't run on your PC
To find a version for your PC, check with the software publisher"
- Windows Server 2012 R2 

See Enable .NET Framework 3.5 by using the Add Roles and Features Wizard

Usage


You can see argument help if you use: 

FuseIT.SFDC.DataExportConsole.exe /?

There are two ways to use the command line. By specifying the login details (1) or by supplying a connection string (2).

1. Specifying Login Details

The following arguments are required:

  • /u:
    Salesforce.com Partner API user name
  • /p:
    Salesforce.com Partner API password
  • /t:
    Salesforce.com Partner API security token
  • /e:
    Salesforce binding environment. Required to be one of the following:
    • Production
    • DeveloperEdition
    • Sandbox
    • Pre_release
  • save path: 
    File path where the exported zip files will be saved (enclose in "speech marks", back slashes should be escaped)

An example command line might look like: 

FuseIT.SFDC.DataExportConsole.exe /u:user@test.com /p:12345678 /t:C3P3qivIf5t6Q6uYtzxxxxxx /e:Production "C:\\SFDCexports"

2. Supplying a Connection String

The connection string can be generated in the FuseIT SFDC Explorer, and then copied into the FuseIT.SFDC.DataExportConsole.exe.config (See Login Section). To add a connection string to the FuseIT.SFDC.DataExportConsole.exe, browse to the directory where the FuseIT.SFDC.DataExportConsole.exe was installed and open the FuseIT.SFDC.DataExportConsole.exe.config file. Find the element <connectionStrings> and insert your connection string within this tag.


An example connection string (without proxy authentication):

<add name="testConnectionString" connectionString="G4S:user id=testuser@test.com;password=test;token=Y3623283JAADJK7;enviroment=Production;" />

Additionally, if you are using the FuseIT.SFDC.DataExportConsole.exe through a proxy, the connection string would look like:

<add name="testConnectionString" connectionString="G4S:user id=testuser@test.com;password=test;token=Y3623283JAADJK7;environment=Production;proxyserver=192.168.132.123; proxyport=808;proxyusername=test; proxypassword=test!;proxyauthentication=PROPRIETARY; proxyssltype=ALWAYS" />

When using the FuseIT.SFDC.DataExportConsole.exe in the command line the following arguments are required:

  • /c:
    connectionstringname
    : The name of the connection string - as specified in the FuseIT.SFDC.DataExportConsole.exe.config
  • Save path 
    Server file path where the exported zip files will be saved (enclose in "speech marks", back-slashes should be escaped)

An example command line using a connection string might look like:

FuseIT.SFDC.DataExportConsole.exe /c:testConnectionString "C:\\SFDCexports"

See additional configuration options in FuseIT SFDC Data Exporter - AppSettings

Automated Data Export retrieval

Once the command line tool is configured you can automate the process by scheduling a task in Windows to invoke it at the required date and time.

Configuration Options

  1. bufferSize - The download buffer size (in kilobytes). Defaults to 16 kilobytes. Reducing may help avoid timeout issues. Increasing can improve download speed.

    Buffer Size
    <!--Set the download block size. Default set to 16k bytes -->
    <add key="bufferSize" value="16"/>
  2. maxRetry - How many times to retry a download that is failing. Defaults to 3. 

    Max Retry
    <!--Set the maximum retry value. 
        If the maxRetry value is 0 the download operation will be tried only once.
        Default value is set to 3 -->
    <add key="maxRetry" value="3"/>