Adding a Connection to Adobe Analytics

To add a connection to Adobe Analytics:

1. In the application console, navigate to the Connections page.
2. At the Add Connections panel, select the icon for the connection you want to add.
3. If the Adobe Analytics icon is not available, click the Add More icon to download and install the Adobe Analytics connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Connecting to Adobe Analytics

In order to connect to Adobe Analytics, the GlobalCompanyId and RSID need to be identified. By default, the Sync App attempts to automatically identify your company and report suite. Alternatively, you can identify the company and report suite explicitly:

Global Company Id

GlobalCompanyId is an optional connection property. If left empty, the Sync App tries to automatically detect the Global Company ID. To find the Global Company ID:

1. Find it in the request URL for the users/me endpoint on the Swagger UI.
2. Expand the users endpoint and then click the GET users/me button.
3. Click the Try it out > Execute buttons.
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 an optional connection property. If not set, the driver tries to automatically detect it. To get a full list of your report suites along with their identifiers next to the name, navigate 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)

AuthScheme must be set to OAuth in all user account flows.

NOTE: Adobe authentication via OAuth requires that you update your refresh token every two weeks. We recommend using OAuthJWT instead.

Service Account (JWT OAuth)

Set the AuthScheme to OAuthJWT to authenticate with this method.

Service accounts have silent authentication, which does not require 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:

• OAuthClientId: Set to the client Id in your app settings.
• OAuthClientSecret: Set to the client secret in your app settings.
• OAuthJWTCertType: Set to "PUBLIC_KEY_FILE".
• OAuthJWTCert: Set to the path to the .key file you generated.
• OAuthJWTCertPassword: Set to the password of the .key file.
• OAuthJWTIssuer: Set to your Organization ID from the Adobe I/O Console integration in the format org_ident@AdobeOrg. This identifies the organization that has been configured for access to the Adobe I/O API.

When you connect the Sync App completes the OAuth flow for a service account.

This section details a selection of advanced features of the Adobe Analytics Sync App.

User Defined Views

The Sync App 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.

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to Adobe Analytics and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

Logging

See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.

Customizing the SSL Configuration

By default, the Sync App 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.

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

The CData Sync App 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.

Stored Procedures

Stored Procedures are function-like interfaces to the data source. They can be used to access additional capabilities of the Adobe Analytics API.

Views

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 MyReport

will become:

SELECT Date, {all the metrics here} FROM MyReport

But 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 divide dimensions into parts.
Let's take a query example:

SELECT Country, City, Visits FROM MyReport

• Firstly, the provider requests all the values of the first dimension, Country, suppose they are: England and Germany.
  
• Secondly, the provider tries to divine England into parts with the dimension City, and it gets, let's suppose: London, Liverpool.
  
• Finally, it divides Germany into parts with City and gets: Berlin, Frankfurt.
  

If we would have a third dimension, the provider would divide every city into parts 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.

Defining Custom Reports

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 Metrics

For 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'

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Adobe Analytics Connector for CData Sync Views

Name	Description
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.
Segments	Query the available segments in AdobeAnalytics.
Users	Query the available users in AdobeAnalytics.

Query the available calculated metrics in AdobeAnalytics.

Columns

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-Columns

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.

Columns

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.

Columns

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.

Columns

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.

Query the available segments in AdobeAnalytics.

Columns

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.

Query the available users in AdobeAnalytics.

Columns

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.
Email	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.

The connection string 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 in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

---

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.

OAuth

---

Property	Description
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.

JWT OAuth

---

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.

SSL

---

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

Proxy

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging

---

Property	Description
LogModules	Core modules to be included in the log file.

Schema

---

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.

Miscellaneous

---

Property	Description
IncludeSummaryData	Configures the data exposed for custom reports. By default, the summary records are not included.
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
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.
SkipEmptyRows	Excludes empty records in report recordsets.
SupportEnhancedBreakDown	Use a breadth-first search algorithm to maximize the number of dimension records sent for breaking down per single request.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

---

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.

Remarks

• Auto: Lets the driver decide automatically based on the other connection properties you have set.
• OAuth: Set this to perform OAuth authentication using a standard user account.
• OAuthJWT: Set this to perform OAuth authentication using an OAuth service account. (To be deprecated on January 1, 2025)
• OAuthClient: Set this to perform OAuth authentication using an OAuth service account. (Server-to-Server)

Your company identifier. If not set, the driver tries to automatically detect it.

Remarks

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.

Remarks

Your report suite identifier. If not set the driver tries to automatically detect it.

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

---

Property	Description
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.

The client Id assigned when you register your application with an OAuth authorization server.

Remarks

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.

Remarks

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.

This section provides a complete list of the JWT OAuth properties you can configure in the connection string for this provider.

---

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.

The JWT Certificate store.

Remarks

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.

Remarks

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.

Remarks

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.

Remarks

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, [email protected]". 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

If a field value contains a comma it must be quoted.

The issuer of the Java Web Token.

Remarks

The issuer of the Java Web Token. This is typically either the Client Id or Email Address of the OAuth Application.

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

---

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.

Remarks

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.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

Type	Default Port	Description
TUNNEL	80	When this is set, the Sync App opens a connection to Adobe Analytics and traffic flows back and forth through the proxy.
SOCKS4	1080	When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5	1080	When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

This indicates whether to use the system proxy settings or not.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

• BASIC: The Sync App performs HTTP BASIC authentication.
• DIGEST: The Sync App performs HTTP DIGEST authentication.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

AUTO	Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

---

Property	Description
LogModules	Core modules to be included in the log file.

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

---

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.

Remarks

The path to a directory which contains the schema files for the Sync App (.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%\\CData\\AdobeAnalytics Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:

Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Remarks

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.

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.

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.

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.

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 the Miscellaneous properties you can configure in the connection string for this provider.

---

Property	Description
IncludeSummaryData	Configures the data exposed for custom reports. By default, the summary records are not included.
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
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.
SkipEmptyRows	Excludes empty records in report recordsets.
SupportEnhancedBreakDown	Use a breadth-first search algorithm to maximize the number of dimension records sent for breaking down per single request.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

Configures the data exposed for custom reports. By default, the summary records are not included.

Remarks

Configures the data exposed for custom reports. By default, the summary records are not included.

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

These hidden properties are used only in specific use cases.

Remarks

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.

Integration and Formatting

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.

Remarks

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.

Remarks

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, "*=*".

Excludes empty records in report recordsets.

Remarks

If set to true, rows for which there is no metric value are skipped in the report. This is recommended if you're using SupportEnhancedBreakDown and querying a report with more than two breakdown levels.

If set to false, all rows are included in the report recordset.

Use a breadth-first search algorithm to maximize the number of dimension records sent for breaking down per single request.

Remarks

If true, the Sync App uses a breadth-first search algorithm to maximize the number of dimension records sent for breaking down in a single request. For each breakdown level, all records at that level are included in the same breakdown request. Use this if you are querying reports across multiple dimensions.

If false, the Sync App uses a depth-first search algorithm to break down dimension records. For each record in the root breakdown, a separate request is sent. Use this option if you are only breaking down records from a single dimension.

This is applied only on reports created via the CreateSchema stored procedure and doesn't support exposing the summary data rows.

The value in seconds until the timeout error is thrown, canceling the operation.

Remarks

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 Sync App throws an exception.

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App 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 Sync App.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

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

Note that the specified path is not embedded in quotation marks.