1. Understanding Import and Export Management for Sales and Fusion Service
  2. Command-Line Parameters

Command-Line Parameters

This topic describes the available command-line parameters for External Data Loader Client.

You can use the help option to see a list of all the commands that are available. For example, the following command lists all the command-line options.

> java -jar oscdataloader.jar help

You can get the options for each command, by using the option -h for that command. For example, the following command lists the options available for the submit command.

> java -jar oscdataloader.jar submit -h

If you're using a proxy server while importing using the EDLC, then you must specify the proxy parameters in the command-line call. The following example shows how:

java -Dhttps.proxyHost=host_name -Dhttps.proxyPort=80 -jar
oscdataloader.jar listobjects -target-url https://<your_pod> -u importuser -w

Here are the command-line parameters.

Command and Options (Preceded by Hyphen)

Description

config

The path where the configuration file is located.

-desc

The description of the import job submitted.

-delimiter

The delimiter used in your source file. The default value is COMMA_DELIMITER. Possible values are:

  • COMMA_DELIMITER: Indicates the comma delimiter

  • OTHER_CARET: Indicates the caret symbol delimiter

  • OTHER_COLON: Indicates the colon delimiter

  • OTHER_CLOSING_CURLY_BRACKET: Indicates the closing curly bracket delimiter

  • OTHER_CLOSING_PARENTHESIS: Indicates the closing parenthesis delimiter

  • OTHER_CLOSING_SQUARE_BRACKET: Indicates the closing square bracket delimiter

  • OTHER_EXCLAMATORY: Indicates the exclamatory mark delimiter

  • OTHER_MINUS: Indicates the minus delimiter

  • OTHER_OPENING_CURLY_BRACKET: Indicates the opening curly bracket delimiter

  • OTHER_OPENING_PARENTHESIS: Indicates the opening parenthesis delimiter

  • OTHER_OPENING_SQUARE_BRACKET: Indicates the opening square bracket delimiter

  • OTHER_PIPE: Indicates the pipe delimiter

  • OTHER_PLUS: Indicates the plus delimiter

  • OTHER_QUESTION_MARK: Indicates the question mark delimiter

  • OTHER_STAR: Indicates the star symbol delimiter

  • OTHER_TILDE: Indicates the tilde symbol delimiter

  • SEMI_COLON_DELIMITER: Indicates the semicolon delimiter

-df

The date format that's used in your source CSV file. The default value is ORA_ZCA_US_FORMAT. Possible values are:

  • ORA_ZCA_EUROPE_FORMAT: EU - YYYY/MM/DD

  • ORA_ZCA_ISO8601_FORMAT: ISO 8601 - YYYY-MM-DD

  • ORA_ZCA_UK_CANADA_FORMAT: UK/Canada - DD/MM/YYYY

  • ORA_ZCA_US_FORMAT: US - MM/DD/YYYY

-ds

The decimal separator is used in your source file. The default value is Period (.). Possible values are:

  • , (Comma)

  • . (Period)

-ecl

Enable or disable custom business logic for the import job. The default value is false. Possible values are:

  • true

  • false

-encoding

The source file encoding. Possible values are:

  • ORA_ZCA_UTF8_ENCODING

  • ORA_ZCA_UTF16_ENCODING

  • ORA_ZCA_UTF16BE_ENCODING

  • ORA_ZCA_UTF16LE_ENCODING

  • UTF8

-export

Download the exported attachment files from the content management server to your local directory. For example, 

java -jar oscdataloader.jar export -object Attachments -export-id 300100189790029 -target-url https://<your_pod> -output-path "C:\MyAttachments"

Make sure that the directory you provide as output path already exists with read and write permissions for the user performing the export.

getlogs

Get log files of an import activity.

-help

Display help text containing possible commands.

help

Show the usage message.

-high-volume

Activate high-volume import for supported objects. By default, this option is set to true for all the supported objects. To use low-volume import, set this option to false. For example, 

> java -jar oscdataloader.jar submit -high-volume false -input-file Account.csv -import-name "Account Import" -object Account

-import-activity (required)

The import activity identifier of the job. This is used to track the status of the import job.

-import -name

The name of the import job.

-input -file (required)

The name of source CSV file. Provide a file name within 40 characters.

-latest

Indicates that the import jobs should be sorted by the latest creation date, when used with the listimports command. If this parameter isn't used, then the import jobs are listed sorted by the oldest creation date. For example,

> java -jar oscdataloader.jar listimports -target-url https://mypod.oracle.com -username importuser -latest

lists the imports sorted by the latest creation date. This parameter can take the value true or false. A value of true indicates that the imports are sorted by the latest creation date. By default, this parameter has the value false.

--limit

The number of import jobs to be listed by the listimports command. It can have possible values ranging from 1 to 500. Default value is 25. For example, 

> java -jar oscdataloader.jar listimports -target-url https://mypod.oracle.com -username importuser -limit 100

lists the first 100 import jobs.

listimports

Get the list of import activities. You can get the list sorted by latest creation date by using the parameter latest.

listobjects

List the objects supported by External Data Loader Client.

-log-type (required)

Specify the type of log file to generate. Possible values are Exception, Error, Diagnostic, and All.

-mapping-number (required)

The mapping number.

-mode

The import mode which is to be used for the import job. The default mode is CREATE_RECORD. Possible values are:

  • CREATE_ONLY: Create records

  • CREATE_RECORD: Update and create records

  • DELETE_RECORD: Delete records

  • UPDATE_RECORD: Update records

-nemail

The email address to which the import job status would be sent.

-object (required)

The object to import.

-offset

The import offset.

-s

The mode of scheduling the import job which determines whether the import job executes immediately or at a future date. The default value is ONE_TIME_IMMEDIATE. Possible values are:

  • ONE_TIME_IMMEDIATE: Immediate

  • ONE_TIME_SCHEDULE: Future

savepassword

Save credential in credential store wallet.

split

Split the import data file into multiple smaller files. The Split Size parameter is used to configure the split size that's used by EDLC. You can use either a low-volume split size or a high-volume split size.

You can use the split records option to use low-volume split. Low-volume split has a default split size value of 50000 records. You can either set the default split size using the profile option ORA_ZCA_IMPORT_LOW_VOLUME_CHUNK_SIZE, or specify the split size using the split records command. Possible values are 10k,20k,30k,40k,and 50k.

Example command:

> java -jar oscdataloader.jar submit -input-file Account.csv -import-name "Account Import"-object Account -mapping-number 123565 -split-records 30000

You can use the high volume split option to use high-volume split. High-volume split has a default split size value of 200000 records. You can either set the default split size using the profile option ORA_ZCA_IMPORT_HIGH_VOLUME_CHUNK_SIZE, or specify the split size using the split records command. Possible values are 100k,200k,300k,400k,and 500k.

Example command:

> java -jar oscdataloader.jar submit -input-file Account.csv -import-name "Account Import" -object Account -mapping-number 123565 -high-volume-split-records 200000
Note: You can use this parameter when the default values slow down the performance or if an optimum size is recommended for the data pattern being imported. This parameter is provided to reduce the number of records that need to split for each EDLC job.

-st

Scheduled future time stamp for an import activity job.

status

Retrieve the status of the specified import.

submit

Submit file import request in Sales and Fusion Service.

-target-url (required)

The environment against which the command is run.

-tsf

The time stamp format used in your source file. The default value is ORA_ZCA_US_FORMAT. Possible values are:

  • ORA_ZCA_CANADA_FORMAT: Canada - DD/MM/YYYY hh:mm:ss PM

  • ORA_ZCA_EUROPE_FORMAT: EU - YYYY/MM/DD 24:mm:ss

  • ORA_ZCA_ISO8601_FORMAT: ISO 8601 - YYYY-MM-DDThh:mm:ss.sss+/-hh:mm

  • ORA_ZCA_UK_FORMAT: UK -DD/MM/YYYY 24:mm:ss

  • ORA_ZCA_US_FORMAT: US - MM/DD/YYYY hh:mm:ss PM

-username (required)

Specify the user name of the user running the command.

-wallet

The Credential Store that holds one set of user credentials (user name and password pair).
validate-settings-for- performance Validate settings to check high-volume import performance. You can use this parameter when you have performance issues while import importing data in high volume for Account, Contact, Address, Relationship, Organization, and Person objects. To validate the settings, you must pass this parameter as “true”. When the parameter is set to “true”, then import job validates the value of the following profile options to determine if the profile options have been set to the recommended values.

Profile Option

 Recommended Value
HZ_POST_IMPORT_GNR_INVOKE N
ZCH_ENABLE_SURVIVORSHIP N
ORA_HZ_ENABLE_SIMPLIFIED_IMPORT_STATS Y
ZCA_BATCH_ASSIGN_ON_BULK_IMPORT N
ZCA_IMPORT_PURGE_ON_JOBCOMPLETION Y
ZCA_IMPORT_SUPPRESS_SUCCESSLOG_GENERATION Y
ZCA_IMPORT_PURGE_FROM_UI Y
ZPM_ENABLE_PARTNER_EVENTS N
ZCA_PUBLIC_BUSINESS_EVENTS N
ZCX_CUSTOM_OBJECT_EVENTS No
HZ_ENABLE_ENTITY_EVENTS No
HZ_INVOKE_OBJ_WF_ON_TRACKING No