ClubHouse

The Lyftron Provider for ClubHouse offers the most natural way to access ClubHouse 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 ClubHouse data into easy-to-integrate relational fully managed ANSI Sql format. Make faster and better business decisions with Lyftron’s ClubHouse 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 ClubHouse.
• Comprehensive full support of ANSI Sql to query data with ease.
• Collaborative query processing.

Prerequisites

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

Step1: Setup ClubHouse account

1.1 Create account in ClubHouse and login

1.2. After Login go to -> Api Tocken and click on ->  generate Api key

Establishing a Connection with Lyftron's Quickstart Steps

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

 

 

Step2 : Login to Lyftron

Start creating your connection 

 

 

2.1 Click on Connect section on the left panel →  Click on Add Connection button Choose your provider -> Type ClubHouse in search bar  

 

Step2.2. Enter your connection details

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

Profile=ClubHouse;ProfileSettings='APIKey=[your_api_key];'

Give connection name as ClubHouse -> Replace “your_api_key” with ClubHouseApi-key , click on test connection -> click save. If connection is not successful so, check the error

 

Key	Value	Field
Connection Name	Enter your connection details	Required
Profile	C:\profiles\ClubHouse.apip	Required
API-Token	your ClubHouse < 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.

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.

Save your connection

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

Step3 : Normalize 

Create data source

After establishing connection, datasource metadata import is needed and for that Lyftron automatically normalize your API & different SQL dialects data into ANSI SQL format and also gives you API sources into simple, code less out of the box data model.

 

 

3.1 Enter data source name -> Choose  ClubHouse from the existing connection list  -> Click next

 

3.2 Choose the table you want to import and  -> Click Create

 

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
Categories	Tables	Categories returns a list of all Categories or information about the selected category and their attributes.
CurrentMember	Tables	Fetches the details of current logged member.
EpicComments	Tables	Get Epic Comment returns information about the selected Epic Comment.
Epics	Tables	List Epics returns a list of all Epics and their attributes.
EpicWorkflow	Tables	Get Epic Workflow returns the Epic Workflow for the organization.
Files	Tables	List Files returns a list of all Files or single file and related attributes in your Clubhouse.
IterationComments	Tables	Generates the list or single comment of iteration
Iterations	Tables	Generates the list of iterations.
Labels	Tables	List Labels returns a list of all Labels and their attributes.
LinkedFiles	Tables	List Linked Files returns a list of all Linked-Files and their attributes.
Members	Tables	List Members returns information about members of the organization.
Milestones	Tables	List Milestones returns a list of all Milestones or single milestone and their attributes.
Projects	Tables	List Projects returns a list of all Projects and their attributes.
Repositories	Tables	List Repositories returns a list of all Repositories and their attributes.
Story	Tables	Get Story returns information about a chosen Story.
StoryComments	Tables	Get Comment is used to get Comment information.
StoryLinks	Tables	Story links (called Story Relationships in the UI) allow you create semantic relationships between two stories.
StoryTasks	Tables	Generates the tasks of stories using story-public-id and task-id.
Teams	Tables	List Teams returns a list of all Teams in the organization.
Workflows	Tables	List Workflows returns a list of all Workflows in the organization.

 

Step 4:  Analyze 

 Querying the data source data

Lyftron allows you to query the source data by simply writing the ANSI Sql query. Please keep in mind as the data is coming directly from API so, there’s a limit to API calls and performance delay from the Stripe API side which Lyftron can’t control so, don’t expect to pull millions of records in just fraction of seconds. If you have heavy data loads, create the pipeline to unload that data into the Lyftron warehouse and query from it.

 

 

4.1.  Drag and drop the table -> Choose your querying options

 

4.2. Click on -> EXECUTE and selected query will return data successfully

 Advanced Settings