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). |
-DatasetConfigs | -DC | Filename | Specify the dataset configuration files that must be used. |
-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. |
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. |
-New_Conversion | -nc | None | Start a new transformation specification. |
-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. |
-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. |
-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 is the name of the variable set up in Map Editor • value is the numeric value that must be assigned to the NAME for this run. 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. |
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. |
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). |
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. |
-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 | Adds a source filter expression in the file. The value must include the path of the file containing the source filter expression. If the path is not included, Runtime Engine assumes that the file is in the current directory. Note: The specified filename must be an ASCII text file and contain only one expression. The syntax of the source filter expression in the file is the same as the syntax for source filter expressions in EZscript. One source filter is added for each -Source_Filter_Expr option and file name value. |
-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 | Adds a target filter expression in the file. The value must include the path of the file containing the target filter expression. If the path is not included, Runtime Engine assumes that the file is in the current directory. Note: The specified filename must be an ASCII text file and contain only one expression. 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. |
-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. |
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. |
Overrides is applicable only when you run Data Integrator 9 artifacts. |