Adobe Analytics Connection
This documentation is based on version 21.0.8383 of the connector.
This documentation is based on version 21.0.8383 of the connector.
The connector leverages the AdobeAnalytics API to enable access to AdobeAnalytics.
GlobalCompanyId is an optional connection property. If left empty the driver tries to automatically detect it. If you want to manually specify the Global Company ID, you can find it in the request URL for the users/me endpoint on the Swagger UI. After logging into the Swagger UI, expand the users endpoint and then click the GET users/me button. Click the Try it out and Execute buttons. Note your Global Company ID shown in the Request URL immediately preceding the users/me endpoint.
RSID is an optional connection property. If not set the driver tries to automatically detect it. Use this property if you want to manually specify the report suite. To get a full list of your report suites along with their identifiers next to the name, navigate to Admin -> Report Suites.
After setting the OAuth connection properties, you are ready to connect to Adobe Analytics
Adobe Analytics uses the OAuth authentication standard. You can authenticate with OAuth integration or Service Account integration.
Note: Set the AuthScheme to OAuth to authenticate with this method.
To authenticate using OAuth, you can either create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties or use the Embedded Credentials. See Using OAuth Authentication for an authentication guide.
Note: Set the AuthScheme to OAuthJWT to authenticate with this method.
Service accounts have silent authentication, without user authentication in the browser.
You need to create an application in this flow. See Creating a Custom OAuth App to create and authorize an app. You can then connect to Adobe Analytics data that the service account has permission to access.
After setting the following connection properties, you are ready to connect:
When you connect the connector completes the OAuth flow for a service account.
OAuth requires the authenticating user to interact with Adobe Analytics using the browser. The connector facilitates this in various ways as described below.
You will need to register an app to obtain the OAuthClientId and OAuthClientSecret.
See Creating a Custom OAuth App for a procedure.
You can connect without setting any connection properties for your user credentials. After setting the following, you are ready to connect:
When you connect the connector opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process.
You must create a custom OAuth app to connect to the Adobe Analytics.
After setting the following, you are ready to connect:
To create Adobe Analytics data sources on headless servers or other machines on which the connector cannot open a browser, you need to authenticate from another machine. Authentication is a two-step process.
Create a Custom OAuth App
You might want to create a custom OAuth app to change the information displayed when users log into Adobe Analytics to grant permissions to the connector.
See Creating a Custom OAuth App for a procedure. You can then follow the procedures below to authenticate and connect to data.
Obtain a Verifier Code
Set the following properties on the headless machine:
You can then follow the steps below to authenticate from another machine and obtain the OAuthVerifier connection property.
On the headless machine, set the following connection properties to obtain the OAuth authentication values:
After the OAuth settings file is generated, set the following properties to connect to data:
Transfer OAuth Settings
Follow the steps below to install the connector on another machine, authenticate, and then transfer the resulting OAuth values.
On a second machine, install the connector and connect with the following properties set:
Test the connection to authenticate. The resulting authentication values are written, encrypted, to the path specified by OAuthSettingsLocation. Once you have successfully tested the connection, copy the OAuth settings file to your headless machine. On the headless machine, set the following connection properties to connect to data:
You must create a custom OAuth app to connect to the Adobe Analytics.
Follow the steps below to create a custom app and obtain the connection properties in a specific OAuth authentication flow.
Follow the steps below to create a custom app and obtain the connection properties in a specific Service Account authentication flow.
This section details a selection of advanced features of the Adobe Analytics connector.
The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.
Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.
To configure the connector using Private Agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.
The Jitterbit Connector for Adobe Analytics allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.
There are two ways to create user defined views:User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.
This User Defined View configuration file is formatted as follows:For example:
{ "MyView": { "query": "SELECT * FROM SampleTable_1 WHERE MyColumn = 'value'" }, "MyView2": { "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)" } }Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"
SELECT * FROM Customers WHERE City = 'Raleigh';An example of a query to the driver:
SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';Resulting in the effective query to the source:
SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.
By default, the connector attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.
To specify another certificate, see the SSLServerCert property for the available formats to do so.
The Jitterbit Connector for Adobe Analytics models Adobe Analytics objects as relational tables and views. The following sections show the available API objects and provide more information on executing SQL to Adobe Analytics APIs.
NOTE: Stored procedures are not currently supported. See the above note for details.
Stored Procedures are function-like interfaces to the data source. They can be used to access additional capabilities of the Adobe Analytics API.
Reports are shown as views, tables that cannot be modified. Unlike traditional database views, however, it is not very helpful to select all metrics and dimensions in a given table. Date is the default dimension for every report, so the query:
SELECT * FROM MyReportwill become:
SELECT Date, {all the metrics here} FROM MyReportBut if the query has criteria, then the default dimensions will be the dimensions used in the criteria, like:
SELECT * FROM MyReport WHERE Country = 'England'will become:
SELECT Country, {all the metrics here} FROM MyReport WHERE Country = 'England'Additionally, the Adobe Analytics API limits the number of dimensions you can request data for per REST API call to one. This means that the only way for the provider to generate reports with multiple dimensions is to break down dimensions.
SELECT Country, City, Visits FROM MyReport
If we would have a third dimension, the provider would break down every city with the third dimension (which means would make one request per city).
Now, imagine a four dimensional report where dimensions have many values. The generation of that report would require a lot of API calls.
However, the Adobe Analytics API allows us to provide some filters that can shorten the execution time of the query, tremendously.
Adobe Analytics API uses the following logical operators: 'AND', 'OR', 'NOT'
and also uses the following operators: 'MATCH', 'CONTAINS', 'BEGINS-WITH' and 'ENDS-WITH', which means criteria such as those below will be handled server-side:
... WHERE Dimension = 'Value' ... WHERE Dimension LIKE '%value%' ... WHERE Dimension1 LIKE '%value' AND Dimension2 = 'Value2' ... WHERE Dimension LIKE 'value%' ... WHERE Dimension1 = 'Value1' AND Dimension2 = 'Value2' ... WHERE Dimension = 'Value1' OR Dimension = 'Value2' OR Dimension = 'Value3' ... WHERE Dimension IN ('Value1', 'Value2', 'Value3', 'Value4') ... WHERE (Dimension1 = 'value1' OR Dimension1 = 'Value2') AND (Dimension2 = 'value3' OR Dimension2 = 'value4')It is strongly recommended to use as many filters as possible, otherwise queries with many dimensions can take a lot of time.
To create a report view on a query, you can use the CreateReport stored procedure. The CreateReport stored procedure* provides an easy way to generate new view definitions with a custom combination of Dimensions and Metrics. Calling it will create a new schema file that you can query like any other view.
The stored procedure* takes a view name, a comma-separated list of metric names, a comma-separated list of metric ids, a comma-separated list of dimension names, a comma-separated list of dimension ids, and an output folder as inputs. You will need to set the Location connection property to the folder containing the new script files in order to access them; the Location can be set instead of the output folder.SELECT Id, Name FROM Dimensions SELECT Id, Name FROM MetricsFor example, to use a new schema along with the default schemas, set the Location property to the db subfolder in the installation folder and make the following call:
EXEC CreateReport Dimensions = 'Country, City', Metrics = 'PageViews, Visits', TableName = 'MyCustomReport'The connector offloads as much of the SELECT statement processing as possible to the Adobe Analytics APIs and then processes the rest of the query in memory. See SupportEnhancedSQL for more information on how the connector circumvents API limitations with in-memory client-side processing.
Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure* is available to update the data if such functionality is applicable to the data source.
Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard. To find out more about tables and stored procedures, please navigate to their corresponding entries in this help document.
Name | Description |
AdsReport | Generate data reports regarding the ads of your website. |
CalculatedMetrics | Query the available calculated metrics in AdobeAnalytics. |
CollectionSuites | Query the available collection suites in AdobeAnalytics. |
Dimensions | Query the available dimensions in AdobeAnalytics. |
Metrics | Query the available metrics in AdobeAnalytics. |
OrdersReport | Generate data reports for orders made on your website. |
ProductsReport | Generate data reports regarding your products. |
Segments | Query the available segments in AdobeAnalytics. |
SiteReport | Generate data reports regarding your website traffic. |
Users | Query the available users in AdobeAnalytics. |
Generate data reports regarding the ads of your website.
Refer to the explanation in the "Data Model" section to learn how to build optimal queries. The following are some use cases for this report:
SELECT Country, City, AdClicks, AdImpressions, ClickThroughs FROM AdsReport SELECT Page, AdClicks, AdImpressions, ClickThroughs FROM AdsReport SELECT Date, Revenue FROM AdsReportYou can turn on client-side execution by setting SupportEnhancedSQL to true in which case any filter that Adobe Analytics doesn't handle, will be handled client-side.
Name | Type | IsDimension | IsMetric | DefaultDimension | Description |
Country | String | True | Name of the country. | ||
City | String | True | Name of the city. | ||
Page | String | True | Name of the page the ad was on. | ||
Date | Date | True | True | The datetime of the given data. | |
PageViews | Int | True | Number of pageviews. | ||
AdClicks | Int | True | Number of adclicks. | ||
AdImpressions | Int | True | Number of adimpressions. | ||
ClickThroughs | Int | True | Number of clickthroughs. | ||
Revenue | Decimal | True | Revenue made from the ads. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartDate | Datetime | Use this to filter reports by the start date of the report. |
EndDate | Datetime | Use this to filter reports by the end date of the report. |
SegmentId | String | Use this to filter reports by a particular segment. |
Query the available calculated metrics in AdobeAnalytics.
Name | Type | IsDimension | IsMetric | DefaultDimension | Description |
Id [KEY] | String | Unique identifier of the calculated metric. | |||
Name | String | The name of the calculated metric. | |||
ReportSuiteName | String | The name of the report suite the calculated metric is in. | |||
Description | String | A description for the calculated metric. | |||
Created | Datetime | The datetime the calculated metric was created. | |||
Modified | Datetime | The datetime the calculated metric was modified. | |||
Type | String | The type of the calculated metric. For example int, decimal, percentage etc. | |||
OwnerId | String | Unique identifier of the user that created the calculated metric. | |||
OwnerName | String | Name of the user that created the calculated metric. | |||
Category | String | The category of the calculated metric. | |||
SiteTitle | String | The title of the site. | |||
Polarity | String | Takes two value: positive and negative. Determines if it's positive or not if the metric increases. | |||
Precision | Integer | The precision of the calculated metric. | |||
Template | String | Additional attribute used to identify templates when IncludeType=templates. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
IncludeType | String | By default, responses without this parameter include only calculated metrics owned by the user. The following values are possible: 1) all: Returns all calculated metrics linked to this company. 2) shared: Returns calculated metrics shared with the user. 3) templates: Returns all calculated metric templates. |
Query the available collection suites in AdobeAnalytics.
Name | Type | IsDimension | IsMetric | DefaultDimension | Description |
Rsid [KEY] | String | Unique identifier of the collection suite. | |||
Name | String | The name of the collection suite. | |||
ParentRsid | String | Unique identifier of the parent of this collection suite. | |||
Currency | String | Default currency used in this collection suite. | |||
Type | String | The type of the collection suite. For example, report suite. | |||
Timezone | String | The timezone of the collection suite. |
Query the available dimensions in AdobeAnalytics.
Name | Type | IsDimension | IsMetric | DefaultDimension | Description |
Id [KEY] | String | Unique identifier of the dimension. | |||
RSID | String | Unique identifier of the report suite the dimension is in. | |||
Title | String | The title of the dimension. | |||
Name | String | The name of the dimension. | |||
Type | String | The type of the dimension. For example string, int, enum etc. | |||
Description | String | A description of the dimension. | |||
Category | String | The category of the dimension. | |||
Pathable | Boolean | Whether or not the dimension is pathable. | |||
Segmentable | Boolean | Whether or not the dimension is segmentable. | |||
ReportType | String | The type of the reports in which this dimension is valid. | |||
Support | String | The type of the reports in which this dimension is supported. |
Query the available metrics in AdobeAnalytics.
Name | Type | IsDimension | IsMetric | DefaultDimension | Description |
Id [KEY] | String | Unique identifier of the metric. | |||
RSID | String | Unique identifier of the report suite the metric is in. | |||
Title | String | The title of the metric. | |||
Name | String | The name of the metric. | |||
Type | String | The type of the metric, for example int, percent, currency etc. | |||
Description | String | A description for the metric. | |||
Category | String | The category of the metric. | |||
Calculated | Boolean | Whether or not this metric is calculated metric. | |||
Segmentable | Boolean | Whether or not this metric is segmentable. | |||
Polarity | String | Takes two value: positive and negative. Determines if it's positive or not if the metric increases. | |||
Precision | Integer | The precision of the metric. |
Generate data reports for orders made on your website.
Refer to the explanation in the "Data Model" section to learn how to build optimal queries. The following are some use cases for this report:
SELECT Date, CartViews, CartAdditions, CartRemovals FROM OrdersReport SELECT Date, Orders, OrdersPerVisitor FROM OrdersReport SELECT Date, Revenue FROM OrdersReportYou can turn on client-side execution by setting SupportEnhancedSQL to true in which case any filter that Adobe Analytics doesn't handle, will be handled client-side.
Name | Type | IsDimension | IsMetric | DefaultDimension | Description |
Date | Date | True | True | The datetime of the given data. | |
Carts | Int | True | Number of carts. | ||
CartAdditions | Int | True | Number of cart additions. | ||
CartRemovals | Int | True | Number of carts removed. | ||
CartViews | Int | True | Number of cart views. | ||
Orders | Int | True | Number of orders made. | ||
ConversionRate | Int | True | Percentage of orders converted to purchase. | ||
OrdersPerVisitor | Int | True | Number of orders per visitor. | ||
Revenue | Decimal | True | Revenue made from sales. | ||
RevenuePerOrder | Decimal | True | Average revenue per each order. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartDate | Datetime | Use this to filter reports by the start date of the report. |
EndDate | Datetime | Use this to filter reports by the end date of the report. |
SegmentId | String | Use this to filter reports by a particular segment. |
Generate data reports regarding your products.
Refer to the explanation in the "Data Model" section to learn how to build optimal queries. The following are some use cases for this report:
SELECT Product, Date, ProductViews, Units FROM ProductsReport SELECT Product, Orders, Checkouts FROM ProductsReport SELECT Product, Date, Revenue FROM ProductsReportYou can turn on client-side execution by setting SupportEnhancedSQL to true in which case any filter that Adobe Analytics doesn't handle, is handled client-side.
Name | Type | IsDimension | IsMetric | DefaultDimension | Description |
Product | String | True | Name of the product. | ||
Date | Date | True | True | The datetime of the given data. | |
ProductViews | Int | True | Number of views a products has received. | ||
CartAdditions | Int | True | Number of times the product was added in a cart. | ||
Checkouts | Int | True | Number of checkouts. | ||
Orders | Int | True | Number of orders. | ||
Units | Int | True | Number of units. | ||
Revenue | Decimal | True | Revenue made from products sales. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartDate | Datetime | Use this to filter reports by the start date of the report. |
EndDate | Datetime | Use this to filter reports by the end date of the report. |
SegmentId | String | Use this to filter reports by a particular segment. |
Query the available segments in AdobeAnalytics.
Name | Type | IsDimension | IsMetric | DefaultDimension | Description |
Id [KEY] | String | Unique identifier of the segment. | |||
Name | String | The name of the segment. | |||
ReportSuiteName | String | The name of the report suite the segment was created in. | |||
Description | String | A description for the segment. | |||
Created | Datetime | The datetime the segment was created. | |||
Modified | Datetime | The datetime the segment was last modified. | |||
OwnerId | String | The unique identifier of the user that created the segment. | |||
OwnerName | String | The name of the user that created the segment. | |||
Version | String | The version of the segment. | |||
Type | String | A comma-separated list of segment types. Allowed values are: shared, templates, curatedItem . | |||
SiteTitle | String | The title of the site. |
Generate data reports regarding your website traffic.
Refer to the explanation in the "Data Model" section to learn how to build optimal queries. The following are some use cases for this report:
Where is most of the traffic coming from? (country / city)
SELECT Country, City, PageViews, Visits FROM SiteReportWhat time of the day is the website the busiest?
SELECT HourOfDay, PageViews, Visits FROM SiteReportWhich search engines do our users most commonly use to find us?
SELECT SearchEngine, Visits, UniqueVisitors FROM SiteReportWho is referring users to visit us?
SELECT Referrer, Visits, UniqueVisitors FROM SiteReportDo people come to stay or do they usually bounce?
SELECT Date, Bounces, BounceRate FROM SiteReportWhat is the most viewed page?
SELECT Page, PageViews, Visits, UniqueVisitors FROM SiteReportYou can turn on client-side execution by setting SupportEnhancedSQL to true in which case any filter that Adobe Analytics doesn't handle, will be handled client-side.
Name | Type | IsDimension | IsMetric | DefaultDimension | Description |
Date | Date | True | True | The datetime of the first log entry of a session. | |
HourOfDay | String | True | The hour of day of the first log entry of a session. | ||
Country | String | True | Groups web traffic by the country where the client was in. | ||
City | String | True | Groups web traffic by the city where the client was in. | ||
SearchEngine | String | True | The second level domain name of the first web site (which is a search engine) that referred a visitor to the site during a session (as supplied by the visitor's browser). | ||
Browser | String | True | The type of user agent used by the visitor, including the version number (for example, MSIE 6.0). | ||
OperatingSystems | String | True | Groups web traffic by the operating system used by the client. Mobile and desktop operating systems appear on this report. | ||
Page | String | True | The name of each page visited during a session. Initially, each page's name is the same as the URI, but can be changed for easier interpretation. | ||
Referrer | String | True | The second level domain name of the web site that first referred a session to the site (as supplied by the visitor's browser). | ||
PageViews | Integer | True | The number of page views. A page view is a request for a defined page (access to images and other types of filtered content are not counted). | ||
Visits | Integer | True | The number of visits. | ||
UniqueVisitors | Integer | True | The number of unique visitors. | ||
Bounces | Integer | True | The number of bounces. A bounce is a visit that consists of a single server call. | ||
BounceRate | Integer | True | The percentage of visits that contain a single hit. | ||
SinglePageVisits | Integer | True | The number of single page visit. | ||
TimeSpentPerVisit | Integer | True | The average amount of time visitors interact with a specific dimension item during each visit. | ||
TimeSpentPerVisitor | Integer | True | The average amount of time visitors interact with a specific dimension item across the visitor's lifetime (length of their cookie). | ||
TotalSecondsSpent | Integer | True | Represents the total amount of time visitors interact with a specific dimension item. | ||
Revenue | Decimal | True | The total dollar amount for the sum of the order for each product. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartDate | Datetime | Use this to filter reports by the start date of the report. |
EndDate | Datetime | Use this to filter reports by the end date of the report. |
SegmentId | String | Use this to filter reports by a particular segment. |
Query the available users in AdobeAnalytics.
Name | Type | IsDimension | IsMetric | DefaultDimension | Description |
LoginId [KEY] | String | Unique identifier of the user. | |||
ImsUserId | String | The IMS User Id. This is used only for internal users such as authors, reviewers, administrators, developers, etc. | |||
CompanyId | String | Unique identifier of the company. | |||
CreateDate | Timestamp | The date when user was created. | |||
Disabled | Boolean | Whether or not this user's account is disabled. | |||
String | The email of the user. | ||||
FirstName | String | The first name of the user. | |||
LastName | String | The last name of the user. | |||
FullName | String | The full name of the user. | |||
LastAccess | Timestamp | When the user accessed his account for the last time. | |||
LastLogin | Timestamp | When the user logged in for the last time. | |||
Login | String | Login name. | |||
PhoneNumber | String | The phone number of the user. | |||
Title | String | The user's title. |
NOTE: Stored procedures are not currently supported. See the above note for details.
Stored procedures* are available to complement the data available from the Data Model. It may be necessary to update data available from a view using a stored procedure* because the data does not provide for direct, table-like, two-way updates. In these situations, the retrieval of the data is done using the appropriate view or table, while the update is done by calling a stored procedure. Stored procedures* take a list of parameters and return back a dataset that contains the collection of tuples that constitute the response.
Name | Description |
CreateReport | Creates a custom report by providing dimensions and metrics. |
GetOAuthAccessToken | Gets an authentication token from AdobeAnalytics. |
GetOAuthAuthorizationURL | Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the OAuthAccessToken from this URL. |
RefreshOAuthAccessToken | Adobe Analytics does not support refreshing token. So, this stored procedure* will call the GetOAuthAccessToken procedure internally, to initiate OAuth flow from the start. |
Creates a custom report by providing dimensions and metrics.
To create a report view on a query, you can use the CreateReport stored procedure. The CreateReport stored procedure* provides an easy way to generate new view definitions with a custom combination of Dimensions and Metrics. Calling it will create a new schema file that you can query like any other view.
The stored procedure* takes a view name, a comma-separated list of metric names, a comma-separated list of metric ids, a comma-separated list of dimension names, a comma-separated list of dimension ids and an output folder as inputs. You will need to set the Location connection property to the folder containing the new script files in order to access them; the Location can be set instead of the output folder.
You can get the metric/dimension Ids by querying Metrics/Dimensions views.
SELECT Id, Name FROM Dimensions SELECT Id, Name FROM MetricsFor example, to use a new schema along with the default schemas, set the Location property to the db subfolder in the installation folder and make the following call:
EXEC CreateReport Dimensions = 'Country, City', DimensionIds = 'variables/geocountry, variables/geocity', Metrics = 'PageViews, Visits', MetricIds = 'metrics/pageviews, metrics/visits', TableName = 'MyCustomReport'Dimensions and Metrics should have their respective Ids specified in DimensionIds and MetricIds inputs.
Name | Type | Required | Description |
TableName | String | True | The name for the new table. |
Description | String | False | An optional description for the table. |
OutputFolder | String | False | The path to output the new schema file to. The value for the Location connection string property will be used by default. You will need to set the Location connection property to the location of your schema files. |
DimensionIds | String | True | A comma-separated list of dimensions' ids. |
MetricIds | String | True | A comma-separated list of metrics' ids. |
Name | Type | Description |
Success | String | Whether or not the schema was created successfully. |
SchemaFile | String | The generated schema file. |
Gets an authentication token from AdobeAnalytics.
Name | Type | Required | Description |
AuthMode | String | False | The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app.
The allowed values are APP, WEB. The default value is APP. |
Scopes | String | False | A comma-separated list of permissions to request from the user. Please check the AdobeAnalytics API for a list of available permissions.
The default value is openid, AdobeID, read_organizations, additional_info.job_function, additional_info.projectedProductContext. |
CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL you have specified in the AdobeAnalytics app settings. Only needed when the Authmode parameter is Web. |
Verifier | String | False | The verifier returned from AdobeAnalytics after the user has authorized your app to have access to their data. This value will be returned as a parameter to the callback URL. |
State | String | False | Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the AdobeAnalytics authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations. |
Name | Type | Description |
OAuthAccessToken | String | The access token used for communication with AdobeAnalytics. |
OAuthRefreshToken | String | The OAuth refresh token. This is the same as the access token in the case of AdobeAnalytics. |
ExpiresIn | String | The remaining lifetime on the access token. A -1 denotes that it will not expire. |
Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the OAuthAccessToken from this URL.
Name | Type | Required | Description |
CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL in the AdobeAnalytics app settings. |
Scopes | String | False | A comma-separated list of scopes to request from the user. Please check the AdobeAnalytics API documentation for a list of available permissions.
The default value is openid, AdobeID, read_organizations, additional_info.job_function, additional_info.projectedProductContext. |
State | String | False | Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the AdobeAnalytics authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations. |
Name | Type | Description |
URL | String | The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app. |
Adobe Analytics does not support refreshing token. So, this stored procedure* will call the GetOAuthAccessToken procedure internally, to initiate OAuth flow from the start.
Name | Type | Required | Description |
OAuthRefreshToken | String | False | Set this to some test value. It won't make a difference since this procedure will start the OAuth flow from start.
The default value is test. |
Name | Type | Description |
OAuthAccessToken | String | The authentication token returned from AdobeAnalytics. This can be used in subsequent calls to other operations for this particular service. |
ExpiresIn | String | The remaining lifetime on the access token. |
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
The following tables return database metadata for Adobe Analytics:
The following tables return information about how to connect to and query the data source:
The following table returns query statistics for data modification queries:
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
Name | Type | Description |
CatalogName | String | The database name. |
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
Name | Type | Description |
CatalogName | String | The database name. |
SchemaName | String | The schema name. |
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
Name | Type | Description |
CatalogName | String | The database containing the table or view. |
SchemaName | String | The schema containing the table or view. |
TableName | String | The name of the table or view. |
TableType | String | The table type (table or view). |
Description | String | A description of the table or view. |
IsUpdateable | Boolean | Whether the table can be updated. |
Describes the columns of the available tables and views.
The following query returns the columns and data types for the SampleTable_1 table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='SampleTable_1'
Name | Type | Description |
CatalogName | String | The name of the database containing the table or view. |
SchemaName | String | The schema containing the table or view. |
TableName | String | The name of the table or view containing the column. |
ColumnName | String | The column name. |
DataTypeName | String | The data type name. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The storage size of the column. |
DisplaySize | Int32 | The designated column's normal maximum width in characters. |
NumericPrecision | Int32 | The maximum number of digits in numeric data. The column length in characters for character and date-time data. |
NumericScale | Int32 | The column scale or number of digits to the right of the decimal point. |
IsNullable | Boolean | Whether the column can contain null. |
Description | String | A brief description of the column. |
Ordinal | Int32 | The sequence number of the column. |
IsAutoIncrement | String | Whether the column value is assigned in fixed increments. |
IsGeneratedColumn | String | Whether the column is generated. |
IsHidden | Boolean | Whether the column is hidden. |
IsArray | Boolean | Whether the column is an array. |
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
Name | Type | Description |
CatalogName | String | The database containing the stored procedure. |
SchemaName | String | The schema containing the stored procedure. |
ProcedureName | String | The name of the stored procedure. |
Description | String | A description of the stored procedure. |
ProcedureType | String | The type of the procedure, such as PROCEDURE or FUNCTION. |
Describes stored procedure* parameters.
The following query returns information about all of the input parameters for the SampleProcedure stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName='SampleProcedure' AND Direction=1 OR Direction=2
Name | Type | Description |
CatalogName | String | The name of the database containing the stored procedure. |
SchemaName | String | The name of the schema containing the stored procedure. |
ProcedureName | String | The name of the stored procedure* containing the parameter. |
ColumnName | String | The name of the stored procedure* parameter. |
Direction | Int32 | An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters. |
DataTypeName | String | The name of the data type. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric data. |
NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time data. |
NumericScale | Int32 | The number of digits to the right of the decimal point in numeric data. |
IsNullable | Boolean | Whether the parameter can contain null. |
IsRequired | Boolean | Whether the parameter is required for execution of the procedure. |
IsArray | Boolean | Whether the parameter is an array. |
Description | String | The description of the parameter. |
Ordinal | Int32 | The index of the parameter. |
Describes the primary and foreign keys. The following query retrieves the primary key for the SampleTable_1 table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='SampleTable_1'
Name | Type | Description |
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
IsKey | Boolean | Whether the column is a primary key in the table referenced in the TableName field. |
IsForeignKey | Boolean | Whether the column is a foreign key referenced in the TableName field. |
PrimaryKeyName | String | The name of the primary key. |
ForeignKeyName | String | The name of the foreign key. |
ReferencedCatalogName | String | The database containing the primary key. |
ReferencedSchemaName | String | The schema containing the primary key. |
ReferencedTableName | String | The table containing the primary key. |
ReferencedColumnName | String | The column name of the primary key. |
Describes the foreign keys. The following query retrieves all foreign keys which refer to other tables:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Name | Type | Description |
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
PrimaryKeyName | String | The name of the primary key. |
ForeignKeyName | String | The name of the foreign key. |
ReferencedCatalogName | String | The database containing the primary key. |
ReferencedSchemaName | String | The schema containing the primary key. |
ReferencedTableName | String | The table containing the primary key. |
ReferencedColumnName | String | The column name of the primary key. |
ForeignKeyType | String | Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key. |
Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.
The following query retrieves all indexes that are not primary keys:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
Name | Type | Description |
CatalogName | String | The name of the database containing the index. |
SchemaName | String | The name of the schema containing the index. |
TableName | String | The name of the table containing the index. |
IndexName | String | The index name. |
ColumnName | String | The name of the column associated with the index. |
IsUnique | Boolean | True if the index is unique. False otherwise. |
IsPrimary | Boolean | True if the index is a primary key. False otherwise. |
Type | Int16 | An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3). |
SortOrder | String | The sort order: A for ascending or D for descending. |
OrdinalPosition | Int16 | The sequence number of the column in the index. |
Returns information on the available connection properties and those set in the connection string.
When querying this table, the config connection string should be used:
jdbc:cdata:adobeanalytics:config:
This connection string enables you to query this table without a valid connection.
The following query retrieves all connection properties that have been set in the connection string or set through a default value:
SELECT * FROM sys_connection_props WHERE Value <> ''
Name | Type | Description |
Name | String | The name of the connection property. |
ShortDescription | String | A brief description. |
Type | String | The data type of the connection property. |
Default | String | The default value if one is not explicitly set. |
Values | String | A comma-separated list of possible values. A validation error is thrown if another value is specified. |
Value | String | The value you set or a preconfigured default. |
Required | Boolean | Whether the property is required to connect. |
Category | String | The category of the connection property. |
IsSessionProperty | String | Whether the property is a session property, used to save information about the current connection. |
Sensitivity | String | The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms. |
PropertyName | String | A camel-cased truncated form of the connection property name. |
Ordinal | Int32 | The index of the parameter. |
CatOrdinal | Int32 | The index of the parameter category. |
Hierarchy | String | Shows dependent properties associated that need to be set alongside this one. |
Visible | Boolean | Informs whether the property is visible in the connection UI. |
ETC | String | Various miscellaneous information about the property. |
Describes the SELECT query processing that the connector can offload to the data source.
When working with data sources that do not support SQL-92, you can query the sys_sqlinfo view to determine the query capabilities of the underlying APIs, expressed in SQL syntax. The connector offloads as much of the SELECT statement processing as possible to the server and then processes the rest of the query in memory.
Below is an example data set of SQL capabilities. The following result set indicates the SELECT functionality that the connector can offload to the data source or process client side. Your data source may support additional SQL syntax. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.
Name | Description | Possible Values |
AGGREGATE_FUNCTIONS | Supported aggregation functions. | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
COUNT | Whether COUNT function is supported. | YES, NO |
IDENTIFIER_QUOTE_OPEN_CHAR | The opening character used to escape an identifier. | [ |
IDENTIFIER_QUOTE_CLOSE_CHAR | The closing character used to escape an identifier. | ] |
SUPPORTED_OPERATORS | A list of supported SQL operators. | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
GROUP_BY | Whether GROUP BY is supported, and, if so, the degree of support. | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
STRING_FUNCTIONS | Supported string functions. | LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE |
NUMERIC_FUNCTIONS | Supported numeric functions. | ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE |
TIMEDATE_FUNCTIONS | Supported date/time functions. | NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT |
REPLICATION_SKIP_TABLES | Indicates tables skipped during replication. | |
REPLICATION_TIMECHECK_COLUMNS | A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication. | |
IDENTIFIER_PATTERN | String value indicating what string is valid for an identifier. | |
SUPPORT_TRANSACTION | Indicates if the provider supports transactions such as commit and rollback. | YES, NO |
DIALECT | Indicates the SQL dialect to use. | |
KEY_PROPERTIES | Indicates the properties which identify the uniform database. | |
SUPPORTS_MULTIPLE_SCHEMAS | Indicates if multiple schemas may exist for the provider. | YES, NO |
SUPPORTS_MULTIPLE_CATALOGS | Indicates if multiple catalogs may exist for the provider. | YES, NO |
DATASYNCVERSION | The Data Sync version needed to access this driver. | Standard, Starter, Professional, Enterprise |
DATASYNCCATEGORY | The Data Sync category of this driver. | Source, Destination, Cloud Destination |
SUPPORTSENHANCEDSQL | Whether enhanced SQL functionality beyond what is offered by the API is supported. | TRUE, FALSE |
SUPPORTS_BATCH_OPERATIONS | Whether batch operations are supported. | YES, NO |
SQL_CAP | All supported SQL capabilities for this driver. | SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX |
PREFERRED_CACHE_OPTIONS | A string value specifies the preferred cacheOptions. | |
ENABLE_EF_ADVANCED_QUERY | Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. | YES, NO |
PSEUDO_COLUMNS | A string array indicating the available pseudo columns. | |
MERGE_ALWAYS | If the value is true, The Merge Mode is forcibly executed in Data Sync. | TRUE, FALSE |
REPLICATION_MIN_DATE_QUERY | A select query to return the replicate start datetime. | |
REPLICATION_MIN_FUNCTION | Allows a provider to specify the formula name to use for executing a server side min. | |
REPLICATION_START_DATE | Allows a provider to specify a replicate startdate. | |
REPLICATION_MAX_DATE_QUERY | A select query to return the replicate end datetime. | |
REPLICATION_MAX_FUNCTION | Allows a provider to specify the formula name to use for executing a server side max. | |
IGNORE_INTERVALS_ON_INITIAL_REPLICATE | A list of tables which will skip dividing the replicate into chunks on the initial replicate. | |
CHECKCACHE_USE_PARENTID | Indicates whether the CheckCache statement should be done against the parent key column. | TRUE, FALSE |
CREATE_SCHEMA_PROCEDURES | Indicates stored procedures* that can be used for generating schema files. |
SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.
Name | Type | Description |
NAME | String | A component of SQL syntax, or a capability that can be processed on the server. |
VALUE | String | Detail on the supported SQL or SQL syntax. |
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
Name | Type | Description |
Id | String | The database-generated ID returned from a data modification operation. |
Batch | String | An identifier for the batch. 1 for a single operation. |
Operation | String | The result of the operation in the batch: INSERTED, UPDATED, or DELETED. |
Message | String | SUCCESS or an error message if the update in the batch failed. |
The advanced configurations properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure. Click the links for further details.
Property | Description |
AuthScheme | The type of authentication to use when connecting to Adobe Analytics. |
GlobalCompanyId | Your company identifier. If not set the driver tries to automatically detect it. |
RSID | Your report suite identifier. If not set the driver tries to automatically detect it. |
Property | Description |
InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
OAuthClientId | The client ID assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
OAuthAccessToken | The access token for connecting using OAuth. |
CallbackURL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
Property | Description |
OAuthJWTCert | The JWT Certificate store. |
OAuthJWTCertType | The type of key store containing the JWT Certificate. |
OAuthJWTCertPassword | The password for the OAuth JWT certificate. |
OAuthJWTCertSubject | The subject of the OAuth JWT certificate. |
OAuthJWTIssuer | The issuer of the Java Web Token. |
OAuthJWTSubject | The user subject for which the application is requesting delegated access. |
Property | Description |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
Property | Description |
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC. |
Property | Description |
MaxRows | Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time. |
Other | These hidden properties are used only in specific use cases. |
Pagesize | The maximum number of results to return per page from Adobe Analytics. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
This section provides a complete list of authentication properties you can configure.
Property | Description |
AuthScheme | The type of authentication to use when connecting to Adobe Analytics. |
GlobalCompanyId | Your company identifier. If not set the driver tries to automatically detect it. |
RSID | Your report suite identifier. If not set the driver tries to automatically detect it. |
The type of authentication to use when connecting to Adobe Analytics.
string
"Auto"
Your company identifier. If not set the driver tries to automatically detect it.
string
""
Your company identifier. If not set the driver tries to automatically detect it.
Your report suite identifier. If not set the driver tries to automatically detect it.
string
""
Your report suite identifier. If not set the driver tries to automatically detect it.
This section provides a complete list of OAuth properties you can configure.
Property | Description |
InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
OAuthClientId | The client ID assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
OAuthAccessToken | The access token for connecting using OAuth. |
CallbackURL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
string
"OFF"
The following options are available:
The client ID assigned when you register your application with an OAuth authorization server.
string
""
As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.
The client secret assigned when you register your application with an OAuth authorization server.
string
""
As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.
The access token for connecting using OAuth.
string
""
The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.
The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.
The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
string
"http://localhost:33333"
During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.
The verifier code returned from the OAuth authorization URL.
string
""
The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.
See to obtain the OAuthVerifier value.
Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the connector exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified file. Set InitiateOAuth to GETANDREFRESH automate the exchange.
Once the OAuth settings file has been generated, you can remove OAuthVerifier from the connection properties and connect with OAuthSettingsLocation set. To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.The OAuth refresh token for the corresponding OAuth access token.
string
""
The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.
The lifetime in seconds of the OAuth AccessToken.
string
""
Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.
The Unix epoch timestamp in milliseconds when the current Access Token was created.
string
""
Pair with OAuthExpiresIn to determine when the AccessToken will expire.
This section provides a complete list of JWT OAuth properties you can configure.
Property | Description |
OAuthJWTCert | The JWT Certificate store. |
OAuthJWTCertType | The type of key store containing the JWT Certificate. |
OAuthJWTCertPassword | The password for the OAuth JWT certificate. |
OAuthJWTCertSubject | The subject of the OAuth JWT certificate. |
OAuthJWTIssuer | The issuer of the Java Web Token. |
OAuthJWTSubject | The user subject for which the application is requesting delegated access. |
The JWT Certificate store.
string
""
The name of the certificate store for the client certificate.
The OAuthJWTCertType field specifies the type of the certificate store specified by OAuthJWTCert. If the store is password protected, specify the password in OAuthJWTCertPassword.
OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject field in order to specify client certificates. If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, a search for a certificate is initiated. Please refer to the OAuthJWTCertSubject field for details.Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
SPC | Software publisher certificates. |
In Java, the certificate store normally is a file containing certificates and optional private keys.
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
The type of key store containing the JWT Certificate.
string
"PEMKEY_FILE"
This property can take one of the following values:
USER | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java. |
MACHINE | For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java. |
PFXFILE | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
PFXBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format. |
JKSFILE | The certificate store is the name of a Java key store (JKS) file containing certificates. Note: this store type is only available in Java. |
JKSBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in Java key store (JKS) format. Note: this store type is only available in Java. |
PEMKEY_FILE | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
PEMKEY_BLOB | The certificate store is a string (base64-encoded) that contains a private key and an optional certificate. |
PUBLIC_KEY_FILE | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
PUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate. |
SSHPUBLIC_KEY_FILE | The certificate store is the name of a file that contains an SSH-style public key. |
SSHPUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains an SSH-style public key. |
P7BFILE | The certificate store is the name of a PKCS7 file containing certificates. |
PPKFILE | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
XMLFILE | The certificate store is the name of a file that contains a certificate in XML format. |
XMLBLOB | The certificate store is a string that contains a certificate in XML format. |
The password for the OAuth JWT certificate.
string
""
If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
The subject of the OAuth JWT certificate.
string
"*"
When loading a certificate the subject is used to locate the certificate in the store.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks the first certificate in the certificate store.
The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@jitterbit.com". Common fields and their meanings are displayed below.
Field | Meaning |
CN | Common Name. This is commonly a host name like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
The issuer of the Java Web Token.
string
""
The issuer of the Java Web Token. This is typically either the Client ID or Email Address of the OAuth Application.
The user subject for which the application is requesting delegated access.
string
""
The user subject for which the application is requesting delegated access. Typically, the user account name or email address.
This section provides a complete list of SSL properties you can configure.
Property | Description |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
The certificate to be accepted from the server when connecting using TLS/SSL.
string
""
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
Description | Example |
A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
A path to a local file containing the certificate | C:\cert.cer |
The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
This section provides a complete list of schema properties you can configure.
Property | Description |
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC. |
A path to the directory that contains the schema files defining tables, views, and stored procedures.
string
"%APPDATA%\\AdobeAnalytics Data Provider\Schema"
The path to a directory which contains the schema files for the connector (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is "%APPDATA%\\AdobeAnalytics Data Provider\Schema" with %APPDATA% being set to the user's configuration directory:
Platform | %APPDATA% |
Windows | The value of the APPDATA environment variable |
Mac | ~/Library/Application Support |
Linux | ~/.config |
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
string
""
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
string
""
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
string
""
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
This section provides a complete list of miscellaneous properties you can configure.
Property | Description |
MaxRows | Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time. |
Other | These hidden properties are used only in specific use cases. |
Pagesize | The maximum number of results to return per page from Adobe Analytics. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
int
-1
Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
These hidden properties are used only in specific use cases.
string
""
The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.
Specify multiple properties in a semicolon-separated list.
DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
The maximum number of results to return per page from Adobe Analytics.
int
50
The Pagesize property affects the maximum number of results to return per page from Adobe Analytics. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.
This property indicates whether or not to include pseudo columns as columns to the table.
string
""
This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".
The value in seconds until the timeout error is thrown, canceling the operation.
int
60
If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout expires and the operation is not yet complete, the connector throws an exception.