Help Manual - Zoho Campaigns Connection Manager

Documentation on SSIS Zoho Campaigns Connection Manager component

Setting Up a Zoho Campaigns REST Connection Manager

The REST Connection Manager is an SSIS connection manager that can be used to establish connections and facilitate data integration with REST-based APIs and services such as Zoho Campaigns, among many more.

Integration for Zoho Campaigns is enabled by the following two components:

To add a new connection, right-click the Connection Manager area in your Visual Studio project and choose "New Connection..." from the context menu. You will be prompted to the "Add SSIS Connection Manager"  window. Select the "REST (KingswaySoft)" item to add a new REST  Connection Manager.

New SSIS Connection

Add SSIS REST Connection Manager

The REST Connection Manager contains 2 pages of configuration:

  • General
  • Advanced Settings

General Page

The General page allows you to specify connection properties and login credentials for the Zoho Campaigns REST service:

Zoho Campaigns Connection Manager

Service Name

The REST service to which it will be connected.

API Throttle Rate

The API Throttling Rate will limit the number of requests that can be sent per minute. You may set it to 0 to disable the throttling.

Generate Token File

This button allows you to log in to the service endpoint and authorize your app to generate a token.

SSIS Zoho Campaigns Connection Manager - OAuth Page

App Type

Two options are available for the App Type, in testing you may work with the KingswaySoft App(please note that in a production setting, we would recommend you create your own app), My Own App you would select when you have created an App for Zoho Campaigns.

Here you can enter the Client ID and Client Secret which you would be getting from the OAuth setup on the API side. The Redirect URL would be the one that you had specified in the App settings.

  • Use Default Browser to Sign In: When this option is checked the Sign In and Authorize button will open your default web browser to complete the OAuth authentication. When this option is unchecked, the Sign In and Authorize button will complete the entire  OAuth authentication process inside the toolkit.
  • Sign In and Authorize: This button allows you to log in to the service endpoint and authorize your app to generate a token.
Path To Token File

The path to the token file on the file system. Please note that this field supports both file system paths as well as Azure Blob Storage Shared Access Signature (SAS) URL path.

Token File Password

The password to the token file.

Test Connection

After all the connection information has been provided, you may click the "Test Connection" button to test if the user credentials entered can connect to the selected REST service.

Advanced Settings Page

SSIS Zoho Campaigns Connection Manager - Advanced settings

Proxy Mode

The Proxy Mode option allows you to specify how you want to configure the proxy server setting. There are three options available:

  • No Proxy
  • Auto-detect (Using system-configured proxy)
  • Manual
Proxy Server

Using the Proxy Server option allows you to specify the name of the proxy server for the connection.

Port

The Port option allows you to specify the port number of the proxy server for the connection.

Username (Proxy Server Authentication)

The Username option (under Proxy Server Authentication) allows you to specify the proxy user account.

Password (Proxy Server Authentication)

The Password option (under Proxy Server Authentication) allows you to specify the proxy user's password.

Note: The Proxy Password is not included in the connection manager's ConnectionString property by default. This is by design for security reasons. However, you can include it in your ConnectionString if you want to parameterize your connection manager. The format would be ProxyPassword=myProxyPassword; (make sure you have a semicolon as the last character). It can be anywhere in the ConnectionString.

Timeout

The number of seconds a request should wait before timing out.

Retry on Intermittent Errors

The retry on intermittent errors option determines if requests will be retried when there is an error. If this option is checked requests will be retried up to 3 times.

Ignore Certificate Errors
This option can be used to ignore those SSL certificate errors when connecting to Zoho Campaigns servers.

Warning: Enabling the "Ignore Certificate Errors" option is generally NOT recommended, particularly for production instances. Unless there is a strong reason to believe the connection is secure - such as the network communication is only happening in an internal infrastructure, this option should be unchecked for best security.

Custom Headers Page

REST Connection Manager - Custom Headers

The Custom Headers page will allow you to set the Header Name and Header Value. You may select the green icon to add another row, and the red icon to remove an existing header you have configured.