The EIQ Server Configuration Tool is a client administration tool that helps admins configure and manage EIQ Product servers locally or via a network.

The EIQ Server Configuration Tool includes features to:

1) Connect to EIQ Product servers (either locally or across networks).

2) configure EIQ Product servers; including EIQ SuperAdapter, EIQ TurboAdapter, EIQ ConventionalAdapter, and EIQ Federation Server configurations.

3) Manage metadata dictionaries using standard data models.

4) Register data sources.

5) Attach multiple data sources (Attach Mode).

6) Configure entities for Link Indexing.

7) Initiate Link Indexing.

8) Set advanced server settings.

9) Monitor and manage connection pooling and client sessions.

10) Manage users and user roles.

Launching the EIQ Server Configuration Tool

Start the EIQ Server Configuration Tool and connect to the EIQ Server by entering the EIQ Server address and user credentials.

Note: Make sure the EIQ Product Server is running.

EIQ Server Configuration Tool Features

The EIQ Server Configuration Tool has various tabs. Each of the tabs and their main functionality is described below:

EIQ Virtual Data Sources Tab

The' EIQ Server Virtual Data Sources' tab provides functionality for viewing existing Virtual Data Sources, creating new ones, or editing and deleting existing ones. For a description of the concepts behind VDSs and virtual schema views, see EIQ Product Server Introduction.

The tab also allows users to create and edit the standard data model used by VDSs through the 'Edit Metadata Dictionary' button.

Metadata Dictionary

The Metadata dictionary holds the standard data model information needed for building virtual schema views. Virtual schema views hide data source specific column names and data types from clients. In virtual schema views, columns from a standard data model are mapped against data source specific columns containing corresponding data through a SuperSchema mapping. See the 'SuperSchema Mapping' Tab section below for more details regarding mapping.

Standard data models provide the following functions:

· Assign a commonly understood meaning to columns (semantic mapping). For example, a column named 'esal' may not mean much to someone unfamiliar with the data source. When it is mapped to a standard data model column named 'Employee Salary', it becomes much more meaningful.

· A data type definition. They define the data in more commonly understood terms.

· A data format definition. They define the format in which the data should be returned for the column.

The National Information Exchange Model (NIEM), HL7, FHIR and eXtensible Business Reporting Language (XBRL) are examples of standard data models.

The 'Edit Metadata Dictionary' button opens a dialog with the list of columns from a standard data model and their data type details. Users can add, delete, or edit items in the list. They can also import a standard data model from an existing CSV formatted file on the file system or export the list to a file.

A standard data model can be imported in two ways:

1) through the 'Import' feature in the 'Metadata Dictionary' dialog

2) by replacing the default STANDARDNAMES.CSV (comma delimited) file under '\WhamTech\Settings\EIQConfig\' folder in the install path before starting the EIQ Server service for the first time.

Supported data types for these columns include: BIGINT, CHAR, DATE, FLOAT, INT, REAL, SMALLINT, TIME, and TIMESTAMP. The lengths of the data types are generally predetermined and cannot be modified. The CHAR data type length is variable and accommodates up to 256 characters in length.

Defining a New Virtual Data Source

To define a new Virtual Data Source, click "Define New". This opens a dialog for configuring a VDS.

Name:

The name of the virtual data source. This name will be given to the clients in a list of available data sources at this EIQ Product server.

Views:

Every VDS comes with a single default view called 'MyTable' that contains all the columns in the metadata dictionary. This provides a flat schema interface to clients. Optionally, users can create an additional view for limiting the number of columns to only a selected subset of the standard data model.

Data Source - EIQ Index Pairs:

For EIQ SuperAdapter, EIQ TurboAdapter, and EIQ ConventionalAdapter configurations, the data source is paired with a corresponding EIQ Index (in the case of EIQ ConventionalAdapter, EIQ ConventionalAdapter Indexes). The pairing notifies the server to execute queries on the EIQ Indexes and go to the corresponding data source only for retrieving results. For EIQ ConventionalAdapters, EIQ ConventionalAdapter Indexes provide data source schema information and any transforms that need to be applied on the results.

Users click 'Add', select the data source from the combo list (or click 'Register new' to add a new data source), browse by clicking 'Browse', and select the corresponding EIQ Indexes for the data sources.

Note: The data source needs to be registered first as described under the Data Sources tab below.

In an EIQ ConventionalAdapter configuration, users must select the "Passthrough command" checkbox so queries can be passed directly to the data source for execution.

For EIQ Federation Server configurations, there is no pairing needed. However, the remote data sources need to be added for a VDS through the same 'Data Source - EIQ Index Pair' dialog. In this case, only a remote data source is selected.

Attaching multiple EIQ Indexes:

In some special cases, users can configure an EIQ SuperAdapter or EIQ TurboAdapter by adding more than one 'Data Source - EIQ Index' pair under a single VDS. Then, they can attach the EIQ Indexes in order to execute queries across the data sources while using local EIQ Indexes for faster execution. The VDS can then be queried as if querying a single data source. For an EIQ TurboAdapter, no SuperSchema mapping is required and clients use data source schema names. For EIQ SuperAdapters, the 'Attach' column name mapping feature under the ‘SuperSchema Mapping’ tab allows users to map standard data model column names for the attached data sources and clients use virtual schema view.

Before they can configure 'Attach', users must first configure a Virtual Data Source with two 'Data Source - EIQ Index' pairs. Then, they need to select one of the 'Data Source - EIQ Index' pairs and click 'Attach'. This will open the 'Configure Attach' dialog.

This dialog provides the following 'Attach' functionalities:

Selecting one of the data sources as the main data source.
Viewing the main data source tables.
Viewing and attaching the tables belonging to the other data sources to the main data source.
Editing the attached table names for providing alias names.

Viewing Index Properties:

Users can view EIQ Index details at any time after configuration by clicking 'View Index'.

SuperSchema Mapping Tab

Standard data model column mapping

Users can map standard data columns to data source columns using a SuperSchema mapping.

In the left pane, users can expand the Virtual Data Source tree hierarchy and select any registered data source name to map standard data model names. The column details for this data source are shown in the right pane.

Users can select and double-click on the data source column or right-click and select 'Edit'. A dialog opens where users can select the corresponding standard data model name from the 'Metadata Column Name' list.

Note: The 'Metadata Column Name' list is dynamically adjusted to display only the standard data model column names that match the selected data source column type.

SuperSchema Mapping for EIQ SuperAdapter VDS with 'Attach' Configuration

For EIQ SuperAdapter VDSs with attached data sources, under the ‘SuperSchema Mapping’ tab a special 'ATTACH' node provides facilities for mapping standard data model column names to the attached data source columns.

Entity Configuration

Admins can define the entities used in Link Indexing by clicking 'Edit Entity Data' at the bottom of the 'SuperSchema Mapping' tab. This opens the 'Edit Entities' dialog which provides features for adding, deleting, and modifying entities.

Entities consist of attributes as represented by standard data model column names listed under the Metadata Dictionary. For example, an 'Address' entity is a combination of city, state, and street attributes (as represented by the 'CITY', 'STATE', and 'STREET' columns below).

Building Link Indexes

EIQ Federation Server admins can build Link Indexes for a VDS that federates one or more EIQ SuperAdapter VDSs by clicking 'Build Link Index' at the bottom of the 'SuperSchema Mapping' tab. This button is disabled unless users select 'Show entity mapping'.

See Link Indexes Help for more details.

TurboAdapter Alias Mapping Tab

For EIQ TurboAdapter configurations, under the 'TurboAdapter Alias Mapping' tab admins may assign alias names for tables and columns in order to provide more meaningful names to users.

Expand the tree node on the left for a VDS data source and double-click on a table name in the right pane to enter an alias name in the 'Assign Table Alias' dialog.

Similarly, expand the tables on the left and double-click a column name in the right pane to enter an alias name in the 'Assign Column Alias' dialog.

Data Sources Tab

Admins use the 'Data Sources' tab to register data sources requiring access through EIQ Products. Registered data sources can either be third-party data sources (Oracle, SQL Server, etc.) or other instances of EIQ Product Servers (EIQ Federation Server, EIQ SuperAdapter, EIQ TurboAdapter, and EIQ ConventionalAdapter). Users can view all registered data sources, add a new data source and test the connections, and edit or delete an existing registered data source.

Registering a data source

Users register a data source by clicking 'Add Data Source'. It opens the 'Data Source Registration' dialog containing the following entry fields:

Alias	This name is unique and is used by the EIQ Product server for this data source. (Required)
ID	This is a data source ID which is unique and specific to the data source.
Data Source Type	The connection driver for the data source. The supported types are: ODBC - Any data source that supports ODBC connections DB2 - For IBM DB2 data sources (data source connections will be through DB2 native client driver) ORACLE - For Oracle data sources (data source connections will be through Oracle native client driver (CLI)) DOCUMENTS - For special data source built through EIQ Server RTI Tool for searching documents on a file system. THUNDERBOLT - For special data sources built through EIQ Server RTI Tool (Native EIQ Non-Virtual Indexes)
Data Source Name	The data source system specific name for the data source. For ODBC connections, this is the data source name (DSN) listed under ODBC Data Source Administrator (see ODBC administration documentation for more details). For ORACLE connections, this is the name of TNS service name (see ORACLE administration documentation for more details).
Connect String	Data source system specific connection string. Not required for ODBC, THUNDERBOLT and DOCUMENTS types.
User Name	If login credentials are required for connecting to the data source, use the user name for the data source system.
Password	If login credentials are required for connecting to the data source, use the password for the data source system.
Schema Name	If the data source requires the schema name in queries, the EIQ Server system will use this value to automatically format SQL commands to the data source accordingly. Oracle data sources require schema name.

Using the 'Test Connection' button verifies that the connection to the data source is working properly.

Registering a remote EIQ Product server data source:

EIQ Federation Servers provide a single interface for accessing multiple data sources. In a typical EIQ Federation Server configuration, multiple data sources belonging to remote EIQ SuperAdapters are registered for access through a VDS. Users can register a remote EIQ Product server's data source by clicking 'Add Remote Server Data Source'. It opens the 'Remote Server Data Source Registration' dialog containing the following entry fields:

Alias	This name is unique and is used by the EIQ Product server for this data source. (Required)
Remote Server Address	The machine name or IP address where the remote EIQ Product server resides.
Remote Data Source	The data source name as registered with the remote server.
User Name	Login username required for connecting to the remote EIQ Product server.
Password	Login password required for connecting to the remote EIQ Product server.

Advanced Settings Tab

The 'Advanced Settings' tab provides admins with various options to modify the server behavior. They can select and double-click on any of the items for editing (or select and click 'Change').

A detailed description of each of the settings is provided in the dialog for that setting.

Management Tab

The EIQ Server Configuration Tool provides features for admins to monitor and manage various EIQ Product server resources such as:

Connection pools for registered data sources and EIQ Indexes.
Virtual Data Sources.
Client sessions and active statements.

The management functions include taking any selected VDS, registered data source, or EIQ Index online or offline for maintenance operations. Apart from the above resources, admins can also manage users and user privileges. Admins can view the resources (Connection Pool and Virtual Data Sources), client sessions, and users by expanding the tree in the left panel.

Monitoring Resource Usage:

If users select a resource (EIQ Indexes or Data Sources under Connection Pool tree item) node in the left pane, the right pane shows the details. The 'Available' column shows the number of idle connections in the connection pool that are available for the selected resource. The 'Acquired' column shows the number of connections currently in use.

Taking resources Offline and bringing back Online

To make changes to existing EIQ Indexes or to take backups, admins must disconnect any open connections, take indexes offline, and then bring them back online. Similarly, they may take down VDSs and data sources to make configuration changes and bring them back online. An example is when accessing Mainframe Data Files through the WhamTech MDF ODBC Driver. If changes are to be made to the MDF DSN configuration XML file, then the MDF data source must be taken offline first.

Note: Before taking EIQ Indexes or data sources offline, the corresponding VDS must be taken offline.

Taking resources offline:

From the tree in the left pane, admins can select a resource folder (Virtual Data Sources, Connection Pool->EIQ Indexes, Connection Pool->Data Sources). In the right pane, from the list of available resources, admins can select a resource to bring down by right-clicking the desired node and selecting 'Take Offline' from the menu.

If there is a connection in use for the selected EIQ Index, a dialog opens asking whether the user would like to proceed with the 'Take offline' action or not. If the user clicks 'Yes', it will take the index offline. This action might affect client sessions that are still using the index. For example, it may terminate results-retrieval for a query that was being processed.

If the user clicks 'No', no action will be taken.

Taking resources online:

Similarly, admins can bring resources back online by right-clicking the resource and clicking 'Bring Online’.

Note: Before bringing VDSs online, the corresponding EIQ Indexes and data sources need to be brought online.

Monitoring Client Sessions

Users can view a list of all client connections to the server by selecting the 'Client Sessions' folder in the left pane tree. In the right pane, for each connection, information such as the Username, Data Source, status of the connection, IP Address of the client machine, and login time is displayed.

Managing Users

Admins can manage users, user credentials, and user access roles by selecting the 'Users' tree node. From here, they can view all existing users, add a new user, delete an existing user, and modify user roles.

EIQ Product servers come with these pre-configured user roles: public, eiqdeveloper, eiqdataanalyst and eiqadmin. These roles restrict user access to certain types of EIQ Product Suite tools. For more information on access control, see EIQ Data Security and Access Control.

By selecting a specific user node from the tree, they can also view the details of any connections from that user.

EIQ Product Server Configurations

The following section gives an outline of major steps required for various EIQ Product Server configurations.

Configuring EIQ Server as EIQ SuperAdapter

Using the EIQ Server RTI Tool:

i. Build indexes for a data source.

ii. Optionally, apply data transforms and data cleansing.

Using the EIQ Server Configuration Tool:

i. Register the data source with the EIQ Server.

ii. Create a VDS.

iii. Pair the data source with corresponding EIQ Indexes.

iv. Map standard data model column names to data source columns using a SuperSchema mapping.

EIQ Update Server Configuration Tool (Optional):

i. Setup update tasks for updating EIQ Indexes for the data source.

Clients: Connect to EIQ Server and select the VDS (E.g.: from EIQ Server Query Tool).

Configuring EIQ Server as EIQ ConventionalAdapter

Using the EIQ Server RTI Tool:

i. Build EIQ ConventionalAdapter Indexes for a data source. EIQ ConventionalAdapter Indexes are special indexes that contain only the metadata information for the data source and any transforms on results.

ii. Optionally, apply data transforms.

Using the EIQ Server Configuration Tool:

i. Register the data source with the EIQ Server.

ii. Create a VDS.

iii. Pair the data source with corresponding EIQ ConventionalAdapter Indexes.

iv. Map standard data model column names to data source columns using a SuperSchema mapping.

Clients: Connect to EIQ Server and select the VDS (e.g. from EIQ Server Query Tool).

Configuring EIQ Server as EIQ TurboAdapter

Using the EIQ Server RTI Tool:

i. Build EIQ Indexes for the data source.

ii. Optionally, apply data transforms and data cleansing

Using the EIQ Server Configuration Tool:

i. Register the data source with the EIQ Server.

ii. Create a VDS.

iii. Pair the data source with EIQ Indexes.

iv. Optionally, provide aliases for table and column names.

EIQ Update Configuration Tool (Optional):

i. Setup update tasks for updating EIQ Indexes for the data source.

Clients: Connect to EIQ Server using 'TurboAdapter' connection option and select the VDS (E.g.: from EIQ Server Query Tool).

Configuring EIQ Server as EIQ Federation Server

Using the EIQ Server Configuration Tool:

i. Register Virtual Data Sources (VDS) from other EIQ SuperAdapters and EIQ Adapters as data sources with the EIQ Server.

ii. Create a new VDS.

iii. Select one or more registered data sources of "Remote EIQ Server" type (typically EIQ SuperAdapter VDSs).

iv. Optionally, define entities for Link Indexing, and

v. Initiate Link Index build process.

Clients: Connect to EIQ Server and select the VDS (E.g.: from EIQ Server Query Tool)

'Attach' for EIQ SuperAdapter Configuration

Using the EIQ Server RTI Tool:

i. Build EIQ Indexes for two or more data sources.

ii. Optionally, apply data transforms and data cleansing

Using the EIQ Server Configuration Tool:

i. Register the data sources

ii. Create a new VDS.

iii. Pair the data sources with their corresponding EIQ Indexes - both under the same VDS.

iv. Attach the EIQ Indexes.

v. Map standard data model column names to data source columns with 'Attached' tables using a SuperSchema mapping.

Clients: Connect to EIQ Server using 'Attach' with the 'SchemaInterface=StandardDataModelWithAttach' option and select the VDS (E.g.: from EIQ Server Query Tool)

'Attach' for EIQ TurboAdapter Configuration

Using the EIQ Server RTI Tool:

i. Build EIQ Indexes for two or more data sources.

ii. Optionally, apply data transforms and data cleansing

Using the EIQ Server Configuration Tool:

iii. Register the data sources

iv. Create a new VDS.

v. Pair the data sources with their corresponding EIQ Indexes - both under the same VDS.

vi. Attach the EIQ Indexes.

Clients: Connect to EIQ Server using 'SchemaInterface=NativeWithAttach' connection option and select the VDS (E.g.: from EIQ Server Query Tool)