Data source parameters

Exonar library graphic

Here’s a summary of the parameters you need to fill for each data source when you set it up.

File Share

Field

Description

Domain

The domain the user belongs to.

If the user does not belong to a domain you can use . (the full stop or period character) as the domain.

User Name

A user who has read access to the data you want to crawl.

Password

The password for the user.

Server

The IP address or fully qualified domain name of the target server.

Share

The name of the target share.

Path

The path to the directory where you want to crawl.

To crawl the entire share, specify a forward slash (/) or backslash (\).

Microsoft Exchange on Premise

Common fields:

Field

Description

Exchange User

A user who has read access to the data you want to crawl and the ability to read mailboxes using Microsoft Identity Impersonation †. The Exchange User must have a valid mailbox.

Exchange Password

Password for the Exchange user.

Target

If you specify mailbox, Exonar crawls just that mailbox. If you specify LDAP query, Exonar crawls all the mailboxes that match the results of the query.

† Therefore, we only support objects that are accessible through impersonation.

Fields when the target is a mailbox:

Field

Description

Exchange Protocol

HTTP or HTTPS.

Exchange Server

The IP address or fully qualified domain name of the target Exchange server.

Mailbox

Specify one mailbox to crawl. For example: me@example.com.

Fields when the target is defined by an LDAP query:

Field

Description

Use Exchange Details

Check this if you want to use the Exchange User as the Directory User.

Directory User

User name for the connection to the Active Directory Server.

Directory Password

Password for the Directory user.

Exchange Protocol

As above.

Exchange Server

As above.

Directory Server

The IP address or fully qualified domain name of the target Active Directory server.

LDAP Protocol

The protocol used by the LDAP server: LDAP or LDAPS.

LDAP Port

The port that the LDAP server listens on. Defaults to the value specified in settings.py.

Directory Search Base

For more information, see Microsoft Exchange: Directory Search Base. Defaults to the value specified in settings.py.

Directory Filter

For more information, see Microsoft Exchange: directory filter. Defaults to the value specified in settings.py.

Microsoft Office 365 Exchange

Field

Description

Domain

The id of a Microsoft tenant-held domain. For example: exonarltd.onmicrosoft.com.

Email

If the ingestion scope is Group Email, this is an email address that identifies a user group. For example: group@example.com. If the ingestion scope is User Email, this is the email address for an individual user.

Microsoft SharePoint 2007 and 2010

Field

Description

User Name

User with read permissions on the data you want to crawl.

Password

The password for the user.

Domain

The domain the user belongs to.

Service Host

The IP address or fully qualified domain name of the server you want to crawl. Example: https://sharepoint.example.com

Site

Optional. You can use this field if you want to target a specific site on your SharePoint server.

Microsoft SharePoint 2013 and 2016

Field

Description

User Name

A user with read permissions on the data you want to crawl.

Password

The password for the user.

HTTP Protocol

HTTP or HTTPS.

Server

The IP address or fully qualified domain name of the target server. Example: sharepoint.example.com

Site

Optional. You can use this field if you want to target a specific site on your SharePoint server.

Folder Path

Optional. Specify the path to target on the site. If you leave Site blank, we target every site on the server.

Microsoft Office 365 SharePoint

Field

Description

Site URL

If the ingestion scope is Site Only, Site with Subsites, or Site with Folder Path, specify the site on your SharePoint server.

Folder Path

If the ingestion scope is Site with Folder Path, specify the path to target on the site.

Enterprise Vault

Field

Description

User Name

A user with read permissions to the Enterprise Vault archives you want to crawl.

Password

The password for the user.

Domain

The domain for the user.

HTTP Protocol

HTTP or HTTPS.

Service Host

The IP address or fully qualified domain name to the target server. Example: enterprisevault.mydomain.local

iManage

Field

Description

User Name

A user with read permissions on the data you want to crawl.

Password

The password for the user.

HTTP Protocol

HTTP or HTTPS.

Server

The IP address or fully qualified domain name of the target server.

Port

The port number for iManage.

Database

As required.

Client

Optional. As required.

Matter

Optional. As required.

Google Drive

Field

Description

Admin Account ID

The email address of the admin account you created. This is the account Exonar will impersonate for domain and group crawls. Required.

Service Account ID

The email address of the service account you created. This is the account Exonar will use for impersonation. Required.

Private Key PEM String

The private key for the service account. This is the content of the PEM file, not the file name. |Exonar| needs an exact copy of the content so be careful here. Required.

Crawl Level

  • Domain

  • Group

  • User

Domain

The domain where the crawl happens. Required for all crawl levels.

Group ID

The email address for the user group you will crawl. Required for user group crawls.

User Account ID

The email address for the individual user you will crawl. Required for individual user crawls.

MySQL

Field

Description

Host

The IP address or the fully qualified domain name of the target server.

Database/Schema

The name of the database you want to crawl. You can only target one database at a time.

Port

The port that MySQL is using. For example: 3306.

Username

A user who has read access to the data you want to crawl.

Password

The password for the user.

Microsoft SQL Server

Field

Description

Host

The IP address or fully qualified domain name of the target server. Can be server\instance or just server.

Database Name

The name of the database you want to crawl. You can only target one database at a time.

Port

The port that SQL Server is using. For example: 1433. Choose port 0 if SQL Server is using dynamic ports.

Schema Name

The schema name of the target database tables/views.

Username

A user who has read access to the data you want to crawl.

Password

The password for the user.

If you use port 0 you must include the \instance in the host

If you specify both a port and instance, the port will take precedence and the instance name will be ignored

For SQL to look up the port when specifying port 0:

  • The firewall must allow traffic on UDP port 1434

  • For Microsoft SQL Server 2005 or later the SQL Server Browser Service must be running

PostgreSQL

Field

Description

Host

The IP address or fully qualified domain name of the target server.

Database Name

The name of the database you want to crawl. You can only target one database at a time.

Port

The port that PostgreSQL is using. For example: 5432

Schema Name

The schema of the target database tables/views.

Username

A user who has read access to the data you want to crawl.

Password

The password for the user.

Oracle

Field

Description

Host

The server you want to crawl. For example: mydatabase.example.com

Database Name

The name of the database you want to crawl. You can only target one database at a time.

Port

The port that Oracle is using. For example: 1521.

Schema Name

The schema of the target database tables/views.

Username

A user who has read access to the data you want to crawl.

Password

The password for the user.