Help Manual - Zoho Bigin Connection Manager

Documentation on SSIS Zoho Bigin Connection Manager component

Setting Up a Zoho Bigin 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 Bigin, among many more.

Integration for Zoho Bigin 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 3 pages of configuration.

  • General
  • Advanced Settings
  • Custom Headers

General Page

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

Zoho Bigin Connection Manager.png

Service Name

The REST service that will be connected to.

API Throttle Rate

Specify the API throttle rate to control throttling related bottlenecks and to manage any such API limits.

Authentication

The Authentication option allows you to create authentication when working with the Zoho Bigin service.

Generate Token File

This button opens a dialogue box in order to sign in to your instance to generate a new Token.

Zoho Bigin Connection Manager - OAuth.png

  • Client ID: The Client ID option allows you to specify the unique ID which identifies the application making the request.
  • Client Secret: The Client Secret option allows you to specify the client secret belonging to your app.
  • Redirect Url: The Redirect Url option allows you to specify the Redirect Url to complete the authentication process.
  • Data Center: Choose the Data Center from the drop down.
  • 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 into the service endpoint and authorize your app to generate a token.
Path To Token File

This option allows you to enter the path to the token file on the file system.

Token File Password

The password to the token file.

Advanced Settings Page

Zoho Bigin Connection Manager - Advanced settings.png

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 requests 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 Slack 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.