29 Warehouse Builder Code Template Tools and Substitution Methods Reference

OdiAnt

Calls the building tool Ant of the Apache Software Foundation. This tool can be used to run several commands such as archiving, compiling, deploying, documenting, EJBs. It runs OS processes, manipulates files, .NET tasks, remote tasks, and so on.

OdiBeep

Plays a default beep or sound file on the computer hosting the agent.

OdiOSCommand

Invokes an operating system command shell to carry out a command and redirects the output to files.

OdiFtpGet

Retrieves a local file from a remote FTP server computer using the FTP protocol GET command.

OdiFtpPut

Copies a local file to a remote FTP server computer using the FTP protocol PUT command.

OdiInvokeWebService (Replaces OdiExecuteWebService)

Invokes a web service using the HTTP protocol and writes the returned response to an XML file.This tool invokes a specific operation on the port of a web service whose description file (WSDL) URL is provided.If this operation requires a SOAP request, it is provided either in a request file or directly written out in the tool call (XMLRequest). The response of the web service request is written to an XML file that can be used in Oracle Data Integrator.Note: This Tool replaces OdiExecuteWebService.Note: This Tool supports both HTTP and HTTPS protocols.

OdiReadMail

Can be used to read emails as well as their attachments from a POP or IMAP internet mail service.The use of this command allows the connection to the mail hosted on the server MAILHOST using the connection parameters specified by USER and PASS. The execution agent is then in waiting mode until MAX_MSG messages are received or the maximum waiting time specified by TIMEOUT is reached. The extracted messages must match the filters such as those specified by the parameters SUBJECT and SENDER. When a message satisfies these criteria, its content as well as its Internet 53 attachment are extracted in a directory specified by the parameter FOLDER. If the parameter KEEP is set to No, the retrieved message is then suppressed from the mailbox.

OdiScpGet

Retrieves a file from a remote SSH server.

OdiScpPut

Copies a local file to a directory on the remote SSH server computer.

OdiSendMail

Can send an email through an SMTP server.

OdiSftpGet

Retrieves a file from a remote SSH server with an enabled SFTP subsystem.

OdiSftpPut

Copies a local file to a remote SSH server computer that has the SFTP subsystem enabled.

OdiFileAppend

Concatenates a set of files into a single file.

The HEADER parameter is used to suppress n number of first lines of the input files (for instance, headers of csv files). The KEEP_FIRST_HEADER parameter is used to keep or remove the first occurrence of the header lines in the resulting file.When the HEADER parameter is omitted, the concatenation is binary (no text reading of the file is performed).

OdiFileCopy

Copies files or a folder into files or a folder on the computer of the execution agent.

OdiFileDelete

Deletes, based on the file modification time, files or a directory on the computer running the agent which executes it.If -FROMDATE is omitted, all files with a modification date earlier than the -TODATE date will be deleted.If -TODATE is omitted, all files with a modification date later than the -FROMDATE date will be deleted.If both parameters are omitted, all files matching the -FILE parameter value will be deleted.

OdiFileMove

Moves files or a directory into files or a directory on the computer of the execution agent.This command can also be used to rename files or directories.

OdiFileWait

Scans the directory DIR and waits for files matching the mask given in PATTERN. When the specified files are found, the action indicated by the parameter ACTION is triggered.The execution agent is in standby mode waiting to receive FILECOUNT files unless the timeout limit, given by TIMEOUT is reached. The directory is scanned every POLLINT milliseconds.

OdiMkDir

Creates a directory.If the parent directory does not exist, this command will recursively create the parent directories.

OdiOutFile

Generates a text file on the computer where the execution agent is running.The file is stored in the path defined by <file_name> and contains the text specified by <Text>.The optional parameter -APPEND can be used to append the <Text> at the end of the file if it already contains data. The parameters -FILE and -APPEND must be specified on the same line.

OdiSqlUnload

Generates a data file by executing the SQL query <sql_query> on the data server whose connection parameters are provided by <driver>, <url>, <user> and <encoded_pass>. The file is written to the path defined by <file_name> (relative to the agent).

OdiUnZip

Used to unzip an archive file to a directory.

OdiZip

Creates ZIP files from a directory or several files.

OdiXMLConcat

Extracts all instances of a given element from a set of source XML files and concatenates them into one target XML file.This tool parses and generates well-formed XML.It does not modify or generate a DTD for the generated files. A reference to an existing DTD can be specified in the HEADER parameter or preserved from the original files using the -KEEP_XML_PROLOGUE.

Note: XML Namespaces are not supported by this tool. You must provide the local part of element name (without namespace or prefix value) in the -ELEMENT_NAME parameter.

OdiXMLSplit

Extracts all instances of a given element stored in a source XML file and splits it over several target XML files.This tool parses and generates well-formed XML.It does not modify or generate a DTD for the generated files. A reference to an existing DTD can be specified in the HEADER parameter or preserved from the original files using the -KEEP_XML_PROLOGUE.

Note: XML Namespaces are not supported by this tool. Please provide the local part of element name (without namespace or prefix value) in the -ELEMENT_NAME parameter.

OdiFileWait

Scans the directory DIR and waits for files matching the mask given in PATTERN. When the specified files are found, the action indicated by the parameter ACTION is triggered.The execution agent is in standby mode waiting to receive FILECOUNT files unless the timeout limit, given by TIMEOUT is reached. The directory is scanned every POLLINT milliseconds

OdiReadMail

Read emails as well as their attachments from a POP or IMAP internet mail service.The use of this command allows the connection to the mail hosted on the server MAILHOST using the connection parameters specified by USER and PASS. The execution agent is then in waiting mode until MAX_MSG messages are received or the maximum waiting time specified by TIMEOUT is reached. The extracted messages must match the filters such as those specified by the parameters SUBJECT and SENDER. When a message satisfies these criteria, its content as well as its attachments are extracted in a directory specified by the parameter FOLDER. If the parameter KEEP is set to No, the retrieved message is then suppressed from the mailbox.

OdiSleep

Waits for <delay> milliseconds.

OdiReverseGetMetaData

OdiReverseResetTable

OdiReverseSetMetaData

OdiDeleteScen

OdiExportAllScen

OdiExportEnvironmentInformation

OdiExportLog

OdiExportMaster

OdiExportObject

OdiExportScen

OdiExportWork

OdiGenerateAllScen

OdiImportObject

OdiImportScen

OdiDataQuality

OdiKillAgent

OdiPingAgent

OdiPurgeLog

OdiReinitializeSeq

OdiStartScen

OdiUpdateAgentSchedule

OdiSAPALEClient

OdiSAPALEServer

OdiWaitForChildSession

OdiWaitForData

OdiWaitForLogData

OdiWaitForTable

OdiRefreshJournalCount

OdiRetrieveJournalData

OdiWaitForData

OdiWaitForLogData

OdiWaitForTable