Specifying options with the options.xml file

Consider the following important points before using the options.xml file:

• The Data Import command-line utility follows the sequence of the data import commands defined in the options.xml file.

• Each command tag listed in the options.xml file will be executed. If the same command tag occurs multiple times, the Data Import command-line utility executes the command tags as many number of times as listed.

  Warning

  Important

  The Data Import command-line utility invocation command must have -x, -u, -p, and -z parameters to start importing the data files using the options.xml file.

• The parameters that are included in the options.xml file override all the parameters passed through command line.
• If any error occurs during the command execution in the options.xml file, the Data Import command-line utility continues to execute the further commands listed in file.
• The Data Import command-line utility allows sequential and parallel importing of data in a single JVM invocation instance. This is done through the options.xml file using the isSerial attribute. If the value of the isSerial attribute is 'False' (default) or the attribute is not specified, the Data Import command-line utility imports the data by using the parallel mode. During parallel importing, the utility imports multiple data files simultaneously.
• The options.xml file has a global tag (optional) for global parameters. The global parameters can be overridden by individual command tags (local parameters specified in individual commands), except for the threads and the debug parameters. These global parameters cannot be overridden by local parameters.
  The threads and the debug parameters are not considered if they are specified as local parameters in a command tag format.

• If the -o and -z parameters are combined, the Data Import command-line utility treats the paths specified for the -z parameter as relative. The tool thus combines the paths specified in the -o and -z parameters and then continues importing the files listed in options.xml file. If only the -z parameter value is specified, the path specified for the -z parameter is considered as the absolute path.
   For example, if the following values are specified:
  • -o "c:\temp" -z "opt\fileName.arx"
     The final path (relative path) is "c:\temp\opt\fileName.arx"
     And if the following values are specified:

  • -z " c:\opt\fileName.arx"
     The final path (absolute path) is "c:\opt\fileName.arx"

    The preceding rule is true only for the data file's path specified in the -o parameter; all the remaining parameters that take the file path as an input are used as absolute paths or as relative paths with respect to the current invocation directory.

• The -z parameter cannot be used with the pattern and filelist parameters through the command line. These parameters can only be used independently or with the -o parameter (as a directory).
• The data import invocation using the -z parameter generates a summary file containing the results of all the data import commands defined in the options.xml file. This summary file has the same name as the options.xml file. For example, if the options.xml file has the name, option_fnd.xml, the Data Import command-line utility generates a summary file named option_fnd_summary.log.
• If the -l parameter (full path name of the log file) is specified for every command in the options.xml file, the Data Import command-line utility creates separate log files for every command tag. If the log file is the same for multiple command tags in the options.xml file, all the logging details for these command tags are written in that one log file. If the -l parameter is not specified in the command and in the options.xml file, the Data Import command-line utility creates a log file in the current directory with the same name as the data file name (datafilename.log ).
• If the debug parameter is specified as a global parameter, the value of this parameter will be common for all the commands in the options.xml file.
• In the options.xml file, the number of threads in a pool can be configured at the global level by setting the -threads parameter in the global tag with the optimum value. This switch is optional; if the command does not have this switch, the value of the -threads parameter is set to its default value (50).
  If the -threads parameter is specified as a global parameter, it overrides the threads option that was provided as a command line parameter while invoking Data Import command-line utility.

options.xml file scenario

The following XML tags and attributes can be used in the options.xml file:

• import—Root element of the options.xml file.
• global—Contains the global parameters with the attributes (name and value).
• commands—Contains the attribute, isSerial (default value, False) for serial and parallel importing.
• command—Contains the parameter with attributes (name and value).

You can rename the options.xml file to any custom name. Make sure that the file contains only the above XML tags and attributes, and is a valid and well-formed file. If the options.xml file is not a valid file or it does not exist, the Data Import command-line utility displays an error and will not proceed further.

<import>
<global>
<parameter name ="x" value="serverName"/>
<parameter name ="u" value="userName"/>
<parameter name ="p" value="password"/>
<parameter name ="debug" value="3"/>
<parameter name ="threads" value="32"/>
</global>
<commands isSerial = "true">
<command>
<parameter name ="D" value="1"/>
<parameter name ="o" value="dataFileDirPath"/>
</command>
<command>
<parameter name ="D" value="3"/>
<parameter name ="o" value="dataFileDirPath1"/>
<parameter name ="e" value= "10000,10050"/>
</command>
</commands>
<import>