{"id":3122,"date":"2012-09-26T19:30:09","date_gmt":"2012-09-26T14:00:09","guid":{"rendered":"http:\/\/JitendraZaa.com\/blog\/?p=3122"},"modified":"2017-03-31T17:02:50","modified_gmt":"2017-03-31T17:02:50","slug":"tutorial-of-command-line-dataloader-salesforce","status":"publish","type":"post","link":"https:\/\/www.jitendrazaa.com\/blog\/salesforce\/tutorial-of-command-line-dataloader-salesforce\/","title":{"rendered":"Command line dataloader in Salesforce – Solve Common errors"},"content":{"rendered":"

I had this article in my list for long time and today i got chance to share with you all. Data Loader is great native tool provide by the Salesforce to insert, upsert, update, export and delete data. Standard Data Loader wizard needs interaction however there are many scenarios where we need to perform these data loading tasks repeatedly like every night 1:00 AM (Nightly Services) or something. So, for these situations we can use standard data loader tool from Command line.<\/p>\n

In this article, i will explain in detail on how to use Data Loader from command line.<\/p>\n

The most important part of setting up Command line Data loader is to generate the encrypted password using utility provided by the Data Loader.<\/p>\n

\"Commandline<\/a>
Commandline Data Loader tools<\/figcaption><\/figure>\n

This directory contains two utility batch file : “encrypt.bat”<\/strong>\u00a0and “process.bat”<\/strong><\/p>\n

Navigate to “Program Files | Data Loader | bin” in command prompt and run command.<\/p>\n

\r\nencrypt.bat \u2013g YOURSECRETKEY\r\n<\/pre>\n
\"Generate<\/a>
Generate Secret Key for Command Line Dataloader<\/figcaption><\/figure>\n
The secrete key provided can be anything of your choice. Copy the generated Text highlighted in White color and paste in new file “Key.txt<\/strong>“.<\/p>\n
Now run again above command to generated encrypted password with following command:<\/p>\n
\r\nencrypt.bat -e password "C:Users\\shiva\\Desktop\\Data Loader Documents\\Try\\Key.txt"\r\n<\/pre>\n
\"Commandline<\/a>
Commandline Data Loader generate Encrypted Password<\/figcaption><\/figure>\n
Now, note this password somewhere, as it is going to be used in remaining part of configuration.<\/p>\n
Make sure that password generated is correct by\u00a0checking below command, it will say password Matched or not\u00a0:<\/p>\n
\r\nencrypt.bat -v generatedPassword actualPassword secretKeyFilePath\r\n<\/pre>\n
If you are using proxy server and it uses the password, then repeat same step for generating encrypted password.<\/p>\n
\"Salesforce<\/a>
Salesforce command line dataloader – verify encrypted password<\/figcaption><\/figure>\n
Additionaly, if we type only encrypt.bat without any parameter, it will show all the available options with help text.<\/p>\n
Create file – “config.properties”:<\/strong><\/span><\/p>\n
This file contains all the common configurations settings like UserName, encrypted password. This file can also be kept as blank however it is good practice to write all common configurations in this file. Keys in this file will be same as of “Process-config.xml”<\/strong> as described at the end of this article.<\/p>\n
Example:<\/p>\n
\r\n#Loader Config\r\n#Wed Sep 19 2012\r\nsfdc.debugMessages=true\r\nprocess.encryptionKeyFile=C:\\Users\\shiva\\Desktop\\Data Loader Documents\\Try\\Key.txt\r\nsfdc.debugMessagesFile = C:\\Users\\shiva\\Desktop\\Data Loader Documents\\Try\\AccountExport.log\r\nsfdc.endpoint=https:\/\/login.salesforce.com\r\nsfdc.username=ilovenagpur@gmail.com\r\nsfdc.password=7b5693f0cad856dc778d4b8506f2c976\r\nsfdc.proxyUsername=proxyUserName\r\nsfdc.proxyPassword=encrypytesPassword\r\nsfdc.proxyHost=proxyhostName\r\nsfdc.proxyPort=123\r\nsfdc.loadBatchSize=200\r\nsfdc.timeoutSecs=600\r\n<\/pre>\n
Create file – “process-conf.xml” :<\/strong><\/span><\/p>\n
This file contains all the information regarding import or export. In this article I am exporting the Account data, so sample file is<\/p>\n
\r\n<!DOCTYPE beans PUBLIC "-\/\/SPRING\/\/DTD BEAN\/\/EN" "http:\/\/www.springframework.org\/dtd\/spring-beans.dtd">\r\n<beans>\r\n<bean id="Account"\r\n\tclass="com.salesforce.dataloader.process.ProcessRunner"\r\n\tsingleton="false">\r\n\t\t<description>Export Account Data<\/description>\r\n\t\t<property name="name" value="Account"\/>\r\n\t\t<property name="configOverrideMap">\r\n\t\t<map>\r\n\t\t\t<entry key="sfdc.enableLastRunOutput" value="false"\/>\r\n\t\t\t<entry key="sfdc.entity" value="Account"\/>\r\n\t\t\t<entry key="process.operation" value="extract"\/>\r\n\t\t\t<entry key="sfdc.extractionRequestSize" value="500"\/>\r\n\t\t\t<entry key="sfdc.extractionSOQL" value="SELECT Id FROM Account"\/>\r\n\t\t\t<entry key="dataAccess.name" value="D:\\Data Load\\Seed Data\\Jit\\Production - 16 Aug 12AccountExport.csv"\/>\r\n\t\t\t<entry key="dataAccess.type" value="csvWrite"\/>\r\n\t\t\t<entry key="dataAccess.writeUTF8" value="true" \/>\r\n\t\t<\/map>\r\n\t\t<\/property>\r\n\t<\/bean>\r\n<\/beans>\r\n<\/pre>\n
At the end of this article, you can see the description of all parameters. Assuming that we are inside the bin folder of dataloader then run below Command:<\/p>\n
\r\nProcess.bat "directory path where we have file process-config.xml"  process Name\r\n<\/pre>\n
In our case the process name is Account, process name is nothing but the property “name”.<\/p>\n
\"Run<\/a>
Run Commandline Data Loader<\/figcaption><\/figure>\n
After running the above command your data will be exported in file provided in configuration “process-config.xml” file.<\/p>\n
While working with command line dataloader, there are chances that you get few error. So i am also inclusing few common error and there solutions:<\/p>\n
Error 1:<\/strong>
\nDataloader error: “javax.crypto.BadPaddingException:”Or error loading parameter of sfdc.password<\/strong>
\nSolution :<\/strong>
\nAdd “process.encryptionKeyFile=C:\\Users\\315447\\Desktop\\Data Loader\\key.txt” Either in “config.properties” or “process-conf.xml”<\/p>\n
\r\n<entry key="process.encryptionKeyFile" value="config\/key.txt"\/>\r\n<\/pre>\n
Error 2:<\/strong>
\nError in query: query is empty<\/strong>
\nSolution:<\/strong>
\nOccurs, If “sfdc.extractionSOQL” key in beans node does not have valid SOQL.<\/p>\n
Parameters for Process-config.xml:<\/strong><\/p>\n
\n\n\n\n\t\n\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t
Parameter<\/div><\/th>
Description<\/div><\/th>\n<\/tr>\n<\/thead>\n
<bean id=" PROCESSNAME " class="com.salesforce.lexiloader.process.ProcessRunner" singleton="false"> <\/td>This first line uniquely defines the process in the XML file. This has to be unique and will be used to call the process later on. Only change the PROCESSNAME<\/b> and leave all other parts the same.<\/td>\n<\/tr>\n
<description>  Your Description here  <\/description><\/td>A description of the process.<\/td>\n<\/tr>\n
<property name="name" value="PROCESSNAME "\/><\/td>Copy the PROCESSNAME<\/b> and place it in this parameter. This is used in the log files when debug messages are showing. This is the name that is shown on the debug logs.<\/td>\n<\/tr>\n
<property name="configOverrideMap"> <\/td>These two lines initiate the parameters for the process. They should not be changed and should always be the same.\t<\/td>\n<\/tr>\n
<entry key="sfdc.debugMessages" value="false"\/><\/td>Set this to True<\/b> if you want detailed debug messages to appear in the command line.<\/td>\n<\/tr>\n
<entry key="sfdc.debugMessagesFile" value="c:\\\\dataloader\\\\samples\\\\status\\\\accountMasterSoapTrace.log"\/><\/td>Set the value to a directory and a file to keep the detailed log file in.  WARNING: This can create an extremely large file. Make sure that you have space on your hard drive before this is set.\t<\/td>\n<\/tr>\n
<entry key="sfdc.endpoint" value="https:\/\/www.salesforce.com"\/><\/td>Keep default, unless loading into Sandbox. for sandbox, it is test.salesforce.com.<\/td>\n<\/tr>\n
<entry key="sfdc.username" value="jitendrazaa@winter13Sand.com" \/><\/td>Set this as the username of the user you are importing \/exporting as.<\/td>\n<\/tr>\n
<entry key="sfdc.password" value="b6b3016135f717754590a3e35b1db32b" \/><br\/> <entry key="process.encryptonKeyFile" value="C:\\\\Program Files\\\\salesforce.com\\\\Apex Data Loader 9.0\\\\test\\\\Key.txt" \/><\/td>See this article on how to create Encrypted password for Command line Dataloader in Salesforce<\/td>\n<\/tr>\n
<entry key="sfdc.timeoutSecs" value="600"\/><\/td>System time out value.<\/td>\n<\/tr>\n
<entry key="sfdc.loadBatchSize" value="200"\/><\/td>System batch load size. <\/td>\n<\/tr>\n
<entry key="process.operation" value="extract" \/><\/td>Signifies the process being run. Possible Values:
  • Extract<\/li>
  • Insert<\/li>
  • Delete<\/li>
  • Upsert<\/li><\/ul><\/td>\n<\/tr>\n
<entry key="sfdc.entity" value="Account"\/><\/td>Signifies the object that you are running this process for. This should be the API name of the object when you are running processes for custom objects.<\/td>\n<\/tr>\n
<entry key="sfdc.extractionRequestSize" value="500"\/><\/td>Batch size for extract processes only<\/td>\n<\/tr>\n
<\/td>This is the SOQL query run for extract processes. You can use the Data Loader GUI to generate the SOQL statement and conditions and simply cut and paste into this entry key.<\/td>\n<\/tr>\n
<entry key="dataAccess.type" value="csvWrite" \/><\/td>Signifies the action when doing the process for Extract, Insert, Delete, Upsert. This key should be used in conjunction with the \"process.operation\" key. Possible Values:
  1. csvRead<\/li>
  2. csvWrite<\/li>
  3. databaseRead<\/li>
  4. databaseWrite<\/li><\/ol> When using Extract processes, use csvWrite<\/b>. When using Delete, Insert, and Upsert processes, use csvRead<\/b>.<\/td>\n<\/tr>\n
<entry key="dataAccess.writeUTF8" value="true" \/><\/td>When using a \"csvWrite\" dataccess type, set this to True when you want files to be extracted as UTF-8<\/b>.<\/td>\n<\/tr>\n
<entry key="dataAccess.name" value="<b>C:\\\\Program Files\\\\salesforce.com\\\\Apex Data Loader 9.0\\\\test\\\\extract.csv<\/b>" \/><\/td>Signifies the location and file name of the dataaccess type process. If running a csvRead, the process will look for the file in this location. If running a csvWrite, the process will replace the file in this location.<\/td>\n<\/tr>\n
<entry key="process.mappingFile" value="<b>C:\\\\Program Files\\\\salesforce.com\\\\Apex Data Loader 9.0\\\\test\\\\upsert_mapping.sdl<\/b>"\/><\/td>Signifies the location of a data loader mapping file. This is the same mapping file used when saving a mapping from the data loader GUI. This is required for insert, delete and upsert processes.<\/td>\n<\/tr>\n
<entry key="sfdc.externalIdField" value="Customer_ID__c"\/><\/td>Signifies the External ID field used for the upsert process. This is required for upserts.<\/td>\n<\/tr>\n
<entry key="process.statusOutputDirectory" value="C:\\\\Program Files\\\\salesforce.com\\\\Apex Data Loader 9.0\\\\test\\\\logs\\\\" \/><\/td>Signifies the directory where the data loader success and error files will be created in.<\/td>\n<\/tr>\n
<entry key="process.outputSuccess" value="C:\\\\Program Files\\\\salesforce.com\\\\Apex Data Loader 9.0\\\\test\\\\Logs\\\\csvUpsertProcess_success.csv" \/><br\/><br\/> <entry key="process.outputError" value="C:\\\\Program Files\\\\salesforce.com\\\\Apex Data Loader 9.0\\\\test\\\\Logs\\\\csvUpsertProcess_error.csv" \/><\/td>Signifies the directory and filename where the success and error files will be created. If this key is not specified, the \"process.statusOutputDirectory\"  key will contain similar filenames as ones generated by the data loader GUI. <\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/p>\n","protected":false},"excerpt":{"rendered":"
How to use Command line dataloader in Salesforce with troubleshooting steps and answers to common errors<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"advanced_seo_description":"","jetpack_seo_html_title":"","jetpack_seo_noindex":false,"jetpack_post_was_ever_published":false,"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"jz_research_post":"","_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[9],"tags":[261,58,281,72],"class_list":["post-3122","post","type-post","status-publish","format-standard","hentry","category-salesforce","tag-ant","tag-cli","tag-command-line-dataloader","tag-dataloader"],"jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"jetpack-related-posts":[{"id":4126,"url":"https:\/\/www.jitendrazaa.com\/blog\/salesforce\/automate-command-line-dataloader-using-ant-with-dynamic-arguments-and-query\/","url_meta":{"origin":3122,"position":0},"title":"Automate Command Line Dataloader using ANT with Dynamic arguments and SOQL query","author":"Jitendra","date":"December 27, 2014","format":false,"excerpt":"As we know, there are multiple ways to load data inside Salesforce like using Workbench, Jitterbit, API etc... Salesforce also provides standard tool to load data into Salesforce using DataLoader. Dataloader by default supports User Interface or Command Line interface. Most of us already know that User interface based Dataloader\u2026","rel":"","context":"In "Salesforce"","block_context":{"text":"Salesforce","link":"https:\/\/www.jitendrazaa.com\/blog\/category\/salesforce\/"},"img":{"alt_text":"Automate Command Line Data Loader","src":"https:\/\/i0.wp.com\/www.jitendrazaa.com\/blog\/wp-content\/uploads\/2014\/12\/Automate-Command-Line-Data-Loader.jpg?resize=350%2C200&ssl=1","width":350,"height":200,"srcset":"https:\/\/i0.wp.com\/www.jitendrazaa.com\/blog\/wp-content\/uploads\/2014\/12\/Automate-Command-Line-Data-Loader.jpg?resize=350%2C200&ssl=1 1x, https:\/\/i0.wp.com\/www.jitendrazaa.com\/blog\/wp-content\/uploads\/2014\/12\/Automate-Command-Line-Data-Loader.jpg?resize=525%2C300&ssl=1 1.5x, https:\/\/i0.wp.com\/www.jitendrazaa.com\/blog\/wp-content\/uploads\/2014\/12\/Automate-Command-Line-Data-Loader.jpg?resize=700%2C400&ssl=1 2x"},"classes":[]},{"id":3201,"url":"https:\/\/www.jitendrazaa.com\/blog\/salesforce\/import-user-quotas-for-collaborative-forecasting\/","url_meta":{"origin":3122,"position":1},"title":"Import User Quotas in Amount for Collaborative forecasting","author":"Jitendra","date":"February 24, 2013","format":false,"excerpt":"In Customizable Forecast, we can add the Quota for user by navigating to User Page and going to Quota related list However in Collaborative Forecasting aka Forecast 3 the only way is using Data Loader. 1. Log-in to the Data Loader and use the Insert function. 2. Click \"Show all\u2026","rel":"","context":"In "Configuration"","block_context":{"text":"Configuration","link":"https:\/\/www.jitendrazaa.com\/blog\/category\/salesforce\/configuration\/"},"img":{"alt_text":"Import Quota Using DataLoader","src":"https:\/\/i0.wp.com\/jitendrazaa.com\/blog\/wp-content\/uploads\/2013\/02\/Import-Quota-Using-DataLoader.png?resize=350%2C200&ssl=1","width":350,"height":200,"srcset":"https:\/\/i0.wp.com\/jitendrazaa.com\/blog\/wp-content\/uploads\/2013\/02\/Import-Quota-Using-DataLoader.png?resize=350%2C200&ssl=1 1x, https:\/\/i0.wp.com\/jitendrazaa.com\/blog\/wp-content\/uploads\/2013\/02\/Import-Quota-Using-DataLoader.png?resize=525%2C300&ssl=1 1.5x"},"classes":[]},{"id":5835,"url":"https:\/\/www.jitendrazaa.com\/blog\/salesforce\/considerations-and-best-practices-for-salesforce-dataloading\/","url_meta":{"origin":3122,"position":2},"title":"Considerations and Best practices for Salesforce Dataloading","author":"Jitendra","date":"January 29, 2018","format":false,"excerpt":"Although we are doing data loading in Salesforce from ages, its very common to miss some steps or considerations. Therefore thought to list some of best practices and considerations I follow before or during data load process. Developer note field - I mostly create a text field on every object\u2026","rel":"","context":"In "Salesforce"","block_context":{"text":"Salesforce","link":"https:\/\/www.jitendrazaa.com\/blog\/category\/salesforce\/"},"img":{"alt_text":"Salesforce Dataloader","src":"https:\/\/i0.wp.com\/www.jitendrazaa.com\/blog\/wp-content\/uploads\/2018\/01\/Salesforce-Dataloader.png?resize=350%2C200&ssl=1","width":350,"height":200,"srcset":"https:\/\/i0.wp.com\/www.jitendrazaa.com\/blog\/wp-content\/uploads\/2018\/01\/Salesforce-Dataloader.png?resize=350%2C200&ssl=1 1x, https:\/\/i0.wp.com\/www.jitendrazaa.com\/blog\/wp-content\/uploads\/2018\/01\/Salesforce-Dataloader.png?resize=525%2C300&ssl=1 1.5x, https:\/\/i0.wp.com\/www.jitendrazaa.com\/blog\/wp-content\/uploads\/2018\/01\/Salesforce-Dataloader.png?resize=700%2C400&ssl=1 2x"},"classes":[]},{"id":4431,"url":"https:\/\/www.jitendrazaa.com\/blog\/salesforce\/using-dataloader-and-ant-to-backup-salesforce-data-on-ftp-server-video\/","url_meta":{"origin":3122,"position":3},"title":"Using Dataloader and ANT to backup Salesforce data on FTP or SFTP server – Video","author":"Jitendra","date":"May 4, 2015","format":false,"excerpt":"Tutorial on how to use command line dataloader to save exported Salesforce backup file on FTP or SFTP server","rel":"","context":"In "Salesforce"","block_context":{"text":"Salesforce","link":"https:\/\/www.jitendrazaa.com\/blog\/category\/salesforce\/"},"img":{"alt_text":"Use Dataloader and ANT to back CSV file on FTP Server","src":"https:\/\/i0.wp.com\/www.jitendrazaa.com\/blog\/wp-content\/uploads\/2015\/05\/Use-Dataloader-and-ANT-to-back-CSV-file-on-FTP-Server-1024x391.png?resize=350%2C200&ssl=1","width":350,"height":200,"srcset":"https:\/\/i0.wp.com\/www.jitendrazaa.com\/blog\/wp-content\/uploads\/2015\/05\/Use-Dataloader-and-ANT-to-back-CSV-file-on-FTP-Server-1024x391.png?resize=350%2C200&ssl=1 1x, https:\/\/i0.wp.com\/www.jitendrazaa.com\/blog\/wp-content\/uploads\/2015\/05\/Use-Dataloader-and-ANT-to-back-CSV-file-on-FTP-Server-1024x391.png?resize=525%2C300&ssl=1 1.5x"},"classes":[]},{"id":3218,"url":"https:\/\/www.jitendrazaa.com\/blog\/salesforce\/salesforce-interview-question-part-15\/","url_meta":{"origin":3122,"position":4},"title":"Salesforce Interview Question \u2013 Part 15","author":"Jitendra","date":"May 24, 2013","format":false,"excerpt":"141 : User Wants to set the starting day in Calendar as \"Monday\" instead of \"Sunday\". How to get it done? Ans : Change the user locale to \"English ( United Kingdom ) \" in Personal information or User record. 142 : Why CSS is not working in PDF created\u2026","rel":"","context":"In "Salesforce"","block_context":{"text":"Salesforce","link":"https:\/\/www.jitendrazaa.com\/blog\/category\/salesforce\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":3325,"url":"https:\/\/www.jitendrazaa.com\/blog\/salesforce\/apex-visualforce-data-loader-and-soql-interview-question-part-17\/","url_meta":{"origin":3122,"position":5},"title":"Apex, Visualforce, Data Loader and SOQL Interview Question \u2013 Part 17","author":"Jitendra","date":"October 10, 2013","format":false,"excerpt":"161 : Sometimes while deleting record it gives error \"Object cannot be Deleted\". What is the reason for this kind of error ? Ans : This is generic error message prompted by Salesforce many times, which is not well informative. To get informative message, we can try to delete same\u2026","rel":"","context":"In "Apex"","block_context":{"text":"Apex","link":"https:\/\/www.jitendrazaa.com\/blog\/category\/salesforce\/apex\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]}],"jetpack_likes_enabled":true,"_links":{"self":[{"href":"https:\/\/www.jitendrazaa.com\/blog\/wp-json\/wp\/v2\/posts\/3122","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.jitendrazaa.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.jitendrazaa.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.jitendrazaa.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.jitendrazaa.com\/blog\/wp-json\/wp\/v2\/comments?post=3122"}],"version-history":[{"count":12,"href":"https:\/\/www.jitendrazaa.com\/blog\/wp-json\/wp\/v2\/posts\/3122\/revisions"}],"predecessor-version":[{"id":5982,"href":"https:\/\/www.jitendrazaa.com\/blog\/wp-json\/wp\/v2\/posts\/3122\/revisions\/5982"}],"wp:attachment":[{"href":"https:\/\/www.jitendrazaa.com\/blog\/wp-json\/wp\/v2\/media?parent=3122"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.jitendrazaa.com\/blog\/wp-json\/wp\/v2\/categories?post=3122"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.jitendrazaa.com\/blog\/wp-json\/wp\/v2\/tags?post=3122"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}