ReadODBCDataSource

Read ODBC Data Source

Related Topics

Definition

Use this command to read a value from an ODBC data source.

The ODBC data source does not need to already exist on all workstations where you want to execute the command ReadODBCDataSource; during execution of an installation package, the data source will be created at runtime. However, you need to install the respective ODBC driver on all required workstations.
The version of the driver installed on the administrator's workstation does not need to be the same as the driver installed on the other workstations (that will call the command ReadODBCDataSource). Please make sure that the driver works correctly on the required workstations.

Settings

Input

• Data source
  Select the name of the data source from a list. The ReadODBCDataSource command automatically creates this data source on client workstations.
  Make sure that the data source is already available on the administrator's workstation. You cannot create a new data source with the ReadODBCDataSource command. This needs to be done on the Control Panel. However, you can configure the existing data sources in this dialog (see below).
• ODBC Driver
  After selecting the data source, this text box displays the name of the ODBC driver.
• User name and Password
  If the database is password protected, you must specify the user name and password (during logon) that will be used when executing the command ReadODBCDataSource.
• Table name
  This text box displays the name of the table from which the data will be read. Click the Browse button (...) to display a list of all tables contained in the selected data source.

  Make sure to fill in the User name and Password text box!

• Index name
  Table data is usually structured by a unique index (primary key). Click the Browse button next to the text box to select the index from a list of all fields in the selected table. If this index is not unique, the command ReadODBCDataSource returns only the first entry of the result. (This is usually the entry first inserted in the database.)
• Index value
  Enter the value you want to search the index for. The record found must match the value in the selected table column. If you have not selected a unique index you will get an incorrect result. In this case, only the first entry will be returned.
• Name of the requested column
  You must specify the name of the column you want to read from the ODBC data source containing the field to be read. The field contents of the selected column will be returned by the command ReadODBCDataSource (on the basis of the previously found record) and stored in the selected variable.
• Variable name for requested value
  Enter the variable where you want to store the result (i.e. the field contents). You can continue using this variable for any other command (like other variables).
• Properties
  The read-only memo box shows the properties of the selected ODBC data source. Click Edit to change the properties

Buttons

• Configure
  Click the Configure button to configure the data source. Depending on the selected data source, the respective dialog box will be displayed (for further information on ODBC, please refer to: Control Panel > ODBC)
  You can configure each driver in a separate dialog box originating from an ODBC driver's DLL. The driver-specific data source setup dialog box enables you to reconfigure the data source.
  You should only specify UNC paths here. If you use network drives in path specifications, please make sure that the paths are the same for all client workstations.
• Edit
  See Input > Properties.