Establishing a Connection
Enabling SSIS in Visual Studio 2022
If you're using Visual Studio 2022, you will need to install the SQL Server Integration Services Projects extension to use SSIS.
- Navigate to Extensions > Manage Extensions.
- In the Manage Extensions window's search box, search for "SQL Server Integration Services Projects 2022" and select the extension in the list.
- Click Download.
- Close Visual Studio and run the downloaded Microsoft.DataTools.IntegrationServices.exe installer. Proceed through the installer with default settings.
- Open Visual Studio. There should now be an "Integration Services Project" project template available.
Adding the Jira Assets Connection Manager
Create a new connection manager as follows:
- Create a Visual Studio project with the "Integration Services Project" template.
- In the project, right-click within the Connection Managers window and select New Connection from the menu.
- In the Description column, select CData Jira Assets Connection Manager and click Add...
- Configure the component as described in the next section.
Alternatively, if you have an existing project and CData Jira Assets Source or CData Jira Assets Destination:
- Right-click your CData Jira Assets source or destination component in your data flow
- Select Edit... to open an editor window.
- Click the New... button next to the Connection manager: dropdown selector to create a connection manager.
- Configure the component as described in the next section.
Connecting and Authenticating to Jira Assets
Jira Assets supports connecting and authenticating using the APIToken or OAuth 2.0 authentication method.To establish a connection, the URL connection property is required. This property must be set to the base URL of your Jira Assets (Atlassian Cloud) site, for example: https://your-domain.atlassian.net.
API Token
To generate an API token:
- Log in to your Atlassian account.
- Navigate to Security > Create and manage API Token > Create API Token.
After you have generated the API token, set these parameters:
OAuth 2.0
You can leverage Jira Assets's "three-legged" OAuth 2.0 support (3LO) to connect to data without providing your login credentials.The following procedures assume that AuthScheme has been set to OAuth in all OAuth flows.
Desktop Applications
CData provides an embedded OAuth application that simplifies OAuth desktop Authentication. Alternatively, you can create a custom OAuth application. See Creating a Custom OAuth Application for information about creating custom applications.After setting the following, you are ready to connect:
- InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
- OAuthClientId: (custom applications only) Set to the Client ID in your application settings.
- OAuthClientSecret: (custom applications only) Set to the Secret in your application settings.
- CallbackURL: (custom applications only) Set to the callback URL configured in your app.
- URL : Set this to the URL to your Jira Assets endpoint, for example, https://yoursitename.atlassian.net.
- The component obtains an access token from Jira Assets and uses it to request data.
- Extracts the access token from the callback URL and authenticates requests.
- Saves OAuth values in the location specified in OAuthSettingsLocation. These values persist across connections.
Headless Machines
To configure the driver to use OAuth with a user account on a headless machine, you need to authenticate on another device that has an internet browser.
- Choose one of two options:
- Option 1: Obtain the OAuthVerifier value as described in "Obtain and Exchange a Verifier Code" below.
- Option 2: Install the component on a machine with an internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow, as described in "Transfer OAuth Settings" below.
- Then configure the component to automatically refresh the access token on the headless machine.
Option 1: Obtain and Exchange a Verifier Code
To obtain a verifier code, you must authenticate at the OAuth authorization URL.
Follow the steps below to authenticate from the machine with an internet browser and obtain the OAuthVerifier connection property.
- Choose one of these options:
- If you are using the Embedded OAuth Application, call the GetOAuthAuthorizationURL stored procedure. Open the URL returned by the stored procedure in a browser.
- If you are using a custom OAuth application, set the following properties:
- InitiateOAuth: Set to OFF.
- OAuthClientId: Set to the Client ID in your application settings.
- OAuthClientSecret: Set to the Secret in your application settings.
- Log in and grant permissions to the component. You are then redirected to the redirect URI. There is a parameter called code appended to the redirect URI. Note the value of this parameter. Later you need this to set the OAuthVerifier connection property.
On the headless machine, set the following connection properties to obtain the OAuth authentication values:
- InitiateOAuth: Set this to REFRESH.
- OAuthVerifier: Set this to the noted verifier code (the value of the code parameter in the redirect URI).
- OAuthClientId: (custom applications only) Set to the Client ID in your application settings.
- OAuthClientSecret: (custom applications only) Set to the Secret in your application settings.
- OAuthSettingsLocation: Set this to persist the encrypted OAuth authentication values to the specified location.
Test the connection to generate the OAuth settings file, then re-set the following properties to connect:
- InitiateOAuth: Set this to REFRESH.
- OAuthClientId: (custom applications only) Set to the Client ID in your application settings.
- OAuthClientSecret: (custom applications only) Set to the Secret in your application settings.
- OAuthSettingsLocation: Set this to the location containing the encrypted OAuth authentication values. Make sure this location gives read and write permissions to the component to enable the automatic refreshing of the access token.
Option 2: Transfer OAuth Settings
Prior to connecting on a headless machine, you need to install and create a connection with the driver on a device that supports an internet browser. Set the connection properties as described in "Desktop Applications" above.
After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the location specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.
Test the connection to generate the OAuth settings file, then copy the OAuth settings file to your headless machine.
On the headless machine, set the following connection properties to connect to data:
- InitiateOAuth: Set this to REFRESH.
- OAuthClientId: (custom applications only) Set to the Client ID in your application settings.
- OAuthClientSecret: (custom applications only) Set to the Secret in your application settings.
- OAuthSettingsLocation: Set this to the location of the OAuth settings file you copied from the machine with the browser. Make sure this location gives read and write permissions to the component to enable the automatic refreshing of the access token.