Microsoft Exchange ETL Source
See the Connector Marketplace topic. Please request your administrator to start a trial or subscribe to the Premium Microsoft Exchange connector.
In Gathr, it can be added as a channel to help in fetching customers’ and prospects’ data and transform it as needed before storing it in a desired data warehouse to run further analytics.
Schema Type
See the topic Provide Schema for ETL Source → to know how schema details can be provided for data sources.
After providing schema type details, the next step is to configure the data source.
Data Source Configuration
Configure the data source parameters as explained below.
Connection Name
Connections are the service identifiers. A connection name can be selected from the list if you have created and saved connection details for Microsoft Exchange earlier. Or create one as explained in the topic - Microsoft Exchange Connection →
Use the Test Connection option to ensure that the connection with the Microsoft Exchange channel is established successfully.
A success message states that the connection is available. In case of any error in test connection, edit the connection to resolve the issue before proceeding further.
Entity
Tables in Microsoft Exchange are statically defined to model Microsoft Exchange entities.
If you selected the Fetch From Source method to design the application, the Entities will list as per the configured connection. Select the entity to be read from Microsoft Exchange.
If you selected the Upload Data File method to design the application, the exact name of the entity should be provided to read the data from Microsoft Exchange.
If you selected the Fetch From Source method to design the application, the Fields would list as per the Entity chosen in the previous configuration parameter. Select the fields or provide a custom query to read the desired records from Microsoft Exchange.
Fields
The conditions to fetch source data from a Microsoft Exchange table can be specified using this option.
Select Fields: Select the column(s) of the entity that should be read.
Custom Query: Provide an SQL query specifying the read conditions for the source data.
Example: SELECT "Id" FROM Companies
If you selected the Upload Data File method to design the application, provide a custom query to fetch records from the Microsoft Exchange entity specified in the previous configuration.
Query
The conditions to fetch source data from a Microsoft Exchange table can be specified using this option.
Provide an SQL query specifying the read conditions for the source data.
Example: SELECT "Id" FROM Companies
Read Options
This section contains additional read options.
Include Content
A boolean indicating if additional content should be retrieved, such as the Body field of an Inbox email.
Retrieving all content for a large number of items can be expensive.
This property cannot be used with the Folders table, or the Calendar child views.
Always Request Table Dependencies
Control whether you want to always retrieve Table Dependencies (Foreign Keys).
Setting this to TRUE might slow down queries and increase amount of calls made.
Body Type
The Body Type element identifies how the body text is formatted in the response.
The possible options are:
Best: The response will return the richest available content of body text. The default is set to Best.
HTML: The response will return an item body as HTML.
Text: The response will return an item body as plain text.
Group ID
Specify this Group ID in order to access the OneNote documents for this group.
Impersonation Type
The type of identifier to use with impersonation while sending requests to the Exchange site.
The pseudo-column of the same name can be used in the SQL query in order to more dynamically impersonate users.
Possible values for Impersonation Type are:
| Impersonation Type | Description |
|---|---|
| PrincipalName | Represents the user principal name (UPN) of the account to use for impersonation. This should be the UPN for the domain where the user account exists. |
| SID | Represents the security descriptor definition language (SDDL) form of the security identifier (SID) for the account to use for impersonation. |
| PrimarySmtpAddress | Represents the primary Simple Mail Transfer Protocol (SMTP) address of the account to use for Exchange impersonation. If the primary SMTP address is supplied, it will cost an extra Active Directory directory service lookup in order to obtain the SID of the user. We recommend that you use the SID or UPN if they are available. |
| SmtpAddress | Represents the Simple Mail Transfer Protocol (SMTP) address of the account to use for Exchange Impersonation. If the SMTP address is supplied, it will cost an extra Active Directory lookup in order to obtain the SID of the user. We recommend that you use the SID or UPN if they are available. |
Impersonation User
The user to impersonate while sending requests to the Exchange site.
The pseudo column of the same name can be used in the SQL query in order to more dynamically impersonate users.
Partitioning
This section contains partitioning configurations.
Enable Partitioning
This enables parallel reading of the data from the entity.
Partitioning is disabled by default.
If enabled, an additional option will appear to configure the partitioning conditions.
Column
The selected column will be used to partition the data.
Max Rows per Partition: Enter the maximum number of rows to be read in a single request.
Example: 10,000
It implies that a maximum number of 10,000 rows can be read in one partition.
Advanced Configuration
This section contains advanced configurations parameters.
Fetch Size
The fetch size determines the number of rows to be fetched per round trip. The default value is 1000.
Add Configuration: Additional properties can be added using this option as key-value pairs.
Detect Schema
Check the populated schema details. For more details, see Schema Preview →
Pre Action
To understand how to provide SQL queries or Stored Procedures that will be executed during pipeline run, see Pre-Actions →.
Notes
Optionally, enter notes in the Notes → tab and save the configuration.
If you have any feedback on Gathr documentation, please email us!