Methods - Connect_ETL - 9.13

Connect ETL ActiveX 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 ActiveX Reference
Copyright
2023
First publish date
2003
ft:lastEdition
2023-09-11
ft:lastPublication
2023-09-11T18:59:22.799064

AddJoinSourceFile

AddKey

AddSourceFile

AddWorkSpaceDirectory

Clear

GetBinaryRecord

GetTextRecord

PutBinaryRecord

PutRecordEnd

PutTextRecord

Run

SetDatabaseServer

SetDatabaseUser

SetJoinSourceDatabaseTable

SetJoinSourceFile

SetJoinSourceSqlText

SetNumericValue

SetSourceDatabaseTable

SetSourceFile

SetSourceSqlText

SetTargetDatabaseTable

SetTargetFile

SetTargetSqlText

SetTextValue

AddJoinSourceFile method

Adds another source file to the DMExpress join task.

Syntax

AddJoinSourceFile (side, string)

Parameters

Name Requirement Access Description
side Mandatory Read An integer expression. This is the side of the join to which you want to add the source file. The left side is assigned number 1 and the right side is assigned number 2.
string Mandatory Read A string expression providing the name of the source file. Expansion or escaping of wildcards in the name is inherited from the specification of the first source file in the Source File dialog.

Returns

An integer (1-based) with the number of the source file added to the DMExpress task.

Notes

You can invoke this method at any time before running the task via Run.

The new source file inherits all the properties of the first source file in the same join side, other than its name.

AddKey method

Adds another sort/merge field to a sort or merge task.

Syntax

AddKey (field)

Parameters

Name Requirement Access Description
field Mandatory Read

You may pass one of the following:

A string expression providing the name of the field that you want to be the additional sort/merge field. Default values are assumed for other sort/merge field properties (ascending order and, if applicable, the default collating sequence).

An IDMExpressFixedPositionField interface or an IDMExpressDelimitedField interface providing access to the definition of the field that you want to be the additional sort/merge field. Similarly, default values are assumed for other sort/merge field properties.

An IDMExpressKey interface providing access to the complete definition of the additional sort/merge field.

Notes

You can invoke this method at any time before running the task via Run. Invoking this method for a task other than a sort or a merge results in an error.

If you pass an interface as the field parameter, DMExpress accesses the interface immediately to obtain the sort/merge field definitions. A later modification to those definitions does not affect the new sort/merge field.

AddSourceFile method

Adds another source file to the DMExpress task.

Syntax

AddSourceFile (string)

Parameters

Name Requirement Access Description
string Mandatory Read A string expression providing the name of the source file. Expansion or escaping of wildcards in the name is inherited from the specification of the first source file in the Source File dialog.

Returns

An integer (1-based) with the number of the source file added to the DMExpress task.

Notes

You can invoke this method at any time before running the task via Run.

The new source file inherits all the properties of the first source file, other than its name.

Use this method only for an aggregate, copy, merge or sort. Use the method AddJoinSourceFile in a join task.

AddWorkSpaceDirectory method

Adds a new work space directory to the DMExpress task.

Syntax

AddWorkSpaceDirectory (string)

Parameters

Name Requirement Access Description
string Mandatory Read A string expression providing the name of the work space directory.

Notes

You can invoke this method at any time before running the task via Run. This method has no effect on DMExpress copy and merge tasks, since no work space is required.

Clear method

Clears all resources associated with the DMExpress task, other than the task name and log file name properties.

Syntax

Clear

GetBinaryRecord method

Retrieves a single record in binary form from DMExpress.

Syntax

GetBinaryRecord (array, length)

Parameters

Name Requirement Access Description
array Mandatory Read/write A byte array to receive a record.
length Mandatory Write A long integer. The length is the number of bytes of the array occupied by the record.

Returns

A boolean indicating if a record is returned. The values returned are as follows:
True DMExpress returned a record
False No records remain

Notes

You can invoke this method at any time before running the task via Run. If you are providing the records through PutTextRecord or PutBinaryRecord, invoke this method after supplying all records, i.e. after invoking PutRecordEnd.

The array should be long enough to hold any record issuing from DMExpress. If not, the record gets truncated.

GetTextRecord method

Retrieves a single record in text form from DMExpress.

Syntax

GetTextRecord (string)

Parameters

Name Requirement Access Description
string Mandatory Write A string holding a record.

Returns

A boolean indicating if a record is returned. The values returned are as follows:

True DMExpress returned a record
False No records remain

Notes

You can invoke this method at any time before running the task via Run. IIf you are providing the records through PutTextRecord or PutBinaryRecord, invoke this method after supplying all records, i.e. after invoking PutRecordEnd.

PutBinaryRecord method

Supplies a single source record in binary form to DMExpress.

Syntax

PutBinaryRecord (array[, length])

Parameters

Name Requirement Access Description
array Mandatory Read A byte array expression providing a source record.
length Optional Read A long integer expression. The length is the number of bytes of the array occupied by the record. A length of 0 indicates that the record occupies the complete array. The default value is 0.

Notes

You can invoke this method at any time before running the task via Run.

PutRecordEnd method

Notifies DMExpress that all source records have been supplied.

Syntax

PutRecordEnd

Notes

Invoke this method after supplying all source records via PutTextRecord or PutBinaryRecord.

PutTextRecord method

Supplies a single source record in text form to DMExpress.

Syntax

PutTextRecord (string)

Parameters

Name Requirement Access Description
string Mandatory Read A string expression providing a source record.

Notes

You can invoke this method at any time before running the task via Run.

Run method

Runs the DMExpress task.

Syntax

Run

SetDatabaseServer method

Changes the database server information associated with a database connection currently in the DMExpress application.

Syntax

SetDatabaseServer (string, Dbms, string)

Parameters

Name Requirement Access Description
string Mandatory Read A string expression providing the name of the database connection whose server information you want to change.
Dbms Mandatory Read A DBMS code that specifies which DBMS should be used for the connection.
string Mandatory Read A string expression providing the name of the database accessed via the connection.

Returns

A boolean indicating if the connection can be established. The values returned are as follows:

True The connection can be established.
False The connection can not be established.

Notes

You can invoke this method at any time before running the task via Run.

SetDatabaseUser method

Changes the database user name and password currently associated with a database connection currently in the DMExpress application.

Syntax

SetDatabaseUser (string, string, string)

Parameters

Name Requirement Access Description
string Mandatory Read A string expression providing the name of the database connection whose user login information you want to change.
string Mandatory Read A string expression providing the login user name under which the connection should be established.
string Mandatory Read A string expression providing the password to use when connecting under the user name appearing in User.

Returns

A boolean indicating if the connection can be established. The values returned are as follows:

True The connection can be established.
False The connection can not be established.

Notes

You can invoke this method at any time before running the task via Run.

SetJoinSourceDatabaseTable method

Changes the name of a source database table currently in the DMExpress join application.

Syntax

SetJoinSourceDatabaseTable (side, string[, index])

Parameters

Name Requirement Access Description
side Mandatory Read An integer expression. This is the side of the join you want to modify. The left side is assigned number 1 and the right side is assigned number 2.
string Mandatory Read A string expression providing the name of the source table.
index Optional Read An integer expression. The index is the number of the table in the join side you want to modify. The sources are numbered from 1 for each join side in the order they appear in the application. The default value is 1.

Returns

A boolean indicating if the source database table was set. The values returned are as follows:

True The join source database table was set.
False The join source database table could not be set.

Notes

You can invoke this method at any time before running the task via Run.

SetJoinSourceFile method

Changes the name of a source file currently in the DMExpress join task.

Syntax

SetJoinSourceFile (side, string[, index])

Parameters

Name Requirement Access Description
side Mandatory Read An integer expression. This is the side of the join you want to modify. The left side is assigned number 1 and the right side is assigned number 2.
string Mandatory Read A string expression providing the name of the source file. Expansion or escaping of wildcards in the name is inherited from the specification in the Source File dialog.
index Optional Read An integer expression. The index is the number of the file in the join side you want to modify. The source files are numbered from 1 for each join side in the order they appear in the task. The default value is 1.

Notes

You can invoke this method at any time before running the task via Run.

SetJoinSourceSqlText method

Changes the SQL text associated with a source currently in the DMExpress join application.

Syntax

SetJoinSourceSqlText (side, string [, index])

Parameters

Name Requirement Access Description
side Mandatory Read An integer expression. This is the side of the join you want to modify. The left side is assigned number 1 and the right side is assigned number 2.
string Mandatory Read A string expression providing the new SQL text for the source.
index Optional Read An integer expression. The index is the number of the source SQL text in the join side you want to modify. The sources are numbered from 1 for each join side in the order they appear in the application. The default value is 1.

Returns

A boolean indicating if the source SQL text was set. The values returned are as follows:

True The source SQL text was set.
False The source SQL text could not be set.

Notes

You can invoke this method at any time before running the task via Run.

SetNumericValue method

Changes the contents of a named number currently in the DMExpress task.

Syntax

SetNumericValue (string, value)

Parameters

Name Requirement Access Description
string Mandatory Read A string expression providing the name of the number in the DMExpress task.
value Mandatory Read A double float expression. This is the new value for the number in the DMExpress task.

Notes

You can invoke this method at any time before running the task via Run.

SetSourceDatabaseTable method

Changes the name of the source database table currently in the DMExpress application.

Syntax

SetSourceDatabaseTable (string [, index])

Parameters

Name Requirement Access Description
string Mandatory Read A string expression providing the name of the source table.
index Optional Read An integer expression. The index is the number of the database table in the DMExpress application. The sources are numbered from 1 in the order in which they appear in the application. The default value is 1

Notes

You can invoke this method at any time before running the task via Run.

Use this method only for an aggregate, copy, merge or sort. Use the method SetJoinSourceDatabaseTable in a join application.

SetSourceFile method

Changes the name of a source file currently in the DMExpress task.

Syntax

SetSourceFile (string[, index])

Parameters

Name Requirement Access Description
string Mandatory Read A string expression providing the name of the source file. Expansion or escaping of wildcards in the name is inherited from the specification in the Source File dialog.
index Optional Read An integer expression. The index is the number of the file in the DMExpress task. The source files are numbered from 1 in the order in which they appear in the task. The default value is 1.

Notes

You can invoke this method at any time before running the task via Run.

Use this method only for an aggregate, copy, merge or sort. Use the method SetJoinSourceFile in a join task.

SetSourceSqlText method

Changes the SQL text associated with a source currently in the DMExpress application.

Syntax

SetSourceSqlText (string[, index])

Parameters

Name Requirement Access Description
string Mandatory Read The string expression providing the source SQL text.
index Optional Read An integer expression. The index is the number of the source SQL text in the DMExpress application. Sources are numbered from 1 in the order in which they appear in the application. The default value is 1.

Returns

A boolean indicating if the source SQL text was set. The values returned are as follows:

True The source SQL text was set.
False The source SQL text could not be set.

Notes

You can invoke this method at any time before running the task via Run.

You can use this method to replace only a source already specified by SQL text. It is not possible to replace a source defined as a database table by SQL text.

SetTargetDatabaseTable method

Changes the name of the target database table currently in the DMExpress application.

Syntax

SetTargetDatabaseTable (string[, index])

Parameters

Name Requirement Access Description
string Mandatory Read A string expression providing the name of the target table.
index Optional Read An integer expression. The index is the number of the database table in the DMExpress application. The targets are numbered from 1 in the order in which they appear in the application. The default value is 1.

Returns

A boolean indicating if the target table name was set. The values returned are as follows:

True The target table name was set.
False The target table name could not be set.

Notes

You can invoke this method at any time before running the task via Run.

SetTargetFile method

Changes the name of a target file in the DMExpress task.

Syntax

SetTargetFile (string [, index])

Parameters

Name Requirement Access Description
string Mandatory Read A string expression providing the new name of the target file.
index Optional Read An integer expression. The index is the number of the file in the DMExpress task. The target files are numbered from 1 in the order in which they appear in the task. The default value is 1.

Notes

You can invoke this method at any time before running the task via Run.

SetTargetSqlText method

Changes the SQL text associated with a target currently in the DMExpress application.

Syntax

SetTargetSqlText (string [, index])

Parameters

Name Requirement Access Description
string Mandatory Read The string expression providing the target SQL text.
index Optional Read An integer expression. The index is the number of the target SQL text in the DMExpress application. Targets are numbered from 1 in the order in which they appear in the application. The default value is 1.

Returns

A boolean indicating if the target SQL text was set. The values returned are as follows:

True The target SQL text was set.
False The target SQL text could not be set.

Notes

You can invoke this method at any time before running the task via Run.

SetTextValue method

Changes the contents of a named text value currently in the DMExpress task.

Syntax

SetTextValue (string, value)

Parameters

Name Requirement Access Description
string Mandatory Read A string expression providing the name of the text value in the DMExpress task.
value Mandatory Read A string expression This is the new value for the text in the DMExpress task.

Notes

You can invoke this method at any time before running the task via Run.