The CData Sync App provides a straightforward way to continuously pipeline your LinkedIn data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The LinkedIn connector can be used from the CData Sync application to pull data from LinkedIn and move it to any of the supported destinations.
The Sync App models entities in version 2.x of the LinkedIn REST API as relational tables.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
There are two ways to find your site's LinkedIn Company ID:
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.
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.
The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .
Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .
Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
For further information, see Query Processing.
By default, the Sync App attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.
To specify another certificate, see the SSLServerCert connection property.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
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 are tables that cannot be modified. Typically, read-only data are shown as views.
Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.
The Sync App models the data in LinkedIn as a list of tables in a relational database that can be queried using standard SQL statements.
| Name | Description |
| Comments | Query Comments data for Posts in the Organization Pages that you administer. |
Query Comments data for Posts in the Organization Pages that you administer.
Note: Requires the r_organization_social and w_organization_social OAuth scope.
SELECT * FROM Comments WHERE Id = 7155174232715386880 and UpdateId = 'urn:li:share:7155174232715386880';
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.
INSERT INTO Comments (UpdateId, Text) VALUES ('urn:li:share:7155174232715386880', 'Test Comment')
INSERT INTO Comments (UpdateId, Text, CreatedBy) VALUES ('urn:li:share:7155174232715386880', 'Test Comment', 'urn:li:organisation:101877555')
UPDATE Comments SET Text = 'Test Comment' WHERE Id = 715517423271578940 UPDATE Comments SET Text = 'Test Comment' WHERE Id = 715517423271578940 AND UpdateId = 'urn:li:share:7155174232715386880'
DELETE FROM Comments WHERE Id = 715517423271578940 DELETE FROM Comments WHERE Id = 715517423271578940 AND UpdateId = 'urn:li:share:7155174232715386880'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
The unique identifier for the comment. |
| UpdateId | String | False |
Id of the Update associated with the comment. |
| Text | String | False |
Content of the update comment. |
| CreatedBy | String | False |
The unique identifier for the person or company. |
| Date | Datetime | True |
Time when the comment was lastly modified. |
| Mentions | String | True |
The URNs of the organizations or people mentioned in comment. |
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.
| Name | Description |
| 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. |
| 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. |
| OrganizationLocations | Query location information for any LinkedIn organization, whether you administer that organization or not. |
| Organizations | Query organization information from any LinkedIn organization, whether you administer that organization or not. |
| Profiles | Query profile information of LinkedIn members. |
| VideoTimeWatchedForVideoViewsStatistics | Query statistics about the time watched in milliseconds for video. |
| VideoTimeWatchedStatistics | Query statistics about the time the video was watched in milliseconds. |
| VideoViewerStatistics | Query statistics about unique viewers who made engaged plays on the video. |
| VideoViewStatistics | Query statistics about video views for a particular company page. |
Retrieve company profiles and updates.
Note: Requires the r_organization_admin OAuth scope.
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'
| 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. |
| 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.
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.
For example, the following queries are processed server side:
SELECT * FROM CompanyFollowerStatistics WHERE CompanyId = '183432' SELECT * FROM CompanyFollowerStatistics WHERE ReportTimeRangeStart = '2019-10-20' AND ReportTimeRangeEnd = '2020-10-15' SELECT * FROM CompanyFollowerStatistics WHERE ReportTimeRangeStart = '2019-10-15' AND TimeGranularity = 'DAY' SELECT * FROM CompanyFollowerStatistics WHERE TimeGranularity = 'MONTH' AND ReportTimeRangeStart = '2019-10-15' AND ReportTimeRangeEnd = '2020-10-15' AND CompanyId = '10904095'
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. |
| 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.
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.
The following query returns a list of all companies that the corresponding member is an administrator of:
SELECT * FROM CompanyList
The following queries are processed server side:
SELECT * FROM CompanyList Role = 'ANALYST';
SELECT * FROM CompanyList WHERE State IN ('APPROVED', 'REQUESTED');
SELECT * FROM CompanyList WHERE State = 'APPROVED' AND Role = 'ADMINISTRATOR';
| Name | Type | Description |
| Id | 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. Possible values are: ADMINISTRATOR, DIRECT_SPONSORED_CONTENT_POSTER, RECRUITING_POSTER, LEAD_CAPTURE_ADMINISTRATOR, LEAD_GEN_FORMS_MANAGER, ANALYST, CURATOR, CONTENT_ADMINISTRATOR. |
| State | String | State of the role assigned to the person. Possible values are: APPROVED, REJECTED, REQUESTED, REVOKED. |
Query statistics about page views for a particular company page.
Note: Requires the r_organization_admin OAuth scope.
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.
The CompanyPageStatistics view allows you to retrieve both lifetime and time-bound statistics on views and clicks for an organization page.
SELECT * FROM [CompanyPageStatistics]
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'
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. |
| 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.
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'
| 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.
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.
For example, the following queries are processed server side:
SELECT * FROM CompanyUpdateStatistics WHERE TimeRangeStart = '2019-10-20' AND TimeRangeEnd = '2020-10-15'
SELECT * FROM CompanyUpdateStatistics WHERE TimeRangeStart = '2019-10-15' AND TimeGranularity = 'DAY'
SELECT * FROM CompanyUpdateStatistics WHERE TimeGranularity = 'MONTH' AND TimeRangeStart = '2019-10-15' AND TimeRangeEnd = '2020-10-15' AND CompanyId = '10904095'
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')
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. |
| 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>)
| 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 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.
| 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.
| Name | Type | Description |
| FirstDegreeSize | Integer | The number of first-degree connections (followers) for the organization. |
Query location information for any LinkedIn organization, whether you administer that organization or not.
Either the OrganizationId or OrganizationVanityName columns must be specified in the criteria to use this view. If both are specified using an AND clause, the criterion for OrganizationId will take precedence over the criterion for OrganizationVanityName. The OR logical operator is not supported in the criteria for columns other than OrganizationId or OrganizationVanityName.
Refer to the query examples below:
SELECT * FROM OrganizationLocations WHERE OrganizationId = '4975021';
SELECT * FROM OrganizationLocations WHERE OrganizationId IN ('4975021', '6554901');
SELECT * FROM OrganizationLocations WHERE OrganizationVanityName IN ('CDataSoftware', 'OtherOrganization');
| Name | Type | Description |
| OrganizationId | String | The identifier of the organization. |
| OrganizationVanityName | String | The vanity name of the organization. |
| GeoLocationURN [KEY] | String | The geolocation URN of the organization's location. |
| LocationType | String | The type of the organization's location. |
| Description | String | The description of the organization's location. |
| StaffCountRange | String | The range of staff members of the organization's location. |
| AddressLine1 | String | The first line of the address of the organization's location. |
| AddressLine2 | String | The second line of the address of the organization's location. |
| City | String | The city of the organization's location. |
| AdministrativeUnit | String | This refers to the administrative unit (e.g. state, country, province) of the organization's location. |
| PostalCode | String | The postal code of the organization's location. |
| Country | String | The country of the organization's location. |
Query organization information from any LinkedIn organization, whether you administer that organization or not.
This view differs from CompanyDetails, because it only exposes Non-Admin Organization data, meaning that you can use this view whether you are querying information on an organization you own or not. If you don't want just the Non-Admin data, but other fields as well, and you are an Organization Administrator, you can use CompanyDetails.
Either the Id or VanityName columns must be specified in the criteria to use this view. If both are specified using an AND clause, the criterion for Id will take precedence over the criterion for VanityName. The OR logical operator is not supported in the criteria for columns other than Id or VanityName.
The = and IN operators are fully supported server-side for the Id column. Refer to the query examples below:
SELECT * FROM Organizations WHERE Id = '4975021';
SELECT * FROM Organizations WHERE Id IN ('4975021', '6554901');
The = operator is fully supported server-side for the VanityName column, while the IN operator is processed client-side. The values specified in the criteria are case-insensitive. Refer to the query examples below:
SELECT * FROM Organizations WHERE VanityName = 'cdatasoftware';
SELECT * FROM Organizations WHERE VanityName IN ('CDataSoftware', 'OtherOrganization');
| Name | Type | Description |
| Id [KEY] | String | The identifier of the organization. |
| Name | String | The name of the organization. |
| VanityName | String | The vanity name of the organization. |
| Website | String | The organization's website. |
| PrimaryType | String | The primary type of the organization. |
| LogoAssetURN | String | The digital media asset URN for the organization's logo. |
| HierarchyClassification | String | The classification for the school's hierarchy in case the organization is a school. |
| SchoolType | String | The type of school in case the organization is a school. |
| YearLevel | String | The classification of the length of the school's educational programs in case the organization is a school. |
Query profile information of LinkedIn members.
NOTE: The r_basicprofile scope is required to access this view.
When querying Profiles with a criteria, Id is required and must be included in the criteria. The OR logical operator is not supported in the criteria for columns other than Id.
The = and IN operators are fully supported server-side for the Id column. Refer to the query examples below:
SELECT * FROM Profiles WHERE Id = 'XXXXXXXXXX';
SELECT * FROM Profiles WHERE Id IN ('XXXXXXXXXX', 'YYYYYYYYYY');
If no criteria is specified as shown in the query below, the view will return the authenticated user's LinkedIn profile data.
SELECT * FROM Profiles;
| 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. |
Query statistics about the time watched in milliseconds for video.
| Name | Type | Description |
| UGCPostId | String | Id of the Post associated with the video in the following format urn:li:ugcPost:{id}. |
| TimeWatchedForVideoViews | Long | The time watched in milliseconds for video play-pause cycles that are at least 3 seconds. |
| TimeGranularity | String | Granularity of the statistics. Can be DAY, WEEK, or ALL (default). |
| TimeRangeStart | Datetime | Exclusive starting timestamp of when the query should begin. Queries from beginning of time when not set. |
| TimeRangeEnd | Datetime | Inclusive ending timestamp of when the query should end. Queries until current time when not set. |
| 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. |
Query statistics about the time the video was watched in milliseconds.
| Name | Type | Description |
| UGCPostId | String | Id of the Post associated with the video in the following format urn:li:ugcPost:{id}. |
| TimeWatched | Long | The time the video was watched in milliseconds. |
| TimeGranularity | String | Granularity of the statistics. Can be DAY, WEEK, or ALL (default). |
| TimeRangeStart | Datetime | Exclusive starting timestamp of when the query should begin. Queries from beginning of time when not set. |
| TimeRangeEnd | Datetime | Inclusive ending timestamp of when the query should end. Queries until current time when not set. |
| 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. |
Query statistics about unique viewers who made engaged plays on the video.
| Name | Type | Description |
| UGCPostId | String | Id of the Post associated with the video in the following format urn:li:ugcPost:{id}. |
| Viewers | Long | Unique viewers who made engaged plays on the video. |
| TimeGranularity | String | Granularity of the statistics. Can be DAY, WEEK, or ALL (default). |
| TimeRangeStart | Datetime | Exclusive starting timestamp of when the query should begin. Queries from beginning of time when not set. |
| TimeRangeEnd | Datetime | Inclusive ending timestamp of when the query should end. Queries until current time when not set. |
| 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. |
Query statistics about video views for a particular company page.
| Name | Type | Description |
| UGCPostId | String | Id of the Post associated with the video in the following format urn:li:ugcPost:{id}. |
| Views | Long | Video views of the statistic. |
| TimeGranularity | String | Granularity of the statistics. Can be DAY, WEEK, or ALL (default). |
| TimeRangeStart | Datetime | Exclusive starting timestamp of when the query should begin. Queries from beginning of time when not set. |
| TimeRangeEnd | Datetime | Inclusive ending timestamp of when the query should end. Queries until current time when not set. |
| 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. |
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.
| 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}. |
| Property | Description |
| OAuthClientId | Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server. |
| OAuthClientSecret | Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server. |
| Scope | A specific scope that the user requires the access token. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
| ProxyPort | The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | The username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
| ProxySSLType | The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| Property | Description |
| MaxRows | Specifies the maximum rows returned for queries without aggregation or GROUP BY. |
| Other | Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties. |
| Pagesize | Specifies the maximum number of results to return from LinkedIn, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file. |
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}.
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 OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| OAuthClientId | Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server. |
| OAuthClientSecret | Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server. |
| Scope | A specific scope that the user requires the access token. |
Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.
Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.
A specific scope that the user requires the access token.
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 | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL.
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 | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Note: 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.
The following table provides port number information for each of the supported protocols.
| Protocol | Default Port | Description |
| TUNNEL | 80 | The port where the Sync App opens a connection to LinkedIn. Traffic flows back and forth via the proxy at this location. |
| SOCKS4 | 1080 | The port where the Sync App opens a connection to LinkedIn. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted. |
| SOCKS5 | 1080 | The port where the Sync App sends data to LinkedIn. If the SOCKS 5 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.
Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the TCP port to be used for a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Identifies the user ID of the account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the password of the user account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
| ProxyPort | The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | The username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
| ProxySSLType | The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).
This connection property takes precedence over other proxy settings. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
The hostname or IP address of the proxy server that you want to route HTTP traffic through.
The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.
The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.
For other proxy types, see FirewallType.
Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
The authentication type can be one of the following:
For all values other than "NONE", you must also set the ProxyUser and ProxyPassword connection properties.
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
The username of a user account registered with the proxy server specified in the ProxyServer connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyUser |
| BASIC | The user name of a user registered with the proxy server. |
| DIGEST | The user name of a user registered with the proxy server. |
| NEGOTIATE | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NTLM | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NONE | Do not set the ProxyPassword connection property. |
The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the username specified in your system proxy settings.
The password associated with the user specified in the ProxyUser connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyPassword |
| BASIC | The password associated with the proxy server user specified in ProxyUser. |
| DIGEST | The password associated with the proxy server user specified in ProxyUser. |
| NEGOTIATE | The password associated with the Windows user account specified in ProxyUser. |
| NTLM | The password associated with the Windows user account specified in ProxyUser. |
| NONE | Do not set the ProxyPassword connection property. |
For SOCKS 5 authentication or tunneling, see FirewallType.
The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the password specified in your system proxy settings.
The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :
| AUTO | Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option. |
| ALWAYS | The connection is always SSL enabled. |
| NEVER | The connection is not SSL enabled. |
| TUNNEL | The connection is made 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 proxy server set in the ProxyServer connection property.
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, set ProxyAutoDetect to False.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.
For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.
The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.
For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) 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, where %APPDATA% is set to the user's configuration directory:
| Platform | %APPDATA% |
| Windows | The value of the APPDATA environment variable |
| Linux | ~/.config |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.
Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.
If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.
Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.
If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may 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 | Specifies the maximum rows returned for queries without aggregation or GROUP BY. |
| Other | Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties. |
| Pagesize | Specifies the maximum number of results to return from LinkedIn, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file. |
Specifies the maximum rows returned for queries without aggregation or GROUP BY.
This property sets an upper limit on the number of rows the Sync App returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.
When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.
Note: It is strongly recommended to set these properties only when advised by the support team to address specific scenarios or issues.
Specify multiple properties in a semicolon-separated list.
| DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
| ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
| RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Specifies the maximum number of results to return from LinkedIn, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
You may want to adjust the default pagesize to optimize results for a particular object or service endpoint you are querying. Be aware that increasing the page size may improve performance, but it could also result in higher memory consumption per page.
Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
This property allows you to define which pseudocolumns the Sync App exposes as table columns.
To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"
To include all pseudocolumns for all tables use: "*=*"
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App cancels the operation and throws an exception.
The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.
Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.
Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the 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)"
}
}
You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.
Refer to User Defined Views for more information.