Getting Started

The Data Source Configuration tool is accessed from the OpenSpirit Desktop by clicking the Data Source Configuration tool bar icon DataSourceConfigurationIcon.gifor by choosing the Tools > Administrator > Data Source Configuration menu item.

The Data Source Configuration tool is platform aware, and configures data sources that run on the platform’s operating system that the tool was started from. The supported platforms for each data source type are listed in the Data Source Details section of this guide.

Some data source types can be configured as private data sources. Private data sources are only visible to the user that configures a private data source. Public data sources are visible to all OpenSpirit users. Be logged in as the OpenSpirit administrator in order to create, edit, or delete public data source configurations.

Tip: Private data sources are supported by data sources that store data on local PC drives. For example, Kingdom or Petra projects that are stored on a local PC drive and are only accessible to a single Windows account.

The Data Source Configuration tool opens in read-only mode when it is run using an account that does not have the Administer OpenSpirit Runtime user right. This gives users the ability to view the various data source configurations. In this mode you can also configure private Windows based data sources, for example Kingdom projects you have local on your Window’s C drive.

Data Source Configuration Tool Layout

The tool’s interface is divided into two sections: the Data Sources Panel on the left-hand side and the data source Attribute Panel on the right-hand side.

DataSourceConfigurationView.jpg

The Data Sources Panel presents a tree of data sources organized by data source type and version. Configured public data sources appear in the tree with a cylinder icon PublicDataSourceIcon.gif next to the data source name. Configured private data sources appear in the tree using a cylinder icon containing a person PrivateDataSourceIcon.gif.

Tip: Data connectors that have been disabled using the OpenSpirit Install Config Manager not appear in the Data Sources tree.

Selecting a configured data source in the tree results in display of an Attribute Panel on the right-hand side of the Data Source Configuration tool. The data source's attributes can then be viewed. The attributes may also be edited if you have permissions to administer the selected data source.

Creating New Data Sources

New data sources are added to the tree by selecting the data source type and version node in the tree and clicking the create data source icon CreateDataSourceIcon.gif in the tool bar or selecting the create option in the right mouse button popup menu. This displays the New Data Source dialog where you enter the name to be given to the new data source, an optional description of the data source. Note, the data source description cannot be changed once the data source has been created. Use the data source copy feature to change the description.

A public data source is created if the Data Source Configuration tool is running in admin mode. A private data source is created if the Data Source Configuration tool is not running in admin mode. Running the OpenSpirit Desktop using the OpenSpirit administrator account (that is, the account used to install the OpenSpirit master installation) automatically runs the tool in admin mode. Admin mode is not enabled by default when running the OpenSpirit Desktop using any other account. Admin mode can be toggled on and off using the Tools > Administrator > Toggle Admin Mode menu option if you know the OpenSpirit administrator password or if your OpenSpirit account has been granted the Administer OpenSpirit Runtime right.

NewDataSourceDialog.jpg

An Attribute Panel is then displayed on the right-hand side of the Data Source Configuration tool. Enter all the required information and click the save icon SaveIcon.gif in the tool bar. The information that is required varies by type and version of the data source.

Data sources can be copied by selecting a data source in the tree and clicking the copy icon CopyIcon.gif in the tool bar or selecting the copy option in the right mouse button popup window.

Data sources can be renamed by selecting a data source in the tree and clicking the rename icon RenameIcon.gif in the tool bar or selecting the copy option in the right mouse button popup window.

Data sources are deleted by selecting a data source in the tree and clicking the delete icon DeleteIcon.gif in the tool bar or selecting the delete option in the right mouse button popup menu.

When you delete a data source, a confirmation dialog opens that lists the sessions that include this data source. Proceeding with the deletion removes the deleted data source from all associated sessions.

Note: Keep in mind that the data source may also be referenced by OpenSpirit Copy Manager jobs, Scan Utility jobs, and by data keys saved in scan data sets and application projects, such as Petrel projects.

Unsaved attribute value edits can be restored to the currently saved state by pressing the refresh icon RefreshIcon.gif in the tool bar.