Batch export properties

A sample export properties file named RDMBatchExportClient.properties is provided with the InfoSphere® MDM Reference Data Management Hub installation. The options in this file are used to specify parameters for running the batch export.

The general format of the options in the properties file is:
		option = value
The following options apply to batch export:
provider_url
This property is required. Provider URL of the server instance in the format host:port.

For example: myserver.ibm.com:9080

target_dir
This property is required. File output directory.

The default path is C:\output\.

Note: The batch export creates subdirectories within the named directory to hold the various files it produces.
format
This property is required. File format for the output. Supported formats are CSV and XML. The default format is CSV.

For example: format = csv

export_separator
This property is required. CSV delimiter, such as "," or "|". The default is a comma.

For example: export_separator = ,

export_wrapper
This property is required. The CSV wrapper default is double quotation marks.

For example: export_wrapper = "

timestamp_format
This property is required. A string that defines the format for time stamps that are used in CSV exports. When you perform an XML export, the batch export uses the time stamp format that is mandated by the XML specification.

The default is timestamp_format = "yyyy-MM-dd'T'HH:mm:ssz"

timezone_offset
This property is optional. Used in CSV exports to designate the offset that the values have from Coordinated Universal Time.

The default is timestamp_offset = +00:00.

date_format
This property is required. A string that defines the format for dates.

The default is date_format = yyyy-MM-dd.

max_translations
This property is required. The maximum number of translations to output in CSV files. A value of 0 instructs the software not to export any translations. For XML formatted output, all translations are exported unless this value is 0.

The default is max_translations = 10.

hierarchy_export
This property is required. The tree or list options are available for hierarchy exports.

The default is hierarchy_export = list.

user
This property is required. User credentials for web service authentication.

For example: user = tabs

password
This property is required. User credentials for web service authentication.

For example: password = tabs

requestid
This property is required. Request control parameters to identify the request.

The default is requestid = 100101.

requester_name
This property is optional. Request control parameters to identify the name of the user that makes the request.

The default is requester_name = Some Name.

request_lang
This property is optional. Request control parameter to identify the request language.

The default is request_lang = 100.

page_size
This property is required. Page size that is used while retrieving data from the server. Identifies the number of rows to be returned in a single request.

The default is page_size = 250.

debug
This property is required. When set to false (the default) no debug information is produced. When set to true debug information is written to the file debug.log in the output directory for the requested file type. If the debug.log file cannot be created, an error message is written to the command window that was used to start the batch export.

For example: debug = true

A sample batch export property file contains the following lines:
#Provider URL of the server instance Host:Port
provider_url = myserver.ibm.com:9080

#File Output Directory
target_dir = C:\\output\\
#File format. Supported Formats are "csv" and "xml"
format = xml

#CSV delimiter - for example "," or "|"
export_separator = ,

#CSV wrapper - usually double quotes
export_wrapper = "

#Date and timestamp formats - for example "yyyy-MM-dd'T'HH:mm:ssz"
date_format = yyyy-MM-dd
timestamp_format = yyyy-MM-dd'T'HH:mm:ssz

#Maximum number of translations to output in csv files
max_translations = 10

#For hierarchy exports, "tree" or "list" options are available.
hierarchy_export = list

#User Credentials for Web service Authentication
user = tabs
password = tabs

#Request Control Parameters
requestid = 100101
requester_name = someName 
request_lang = 100

#Page size while retrieving data from the server.
page_size = 250


Last updated: 22 Mar 2017