Preface

This documentation describes how to connect to Northwind database. The connector by default isn't  set up to be used with any other database. It is just a template for creating connections to specific SQL databases. You need to edit the connector and define all queries manually to match your DataBase.

Prerequisites

To start this service the developer will need to update the following files:

• Via.Dbc.CommunityFetchService.exe.config
• ConnectorDefinition.xml
• IdentificationDefinition.xml (Optional)

Even if the Wizard failed to start the service, the connector is fully installed. You can either click 'Close' and create these files later and then start the Via.GenericSQL.Fetch.Service service manually. Or add the required files and click 'Run Again' to complete the installer.

Starting Fetch Services

When you install the GenericSQL Connector the first time the installer will not be able to start the Via.GenericSQL.Fetch.Service. The reason for this is that the connector does not distribute all files that is needed by the connector to start the fetch service. The connector only distributes examples files. Doing it this way supports connector upgrades without overwriting the files developed for the custom source system. Connector upgrades will only upgrade binaries and examples files.

Setup

For this guide the connection will be set up using the example files of Northwind database with an Microsoft SQL backend. The example files are provided with connector:

• Via.Dbc.CommunityFetchService_Northwind.exe.config
• ConnectorDefinition_Northwind_MicrosoftSQL.xml
• IdentificationDefinition_Northwind_MicrosoftSQL.xml

The renamed example config files are tailored towards database tables holding data relating to the imaginary company Northwind. In the example config we are extracting data for 4 content types: Products, Customers, Orders and Employee. These example config files can now be used as templates and be modified to extract the actual content types stored in the target data base. This includes updating all SELECT statements to refer to existing data base tables and columns.

Go to the 'Fetch' folder of the GenericSQL Connector and rename the following files:

1. Via.Dbc.CommunityFetchService_Northwind.exe.config to Via.Dbc.CommunityFetchService.exe.config
2. ConnectorDefinition_Northwind_MicrosoftSQL.xml to ConnectorDefinition.xml
3. IdentificationDefinition_Northwind_MicrosoftSQL.xml to IdentificationDefinition.xml

Go to services.msc and start Via.GenericSQL.Fetch.Service service manually. This registers the connector with Locator and you can now add a new connection in the Locator Management Console.

Adding a New Connection

These are the Wizard pages for the Northwind example files. 

Connection Name Page

Connection Page

Depending of which ConnectionType is set in the ConnectorDefintion.xml you will get diffrent pages here

MsSql

Use by example files.