P. 1
Sales Force Data Loader

Sales Force Data Loader

|Views: 1,025|Likes:
Published by hertzel

More info:

Published by: hertzel on May 21, 2011
Copyright:Attribution Non-commercial

Availability:

Read on Scribd mobile: iPhone, iPad and Android.
download as PDF, TXT or read online from Scribd
See more
See less

05/21/2011

pdf

text

original

Sections

  • Data Loader Overview
  • DATA LOADER
  • When to Use the Data Loader
  • Use the Data Loader when:
  • Data Loader When to Use the Data Loader
  • INSTALLING AND CONFIGURING THE DATA LOADER
  • Installing the Data Loader
  • Installing and Confguring the Data Loader Installing the Data Loader
  • Confguring the Data Loader
  • USING DATA LOADER
  • Exporting Data
  • Defning Field Mappings
  • Inserting, Updating, or Deleting Data Using the Data Loader
  • Performing Mass Updates
  • Uploading Attachments
  • Reviewing Output Files
  • RUNNING BATCH PROCESSES
  • Running in Batch Mode
  • Understanding Installed Directories and Files
  • Encrypting From the Command Line
  • Upgrading Your Batch Mode Interface
  • Using the Command Line Interface
  • Confguring Batch Processes
  • Running Batch Processes Confguring Batch Processes
  • Data Loader Process Confguration Parameters
  • Data Loader Command Line Operations
  • Confguring Database Access
  • id
  • Data Access Objects
  • Mapping Columns
  • Running Individual Batch Processes
  • Data Loader Third-Party Licenses
  • Running Batch Processes Running Individual Batch Processes
  • Index

Salesforce: Spring '11

Data Loader Developer's Guide

Last updated: April 10, 2011
© Copyright 2000-2011 salesforce.com, inc. All rights reserved. Salesforce.com is a registered trademark of salesforce.com, inc., as are other

names and marks. Other marks appearing herein may be trademarks of their respective owners.

Table of Contents

Table of Contents
Data Loader.........................................................................................................................................1
Data Loader Overview..............................................................................................................................................................1 When to Use the Data Loader..................................................................................................................................................2 Installing and Configuring the Data Loader.............................................................................................................................3 Using Data Loader....................................................................................................................................................................9 Running Batch Processes........................................................................................................................................................18 Data Loader Third-Party Licenses..........................................................................................................................................35 Index...................................................................................................................................................................................................37

i

Table of Contents

ii

mappings. see the following topics: • • When to Use the Data Loader Installing the Data Loader 1 . including custom objects Detailed success and error log files in CSV format A built-in CSV file viewer Support for Windows 7 and Windows XP In addition. use a tab or other delimiter. the Data Loader reads. You can use Data Loader interactively through its user interface. When you set up batch processes through the command line. data sources. you work interactively to specify the configuration parameters. it outputs CSV files. extracts. we encourage you to use Data Loader on Windows 7 instead. update. Use it to insert. delete. you specify the configuration. CSV files used for import and export. When exporting data. an open source version of Data Loader is available here. and the field mappings that map the field names in your import file with the field names in Salesforce. To get started. and Developer Editions The Data Loader is a client application for the bulk import or export of data.DATA LOADER Data Loader Overview Available in: Enterprise. Unlimited. When importing data. Note: If commas are not appropriate for your locale. When you use the user interface. and loads data from comma separated values (CSV) files or from a database connection. and actions in files used for automated processing. Note: If you are currently using Windows 2000. or export Salesforce records. or set up automated batch processes launched from the command line. The Data Loader offers the following key features: • • • • • • • • An easy-to-use wizard interface for interactive use An alternate command line interface for automated batch operations Support for large files with up to 5 million records Drag-and-drop field mapping Support for all objects.

Unlimited. contact email address. we recommend you work with a Salesforce. If you need to load more than 5.” When to Use the Data Loader Available in: Enterprise.000 records. such as nightly imports. and Developer Editions The Data Loader complements the web-based import wizards that are accessible from the Setup menu in the online application. or lead email address. You want to schedule regular data loads. You want to prevent duplicates by uploading records according to account name and site. You want to export your data for backup purposes. 2 . The object you need to import is supported by the web-based import wizards.000 to 5. You need to load into an object that is not yet supported by web-based importing.Data Loader When to Use the Data Loader Note: In previous versions.000. the Data Loader has been known as the “AppExchange Data Loader“ and the “Sforce Data Loader. Refer to the following guidelines to determine which method of importing best suits your business needs: Use the Data Loader when: • • • • You need to load 50.000 records.000 records.000. Use Web-based importing when: • • • You are loading less than 50.com partner.

you need: • • • • • Windows 7 or Windows XP. You can run the Data Loader wizards or run the application from the command line. Sun JVM 1. Installation Procedure Caution: Over time. Click Next. 90 MB free disk space. The latest version is always available from Salesforce at Your Name ➤ Setup ➤ Data Management ➤ Data Loader. Note: If you are currently using Windows 2000. “Create” on accounts to insert new accounts System Requirements To use the Data Loader. Different versions have different entries in the Add or Remove Programs dialog in your Windows Control Panel. Click Download the Data Loader and save the installer to your PC.” You can run different versions at the same time on one computer. Double-click the downloaded file to launch the InstallShield wizard. for example. Accept the license agreement and click Next.5 or later (Windows XP or Windows 7).5 or later (Windows XP or Windows 7). 3 . 2. 256 MB available memory. Unlimited. In the online application. we encourage you to use Data Loader on Windows 7 instead. click Your Name ➤ Setup ➤ Data Management ➤ Data Loader. and Developer Editions User Permissions Needed To access the page to download the Data Loader: To use the Data Loader: “Modify All Data” The appropriate user permission for the operation you are doing. 4. However. If you have previously installed the latest version and want to install it again. first remove it from your computer by using the Add or Remove Programs dialog in the Windows Control Panel. 3. Java JRE 1. 5. multiple versions of the Data Loader client application have been available for download.Installing and Configuring the Data Loader Installing the Data Loader INSTALLING AND CONFIGURING THE DATA LOADER Installing the Data Loader Available in: Enterprise. 1. do not install multiple copies of the same version. Some versions were released with earlier product names such as “AppExchange Data Loader” or “Sforce Data Loader.

. To set a field value to null when the Use Bulk API option is selected. and Developer Editions Use the Settings menu to change the default operation settings of the Data Loader. 7. Tip: If you experience login issues in the command line interface after upgrading to a new version of the Data Loader. 4 .com ➤ Data Loader ➤ Data Loader. or click Change. to choose another directory. or delete operation. or choose Start ➤ All Programs ➤ salesforce. update. Click Install. For example. and your security token is XXXXXXXXXX. 3.Installing and Configuring the Data Loader Configuring the Data Loader 6. upsert. Salesforce automatically sends you an activation email that you can use to log in. Unlimited. Click Next. this option instructs the Data Loader to overwrite any existing data in mapped fields. you must enter mypasswordXXXXXXXXXX to log in. records moving to or from Salesforce are processed in increments of this size. see Encrypting From the Command Line on page 19. Configuring the Data Loader Available in: Enterprise. 8. Note that when you are updating records. Edit the fields as desired: Field Batch Size Description In a single insert. Empty field values are ignored when you update records using the Bulk API. logins from untrusted IPs are blocked until they're activated.000 if the Use Bulk API option is selected. Logging In to the Data Loader If your organization restricts IP addresses. We recommend a value between 50 and 100. please try re-encrypting your password to solve the problem.com ➤ Data Loader ➤ Data Loader. This option is not available if the Use Bulk API option is selected. if your password is mypassword. The email contains a security token that you must add to the end of your password. For information on the password encryption utility. Choose Settings ➤ Settings. The maximum value is 200. use a field value of #N/A. To start the Data Loader. Insert Null Values Enable this option to insert blank mapped values as null values during data operations. The maximum value is 10. Accept the default installation directory. double-click the Data Loader icon on your desktop. Start the Data Loader by choosing Start ➤ Programs ➤ salesforce. Click Finish.. 9. 2. 1.

To turn off compression. disable this option. Select this option to direct the Data Loader to truncate data in the following types of fields when loading that data into Salesforce: Email. Picklist. Text. This option forces files to open in UTF-8 encoding. Phone. truncation. It also applies to updates on accounts if your organization has territory assignment rules on accounts. By default. Larger values may improve performance. To turn off this automatic reset. You may want to disable compression if you need to debug the underlying SOAP messages.0 and later. updates. if you are loading into a sandbox. In Data Loader versions 14. enable this option. Specify how many seconds the Data Loader waits to receive a response back from the server before returning an error for the request.000. The maximum value is 2. records are returned from Salesforce in increments of this size. The assignment rule overrides Owner values in your CSV file. This option forces files to be written in UTF-8 encoding. the load operation fails if a value is specified that is too large. This option applies to inserts. Compression enhances the performance of the Data Loader and is turned on by default.salesforce. but use more memory on the client. In Data Loader version 15.com. Enter the URL of the Salesforce server with which you want to communicate. For example. Select this option to support the date formats dd/MM/yyyy and dd/MM/yyyy HH:mm:ss. values for fields of those types are truncated by the Data Loader if they are too large. In a single export or query operation. Selecting this option allows you to specify that the previous behavior. even if they were saved in a different format. change the URL to https://test. Multi-select Picklist. be used instead of the new behavior in Server Host Reset URL on Login Compression Timeout Query Request Size Generate success files for exports Read all CSVs with UTF-8 encoding Write all CSVs with UTF-8 encoding Use European Date Format Allow field truncation 5 . and Text (Encrypted). updates.0 and earlier. and upserts. and upserts on cases and leads. Salesforce resets the URL after login to the one specified in Server Host. Select this option to generate a success file when exporting data.Installing and Configuring the Data Loader Configuring the Data Loader Field Assignment Rule Description Specify the ID of the assignment rule to use for inserts.

• • If no value is specified. It is faster than the default SOAP-based API due to parallel processing and fewer network round-trips. the value specified here is used. Valid values are any time zone identifier which can be passed to the Java getTimeZone(java. and hard delete records. the load operation fails for the row if a value is specified that is too large for the field.lang. such as Attachment records or Salesforce CRM Content. Using serial mode guarantees that batches are processed one at a time.0 and later. Bulk API Hard Delete. In that case. Instead. This option is not available if the Use Bulk API option is selected. update. upsert. the deleted records are not stored in the Recycle Bin. If an incorrect value is entered. The administrative permission for this operation. they become immediately eligible for deletion.0 and earlier.String) method. A Salesforce user license is required for hard delete. Use Bulk API Select this option to use the Bulk API to insert. GMT is used as the time zone and this fact is noted in the Data Loader log. is disabled by default and must be enabled by an administrator.Installing and Configuring the Data Loader Configuring the Data Loader Field Description Data Loader versions 15. Processing in parallel can cause database contention. This option is selected by default and has no effect in versions 14. The Bulk API is optimized to load or delete a large number of records asynchronously. the load may fail. the time zone of the computer where Data Loader is installed is used. Note that using this option may significantly increase the processing time for a load. Upload Bulk API Batch as Zip File (enable to upload binary attachments) Select this option to use the Bulk API to upload zip files containing binary attachments. Caution: When you select the Hard Delete operation. This option is only available if the Use Bulk API option is selected. Time zone If a date value does not include a time zone. The value can be a full name such as 6 .. delete. This option is only available if the Use Bulk API option is selected. Enable serial mode for Bulk API Select this option to use serial instead of parallel processing for the Bulk API. When this is severe.

or a custom ID such as GMT-8:00.Installing and Configuring the Data Loader Configuring the Data Loader Field Description America/Los_Angeles. Unlimited. The name of the Windows domain used for NTLM authentication. The username for proxy server authentication. To set a field value to null when the Use Bulk API option is selected. there are some differences in behavior in Data Loader when you enable the Bulk API. 7 . Click OK to save your settings. Empty field values are ignored when you update records using the Bulk API. see Configuring the Data Loader on page 4 The following settings are not available on the Settings ➤ Settings page in Data Loader when the Use Bulk API option is selected: Insert Null Values This option enables Data Loader to insert blank mapped values as null values during data operations when the Bulk API is disabled. if applicable. The password for proxy server authentication. A load operation fails for the row if a value is specified that is too large for the field when the Use Bulk API option is selected. For more information. Proxy Host Proxy Port Proxy Username Proxy Password Proxy NTLM domain The host name of the proxy server. However. One important difference is that it allows you execute a hard delete if you have the administrative permission and license. Start at row 4. The proxy server port. and Developer Editions Enabling the Bulk API in Data Loader allows you to load or delete a large number of records faster than using the default SOAP-based API. If your last operation failed. you can use this setting to begin where the last successful operation finished. use a field value of #N/A. Data Loader Behavior with Bulk API Enabled Available in: Enterprise. Allow field truncation This option directs Data Loader to truncate data for certain field types when the Bulk API is disabled.

com ➤ Data Loader ➤ Data Loader. Select the Use Bulk API option. When this is severe. 2. Click Remove. the deleted records are not stored in the Recycle Bin. Note: You can also select the Enable serial mode for Bulk API option.Installing and Configuring the Data Loader Uninstalling the Data Loader Configuring the Data Loader to Use the Bulk API Available in: Enterprise. It is faster than the SOAP-based API due to parallel processing and fewer network round-trips. Instead. Unlimited. 3. Note that using this option may significantly increase the processing time for a load. Click OK. Caution: When you select the Hard Delete operation. The administrative permission for this operation. 4. deleting. and hard deleting records: 1. To configure Data Loader to use the Bulk API for inserting. Go to Start ➤ Control Panel ➤ Add or Remove Programs. Uninstalling the Data Loader Available in: Enterprise. Bulk API Hard Delete. Using serial mode guarantees that batches are processed one at a time. is disabled by default and must be enabled by an administrator. Unlimited. and Developer Editions To uninstall the Data Loader client application: 1. The uninstaller removes the program from your computer. Select the Data Loader program. Data Loader uses the SOAP-based API to process records. Processing in parallel can cause database contention. the load may fail. A Salesforce user license is required for hard delete. By default. updating. 8 . Start the Data Loader by choosing Start ➤ Programs ➤ salesforce. 2. 3. Choose Settings ➤ Settings. and Developer Editions The Bulk API is optimized to load or delete a large number of records asynchronously. upserting. they become immediately eligible for deletion.

Using Data Loader Data Types Supported by the Data Loader USING DATA LOADER Data Types Supported by the Data Loader Available in: Enterprise. For more information. “on”.SSS'Z' yyyy-MM-dd'T'HH:mm:ss.SSS+/-HHmm: • • • • • • • • yyyy is the four-digit year MM is the two-digit month (01-12) dd is the two-digit day (01-31) HH is the two-digit hour (00-23) mm is the two-digit minute (00-59) ss is the two-digit seconds (00-59) SSS is the three-digit milliseconds (000-999) +/-HHmm is the Zulu (UTC) time zone offset The following date formats are also supported: • • • • • • • • • • yyyy-MM-dd'T'HH:mm:ss. “n”.SSS -800 yyyy-MM-dd'T'HH:mm:ss.SSS Pacific Standard Time yyyy-MM-dd'T'HH:mm:ss. “true”. “1” False values (case insensitive) = “no”.SSS GMT-08:00 yyyy-MM-dd'T'HH:mm:ss. Unlimited. “off ”. “0” Date Formats We recommend you specify dates in the format yyyy-MM-ddTHH:mm:ss. see Uploading Attachments on page 15 and Uploading Content with the Data Loader on page 16. “y”.SSSPST yyyy-MM-dd'T'HH:mm:ss.SSSPacific Standard Time yyyy-MM-dd'T'HH:mm:ss. Base64 fields are only used to insert or update attachments and Salesforce CRM Content.SSS PST yyyy-MM-dd'T'HH:mm:ss.SSSGMT-08:00 yyyy-MM-dd'T'HH:mm:ss. and Developer Editions Data Loader supports the following data types: Base64 String path to file (converts the file to a base64–encoded array).SSS-800 yyyy-MM-dd'T'HH:mm:ss 9 . “false”. Boolean • • True values (case insensitive) = “yes”.

or 4:00 PM on December 31. or just after midnight on December 31. The earliest valid date is 1700-01-01T00:00:00Z GMT. we recommend that you change your computer setting to GMT in order to avoid date adjustments when inserting or updating records. make sure that all Salesforce IDs you enter in the Data Loader are in the correct case. 4000. Note: These values are offset by your timezone. 1699. The latest valid date is 4000-12-31T00:00:00Z GMT. 10 .” Only dates within a certain range are valid. search for “data loader date. If your computer's locale is east of Greenwich Mean Time (GMT). or just after midnight on January 1. select the Use European date format box in the Settings dialog. Tip: To ensure data quality. A knowledge base solution for this issue is available in the Salesforce Help & Training window. in the Pacific timezone. For example. invalid XML characters are removed. the earliest valid date is 1699-12-31T16:00:00.Using Data Loader Data Types Supported by the Data Loader • • • • • yyyy-MM-dd HH:mm:ss yyyyMMdd'T'HH:mm:ss yyyy-MM-dd MM/dd/yyyy HH:mm:ss MM/dd/yyyy Note the following tips for date formats: • • To enable date formats that begin with the day rather than the month. • Double Standard double string ID A Salesforce ID is a case-sensitive 15-character or case–insensitive 18-character alphanumeric string that uniquely identifies a particular record. 1700. Integer Standard integer string String All valid XML strings. European date formats aredd/MM/yyyy and dd/MM/yyyy HH:mm:ss.

For example. you will not be asked to log in again. logins from untrusted IPs are blocked until they're activated. with developer name noted in parentheses. Start the Data Loader by choosing Start ➤ Programs ➤ salesforce. As you follow the next steps. or click No to choose another file. If your object name does not display in the default list. The email contains a security token that you must add to the end of your password. Pricebook2. 7. SOQL allows you to specify the source object (such as account). For example. Click Next. select conditions to filter your data set. Click Browse. and Developer Editions User Permissions Needed To export records: To export all records: “Read” on the records “Read” on the records You can use the Data Loader export wizard to extract data from any Salesforce object. Create a SOQL query for the data export. If you select an existing file. Unlimited. to select the CSV file to which the data will be exported. the contents of that file are replaced. Choose the fields you want to export. you will see that the CSV viewer displays all the Account names and their IDs.Using Data Loader Exporting Data Exporting Data Available in: Enterprise. click Next. if your password is mypassword. 6.ProductCode FROM PricebookEntry WHERE IsActive = true 11 . Salesforce automatically sends you an activation email that you can use to log in. a list of fields to retrieve. Optionally.. For example: Select Name. see the Web Services API Developer's Guide.Name.. c. Choose an object. You can enter a new file name to create a new file or choose an existing file. Tip: You can use a SOQL relationship query to include fields from a related object. Product2Id. Pricebook2Id. a. and conditions for selecting rows in the source object. The objects will be listed by localized label name. SOQL is the Salesforce Object Query Language that allows you to construct simple but powerful query strings. These commands can also be found in the File menu. Click Export or Export All . If you do not select any conditions. Click Log in to log in. Click Yes to confirm this action. b. 3. select the Account object. When you export. Product2. 2.com ➤ Data Loader ➤ Data Loader. Enter your Salesforce username and password. Review the generated query and edit if necessary. and your security token is XXXXXXXXXX. you must enter mypasswordXXXXXXXXXX to log in. (Until you log out or close the program. 5. check Id and Name in the query fields and click Finish. 1. all the data to which you have read access will be returned. For object descriptions. you can choose to include (Export All) or exclude (Export) soft-deleted records. 4. Similar to the SELECT command in SQL. check Show all objects to see a complete list of objects that you can access. For example. After your login completes successfully.) If your organization restricts IP addresses.

UnitPrice. 10. For more information.Family FROM OpportunityLineItems) FROM Opportunity For more information on SOQL. The Data Loader automatically populates the list at the bottom of the window. 9. Specify a name for the SDL mapping file. 12 .product2.Name FROM Contact When using relationship queries in the Data Loader. delete.Using Data Loader Defining Field Mappings Or: Select Id. 1. For example. Name. using ACCOUNT. or click OK to close. click and drag the Name field to the right of the NAME column header field. and Developer Editions Whenever you insert. Defining Field Mappings Available in: Enterprise. Note: The Data Loader currently does not support the extraction of attachments. Click Yes to confirm this action. As a workaround. a confirmation window summarizes your results. or click No to choose another file. (SELECT Quantity. Unlimited. Id. Updating. click Save Mapping to save this mapping for future use.Name does not work. see the Web Services API Developer's Guide. see Inserting. if you are inserting new Account records where your CSV file contains the names of new accounts. For more details. Click View Extraction to view the CSV file. PricebookEntry. then click Yes to confirm. Click OK to use your mapping for the current operation. Optionally. click and drag fields from the list of Salesforce fields at the top to the list of CSV column header names at the bottom. automatic matching works only on the ID field. we recommend that you use the weekly export feature in the online application to export attachments. or Deleting Data Using the Data Loader on page 13. To automatically match fields with columns. 2. the fully specified field names are case-sensitive. If you select an existing file. see Reviewing Output Files on page 17. The Data Loader does not support nested queries or querying child objects. click Auto-Match Fields to Columns. Account. 4. PricebookEntry. For example. For example. 3. LastName. 8. ListPrice. To manually match fields with columns. Note that for a delete operation. based on the similarity of field and column names. A progress information window reports the status of the operation.NAME instead of Account. Click Finish. the contents of that file are replaced.Name. PriceBookEntry. or update files. use the Mapping Dialog window to associate Salesforce fields with the columns of your CSV file. queries similar to the following return an error: SELECT Amount. After the operation completes.

update. Enter your Salesforce username and password. After the object and CSV file are initialized. to insert new Account records. 2. logins from untrusted IPs are blocked until they're activated. Update. the existing record is updated with the values in your file. see the Web Services API Developer's Guide. see “Custom Field Attributes” in the Salesforce online help. The email contains a security token that you must add to the end of your password. Id is automatically used. you could specify a CSV file named insertaccounts.) If your organization restricts IP addresses. After your login completes successfully. or Deleting Data Using the Data Loader Inserting. if your password is mypassword. or delete existing records. if you are inserting Account records. click Next. see Configuring the Data Loader on page 4. or Deleting Data Using the Data Loader Available in: Enterprise. select Account. For example. then the record is created as new. you must enter mypasswordXXXXXXXXXX to log in. 3. 6. 13 . and your security token is XXXXXXXXXX. you are not asked to log in again. 4.if a record in your file matches an existing record. (Until you log out or close the program. click OK. From the drop-down list. For more information on external IDs. 1. For example.. Delete or Hard Delete. 5. For object descriptions. The objects are listed by localized label name. For more information. For example. Click Browse. Click Next. modify existing records. the deleted records are not stored in the Recycle Bin and become immediately eligible for deletion. begin by clicking Insert.Using Data Loader Inserting. check Show all objects to see a complete list of the objects that you can access. These commands can also be found in the File menu. Updating. or Id (the Salesforce record ID). Choose an object.. If your object name does not display in the default list. Updating. Start the Data Loader by choosing Start ➤ Programs ➤ salesforce. to select your CSV file. If you are performing an upsert: a. Your CSV file must contain a column of ID values for matching against existing records. if you are inserting Account records. If no match is found. and hard delete wizards in the Data Loader allow you to add new records. and Developer Editions User Permissions Needed To insert records: To update records: To upsert records: To delete records: To hard delete records “Create” on the record “Edit” on the record “Create” or “Edit” on the record “Delete” on the record “Delete” on the record The insert. upsert. For example. 7. When you hard delete records.com ➤ Data Loader ➤ Data Loader. Click Insert. If the object has no external ID fields. The column may be either an external ID (a custom field with the “External ID” attribute). Upsert.csv containing a Name column for the names of the new accounts. Note that “upsert” is a combination of inserting and updating . Click Next to continue. with developer name noted in parentheses. select which field to use for matching. delete. Click Log in to log in. Salesforce automatically sends you an activation email that you can use to log in. Unlimited.

or Deleting Data Using the Data Loader on page 13. Tip: • • If you are updating or deleting large amounts of data. See Inserting. If you made a mistake. one file name starts with “success. If you get a timeout error when loading a file. review Performing Mass Updates and Performing Mass Deletes for tips and best practices. to specify a directory for these files. Click Choose an Existing Map to select an existing field mapping.. save an extra copy of the generated CSV file. For more details and an example of usage. Launch the Data Loader and follow the update wizard. See Reviewing Output Files on page 17. If you make no selection here. Click Next to continue. 8. 12. 2. Make sure your report includes the record ID. Note that matching is done according to record ID. 13. Obtain your data by performing an export of the objects you wish to update. review your success and error log files. Define how the columns in your CSV file map to Salesforce fields. Even if the processing failed. some records could have completed successfully. or click OK to close. so you must check the results. Also. After the operation. Unlimited. For every operation. As the operation proceeds. Open your working file in a CSV editor such as Excel. There is a five-minute limit to process 100 records when the Bulk API is enabled. or Deleting Data Using the Data Loader b.. If your file includes the external IDs of an object that has a relationship to your chosen object. Updating. Click Next. a confirmation window summarizes your results. Click View Successes to view your success file.” Click Browse. As a backup measure. and try again. 11. 10. If the Bulk API continues to exceed the 10-minute limit on subsequent attempts. a progress information window reports the status of the data movement. 6. Performing Mass Updates Available in: Enterprise. Updating.Using Data Loader Inserting. or “Running Reports” in the Salesforce online help. you can use the related object's Id field for matching by mapping it in the next step. or by running a report. 14 . or click Create or Edit a Map to create a new map or modify an existing map. 5. 3. click View Errors to open your errors file.” while the other starts with “error. the Data Loader generates two unique CSV log files. Click Finish to perform the operation. see Defining Field Mappings on page 12. and Developer Editions To update a large number of records at one time. the file is placed back in the queue and reprocessed up to 10 times before the operation is permanently marked as failed. and update your data. 4. the Bulk API places the remainder of the file back in the queue for later processing. see Reviewing Output Files on page 17. we recommend the following steps: 1. split your file into smaller files. 9. For more information. use the backup file to update the records to their previous values. if it takes longer than 10 minutes to process a file. See Exporting Data on page 11. and then click Yes to confirm. After the operation completes. enable that external ID for record matching by selecting its name from the drop-down list.

such as myattachment.C:\Export\attachment1.jpg. checkbox. 15 . Map only the ID column. You can use this CSV file to upload the attachments.jpg. Body . Updating. or Deleting Data Using the Data Loader on page 13. note the following: • • If you intend to upload via the Bulk API. review your success and error log files. see “Exporting Backup Data” in the Salesforce online help. Next.gif 701300000000iNHAAY. After the operation. As a backup measure.) Save an extra copy of the generated CSV file. make sure to select the Show all Salesforce objects checkbox and the Attachment object name in the list.Using Data Loader Uploading Attachments Performing Mass Deletes Available in: Enterprise. Your CSV file might look like this: ParentId. Name . such as Description.attachment1.the name of the attachment file. see Inserting. 4. To upload attachments: 1. Before uploading attachments. 3.. For more information on the weekly export service. 2. Ensure that the values in the Body column contain the full file name of the attachments as they exist on your computer. On the Schedule Export page. Unlimited. At the Select data objects step. begin by requesting a weekly data export for the source organization.Name.the Salesforce ID of the parent record.doc The CSV file can also include other optional Attachment fields.jpg. (See Exporting Data on page 11. For example. See Reviewing Output Files on page 17. Confirm that the CSV file you intend to use for attachment importing contains the following required columns (each column represents a Salesforce field): • • • ParentId . if an attachment named myattachment.C:\Export\files\attachment2. Updating. being sure to select all fields. 2. this time using only the record ID as the desired criteria. Uploading Attachments You can use the Data Loader to upload attachments to Salesforce.attachment2. which causes the file Attachment. we recommend the following steps: 1.. verify that Upload Bulk API Batch as Zip File (enable to upload binary attachments) on the Settings ➤ Settings page is enabled.the absolute path to the attachment on your local drive. Proceed with an insert or upsert operation. See Inserting. and Developer Editions To delete a large number of records at one time using the Data Loader. If you are migrating attachments from a source Salesforce organization to a target Salesforce organization. Launch the Data Loader and follow the delete or hard delete wizard. export the objects you wish to delete.Body 50030000000VDowAAG.csv to be included in your export. Body must specify C:\Export\myattachment. or Deleting Data Using the Data Loader on page 13.jpg is located on your computer at C:\Export. export the objects you wish to delete.doc. make sure to select the Include Attachments.

complete file path on your local drive (for uploading documents only). Log in to Salesforce. you must specify the URL in ContentUrl. Your SOQL query might look like this: Select Id.complete file path on your local drive (for uploading documents only). OwnerId . Note: If there are commas in the description.content type ID. you must specify the actual path in the VersionData and PathOnClient fields in the CSV file. RecordTypeId . Unlimited. 16 . defaults to the user uploading the file. Note: Files are converted to base64 encoding on upload. ContentUrl . Do not use PathOnClient or VersionData to upload links. When you upload a document from your local drive using the Data Loader. This adds approximately 30% to the file size.Using Data Loader Uploading Content with the Data Loader Uploading Content with the Data Loader Available in: Enterprise.(optional) file or link description. • • • • • PathOnClient . VersionData identifies the location and extracts the format and PathOnClient identifies the type of document being uploaded. Create a CSV file with the following fields: • • Title . and Developer Editions You can use the Data Loader to bulk upload documents and links into workspaces in Salesforce CRM Content.(optional) file owner. To determine the RecordTypeId values for your organization using the Data Loader. • • 1. Before uploading documents or links. Description . note the following: • • If you intend to upload via the Bulk API. Name FROM RecordType WHERE SobjectType = 'ContentVersion' To determine the RecordTypeId values for your organization using the AJAX Toolkit: a. • VersionData . follow the steps in Exporting Data. FirstPublishLocationId . you must specify RecordTypeId. Note: If you publish to a workspace that has restricted content types.file name. You can't export content using the Data Loader. When you upload a link using the Data Loader. use double quotes around the text.URL (for uploading links only). verify that Upload Bulk API Batch as Zip File (enable to upload binary attachments) on the Settings ➤ Settings page is enabled.workspace ID.

OwnerId.FirstPublishLocationId. Each row in the CSV file corresponds to one Salesforce record. Click on the arrows for recordTypeInfos. The CSV file opens in a new window. One file name starts with “success. select the Generate success files for exports setting. For more information.005000000000000. In it. In the AJAX Toolkit Shell page type: sforce. Click Close to return to the CSV Chooser window.” while the other starts with “error. Reviewing Output Files Available in: Enterprise. c. Unlimited.” During every export. 3.connection. see Inserting.salesforce. The Data Loader has a built-in CSV file viewer with which you can open these files. click Open Error. see Configuring the Data Loader on page 4. there is a column for newly generated record IDs.012300000008o2sAQG. there is a column that describes why the load failed. Press Enter.one 2.Using Data Loader Reviewing Output Files b. A sample CSV file is: Title.com/soap/ajax/21. Note: To generate success files when exporting data.(optional) tag. The “error” file contains all records that were rejected from the load operation. Upload the CSV file for the ContentVersion object.html. To view a CSV file of your choice. Specify a number of rows to view."This is a test file. e. The default is 1000.PathOnClient. Updating.058700000004Cd0. or Deleting Data Using the Data Loader on page 13. and Developer Editions After every import or export. The “success” file contains all records that were successfully loaded. You can see the instanceName in the URL field of your browser after logging in to Salesforce. 4. 2. 5.c:\files\testfile.TagsCsv testfile. All of the RecordTypeId values for your organization are listed. such as Microsoft® Office Excel.c:\files\testfile. the Data Loader generates two unique CSV output files. To view the last success file. click Open CSV. To view the last error file. click Open Success.describeSObject("ContentVersion") d. Enter this URL in your browser: http://instanceName. • TagsCsv . the Data Loader saves extracted data to a CSV file that you specify in the wizard. 17 . In it. To view output files from a Data Loader operation: 1. All documents and links will be available in the specified workspace.RecordTypeId.pdf. click Open in External Program to open the file in the associated external program. Choose View CSV from the View menu of the Data Loader.Description. Enter the instanceName.pdf. and then click OK to exit the window.VersionData. Optionally. such as na1. for your organization. use for bulk upload".0/debugshell.

such as Microsoft Notepad. you can access log files that track the operations and network connections made by the Data Loader.log. sdl_out. See the following topics: • • • • • • • • • • • Understanding Installed Directories and Files Encrypting From the Command Line Upgrading Your Batch Mode Interface Using the Command Line Interface Configuring Batch Processes Data Loader Process Configuration Parameters Data Loader Command Line Operations Configuring Database Access Mapping Columns Running Individual Batch Processes Data Access Objects 18 . RUNNING BATCH PROCESSES Running in Batch Mode You can run the Data Loader in batch mode from the command line.log in either the Run dialog or the Windows Explorer address bar. Log entries marked “ERROR” are problems such as a submitted record missing a required field. it includes log entries for the creation of proxy server network connections.log A supplemental log that contains additional information not captured in sdl. such as logging in to Salesforce. Unlimited. or if requested by salesforce. ensure that the password provided in the configuration parameters is encrypted. The two log files are: sdl. If you are having login issues from the UI.log Contains a detailed chronological list of Data Loader log entries. and Developer Editions If you need to investigate a problem with the Data Loader. For example. These files can be opened with commonly available text editor programs.com Customer Support. you may need to obtain a new security token. If you are having login issues from the command line.log and %TEMP%\sdl_out. You can quickly open these files by entering %TEMP%\sdl. Log entries marked “INFO” are procedural items.Running Batch Processes Troubleshooting Data Loader Operations Troubleshooting Data Loader Operations Available in: Enterprise.

conf The default configuration directory. see Using the Command Line Interface on page 20. The config. Loader. please substitute that directory path as appropriate.properties. 2. follow the prompts provided to execute the following actions: 19 . Understanding Installed Directories and Files In versions 8.Running Batch Processes Understanding Installed Directories and Files Note: If you have used the batch mode from the command line with a version earlier than 8.xml. you must encrypt the following configuration parameters: • • sfdc. installing the Data Loader creates several directories under the installation directory.properties file that is generated when you modify the Settings dialog in the graphical user interface is located at C:\Documents and Settings\your Windows username\Application Data\salesforce. see Upgrading Your Batch Mode Interface on page 20. At the command line. Run \bin\encrypt. To use the encryption utility: 1. Using the Encryption Utility The Data Loader offers an encryption utility to secure passwords specified in configuration files.proxyPassword Use the utility described below to perform encryption.password sfdc. Contains the configuration files config. The following directories are involved in running the program from the command line for automated batch processing: bin Contains the batch files encrypt. \bin means C:\Program Files \salesforce. provided you accepted the default installation directory.0 and later.com\Data Loader version_number.class. File Path Convention The file paths provided in these topics start one level below the installation directory.bat for encrypting passwords and process.bat for running batch processes. You can copy this file to the conf installation directory to use it for batch processes. If you installed the program to a different location. and log-conf.bat.0. Encrypting From the Command Line When running the Data Loader in batch mode from the command line. samples Contains subdirectories of sample files for reference.com\Data Loader version_number\bin. For example. For information on running the Data Loader from the command line.

Running Batch Processes Upgrading Your Batch Mode Interface Generate a key Key text is generated onscreen from the text you provide. Unlimited. run Data Loader from the command line. In the configuration file. see Encrypting From the Command Line on page 19. To view tips and instructions. 20 . Manually update your config. Before running any batch operation. Optionally. which takes the following parameters: • • The directory containing config.bat.properties. A success or failure message is printed to the command line. see Running Individual Batch Processes on page 35. Generate a new config. install the new version alongside the old version and dedicate the old version solely to batch processes. The name of the batch process bean contained in process-conf. add -help to the command contained in process.properties file from the new GUI If you originally generated your config. Upgrading Your Batch Mode Interface The batch mode interface in versions 8. Optionally. Using the Command Line Interface Available in: Enterprise. For more information about using process. make sure that the encrypted text is copied precisely and the key file is mentioned. Encrypt text Generates an encrypted version of a password or other text.properties file If your old config. The key file can then be used for encryption and decryption. your options are as follows: Maintain the old version for batch use Do not uninstall your old version of the Data Loader.0 and later of the Data Loader are not backwards-compatible with earlier versions. then you must manually update it for the new version. you can provide a key file for the encryption. For more information. You cannot take advantage of newer features such as database connectivity.bat.properties file was created manually. Verify encrypted text Given encrypted and decrypted versions of a password. and Developer Editions For automated batch operations such as nightly scheduled loads and extractions.bat. For more information. verifies whether the encrypted password provided matches its decrypted version.properties file from the graphical user interface. be sure to include your encrypted password in the configuration file. Continue to use that version for batch processes. use the new version to set the same properties and generate a new file. For more information.xml. From the command line. omitting any leading or trailing spaces. Use this new file with the new batch mode interface. navigate into the bin directory and type process. but your integrations will continue to work. see Understanding Installed Directories and Files on page 19. Carefully copy the key text to a key file.0 to run batch processes. If you are using a version earlier than 8. see Running in Batch Mode on page 18.

such as sendAccountsFile_lastrun. If you use process-conf. the value is the setting value.xml. enableLastRunOutput If set to true (the default). are written.xml.Running Batch Processes Configuring Batch Processes The Data Loader runs whatever operation. this value is not used because the files are not generated. This value is also used as the non-generic thread name and for configuration backing files (see below). You can change parameters at runtime by giving param=value as program arguments. Otherwise.name to the name of a process specifies a process to run. configOverrideMap A property of type map where each entry represents a configuration setting: the key is the setting name. use a copy of log-conf. the files are not generated or saved. please try re-encrypting your password to solve the problem. For more information on batch mode.com/sforce/2005/06/sforce_data_loa. 21 .xml to configure your Data Loader processes. The default value is \conf. For example. You can set the minimum and maximum heap size. Configuring Batch Processes Use \samples\conf\process-conf. output files containing information about the last run.sforce. A process should have ProcessRunner as the class attribute and the following properties set in the configuration file: name Sets the name of the ProcessRunner bean. the config.html Tip: If you experience login issues in the command line interface after upgrading to a new version of the Data Loader.com\Data Loader version number\conf The batch process configuration file is process-conf.0 and later. If enableLastRunOutput is set to false. or map is specified in the configuration file that you specify. For example.xml.properties. file. see the following blog post for command line instructions: http://blog. Data Loader configuration files are installed at the following location: C:\Program Files\salesforce. -Xms256m -Xmx256m sets the heap size to 256 MB. the current directory is used. adding process. Note: These topics only apply to version 8. such as sendAccountsFile_lastrun.operation=insert to the command changes the configuration at runtime. By default. If you have an earlier version of the Data Loader.properties. If you do not specify a configuration directory. For information on the password encryption utility. If you want to implement enhanced logging. If set to false. are generated and saved to the location specified by lastRunOutputDirectory. lastRunOutputDirectory The directory location where output files containing information about the last run. see Running in Batch Mode on page 18. see Encrypting From the Command Line on page 19. setting process.properties file is used for parameter settings. which are represented by ProcessRunner beans.

properties. even if they were saved in a different CSVs with format.000. UTF-8 encoding Sample value: true Write all This option forces files to be written in UTF-8 CSVs with encoding. use the name of the database configuration in database-conf. The maximum value is 2. UTF-8 encoding Sample value: true dataAccess. The settings in configOverrideMap take precedence over those in the configuration backing file. csvRead. The maximum value is 200. Note the implication for a large parameter value: if an error occurs. Data Loader Process Configuration Parameters When running the Data Loader in batch mode from the command line.name string Not applicable (N/A) Name of the data source to use.writeUTF8 boolean dataAccess. dataAccess. and databaseRead. databaseWrite. the option is also represented in the graphical user interface at Settings ➤ Settings. and is used to load default configuration parameters in config. see Data Loader Process Configuration Parameters on page 22. dataAccess. For databases. all records in dataAccess.xml.writeBatchSize integer N/A 22 . Standard types are csvWriter. Parameter Name Data Type Equivalent Option in Settings Dialog Description This option forces files to open in UTF-8 Read all encoding. such as a CSV file name. Sample value: c:\dataloader\data\extractLead. The configuration backing file is managed programmatically and does not require any manual edits.type string N/A Sample value: csvWrite Number of records written to your back-end or other external database at a time.Running Batch Processes Data Loader Process Configuration Parameters The configuration backing file stores configuration parameter values from the last run for debugging purposes.csv Number of records read from your back-end or other external database at a time.properties. you can specify the following configuration parameters in config. In some cases.readBatchSize integer N/A Sample value: 50 Standard or custom data source type.readUTF8 boolean dataAccess. For the names and descriptions of available process configuration parameters.

enableLastRunOutput boolean N/A Sample value: true Name of the file that contains the encryption key. you can change the location of the directory where these files are saved. To stop the writing of these files.initialLastRunDate date N/A example: 2006-04-13T13:50:32.properties. Alternatively.SSS+/-HHmm. each record is processed individually (not in batch) and errors are specific to a given record. process.encryptionKeyFile string (file name) N/A Sample value: c:\dataloader\conf\my.key The initial setting for the process.lastRunOutputDirectory string (directory) N/A 23 . files for Sample value: true exports process. using process. For process. you can change the location where output files such as process. Format must be yyyy-MM-ddTHH:mm:ss.enableExtractSuccessOutput boolean When running the Data Loader in batch mode. In contrast. set this option to false. Sample value: 500 Generate Select this option to generate a success file when success exporting data. See Encrypting From the Command Line on page 19. see Date Formats on page 9. We recommend setting the value to 1 when you need to diagnose problems with writing to a database. you can disable the generation of output files such as sendAccountsFile_lastRun.Running Batch Processes Data Loader Process Configuration Parameters Parameter Name Data Type Equivalent Option in Settings Dialog Description the batch are rolled back.lastRunOutputDirectory. which can be used in a SQL string and is automatically updated when a process has run successfully.lastRunDate parameter.423-0700 When running the Data Loader in batch mode. Files of this type are saved by default to the conf directory. process. For an explanation of the date format syntax. if the value is set to 1.

mappingFile string (file name) N/A c:\dataloader\conf\accountExtractMap. Alternatively.xml.Running Batch Processes Data Loader Process Configuration Parameters Parameter Name Data Type Equivalent Option in Settings Dialog Description sendAccountsFile_lastRun.sdl The operation to perform. change the value of this option to the full path where the last run files should be written.csv 24 .enableExtractSuccessOutput process. process. using process. The file names are automatically generated for each operation unless you specify otherwise in process-conf. Sample value: c:\dataloader\status The name of the CSV file that stores error data from the last operation. See Data Loader Command Line Operations on page 30. To change the location.operation string N/A Sample value: extract The directory where “success” and “error” output files are saved.loadRowToStartAt number Start at row Sample value: 1008 Name of the the field mapping file to use.enableLastRunOutput. Files of this type are saved by default to the conf directory. Sample value: N/A c:\dataloader\status\myProcessSuccesses.outputSuccess string (file name) on page 23. If your last operation failed. Sample value: process. See also process.properties are written.csv The name of the CSV file that stores success data from the last operation.outputError string (file name) N/A c:\dataloader\status\myProcessErrors. See Mapping Columns on page 34. Sample value: process. you can use this setting to begin where the last successful operation finished.statusOutputDirectory string (directory) N/A process. you can stop the files from being written. process.

Sample value: true Specify the ID of the assignment rule to use for inserts.useBulkApi.assignmentRule string Assignment Sample value: 03Mc00000026J7w Rule The number of milliseconds to wait between successive checks to determine if the asynchronous Bulk API operation is complete or how many records have been processed. See also sfdc. such as Attachment records or Salesforce CRM Content. Processing in parallel can cause database contention.bulkApiCheckStatusInterval integer N/A Sample value: 5000 Select this option to use serial instead of parallel processing for the Bulk API. See also sfdc.useEuropeanDates boolean sfdc. updates. This option applies to inserts. Using serial mode guarantees that batches are processed one at a time. When this is severe. It also applies to updates on accounts if your organization has territory assignment rules on accounts. The assignment rule overrides Owner values in your CSV file. sfdc. We recommend a value of 5000. Sample value: true The number of seconds to wait for a connection during API calls. sfdc.useBulkApi. Note that using this option may significantly increase the processing time for a load. and upserts on cases and leads.bulkApiSerialMode boolean Enable serial mode for Bulk API Upload Bulk API Batch as Zip File (enable to upload binary attachments) Select this option to use the Bulk API to upload zip files containing binary attachments. the load may fail.Running Batch Processes Data Loader Process Configuration Parameters Parameter Name Data Type Equivalent Option in Settings Dialog Use European Date Format Description Select this option to support the date formats dd/MM/yyyy and dd/MM/yyyy HH:mm:ss. and upserts. updates. process.useBulkApi.connectionTimeoutSecs integer N/A Sample value: 60 25 . See also sfdc.bulkApiZipContent boolean sfdc. Sample value: false sfdc.

For more information about external IDs.debugMessagesFile. records are returned from Salesforce in increments of this size.com. if you are loading into a sandbox.extractionRequestSize integer 26 .Running Batch Processes Data Loader Process Configuration Parameters Parameter Name Data Type Equivalent Option in Settings Dialog Description If true.0 The Salesforce object used in the operation. enables repeated attempts to connect to Salesforce servers.debugMessages boolean N/A Sample value: false See process. By default. As messages are sent or received. Larger values sfdc. see “Custom Field Attributes” in the Salesforce online help.com/services/Soap/u/21. change the URL to https://test. sfdc. sfdc. please monitor your available disk storage appropriately. messages are sent to STDOUT unless you specify an alternate location in sfdc.enableRetries boolean N/A Sample value: true Enter the URL of the Salesforce server with which you want to communicate. Stores SOAP messages sent to or from Salesforce.000. they are appended to the end of the file.entity string N/A Sample value: Lead Used in upsert operations.salesforce. specifies the custom field with the “External ID” attribute that are used as a unique identifier for data matching.debugMessagesFile string (file name) on page 23.minRetrySleepSecs on page 27. The maximum value is 2.salesforce.externalIdField string N/A Query Request Size Sample value: LegacySKU__c In a single export or query operation.maxRetries on page 27 and sfdc.enableExtractSuccessOutput sfdc. sfdc. Sample value: N/A \lexiloader\status\sfdcSoapTrace. See sfdc.endpoint URL Server Host Sample production value: https://login. enables SOAP message debugging. sfdc.log If true. sfdc. For example. As the file does not have a size limit.

see the Web Services API Developer's Guide. See sfdc. or delete operation. The wait time increases with each try. enable this option. but use more memory on the client.insertNulls boolean Insert Null Values Enable this option to insert blank mapped values as null values during data operations.Running Batch Processes Data Loader Process Configuration Parameters Parameter Name Data Type Equivalent Option in Settings Dialog Description may improve performance. sfdc. sfdc. Note that when you are updating records.maxRetries integer N/A Sample value: 3 The minimum number of seconds to wait between connection retries.enableRetries on page 26. For more information on SOQL. sfdc. this option instructs the Data Loader to overwrite any existing data in mapped fields. Sample value: SELECT Id. See sfdc. update. AnnualRevenue. Rating. LastName. Sample value: 500 The SOQL query for the data export. To turn off compression. You may want to disable compression if you need to debug the underlying SOAP messages. We recommend a value between 50 and 100. records moving to or from Salesforce are processed in increments of this size. Sample value: false In a single insert. OwnerId FROM Lead string N/A sfdc. sfdc. sfdc. The maximum value is 200.loadBatchSize integer Batch Size Sample value: 100 The maximum number of repeated attempts to connect to Salesforce.extractionSOQL FirstName. upsert.minRetrySleepSecs integer N/A Sample value: 2 Compression enhances the performance of the Data Loader and is turned on by default.noCompression boolean Compression Sample value: false 27 .enableRetries on page 26.

sfdc.resetUrlOnLogin boolean Reset URL on Login Sample value: false Specify how many seconds the Data Loader waits to receive a response back from the server before returning an error for the request. if applicable.company.proxyUsername string Sample value: jane.To turn off this automatic reset. Sample value: 4285b36161c65a22 The proxy server port.endpoint.timeoutSecs integer Timeout Sample value: 540 If a date value does not include a time zone. sfdc. the time zone of the computer where Data Loader is installed is used. the value specified here is used.proxyUsername on page 28.proxyHost URL Proxy Host Sample value: http://myproxy. sfdc.timeZone string Time zone 28 .password encrypted string N/A An encrypted Salesforce password that corresponds to the username provided in sfdc.internal. sfdc.proxyPassword encrypted Proxy string Password Proxy Port Proxy Username An encrypted password that corresponds to the proxy username provided in sfdc. Salesforce resets the URL after login to the one specified in sfdc. sfdc. • If no value is specified. See also Encrypting From the Command Line on page 19.doe By default. See also Encrypting From the Command Line on page 19.proxyPort integer Sample value: 8000 The username for proxy server authentication.username on page 30.com sfdc.Running Batch Processes Data Loader Process Configuration Parameters Parameter Name Data Type Equivalent Option in Settings Dialog Description sfdc. sfdc. Sample value: 4285b36161c65a22 The host name of the proxy server. disable this option.

In that case.Running Batch Processes Data Loader Process Configuration Parameters Parameter Name Data Type Equivalent Option in Settings Dialog Description • If an incorrect value is entered. This option is selected by default and has no effect in versions 14. update. You can retrieve the default value by running the TimeZone.truncateFields boolean Allow field truncation Sample value: true sfdc. It is faster than the default SOAP-based API due to parallel processing and fewer network round-trips. or a custom ID such as GMT-8:00. See also sfdc.bulkApiSerialMode.0 and earlier.0 and later. and hard delete records. and Text (Encrypted). GMT is used as the time zone and this fact is noted in the Data Loader log. truncation. be used instead of the new behavior in Data Loader versions 15. delete. the load operation fails for the row if a value is specified that is too large for the field.lang. This option is not available if the Use Bulk API option is selected. Valid values are any time zone identifier which can be passed to the Java getTimeZone(java. Selecting this option allows you to specify that the previous behavior.String) method. The value can be a full name such as America/Los_Angeles.0 and earlier. The Bulk API is optimized to load or delete a large number of records asynchronously. This value is the time zone on the computer where Data Loader is installed. In Data Loader versions 14. In Data Loader version 15. upsert. Picklist. 29 .0 and later. Multi-select Picklist.getDefault() method in Java. Text. sfdc. values for fields of those types are truncated by the Data Loader if they are too large. Select this option to direct the Data Loader to truncate data in the following types of fields when loading that data into Salesforce: Email.useBulkApi boolean Use Bulk API Select this option to use the Bulk API to insert. the load operation fails if a value is specified that is too large. Phone.

Hard Delete Loads data from a data source into Salesforce. Upsert Loads data from a data source into Salesforce. Extract Uses a Salesforce Object Query Language (SOQL) string to export a set of records from Salesforce. then writes the exported data to a data source.username string N/A Sample value: jdoe@mycompany. use \samples\conf\database-conf. An operation represents the flow of data between Salesforce and an external data source such as a CSV file or a database.xml to configure database access objects. where existing records with matching ID fields are deleted. Insert Loads data from a data source into Salesforce as new records. 30 . where existing records with a matching custom external ID field are updated. sfdc. See sfdc. See the following list of operation names and descriptions.com Data Loader Command Line Operations When running the Data Loader in batch mode from the command line. then writes the exported data to a data source. including both existing and soft-deleted records. where existing records with matching ID fields are deleted without being stored first in the Recycle Bin. records without matches are inserted as new records. where existing records with matching ID fields are updated. which you use to extract data directly from a database.password on page 28.Running Batch Processes Data Loader Command Line Operations Parameter Name Data Type Equivalent Option in Settings Dialog Description Sample value: true Salesforce username. Soft-deleted records are not included. Update Loads data from a data source into Salesforce. Configuring Database Access When you run the Data Loader in batch mode from the command line. Extract All Uses a Salesforce Object Query Language (SOQL) string to export a set of records from Salesforce. several operations are supported. Delete Loads data from a data source into Salesforce.

database.dao. which has the following properties: sqlConfig The SQL configuration bean for the data access object that interacts with a database.DatabaseConfig" singleton="true"> <property name="sqlConfig" ref="accountInsertSql"/> </bean> DataSource The DataSource bean sets the physical information needed for database connections. use org.commons.BasicDataSource when database connections are pooled.commons.dbcp. For example. url The string for physically connecting to the database.com:1521:TEST"/> <property name="username" value="test"/> <property name="password" value="test"/> </bean> 31 .OracleDriver"/> <property name="url" value="jdbc:oracle:thin:@myserver.salesforce. dataSource The bean that acts as database driver and authenticator.Running Batch Processes Configuring Database Access DatabaseConfig Bean The top-level database configuration object is the DatabaseConfig bean.apache.dataloader.BasicDataSource. username The username for logging in to the database.commons.apache.salesforce.DataSource such as org.sql. It must refer to an implementation of javax. password The password for logging in to the database.driver.BasicDataSource" destroy-method="close"> <property name="driverClassName" value="oracle. DataSource Example <bean id="oracleRepDataSource" class="org. additional information may be required.dbcp. Depending on your implementation.jdbc.dbcp.apache. It contains the following properties: driverClassName The fully qualified name of the implementation of a JDBC driver. DatabaseConfig Example <bean id="AccountInsert" class="com.internal.

a write interface (DataWriter). See the following list of object names and descriptions. databaseWrite Allows writing to a database.dao.xml to configure database access.xml to configure database access. several data access objects are supported. which is an open source full-stack Java/J2EE application framework.salesforce. A typical bean has the following attributes: id Uniquely identifies the bean to XmlBeanFactory. queries and inserts are different but very similar. Use database-conf. see Configuring Database Access on page 30. The Spring Framework allows you to use XML files to configure beans.com cannot guarantee the availability or accuracy of external websites. For more information. 32 . csvRead Allows the reading of a comma or tab-delimited file. Data Access Objects When running the Data Loader in batch mode from the command line. Each bean represents an instance of an object. For more information on the Spring Framework. There should be a header row at the top of the file that describes each column. csvWrite Allows writing to a comma or tab-delimited file. Note that salesforce. class Specifies the implementation class for the bean instance. Use database-conf. The bean must be of type com. As shown in the code samples below. A data access object allows access to an external data source outside of Salesforce.Running Batch Processes Configuring Database Access Spring Framework Overview The Data Loader configuration files are based on the Spring Framework. which is the class that gets objects from an XML configuration file. They can implement a read interface (DataReader). SQL Configuration When running the Data Loader in batch mode from the command line. A header row is added to the top of the file based on the column list provided by the caller. see Configuring Database Access on page 30.database. the parameters correspond to each object's setter methods. databaseRead Allows the reading of a database. the SqlConfig class contains configuration parameters for accessing specific data in the database. For more information. see the official documentation and the support forums. or both.SqlConfig and have the following properties: sqlString The SQL code to be used by the data access object.dataloader.

postal_code.PARTY_ID and locs. ar.lastRunDate@ OR accounts. SQL Query Bean Example <bean id="accountMasterSql" class="com. ' '). For more information. sqlParams A property of type map that contains descriptions of the replacement parameters specified in sqlString.database.dao.dataloader.Running Batch Processes Configuring Database Access The SQL can contain replacement parameters that make the string dependent on configuration or operation variables. For example. ar. ar. parties.LOCATION_ID = party_sites.account_number.hz_organization_profiles org.LOCATION_ID and (locs.last_update_date > @process. Replacement parameters must be delimited on both sides by “@” characters.util.Date instead of java.address1. the value is the fully qualified Java type to be used when the parameter is set on the SQL statement.PARTY_ID = accounts. org. concat (concat(parties. locs.sql” types are sometimes required.Date. locs.hz_cust_accounts accounts.country.city. accounts.hz_locations locs where accounts.PARTY_ID = accounts.PARTY_ID = org. Each entry represents one replacement parameter: the key is the replacement parameter's name.hz_party_sites party_sites.PARTY_ID and parties. locs. The column names are used to access and return the output to the caller of the DataReader interface.last_update_date > @process.state.sic_code from ar.PARTY_ID and party_sites.salesforce.lastRunDate@. @process.organization_name. see the official JDBC API documentation. such as java.address2) billing_address. Note that “java. locs.SqlConfig" singleton="true"> <property name="sqlString"/> <value> SELECT distinct '012x00000000Ij7' recordTypeId. Contains column names for the data outputted by executing the SQL.hz_parties parties. parties. ar.lastRunDate@ </value> </property> <property name="columNames"> <list> <value>recordTypeId</value> <value>account_number</value> <value>organization_name</value> <value>billing_address</value> <value>city</value> <value>postal_code</value> <value>state</value> <value>country</value> <value>sic_code</value> </list> </property> <property name="sqlParams"> 33 . columnNames Used when queries (SELECT statements) return a JDBC ResultSet.sql.

You may map constants by surrounding them with double quotation marks. as in "United States"=BillingCountry. Values without quotation marks are treated as column names. Destinations must be column names. @sic_code@) </value> </property> <property name="sqlParams"/> <map> <entry key="billing_address" value="java. SIC_CODE) VALUES (@billing_address@. Surround constants with double quotation marks.Running Batch Processes Mapping Columns <map> <entry key="process.INT_PARTIES ( BILLING_ADDRESS.mappingFile to specify the name of your mapping file. Column Mapping Example for Data Insert The Salesforce fields are on the right. SLA__C=SLA__c BILLINGCITY=BillingCity SYSTEMMODSTAMP= OWNERID=OwnerId CUSTOMERPRIORITY__C=CustomerPriority__c ANNUALREVENUE=AnnualRevenue DESCRIPTION=Description 34 .lastRunDate" value="java.String"/> <entry key="sic_code" value="java. 2.SqlConfig" singleton="true"> <property name="sqlString"/> <value> INSERT INTO REP.dataloader. Put the data source on the left. an equals sign (=) as a separator.database. you must create a properties file that maps values between Salesforce and data access objects. Create a new file. use the parameter process. Data sources can be either column names or constants. 3. 1. pair a data source with its destination. as in “sampleconstant”.lang.lang.dao.String"/> </map> </property> </bean> Mapping Columns When running the Data Loader in batch mode from the command line.sql. In your configuration file.Date"/> </map> </property> </bean> SQL Insert Bean Example <bean id="partiesInsertSql" class="com.salesforce. Observe the following syntax: • • • • • On each line. and the destination on the right.

To use an alternate directory. Process Example process .1 http://www..1 1. which requires the following parameters: A configuration directory The default is \conf.bat. copy process-conf.org/licenses/LICENSE-1.xml.apache. Unlimited.apache./conf accountMasterProcess Note: You can configure external process launchers such as the Microsoft Windows XP Scheduled Task Wizard to run processes on a schedule.xml from \samples\conf. If your process requires database connectivity.org/licenses/LICENSE-1. Data Loader Third-Party Licenses Available in: Enterprise. Id=account_number Name=name Phone=phone Running Individual Batch Processes To start an individual batch process use \bin\process.Running Batch Processes Running Individual Batch Processes BILLINGSTREET=BillingStreet SHIPPINGSTATE=ShippingState Column Mapping Example for Data Export The Salesforce fields are on the left. A process name The name of the ProcessRunner bean from \samples\conf\process-conf.1 35 . Copy config.6 License http://www. create a new directory and add the following files to it: • • • If your process is not interactive. and Developer Editions The following third-party licenses are included with the installation of the Data Loader: Technology Axis Ant Apache Jakarta Commons BeanUtils Version Number 1.properties from \conf. copy database-conf.xml from \samples\conf.

2.1 1.2 Library Apache Log4j Eclipse SWT 1.opensymphony.0.mozilla.063 OpenSymphony Quartz Enterprise 1.com/quartz/license.html http://jakarta.action http://www.txt Apache Commons Object Pooling 1.Running Batch Processes Data Loader Third-Party Licenses Technology Apache Commons Collections Apache Commons Database Connection Pooling (DBCP) Apache Commons Logging Version Number 3.2.5.1 1.apache.apache.txt http://www.org/org/documents/epl-v10.3 License http://jakarta.0.html http://www. 36 .org/licenses/LICENSE-2.8 3.apache.apache.apache.6R2 1.org/commons/license.0.org/commons/license.org/commons/license.html http://jakarta.com is not responsible for the availability or content of third-party websites.apache.html http://www.1.1 Job Scheduler Rhino JavaScript for Java Spring Framework 1.eclipse.html http://www.html http://jakarta.org/commons/license.org/licenses/LICENSE-2.2.org/MPL/MPL-1.6 Note: salesforce.

Index Index A Apex Data Loader See Data Loader 1 Data Loader (continued) configuring batch processes 21 data types 9 date formats 9 installed files 19 installing 3 overview 1 password encryption 19 sample files 19 settings 7.properties 22 configuring 4. 16 column mapping 34 command line interface 20 command line operations 30 config. 8. see Data Loader 32 37 . 8 S Spring Framework. 8 Spring Framework 32 starting batch processes 35 system requirements 3 third-party licenses 35 troubleshooting 18 uninstalling 8 uploading 16 uploading attachments 15 using 7 when to use 2 B Bulk API 4. 8 uploading attachments 15 D Data Loader attachments 8 batch files 19 batch mode 18 batch mode parameters 22 Bulk API 4. 7.

You're Reading a Free Preview

Download
scribd
/*********** DO NOT ALTER ANYTHING BELOW THIS LINE ! ************/ var s_code=s.t();if(s_code)document.write(s_code)//-->