Adding a Connection to LinkedIn

To add a connection to LinkedIn:

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 LinkedIn icon is not available, click the Add More icon to download and install the LinkedIn 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 LinkedIn

The LinkedIn CompanyId is a string of numbers, usually 6 to 9 digits long, that is unique to your company. Working with LinkedIn entities that require the CompanyId to be exposed, requires Company Page Administrator permissions.

There are two ways to find your site's LinkedIn Company ID:

• Look at the URL of the search results page when you search for your company name in your LinkedIn page's Company dropdown. The ID is the value in the URL after /search/?f_C=[numeric value]&.

• As a LinkedIn Page Admin, use the All Pages or Home tab to navigate to the page's Admin View. The ID is the numbers in the URL that come after https://www.linkedin.com/company/.

CompanyId is required in most of the LinkedIn data model entities. You can specify it directly as part of a query or -- if the query you are using is not easily modified -- you can set it globally.

If you are not sure if it is required for a query you want to run, check the table or view description, or see whether it is specified as a column or pseudo-column.

Authenticating to LinkedIn

LinkedIn provides embedded OAuth credentials that simplify connection from a Desktop application . To connect from a Web application, you must create a custom OAuth application, as described in Creating a Custom OAuth Application.

To connect via OAuth from all authentication flows, you must set AuthScheme to OAuth.

The following subsections describe how to authenticate to LinkedIn from the available OAuth flows. For information about how to create a custom OAuth application, and why you might want to create one even for auth flows that already have embedded OAuth credentials, see Creating a Custom OAuth Application.

For a complete list of connection string properties available in LinkedIn, see Connection.

When the access token expires, the Sync App refreshes it automatically.

This section details a selection of advanced features of the LinkedIn 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 LinkedIn 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 entities in the LinkedIn API as tables, views, and stored procedures. These are defined in schema files, which are simple, text-based configuration files. API limitations and requirements are documented in this section; you can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations.

Views

Views are tables that cannot be modified. Typically, read-only data are shown as views.

Stored Procedures

Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.

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.

LinkedIn Connector for CData Sync Views

Name	Description
Comments	Query Comments data for Posts in the Organization Pages that you administer.
CompanyDetails	Retrieve company profiles and updates.
CompanyFollowerStatistics	Query statistics about followers for a particular company page.
CompanyList	Lists all companies and the privileges that the user has within the organization.
CompanyLocations	Retrieve company locations information.
CompanyPageStatistics	Query statistics about page views for a particular company page.
CompanyStatusUpdates	Lists update events from the LinkedIn company page.
CompanyUpdateStatistics	Query update statistics about a company. If the TimeRange filters are not specified, the default result set is for the last 12 months.
GeoLocation	Provides the display name for a given geo Id, or a set of geo Ids.
Industries	Query the list of available industries in LinkedIn.
OrganizationFollowerCount	The Organization Follower Count View provides the ability to retrieve the number of first-degree connections (followers) for the organization defined in the CompanyId connection string property.
Profiles	Query profile information of LinkedIn members.

Query Comments data for Posts in the Organization Pages that you administer.

Note: Requires the r_organization_social OAuth scope.

Select

The Comments view supports filtering on the WHERE clause only for the UpdateId column and only for the = and IN operators. The = operator is fully supported server-side, whereas the IN operator is partially supported server-side and partially client-side. Refer to the query examples below:

SELECT * FROM Comments WHERE UpdateId = 'urn:li:share:7155174232715386880';
SELECT * FROM Comments WHERE UpdateId IN ('urn:li:share:7155174232715386880', 'urn:li:share:7165681621608738816');

The following query returns the data for the columns we expose in the view, for each Post in each Organization Page that the user administers.

SELECT * FROM Comments;

To retrieve information on Posts in your Organization Pages, use CompanyStatusUpdates.

Columns

Name	Type	Description
Id [KEY]	String	The unique identifier for the comment.
UpdateId	String	Id of the Update associated with the comment.
Text	String	Content of the update comment.
CreatedBy	String	The unique identifier for the person or company.
Date	Datetime	Comment created time.

Retrieve company profiles and updates.

Note: Requires the r_organization_admin OAuth scope.

Select

The CompanyDetails view supports only the CompanyId column in the WHERE clause. The only supported operator for the CompanyId column is =. For example:

SELECT * FROM CompanyDetails WHERE CompanyId = '183432'

Columns

Name	Type	Description
CompanyId [KEY]	String	The unique, internal, numeric identifier for the company in the following format urn:li:organization:{id}
CompanyName	String	The name of the company.
UniversalName	String	The unique string identifier for the company.
Description	String	The company description. Limit of 500 characters.
Specialties	String	The company specialties.
StaffCountRange	String	The company staff count range.
WebsiteUrl	String	The URL for the company website.
Logo	String	The original company logo.
SquareLogo	String	The square company logo.
CompanyTypeName	String	The name of the company type.
Groups	String	The groups of the company.
Industries	String	The industries of the company.
FoundedYear	Integer	The year the company was founded.
EndYear	Integer	The year listed for when the company closed or was acquired by another.
PrimaryOrganizationType	String	Type of primary organization being used in the lookup. Possible values: SCHOOL,BRAND,NONE
VanityName	String	Entity's unique name used in URLs.
VersionTag	String	Tag indicating version.

Query statistics about followers for a particular company page.

Note: Requires the r_organization_admin OAuth scope.

Select

The CompanyFollowerStatistics view supports only the CompanyId column in the WHERE clause. The supported operator for the CompanyId column is =. For example:

SELECT * FROM CompanyFollowerStatistics WHERE CompanyId = '183432'

Time-Based Data Queries

The three inputs that control time-based data queries are TimeGranularity, TimeRangeStart, and TimeRangeEnd. TimeGranularity is not always required, but if it is specified you must also specify TimeRange Start, TimeRangeEnd, or both.

The behavior of TimeGranularity in a query depends on what other inputs are specified.

Inputs specified	Result
None	The driver returns all data from the time the company page was created until the present time, in one record.
TimeRangeStart only (no TimeRangeEnd or TimeGranularity)	The driver returns all data from the time specified in TimeRangeStart until the present time, in one record.
TimeRangeStart and TimeRangeEnd (no TimeRangeGranularity)	The driver returns all data from the time specified in TimeRangeStart until the time specified in TimeRangeEnd, in one record. If the value specified in TimeRangeStart is older than the time when the page was created, it retrieves all data from the time the page was created to the time specified in TimeRangeEnd.
TimeRangeEnd only (no TimeRangeStart or TimeGranularity)	The driver returns all data from the time the company page was created, until the time specified in TimeRangeEnd, in one record.
All	The driver breaks down the data into multiple records with different time intervals: one record for every day/month beginning from TimeRangeStart until TimeRangeEnd, depending on the value specified in TimeGranularity.

Columns

Name	Type	Description
CompanyId	String	Id of the Company associated with the follow statistics in the following format urn:li:organization:{id}.
Category	String	The category of the followers.
Type	String	Type of the category.
OrganicFollowerCount	Integer	Total number of the organinc followers.
PaidFollowerCount	Integer	Total number of the paid followers.
TimeGranularity	String	Granularity of the statistics. Must be either DAY or MONTH.
ReportTimeRangeStart	Datetime	Exclusive starting timestamp of when the query should begin. Queries from beginning of time when not set.
ReportTimeRangeEnd	Datetime	Inclusive ending timestamp of when the query should end. Queries until current time when not set.
UsageStartTime	Datetime	Date start covered by the report data point. Refer to the ReportTimeRangeStart column for the start date of the range covered by the complete report.
UsageEndTime	Datetime	Date end covered by the report data point. Refer to the ReportTimeRangeEnd column for the end date of the range covered by the complete report.

Lists all companies and the privileges that the user has within the organization.

Note: Requires the r_organization_admin OAuth scope.

Select

The CompanyList view returns a list of all companies that the member is an administrator of. For example:

SELECT * FROM CompanyList

Columns

Name	Type	Description
Id [KEY]	String	A unique identifier for the company in the following format urn:li:organization:{id}
RoleAssignee	String	Id of the assigned person.
Role	String	Role of the assigned person.
State	String	State of the company.

Retrieve company locations information.

Note: Requires the r_organization_admin OAuth scope.

Select

The CompanyLocations view supports only the CompanyId column in the WHERE clause. The only supported operator for the CompanyId column is =. For example:

SELECT * FROM CompanyLocations WHERE CompanyId = '183432'

Columns

Name	Type	Description
CompanyId	String	Id of the Company associated with the comment in the following format urn:li:organization:{id}
Description	String	The company description. Limit of 500 characters.
LocationType	String	Type of the location.
Street1	String	The first line of the street address for the company location.
Apartment	String	The number of the apatrment,suite etc. for the company location.
City	String	The city of the company location.
State	String	The state of the company location.
PostalCode	String	The postal code of the company location.
CountryCode	String	The country code of the company location.

Query statistics about page views for a particular company page.

Note: Requires the r_organization_admin OAuth scope.

Select

The Sync App uses the LinkedIn API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• CompanyId supports only the '=' operator.
• TimeGranularity supports only the '=' operator.
• ReportTimeRangeStart supports only the '=' operator.
• ReportTimeRangeEnd supports only the '=' operator.

The CompanyPageStatistics view allows you to retrieve both lifetime and time-bound statistics on views and clicks for an organization page.

• Lifetime page statistics: To retrieve lifetime page statistics, do not set the ReportTimeRangeStart and ReportTimeRangeEnd in the WHERE clause conditions. The API returns view and click statistics segmented by various facets. For example:
  

  SELECT * FROM [CompanyPageStatistics]

• Time-bound page statistics: To retrieve time-bound page statistics, include the ReportTimeRangeStart and/or ReportTimeRangeEnd in the WHERE clause conditions. The API returns aggregate page statistics within all of the days or months in between the selected date range based on the specified TimeGranularity (DAY or MONTH). For example:
  

  SELECT * FROM [CompanyPageStatistics] WHERE ReportTimeRangeStart = '2019-10-20' AND ReportTimeRangeEnd = '2020-10-15'
  
  SELECT * FROM [CompanyPageStatistics] WHERE ReportTimeRangeStart = '2019-10-15' AND TimeGranularity = 'DAY'
  
  SELECT * FROM [CompanyPageStatistics] WHERE TimeGranularity = 'MONTH' AND ReportTimeRangeStart = '2019-10-15' AND ReportTimeRangeEnd = '2020-10-15' AND companyId = '10904095'

Time-Based Data Queries

The three inputs that control time-based data queries are TimeGranularity, TimeRangeStart, and TimeRangeEnd. TimeGranularity is not always required, but if it is specified you must also specify TimeRange Start, TimeRangeEnd, or both.

The behavior of TimeGranularity in a query depends on what other inputs are specified.

Inputs specified	Result
None	The driver returns all data from the time the company page was created until the present time, in one record.
TimeRangeStart only (no TimeRangeEnd or TimeGranularity)	The driver returns all data from the time specified in TimeRangeStart until the present time, in one record.
TimeRangeStart and TimeRangeEnd (no TimeRangeGranularity)	The driver returns all data from the time specified in TimeRangeStart until the time specified in TimeRangeEnd, in one record. If the value specified in TimeRangeStart is older than the time when the page was created, it retrieves all data from the time the page was created to the time specified in TimeRangeEnd.
TimeRangeEnd only (no TimeRangeStart or TimeGranularity)	The driver returns all data from the time the company page was created, until the time specified in TimeRangeEnd, in one record.
All	The driver breaks down the data into multiple records with different time intervals: one record for every day/month beginning from TimeRangeStart until TimeRangeEnd, depending on the value specified in TimeGranularity.

Columns

Name	Type	Description
CompanyId	String	Id of the Company associated with the page statistics in the following format urn:li:organization:{id}
Category	String	The category of the statistics.
Type	String	Type of the category. Not applicable for the totalPageStatistics category.
AllPageViews	Integer	Complete page views count. The reported counts may be higher because they include comprehensive mobile and desktop traffic.
AllDesktopPageViews	Integer	Complete desktop page views count.
AllMobilePageViews	Integer	Complete mobile page views count.
OverviewPageViews	Integer	Total Overview page views count. The reported counts may be higher because they include comprehensive mobile and desktop traffic.
CareersPageViews	Integer	Total Careers page views count.
DesktopCareersPageViews	Integer	Total desktop Careers page views count.
DesktopJobsPageViews	Integer	Total desktop Jobs page views count.
DesktopLifeAtPageViews	Integer	Total desktop Life Atpage views count.
DesktopOverviewPageViews	Integer	Total desktop Overview page views count.
JobsPageViews	Integer	Total Jobs page views count.
LifeAtPageViews	Integer	Total LifeAt page views count.
MobileCareersPageViews	Integer	Total mobile Careers page views count.
MobileJobsPageViews	Integer	Total mobile Jobs page views count.
MobileLifeAtPageViews	Integer	Total mobile LifeAt Page views count.
MobileOverviewPageViews	Integer	Total mobile Overview page views count.
MobileProductsPageViews	Integer	Total mobile Products page views count.
InsightsPageViews	Integer	Total Insights page views count.
MobileAboutPageViews	Integer	Total mobile About page views count.
ProductsPageViews	Integer	Total Products page views count.
DesktopProductsPageViews	Integer	Total desktop Products page views count.
PeoplePageViews	Integer	Total People page views count.
DesktopPeoplePageViews	Integer	Total desktop People page views count.
AboutPageViews	Integer	Total About page views count.
DesktopAboutPageViews	Integer	Total desktop About page views count.
MobilePeoplePageViews	Integer	Total mobile People page views count.
DesktopInsightsPageViews	Integer	Total desktop Insights page views count.
MobileInsightsPageViews	Integer	Total mobile Insights page views count.
MobileCareersPagePromoLinksClicks	Integer	Total mobile clicks count on Careers page promo links. Applicable only for the totalPageStatistics category.
MobileCareersPageJobsClicks	Integer	Total mobile clicks count on Careers page Jobs. Applicable only for the totalPageStatistics category.
MobileCareersPageEmployeesClicks	Integer	Total mobile clicks count on Careers page Employees. Applicable only for the totalPageStatistics category.
CareersPagePromoLinksClicks	Integer	Total clicks count on Careers page promo links. Applicable only for the totalPageStatistics category.
CareersPageBannerPromoClicks	Integer	Total clicks count on Careers page banner promo. Applicable only for the totalPageStatistics category.
CareersPageJobsClicks	Integer	Total clicks count on Careers page jobs. Applicable only for the totalPageStatistics category.
CareersPageEmployeesClicks	Integer	Total clicks count on Careers page employees. Applicable only for the totalPageStatistics category.
TimeGranularity	String	Granularity of the statistics. Must be either DAY or MONTH.
UsageStartTime	Datetime	Date start covered by the report data point. Refer to the ReportTimeRangeStart column for the start date of the range covered by the complete report.
UsageEndTime	Datetime	Date end covered by the report data point. Refer to the ReportTimeRangeEnd column for the end date of the range covered by the complete report.
ReportTimeRangeStart	Datetime	Exclusive starting timestamp of when the query should begin. Queries from beginning of time when not set.
ReportTimeRangeEnd	Datetime	Inclusive ending timestamp of when the query should end. Queries until current time when not set.

Lists update events from the LinkedIn company page.

Note: Requires the r_organization_social OAuth scope.

Select

The CompanyStatusUpdates table supports only the CompanyId column in the WHERE clause. The supported operator for the CompanyId column is =. For example:

SELECT * FROM CompanyStatusUpdates WHERE CompanyId = '183432'

Columns

Name	Type	Description
Id [KEY]	String	The unique identifier for the update.
Comment	String	Comment associated with update status.
CompanyId	String	Id of the Company associated with the update.
Date	Datetime	Update created time .
CreatedBy	String	Id of the person who created update.
FirstPublishedAt	Datetime	Time when update is published.
LastModified	Datetime	Last time when changes for this update are made.
Visibility	String	Visibility of the update.
LifecycleState	String	State of the update.

Query update statistics about a company. If the TimeRange filters are not specified, the default result set is for the last 12 months.

Note: Requires the r_organization_admin scope.

Select

The Sync App uses the LinkedIn API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• CompanyId supports the '=' comparisons.
• UGCPostId supports the '=,IN' comparisons.

For example, the following queries are processed server side:

SELECT * FROM CompanyUpdateStatistics WHERE CompanyId = '183432'
SELECT * FROM CompanyUpdateStatistics WHERE UGCPostId = 'urn:li:ugcPost:1234'
SELECT * FROM CompanyUpdateStatistics WHERE UGCPostId IN ('urn:li:ugcPost:1234', 'urn:li:ugcPost:2345')

Time-Based Data Queries

The three inputs that control time-based data queries are TimeGranularity, TimeRangeStart, and TimeRangeEnd. TimeGranularity is not always required, but if it is specified you must also specify TimeRange Start, TimeRangeEnd, or both.

The behavior of TimeGranularity in a query depends on what other inputs are specified.

Inputs specified	Result
None	The driver returns all data from the time the company page was created until the present time, in one record.
TimeRangeStart only (no TimeRangeEnd or TimeGranularity)	The driver returns all data from the time specified in TimeRangeStart until the present time, in one record.
TimeRangeStart and TimeRangeEnd (no TimeRangeGranularity)	The driver returns all data from the time specified in TimeRangeStart until the time specified in TimeRangeEnd, in one record. If the value specified in TimeRangeStart is older than the time when the page was created, it retrieves all data from the time the page was created to the time specified in TimeRangeEnd.
TimeRangeEnd only (no TimeRangeStart or TimeGranularity)	The driver returns all data from the time the company page was created, until the time specified in TimeRangeEnd, in one record.
All	The driver breaks down the data into multiple records with different time intervals: one record for every day/month beginning from TimeRangeStart until TimeRangeEnd, depending on the value specified in TimeGranularity.

Columns

Name	Type	Description
Clicks	Integer	Total clicks count.
Comments	Integer	Total comments count.
CommentMentions	Integer	Total comment mentions count.
Engagement	Double	Total engagement count.
Impressions	Integer	Total impressions count.
Likes	Integer	Total likes count.
Shares	Integer	Total shares count.
ShareMentions	Integer	Total share mentions count.
UniqueImpressions	Integer	Total share mentions count.
TimeRangeStart	Datetime	Exclusive starting datetime of when the query should begin. When not set, queries from the beginning of time.
TimeRangeEnd	Datetime	Inclusive ending datetime of when the query should end. When not set, queries until the current time.
TimeGranularity	String	Granularity of the statistics. Must be either DAY or MONTH. Requires TimeRangeStart and TimeRangeEnd.
UGCPostId	String	The ID of the UGC post.
ShareId	String	The ID of the share.
CompanyId	String	Id of the Company associated with the update statistics.
IntervalStartTime	Datetime	Date start covered by the report data point. For start date of the range covered by the complete report, see the TimeRangeStart column.
IntervalEndTime	Datetime	Date end covered by the report data point. For the end date of the range covered by the complete report, see the TimeRangeEnd column.

Provides the display name for a given geo Id, or a set of geo Ids.

GeoLocation requires an Id in SELECT statements. For example:

SELECT * FROM geolocation where id = 'urn:li:geo:123456'

To specify multiple geolocation Ids use the IN operator:

SELECT * FROM geolocation WHERE id IN (<List of geolocation ids>)

Columns

Name	Type	Description
Id [KEY]	String	Unique identifier for the entity. Can be a single Id or a comma-separated list of Ids.
Country	String	An uppercase two-letter country code as defined by ISO-3166.
Language	String	A lowercase two-letter language code as defined by ISO-639.
Value	String	The value of the display text.

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
LocaleLanguage	String	The locale language the country data is requested in. A lowercase two-letter language code as defined by ISO-639. The default value is en.
LocaleCountry	String	The locale country the country data is requested in. An uppercase two-letter country code as defined by ISO-3166. The default value is US.

Query the list of available industries in LinkedIn.

Columns

Name	Type	Description
Id [KEY]	Integer	The identifier of the industry.
Name	String	The name of the industry.
URN	String	The URN of the industry.
ParentId	Integer	The identifier of the parent industry of this industry.

The Organization Follower Count View provides the ability to retrieve the number of first-degree connections (followers) for the organization defined in the CompanyId connection string property.

Columns

Name	Type	Description
FirstDegreeSize	Integer	The number of first-degree connections (followers) for the organization.

Query profile information of LinkedIn members.

Select

The Profiles view supports filtering only on the Id column and only with the = and IN operators, which are both processed server-side. Refer to the query examples below:

SELECT * FROM Profiles WHERE Id = 'XXXXXXXXXX';
SELECT * FROM Profiles WHERE Id IN ('XXXXXXXXXX', 'YYYYYYYYYY');

Note: Your OAuth tokenRequires the r_basicprofile scope.

Columns

Name	Type	Description
Id [KEY]	String	The unique identifier of the member's profile.
FirstName	String	The first name of the member's profile.
LastName	String	The last name of the member's profile.
MaidenName	String	The maiden name of the member's profile.
Headline	String	The headline of the member's profile. Often this is the job title.
VanityName	String	The vanity name of the member's profile.
PictureAssetURN	String	The digital media asset URN for the picture of the member's profile.

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
CompanyId	The company Id of the currently logged on user. If specifying the Company Id in the query, use the format urn:li:organization:{thecompanyid}.

Connection

---

Property	Description
APIVersion	The version of the LinkedIn Marketing API to be used.

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.
Scope	A specific scope that the user requires the access 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
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 LinkedIn.
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.
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
CompanyId	The company Id of the currently logged on user. If specifying the Company Id in the query, use the format urn:li:organization:{thecompanyid}.

The company Id of the currently logged on user. If specifying the Company Id in the query, use the format urn:li:organization:{thecompanyid}.

Remarks

This property must be set in the connection string or query. Otherwise, the Sync App will use the first found company Id.

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

---

Property	Description
APIVersion	The version of the LinkedIn Marketing API to be used.

The version of the LinkedIn Marketing API to be used.

Remarks

The API version used by default is 202401. To use a different API version set this to the format YYYYMM.

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.
Scope	A specific scope that the user requires the access token.

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.

A specific scope that the user requires the access token.

Remarks

This property must be set in the connection string to get a scoped token with specific privileges.

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 LinkedIn 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\\LinkedIn 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
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 LinkedIn.
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.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

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

Remarks

The Pagesize property affects the maximum number of results to return per page from LinkedIn. 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, "*=*".

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