DMXAddKey function - Connect_ETL - Latest

Connect ETL Shell Functions Reference

Product type
Software
Portfolio
Integrate
Product family
Connect
Product
Connect > Connect (ETL, Sort, AppMod, Big Data)
Version
Latest
ft:locale
en-US
Product name
Connect ETL
ft:title
Connect ETL Shell Functions Reference
Copyright
2025
First publish date
2003
ft:lastEdition
2025-05-21
ft:lastPublication
2025-05-21T18:32:36.824000

Short Description: To select a named field as an additional sort/merge field for a sort or a merge task.

Syntax

DMXAddKey ID fieldname [direction [sequence] ]

Parameters

ID The ID returned by DMXNew that identifies the invocation.
fieldname The name of the field to be added as an additional sort/merge field. The field must be defined in the data dictionary of the task identified by ID
direction The direction in which to order the sort/merge field. The argument is optional and defaults to $DMX_ORDER_ASCENDING. For a description, see Sort/Merge field direction code passed to Connect ETL subroutines
sequence The name of the collating sequence to use when ordering the sort/merge field. The sequence can be any of the standard sequences or a special sequence defined in the data dictionary of the loaded task. The argument is optional. If not specified, the default collating sequence will be used. The sequence name must be empty for a field with type other than character. Connect ETL terminates with an error otherwise.

Notes

You can invoke this function at any time after loading the task via DMXSetApplicationFileName and before running the task via DMXRun.

Connect ETL will terminate with an error if the loaded task is a join or copy.