How to Set Up and Configure the vDoc Connector

vDoc is an SQL-based Connector for source systems 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.
  • ConnectivityHub: 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_TEMPLATE: Connection name
    2. VDOC_CONTENT_TEMPLATE: Content name
    3. SQL_SERVER_NAME_TEMPLATE: Server name

        

       

       

Create a Target

  1. Create a Target 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 will not be created.

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

Import the XML File

ConnectivityHub

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 => ConnectivityHub or Connector Framework should be in the same time zone.