Files, Record Types, and Parameters for Oracle Data Loader On Demand

This chapter provides information about the files, record types, and command-line parameters for Oracle Data Loader On Demand. It includes the following topics:

Command-Line Parameters for Oracle Data Loader On Demand

Oracle Data Loader On Demand has a command-line interface. The syntax for running Oracle Data Loader On Demand is:

java -jar Oracle_DataLoader_OnDemand.jar parameters

Option names and values are case sensitive and must be in lower case. Parameters with spaces must be enclosed in double quotes.

The parameters are listed in the following table.

Table Command-Line Parameters for Oracle_DataLoader_OnDemand.jar

Parameters	Required or Optional	Description
-username value	Required	Your User Sign In ID for Oracle CRM On Demand.
-operation value	Required	Operation type. The value must be one of the following: insert. The Insert operation creates new records in the database. If a record already exists, then the import fails. Uniqueness is determined by the values of the database user key. Uniqueness is determined by the values of the required fields. To determine uniqueness for a record and which fields are required, see the table in the topic Use the Required Field Mappings. update. The Update operation updates only records that already exist in the database. The record can be found by matching the External System ID. upsert. The Upsert operation performs either an Insert operation or an Update operation, depending on if the external record can be matched to an existing record in the database. resume. The Resume operation is used only to restart an operation that was previously interrupted by a user.
-propertyfilepath value	Optional	Specifies the path and file name of a properties file. If you do not specify a properties file, then you must specify all the parameters for the Insert, Update, Upsert, or Resume operations.
-clientloglevel value	Optional	Specifies the level of detail for the client log file. It must be one of the following: basic. Provides high-level errors. This is the default value. detailed. Provides more detailed error messages for troubleshooting. all. Provides all error messages, including any third party error messages generated from any libraries used by the client. Use this option only when instructed by Customer Care to troubleshoot an issue. Note: If you set -clientloglevel to all or detailed, then the command-line parameters are copied to the log file.
-clientlogfiledir value	Optional	Specifies the directory in which to save the OracleDataLoaderOnDemand log file. This log file stores errors and warnings related to the submission of an Insert, Update, or Upsert job. Errors in an Insert, Update, or Upsert operation are stored in a server log, which is accessible by Customer Care. If you do not use -clientlogfiledir to specify a directory, then the OracleDataLoaderOnDemand log file is stored in the same directory as the Oracle_DataLoader_OnDemand.jar file.
-disableimportaudit	Optional	Specifies whether the auditing of record creation and update during an import request is disabled. This setting takes effect if you have the Manage Record Auditing for Imports privilege. By default, auditing is turned on for each request. Import performance for some objects improves when auditing is turned off.
-importblankinmsp	Optional	Specifies whether multi-select picklist fields can be updated to null values on importing. By default, null values are not imported.
-help	Optional	Displays a list of available parameters.
-proxyserver value	Optional	Specifies the name of a proxy server.
-proxyserverport value	Optional	Specifies a port on the proxy server.
-proxyauthusername value	Optional	Specifies a proxy server authentication name. If this parameter is specified, Oracle Data Loader On Demand prompts for the proxy server authentication user password.
-hosturl value	Optional	Specifies the Oracle CRM On Demand host URL.
-characterset value	Optional	Specifies the character set encoding of the data file and map file. If this parameter is not specified, a value of UTF-8 is the default. For a list of supported values, see the following: https://docs.oracle.com/javase/6/docs/technotes/guides/intl/encoding.doc.html
-disableemailnotification	Optional	Specifies whether an email notification is sent after a database import. If this parameter is not specified, then the email notification is sent after the database import. If this parameter is specified, then the email notification is not sent.
-senduserlogfile	Optional	Specifies whether Oracle Data Loader On Demand sends the log file after a database import. If disableemailnotification is in the parameter list, then the value of senduserlogfile is ignored. Note: If the user log file size exceeds 20 MB, then Oracle Data Loader On Demand does not email the file, but does note this fact in the user log file. Refer to the userlogfiledir parameter to specify where the user log file is stored.
-userlogfiledir value	Optional	Specifies the directory in which to save the user log file. If you do not use -userlogfiledir to specify a directory and the waitforcompletion parameter is present in the properties file, then the user log file is stored in the same directory as the Oracle_DataLoader_OnDemand.jar file. If neither the -userlogfiledir parameter or the waitforcompletion parameter are specified, then the user log file is not saved.

When you run Oracle Data Loader On Demand from the command-line you are prompted to enter your password. This is a security feature to prevent unauthorized people from gaining access to your password.

Note: Oracle Data Loader On Demand does not support password text files.

Command-Line and Properties File

You can specify the parameters for any operation (Insert, Update, Upsert, or Resume) on the command-line, or use a properties file. If you use a properties file (recommended), then the command-line must contain the following parameters:

username
propertyfilepath

If you specify all possible parameters in the properties file, then the resulting command-line resembles the following:

java -jar Oracle_DataLoader_OnDemand.jar -username "AcmeRentals/jbrown" -
propertyfilepath "D:\dataload\propfiles\insert_leads.txt"

If the same parameter is specified in both the properties file and the command-line, the command-line value overrides the value in the properties file.

Note: Do not specify your user name in the properties file. This parameter must be specified on the command-line.

Example of Oracle Data Loader On Demand Command-Line

The following is an example of a command-line to run Oracle Data Loader On Demand for the following conditions:

Inserting records.
User ID is AcmeRentals/jbrown.
The log file is stored in:
```
D:\dataload\logs
```
The log detail level is basic.
The properties file is in the following directory:
```
D:\dataload\propfiles\insert_leads.txt
```

The resulting command-line is:

java -jar Oracle_DataLoader_OnDemand.jar -operation "insert" -username 
"AcmeRentals/jbrown" -clientlogfiledir "D:\dataload\logs" -clientloglevel "basic" 
-propertyfilepath "D:\dataload\propfiles\insert_leads.txt"

Supported Record Types for Oracle Data Loader On Demand

The record types named in this topic are the supported record types you use with Oracle Data Loader On Demand. When you specify a record type you must use the name exactly as specified. For example, for the Campaign object you cannot use Campaigns instead. If you have customized an object name in the Oracle CRM On Demand user interface, that customization does not apply to Oracle Data Loader On Demand. For example, if you have changed Account to Customer in the user interface, you must specify Account in Oracle Data Loader On Demand.

Support for record types can change over time. To determine whether a record type is supported for importing, see Determining Which Record Types Can Be Imported.

You can Insert (but not Update or Upsert) the following record types using Oracle Data Loader On Demand:

Appointment Contact
Appointment User
Note
Task Contact
Task User

You can Insert, Update, and Upsert the following record types using Oracle Data Loader On Demand:

Account
Account Address
Account Book
Account Competitor
Account Contact
Account Partner
Account Team
Accreditation
Accreditation Request
Address
Allocation
Application
Appointment
Asset
Blocked Product
Book
Book User
Broker Profile
Business Plan
Campaign
Campaign Recipient
Certification
Certification Request
Claim
Contact (Admin)
Contact Address
Contact Book
Contact State License
Contact Team
Course
Course Enrollment
Coverage
Custom Object 1-15
Damage
Deal Registration
Dealer
Event
Exam
Exam Registration
Financial Account
Financial Account Holder
Financial Account Holding
Financial Plan
Financial Product
Financial Transaction
HCP Contact Allocation
Insurance Property
Inventory Audit Report
Inventory Period
Invitee
Involved Party
Lead
MDF Request
Message Response
Messaging Plan
Messaging Plan Item
Messaging Plan Item Relations
Modification Tracking
Objective
Opportunity
Opportunity Contact Role
Opportunity Product Revenue
Opportunity Team
Order
Order Item
Partner
Partner Program
Plan Account
Plan Contact
Plan Opportunity
Policy
Policy Holder
Portfolio
Price List
Price List Line Item
Product
Product Category
Product Indication
SP Request
Sample Disclaimer
Sample Inventory
Sample Lot
Sample Request
Sample Request Item
Sample Transaction
Service Request
Social Profile
Solution
Special Pricing Product
Task
Transaction Item
User
Vehicle
Vehicle Contact

Determining Which Record Types Can Be Imported

To determine which record types can be imported, complete the following procedure.

To determine which record types can be imported

In Oracle CRM On Demand, navigate to Admin, and then Import and Export Tools.
Under the Import Data section, click the menu and check which records appear on the menu.

Data File for Oracle Data Loader On Demand

The data file contains the records from your external application to be imported or updated into Oracle Data Loader On Demand. The data file is a text file and can be created using any means you prefer (such as exporting data from your application, using a data extraction utility on the external application’s database, and so on). The data file must meet the following criteria:

The data file character set encoding must be specified. If it is not specified, the default value is UTF-8.
The fields must be separated by either commas (,) or semicolons (;) used consistently. Make sure the properties file specifies which delimiter you use.
The first line of the data file (the header record) must list the field names to process.
For each field listed in the header record, there must be an entry in the map file.
The map file must have the same character set encoding as the data file.
Every record in the data file must have the same number of fields as the header record.

For an example of a data file, see Sample Data File.

Properties File for Oracle Data Loader On Demand

The properties file is a text file that contains name-value pairs of configuration parameters for Oracle Data Loader On Demand. Parameters must be specified in the following format, one for each line:

optionName=optionValue

When specifying file paths in a properties file you must use double backslashes between directory levels. Note that this is different than entering file paths on the command-line where single backslashes are required. For example, when you specify the file path for log file you would use -clientlogfiledir "D:\dataload\logs" when you enter it on a command-line, but -clientlogfiledir "D:\\dataload\\logs" when you enter it in a properties file.

Boolean parameters can have a value of either True or False. For information on the parameters, see the following:

The table in the topic Command-Line Parameters for Oracle Data Loader On Demand has a list of parameters that applies to all operations.
The table in the topic Insert, Update, and Upsert Parameters has a list of parameters that applies to the Insert, Update, and Upsert operations.
The table in the topic Resuming or Halting Operations in Oracle Data Loader On Demand has a list of parameters that applies to the Resume operation.

Map File for Oracle Data Loader On Demand

A map file contains the field mappings between Oracle CRM On Demand and the fields from an external data source. You specify the path and the name of the map file in the properties file or in the command-line. The map file must be in CSV format. It must have the same character set encoding as the data file. The first line of the map file must contain the following header:

"Oracle CRM On Demand Field","Import File Field"

All remaining lines in the map file must contain a pair of mappings where the first item is a field in Oracle CRM On Demand and the second item is a field in your data file. Only mapped fields are processed. If the map file is not a valid CSV format, a mapping validation error occurs. For example, if you have a data file that contains two columns, and the names of those two columns are My Acct Name and My Acct Loc, then the map file contains the following:

"Oracle CRM On Demand Field","Import File Field"
"Name","My Acct Name"
"Location","My Acct Loc"

Map files are interchangeable between the Import operation in Oracle CRM On Demand and Oracle Data Loader On Demand. To save time, you can perform a small import (with at least one record), which generates a map file. The Import Assistant allows easy mapping of your data files with Oracle CRM On Demand fields. When the import finishes, the map file for the import becomes available in Oracle CRM On Demand. You can download the map file and use it with Oracle Data Loader On Demand. Note that the mapping file has the extension MAP. You must keep that extension for the mapping file to be recognized by Oracle Data Loader On Demand.

The double quotation marks are optional when you create a map file manually. If you create the map file using the Import Assistant, it surrounds all values with double quotation marks. For an example of a map file, see Sample Map File.