How to Set Up and Configure the vDoc Connector

vDoc is an SQL-based Connector for source systems Your Source System is the repository where your data is stored (data to be indexed). This repository is managed by applications such as: - SharePoint O365 - SharePoint 2013/16/19 - Documentum - File Share - OpenText - Lotus Notes - etc. Your Source System repository can also be a database such as SQL or Oracle. that expose content via an underlying database.

  • These connectors use a common framework with template-based administrative screens.

  • The SQL calls are available for tailoring, either for performance optimization or to support advanced scenarios.

Configure the Connector

The connector is configured according to the connector framework you employ:

  • Connector Framework: You can replace the template names after the import.
  • Connectivity Hub: Modify the XML file before import.

Modify the XML File

  1. In the XML file provided, replace the following placeholders with valid values:
    1. VDOC_CONNECTION Connection defines the how Connectivity Hub connects to your Source System (which contains your documents, graphics, etc.,). Your Connection includes identifying elements such as: URL of the BA Insight web service connector you are using, (File Share connector, SharePoint Online connector, etc.), Authentication mode, User Accounts and Credentials, Database information (for database connectors)_TEMPLATE: Connection name
    2. VDOC_CONTENT_TEMPLATE: Content name
    3. SQL_SERVER_NAME_TEMPLATE: Server name

        

       

       

Create a Target

  1. Create a Target A Target is a "pointer" to a specific instance of a search application, such as Elasticsearch. - (A Search application instance has one or more indexes) before performing the import.

  2. The DestinationId, inside the XML, must have the ID of the Target.



    Note: If a Target is not configured beforehand and the DestinationId does not have the proper ID, then the Content Source Content Sources do the following: Receive data from the Source System via the Connection, Filter the data it receives, Provide the results to the Target, Define the specific search index that contains the content you wish to index (and later search). is not created.

    TargetIndex     entry options:
    1. Empty:
      1. If left empty, after import the user needs to go to the created Content Source, save it, then the Target Index is calculated from the Content Source's name. 
    2. Deleted/commented:
      1. After import, the user needs to go to the created Content Source, save it, then the Target Index is calculated from the Content Source's name.
    3. Default template value:
      1. After import, the user needs to go to the created Content Source, save it, and then the Target Index is calculated from the Content Source's name.

Import the XML File

Connectivity Hub

If you use Connectivity Hub:

  1. Import the XML file as explained here: How to Import Your Content and Connection Using the Import cmdlet.

Connector Framework

If you use Connector Framework:

  1. Go to the Connector Framework site.
  2. Go to Tools > Templates.
  3. Click on Import template. 
  4. Select the XML file.
  5. Complete the following fields:
    1. Title (the name of the Connection and Content)
    2. Code
  6. Click Save.
  7. Go to Manage templates > Use Template.
  8. Select the imported template and click "create content."

For Connector Framework you must also configure the content owner and the default domain.

Note: vDoc uses local time => Connectivity Hub or Connector Framework should be in the same time zone.