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 Linear 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 Linear Connection Manager and click Add...
- Configure the component as described in the next section.
Alternatively, if you have an existing project and CData Linear Source or CData Linear Destination:
- Right-click your CData Linear 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 to Linear
You can authenticate to Linear with a personal API key or with OAuth 2.0.
- API Key: The simplest option. Use it to connect with your own Linear account.
- OAuth (authorization code): Authenticate an application on behalf of a Linear user. Set AuthScheme to OAuth.
- OAuth (client credentials): Authenticate the application itself, for app-owned (machine-to-machine) access with no user interaction. Set AuthScheme to OAuthClient.
Authenticate with an API Key
To connect with a personal API key, set the following:
- AuthScheme: APIKey.
- APIKey: A Linear personal API key.
To create a personal API key:
- Log in to Linear and open Settings > Security & access > Personal API keys.
- Select New API key, name it, and create it.
- Copy the key immediately. Linear shows it only once.
Authenticate with OAuth
The component supports the OAuth 2.0 authorization code grant. All OAuth flows require a custom OAuth application registered in Linear.
See Creating a Custom OAuth Application for the steps to create one.
Client Credentials
Use the client credentials grant to authenticate the application itself, with no user sign-in. This is suited to backend or machine-to-machine integrations that act as the OAuth application rather than on behalf of a specific user.
Set the following and connect:
- AuthScheme: OAuthClient.
- OAuthClientId: The Client ID from your OAuth application.
- OAuthClientSecret: The Client Secret from your OAuth application.
Note: To request specific OAuth scopes, set Scope to a comma-separated list (for example, read,write). When omitted, the component requests read,write. Scope is optional and is not a standard connection property.
No browser interaction or callback URL is required. The component obtains an access token directly from the Linear token endpoint and refreshes it automatically.
Desktop Applications
After registering a custom OAuth application, set the following and connect:
- InitiateOAuth: GETANDREFRESH. Use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
- OAuthClientId: The Client ID from your OAuth application.
- OAuthClientSecret: The Client Secret from your OAuth application.
- CallbackURL: The Callback URL defined in your OAuth application (for example, http://localhost:33333).
Note: To request specific OAuth scopes, set Scope to a comma-separated list (for example, read,write). When omitted, the component requests read,write. Scope is optional and is not a standard connection property.
When you connect, the component opens Linear's OAuth endpoint in your default browser. Log in and grant access to the application. The component then completes the OAuth process:
- The component obtains an access token from Linear and uses it to request data.
- The OAuth values are saved in the location specified by OAuthSettingsLocation and persist across connections.
Headless Machines
To authenticate on a machine without a browser, obtain the OAuth values on another machine that has a browser and transfer them.
- On a machine with a browser, register the custom OAuth application and complete a desktop or web flow to obtain an OAuthAccessToken and OAuthRefreshToken (or an OAuthVerifier).
- On the headless machine, set InitiateOAuth to REFRESH, supply OAuthClientId, OAuthClientSecret, the token values, and OAuthSettingsLocation. The component then refreshes the access token automatically.