External Data Sets - WorkView - Foundation 24.1 - Foundation 24.1 - Ready - OnBase - Premier - external - Premier

WorkView

Platform
OnBase
Product
WorkView
Release
Foundation 24.1
License
Premier

You can create external data sets that are available for attributes. External data sets pull values from an external database into WorkView. To create an external data set:

  1. In the WorkView ribbon, in the General ribbon group, click Data Sets. The Data Sets dialog box is displayed.
  2. Click Add and select External Data Set. The External Data Set Configuration dialog box is displayed.

The following fields make up this screen:

Field

Description

Name

Name used for data set.

Local or Linked Server

Select this option if the OnBase Studio is on the same server as the database you want to connect to and you are able to connect directly to the server on which the external database resides. This option is the preferred method of connecting to a database and provides greater functionality between the two options.

Server

Enabled when the Local or Linked Server option is selected. This specifies either the local or linked server. Select Local database for a local database and select Database for a linked database.

Note:

The Local database option is not supported in Oracle databases.

Database

Enabled when the Local or Linked Server option is selected. This field should contain the name of the database to which WorkView will connect. Depending on the type of database, this field may be blank.

Database names with spaces for external data sets are allowed when used in conjunction with square brackets. Example: [Database Name]

Note:

This field is limited to 60 characters.

ODBC Connection

Select this option when you want to connect to a database via an ODBC connection. This option does not allow sorting or filter criteria to be utilized using the associated external class.

Note:

It is recommended that if you do not require modification to an external class, the User Name and Password provided for the connection should have read-only access.

Note:

If a password contains special characters, those characters will need to be escaped in order to log in successfully. The method to escape characters varies by database type. As an example, if an account associated with a SQL Server database has a special character, like pass;word, the password would need to be enclosed in {}: {pass;word}.

Data Source

Enabled when the ODBC Connection option is selected. This drop-down list displays all of the configured ODBC connections on the workstation. Select the appropriate ODBC source to connect to the appropriate database.

User Name

Enabled when the ODBC Connection option is selected. This field should contain the username for the database used during ODBC source configuration.

CAUTION: It is recommended you leverage a user account with the least amount of privilege as possible as it will limit potential risk.

Password

Enabled when the ODBC Connection option is selected. This field should contain the correct password associated with the username entered in the Username field.

Note:

This field is limited to 63 characters.

Table Name

This field should contain the name of the table from which you want to pull information.

Column Name

This fields should contain the name of the column within the specified table that contains the values you want to use in the data set.

Cache Items

When this option is selected, values pulled from the external database will be cached on the server for faster data set value access on the client side.

CAUTION:

Values will remain cached until IIS is restarted or the application pool is recycled on the server; therefore, when this option is selected, immediate changes to values in the external database will not be reflected in the client until the IIS is restarted or the application pool is recycled on the server.

Sort

When None is selected, there is no sort order defined for the data set.

When Ascending is selected, the sort order is set to sort in ascending order (examples: A-Z and 1-10).

When Descending is selected, the sort order is set to sort in descending order (examples: Z-A and 10-1).

Test Connection

When this button is clicked, the connection to the database configured is tested and if the connection is successful, the values found in the specified column are displayed in a Connection successful dialog box.