User Guide : Using Runtime Engine : Runtime Engine Command Line Interface : Command Line Options
 
Share this page                  
Command Line Options
The Runtime Engine command line interface includes options in the following categories:
Global Options
Map Options
Process Options
To view information about these options, run any of the following commands:
djengine -h
djengine -help
Note:  The options are case-sensitive.
Global Options
Global options are global because they do not apply to a single transformation or process.
You must specify global options before the map or process options.
Full Name
Short Name
Argument
Description
-Help
-h
-
Displays information about the syntax and options available for the Runtime Engine. Also, displays version, copyright, and registration information about the engine and exits.
Note:  Do not use this option with any other option.
-Repeat_Count
-r
Number
Sets the number of times the map or process will be run. If set to zero, then the file is run continuously.
-Verbose
-v
-
Displays informational messages during execution.
-Version
-V
-
Displays the version number and some other information of the installed Runtime Engine, then exits.
Note:  Do not use this option with any other option.
-Base
-b
Filename
Specify the base directory, djar, or zip to resolve the runtime configuration package. This is mainly required to run existing v10 packages. For v11 packages, where the djar and the external RTC are not in the same location, you can edit the RTC’s entry point.
-RuntimeConfig
-RC
Filename
Specify the runtime configuration file that must be used.
-PackageName
-RP
String
Specify the package name (overrides the entry in the runtime configuration file).
-PackageVersion
-RV
String
Specify the package version (overrides the entry in runtime configuration file).
-Source_List
-ss
-
Displays the available source connections that can be used as the source file types.
-Target_List
-ts
-
Displays the available target connections that can be used as the target file types.
-Initialization_Info
-i
file Name
Sets the location of the initialization file. It is recommended to use the cosmos.ini file available in the default location.
You can also create an initialization file based on the default cosmos.ini file. Make sure that there are no errors in the format and content of the initialization file. For information about the cosmos.ini file settings, see Cosmos.ini Settings.
-Clear_Logfile
-cl
-
Clears the log file before each run. If there are multiple engine steps (processes or maps), then this command clears the log file in each step. If a repeat count is specified, only the log file from the last repetition exists.
-Single_Thread
-ot
-
Forces -CoInitializeEx call to set the threading mode as Single-Thread Apartment, which means each invoked COM object is isolated from the other threads. If multi-threading is enabled on the system, then this option restricts the process or map for which it applies single threading.
Note:  This option is applicable only on Windows.
-Debug
-d
-
Displays additional information about the steps that are run.
-Trace
-t
-
Trace the map execution.
-Define_Macro
-D
String
Sets a macro value that can be used in the map or process. Instead of specifying directory paths in a map, Macros are set using the following syntax:
-Define_Macro NAME=filepath
where:
NAME: Name of the macro set up in Map Editor
filepath: Value for the macro.
Note:  You can use macros in Connection Strings for ChangeSource, ChangeTarget, SDK interfaces, and the engine Command Line Interface (CLI) for portability.
For information about setting up macros in Map Editor, see Managing Macro Sets and Macros.
-Http_Monitor
-mh
Number
Sets a simple progress monitor on the port specified using HTTP. To monitor the progress, open a web browser and enter the HTTP URL using the name of the local host and the port number provided for the Runtime Engine. For example, if the host name is engine.abcd.com and the port number is 100, the URL is:
http://engine.abcd.com:100
Note:  The URL is only valid while the engine is running.
-Macro_File
-mf
File name
Specifies the location of an XML or JSON file that has been created to store the macros used by the engine.
-Profile
-P
None
Turns on engine profiling and uses the default output file name as profile.out (generated in the current execution directory).
-Profile_To_File
-PF
String
Turns on profiling. The specified argument is the path name for the profiling output file.
-Profile_Filter
-PM
Number
Mask of events that will be profiled.
Note:  The RC, DC, RP, RV options are only listed as global because they do not apply only to transformations or processes. Only -b option is actually global.
Map Options
Map options are specified on the command line after the global options.
Option Name
Short Name
Argument
Description
-Logfile
-l
File Name
Set a log file with this name instead of the default name. This value must include the path of the file. If the path is not included, then Runtime Engine creates the log file in the current directory. If the log file name is not set using this option, then the log file specified in the map or process is used. By default, Runtime Engine logs all messages including informational messages.
-Error_File
-l
filename
Set log file for this transformation.
-Expr_Module_List
-em
String
Add list of expression modules. The string value must contain the path and file name of each expression module delimited by a semicolon (;) or a line feed (\n).
For example, if there are two expression modules you want to add to a map or process named c:\test\expr1.ezscript and c:\test\expr2.ezscript, add them using this option on the command line or in a specification file:
-Expr_Module_List c:\test\expr1.ezscript;c:\test\expr2.ezscript
-Layout_Mismatch
-lm
Number
Set option for target layout mismatch.
-Max_Errors
-me
Number
Sets the maximum errors for a map or process run. This value is used in the default Error Routine to determine if the number of errors encountered has reached the maximum. If the maximum is reached, the map or process is aborted.
-Null_Handling
-nh
Number
If the target field is set to not accept Nulls and if the source field has spaces, Nulls, or is an empty string, this option indicates how the Runtime Engine transforms the data:
0: Ignore - If a null is encountered, the record is rejected and the transformation proceeds as normal. In this case, the only way to avoid having the record rejected is to write an EZscript in the map or process to transform the data.
1: Treat as Warning - Runtime Engine transforms the data on a best-fit basis, and a warning message is written to the log file indicating a null was encountered. The transformation continues uninterrupted.
2: Treat as Error (default) - If a null is encountered, an error message appears. If the maximum error count is set to 1, the transformation is aborted. In this case, the only way to avoid having the record rejected (and possibly aborting the transformation) is to write an EZscript to transform the data.
Note:  This option is applicable for SQL targets only.
-Overflow_Handling
-oh
Number
Sets overflow handling. It governs the Runtime Engine's behavior when an overflow is encountered while running a transformation:
0: Runtime Engine does nothing when an overflow occurs.
1: Runtime Engine logs a warning message to the log file and continues processing.
2: Runtime Engine logs an error message to the log file and stops processing.
-Key
-k
string
Specifies a password for accessing a password-protected .djar file. Specify the options, provide the password, and then the name of the .djar file. These .djar files can contain map or process files.
For example, to run a process file that is inside a .djar file named abcd.djar, run the following command:
djengine -pe -k password abcd.djar
-Set
-se
name=value
Sets a variable for the map. You can substitute global variables within the Map Editor and provide their values at run time on the command line or in a specification file. Variables are set using the following syntax:
-Set NAME=value -se NAME=value
where:
NAME - Name of the variable set up in Map Editor.
value - Value that must be assigned for NAME.
For example:
djengine -se myvar=1000 conv.map.rtc
You can also pass database connection string information using the -Set option as follows:
djengine -set myvar=\"userid=sa;password=unlock\" conv.map.rtc
Escape double quotes with a backslash.
-Daemonize
-dm
 
Runs the map as a daemon.
Note:  This option is applicable only for Linux.
Process Options
Process options are specified on the command line after global options.
Option Name
Short Name
Argument
Description
-Logfile
-l
file name
Set the log file for this process. The value must include the path name of the file. If the path is not included, then Runtime Engine creates this file in the current directory. If a log file is not set using this option, then the log file specified in the process is used. By default, Runtime Engine logs all messages including informational messages.
-Process_Execute
-pe
none
Initiates a process execution.
-Process_Force_Reload
-pf
none
Sets the flag for processes to unload and reload maps and processes during execution. This flag helps when the process or transformation steps depend on macros that may be set by scripts in the process.
Note:  This argument is similar to setting the UnloadMapsAndProcesses flag in the cosmos.ini.
This option can be used in any of the following ways:
After -pe option
djengine -pe -pf test.ip.xml
Before specifying the djar name
djengine -pf test.djar
-Process_Root_Dir
-pr
dirpath
Sets the process root directory path, where the process files and the associated map specification files are located.
The value is the path to the location of the process file. The path can be a standard Windows or Linux path, a UNC path, or a relative path. The root directory must contain the process file (.process) and all map specification files (.map.rtc) for every map included in that process for all subprocesses referenced within the main process.
If the process root directory is not specified on the command line or in the option file, then Runtime Engine searches for the process files in the current directory.
-Key
-k
string
Specify a password for accessing a password-protected .djar file. The .djar files can contain map or process files.
-Set
-se
name=val
Sets a variable for process. You can substitute the global variables within Process Editor and provide their values at runtime on the command line or in a specification file. Variables are set using the following syntax:
-Set NAME=value-se NAME=value
where:
NAME is the name of the variable set up in Process Editor
value is the numeric value that must be assigned to the NAME.
Example:
djengine -se myvar=1000 conv.process
You can also pass database connection string information using the -Set parameter as follows:
djengine -set myvar=\"userid=sa;password=unlock\" conv.process
-Daemonize
-dm
 
Runs the process as a daemon.
Note:  This option is only applicable for Linux.
Command Line Options (XML Files)
This section provides the command line options for XML-based files.
Note:  Data Integrator v9 options are maintained for backwards compatibility only. They are not applicable for integration artifacts designed in DataConnect v11 or higher.
Global Options (XML Files)
The following table provides the global options for XML-based artifacts.
 
Full Name
Short Name
Argument
Description
-Help
-h
-
Displays information about the syntax and options available for the Runtime Engine. Also, displays version, copyright, and registration information about the engine and exits.
Note:  Do not use this option with any other option.
-Repeat_Count
-r
Number
Sets the number of times the map or process will be run. If set to zero, then the file is run continuously.
-Verbose
-v
-
Displays informational messages during execution.
-Version
-V
-
Displays the version number and some other information of the installed Runtime Engine, then exits.
Note:  Do not use this option with any other option.
-Source_List
-ss
-
Displays the available source connections that can be used as the source file types.
-Target_List
-ts
-
Displays the available target connections that can be used as the target file types.
-Initialization_Info
-i
file Name
Sets the location of the initialization file. It is recommended to use the cosmos.ini file available in the default location.
You can also create an initialization file based on the default cosmos.ini file. Make sure that there are no errors in the format and content of the initialization file. For information about the cosmos.ini file settings, see Cosmos.ini Settings.
-Clear_Logfile
-cl
-
Clears the log file before each run. If there are multiple engine steps (processes or maps), then this command clears the log file in each step. If a repeat count is specified, only the log file from the last repetition exists.
-Single_Thread
-ot
-
Forces -CoInitializeEx call to set the threading mode as Single-Thread Apartment, which means each invoked COM object is isolated from the other threads. If multi-threading is enabled on the system, then this option restricts the process or map for which it applies single threading.
Note:  This option is applicable only on Windows.
-Debug
-d
-
Displays additional information about the steps that are run.
-Trace
-t
-
Trace the map execution.
-Define_Macro
-D
String
Sets a macro value that can be used in the map or process. Instead of specifying directory paths in a map, Macros are set using the following syntax:
-Define_Macro NAME=filepath
where:
NAME: Name of the macro set up in Map Editor
filepath: Value for the macro.
Note:  You can use macros in Connection Strings for ChangeSource, ChangeTarget, SDK interfaces, and the engine Command Line Interface (CLI) for portability.
For information about setting up macros in Map Editor, see Managing Macro Sets and Macros.
-Http_Monitor
-mh
Number
Sets a simple progress monitor on the port specified using HTTP. To monitor the progress, open a web browser and enter the HTTP URL using the name of the local host and the port number provided for the Runtime Engine. For example, if the host name is engine.abcd.com and the port number is 100, the URL is:
http://engine.abcd.com:100
Note:  The URL is only valid while the engine is running.
-Macro_File
-mf
File name
Specifies the location of an XML or JSON file that has been created to store the macros used by the engine.
-Profile
-P
None
Turns on Engine profiling and uses the default output file name as djprof.out.
-Profile_To_File
-PF
String
Turns on profiling. The specified argument is the path name for the profiling output file.
-Profile_Filter
-PM
Number
Mask of events that will be profiled.
@<path>
String
Path to specification file. For more information, see Command Line Override Strings (XML Files).
Map Options (XML Files)
The following table provides the map options for XML-based artifacts.
 
Option Name
Short Name
Argument
Description
-Automatic_Mapping
-am
Number
Sets automatic mapping for the first target on the map. It indicates the type of mapping to perform when no mapping is encountered:
0: Error aborts the running the map (default)
1: Map by matching field name
2: Map by matching field position
3: No automatic mapping
4: Duplicate source layout
-New_Transformation
-nt
None
Start new map specification. This option is dependent on the following options:
-Source_Type
-Source_Connect_Info
-Target_Type
-Target_Connect_Info
-Automatic_Mapping
 
For example:
djengine -v -l D:\\Workspace\\test.data\\Logs NewMap.log -nt -st "Oracle 12c" -sc "database=QADB7;userid=test;password=test1;table=EMP" -tt "ASCII (Delimited)" -tc "File=D:\\Workspace\\test.data\\TARGET NewMapusingCMD_UsingOracldDB.txt;FieldSeparator=|;Header=false" -am 1
-Reject_Type
-rt
String
Set the Reject Type.
-Reject_Connect_Info
-rc
String
Change the Reject Connection Information.
-Source_Type
-st
string
Sets the source type for a new map. The source type is the name of the software application or the type of data from which the source data originated. For a list of supported source type names use the -Source_List option on the Runtime Engine command line.
Note:  This option must be used only when a new map is being created and run. It is invalid to try to set the source type when working with an existing map.
-Source_Connect_Info
-sc
string
Change source connection information. For more information, see -Source_Connect_Info.
-Source_Mismatch
-sm
number
Specify how Runtime Engine handles any mismatch between the layout of the source data and the source schema:
0: Treat a mismatch as an error.
1: Use the layout in the map schema.
2: Use the layout of the source data and map by position.
3: Use the layout of the source data and map by name.
-Source_Filter_Expr
-sf
string
Source filter expression is double quotes. The syntax of the source filter expression in the file is the same as the syntax for source filter expressions in EZscript.
Use backslash to escape double quotes (") present in the expression.
One source filter is added for each -Source_Filter_Expr option and file name value.
For example:
djengine -v -l D:\\RegressionTestWorkspace\\test.data\\Logs setOption.log -mf D:\\RegressionTestWorkspace\\test.data\\Macros MacroDef_112.json -sf "Records(\"R1\").Fields(\"state\")==\"TX\"" m_SetSourceType.tf.xml
-Clear_Source_Filters
-cs
 
Clears existing source filters in the map (for example, filters created using Map Editor) before adding new source filters.
Note:  If this option is not set, then the new source filters are added to the existing source filters in the map.
-Source_Sample_Logic
-sl
string
Set sample logic information for source. For more information, see -Source_Sample_Logic.
-Target_Type
-tt
string
Set target type for a new map. The target type is the name of the software application or type of data to which the data must be transferred. For the list of supported target type names, use the -Target_List parameter on the Runtime Engine command line.
Note:  This option must be used only when a new map is being created and run. It is invalid to try to set the target type when working with an existing map.
-Target_Connect_Info
-tc
string
Change target connection information. For more information, see -Target_Connect_Info.
-Target_Filter_Expr
-tf
string
Target filter expression in double quotes. The syntax of the target filter expression in the file is the same as the syntax for target filter expressions in EZscript.
One target filter is added for each -Target_Filter_Expr option and filename value.
Use backlash to escape double quotes (") present in the expression.
For example:
djengine -v -l D:\\RegressionTestWorkspace\\test.data\\Logs setOption.log -mf D:\\RegressionTestWorkspace\\test.data\\Macros MacroDef_112.json -tf "Targets(0).Records(\"R1\").Fields(\"state\")==\"TX\"" m_SetTargetType.tf.xml
-Clear_Target_Filters
-ct
 
Clears existing target filters in the map (for example, filters created using Map Editor) before adding new target filters.
Note:  If this option is not set, then the new target filters are added to the existing target filters in the map.
-Target_Sample_Logic
-tl
string
Set sample logic information for target. For more information, see -Target_Sample_Logic.
-Truncation_Handling
-th
number
Sets truncation handling for the map. This setting governs Runtime Engine behavior when a truncation is encountered while running a map.
0: Runtime Engine does nothing when a truncation occurs.
1: Runtime Engine logs a warning message to the log file and continues processing.
2: Runtime Engine logs an error message to the log file and stops processing.
-Query_Statement
-qs
file name
Set the query statement available in an ASCII text file that must be used with the source file for this map.
Note:  If the path is not included, then the Runtime Engine assumes that the file is in the current directory.
-Progress_Frequency
-pf
number
Sets the frequency when progress checks are made during a map or process run. The default progress frequency is two seconds. This means that a progress check is performed every two seconds when a map or process is running. The default progress callback is called with every progress check and an informative message is written to the log file.
The resolution for the progress frequency setting is 1/5 of a second. This means that if the number value is set to 10 the progress check is made every two seconds.
Note:  This option is applicable only for artifacts in XML format.
-Target_Mismatch
-tm
number
Specify how Runtime Engine handles any mismatch between the layout of the target data and the target schema:
0: Treat a mismatch as an error.
1: Use the layout in the map schema.
2: Use the layout of the target data and map by position.
3: Use the layout of the target data and map by name.
Note:  This option is applicable only for artifacts in XML format.
For additional examples, see Additional Examples.
-Source_Connect_Info
This options changes the source connection information. The connection information can include core connection information, property information, and browser information. It is a collection of attribute value pairs that describe the source connection information. If no attribute value pair is encountered, then it is assumed that the string value is a connection file name.
The syntax of an attribute value pair is:
attributeName=attributeValue
A semicolon (;) separates each attribute value pair. The attribute names are not case-sensitive.
The core connection attribute names are:
File
Database
Server
Userid
Password
Table
The property attribute names is based on the source type. For example, the properties for a delimited Unicode source are different than the properties for a Salesforce source. Invalid attribute names are ignored in the connection string. However, a warning message is logged in the error log.
Attribute names and values containing spaces or special characters must be in quotes. Double quotes allow escaping of meta characters by using the backslash. For example, if an attribute value contained a semicolon, a backslash must be used to escape it ( \; ). Single quotes indicate the Runtime Engine to use the value within single quotes. No escaping is used with single quotes.
The order in which the connection information is set is not important when using a connection string. This is because Runtime Engine extracts all the connection information from the connection string and then sets the information in the appropriate order. However, when the server name is set, the database name and the table connection information are cleared. When the database name is set, the table connection information is cleared. If only the server is set in the connection string, then the database name and table are cleared.
Examples
This example assumes that the source type is delimited ASCII. File is the only connection property related attribute. The other attribute value pairs are source properties related to a delimited ASCII source.
-Source_Connect_Info "File=d:\\dj5libs\\tutor1.asc;RecordSeparator=CR-LF; RecordFieldCount=0;FieldSeparator=,;FieldStartDelimiter='"';FieldEndDelimiter='"';Header=False;AlternateFieldSeparator=None;StartOffset=0;AutomaticStyling=False;StyleSampleSize=1000;StripLeadingBlanks=True;StripTrailingBlanks=True"
This example assumes that the source type is Access ODBC. The Server, Database, UserID, and Table attributes are the related connection properties. The other attributes are source properties related to an ODBC source.
-Source_Connect_Info "Server=ACCESS;Database='MS Access 2.0 Databases';UserId=admin;Table=tblTest;DriverOptions='; DBQ=c:\\MyData.600\\test.mdb;InstallDir=c:\\MyData.600; DriverId=25;FIL=MS Access;MaxBufferSize=512; PageTimeout=600';PrimaryKey=;SystemTables=False; TransactionIsolation=versioning"
-Source_Sample_Logic
Sets sample logic information for the source. It is a collection of attribute value pairs that describe the sample information. The syntax of an attribute value pair is:
attributeName=attributeValue
A semicolon (;) separates each attribute value pair. The attribute names are not case sensitive. The attribute names are:
Type
Start
Count
Frequency
There are three types of sampling:
0: Sampling all of the records
1: Sampling a range of records
2: Sampling every nth record
The different sample types govern the appropriate attributes to include in the sample string.
Examples
A sample with all records only needs the type attribute in the sample string. The following string sets the sample type to all records:
-Source_Sample_Logic type=0
A sample with a range of records needs the type, start and count attributes in the sample string. The following string sets the sample type to range, the starting record to 3 and the record count to 5. This means that the sample records are 3 through 7.
-Source_Sample_Logic type=1;start=3;count=5
A sample including every nth record needs the type and frequency attributes in the sample string. The following string sets the sample type to every nth and the frequency to 5. This means that the sample includes every fifth record.
-Source_Sample_Logic type=2;frequency=5
Note:  Invalid attribute names are ignored in the sample string. Also, an error is logged if the start or count is set without setting a sample type of range or the frequency is set without setting a sample type of every nth. When the start, count and frequency values are set, they must be greater than 0.
-Target_Connect_Info
This option changes the target connection information. The connection information can include core connection information, property information, and browser information. It is a collection of attribute value pairs that describe the target connection information. If no attribute value pair is encountered, then it is assumed that the string value is a connection file name.
The syntax of an attribute value pair is:
attributeName=attributeValue
A semicolon (;) separates each attribute value pair. The attribute names are not case sensitive.
The core connection attribute names are:
File
Database
Server
Userid
Password
Table
The property attribute names are based on the target type. For example, the properties for a Delimited Unicode target is different than the properties for a NetSuite target. Invalid attribute names are ignored in the connection string. However, a warning message is logged in the error log.
Attribute names and values containing spaces or special characters must be in quotes. Double quotes allow escaping of meta-characters by using the backslash. For example, if an attribute value contained a semicolon, a backslash must be used to escape it (\;). Single quotes indicate Runtime Engine to use the value within single quotes. No escaping is used with single quotes.
The order in which the connection information is set is not important when using a connection string. This is because Runtime Engine extracts all the connection information from the connection string and then sets the information in the appropriate order. However, when the server name is set, the database name and the table connection information are cleared. When the database name is set, the table connection information is cleared. If only the server is set in the connection string, then the database name and table are cleared.
Example
This example assumes that the target type is binary. File is the only connection property related attribute. The other attribute value pairs are target properties related to a binary target.
-Target_Connect_Info "File=d:\\pv8\\capi\\test\\tutorout.bin;EBCDIC=False; PageSize=0;RecordSeparator=None"
-Target_Sample_Logic
Sets Sample Logic information for target. It is a collection of attribute value pairs that describe the sample information. The syntax of an attribute value pair is:
attributeName=attributeValue
A semicolon ( ; ) separates each attribute value pair. The attribute names are not case sensitive. The sample attribute names are:
Type
start
Count
Frequency
There are three types of sampling:
0: Sampling all of the records
1: Sampling a range of records
2: Sampling every nth record
The different sample types govern the appropriate attributes to include in the sample string.
Examples:
A sample with all records only needs the type attribute in the sample string. The following sample string sets the type to all records.
-Target_Sample_Logic type=0
A sample with a range of records requires the type, start and count attributes in the sample string. The following sample string sets the type to range with a starting record of 5 and a record count of 8. This means the sample includes records 5 through 12.
-Target_Sample_Logic type=1;start=5;count=8
A sample including every nth record needs the type and frequency attributes in the sample string. The following sample string sets the type to every nth and the frequency to 3. This means that the sample is every 3rd record.
-Target_Sample_Logic type=2;frequency=3
Note:  Invalid attribute names are ignored in the sample string. Also, an error is logged if the start or count is set without setting a sample type of range, or if the frequency is set without setting a sample type of every nth. When the start, count and frequency values are set, they must be greater than 0.
Additional Examples
The following examples show usage of -sc, -st, -tt, and -tc options:
Using ASCII (Delimited) as Source and Target
djengine -v -l D:\\Workspace\\test.data\\Logs\\NewMap.log -nt -st "ASCII (Delimited)" -sc "File=D:\\Workspace\\test.data\\SOURCES\\AsciiD\\Accounts.txt;FieldSeparator=,;Header=true" -tt "ASCII (Delimited)" -tc "File=D:\\Workspace\\test.data\\TARGET\\NewMapusingCMD.txt;FieldSeparator=|;Header=false" -am 1
Using Oracle 12c as Source and MySQL (ODBC 3.5) as Target
djengine -v -l D:\\Workspace\\test.data\\Logs\\NewMap.log -nt -st "Oracle 12c" -sc "database=QADB7;userid=scott;password=tiger;table=EMP" -tt "ASCII (Delimited)” -tc "File=D:\\Workspace\\test.data\\TARGET\\NewMapusingCMD_UsingOracldDB.txt;FieldSeparator=|;Header=false" -am 1
Using MySQL as Target and Target Type as ODBC
djengine -v -l D:\\Workspace\\test.data\\Logs\\NewMap.log -nt -st "Oracle 12c” -sc "database=QADB7;userid=scott;password=tiger;table=EMP" -tt "MySQL (ODBC 3.5)" -tc "Database=Mysql;UserId=root;Password="root";Table=Reg_DCNG-14233" -am 1
 
Process Options (XML Files)
The following table provides the process options for XML based artifacts.
 
Option Name
Short Name
Argument
Description
-Logfile
-l
file name
Set the log file for this process. The value must include the path name of the file. If the path is not included, then Runtime Engine creates this file in the current directory. If a log file is not set using this option, then the log file specified in the process is used. By default, Runtime Engine logs all messages including informational messages.
-Process_Execute
-pe
none
Initiates a process execution.
-Process_Root_Dir
-pr
dirpath
Sets the process root directory path, where the process files and the associated map specification files are located.
The value is the path to the location of the process file. The path can be a standard Windows or Linux path, a UNC path, or a relative path. The root directory must contain the process file (.process) and all map specification files (.map.rtc) for every map included in that process for all subprocesses referenced within the main process.
If the process root directory is not specified on the command line or in the option file, then Runtime Engine searches for the process files in the current directory.
-Key
-k
string
Specify a password for accessing a password-protected .djar file. The .djar files can contain map or process files.
-Set
-se
name=val
Sets a variable for process. You can substitute the global variables within Process Editor and provide their values at runtime on the command line or in a specification file. Variables are set using the following syntax:
-Set NAME=value-se NAME=value
where:
NAME is the name of the variable set up in Process Editor
value is the numeric value that must be assigned to the NAME.
Example:
djengine -se myvar=1000 conv.process
You can also pass database connection string information using the -Set parameter as follows:
djengine -set myvar=\"userid=sa;password=unlock\" conv.process
-Daemonize
-dm
 
Runs the process as a daemon.
Note:  This option is only applicable for Linux.
Command Line Override Strings (XML Files)
You can override both the source and target connection information in an existing map. Overrides can range from pointing to a different source or target file to enumerating settings to connect to a SQL database. Both file and table wild cards are supported. The source and target types may also be entered if the map is new.
 
Overrides is applicable only when you run Data Integrator 9 artifacts.
Overriding source and target connection information is an all-or-nothing proposition. For example, you cannot change the Server parameter:
-Source_Connect_Info "SERVER=MyServer"
without also specifying the remainder of the connection string:
-Source_Connect_Info "SERVER=MyServer;DATABASE=TestDB;USERID=sa; PASSWORD=unlock"
Depending on where you use an override string, it may be parsed differently, as in the following example:
djengine.exe -Source_Connect_Info "SERVER='MyServer';DATABASE='TestDB'; ..." MyMap.tf.xml
In this example, the Windows shell command processor is reading this command line. It parses any arguments before passing them to the Runtime Engine. Therefore, you must follow Windows command conventions. Hence, if you have to use a double-quote character inside an override string, you must "escape" the character by repeating it three times:
djengine.exe -Source_Connect_Info "SERVER=MyServer;QueryStatement="""SELECT * FROM tblTest WHERE Country = 'CA'""";DATABASE=Production" MyMap.tf.xml
The Runtime Engine parses strings differently depending on whether the string is encapsulated in single or double quote characters:
If single-quote characters are used, everything is interpreted literally.
If double-quote characters are used, backslashes act as an escape character. This allows you to use binary, hex, and decimal values to specify special characters (line feeds, carriage returns, single- and double-quote characters, and so on.). If you use a password string encrypted by Map Editor, you must use the double-quote syntax.
If using an encrypted password string, remove double-quotes around the parameter before including it as part of a source or a target override string. Leave the remainder of the password string unmodified. Encrypted passwords MUST be passed with an Opt File or an API call.
Many of the source and target parameters are unnecessary.
The Runtime Engine retains a number of extra source and target parameters from RDBMS clients and ODBC DSN. The goal was to make maps more stable when ported between machines by resending DSN/client configuration parameters rather than relying on defaults. When creating override strings, you can exclude most of these parameters.
For SQL-type sources and targets, the required parameters are:
Server
Database
User ID
Password
Table (or QueryStatement for SQL pass-through sources)
ODBC sources and targets do not require the Server parameter; use the Database parameter to specify the DSN name. Any other double-quote characters in your connection string (for example, QueryStatement) can be escaped using a backslash followed by a double-quote:
"SELECT * FROM table;"
"SELECT * FROM table;"
becomes
\"SELECT * FROM table;\"
This assumes that the Runtime Engine is parsing the string (not directly on the command line) and the string is encapsulated with double-quote characters.
The "+" (plus sign) in command line overrides limits the connection override to the information following the "+" sign.
The plus sign at the beginning of the connection information means "only override the information specified here" rather than "replace all connection information with this information." This means that you can, for example, change the database, user ID, or password without changing the table name.
When you override the target or source connection, the entire connection string is enclosed in quotes (-Target_C "<connectinfo>"). The password is enclosed in quotes. The quotes around the password must be escaped using a single backslash following each quotation mark. For example:
Database=mydb;UserId=mitch;Password="\xyz123"\; Table=MITCH.NEW1