Jira

ExpandedToggleIcon        Connection Dialog

To connect to Jira, first you need to select the Environment (Cloud or Server) to connect to and enter the Domain.

 

Connecting to Jira Server

To connect to Jira Server, you need to specify your User Id (user email) and Password (API token).

 

Connecting to Jira Cloud

 

For Basic Authentication, you need to enter your User Id (user email) and Password (API token).

For OAuth Authentication, you need to:

1.Click Sign In.
2.Sign in to Jira in the opened login page in the browser.
3.Cloud Id and Refresh Token are automatically generated.

 

In addition to the required options, Advanced connection options may be set for more fine connection tuning.

 

ExpandedToggleIcon        Advanced Connection Options

The following table describes the options that you can include in the Connection String using the Advanced Connection Editor dialog box:

 

Option

Description

ApiVersion

Specifies the version of Jira API to use.

Authentication Type

Determines the type of API authentication - Basic or OAuth.

Client Id

Specifies the OAuth 2.0 client ID obtained when you register a custom OAuth app for Jira Cloud.

Client Secret

Specifies the OAuth 2.0 client secret obtained when you register a custom OAuth app for Jira Cloud.

CloudId

Specifies the unique identifier of your Jira Cloud instance. The value is obtained automatically when you perform Web Login.

Connection Lifetime

Specifies the maximum lifetime (in seconds) of a connection. When a connection is returned to the pool, its creation time is compared with the current time, and the connection is destroyed if that time span exceeds the value specified by Connection Lifetime. The default value is 0 (connection always returns to pool).

Connection Timeout

Specifies the length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error. The default value is 60.

Default Command Timeout

Specifies the time in seconds to wait while trying to execute a command before terminating the attempt and generating an error. The default value is 60.

Environment

Determines whether to connect to Jira Cloud or Jira Server.

Failover Retries

Specifies the number of retries to perform a command if it fails because of the exception, which indicates that the reason of a failure may be temporary. The default value is 7.

Initialization Command

Specifies a data source-specific command to execute immediately after the connection is established.

Local SQL Engine

Determines whether to enable local SQL processing (enabled by default). Local SQL processing allows performing complex SELECT statements that cannot be directly compiled to Jira API calls. In this case the data from the mentioned cloud objects is queried to the local cache, and then the query is performed against the cache.

If local SQL processing is disabled, only simple SELECT statements that can be directly translated into Jira API calls can be used. More complex SELECT statements will fail.

Max Pool Size

Specifies the maximum number of connections allowed in the pool. Setting the Max Pool Size value in the connection string can affect performance. The default value is 100.

MergeCustomFieldsBehavior

Determines how values from Jira custom fields that share the same name are merged into a single column.

Min Pool Size

Specifies the minimum number of connections allowed in the pool. The default value is 0.

NormalizeDbNames

Determines whether database object names are normalized when retrieved from the database.

Password

Stores the API Token for Jira Basic authentication.

Stores the OAuth access token for Jira OAuth authentication.

Persist Security Info

Indicates if security-sensitive information, such as the password, is not returned as part of the connection if the connection is open or has ever been in an open state.

Pooling

Specifies whether, by default, the connection is drawn from the appropriate pool or is created and added to the appropriate pool.

Proxy Host

Specifies the host name or IP address of the proxy server.

Proxy Password

Specifies the password for the proxy server account.

Proxy Port

Specifies the port number of the proxy server. The default value is 3128.

Proxy User

Specifies the proxy server account name.

Readonly

Indicates whether the connection is read-only (allows only SELECT statements).

Run Once Command

Specifies a command to execute immediately after establishing the connection. Unlike Initialization Command, it is not executed for connections obtained from the connection pool.

SuppressExtendedRequests

Determines whether to suppress additional API requests required to retrieve extended data for Jira objects.

Token

Stores the OAuth 2.0 refresh token for Jira Cloud. This value is obtained automatically when you perform Web Login.

Token Server

Is not used when Jira Basic authentication is selected.

Specifies the location, a file or a registry key, to store new refresh tokens between sessions when Jira OAuth authentication is selected. When set, SSIS Data Flow Components for Jira can query new refresh tokens automatically when the current one expires and store them between sessions. For example, "file://D:\temp\oauth_token_1234.txt" or "reg://HKEY_CURRENT_USER\Software\Devart\dotConnect\OAuth_12345"

Url

Specifies the domain address.

UseCustomObjects

Determines whether to allow working with Jira custom objects.

User

Contains the user email for Jira Basic authentication.

Is not used for Jira OAuth authentication.

UTC Dates

Converts dates to UTC format during import if set to True, and treats the date values entered by the user (in SELECT statements, etc.) as UTC dates when sending them to the data source.