Shell Functions Overview - Connect_ETL - 9.13

Connect ETL Shell Functions Reference

Product type
Software
Portfolio
Integrate
Product family
Connect
Product
Connect > Connect (ETL, Sort, AppMod, Big Data)
Version
9.13
Language
English
Product name
Connect ETL
Title
Connect ETL Shell Functions Reference
Copyright
2023
First publish date
2003
Last updated
2023-09-11
Published on
2023-09-11T19:06:59.560515
Function name Purpose
DMXNew creates a new Connect ETL invocation
DMXSetApplicationFileName loads the Connect ETL task from an .dxt file
DMXSelectJoinSide selects a join side to amend for a join task
DMXSetDatabaseServer overrides the database server information associated with a database connection
DMXSetDatabaseUser overrides the user name and password for a database connection
DMXSetSourceFile overrides a source file name
DMXAddSourceFile adds an additional source file
DMXSetSourceDatabaseTable overrides a source database table name
DMXSetSourceSqlText overrides the SQL text associated with a source
DMXAddKey selects a named field as an additional sort/merge field for a sort or merge task
DMXAddDatetimeFormat define a new date/time format
DMXAddPositionalKey defines a fixed-position field and uses it as an additional sort/merge field for a sort or merge task
DMXAddDelimitedKey defines a delimited field and uses it as an additional sort/merge field for a sort or merge task
DMXSetTargetFile overrides a target file
DMXSetTargetDatabaseTable overrides a target database table name
DMXSetTargetSqlText overrides the SQL text associated with a target
DMXSetEstimatedInputRecordCount overrides the estimated number of source records
DMXSetEstimatedInputDataBytes overrides the estimated amount of source data
DMXSetNumericValue overrides the contents of a named number
DMXSetTextValue overrides the contents of a named piece of text
DMXAddWorkSpaceDirectory adds a new work space directory
DMXRun runs the Connect ETL task as a command line invocation
DMXClear terminates the task, releasing all resources

You do not need all the functions to run a task; DMXNew, DMXSetApplicationFileName, DMXRun and DMXClear are the minimum necessary. You must call any functions you use in the order shown above. If you use more than one DMXSet… / DMXAdd… routine other than DMXSetApplicationFileName, you can call them in any order.

Any value returned by a function is sent to standard output. Each function sets the return code to a Connect ETL completion status.

If a Connect ETL shell function encounters a problem, messages are sent to standard error.