Common Configuration Settings

The process of configuring a data source may seem overly complex, therefore you should take time to gather the information needed for each data source that you are configuring.

The Data Source Configuration Tool attempts to automatically gather and validate as many configuration values as it can. It does this by interrogating the data source’s (that is, OpenWorks, and Kingdom) setup files after you have entered the configuration name and the install directory location for the data source. During the configuration of different data sources the configuration tool provides feedback information and hints in the form of helper icons.

Each data source type requires a different set of configuration information. However, many of the settings are for similar types of information. A standard set of data entry fields and icons are used in the configuration panels for all of the data source types. The helper icons and their descriptions are as follows:

FileSelectorIcon.gif

File Selector : pressing this icon opens a file select dialog, which is used to set directory locations and pick file location. Ex. Selecting the Openworks install directory.

VerificationIcon.gif

Verification Indicator: this icon indicates that the Configuration Tool was able to verify the input value. This verification can be related to:
  • File or directory location

  • Project data source Oracle connection information is correct

  • OpenSpirit query account is accessible via account name/password

ErrorIcon.gif

ErrorBackgroundSample.gif

Non-Verification Indicator: this icon indicates that the Configuration Tool could not verify the input value. Also, the background color of the value input colored light red as a further indication. Pressing this icon opens an information dialog that informs you of the reasons that the value could not be verified.

NOTE: The Tool attempts to verify all entries, but in some environments (even when the values are known to be correct) the verification could fail. Therefore, you have the ability to save the configuration even with non-verified values.

DropdownIcon.gif

Dropdown Selector: when pressed, this icon presents you with a list of values to select from. The values in the list are determined by the configuration parameter that you are selecting. They are:
  1. If you are selecting a directory/file location the list is populated with all the previously selected locations.

  2. If you are selecting an Oracle parameter (that is, OWSYSSID and TWO_TASK), then the list is populated with all the Oracle

    Instances found after parsing the tnsnames.ora file.

BuilderIcon.gif

Builder: pressing this icon brings up dialogs to help you configure the following:
  1. URL Builder: this Builder is associated with the DB URL value. The Builder creates a URL to facilitate connection to the project data source’s (OpenWorks, Studio, and so on) Oracle or SQL Server database. This URL tells OpenSpirit where to find the project databases it needs to access.

  2. Query Account Builder: this Builder is associated with the Query Account values. The Builder is used to create a database account in the project data source’s database. This query account is typically used by OpenSpirit to access the names of available projects.

Add a row (Project Catalog builder only)

Delete arow(ProjectCatalogbuilderonly)

Database URL Builder

The database URL dialog is used to enter information used to connect to an Oracle or SQL Server database.

Name

Description

Hints & Finding Values

Provider

The type of database provider, Oracle, or SQL Server.

Ask your database administrator.

Oracle Provider

SID/ServiceName

Choose to use an Oracle SID or an Oracle service name. Enter the SID or Service Name of the data source's Oracle instance.

The SID and service names can be found in your tnsname.ora file.

Host

The host name of the computer running the data source's Oracle instance.

Located in the tnsname.ora file. This can either be the machine name or its IP address.

Port

The Oracle listener port number.

The listener port can be found in your tnsname.ora file. The default Oracle port number is 1521.

Custom DB URL

Select the Custom Editor option to enter custom database URLs such as URLs needed to support Oracle RAC. The Custom DB URL field is enabled by selecting the Custom Editor option.

Use of the custom field requires expertise in JDBC URL syntax. Only used this field when instructed by OpenSpirit support.

SQL Server Provider

Host

The host name of the computer running the data source's SQL Server instance.

Ask your local database administrator.

Instance

The instance name of the data source's SQL Server database. Leave this field blank if the database is in the default SQL Server instance.

Ask your local database administrator.

Port

The port number of your SQL Server database instance.

Ask your local database administrator. The default SQL Server port number is 1433.

Database Name

The name of the database within the SQL Server instance. This can often be left blank if the account used to access the database has the correct database as its default database.

Ask your local database administrator.

Custom DB URL

Select the Custom Editor option to enter custom database URLs. The Custom DB URL field is enabled by selecting the Custom Editor option.

Use of the custom field requires expertise in JDBC URL syntax. Only used this field when instructed by OpenSpirit support.

Database Query Account Builder

The database query account builder dialog is used to create a database account to be used to access OpenWorks project information. The dialog is provided as a convenience. Most companies choose to create the query account using Oracle tools rather than this OpenSpirit query account builder.

QueryAccountDialog.jpg

Name

Description

Hints & Finding Values

DBA Account

Oracle account with permissions to create Oracle accounts.

This needs to be a DBA privileged account that used to create the query account. OpenSpirit does not store this DBA account and password anywhere. It is only used to create the query account when the Ok button is pressed.

DBA Password

Password to the Oracle account.

New Account

The name of the new Oracle query account to be created.

This account only requires connect privilege to the project data source of the Oracle database because the accessed tables have public read access. See the help for a specific data source type for more details about the use of the query account.

This account name and encrypted passwordbe stored in the OpenSpirit metadata repository.

New Password

The password to be assigned to the new Oracle query account.

Verify Password

Repeat the password to avoid typing errors.