eDOCS DM Connector: Adding a New Connection

Owned by Steinar Skjerven
Last updated: Mar 23, 2018

Prerequisites

eDOCS DM 16 with a MS SQL backend is set as the default eDOCS DM connector version. If your eDOCS DM installation is version 10 or 5 or Oracle a few steps are required before setting up a connection:

  1. Stop the ViaWorks Edocs DM Fetch Service on all servers.
  2. For all Locator servers, open File Explorer and go to the eDOCS DM Fetch folder: <<Program Files>>\VirtualWorks\ViaWorks\edocsdm
  3. The connector uses the files 'ConnectorDefinition.xml' and 'IdentificationDefinition.xml'. Select the file matching version and database backend and rename to 'ConnectorDefinition.xml' and 'IdentificationDefinition.xml.
    1. The 'ConnectorDefinition.xml' options are:
      1. ConnectorDefinition.xml - Default with support for eDOCS DM 16.x+ with MSSQL database backend.
      2. ConnectorDefinition_edocsdm5 - eDOCS DM 5.x+ with MSSQL database backend.
      3. ConnectorDefinition_edocsdm10 - eDOCS DM 10.x+ with MSSQL database backend.
      4. ConnectorDefinition_oracle.xml - eDOCS DM 16.x+ with Oracle database backend.
      5. ConnectorDefinition_oracle_edocsdm5.xml - eDOCS DM 5.x+ with Oracle database backend.
      6. ConnectorDefinition_oracle_edocsdm10.xml - eDOCS DM 10.x+ with Oracle database backend.
    2. The 'IdentificationDefinition.xml' options are:
      1. IdentificationDefinition.xml - Default with support for all versions with MSSQL database backend.
      2. IdentificationDefinition_oracle.xml - All versions with Oracle database backend.
  4. Repeat step 2. and 3. for all Locator servers with the connector installed.
  5. Start the ViaWorks Edocs DM Fetch Service on all the servers.

Connection Name Page

 

Setting NameDescription
Display NameThe name of the connection. 


Connection Settings Page

Depending on if you set up a MS SQL or an Oracle connector you get the following pages:

MSSQL

 


Setting NameDescription
ServerThe database server
PortDefault 1433. Use 0 if named instance.
DatabaseThe name of the eDOCS DM database
Use integrated securityYes/No
User NameIf integrated security a Active Directory user with read to the eDOCS DM database. If not integrated security a SQL Authentication User with read access to the eDOCS DM database.
PasswordThe password of index user
Connection timeout (in seconds)Advanced options. Default 15.
Command timeout (in seconds)Advanced options. Default 30
Database SchemaThe schema of the eDOCS DM database. Usually docsadm.

Oracle


Setting NameDescription
ServerThe database server
PortDefault 1521
DatabaseThe SID or Service Name of the eDOCS DM database. If SID please enable 'Use database name as SID'
User NameThe user/schema of the index user
PasswordThe password of the index user
Use database name as SIDIf Oracle connection string uses SID or Service Name. See 'Database'.
Connection timeout (in seconds)Advanced options. Default 15.
Command timeout (in seconds)Advanced options. Default 30
Database SchemaThe schema of the eDOCS DM database.

eDOCS DM Document Server Page

Page for the Active Directory Index User with read access to the eDOCS DM Document Server. 

Setting NameDescription
UsernameThe user name of the Active Directory index user with read access to the eDOCS DM Document Server
PasswordThe index user password
DomainThe index user domain
UNC Path

This setting is not in use by the connector. The calculate will get the full path of the files from the database.

Please enter \\localhost\c$\Windows\Temp or similar.

File Types Page

Setting Name
Description
File Type to index

Select file types Only the most common file types are included by default.

The file extension to index. The options are:

  • Index all file types (default)
    • This one will by default index ALL files, regardless of the file format
    • For file types associated with the built-in DocFilter content filter, all text content available will be indexed
    • For other file types, only available metadata (like file name and path) will be indexed
  • Index selected file types only
    • Will only index the file types listed in the dialog
  • Exclude selected file types
    • Will index everything - except the file types defined in the list



ayfie