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.

1. Navigate to Extensions > Manage Extensions.
2. In the Manage Extensions window's search box, search for "SQL Server Integration Services Projects 2022" and select the extension in the list.
3. Click Download.
4. Close Visual Studio and run the downloaded Microsoft.DataTools.IntegrationServices.exe installer. Proceed through the installer with default settings.
5. Open Visual Studio. There should now be an "Integration Services Project" project template available.

Adding the Adobe Analytics Connection Manager

Create a new connection manager as follows:

1. Create a Visual Studio project with the "Integration Services Project" template.
2. In the project, right-click within the Connection Managers window and select New Connection from the menu.
3. In the Description column, select CData Adobe Analytics Connection Manager and click Add...
4. Configure the component as described in the next section.

Alternatively, if you have an existing project and CData Adobe Analytics Source or CData Adobe Analytics Destination:

1. Right-click your CData Adobe Analytics source or destination component in your data flow
2. Select Edit... to open an editor window.
3. Click the New... button next to the Connection manager: dropdown selector to create a connection manager.
4. Configure the component as described in the next section.

Connecting to Adobe Analytics

To connect to Adobe Analytics, both the GlobalCompanyId and RSID must be identified. By default, the component attempts to identify your company and report suite automatically. However, you can also specify these values explicitly:

Global Company Id

The GlobalCompanyId is an optional connection property. If left empty, the component attempts to automatically detect the Global Company ID. To find the Global Company ID:

1. Locate it in the request URL for the users/me endpoint on the Swagger UI.
2. Expand the users endpoint, then click GET users/me.
3. Click Try it out > Execute.
4. Set the GlobalCompanyId connection property to the Global Company ID shown in the request URL immediately preceding the users/me endpoint.

Report Suite Id

RSID is also an optional connection property. If not set, the driver tries to detect it automatically. To view all of your report suites and their identifiers, go to Admin > Report Suites.

Authenticating to Adobe Analytics

Adobe Analytics uses the OAuth authentication standard. You can authenticate with OAuth integration or Service Account integration.

User Accounts (OAuth)

You must set AuthScheme to OAuth for all user account flows.

Desktop Applications

CData provides an embedded OAuth application that simplifies OAuth desktop authentication. Alternatively, you can create a custom OAuth application. Review Creating a Custom OAuth App for more information.

Get and Refresh the OAuth Access Token

Set the following properties to connect:

• InitiateOAuth: Set to GETANDREFRESH to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
• OAuthClientId (custom applications only): Set to the client Id assigned when you registered your app.
• OAuthClientSecret (custom applications only): Set to the client secret assigned when you registered your app.
• CallbackURL (custom application only): Set to the redirect URI defined when you registered your app. For example: https://localhost:3333

When you connect, the component opens Adobe Analytics's OAuth endpoint in your default browser. Log in and grant permissions to the application. The component then completes the OAuth process:

1. The component obtains an access token from Adobe Analytics and uses it to request data.
2. The OAuth values are saved in the location specified in OAuthSettingsLocation, to persist across connections.

The component refreshes the access token automatically when it expires.

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.

1. 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.
2. 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.

1. 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 assigned when you registered your application.
     • OAuthClientSecret: Set to the client secret assigned when you registered your application.
     Then call the GetOAuthAuthorizationURL stored procedure with the appropriate CallbackURL. Open the URL returned by the stored procedure in a browser.
2. Log in and grant permissions to the component. You are then redirected to the redirect URI. There will be a parameter called code appended to the redirect URI. Note the value of this parameter. Later you will set this in the OAuthVerifier connection property.

Next, you need to exchange the OAuth verifier code for OAuth refresh and access tokens.

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 this to the client Id in your custom OAuth application settings.
• OAuthClientSecret (custom applications only): Set this to the client secret in the custom OAuth 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 this to the client Id assigned when you registered your application.
• OAuthClientSecret: (custom applications only) Set this to the client secret assigned when you registered your application.
• 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 this to the client Id assigned when you registered your application.
• OAuthClientSecret: (custom applications only) Set this to the client secret assigned when you registered your application.
• 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.

Service Account

Service accounts have silent authentication, which does not require user authentication in the browser.
You need to create an application for this flow. Review Creating a Custom OAuth App to create and authorize an application. You can then connect to Adobe Analytics data that the service account has permission to access.

Server-to-Server OAuth

Set the AuthScheme to OAuthClient to authenticate with this method.

Set the following properties to connect:

• InitiateOAuth: Set to GETANDREFRESH.
• OAuthClientId: Set to the client Id in your app settings.
• OAuthClientSecret: Set to the client secret in your app settings.

When you connect, the component completes the OAuth flow for a service account.

1. Retrieves an access token by using the provided OAuthClientId and OAuthClientSecret in a Client Credentials OAuth flow.
2. Saves OAuth values in OAuthSettingsLocation to persist across connections.
3. Requests new access token when the token expires.