ÿþ<HTML xmlns="http://www.w3.org/TR/REC-html40"> <HEAD> <TITLE>DDDriverDatabaseCommands</TITLE> <LINK rel="stylesheet" href="rrafs.css" type="text/css"/> </HEAD> <BODY> <DIV NAME="top" ID="top"> <H3>DDDriverDatabaseCommands</H3> <SMALL>Last Updated:<script language="JavaScript">document.write(document.lastModified)</script></SMALL> <BR/> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Driver Database Commands for the Cycle, Suite, and Step drivers </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p> This keyword library provides Driver Database Commands that can be used by all three DDE Drivers--CycleDriver, SuiteDriver, and StepDriver. That means they can be used in any keyword driven test tables regardless of the test tables level--Cycle, Suite, or Step. </p><p> Each different driver command has different parameters as described in its documentation. For reference, the first fields of ALL Driver Command test records are defined below: </p><p> Most all commands here require a data source name, Since this driver uses jdbc, then a format like "jdbc:odbc:drivername" is usually supplied for that parameter. Another examples could be: jdbc:oracle:thin:@machine:1111:DBNAME <br> If the jdbc:odbc: is omitted, then the 'drivername' is assumed to be Sun's jdbc-odbc bridge (sun.jdbc.odbc.JdbcOdbcDriver) and that string (jdbc:odbc:) is automatically prepended. </p><p> Notice that for all of the commands here which accept the ADBAlias and ATableAlias parameters, that they are not used. They are only there because there for compatibility with the Component Function versions of these commands (CFDatabase). </p><p> In order to specify the driver, a 'setJdbcDriver' command can be used once at the beginning </p><dl><dd> Field #1 </dd><dt> The "C" = DRIVER COMMAND record type specifier. </dt><dd> Field #2 </dd><dt> The Driver Command keyword. </dt></dl><p> Examples: </p><code> C, setJdbcDriver, "sun.jdbc.odbc.JdbcOdbcDriver" C, setJdbcDriver, "oracle.jdbc.driver.OracleDriver" </code><p> Driver Command parameters must be placed in the test record in the field position specified in the documentation. Some parameters are optional and can be skipped. Optional parameters can only be skipped if all subsequent optional paramaters are also skipped. </p><p> Example: </p><code> c, deleteDBTableRecords, ADBAlias, ATableAlias, DBTableName, DBQueryCond, DBSourceName </code><p> The above example skips the UserId, Password, and SQLStatus (they are not even included) </p><dl><dd><a href="DDDriverCommands.htm" target="_blank"> DDDriverCommands </a></dd></dl></detailed_desc><BR/> </DIV> </DIV> <BR/> <DIV NAME="list" ID="list"> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <TABLE cellspacing="3" border="1" cellpadding="2"> <TR> <TD nowrap="true" width="27%"><A NAME='list_CopyDBTableColumnToFile' HREF='#detail_CopyDBTableColumnToFile' >CopyDBTableColumnToFile</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='SDC.GIF' ALT='SAFS Driver Commands'/></TD> </TR></TABLE> </TD> <TD> This routine will copy the contents of one or more DBTable column(s) to a file. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_CopyDBTableToFile' HREF='#detail_CopyDBTableToFile' >CopyDBTableToFile</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='SDC.GIF' ALT='SAFS Driver Commands'/></TD> </TR></TABLE> </TD> <TD> This routine will copy the contents of a DBTable to a file. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_DeleteDBTableRecords' HREF='#detail_DeleteDBTableRecords' >DeleteDBTableRecords</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='SDC.GIF' ALT='SAFS Driver Commands'/></TD> </TR></TABLE> </TD> <TD> Deletes records in a database table </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_ExecSQLQuery' HREF='#detail_ExecSQLQuery' >ExecSQLQuery</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='SDC.GIF' ALT='SAFS Driver Commands'/></TD> </TR></TABLE> </TD> <TD> Executes the query provided in a queryStr on the database table. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_GetDBTableColumnCount' HREF='#detail_GetDBTableColumnCount' >GetDBTableColumnCount</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='SDC.GIF' ALT='SAFS Driver Commands'/></TD> </TR></TABLE> </TD> <TD> Executes the query in a specified database table and returns the total column count. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_GetDBTableRowCount' HREF='#detail_GetDBTableRowCount' >GetDBTableRowCount</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='SDC.GIF' ALT='SAFS Driver Commands'/></TD> </TR></TABLE> </TD> <TD> Executes the query in a database table. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_GetDBValue' HREF='#detail_GetDBValue' >GetDBValue</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='SDC.GIF' ALT='SAFS Driver Commands'/></TD> </TR></TABLE> </TD> <TD> Executes the query and returns the case-sensitive value as result of the execution. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_SetJdbcDriver' HREF='#detail_SetJdbcDriver' >SetJdbcDriver</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='SDC.GIF' ALT='SAFS Driver Commands'/></TD> </TR></TABLE> </TD> <TD> set Jdbc Driver </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_VerifyDatabaseNullValue' HREF='#detail_VerifyDatabaseNullValue' >VerifyDatabaseNullValue</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='SDC.GIF' ALT='SAFS Driver Commands'/></TD> </TR></TABLE> </TD> <TD> Verifies the value of a field in a database table is NULL </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_VerifyDatabaseValue' HREF='#detail_VerifyDatabaseValue' >VerifyDatabaseValue</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='SDC.GIF' ALT='SAFS Driver Commands'/></TD> </TR></TABLE> </TD> <TD> Verifies the case-sensitive value of a field in a database table </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_VerifyDBNullValue' HREF='#detail_VerifyDBNullValue' >VerifyDBNullValue</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='SDC.GIF' ALT='SAFS Driver Commands'/></TD> </TR></TABLE> </TD> <TD> Verifies the value of a field in a database table is NULL </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_VerifyDBValue' HREF='#detail_VerifyDBValue' >VerifyDBValue</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='SDC.GIF' ALT='SAFS Driver Commands'/></TD> </TR></TABLE> </TD> <TD> Verifies the case-sensitive value of a field in a database table </TD> </TR> </TABLE> <HR/> </DIV> <DIV NAME="detail" ID="detail"> <H3><A NAME='detail_CopyDBTableColumnToFile' />DDDriverDatabaseCommands::<BIG>CopyDBTableColumnToFile</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='SDC.GIF' ALT='SAFS Driver Commands'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> This routine will copy the contents of one or more DBTable column(s) to a file. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> 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. <p> A data source name 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). </p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="3" ><LI> <B>ADBAlias</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> not used </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>ATableAlias</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> not used </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>DBSourceName</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the Datasource containing the DBTable </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>FileOut</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the output file. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>SQLQuery</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> The file will contain the results of the executed Query. The query is NOT validated by this function. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>DirectoryOut</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> OPTIONAL parameter. If not specified the file will be stored in the default test directory </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>SQLStatus</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A variable which holds the current SQL run status. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>Delimiter</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Optional Delimiter to be used between columns written to file. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>UserID</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> UserID for accessing the Datasource (if required). </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>Password</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Password for accessing the Datasource (if required). </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">C, CopyDBTableColumnToFile, ADBAlias, ATableAlias, DataSourceName, OutputFileName, SQLQuery, OutputDirectory, sqlStatus, "|"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> This routine will export the contents of a single DBTable column to a file. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> This routine will export the contents of a single DBTable column to a file using | as delimeter </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_CopyDBTableToFile' />DDDriverDatabaseCommands::<BIG>CopyDBTableToFile</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='SDC.GIF' ALT='SAFS Driver Commands'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> This routine will copy the contents of a DBTable to a file. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> This routine will export the contents of a DBTable to a delimeted file. <p> A data source name 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). </p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="3" ><LI> <B>ADBAlias</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> not used </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>ATableAlias</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> not used </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>DBSourceName</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the Datasource containing the DBTable </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>FileOut</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the output file. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>DBTableName</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the TABLE to access within the DBSourceName </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>ColumnCount</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> If specified the output file will contain only the number of columns specified. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p> OPTIONAL parameter. If specified the output file will contain only the number of columns specified. This number will become the first dimension of the retreival array. If NOT specified then no maximum. </p></detailed_desc><BR/> </DIV> </LI> <BR/> <LI>[ <B>RowCount</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> If specified the output file will contain only the number of rows specified. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p> OPTIONAL parameter. If specified the output file will contain only the number of columns specified. This number will become the first dimension of the retreival array. If NOT specified then no maximum. </p></detailed_desc><BR/> </DIV> </LI> <BR/> <LI>[ <B>SQLQuery</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> OPTIONAL parameter. If specified, the file will contain the results of the executed Query. The query is NOT validated by this function. If this is provided, the the DBTableName must be "" </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>delimiter</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> OPTIONAL parameter. If not specified the default ',' seperator will be used. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>DirectoryOut</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> OPTIONAL parameter. If not specified the file will be stored in the default test directory </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>SQLStatus</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A variable which holds the current SQL run status. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>UserID</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> UserID for accessing the Datasource (if required). </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>Password</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Password for accessing the Datasource (if required). </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">C, CopyDBTableToFile, ADBAlias, ATableAlias, Data Source Name (dsn), OutputFileName, tableName, [ColumnCount],[rowCount], [SQLQuery], [Delimiter], [OutputDirectory], sqlStatus, "[UID]", "[PWD]"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> This routine will export the contents of a DBTable to a delimeted file. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> This routine will export the contents of a DBTable to a delimeted file. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_DeleteDBTableRecords' />DDDriverDatabaseCommands::<BIG>DeleteDBTableRecords</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='SDC.GIF' ALT='SAFS Driver Commands'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Deletes records in a database table </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Deletes records in a database table. <p> 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). </p><p> A query condition can be included. 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 &gt; 100000 and CliCat = 'C'".<br> Including "where" in the expression itself is optional. It will be prefixed to the expression if it is not provided. </p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="3" ><LI> <B>ADBAlias</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> not used </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>ATableAlias</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> not used </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>DBTableName</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the TABLE to access within the DBSourceName</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>DBQueryCond</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Expression allowed by the WHERE clause of the DELETE FROM sentence of the SQL driver </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A query condition can be included, if not then "" is supplied. 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 &gt; 100000 and CliCat = 'C'".<br> "where" will be added to any expression if it is not provided. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B>DBSourceName</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the Datasource containing the DBTable </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>UserID</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> UserID for accessing the Datasource (if required). </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>Password</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Password for accessing the Datasource (if required). </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>SQLStatus</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> SQL status code as a result of executing the query gets stored in this variable </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">C, DeleteDBTableRecords, ADBAlias, ATableAlias, Clients, "CID = 25", ContactDatabase, "", "", sqlStatusVar</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Delete the records in the CLIENTS table in CONTACTDATABASE where the CID field = 25. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Delete the records in the CLIENTS table in CONTACTDATABASE where the CID field = 25.<br> No UserID or Password was required for this access. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_ExecSQLQuery' />DDDriverDatabaseCommands::<BIG>ExecSQLQuery</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='SDC.GIF' ALT='SAFS Driver Commands'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Executes the query provided in a queryStr on the database table. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Executes the query in a database table. <p> A data source name 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). </p><p> Use this command with caution. It doesn't return any value back other than the SQL Status code. So, remember not to use 'SELECT' command inside the queryStr. It should rather be used to do an 'UPDATE', 'INSERT' or 'DELETE'. </p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="3" ><LI> <B>ADBAlias</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> not used </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>ATableAlias</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> not used </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>DBSourceName</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the Datasource containing the DBTable </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>queryStr</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Actual query stored in a queryStr. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>SQLStatusCode</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> SQL status code as a result of executing the query. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>UserID</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> UserID for accessing the Datasource (if required). </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>Password</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Password for accessing the Datasource (if required). </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">C, ExecSQLQuery, ADBAlias, ATableAlias, empODBC, "UPDATE Employee Set City = 'Pittsburgh' Where EmpID = '0023' ", sqlStatus</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Executes the query provided in a queryStr against the database specified in the DSN. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Executes the query provided in a queryStr i.e. updates the city column in the Employee table for a EmpID equals to 0023. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_GetDBTableColumnCount' />DDDriverDatabaseCommands::<BIG>GetDBTableColumnCount</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='SDC.GIF' ALT='SAFS Driver Commands'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Executes the query in a specified database table and returns the total column count. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Executes the query in a specified database table and returns the total column count. <p> A data source name 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). </p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="3" ><LI> <B>ADBAlias</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> not used </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>ATableAlias</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> not used </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>DBSourceName</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the Datasource containing the DBTable </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>DBTableName</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the TABLE to access within the DBSourceName </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>ColumnCount</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> SQL result get stored in this return variable. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>SQLStatusCode</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> SQL status code as a result of executing the query. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>UserID</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> UserID for accessing the Datasource (if required). </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>Password</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Password for accessing the Datasource (if required). </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">C, GetDBTableColumnCount, ADBAlias, ATableAlias, empODBC, Employee, columnCount, sqlStatus</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Executes the query for the Table name (Employee) on the database specified in the DSN. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Executes the query for given Table name (Employee) on the database specified in the DSN. And this command returns total column count on the given table and SQL staus code. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_GetDBTableRowCount' />DDDriverDatabaseCommands::<BIG>GetDBTableRowCount</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='SDC.GIF' ALT='SAFS Driver Commands'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Executes the query in a database table. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Executes the query in a database table. <p> A data source name 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). </p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="3" ><LI> <B>ADBAlias</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> not used </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>ATableAlias</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> not used </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>DBSourceName</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the Datasource containing the DBTable </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>DBTableName</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the TABLE to access within the DBSourceName </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>RowCount</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> SQL result get stored in this return variable. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>SQLStatusCode</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> SQL status code as a result of executing the query. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>UserID</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> UserID for accessing the Datasource (if required). </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>Password</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Password for accessing the Datasource (if required). </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">C, GetDBTableRowCount, ADBAlias, ATableAlias, empODBC, Employee, rowCount, sqlStatus</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Executes the query for the Table name (Employee) on the database specified in the DSN. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Executes the query for given Table name (Employee) on the database specified in the DSN. And this command returns total row count on the given table and SQL staus code. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_GetDBValue' />DDDriverDatabaseCommands::<BIG>GetDBValue</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='SDC.GIF' ALT='SAFS Driver Commands'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Executes the query and returns the case-sensitive value as result of the execution. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Executes the query specified in the queryStr and returns the case-sensitive value as result of the execution. <p> To return the value, it executes a SQL query sentence using a data source to connect to the data base (using a 'SELECT'). </p><p> 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). </p><p> 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). </p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="3" ><LI> <B>ADBAlias</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> not used </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>ATableAlias</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> not used </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>DBSourceName</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the Datasource containing the DBTable </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>queryStr</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Actual query stored in a queryStr. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>QueryResult</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> SQL result get stored in this return variable. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>SQLStatusCode</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> SQL status code as a result of executing the query. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>UserID</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> UserID for accessing the Datasource (if required). </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>Password</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Password for accessing the Datasource (if required). </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">C, GetDBValue, ADBAlias, ATableAlias, empODBC, "Select LastName From Employee Where EmpID = '0023'", queryResult, sqlStatus</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Executes the query in the queryStr on the database specified in the DSN. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Executes the query in the queryStr on the database specified in the DSN. And this command returns single value as result of the query execution and SQL staus code. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_SetJdbcDriver' />DDDriverDatabaseCommands::<BIG>SetJdbcDriver</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='SDC.GIF' ALT='SAFS Driver Commands'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> set Jdbc Driver </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> sets a JDBC driver, can be called more than once with multiple drivers. </detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="3" ><LI> <B>DriverClassName</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the driver class </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">C, SetJdbcDriver, "oracle.jdbc.driver.OracleDriver"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> sets driver oracle.jdbc.driver.OracleDriver </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> sets driver oracle.jdbc.driver.OracleDriver using Class.forName </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_VerifyDatabaseNullValue' />DDDriverDatabaseCommands::<BIG>VerifyDatabaseNullValue</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='SDC.GIF' ALT='SAFS Driver Commands'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Verifies the value of a field in a database table is NULL </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Verifies the value of a field in a database table is NULL. <p> 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. </p><p> A table and field name are required. You also have to specify data source name, user id and password (the user id and password can be "" meaning not required). </p><p> A query condition can be included. 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 &gt; 100000 and CliCat = 'C'".<br> Including "where" in the expression itself is optional. It will be prefixed to the expression if it is not provided. </p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="3" ><LI> <B>ADBAlias</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> not used </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>ATableAlias</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> not used </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>DBFieldName</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the FIELD within DBTableName used in the verification </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>DBTableName</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the TABLE to access within the DBSourceName</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>DBQueryCond</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A query condition can be included, if not then "" must be supplied. 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 &gt; 100000 and CliCat = 'C'".<br> "where" will be added to any expression if it is not provided. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B>DBSourceName</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the Datasource containing the DBTable </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>UserID</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> UserID for accessing the Datasource (if required). </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>Password</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Password for accessing the Datasource (if required). </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>SQLStatus</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> SQL status code as a result of executing the query gets stored in this variable </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">C, VerifyDatabaseNullValue, ADBAlias, ATableAlias, LASTNAME, Clients, "CID = 25", ContactDatabase, "", "", sqlStatusVariable</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Verify the LASTNAME field in the CLIENTS table in CONTACTDATABASE is NULL where the CID field = 25. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Verify the LASTNAME field in the CLIENTS table in CONTACTDATABASE is NULL for the first record whose CID field = 25. No UserID or Password was required for this access. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_VerifyDatabaseValue' />DDDriverDatabaseCommands::<BIG>VerifyDatabaseValue</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='SDC.GIF' ALT='SAFS Driver Commands'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Verifies the case-sensitive value of a field in a database table </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Verifies the case-sensitive value of a field in a database table. <p> To return the value, it executes a SQL query sentence using a data source to connect to the data base (using a 'SELECT'). </p><p> A table and field name are required. You also have to specify data source name, user id, password, and the expected value. </p><p> 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). </p><p> A query condition can be included. 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 &gt; 100000 and CliCat = 'C'".<br> Including "where" in the expression itself is optional. It will be prefixed to the expression if it is not provided. </p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="3" ><LI> <B>ADBAlias</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> not used </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>ATableAlias</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> not used </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>DBFieldName</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the FIELD within DBTableName used in the verification </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>DBTableName</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the TABLE to access within the DBSourceName</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>DBQueryCond</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A query condition can be included, if not then "" must be supplied. 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 &gt; 100000 and CliCat = 'C'".<br> "where" will be added to any expression if it is not provided. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B>DBSourceName</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the Datasource containing the DBTable </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>UserID</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> UserID for accessing the Datasource (if required, if not then "" must be supplied). </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>Password</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Password for accessing the Datasource (if required, if not then "" must be supplied). </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>ExpectedValue</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Benchmark value to compare against retrieved DBFieldName value </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>SQLStatus</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> SQL status code as a result of executing the query gets stored in this variable </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">C, VerifyDBValue, ADBAlias, ATableAlias, LASTNAME, Clients, "CID = 25", ContactDatabase, "", "", "Smith", sqlStatusVariable</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Verify the LASTNAME field in the CLIENTS table in CONTACTDATABASE contains "Smith" where the CID field = 25. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Verify the LASTNAME field in the CLIENTS table in CONTACTDATABASE contains "Smith" for the first record whose CID field = 25. No UserID or Password was required for this access. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_VerifyDBNullValue' />DDDriverDatabaseCommands::<BIG>VerifyDBNullValue</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='SDC.GIF' ALT='SAFS Driver Commands'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Verifies the value of a field in a database table is NULL </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Verifies the value of a field in a database table is NULL. <p> 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. </p><p> A table and field name are required. You also have to specify data source name, user id and password (the user id and password can be "" meaning not required). </p><p> A query condition can be included. 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 &gt; 100000 and CliCat = 'C'".<br> Including "where" in the expression itself is optional. It will be prefixed to the expression if it is not provided. </p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="3" ><LI> <B>ADBAlias</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> not used </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>ATableAlias</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> not used </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>DBFieldName</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the FIELD within DBTableName used in the verification </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>DBTableName</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the TABLE to access within the DBSourceName</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>DBQueryCond</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A query condition can be included, if not then "" must be supplied. 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 &gt; 100000 and CliCat = 'C'".<br> "where" will be added to any expression if it is not provided. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B>DBSourceName</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the Datasource containing the DBTable </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>UserID</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> UserID for accessing the Datasource (if required). </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>Password</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Password for accessing the Datasource (if required). </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>SQLStatus</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> SQL status code as a result of executing the query gets stored in this variable </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">C, VerifyDBNullValue, ADBAlias, ATableAlias, LASTNAME, Clients, "CID = 25", ContactDatabase, "", "", sqlStatusVariable</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Verify the LASTNAME field in the CLIENTS table in CONTACTDATABASE is NULL where the CID field = 25. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Verify the LASTNAME field in the CLIENTS table in CONTACTDATABASE is NULL for the first record whose CID field = 25. No UserID or Password was required for this access. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_VerifyDBValue' />DDDriverDatabaseCommands::<BIG>VerifyDBValue</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='SDC.GIF' ALT='SAFS Driver Commands'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Verifies the case-sensitive value of a field in a database table </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Verifies the case-sensitive value of a field in a database table. <p> To return the value, it executes a SQL query sentence using a data source to connect to the data base (using a 'SELECT'). </p><p> A table and field name are required. You also have to specify data source name, user id, password, and the expected value. </p><p> 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). </p><p> A query condition can be included. 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 &gt; 100000 and CliCat = 'C'".<br> Including "where" in the expression itself is optional. It will be prefixed to the expression if it is not provided. </p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="3" ><LI> <B>ADBAlias</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> not used </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>ATableAlias</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> not used </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>DBFieldName</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the FIELD within DBTableName used in the verification </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>DBTableName</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the TABLE to access within the DBSourceName</short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>DBQueryCond</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A query condition can be included, if not then "" must be supplied. 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 &gt; 100000 and CliCat = 'C'".<br> "where" will be added to any expression if it is not provided. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B>DBSourceName</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the Datasource containing the DBTable </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>UserID</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> UserID for accessing the Datasource (if required, if not then "" must be supplied). </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>Password</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Password for accessing the Datasource (if required, if not then "" must be supplied). </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B>ExpectedValue</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Benchmark value to compare against retrieved DBFieldName value </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI>[ <B>SQLStatus</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> SQL status code as a result of executing the query gets stored in this variable </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">C, VerifyDBValue, ADBAlias, ATableAlias, LASTNAME, Clients, "CID = 25", ContactDatabase, "", "", "Smith", sqlStatusVariable</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Verify the LASTNAME field in the CLIENTS table in CONTACTDATABASE contains "Smith" where the CID field = 25. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Verify the LASTNAME field in the CLIENTS table in CONTACTDATABASE contains "Smith" for the first record whose CID field = 25. No UserID or Password was required for this access. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> </DIV> </BODY> </HTML>