XML Files | Teradata Data Mover - 17.10 - Data Mover XML Files - Teradata Data Mover

Teradata® Data Mover User Guide

Product
Teradata Data Mover
Release Number
17.10
Release Date
June 2021
Content Type
User Guide
Publication ID
B035-4101-061K
Language
English (United States)

Data Mover commands have required and optional parameters you can specify by typing them directly in the command line or in an XML file the command uses. It is often more convenient to use XML files because you can reuse and easily modify them without having to type the parameter values each time you run a command.

The XML files that specify command parameters are referred to as parameters.xml throughout this book.

If the same parameter is defined in parameters.xml and also directly in the command-line, a message displays and the value from the command-line takes precedence.

Case Sensitivity in XML Files

When you create or modify an XML file, you specify values for elements, which correspond to command parameters. Element names, which are enclosed by opening and closing XML tags, are case-sensitive and must appear as shown in the sample XML files. For example, the job_name element must be in lowercase letters and must not be changed to JOB_NAME.

Some of the values that you specify or change are not case-sensitive. For example, the value for the element for export_without_spool can be entered as either true or TRUE. Both are valid. For the create command, the following two example XML files are equivalent.

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<!--  lowercase values  -->
 <dmCreate xmlns="http://schemas.teradata.com/dataMover/v2009" 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://schemas.teradata.com/unity/datamover.xsd">
		<job_name>floyd_dmdev_create</job_name>
		<source_tdpid>floyd</source_tdpid>
  <source_user>dmguest</source_user>
  <source_password>please</source_password>
  <target_tdpid>dmdev</target_tdpid>
  <target_user>dmguest</target_user>
  <target_password>please</target_password>
  <data_streams>4</data_streams>
  <max_agents_per_task>4</max_agents_per_task>
  <source_sessions>4</source_sessions>
  <target_sessions>4</target_sessions>
  <force_utility>tptapi</force_utility>
  <log_level>0</log_level>
			<database selection="unselected">
    <name>dmguest</name>
     <table selection="included">
      <name>orders_2010</name>
      <export_without_spool>true</export_without_spool>
      <validate_row_count>partial</validate_row_count>
      <sql_where_clause>
       <![CDATA[WHERE colA > 100]]>
      </sql_where_clause>
       <key_columns>
        <key_column>colA</key_column>
       </key_columns>
      <staging_to_target>insert_only</staging_to_target>
     </table>
   </database>
 </dmCreate>
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<!--  UPPERCASE VALUES  -->
 <dmCreate xmlns="http://schemas.teradata.com/dataMover/v2009" 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://schemas.teradata.com/unity/datamover.xsd">
		<job_name>floyd_dmdev_create</job_name>
		<source_tdpid>floyd</source_tdpid>
  <source_user>dmguest</source_user>
  <source_password>please</source_password>
  <target_tdpid>dmdev</target_tdpid>
  <target_user>dmguest</target_user>
  <target_password>please</target_password>
  <data_streams>4</data_streams>
  <max_agents_per_task>4</max_agents_per_task>
  <source_sessions>4</source_sessions>
  <target_sessions>4</target_sessions>
  <force_utility>TPTAPI</force_utility>
  <log_level>0</log_level>
			<database selection="unselected">
    <name>dmguest</name>
     <table selection="included">
      <name>orders_2010</name>
      <export_without_spool>TRUE</export_without_spool>
      <validate_row_count>PARTIAL</validate_row_count>
      <sql_where_clause>
       <![CDATA[WHERE colA > 100]]>
      </sql_where_clause>
       <key_columns>
        <key_column>colA</key_column>
       </key_columns>
      <staging_to_target>INSERT_ONLY</staging_to_target>
     </table>
   </database>
 </dmCreate>

The following table lists values that are not case-sensitive:

Element Value
force_utility DSA
TPTAPI
TPTAPI_LOAD
TPTAPI_UPDATE
TPTAPI_STREAM
JDBC
T2T
export_without_spool

overwrite_existing_objects

online_archive

TRUE
FALSE
FALSE
UNSPECIFIED
force_target_staging_table TRUE
FALSE
validate_row_count NONE
PARTIAL
ALL
staging_to_target NOT_SPECIFIED
DELETE_INSERT
MERGE
INSERT_ONLY
status_mode A
N
I
R
C
F
RS
Q
UC
B
action_time BEFORE
AFTER
enabled (an attribute of the action_time element) YES
NO
index_type HASH_INDEX
JOIN_INDEX
The values TRUE and FALSE are not case-sensitive for several elements and attributes, including:
  • compare_ddl
  • override_lock_access
  • use_userid_pool
  • sync (a child element of the dmCreate and dmEdit elements)
  • all and skip_prompt (child elements of the delete_job element)
  • copyStats (an attribute of the table or index elements)