org.safs.model.components

Class Database

java.lang.Object

org.safs.model.Component

org.safs.model.components.UIComponent

org.safs.model.components.GenericMaster

org.safs.model.components.GenericObject

org.safs.model.components.Database

public class Database
extends GenericObject

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Database(java.lang.String compname)
	Database(java.lang.String winname, java.lang.String compname) Constructor Create an instance of pseudo-component representing a specific component in a specific window.
	Database(Window window, java.lang.String compname) Constructor Create an instance of pseudo-component representing a specific component in a specific window.

Method Summary

Modifier and Type	Method and Description
void	copyDBTableColumnToFile(StepTestTable table, java.lang.String[] parameters) This routine will copy the contents of one or more DBTable column(s) to a file.
void	copyDBTableColumnToFile(StepTestTable table, java.lang.String dBSourceName, java.lang.String fileOut, java.lang.String sQLQuery, java.lang.String directoryOut, java.lang.String sQLStatus, java.lang.String delimiter, java.lang.String userID, java.lang.String password, java.lang.String prompt) This routine will copy the contents of one or more DBTable column(s) to a file.
ComponentFunction	copyDBTableColumnToFile(java.lang.String[] parameters) This routine will copy the contents of one or more DBTable column(s) to a file.
ComponentFunction	copyDBTableColumnToFile(java.lang.String dBSourceName, java.lang.String fileOut, java.lang.String sQLQuery, java.lang.String directoryOut, java.lang.String sQLStatus, java.lang.String delimiter, java.lang.String userID, java.lang.String password, java.lang.String prompt) This routine will copy the contents of one or more DBTable column(s) to a file.
void	copyDBTableToFile(StepTestTable table, java.lang.String[] parameters) This routine will copy the contents of a DBTable to a file.
void	copyDBTableToFile(StepTestTable table, java.lang.String dBSourceName, java.lang.String fileOut, java.lang.String dBTableName, java.lang.String columnCount, java.lang.String rowCount, java.lang.String sQLQuery, java.lang.String delimiter, java.lang.String directoryOut, java.lang.String sQLStatus, java.lang.String userID, java.lang.String password, java.lang.String prompt) This routine will copy the contents of a DBTable to a file.
ComponentFunction	copyDBTableToFile(java.lang.String[] parameters) This routine will copy the contents of a DBTable to a file.
ComponentFunction	copyDBTableToFile(java.lang.String dBSourceName, java.lang.String fileOut, java.lang.String dBTableName, java.lang.String columnCount, java.lang.String rowCount, java.lang.String sQLQuery, java.lang.String delimiter, java.lang.String directoryOut, java.lang.String sQLStatus, java.lang.String userID, java.lang.String password, java.lang.String prompt) This routine will copy the contents of a DBTable to a file.
void	deleteDBTableRecords(StepTestTable table, java.lang.String[] parameters) Deletes records in a database table Deletes records in a database table.
void	deleteDBTableRecords(StepTestTable table, java.lang.String dBTableName, java.lang.String dBQueryCond, java.lang.String dBSourceName, java.lang.String userID, java.lang.String password, java.lang.String prompt) Deletes records in a database table Deletes records in a database table.
ComponentFunction	deleteDBTableRecords(java.lang.String[] parameters) Deletes records in a database table Deletes records in a database table.
ComponentFunction	deleteDBTableRecords(java.lang.String dBTableName, java.lang.String dBQueryCond, java.lang.String dBSourceName, java.lang.String userID, java.lang.String password, java.lang.String prompt) Deletes records in a database table Deletes records in a database table.
void	execSQLCommit(StepTestTable table, java.lang.String[] parameters) This routine will commit the pending queries on the database.
void	execSQLCommit(StepTestTable table, java.lang.String dBSourceName, java.lang.String sQLStatus, java.lang.String userID, java.lang.String password) This routine will commit the pending queries on the database.
ComponentFunction	execSQLCommit(java.lang.String[] parameters) This routine will commit the pending queries on the database.
ComponentFunction	execSQLCommit(java.lang.String dBSourceName, java.lang.String sQLStatus, java.lang.String userID, java.lang.String password) This routine will commit the pending queries on the database.
void	execSQLQuery(StepTestTable table, java.lang.String[] parameters) Executes the query provided in a ^queryStr on the database table.
void	execSQLQuery(StepTestTable table, java.lang.String dBSourceName, java.lang.String queryStr, java.lang.String sQLStatusCode, java.lang.String userID, java.lang.String password, java.lang.String prompt) Executes the query provided in a ^queryStr on the database table.
ComponentFunction	execSQLQuery(java.lang.String[] parameters) Executes the query provided in a ^queryStr on the database table.
ComponentFunction	execSQLQuery(java.lang.String dBSourceName, java.lang.String queryStr, java.lang.String sQLStatusCode, java.lang.String userID, java.lang.String password, java.lang.String prompt) Executes the query provided in a ^queryStr on the database table.
void	getDBTableColumnCount(StepTestTable table, java.lang.String[] parameters) Executes the query in a specified database table and returns the total column count.
void	getDBTableColumnCount(StepTestTable table, java.lang.String dBSourceName, java.lang.String dBTableName, java.lang.String columnCount, java.lang.String sQLStatusCode, java.lang.String userID, java.lang.String password, java.lang.String prompt) Executes the query in a specified database table and returns the total column count.
ComponentFunction	getDBTableColumnCount(java.lang.String[] parameters) Executes the query in a specified database table and returns the total column count.
ComponentFunction	getDBTableColumnCount(java.lang.String dBSourceName, java.lang.String dBTableName, java.lang.String columnCount, java.lang.String sQLStatusCode, java.lang.String userID, java.lang.String password, java.lang.String prompt) Executes the query in a specified database table and returns the total column count.
void	getDBTableRowCount(StepTestTable table, java.lang.String[] parameters) Executes the query in a database table.
void	getDBTableRowCount(StepTestTable table, java.lang.String dBSourceName, java.lang.String dBTableName, java.lang.String rowCount, java.lang.String sQLStatusCode, java.lang.String userID, java.lang.String password, java.lang.String prompt) Executes the query in a database table.
ComponentFunction	getDBTableRowCount(java.lang.String[] parameters) Executes the query in a database table.
ComponentFunction	getDBTableRowCount(java.lang.String dBSourceName, java.lang.String dBTableName, java.lang.String rowCount, java.lang.String sQLStatusCode, java.lang.String userID, java.lang.String password, java.lang.String prompt) Executes the query in a database table.
void	getDBValue(StepTestTable table, java.lang.String[] parameters) Executes the query and returns the case-sensitive value as result of the execution.
void	getDBValue(StepTestTable table, java.lang.String dBSourceName, java.lang.String queryStr, java.lang.String queryResult, java.lang.String sQLStatusCode, java.lang.String userID, java.lang.String password, java.lang.String prompt) Executes the query and returns the case-sensitive value as result of the execution.
ComponentFunction	getDBValue(java.lang.String[] parameters) Executes the query and returns the case-sensitive value as result of the execution.
ComponentFunction	getDBValue(java.lang.String dBSourceName, java.lang.String queryStr, java.lang.String queryResult, java.lang.String sQLStatusCode, java.lang.String userID, java.lang.String password, java.lang.String prompt) Executes the query and returns the case-sensitive value as result of the execution.
void	verifyDatabaseNullValue(StepTestTable table, java.lang.String[] parameters) Verifies the value of a field in a database table is NULL Verifies the value of a field in a database table is NULL.
void	verifyDatabaseNullValue(StepTestTable table, java.lang.String dBFieldName, java.lang.String dBTableName, java.lang.String dBQueryCond, java.lang.String dBSourceName, java.lang.String userID, java.lang.String password, java.lang.String prompt) Verifies the value of a field in a database table is NULL Verifies the value of a field in a database table is NULL.
ComponentFunction	verifyDatabaseNullValue(java.lang.String[] parameters) Verifies the value of a field in a database table is NULL Verifies the value of a field in a database table is NULL.
ComponentFunction	verifyDatabaseNullValue(java.lang.String dBFieldName, java.lang.String dBTableName, java.lang.String dBQueryCond, java.lang.String dBSourceName, java.lang.String userID, java.lang.String password, java.lang.String prompt) Verifies the value of a field in a database table is NULL Verifies the value of a field in a database table is NULL.
void	verifyDatabaseValue(StepTestTable table, java.lang.String[] parameters) Verifies the case-sensitive value of a field in a database table Verifies the case-sensitive value of a field in a database table.
void	verifyDatabaseValue(StepTestTable table, java.lang.String dBFieldName, java.lang.String dBTableName, java.lang.String dBQueryCond, java.lang.String dBSourceName, java.lang.String userID, java.lang.String password, java.lang.String expectedValue, java.lang.String prompt) Verifies the case-sensitive value of a field in a database table Verifies the case-sensitive value of a field in a database table.
ComponentFunction	verifyDatabaseValue(java.lang.String[] parameters) Verifies the case-sensitive value of a field in a database table Verifies the case-sensitive value of a field in a database table.
ComponentFunction	verifyDatabaseValue(java.lang.String dBFieldName, java.lang.String dBTableName, java.lang.String dBQueryCond, java.lang.String dBSourceName, java.lang.String userID, java.lang.String password, java.lang.String expectedValue, java.lang.String prompt) Verifies the case-sensitive value of a field in a database table Verifies the case-sensitive value of a field in a database table.
void	verifyDBNullValue(StepTestTable table, java.lang.String[] parameters) Verifies the value of a field in a database table is NULL Verifies the value of a field in a database table is NULL.
void	verifyDBNullValue(StepTestTable table, java.lang.String dBFieldName, java.lang.String dBTableName, java.lang.String dBQueryCond, java.lang.String dBSourceName, java.lang.String userID, java.lang.String password, java.lang.String prompt) Verifies the value of a field in a database table is NULL Verifies the value of a field in a database table is NULL.
ComponentFunction	verifyDBNullValue(java.lang.String[] parameters) Verifies the value of a field in a database table is NULL Verifies the value of a field in a database table is NULL.
ComponentFunction	verifyDBNullValue(java.lang.String dBFieldName, java.lang.String dBTableName, java.lang.String dBQueryCond, java.lang.String dBSourceName, java.lang.String userID, java.lang.String password, java.lang.String prompt) Verifies the value of a field in a database table is NULL Verifies the value of a field in a database table is NULL.
void	verifyDBValue(StepTestTable table, java.lang.String[] parameters) Verifies the case-sensitive value of a field in a database table Verifies the case-sensitive value of a field in a database table.
void	verifyDBValue(StepTestTable table, java.lang.String dBFieldName, java.lang.String dBTableName, java.lang.String dBQueryCond, java.lang.String dBSourceName, java.lang.String userID, java.lang.String password, java.lang.String prompt, java.lang.String expectedValue) Verifies the case-sensitive value of a field in a database table Verifies the case-sensitive value of a field in a database table.
ComponentFunction	verifyDBValue(java.lang.String[] parameters) Verifies the case-sensitive value of a field in a database table Verifies the case-sensitive value of a field in a database table.
ComponentFunction	verifyDBValue(java.lang.String dBFieldName, java.lang.String dBTableName, java.lang.String dBQueryCond, java.lang.String dBSourceName, java.lang.String userID, java.lang.String password, java.lang.String prompt, java.lang.String expectedValue) Verifies the case-sensitive value of a field in a database table Verifies the case-sensitive value of a field in a database table.

Methods inherited from class org.safs.model.components.GenericObject

altLeftDrag, altLeftDrag, click, click, click, click, clickScreenImage, clickScreenImage, clickScreenLocation, clickScreenLocation, clickScreenPoint, clickScreenPoint, compareStoredData, compareStoredData, compareStoredData, compareStoredData, compareStoredProperties, compareStoredProperties, compareStoredProperties, compareStoredProperties, ctrlAltLeftDrag, ctrlAltLeftDrag, ctrlClick, ctrlClick, ctrlClick, ctrlClick, ctrlClickScreenImage, ctrlClickScreenImage, ctrlLeftDrag, ctrlLeftDrag, ctrlRightClick, ctrlRightClick, ctrlRightClick, ctrlRightClick, ctrlRightClickScreenImage, ctrlRightClickScreenImage, ctrlShiftLeftDrag, ctrlShiftLeftDrag, doubleClick, doubleClick, doubleClick, doubleClick, doubleClickScreenImage, doubleClickScreenImage, doubleClickScreenLocation, doubleClickScreenLocation, doubleClickScreenPoint, doubleClickScreenPoint, doubleTap, doubleTap, dragTo, dragTo, dragTo, dragTo, flick, flick, flick, flick, flickDown, flickDown, flickLeft, flickLeft, flickRight, flickRight, flickUp, flickUp, hScrollTo, hScrollTo, javaMenuSelect, javaMenuSelect, leftDrag, leftDrag, mouseClick, mouseClick, multiClick, multiClick, multiClick, multiClick, multiClickScreenImage, multiClickScreenImage, multiClickScreenImage, multiClickScreenImage, press, press, rightClick, rightClick, rightClick, rightClick, rightClickScreenImage, rightClickScreenImage, rightClickScreenLocation, rightClickScreenLocation, rightClickScreenPoint, rightClickScreenPoint, rightDrag, rightDrag, shiftClick, shiftClick, shiftClick, shiftClick, shiftClickScreenImage, shiftClickScreenImage, shiftLeftDrag, shiftLeftDrag, tap, tap, twoFingerTap, twoFingerTap, verifyImage, verifyImage, vScrollTo, vScrollTo

Methods inherited from class org.safs.model.components.GenericMaster

assignPropertyVariable, assignPropertyVariable, assignPropertyVariable, assignPropertyVariable, captureObjectDataToFile, captureObjectDataToFile, captureObjectDataToFile, captureObjectDataToFile, capturePropertiesToFile, capturePropertiesToFile, capturePropertiesToFile, capturePropertiesToFile, capturePropertyToFile, capturePropertyToFile, capturePropertyToFile, capturePropertyToFile, clearAppMapCache, clearAppMapCache, clearCache, clearCache, executeScript, executeScript, executeScript, executeScript, getComputedStyle, getComputedStyle, getGUIImage, getGUIImage, getGUIImage, getGUIImage, getTextFromGUI, getTextFromGUI, getTextFromGUI, getTextFromGUI, gUIDoesExist, gUIDoesExist, gUIDoesNotExist, gUIDoesNotExist, hoverMouse, hoverMouse, hoverMouse, hoverMouse, hoverScreenLocation, hoverScreenLocation, hoverScreenLocation, hoverScreenLocation, inputCharacters, inputCharacters, inputKeys, inputKeys, isPropertyExist, isPropertyExist, isPropertyExist, isPropertyExist, locateScreenImage, locateScreenImage, locateScreenImage, locateScreenImage, saveTextFromGUI, saveTextFromGUI, saveTextFromGUI, saveTextFromGUI, sendEvent, sendEvent, sendEvent, sendEvent, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, showOnPage, showOnPage, typeChars, typeChars, typeEncryption, typeEncryption, typeEncryption, typeEncryption, typeKeys, typeKeys, verifyArrayPropertyToFile, verifyArrayPropertyToFile, verifyArrayPropertyToFile, verifyArrayPropertyToFile, verifyBinaryFileToFile, verifyBinaryFileToFile, verifyBinaryFileToFile, verifyBinaryFileToFile, verifyClipboardToFile, verifyClipboardToFile, verifyClipboardToFile, verifyClipboardToFile, verifyClipboardVP, verifyClipboardVP, verifyComputedStyle, verifyComputedStyle, verifyFileToFile, verifyFileToFile, verifyFileToFile, verifyFileToFile, verifyGUIImageToFile, verifyGUIImageToFile, verifyGUIImageToFile, verifyGUIImageToFile, verifyObjectDataToFile, verifyObjectDataToFile, verifyObjectDataToFile, verifyObjectDataToFile, verifyPropertiesSubsetToFile, verifyPropertiesSubsetToFile, verifyPropertiesSubsetToFile, verifyPropertiesSubsetToFile, verifyPropertiesToFile, verifyPropertiesToFile, verifyPropertiesToFile, verifyPropertiesToFile, verifyProperty, verifyProperty, verifyProperty, verifyProperty, verifyPropertyContains, verifyPropertyContains, verifyPropertyContains, verifyPropertyContains, verifyPropertyToFile, verifyPropertyToFile, verifyPropertyToFile, verifyPropertyToFile, verifyTabOrder, verifyTabOrder, verifyTextFileToFile, verifyTextFileToFile, verifyTextFileToFile, verifyTextFileToFile, verifyValueContains, verifyValueContains, verifyValueContains, verifyValueContains, verifyValueContainsIgnoreCase, verifyValueContainsIgnoreCase, verifyValueContainsIgnoreCase, verifyValueContainsIgnoreCase, verifyValueDoesNotContain, verifyValueDoesNotContain, verifyValueDoesNotContain, verifyValueDoesNotContain, verifyValues, verifyValues, verifyValues, verifyValues, verifyValuesIgnoreCase, verifyValuesIgnoreCase, verifyValuesIgnoreCase, verifyValuesIgnoreCase, verifyValuesNotEqual, verifyValuesNotEqual, verifyValuesNotEqual, verifyValuesNotEqual

Methods inherited from class org.safs.model.components.UIComponent

getWindow, setWindow

Methods inherited from class org.safs.model.Component

getName, getParent, getParentName, quote

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Database

public Database(Window window,
                java.lang.String compname)

Constructor Create an instance of pseudo-component representing a specific component in a specific window.

Parameters:

window - Optional:NO Specifies which Window this component is 'in'.

compname - Optional:NO Specifies the AppMap name of the component in the Window.

Database

public Database(java.lang.String winname,
                java.lang.String compname)

Constructor Create an instance of pseudo-component representing a specific component in a specific window. This convenience routine will create the requisite Window component.

Parameters:

winname - Optional:NO Specifies the AppMap name of the window.

compname - Optional:NO Specifies the AppMap name of the component in the Window.

Database

protected Database(java.lang.String compname)

Method Detail

copyDBTableColumnToFile

public ComponentFunction copyDBTableColumnToFile(java.lang.String dBSourceName,
                                                 java.lang.String fileOut,
                                                 java.lang.String sQLQuery,
                                                 java.lang.String directoryOut,
                                                 java.lang.String sQLStatus,
                                                 java.lang.String delimiter,
                                                 java.lang.String userID,
                                                 java.lang.String password,
                                                 java.lang.String prompt)

 
              This routine will copy the contents of one or more DBTable column(s) to a file.
              
                 This routine will export the contents of one or more DBTable column(s) to
                 a delimeted file. If columnDelimiter is omitted, a horizontal tab is used
                 to delimit fields.
                 
                 A data source name [DSN] and Query String is required. You also have to specify
                 a variable to get the status code.  And optionally user id and password (this is
                 because some drivers don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include them in the
                 connection string. This would allow the possibility to specify them in the 
                 data source definition.
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

fileOut - Optional:NO Name of the output file.

sQLQuery - Optional:NO The file will contain the results of the executed Query. The query is NOT validated by this function.

directoryOut - Optional:YES OPTIONAL parameter. If not specified the file will be stored under the project "Datapool\Test\" directory.

sQLStatus - Optional:NO A variable which holds the current SQL run status.

delimiter - Optional:YES Optional Delimiter to be used between columns written to file.

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

prompt - Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

copyDBTableColumnToFile

public void copyDBTableColumnToFile(StepTestTable table,
                                    java.lang.String dBSourceName,
                                    java.lang.String fileOut,
                                    java.lang.String sQLQuery,
                                    java.lang.String directoryOut,
                                    java.lang.String sQLStatus,
                                    java.lang.String delimiter,
                                    java.lang.String userID,
                                    java.lang.String password,
                                    java.lang.String prompt)

 
              This routine will copy the contents of one or more DBTable column(s) to a file.
              
                 This routine will export the contents of one or more DBTable column(s) to
                 a delimeted file. If columnDelimiter is omitted, a horizontal tab is used
                 to delimit fields.
                 
                 A data source name [DSN] and Query String is required. You also have to specify
                 a variable to get the status code.  And optionally user id and password (this is
                 because some drivers don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include them in the
                 connection string. This would allow the possibility to specify them in the 
                 data source definition.
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

table - Optional:NO The table to add the record to.

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

fileOut - Optional:NO Name of the output file.

sQLQuery - Optional:NO The file will contain the results of the executed Query. The query is NOT validated by this function.

directoryOut - Optional:YES OPTIONAL parameter. If not specified the file will be stored under the project "Datapool\Test\" directory.

sQLStatus - Optional:NO A variable which holds the current SQL run status.

delimiter - Optional:YES Optional Delimiter to be used between columns written to file.

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

prompt - Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

copyDBTableColumnToFile

public ComponentFunction copyDBTableColumnToFile(java.lang.String[] parameters)

 
              This routine will copy the contents of one or more DBTable column(s) to a file.
              
                 This routine will export the contents of one or more DBTable column(s) to
                 a delimeted file. If columnDelimiter is omitted, a horizontal tab is used
                 to delimit fields.
                 
                 A data source name [DSN] and Query String is required. You also have to specify
                 a variable to get the status code.  And optionally user id and password (this is
                 because some drivers don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include them in the
                 connection string. This would allow the possibility to specify them in the 
                 data source definition.
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

parameters - Optional:NO An array containing the following parameters:

dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
fileOut -- Optional:NO Name of the output file.
sQLQuery -- Optional:NO The file will contain the results of the executed Query. The query is NOT validated by this function.
directoryOut -- Optional:YES OPTIONAL parameter. If not specified the file will be stored under the project "Datapool\Test\" directory.
sQLStatus -- Optional:NO A variable which holds the current SQL run status.
delimiter -- Optional:YES Optional Delimiter to be used between columns written to file.
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).
prompt -- Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

copyDBTableColumnToFile

public void copyDBTableColumnToFile(StepTestTable table,
                                    java.lang.String[] parameters)

 
              This routine will copy the contents of one or more DBTable column(s) to a file.
              
                 This routine will export the contents of one or more DBTable column(s) to
                 a delimeted file. If columnDelimiter is omitted, a horizontal tab is used
                 to delimit fields.
                 
                 A data source name [DSN] and Query String is required. You also have to specify
                 a variable to get the status code.  And optionally user id and password (this is
                 because some drivers don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include them in the
                 connection string. This would allow the possibility to specify them in the 
                 data source definition.
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

table - Optional:NO The table to add the record to.

parameters - Optional:NO An array containing the following parameters:

dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
fileOut -- Optional:NO Name of the output file.
sQLQuery -- Optional:NO The file will contain the results of the executed Query. The query is NOT validated by this function.
directoryOut -- Optional:YES OPTIONAL parameter. If not specified the file will be stored under the project "Datapool\Test\" directory.
sQLStatus -- Optional:NO A variable which holds the current SQL run status.
delimiter -- Optional:YES Optional Delimiter to be used between columns written to file.
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).
prompt -- Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

copyDBTableToFile

public ComponentFunction copyDBTableToFile(java.lang.String dBSourceName,
                                           java.lang.String fileOut,
                                           java.lang.String dBTableName,
                                           java.lang.String columnCount,
                                           java.lang.String rowCount,
                                           java.lang.String sQLQuery,
                                           java.lang.String delimiter,
                                           java.lang.String directoryOut,
                                           java.lang.String sQLStatus,
                                           java.lang.String userID,
                                           java.lang.String password,
                                           java.lang.String prompt)

 
              This routine will copy the contents of a DBTable  to a file.
              
                 This routine will export the contents of a DBTable  to a delimeted file.
                 
                 A data source name [DSN] and Query String is required. You also have to specify
                 a variable to get the status code.  And optionally user id and password (this is
                 because some drivers don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include them in the
                 connection string. This would allow the possibility to specify them in the 
                 data source definition.  If no output directory is specified, the result file
                 get saved under "Datapool\Test\".
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

fileOut - Optional:NO Name of the output file.

dBTableName - Optional:NO Name of the TABLE to access within the DBSourceName

columnCount - Optional:YES If specified the output file will contain only the number of columns specified.

rowCount - Optional:YES If specified the output file will contain only the number of rows specified.

sQLQuery - Optional:YES OPTIONAL parameter. If specified, the file will contain the results of the executed Query. The query is NOT validated by this function.

delimiter - Optional:YES OPTIONAL parameter. If not specified the default ',' seperator will be used.

directoryOut - Optional:YES OPTIONAL parameter. If not specified the file will be stored under the project "Datapool\Test\" directory.

sQLStatus - Optional:NO A variable which holds the current SQL run status.

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

prompt - Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

copyDBTableToFile

public void copyDBTableToFile(StepTestTable table,
                              java.lang.String dBSourceName,
                              java.lang.String fileOut,
                              java.lang.String dBTableName,
                              java.lang.String columnCount,
                              java.lang.String rowCount,
                              java.lang.String sQLQuery,
                              java.lang.String delimiter,
                              java.lang.String directoryOut,
                              java.lang.String sQLStatus,
                              java.lang.String userID,
                              java.lang.String password,
                              java.lang.String prompt)

 
              This routine will copy the contents of a DBTable  to a file.
              
                 This routine will export the contents of a DBTable  to a delimeted file.
                 
                 A data source name [DSN] and Query String is required. You also have to specify
                 a variable to get the status code.  And optionally user id and password (this is
                 because some drivers don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include them in the
                 connection string. This would allow the possibility to specify them in the 
                 data source definition.  If no output directory is specified, the result file
                 get saved under "Datapool\Test\".
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

table - Optional:NO The table to add the record to.

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

fileOut - Optional:NO Name of the output file.

dBTableName - Optional:NO Name of the TABLE to access within the DBSourceName

columnCount - Optional:YES If specified the output file will contain only the number of columns specified.

rowCount - Optional:YES If specified the output file will contain only the number of rows specified.

sQLQuery - Optional:YES OPTIONAL parameter. If specified, the file will contain the results of the executed Query. The query is NOT validated by this function.

delimiter - Optional:YES OPTIONAL parameter. If not specified the default ',' seperator will be used.

directoryOut - Optional:YES OPTIONAL parameter. If not specified the file will be stored under the project "Datapool\Test\" directory.

sQLStatus - Optional:NO A variable which holds the current SQL run status.

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

prompt - Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

copyDBTableToFile

public ComponentFunction copyDBTableToFile(java.lang.String[] parameters)

 
              This routine will copy the contents of a DBTable  to a file.
              
                 This routine will export the contents of a DBTable  to a delimeted file.
                 
                 A data source name [DSN] and Query String is required. You also have to specify
                 a variable to get the status code.  And optionally user id and password (this is
                 because some drivers don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include them in the
                 connection string. This would allow the possibility to specify them in the 
                 data source definition.  If no output directory is specified, the result file
                 get saved under "Datapool\Test\".
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

parameters - Optional:NO An array containing the following parameters:

dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
fileOut -- Optional:NO Name of the output file.
dBTableName -- Optional:NO Name of the TABLE to access within the DBSourceName
columnCount -- Optional:YES If specified the output file will contain only the number of columns specified.
rowCount -- Optional:YES If specified the output file will contain only the number of rows specified.
sQLQuery -- Optional:YES OPTIONAL parameter. If specified, the file will contain the results of the executed Query. The query is NOT validated by this function.
delimiter -- Optional:YES OPTIONAL parameter. If not specified the default ',' seperator will be used.
directoryOut -- Optional:YES OPTIONAL parameter. If not specified the file will be stored under the project "Datapool\Test\" directory.
sQLStatus -- Optional:NO A variable which holds the current SQL run status.
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).
prompt -- Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

copyDBTableToFile

public void copyDBTableToFile(StepTestTable table,
                              java.lang.String[] parameters)

 
              This routine will copy the contents of a DBTable  to a file.
              
                 This routine will export the contents of a DBTable  to a delimeted file.
                 
                 A data source name [DSN] and Query String is required. You also have to specify
                 a variable to get the status code.  And optionally user id and password (this is
                 because some drivers don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include them in the
                 connection string. This would allow the possibility to specify them in the 
                 data source definition.  If no output directory is specified, the result file
                 get saved under "Datapool\Test\".
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

table - Optional:NO The table to add the record to.

parameters - Optional:NO An array containing the following parameters:

dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
fileOut -- Optional:NO Name of the output file.
dBTableName -- Optional:NO Name of the TABLE to access within the DBSourceName
columnCount -- Optional:YES If specified the output file will contain only the number of columns specified.
rowCount -- Optional:YES If specified the output file will contain only the number of rows specified.
sQLQuery -- Optional:YES OPTIONAL parameter. If specified, the file will contain the results of the executed Query. The query is NOT validated by this function.
delimiter -- Optional:YES OPTIONAL parameter. If not specified the default ',' seperator will be used.
directoryOut -- Optional:YES OPTIONAL parameter. If not specified the file will be stored under the project "Datapool\Test\" directory.
sQLStatus -- Optional:NO A variable which holds the current SQL run status.
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).
prompt -- Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

deleteDBTableRecords

public ComponentFunction deleteDBTableRecords(java.lang.String dBTableName,
                                              java.lang.String dBQueryCond,
                                              java.lang.String dBSourceName,
                                              java.lang.String userID,
                                              java.lang.String password,
                                              java.lang.String prompt)

 
                 Deletes records in a database table
              
                 Deletes records in a database table.
                 
                 A table name is required. You also have to specify data source name,
                 and optionally user id and password (this is because some drivers
                 don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include
                 them in the connection string. This would allow the possibility
                 to specify them in the data source definition.
                 
                 A query condition can be included, usually it is. It can be any 
                 valid expression allowed by the WHERE clause of the DELETE FROM sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

dBTableName - Optional:NO Name of the TABLE to access within the DBSourceName

dBQueryCond - Optional:YES Expression allowed by the WHERE clause of the DELETE FROM sentence of the SQL driver

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

prompt - Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

deleteDBTableRecords

public void deleteDBTableRecords(StepTestTable table,
                                 java.lang.String dBTableName,
                                 java.lang.String dBQueryCond,
                                 java.lang.String dBSourceName,
                                 java.lang.String userID,
                                 java.lang.String password,
                                 java.lang.String prompt)

 
                 Deletes records in a database table
              
                 Deletes records in a database table.
                 
                 A table name is required. You also have to specify data source name,
                 and optionally user id and password (this is because some drivers
                 don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include
                 them in the connection string. This would allow the possibility
                 to specify them in the data source definition.
                 
                 A query condition can be included, usually it is. It can be any 
                 valid expression allowed by the WHERE clause of the DELETE FROM sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

table - Optional:NO The table to add the record to.

dBTableName - Optional:NO Name of the TABLE to access within the DBSourceName

dBQueryCond - Optional:YES Expression allowed by the WHERE clause of the DELETE FROM sentence of the SQL driver

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

prompt - Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

deleteDBTableRecords

public ComponentFunction deleteDBTableRecords(java.lang.String[] parameters)

 
                 Deletes records in a database table
              
                 Deletes records in a database table.
                 
                 A table name is required. You also have to specify data source name,
                 and optionally user id and password (this is because some drivers
                 don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include
                 them in the connection string. This would allow the possibility
                 to specify them in the data source definition.
                 
                 A query condition can be included, usually it is. It can be any 
                 valid expression allowed by the WHERE clause of the DELETE FROM sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

parameters - Optional:NO An array containing the following parameters:

dBTableName -- Optional:NO Name of the TABLE to access within the DBSourceName
dBQueryCond -- Optional:YES Expression allowed by the WHERE clause of the DELETE FROM sentence of the SQL driver
dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).
prompt -- Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

deleteDBTableRecords

public void deleteDBTableRecords(StepTestTable table,
                                 java.lang.String[] parameters)

 
                 Deletes records in a database table
              
                 Deletes records in a database table.
                 
                 A table name is required. You also have to specify data source name,
                 and optionally user id and password (this is because some drivers
                 don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include
                 them in the connection string. This would allow the possibility
                 to specify them in the data source definition.
                 
                 A query condition can be included, usually it is. It can be any 
                 valid expression allowed by the WHERE clause of the DELETE FROM sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

table - Optional:NO The table to add the record to.

parameters - Optional:NO An array containing the following parameters:

dBTableName -- Optional:NO Name of the TABLE to access within the DBSourceName
dBQueryCond -- Optional:YES Expression allowed by the WHERE clause of the DELETE FROM sentence of the SQL driver
dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).
prompt -- Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

execSQLCommit

public ComponentFunction execSQLCommit(java.lang.String dBSourceName,
                                       java.lang.String sQLStatus,
                                       java.lang.String userID,
                                       java.lang.String password)

 
              This routine will commit the pending queries on the database.
              
                 When ExecSQLQuery is used with the autoCommit option turned off, queries will be
                 not be auto-committed as is the default with JDBC.  In this way, you can use
                 multiple ExecSQLQuery statements, but then use ExecSQLCommit to commit all of
                 the queries at once.

                 This can be useful if your program is using a special process that requires
                 committing all queries at one time.
                 
                 A data source name [DSN] and Query String is required. You also have to specify
                 a variable to get the status code.  And optionally user id and password (this is
                 because some drivers don't need a user/password).
                 
                  

Supporting Engines:

• Rational RobotJ

Parameters:

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

sQLStatus - Optional:NO A variable which holds the current SQL run status.

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

execSQLCommit

public void execSQLCommit(StepTestTable table,
                          java.lang.String dBSourceName,
                          java.lang.String sQLStatus,
                          java.lang.String userID,
                          java.lang.String password)

 
              This routine will commit the pending queries on the database.
              
                 When ExecSQLQuery is used with the autoCommit option turned off, queries will be
                 not be auto-committed as is the default with JDBC.  In this way, you can use
                 multiple ExecSQLQuery statements, but then use ExecSQLCommit to commit all of
                 the queries at once.

                 This can be useful if your program is using a special process that requires
                 committing all queries at one time.
                 
                 A data source name [DSN] and Query String is required. You also have to specify
                 a variable to get the status code.  And optionally user id and password (this is
                 because some drivers don't need a user/password).
                 
                  

Supporting Engines:

• Rational RobotJ

Parameters:

table - Optional:NO The table to add the record to.

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

sQLStatus - Optional:NO A variable which holds the current SQL run status.

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

execSQLCommit

public ComponentFunction execSQLCommit(java.lang.String[] parameters)

 
              This routine will commit the pending queries on the database.
              
                 When ExecSQLQuery is used with the autoCommit option turned off, queries will be
                 not be auto-committed as is the default with JDBC.  In this way, you can use
                 multiple ExecSQLQuery statements, but then use ExecSQLCommit to commit all of
                 the queries at once.

                 This can be useful if your program is using a special process that requires
                 committing all queries at one time.
                 
                 A data source name [DSN] and Query String is required. You also have to specify
                 a variable to get the status code.  And optionally user id and password (this is
                 because some drivers don't need a user/password).
                 
                  

Supporting Engines:

• Rational RobotJ

Parameters:

parameters - Optional:NO An array containing the following parameters:

dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
sQLStatus -- Optional:NO A variable which holds the current SQL run status.
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).

execSQLCommit

public void execSQLCommit(StepTestTable table,
                          java.lang.String[] parameters)

 
              This routine will commit the pending queries on the database.
              
                 When ExecSQLQuery is used with the autoCommit option turned off, queries will be
                 not be auto-committed as is the default with JDBC.  In this way, you can use
                 multiple ExecSQLQuery statements, but then use ExecSQLCommit to commit all of
                 the queries at once.

                 This can be useful if your program is using a special process that requires
                 committing all queries at one time.
                 
                 A data source name [DSN] and Query String is required. You also have to specify
                 a variable to get the status code.  And optionally user id and password (this is
                 because some drivers don't need a user/password).
                 
                  

Supporting Engines:

• Rational RobotJ

Parameters:

table - Optional:NO The table to add the record to.

parameters - Optional:NO An array containing the following parameters:

dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
sQLStatus -- Optional:NO A variable which holds the current SQL run status.
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).

execSQLQuery

public ComponentFunction execSQLQuery(java.lang.String dBSourceName,
                                      java.lang.String queryStr,
                                      java.lang.String sQLStatusCode,
                                      java.lang.String userID,
                                      java.lang.String password,
                                      java.lang.String prompt)

 
                 Executes the query provided in a ^queryStr on the database table.
              
                 Executes the query in a database table.
                 
                 A data source name [DSN] and Query String is required. You also have to specify
                 a variable to get the status code.  And optionally user id and password (this is
                 because some drivers don't need a user/password).
                 
                 Use this command with caution.  It doesn't return any value back other than the
                 SQL Status code.  So, remember not to use use Select command inside the queryStr.
                 It cab be use to update Table. or reset some flag.
                 
                 To do: if user id and/or password are not specified, don't include
                 them in the connection string. This would allow the possibility
                 to specify them in the data source definition.
                  
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

queryStr - Optional:NO Actual query stored in a ^queryStr.

sQLStatusCode - Optional:NO SQL status code as a result of executing the query.

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

prompt - Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

execSQLQuery

public void execSQLQuery(StepTestTable table,
                         java.lang.String dBSourceName,
                         java.lang.String queryStr,
                         java.lang.String sQLStatusCode,
                         java.lang.String userID,
                         java.lang.String password,
                         java.lang.String prompt)

 
                 Executes the query provided in a ^queryStr on the database table.
              
                 Executes the query in a database table.
                 
                 A data source name [DSN] and Query String is required. You also have to specify
                 a variable to get the status code.  And optionally user id and password (this is
                 because some drivers don't need a user/password).
                 
                 Use this command with caution.  It doesn't return any value back other than the
                 SQL Status code.  So, remember not to use use Select command inside the queryStr.
                 It cab be use to update Table. or reset some flag.
                 
                 To do: if user id and/or password are not specified, don't include
                 them in the connection string. This would allow the possibility
                 to specify them in the data source definition.
                  
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

table - Optional:NO The table to add the record to.

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

queryStr - Optional:NO Actual query stored in a ^queryStr.

sQLStatusCode - Optional:NO SQL status code as a result of executing the query.

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

prompt - Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

execSQLQuery

public ComponentFunction execSQLQuery(java.lang.String[] parameters)

 
                 Executes the query provided in a ^queryStr on the database table.
              
                 Executes the query in a database table.
                 
                 A data source name [DSN] and Query String is required. You also have to specify
                 a variable to get the status code.  And optionally user id and password (this is
                 because some drivers don't need a user/password).
                 
                 Use this command with caution.  It doesn't return any value back other than the
                 SQL Status code.  So, remember not to use use Select command inside the queryStr.
                 It cab be use to update Table. or reset some flag.
                 
                 To do: if user id and/or password are not specified, don't include
                 them in the connection string. This would allow the possibility
                 to specify them in the data source definition.
                  
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

parameters - Optional:NO An array containing the following parameters:

dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
queryStr -- Optional:NO Actual query stored in a ^queryStr.
sQLStatusCode -- Optional:NO SQL status code as a result of executing the query.
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).
prompt -- Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

execSQLQuery

public void execSQLQuery(StepTestTable table,
                         java.lang.String[] parameters)

 
                 Executes the query provided in a ^queryStr on the database table.
              
                 Executes the query in a database table.
                 
                 A data source name [DSN] and Query String is required. You also have to specify
                 a variable to get the status code.  And optionally user id and password (this is
                 because some drivers don't need a user/password).
                 
                 Use this command with caution.  It doesn't return any value back other than the
                 SQL Status code.  So, remember not to use use Select command inside the queryStr.
                 It cab be use to update Table. or reset some flag.
                 
                 To do: if user id and/or password are not specified, don't include
                 them in the connection string. This would allow the possibility
                 to specify them in the data source definition.
                  
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

table - Optional:NO The table to add the record to.

parameters - Optional:NO An array containing the following parameters:

dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
queryStr -- Optional:NO Actual query stored in a ^queryStr.
sQLStatusCode -- Optional:NO SQL status code as a result of executing the query.
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).
prompt -- Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

getDBTableColumnCount

public ComponentFunction getDBTableColumnCount(java.lang.String dBSourceName,
                                               java.lang.String dBTableName,
                                               java.lang.String columnCount,
                                               java.lang.String sQLStatusCode,
                                               java.lang.String userID,
                                               java.lang.String password,
                                               java.lang.String prompt)

 
                 Executes the query in a specified database table and returns the total column count.
              
                 Executes the query in a specified database table and returns the total column count.
                 
                 A data source name [DSN] and Table name are required. You also have to specify a 
                 variable to get the result of the SQL and status code.  And optionally user id 
                 and password (this is because some drivers don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include them in the 
                 connection string. This would allow the possibility to specify them in the data
                 source definition.
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

dBTableName - Optional:NO Name of the TABLE to access within the DBSourceName

columnCount - Optional:NO SQL result get stored in this return variable.

sQLStatusCode - Optional:NO SQL status code as a result of executing the query.

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

prompt - Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

getDBTableColumnCount

public void getDBTableColumnCount(StepTestTable table,
                                  java.lang.String dBSourceName,
                                  java.lang.String dBTableName,
                                  java.lang.String columnCount,
                                  java.lang.String sQLStatusCode,
                                  java.lang.String userID,
                                  java.lang.String password,
                                  java.lang.String prompt)

 
                 Executes the query in a specified database table and returns the total column count.
              
                 Executes the query in a specified database table and returns the total column count.
                 
                 A data source name [DSN] and Table name are required. You also have to specify a 
                 variable to get the result of the SQL and status code.  And optionally user id 
                 and password (this is because some drivers don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include them in the 
                 connection string. This would allow the possibility to specify them in the data
                 source definition.
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

table - Optional:NO The table to add the record to.

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

dBTableName - Optional:NO Name of the TABLE to access within the DBSourceName

columnCount - Optional:NO SQL result get stored in this return variable.

sQLStatusCode - Optional:NO SQL status code as a result of executing the query.

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

prompt - Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

getDBTableColumnCount

public ComponentFunction getDBTableColumnCount(java.lang.String[] parameters)

 
                 Executes the query in a specified database table and returns the total column count.
              
                 Executes the query in a specified database table and returns the total column count.
                 
                 A data source name [DSN] and Table name are required. You also have to specify a 
                 variable to get the result of the SQL and status code.  And optionally user id 
                 and password (this is because some drivers don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include them in the 
                 connection string. This would allow the possibility to specify them in the data
                 source definition.
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

parameters - Optional:NO An array containing the following parameters:

dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
dBTableName -- Optional:NO Name of the TABLE to access within the DBSourceName
columnCount -- Optional:NO SQL result get stored in this return variable.
sQLStatusCode -- Optional:NO SQL status code as a result of executing the query.
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).
prompt -- Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

getDBTableColumnCount

public void getDBTableColumnCount(StepTestTable table,
                                  java.lang.String[] parameters)

 
                 Executes the query in a specified database table and returns the total column count.
              
                 Executes the query in a specified database table and returns the total column count.
                 
                 A data source name [DSN] and Table name are required. You also have to specify a 
                 variable to get the result of the SQL and status code.  And optionally user id 
                 and password (this is because some drivers don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include them in the 
                 connection string. This would allow the possibility to specify them in the data
                 source definition.
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

table - Optional:NO The table to add the record to.

parameters - Optional:NO An array containing the following parameters:

dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
dBTableName -- Optional:NO Name of the TABLE to access within the DBSourceName
columnCount -- Optional:NO SQL result get stored in this return variable.
sQLStatusCode -- Optional:NO SQL status code as a result of executing the query.
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).
prompt -- Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

getDBTableRowCount

public ComponentFunction getDBTableRowCount(java.lang.String dBSourceName,
                                            java.lang.String dBTableName,
                                            java.lang.String rowCount,
                                            java.lang.String sQLStatusCode,
                                            java.lang.String userID,
                                            java.lang.String password,
                                            java.lang.String prompt)

 
                 Executes the query in a database table.
              
                 Executes the query in a database table.
                 
                 A data source name [DSN] and Query String is required. You also have to specify
                 a variable to get the status code.  And optionally user id and password (this is
                 because some drivers don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include them in the 
                 connection string. This would allow the possibility to specify them in the data
                 source definition. 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

dBTableName - Optional:NO Name of the TABLE to access within the DBSourceName

rowCount - Optional:NO SQL result get stored in this return variable.

sQLStatusCode - Optional:NO SQL status code as a result of executing the query.

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

prompt - Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

getDBTableRowCount

public void getDBTableRowCount(StepTestTable table,
                               java.lang.String dBSourceName,
                               java.lang.String dBTableName,
                               java.lang.String rowCount,
                               java.lang.String sQLStatusCode,
                               java.lang.String userID,
                               java.lang.String password,
                               java.lang.String prompt)

 
                 Executes the query in a database table.
              
                 Executes the query in a database table.
                 
                 A data source name [DSN] and Query String is required. You also have to specify
                 a variable to get the status code.  And optionally user id and password (this is
                 because some drivers don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include them in the 
                 connection string. This would allow the possibility to specify them in the data
                 source definition. 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

table - Optional:NO The table to add the record to.

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

dBTableName - Optional:NO Name of the TABLE to access within the DBSourceName

rowCount - Optional:NO SQL result get stored in this return variable.

sQLStatusCode - Optional:NO SQL status code as a result of executing the query.

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

prompt - Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

getDBTableRowCount

public ComponentFunction getDBTableRowCount(java.lang.String[] parameters)

 
                 Executes the query in a database table.
              
                 Executes the query in a database table.
                 
                 A data source name [DSN] and Query String is required. You also have to specify
                 a variable to get the status code.  And optionally user id and password (this is
                 because some drivers don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include them in the 
                 connection string. This would allow the possibility to specify them in the data
                 source definition. 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

parameters - Optional:NO An array containing the following parameters:

dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
dBTableName -- Optional:NO Name of the TABLE to access within the DBSourceName
rowCount -- Optional:NO SQL result get stored in this return variable.
sQLStatusCode -- Optional:NO SQL status code as a result of executing the query.
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).
prompt -- Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

getDBTableRowCount

public void getDBTableRowCount(StepTestTable table,
                               java.lang.String[] parameters)

 
                 Executes the query in a database table.
              
                 Executes the query in a database table.
                 
                 A data source name [DSN] and Query String is required. You also have to specify
                 a variable to get the status code.  And optionally user id and password (this is
                 because some drivers don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include them in the 
                 connection string. This would allow the possibility to specify them in the data
                 source definition. 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

table - Optional:NO The table to add the record to.

parameters - Optional:NO An array containing the following parameters:

dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
dBTableName -- Optional:NO Name of the TABLE to access within the DBSourceName
rowCount -- Optional:NO SQL result get stored in this return variable.
sQLStatusCode -- Optional:NO SQL status code as a result of executing the query.
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).
prompt -- Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

getDBValue

public ComponentFunction getDBValue(java.lang.String dBSourceName,
                                    java.lang.String queryStr,
                                    java.lang.String queryResult,
                                    java.lang.String sQLStatusCode,
                                    java.lang.String userID,
                                    java.lang.String password,
                                    java.lang.String prompt)

 
                 Executes the query and returns the case-sensitive value as result of the execution.
              
                 Executes the query specified in the ^queryStr and returns the case-sensitive value
                 as result of the execution.
                 
                 To return the value, it executes a SQL query sentence using an ODBC data source to 
                 connect to the data base.
                 
                 A queryStr and the two return variables to store the query result and SQL Status code
                 are required.  You also have to specify data source name and optionally user id and
                 password (this is because some drivers don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include them in the connection
                 string. This would allow the possibility to specify them in the data source definition.
                 
                 If the query returns more than one record, the returned value is the corresponding to the
                 first one, unless the field name be something like COUNT(*) or SUM(InvoiceTot).
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

queryStr - Optional:NO Actual query stored in a ^queryStr.

queryResult - Optional:NO SQL result get stored in this return variable.

sQLStatusCode - Optional:NO SQL status code as a result of executing the query.

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

prompt - Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

getDBValue

public void getDBValue(StepTestTable table,
                       java.lang.String dBSourceName,
                       java.lang.String queryStr,
                       java.lang.String queryResult,
                       java.lang.String sQLStatusCode,
                       java.lang.String userID,
                       java.lang.String password,
                       java.lang.String prompt)

 
                 Executes the query and returns the case-sensitive value as result of the execution.
              
                 Executes the query specified in the ^queryStr and returns the case-sensitive value
                 as result of the execution.
                 
                 To return the value, it executes a SQL query sentence using an ODBC data source to 
                 connect to the data base.
                 
                 A queryStr and the two return variables to store the query result and SQL Status code
                 are required.  You also have to specify data source name and optionally user id and
                 password (this is because some drivers don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include them in the connection
                 string. This would allow the possibility to specify them in the data source definition.
                 
                 If the query returns more than one record, the returned value is the corresponding to the
                 first one, unless the field name be something like COUNT(*) or SUM(InvoiceTot).
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

table - Optional:NO The table to add the record to.

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

queryStr - Optional:NO Actual query stored in a ^queryStr.

queryResult - Optional:NO SQL result get stored in this return variable.

sQLStatusCode - Optional:NO SQL status code as a result of executing the query.

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

prompt - Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

getDBValue

public ComponentFunction getDBValue(java.lang.String[] parameters)

 
                 Executes the query and returns the case-sensitive value as result of the execution.
              
                 Executes the query specified in the ^queryStr and returns the case-sensitive value
                 as result of the execution.
                 
                 To return the value, it executes a SQL query sentence using an ODBC data source to 
                 connect to the data base.
                 
                 A queryStr and the two return variables to store the query result and SQL Status code
                 are required.  You also have to specify data source name and optionally user id and
                 password (this is because some drivers don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include them in the connection
                 string. This would allow the possibility to specify them in the data source definition.
                 
                 If the query returns more than one record, the returned value is the corresponding to the
                 first one, unless the field name be something like COUNT(*) or SUM(InvoiceTot).
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

parameters - Optional:NO An array containing the following parameters:

dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
queryStr -- Optional:NO Actual query stored in a ^queryStr.
queryResult -- Optional:NO SQL result get stored in this return variable.
sQLStatusCode -- Optional:NO SQL status code as a result of executing the query.
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).
prompt -- Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

getDBValue

public void getDBValue(StepTestTable table,
                       java.lang.String[] parameters)

 
                 Executes the query and returns the case-sensitive value as result of the execution.
              
                 Executes the query specified in the ^queryStr and returns the case-sensitive value
                 as result of the execution.
                 
                 To return the value, it executes a SQL query sentence using an ODBC data source to 
                 connect to the data base.
                 
                 A queryStr and the two return variables to store the query result and SQL Status code
                 are required.  You also have to specify data source name and optionally user id and
                 password (this is because some drivers don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include them in the connection
                 string. This would allow the possibility to specify them in the data source definition.
                 
                 If the query returns more than one record, the returned value is the corresponding to the
                 first one, unless the field name be something like COUNT(*) or SUM(InvoiceTot).
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

table - Optional:NO The table to add the record to.

parameters - Optional:NO An array containing the following parameters:

dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
queryStr -- Optional:NO Actual query stored in a ^queryStr.
queryResult -- Optional:NO SQL result get stored in this return variable.
sQLStatusCode -- Optional:NO SQL status code as a result of executing the query.
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).
prompt -- Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

verifyDatabaseNullValue

public ComponentFunction verifyDatabaseNullValue(java.lang.String dBFieldName,
                                                 java.lang.String dBTableName,
                                                 java.lang.String dBQueryCond,
                                                 java.lang.String dBSourceName,
                                                 java.lang.String userID,
                                                 java.lang.String password,
                                                 java.lang.String prompt)

 
                 Verifies the value of a field in a database table is NULL
              
                 Verifies the value of a field in a database table is NULL.
                 
                 Sometimes you have to check if a field's value is NULL. This
                 NULL value is different from any other (even zero for numerics
                 and null string for characters), so if you try to check it
                 using VerifyDBValue() function, if will fail.
                 
                 A table and field name are required. You also have to specify data source name,
                 and optionally user id and password (this is because some drivers
                 don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include
                 them in the connection string. This would allow the possibility
                 to specify them in the data source definition.
                 
                 A query condition can be included, usually it is. It can be any 
                 valid expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

dBFieldName - Optional:NO Name of the FIELD within DBTableName used in the verification

dBTableName - Optional:NO Name of the TABLE to access within the DBSourceName

dBQueryCond - Optional:YES Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

prompt - Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

verifyDatabaseNullValue

public void verifyDatabaseNullValue(StepTestTable table,
                                    java.lang.String dBFieldName,
                                    java.lang.String dBTableName,
                                    java.lang.String dBQueryCond,
                                    java.lang.String dBSourceName,
                                    java.lang.String userID,
                                    java.lang.String password,
                                    java.lang.String prompt)

 
                 Verifies the value of a field in a database table is NULL
              
                 Verifies the value of a field in a database table is NULL.
                 
                 Sometimes you have to check if a field's value is NULL. This
                 NULL value is different from any other (even zero for numerics
                 and null string for characters), so if you try to check it
                 using VerifyDBValue() function, if will fail.
                 
                 A table and field name are required. You also have to specify data source name,
                 and optionally user id and password (this is because some drivers
                 don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include
                 them in the connection string. This would allow the possibility
                 to specify them in the data source definition.
                 
                 A query condition can be included, usually it is. It can be any 
                 valid expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

table - Optional:NO The table to add the record to.

dBFieldName - Optional:NO Name of the FIELD within DBTableName used in the verification

dBTableName - Optional:NO Name of the TABLE to access within the DBSourceName

dBQueryCond - Optional:YES Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

prompt - Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

verifyDatabaseNullValue

public ComponentFunction verifyDatabaseNullValue(java.lang.String[] parameters)

 
                 Verifies the value of a field in a database table is NULL
              
                 Verifies the value of a field in a database table is NULL.
                 
                 Sometimes you have to check if a field's value is NULL. This
                 NULL value is different from any other (even zero for numerics
                 and null string for characters), so if you try to check it
                 using VerifyDBValue() function, if will fail.
                 
                 A table and field name are required. You also have to specify data source name,
                 and optionally user id and password (this is because some drivers
                 don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include
                 them in the connection string. This would allow the possibility
                 to specify them in the data source definition.
                 
                 A query condition can be included, usually it is. It can be any 
                 valid expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

parameters - Optional:NO An array containing the following parameters:

dBFieldName -- Optional:NO Name of the FIELD within DBTableName used in the verification
dBTableName -- Optional:NO Name of the TABLE to access within the DBSourceName
dBQueryCond -- Optional:YES Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).
prompt -- Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

verifyDatabaseNullValue

public void verifyDatabaseNullValue(StepTestTable table,
                                    java.lang.String[] parameters)

 
                 Verifies the value of a field in a database table is NULL
              
                 Verifies the value of a field in a database table is NULL.
                 
                 Sometimes you have to check if a field's value is NULL. This
                 NULL value is different from any other (even zero for numerics
                 and null string for characters), so if you try to check it
                 using VerifyDBValue() function, if will fail.
                 
                 A table and field name are required. You also have to specify data source name,
                 and optionally user id and password (this is because some drivers
                 don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include
                 them in the connection string. This would allow the possibility
                 to specify them in the data source definition.
                 
                 A query condition can be included, usually it is. It can be any 
                 valid expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

table - Optional:NO The table to add the record to.

parameters - Optional:NO An array containing the following parameters:

dBFieldName -- Optional:NO Name of the FIELD within DBTableName used in the verification
dBTableName -- Optional:NO Name of the TABLE to access within the DBSourceName
dBQueryCond -- Optional:YES Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).
prompt -- Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

verifyDatabaseValue

public ComponentFunction verifyDatabaseValue(java.lang.String dBFieldName,
                                             java.lang.String dBTableName,
                                             java.lang.String dBQueryCond,
                                             java.lang.String dBSourceName,
                                             java.lang.String userID,
                                             java.lang.String password,
                                             java.lang.String expectedValue,
                                             java.lang.String prompt)

 
                 Verifies the case-sensitive value of a field in a database table
              
                 Verifies the case-sensitive value of a field in a database table.
                 
                 To return the value, it executes a SQL query sentence using an ODBC 
                 data source to connect to the data base. 
                 
                 A table and field name are required. You also have to specify data source name,
                 and optionally user id and password (this is because some drivers
                 don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include
                 them in the connection string. This would allow the possibility
                 to specify them in the data source definition.
                 
                 If the query returns more than one record, the returned value
                 is the corresponding to the first one, unless the field name
                 be something like COUNT(*) or SUM(InvoiceTot).
                 
                 A query condition can be included, usually it is. It can be any 
                 valid expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

dBFieldName - Optional:NO Name of the FIELD within DBTableName used in the verification

dBTableName - Optional:NO Name of the TABLE to access within the DBSourceName

dBQueryCond - Optional:YES Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

expectedValue - Optional:NO Benchmark value to compare against retrieved DBFieldName value

prompt - Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

verifyDatabaseValue

public void verifyDatabaseValue(StepTestTable table,
                                java.lang.String dBFieldName,
                                java.lang.String dBTableName,
                                java.lang.String dBQueryCond,
                                java.lang.String dBSourceName,
                                java.lang.String userID,
                                java.lang.String password,
                                java.lang.String expectedValue,
                                java.lang.String prompt)

 
                 Verifies the case-sensitive value of a field in a database table
              
                 Verifies the case-sensitive value of a field in a database table.
                 
                 To return the value, it executes a SQL query sentence using an ODBC 
                 data source to connect to the data base. 
                 
                 A table and field name are required. You also have to specify data source name,
                 and optionally user id and password (this is because some drivers
                 don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include
                 them in the connection string. This would allow the possibility
                 to specify them in the data source definition.
                 
                 If the query returns more than one record, the returned value
                 is the corresponding to the first one, unless the field name
                 be something like COUNT(*) or SUM(InvoiceTot).
                 
                 A query condition can be included, usually it is. It can be any 
                 valid expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

table - Optional:NO The table to add the record to.

dBFieldName - Optional:NO Name of the FIELD within DBTableName used in the verification

dBTableName - Optional:NO Name of the TABLE to access within the DBSourceName

dBQueryCond - Optional:YES Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

expectedValue - Optional:NO Benchmark value to compare against retrieved DBFieldName value

prompt - Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

verifyDatabaseValue

public ComponentFunction verifyDatabaseValue(java.lang.String[] parameters)

 
                 Verifies the case-sensitive value of a field in a database table
              
                 Verifies the case-sensitive value of a field in a database table.
                 
                 To return the value, it executes a SQL query sentence using an ODBC 
                 data source to connect to the data base. 
                 
                 A table and field name are required. You also have to specify data source name,
                 and optionally user id and password (this is because some drivers
                 don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include
                 them in the connection string. This would allow the possibility
                 to specify them in the data source definition.
                 
                 If the query returns more than one record, the returned value
                 is the corresponding to the first one, unless the field name
                 be something like COUNT(*) or SUM(InvoiceTot).
                 
                 A query condition can be included, usually it is. It can be any 
                 valid expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

parameters - Optional:NO An array containing the following parameters:

dBFieldName -- Optional:NO Name of the FIELD within DBTableName used in the verification
dBTableName -- Optional:NO Name of the TABLE to access within the DBSourceName
dBQueryCond -- Optional:YES Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).
expectedValue -- Optional:NO Benchmark value to compare against retrieved DBFieldName value
prompt -- Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

verifyDatabaseValue

public void verifyDatabaseValue(StepTestTable table,
                                java.lang.String[] parameters)

 
                 Verifies the case-sensitive value of a field in a database table
              
                 Verifies the case-sensitive value of a field in a database table.
                 
                 To return the value, it executes a SQL query sentence using an ODBC 
                 data source to connect to the data base. 
                 
                 A table and field name are required. You also have to specify data source name,
                 and optionally user id and password (this is because some drivers
                 don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include
                 them in the connection string. This would allow the possibility
                 to specify them in the data source definition.
                 
                 If the query returns more than one record, the returned value
                 is the corresponding to the first one, unless the field name
                 be something like COUNT(*) or SUM(InvoiceTot).
                 
                 A query condition can be included, usually it is. It can be any 
                 valid expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

table - Optional:NO The table to add the record to.

parameters - Optional:NO An array containing the following parameters:

dBFieldName -- Optional:NO Name of the FIELD within DBTableName used in the verification
dBTableName -- Optional:NO Name of the TABLE to access within the DBSourceName
dBQueryCond -- Optional:YES Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).
expectedValue -- Optional:NO Benchmark value to compare against retrieved DBFieldName value
prompt -- Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

verifyDBNullValue

public ComponentFunction verifyDBNullValue(java.lang.String dBFieldName,
                                           java.lang.String dBTableName,
                                           java.lang.String dBQueryCond,
                                           java.lang.String dBSourceName,
                                           java.lang.String userID,
                                           java.lang.String password,
                                           java.lang.String prompt)

 
                 Verifies the value of a field in a database table is NULL
              
                 Verifies the value of a field in a database table is NULL.
                 
                 Sometimes you have to check if a field's value is NULL. This
                 NULL value is different from any other (even zero for numerics
                 and null string for characters), so if you try to check it
                 using VerifyDBValue() function, if will fail.
                 
                 A table and field name are required. You also have to specify data source name,
                 and optionally user id and password (this is because some drivers
                 don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include
                 them in the connection string. This would allow the possibility
                 to specify them in the data source definition.
                 
                 A query condition can be included, usually it is. It can be any 
                 valid expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

dBFieldName - Optional:NO Name of the FIELD within DBTableName used in the verification

dBTableName - Optional:NO Name of the TABLE to access within the DBSourceName

dBQueryCond - Optional:YES Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

prompt - Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

verifyDBNullValue

public void verifyDBNullValue(StepTestTable table,
                              java.lang.String dBFieldName,
                              java.lang.String dBTableName,
                              java.lang.String dBQueryCond,
                              java.lang.String dBSourceName,
                              java.lang.String userID,
                              java.lang.String password,
                              java.lang.String prompt)

 
                 Verifies the value of a field in a database table is NULL
              
                 Verifies the value of a field in a database table is NULL.
                 
                 Sometimes you have to check if a field's value is NULL. This
                 NULL value is different from any other (even zero for numerics
                 and null string for characters), so if you try to check it
                 using VerifyDBValue() function, if will fail.
                 
                 A table and field name are required. You also have to specify data source name,
                 and optionally user id and password (this is because some drivers
                 don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include
                 them in the connection string. This would allow the possibility
                 to specify them in the data source definition.
                 
                 A query condition can be included, usually it is. It can be any 
                 valid expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

table - Optional:NO The table to add the record to.

dBFieldName - Optional:NO Name of the FIELD within DBTableName used in the verification

dBTableName - Optional:NO Name of the TABLE to access within the DBSourceName

dBQueryCond - Optional:YES Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

prompt - Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

verifyDBNullValue

public ComponentFunction verifyDBNullValue(java.lang.String[] parameters)

 
                 Verifies the value of a field in a database table is NULL
              
                 Verifies the value of a field in a database table is NULL.
                 
                 Sometimes you have to check if a field's value is NULL. This
                 NULL value is different from any other (even zero for numerics
                 and null string for characters), so if you try to check it
                 using VerifyDBValue() function, if will fail.
                 
                 A table and field name are required. You also have to specify data source name,
                 and optionally user id and password (this is because some drivers
                 don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include
                 them in the connection string. This would allow the possibility
                 to specify them in the data source definition.
                 
                 A query condition can be included, usually it is. It can be any 
                 valid expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

parameters - Optional:NO An array containing the following parameters:

dBFieldName -- Optional:NO Name of the FIELD within DBTableName used in the verification
dBTableName -- Optional:NO Name of the TABLE to access within the DBSourceName
dBQueryCond -- Optional:YES Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).
prompt -- Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

verifyDBNullValue

public void verifyDBNullValue(StepTestTable table,
                              java.lang.String[] parameters)

 
                 Verifies the value of a field in a database table is NULL
              
                 Verifies the value of a field in a database table is NULL.
                 
                 Sometimes you have to check if a field's value is NULL. This
                 NULL value is different from any other (even zero for numerics
                 and null string for characters), so if you try to check it
                 using VerifyDBValue() function, if will fail.
                 
                 A table and field name are required. You also have to specify data source name,
                 and optionally user id and password (this is because some drivers
                 don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include
                 them in the connection string. This would allow the possibility
                 to specify them in the data source definition.
                 
                 A query condition can be included, usually it is. It can be any 
                 valid expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

table - Optional:NO The table to add the record to.

parameters - Optional:NO An array containing the following parameters:

dBFieldName -- Optional:NO Name of the FIELD within DBTableName used in the verification
dBTableName -- Optional:NO Name of the TABLE to access within the DBSourceName
dBQueryCond -- Optional:YES Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).
prompt -- Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

verifyDBValue

public ComponentFunction verifyDBValue(java.lang.String dBFieldName,
                                       java.lang.String dBTableName,
                                       java.lang.String dBQueryCond,
                                       java.lang.String dBSourceName,
                                       java.lang.String userID,
                                       java.lang.String password,
                                       java.lang.String prompt,
                                       java.lang.String expectedValue)

 
                 Verifies the case-sensitive value of a field in a database table
              
                 Verifies the case-sensitive value of a field in a database table.
                 
                 To return the value, it executes a SQL query sentence using an ODBC 
                 data source to connect to the data base. 
                 
                 A table and field name are required. You also have to specify data source name,
                 and optionally user id and password (this is because some drivers
                 don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include
                 them in the connection string. This would allow the possibility
                 to specify them in the data source definition.
                 
                 If the query returns more than one record, the returned value
                 is the corresponding to the first one, unless the field name
                 be something like COUNT(*) or SUM(InvoiceTot).
                 
                 A query condition can be included, usually it is. It can be any 
                 valid expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

dBFieldName - Optional:NO Name of the FIELD within DBTableName used in the verification

dBTableName - Optional:NO Name of the TABLE to access within the DBSourceName

dBQueryCond - Optional:YES Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

prompt - Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

expectedValue - Optional:NO Benchmark value to compare against retrieved DBFieldName value

verifyDBValue

public void verifyDBValue(StepTestTable table,
                          java.lang.String dBFieldName,
                          java.lang.String dBTableName,
                          java.lang.String dBQueryCond,
                          java.lang.String dBSourceName,
                          java.lang.String userID,
                          java.lang.String password,
                          java.lang.String prompt,
                          java.lang.String expectedValue)

 
                 Verifies the case-sensitive value of a field in a database table
              
                 Verifies the case-sensitive value of a field in a database table.
                 
                 To return the value, it executes a SQL query sentence using an ODBC 
                 data source to connect to the data base. 
                 
                 A table and field name are required. You also have to specify data source name,
                 and optionally user id and password (this is because some drivers
                 don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include
                 them in the connection string. This would allow the possibility
                 to specify them in the data source definition.
                 
                 If the query returns more than one record, the returned value
                 is the corresponding to the first one, unless the field name
                 be something like COUNT(*) or SUM(InvoiceTot).
                 
                 A query condition can be included, usually it is. It can be any 
                 valid expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

table - Optional:NO The table to add the record to.

dBFieldName - Optional:NO Name of the FIELD within DBTableName used in the verification

dBTableName - Optional:NO Name of the TABLE to access within the DBSourceName

dBQueryCond - Optional:YES Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

prompt - Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

expectedValue - Optional:NO Benchmark value to compare against retrieved DBFieldName value

verifyDBValue

public ComponentFunction verifyDBValue(java.lang.String[] parameters)

 
                 Verifies the case-sensitive value of a field in a database table
              
                 Verifies the case-sensitive value of a field in a database table.
                 
                 To return the value, it executes a SQL query sentence using an ODBC 
                 data source to connect to the data base. 
                 
                 A table and field name are required. You also have to specify data source name,
                 and optionally user id and password (this is because some drivers
                 don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include
                 them in the connection string. This would allow the possibility
                 to specify them in the data source definition.
                 
                 If the query returns more than one record, the returned value
                 is the corresponding to the first one, unless the field name
                 be something like COUNT(*) or SUM(InvoiceTot).
                 
                 A query condition can be included, usually it is. It can be any 
                 valid expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

parameters - Optional:NO An array containing the following parameters:

dBFieldName -- Optional:NO Name of the FIELD within DBTableName used in the verification
dBTableName -- Optional:NO Name of the TABLE to access within the DBSourceName
dBQueryCond -- Optional:YES Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).
prompt -- Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.
expectedValue -- Optional:NO Benchmark value to compare against retrieved DBFieldName value

verifyDBValue

public void verifyDBValue(StepTestTable table,
                          java.lang.String[] parameters)

 
                 Verifies the case-sensitive value of a field in a database table
              
                 Verifies the case-sensitive value of a field in a database table.
                 
                 To return the value, it executes a SQL query sentence using an ODBC 
                 data source to connect to the data base. 
                 
                 A table and field name are required. You also have to specify data source name,
                 and optionally user id and password (this is because some drivers
                 don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include
                 them in the connection string. This would allow the possibility
                 to specify them in the data source definition.
                 
                 If the query returns more than one record, the returned value
                 is the corresponding to the first one, unless the field name
                 be something like COUNT(*) or SUM(InvoiceTot).
                 
                 A query condition can be included, usually it is. It can be any 
                 valid expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

table - Optional:NO The table to add the record to.

parameters - Optional:NO An array containing the following parameters:

dBFieldName -- Optional:NO Name of the FIELD within DBTableName used in the verification
dBTableName -- Optional:NO Name of the TABLE to access within the DBSourceName
dBQueryCond -- Optional:YES Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).
prompt -- Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.
expectedValue -- Optional:NO Benchmark value to compare against retrieved DBFieldName value