Using the Oracle Data Integrator Tools

Using the Oracle Data Integrator Tools


Oracle Data Integrator Tools (also called Oracle Data Integrator Commands) are commands provided for performing specific tasks at run-time. These tasks may be as simple as waiting for a certain time or producing a sound, or as sophisticated as executing ANT Scripts or reading emails from a server.

They are used in Packages, in Procedure Commands, in Knowledge Modules Commands or directly from a command line.

Note: Previous versions of Oracle Data Integrator that supported calling built-in tools from Jython or Java scripts using their internal Java classes (such as SnpsSendMail and SendMail). The usage of tools using this method is deprecated since version 10.1.3.2.0 and should be avoided.

Note: The carriage return in a command is not allowed.
Using a Tool in a Package

How to add and use an Oracle Data Integrator Tool in a Package is covered in Adding Oracle Data Integrator Tool Steps.

It is possible to sequence the tools steps within the package, and organize them according to their success and failure. For more information, refer to Defining the Sequence of Steps and Arranging the Steps Layout.

In a package, it possible to use directly in the tool parameters variable values, sequences or Oracle Data Integrator substitution method calls. Refer to Working with Procedures, Variables, Sequences, and User Functions for more information.

Using a Tool in a Knowledge Module or a Procedure Command

How to use an Oracle Data Integrator Tool in a KM or Procedure is covered in Working with Procedures.

In a knowledge module or a procedure, it possible to use directly in the tool parameters variable values, sequences, Oracle Data Integrator substitution method calls or the results from a SELECT statement. Refer to Working with Procedures, Variables, Sequences, and User Functions for more information.

Using a Tool from a Command Line

Note: The command line scripts, which are required for performing the tasks described in this section, are only available if you have installed the Oracle Data Integrator Standalone Agent. See the Oracle Fusion Middleware Installation Guide for Oracle Data Integrator for information about how to install the Standalone Agent.



To use an Oracle Data Integrator Tool from a command line:
Launch a Shell (UNIX), a Command Prompt (Windows).

Go to the oracledi/agent/bin sub-directory of the Oracle Data Integrator installation directory.

Launch the startcmd.bat (Windows) or startcmd.sh (UNIX) command, with the following syntax:
startcmd <command_name> [<command_parameters>]*


Note: On Windows platforms, it is necessary to surround the command arguments containing "=" signs or spaces, by using double quotes. The command call may differ from the UNIX command call. For example:
startcmd.bat OdiSleep "-DELAY=5000" (Windows)
./call startcmd.sh OdiSleep -DELAY=5000 (UNIX)


The <command_name> parameter is case-sensitive.