eDOCS DM Connector: Adding a New Connection

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:

Stop the ViaWorks Edocs DM Fetch Service on all servers.
For all Locator servers, open File Explorer and go to the eDOCS DM Fetch folder: <<Program Files>>\VirtualWorks\ViaWorks\edocsdm
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.
Repeat step 2. and 3. for all Locator servers with the connector installed.
Start the ViaWorks Edocs DM Fetch Service on all the servers.

Connection Name Page

Setting Name	Description
Display Name	The 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 Name	Description
Server	The database server
Port	Default 1433. Use 0 if named instance.
Database	The name of the eDOCS DM database
Use integrated security	Yes/No
User Name	If 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.
Password	The password of index user
Connection timeout (in seconds)	Advanced options. Default 15.
Command timeout (in seconds)	Advanced options. Default 30
Database Schema	The schema of the eDOCS DM database. Usually docsadm.

Oracle

Setting Name	Description
Server	The database server
Port	Default 1521
Database	The SID or Service Name of the eDOCS DM database. If SID please enable 'Use database name as SID'
User Name	The user/schema of the index user
Password	The password of the index user
Use database name as SID	If 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 Schema	The 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 Name	Description
Username	The user name of the Active Directory index user with read access to the eDOCS DM Document Server
Password	The index user password
Domain	The 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