Getting Started with the CData SSIS Components for Outlook

Complete guide to installing, licensing, and connecting with the CData SSIS Components for Outlook.

This guide explains everything you need to get started with the CData SSIS Components for Outlook. You'll learn how to install the components, activate your license, configure your first SSIS connection manager, and build a data flow task to move and transform Outlook data in your SQL Server Integration Services workflows.

Installation & Licensing

System Requirements

  • Windows: Windows 10/11 or Windows Server 2016+
  • Visual Studio: Visual Studio 2015 or later
  • SQL Server: SQL Server 2014, 2016, 2017, 2019, or 2022

Installing the SSIS Components

  1. Download the SSIS Components installer for Outlook from your CData account or the evaluation download page
  2. Run the installer and follow the installation wizard
  3. The installer automatically registers the Connection Manager, Source, and Destination components with Visual Studio
  4. When prompted, activate your license using the product key sent to you by the CData Orders Team:
    XXXX-XXXX-XXXX-XXXX-XXXX
    • Note: To run a trial, choose the Trial Key option.

Enabling SSIS in Visual Studio 2022

If you are using Visual Studio 2022, the SQL Server Integration Services Projects extension must be installed.

  1. In Visual Studio, select Extensions > Manage Extensions
  2. Search for SQL Server Integration Services Projects 2022
  3. Click Install
  4. Close Visual Studio and run the downloaded Microsoft.DataTools.IntegrationServices.exe installer
  5. Reopen Visual Studio. The Integration Services Project template will now appear when creating a new project

Activating Your License

During installation, you are prompted to activate the SSIS Component license. If you need to update or change activation:

License Activation

The installer automatically prompts you to add your license. During installation, you can choose to:

  • Use your existing subscription license key, or
  • Enter your trial license

To activate a full subscription license, contact the CData Orders Team and request your product key at [email protected].

Enter the license key in the installer when prompted. Once activated, the components will be licensed and ready to use inside Visual Studio without any additional steps.

Runtime Licensing

When deploying SSIS packages, a Runtime Key (RTK) can also be used:

  • Set the RTK property in the Connection Manager before deployment

Common Licensing Questions

Can I use my license on multiple machines?
Yes, depending on your subscription tier. Contact [email protected] for details.

I lost my license key. How do I retrieve it?
Email [email protected] with your order number, and we'll resend your license key.

How do I transfer my license to another machine?

Yes. When transferring the license to a different machine, you will need to submit a License Transfer Request on our site linked below:

https://www.cdata.com/lic/transfer/

After the License Transfer Request is submitted and successfully processed, an activation will be added to your Product Key and you will be able to activate the full license on the other machine. Once this process is finished, the license on the previous machine will be invalid.

You may also view and upgrade licenses in the self-service portal at portal.cdata.com.

Connection Configuration

Once the components are installed and licensed, you can configure a connection to Outlook using an SSIS Connection Manager. This Connection Manager stores all authentication and connection properties used by the Source and Destination components.

Creating a Connection Manager

  1. In the bottom Connection Managers panel of your SSIS package, right-click and select New Connection
  2. Select CData API Driver for SSIS from the list
  3. Click Add to open the Connection Manager UI
  4. Enter the required authentication properties (OAuth, API token, client credentials, etc.) depending on your Outlook

    5. Configuring Connection Properties

    Using OAuth Authentication

    Microsoft Graph API uses OAuth 2.0 for authentication. You must register an application in the Microsoft Azure Portal to obtain OAuth credentials (Client ID and Client Secret).

    Obtaining OAuth Credentials

    1. Log in to the Azure Portal.
    2. Navigate to Azure Active Directory > App registrations.
    3. Click New registration to create a new application.
    4. Enter an application name and select the appropriate account types.
    5. Set the Redirect URI to your application's callback URL (e.g., http://localhost:33333 for desktop apps).
    6. Click Register to create the application.
    7. On the application overview page, copy the Application (client) ID - this is your OAuthClientId.
    8. Navigate to Certificates & secrets and create a new client secret.
    9. Copy the client secret value - this is your OAuthClientSecret.
    10. Navigate to API permissions and add the required Microsoft Graph API permissions:
      • Mail.Read - For accessing email messages
      • Contacts.Read - For accessing contacts
      • Calendars.Read - For accessing calendar events
      • Tasks.Read - For accessing To Do tasks
      • offline_access - For obtaining refresh tokens
    11. Click Grant admin consent to grant these permissions.

    Connecting with OAuth

    After setting the following connection properties, you are ready to connect:

    • AuthScheme: Set this to OAuth.
    • InitiateOAuth: Set this to GETANDREFRESH. The CData API Profile for Outlook will automatically walk through the OAuth process in order to obtain the access token.
    • OAuthClientId: Set this to the Application (client) ID from Azure Portal.
    • OAuthClientSecret: Set this to the client secret value from Azure Portal.
    • TenantId: Set this to your Azure AD tenant identifier (GUID or domain name like 'contoso.onmicrosoft.com').
    • CallbackURL: Set this to the Redirect URI you specified in your app registration (e.g., http://localhost:33333 for desktop apps).

    Example connection string

    Profile=C:\profiles\Outlook.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;TenantId=your_tenant_id;CallbackUrl=http://localhost:33333;

  5. Click Test Connection to confirm connectivity

Building an SSIS Data Flow

With a Connection Manager created, you can now pull data from Outlook or push data into it using SSIS data flow tasks.

Creating a Data Flow Task

  1. In the Control Flow tab, drag a Data Flow Task onto the design surface
  2. Double-click the task to open the Data Flow workspace

Using the Source Component

  1. In the SSIS Toolbox, drag the CData Outlook Source component into the Data Flow
  2. Double-click it to open the Source Editor
  3. Select the CData Outlook Connection Manager you created
  4. Choose a table or view to extract records from
  5. Click OK to save your configuration

Using the Destination Component

  1. Drag a SQL Server Destination onto the canvas
  2. Double-click it to open the Destination Editor
  3. Select an existing table or click New to auto-generate a table based on the Source schema
  4. Connect the Source output to the Destination input and map the columns as needed
  5. At this point you have created a data flow task for replicating your Outlook data to a SQL Server database

Testing Your Data Flow

  1. Return to the Control Flow tab
  2. Click Start Debugging
  3. Monitor the progress indicators
  4. Review row counts and ensure data is loading as expected

Common Connection Issues

Authentication Failed

Solution: Verify OAuth settings, client IDs, secrets, or token permissions for your Outlook. Contact [email protected] for OAuth troubleshooting.

Cannot Reach Server

Solution: Check firewall, proxy, and VPN configurations. Contact [email protected] for specific port requirements.

Table Not Found

Solution: Confirm you selected the correct schema or database when querying Outlook.

What's Next

Now that you have installed, licensed, and configured the SSIS Components, here are scenarios you can use to explore our SSIS tools:

SSIS ComponentArticle Title
BIMLUse Biml to Build SSIS Tasks to Replicate Outlook to SQL Server
SSIS ImportImport Outlook Data into SQL Server using SSIS

Get Support

If you need assistance at any point:

FAQs

Installation & Licensing

  • Do I need administrator rights to install the SSIS Components?
    Yes, administrator rights are required to install components for use across Visual Studio.
  • Do I need an RTK to deploy to Azure Data Factory?
    Yes. Set the RTK property in the Connection Manager before publishing.

Connecting

  • Can I use multiple Outlook accounts?
    Create separate Connection Managers for each account.
  • Can I connect through a proxy?
    Yes. Configure proxy settings in the Connection Manager properties.
  • How do I test my connection?
    Click Test Connection in the Connection Manager UI.

Performance & Troubleshooting

  • Why is my data flow slow?
    Add filters, limit rows, and ensure batching settings are configured in the Source component.
  • How do I enable logging?
    Add the following to your connection manager:
    • Logfile: /path/to/logfile.log
    • Verbosity: 3

    Be prepared to securely upload the log file upon request when reaching out to [email protected] for troubleshooting analysis.

    For questions not covered in this FAQ, contact [email protected].

Ready to get started?

Connect to live data from Outlook with the API Driver

Connect to Outlook

In this article

Related articles