Setup a Jira REST Connection Manager

The REST Connection Manager is an SSIS connection manager component that can be used to establish connections with Jira REST service to help facilitate Jira data integration.

See Jira REST Source Component for how to retrieve data from Jira & Jira REST Destination Component for how to write to Jira.

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 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 configuration pages:

  • General
  • Advanced Settings

General

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

SSIS REST Jira Connection Manager

Service Name

The REST service that will be connected to.

General Settings
Server URL

The URL of the Jira server that you want to connect to.

API Throttle Rate

The API Throttling Rate will limit the number of requests that can be sent per minute.

Authentication Mode

The Authentication Mode to be used in order to connect to your Jira instance. Available options are:

  • API Token
  • OAuth 2
API Token

SSIS REST Jira Connection Manager - API Token Mode

Server URL

The URL of the Jira server that you want to connect to.

Consumer Key

The Consumer Key to use when requesting Jira Access Token. You can navigate to Application links in Jira system to configure the client app to get the Consumer Key.

Certificate Path

The Certificate Path specifies the location of the certificate that will be used.

Certificate Password

The Password to the certificate file.

Generate Token (In App)…

This button will open the In App authentication window through which you can authenticate to your Jira instance and retrieve the API Token.

Generate Token (In Browser)…

This button will open your default browser where you can authenticate to your Jira instance. Once authenticated, you will be redirected to a URL, which you can copy and paste as your redirect URL.

API Token

The API Token that is retrieved via authentication.

Show Token

The masked API Token is shown.

OAuth 2

SSIS REST Jira Connection Manager - OAuth 2 Mode

Generate Token File

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

SSIS REST Jira Connection Manager - OAuth Configuration Page

App Type
KingswaySoft

Selecting KingswaySoft App, the connection manager will use the client ID and secret that is provided by KingswaySoft for your convenience when setting up connection. Please note that this should be used only for testing.

My Own App

Selecting this option will allow you to use your own credentials.

App Info

Here you can enter the Client ID, Client Secret and the Scope depending on the OAuth 2 setup at the API side. The Redirect URL will be the one that you had specified in the App settings.

Sign In & Authorize
Use Default Browser to Sign In

When this option is checked the Sign In & Authorize button will open your default web browser to complete the OAuth authentication. When this option is unchecked, the Sign In & Authorize button will complete the entire OAuth authentication process inside of the toolkit.

Sign In & Authorize button

This button allows you to login 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

Token File Password

The password to the token file.

Test Connection

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

Advanced Settings

REST Connection Manager - Advanced

Proxy Server Settings
Proxy Mode

Proxy Mode option allows 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 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)

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

Password (Proxy Server Authentication)

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.

Miscellaneous Settings
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 Jira servers.

Warning: Enabling "Ignore Certificate Errors" option is generally NOT recommended, particularly for production instance. 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.