Task Factory Social Media

Note:  These Task Factory social media components require SQL Server version 2012 or higher.

Social OAuth Connection Manager

Important:  To obtain Api Keys and Tokens, you need to first create an app developer account by visiting Facebook and Twitter's developer websites.

As of January 30, 2018, LinkedIn has been separated into its own connection manager due to their OAuth2 connection requirement. See the LinkedIn OAuth2 Connection Manager tab for more information.

Social OAuth Connection Manager

The Social OAuth Connection Manager is used to set up a connection to social media sites. This connection manager is used within the Facebook Source and Twitter Source components.

Connection Settings

Task Factory Social OAuth Connection Manager Connection Settings

OptionDescription
ServiceSelect this drop-down box to choose which social media to connect to.
Api Key
API Secret
Token
Token Secret
Authentication information provided to users at each social media's app developer site.

Advanced

Task Factory Social OAuth Connection Manager Advanced

OptionDescription
Authentication UrlThe Url (with version) of the social media site the user wants to connect to.
Proxy HostThe ip address of the proxy the user wishes to connect through.
Proxy PortThe port of the proxy being used.
Proxy User NameUsers should enter their user name for the proxy if it is required.
Proxy PasswordUsers should enter their password for the proxy if it is required.
Facebook Source

Facebook Source

Source IconSource Description
Task Factory Facebook Source IconThe Facebook Source is used to extract data such as your user profile, status updates, friends, likes, and comments within an SSIS package. See the Social OAuth Connection Manager to learn more about setting up this component's connection manager.

Settings Tab

Task Factory Facebook Source Settings tab

OptionDescription
Connection ManagerIn this field, users can create a new connection manager or select a pre-existing one.
 Api End PointsIn this field, users select the endpoint they wish to connect to (such as User Profile or User Groups.) Selecting an endpoint auto-populates that field's parameters and commonly used Output Columns.
API QueryThis field defines the query to be used in the API. Although several end points have been pre-configured, users can type in or paste custom calls that are not included with the component. These calls can be found by selecting the View Api Document link and adding the reference to the end of the API Query.

Example: https://graph.facebook.com/{user-id}/groups
Root Json PathBecause Facebook returns the raw data in Json format, users need to define the root path when creating custom queries.
Query ParametersUser-defined parameters (such as id) based on the API query. Parameters can be set dynamically by entering the variable name.

Example: <@User::ScreenName> 
Output ColumnsIn this window, users can add and remove columns and define their name, token path (defined within the raw data), data type, length, precision, scale, and code page.

Preview Tab

Task Factory Facebook Source Preview

OptionDescription
Preview DataSelecting this button returns the results and raw data based on the user-defined settings.
ResultsIn this window, users can see a preview of the first few rows of data based on their configuration.
Raw DataThis window displays the Json data in raw form. Developers can use this to help determine root and token paths.
Twitter Source

Twitter Source

Source IconSource Description
Task Factory Twitter Source IconThe Twitter Source is used to extract data such as status updates (known as Tweets), followers, hashtags, and retweeted or favorited tweets within an SSIS package. See the Social OAuth Connection Manager to learn more about setting up this component's connection manager.

Settings Tab

Task Factory Twitter Source Settings

OptionDescription
Connection ManagerIn this field, users can create a new connection manager or select a pre-existing one configured earlier.
Api End PointsIn this field, users select the Api they wish to connect to (such as User Timeline, Followers/List, etc.) Selecting an endpoint auto-populates that field's parameters and commonly used Output Columns.
API QueryThis field defines the query to be used in the API. Although several end points have been pre-configured, users can type in or paste custom calls that are not included with the component. These calls can be found by selecting the View Api Document link, and copy & pasting the Resource URL located on the page of the selected API.
Root Json PathBecause Twitter returns the raw data in Json format, users need to define the root path when creating custom queries. This can (usually) be found in the View Api Document link under Example Result.
# Seconds to wait between API round tripsFor security reasons, Twitter places a 200 count limit per call at runtime and only 15 calls can be performed within 15 minutes. This limitation can cause a too many requests error when querying a large dataset such as a user's followers which has 10,000 users. To avoid this error, users can set a timer that pauses between calls.
Query ParametersUser-defined parameters (such as screenname or count number.) Parameters can be set dynamically by entering the variable name.

Example: <@User::ScreenName>
Output ColumnsIn this window, users can add and remove columns and define their name, token path (defined within the raw data), data type, length, precision, scale, and code page.

Preview Tab

Task Factory Twitter Source Preview

OptionDescription
Preview DataSelecting this button returns the results and raw data based on the user-defined settings.
ResultsIn this window, users can see a preview of the first few rows of data based on their configuration.
Raw DataThis window displays the Json data in raw form. Developers can use this to help determine a root and token path.
LinkedIn OAuth2 Connection Manager

LinkedIn OAuth2 Connection Manager

Used with the LinkedIn Source data flow component.

Additional Information: Before using the LinkedIn Source, users must first create an app to obtain a Client ID and Client Secret. This can be done by visiting LinkedIn Developers.

Connection Settings

Task Factory LinkedIn OAuth2 Connection Connection Settings

OptionDescription
Client IdEnter the Client ID provided by LinkedIn.
Client SecretEnter the Client Secret provided by LinkedIn.

Note:  Client ID and Client Secret are located in the My Apps - Authentication Keys section at LinkedIn Developers.
Access TokenLinkedIn's OAuth2 connection requires an access token to make API requests. Select the Get Token button to open the Token Getter window.
Is Bearer TokenLinkedIn requires access tokens be designated as bearer tokens. This option is automatically selected after the user has created an access token in the previous step.
Access Token Expiration DateIdentifies the date and time a user's access token expires. This field automatically populates when the user completes the steps in the Get Token window.
Test ConnectionTests the connection after the connection manager has been configured.

Get Token 

The Get Token window displays when users select the Get Token button.

Task Factory OAuth2 Token Getter Get Token

OptionDescription
Client IDThe client ID entered in the connection settings.
Client SecretThe client secret entered in the connection settings.
Authorized Redirect UrlThis is a required field. It must match a redirect URL configured within LinkedIn's developer website (located in the My Apps - OAuth 2.0 section).
ScopesIdentifies the default application permissions. Users can add the following scopes:

  • r_basicprofile 
  • r_emailaddress, 
  • rw_company_admin
  • w_share 
Multiple scopes should be separated by a space.
StateA unique string value similar to a password. The state can be any word, number, or character combination that does not contain a space.
Get Access TokenAfter all fields have been completed, select the Get Access Token button to receive it. This opens a small browser within the window. The user must authenticate to LinkedIn and allow access to the API to complete the process.

Headers

Task Factory LinkedIn OAuth2 Connection Headers

OptionDescription
HeadersLinkedIn requires a connection header called x-li-format with the value Json. This is automatically entered after the user completes the steps in the Get Token window.
Add New HeaderCreates a new header.
Remove HeaderRemoves a selected header.

Proxy 

Task Factory LinkedIn OAuth2 Connection Proxy

OptionDescription
Proxy HostIdentifies the proxy address.
Proxy PortIdentifies the port used by the proxy.
Proxy User NameEnter the user name for proxies that require user authentication.
Proxy PasswordEnter the password for proxies that require user authentication.
Auth SchemeIdentifies which authentication scheme the proxy is using.
LinkedIn Source

LinkedIn Source

Source IconSource Description
Task Factory LinkedIn Source IconThe LinkedIn Source is used to extract data such as name, status updates, connections, and headlines within an SSIS package. See the LinkedIn Social OAuth2 Connection Manager to learn more about setting up this component's connection manager.

Task Factory LinkedIn Source

OptionDescription
Connection ManagerIn this field, users can create a new connection manager or select a pre-existing one.
Api End PointsIn this field, users select the Api they wish to connect to (Get My Profile and Get Member Profile.) Selecting an endpoint auto-populates that field's parameters and commonly used Output Columns.
API QueryThis field defines the query to be used in the API. Although several end points have been pre-configured, users can type in or paste custom calls that are not included with the component.

Note:  Unfortunately, LinkedIn does not provide a comprehensive list of API calls so users have to search the internet if they wish to customize this field.
Root Json PathBecause LinkedIn returns the raw data in Json format, users need to define the root path when creating custom queries.
Query ParametersUser-defined parameters (such as id) based on the API query. Parameters can be set dynamically by entering the variable name.

Example: <@User::ScreenName>
Output ColumnsIn this window, users can add and remove columns and define their name, token path (defined within the raw data), data type, length, precision, scale, and code page.

Preview

Task Factory LinkedIn Source Preview

OptionDescription
Preview DataSelecting this button returns the results and raw data based on the user-defined settings.
ResultsIn this window, users can see a preview of the first few rows of data based on their configuration.
Raw DataThis window displays the Json data in raw form. Developers can use this to help determine a root and token path.