SQLData object database configuration

Use the Database tab to configure the SQL Server database path and authentication details that the SQLData object will use when connecting to the database at configuration and runtime.

The SQLData object is configured to connect to a single SQL Server database table. The object supports network browsing to the database server, selecting the database and subsequently locating the appropriate table. The object supports network browsing to locate the database table. Changing the table information automatically results in a disconnection from the database. The table definition is retained during disconnection to enable cloning of the database from the definition already loaded.

If the database or table does not exist on the selected node, the object will create the database and database table when you enter a valid table definition and click the Create Database button on the Design tab, or when the object is deployed.

You can configure the SQLData object to use one of three authentication modes: Windows Integrated Security, Windows Account, or SQL Server Authentication. For more information, see SQLData object authentication modes.

As a database connection may not always be required when configuring the object in the IDE, a Test Connection button has been provided.

All errors associated with connecting to the database are sent to the logger.

Options are as follows. For more information about the attribute associated with each option, click the attribute link in parentheses.

Database Server Name (DBServerName attribute)

The name of the SQL Server on which the database resides. To select from a list of all available nodes on the network, click the ellipsis button. Named server instances are not supported.

Database Name (DBName attribute)

The name of the database that is used to store tables. The list includes all of the databases available for the selected node.

Port Number

The TCP/IP port number that the SQL Server uses. If you are using the default SQL Server port (1433), this field can remain empty.

Table Name (DBTableName attribute)

The name of the table in the database. The list includes all of the user tables available for the selected database.

Authentication Mode (AuthenticationMode attribute)

The authentication mode that will be used to connect to the database. Available options are Windows Integrated Security, Windows Account, or SQL Server Authentication. For more information, see SQLData object authentication modes.

If you select Windows Integrated Security, ArchestrA user details are used to connect to the database. If you select Windows Account, the Windows user account details in the object are used to connect to the database. The Domain, Username, and Password options will become available. If you select SQL Server Authentication, the SQL Server user account details in the object are used to connect to the database. The Username and Password options will become available.

Domain

The user authentication domain name for runtime and configuration-time SQL Server access.

Username

The user authentication username for runtime and configuration-time SQL Server access.

Password

The user authentication password for runtime and configuration-time SQL Server access.

Open Database in Read-Only Mode (DBReadOnly attribute)

If enabled, only read-only access from the SQL Server database will be allowed. The SQLData object will not be able to modify either the database schema or the data.

Use Database View

Toggles between database view and table view.

Table Name/View Name

Select the table name or view name, depending on your Use Database View selection

Test Connection

Used to test the object’s connection to the database at configuration time. (There is no impact on runtime.)