FigShare

The Lyftron Provider for FigShare offers the most natural way to access FigShare data from Lyftron with ease and also enables to connect with BI, MDM & ML tools, Data warehouses, Databases and other SAAS based applications with zero code and zero infrastructure requirements. The provider wraps the complexity of accessing FigShare data into easy-to-integrate relational fully managed ANSI Sql format. Make faster and better business decisions with Lyftron’s FigShare data provider and automatically build your data migration pipelines in minutes, not months

The provider hides the complexity of accessing data and provides additional powerful security features, smart caching, batching, socket management, and more.

Key Features

• Comprehensive Delta load mechanism.
• Real-time access to FigShare.
• Comprehensive full support of ANSI Sql to query data with ease.
• Collaborative query processing.

Prerequisites

The user must have credentials for FigShare, Lyftron and your destination data warehouse, lake or database to perform the data pipeline operation with Lyftron

Establishing a Connection with Lyftron's Quickstart Steps

Create your FigShare connection with Lyftron by following the 5 easy steps show below:

Step1. Add your connection

Click on Connect section on the left panel →  Click on Add Connection button

Step2. Select your connector

In the connector selection panel, search and click FigShare for your connection 

Step3. Enter your connection details

In the Connection String section enter the values of the below parameters. The following connection string is required to establish FigShare connection with Lyftron.

Profile=C:\profiles\Figshare.apip;ProfileSettings='APIKey=[your_apikey]';

Key	Value	Field
Connection Name	Enter your connection details	Required
Profile	C:\profiles\Figshare.apip	Required
APIKey	your FigShare personal_token	Required
Logfile**	Use the logfile option to debug your job and provide your connection name to generate the log file.  [ConnectionConfigurationPath]\Connection_name_log.tx	Optional
Verbosity**	Choose verbosity 1-5 based on the severity of debugging	Optional

** For more information, check the Lyftron logging and debugging section.

If you want more detailed information about how to establish a connection with Lyftron, click on Lyftron Connection Quick Start guide.

Step4. Test your connection

Once you are done entering your connection details, simply click on the Test Connection button to test the connectivity. In case your connection fails, add Logfile and Verbosity parameters and check the Lyftron logging and debugging section, to debug the error.

Step5. Save your connection

Hurray! Now you have successfully connected with the Lyftron FigShare connector and can utilize the connector to Extract, Warehouse, Analyze, Visualize and Share your data.

Data Model 

The provider models the data in APIs into a list of tables that can be queried using standard SQL statements.

Generally, querying APIs tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns. 

Name	Type	Description
InstitutionAccountGroupRoles	Tables	List Institution Account Group Roles.
InstitutionCurationReview	Tables	Retrieve a certain curation review by its ID.
InstitutionCurationReviewComments	Tables	Retrieve a certain curation review's comments.
InstitutionCurationReviews	Tables	Retrieve a list of curation reviews for this institution.
PrivateAccountCategories	Tables	List institution categories (including parent Categories).
PrivateAccountInformation	Tables	Account information for token/personal token.
PrivateAccountInstitutionAccounts	Tables	Returns the accounts for which the account has administrative privileges (assigned and inherited).
PrivateAccountInstitutionGroups	Tables	List institution categories (including parent Categories).
PrivateAccountInstitutionRoles	Tables	Returns the roles available for groups and the institution group.
PrivateAccountInstitutions	Tables	Returns Account institution details.
PrivateAccountInstitutionUser	Tables	Retrieve institution user information using the AccountId.
PrivateAccountLicenses	Tables	It will return a list with figshare public licenses AND licenses defined for account's institution.
PrivateArticleAuthors	Tables	List article authors.
PrivateArticleCategories	Tables	List article categories.
PrivateArticleDetails	Tables	Retrieve private article details.
PrivateArticleFiles	Tables	List private files.
PrivateArticlePrivateLinks	Tables	List private links.
PrivateArticles	Tables	Get Own Articles
PrivateCollectionArticles	Tables	List collection articles.
PrivateCollectionAuthors	Tables	List collection authors.
PrivateCollectionCategories	Tables	List collection categories.
PrivateCollectionDetails	Tables	Retrieve private collection details.
PrivateCollectionPrivateLinks	Tables	List collection private links.
PrivateCollections	Tables	List private collections
PrivateInstitutionArticles	Tables	Get Articles from own institution. User must be administrator of the institution.
PrivateProjectArticleDetails	Tables	Retrieve private project article details.
PrivateProjectArticleFiles	Tables	Retrieve private project article files.
PrivateProjectArticles	Tables	List private project articles.
PrivateProjectCollaborators	Tables	List Project collaborators and invited users.
PrivateProjectDetails	Tables	Retrieve private project details.
PrivateProjectNotes	Tables	Retrieve private project notes.
PrivateProjects	Tables	List private projects
PublicArticleDetails	Tables	Retrieve public article details.
PublicArticleFiles	Tables	Files list for article.
PublicArticles	Tables	Returns a list of public articles. There is a API limititaion on the number of articles that you can retrieve. Use one or more filters not to exceed this API limitation.
PublicCategories	Tables	Returns a list of public categories.
PublicCollectionArticles	Tables	Returns a list of public collection articles.
PublicCollectionDetails	Tables	Retrieve public collection details.
PublicCollections	Tables	Returns a list of public collections. There is a API limititaion on the number of public collections that you can retrieve. Use one or more filters not to exceed this API limitation.
PublicInstitutionArticles	Tables	Returns a list of articles belonging to the institution.
PublicLicenses	Tables	Returns a list of public licenses.
PublicProjectArticles	Tables	Returns a list of public project articles.
PublicProjectDetails	Tables	Retrieve public project details.
PublicProjects	Tables	Returns a list of public projects. There is a API limititaion on the number of public projects that you can retrieve. Use one or more filters not to exceed this API limitation.