Overview
The Lyftron Provider for CapsuleCrm offers the most natural way to access CapsuleCrm 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 CapsuleCrm data into easy-to-integrate relational fully managed ANSI Sql format. Make faster and better business decisions with Lyftron’s CapsuleCrm 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 CapsuleCrm.
- Comprehensive full support of ANSI Sql to query data with ease.
- Collaborative query processing.
Prerequisites
The user must have credentials for CapsuleCrm, 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 CapsuleCrm 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 CapsuleCrm 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 CapsuleCrm connection with Lyftron.
"Profile=C:\profiles\CapsuleCrm.apip;ProfileSettings='Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url';"| Key | Value | Field |
| Connection Name | Enter your connection details | Required |
| Profile | C:\profiles\CapsuleCrm.apip | Required |
| ProfileSettings | Authscheme=OAuth | Required |
| InitiateOAuth | GETANDREFRESH | |
| OAuthClientId | Your client id | Required |
| OAuthClientSecret | Your client secret | Required |
| CallbackUrl | Your callback URL | 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 CapsuleCrm connector and can utilize the connector to Extract, Warehouse, Analyze, Visualize and Share your data.
Data Model
The provider models the data in API into a list of tables that can be queried using standard SQL statements.
Generally, querying API 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 |
| ActivityTypes | Table | Returns the collection of all the activity types on this Capsule account. |
| CaseEntries | Table | List notes, emails and completed tasks for cases. |
| CaseParties | Table | Returns the collection of additional parties related to a given case. |
| Cases | Table | Returns the collection of Cases on the Capsule account. |
| CaseTags | Table | Returns the collection of all of the case tags on this Capsule account |
| Categories | Table | Returns collection of all the lost reasons on this Capsule account. |
| Countries | Table | List the country codes that Capsule supports. |
| Currencies | Table | List the currency codes that Capsule supports. |
| CurrentUser | Table | Shows the details of the user the provided access token is associated with. |
| DeletedCases | Table | Returns a collection of cases that have been deleted from Capsule since the date specified in the since parameter. Also contains cases that have been made restricted for the user calling the API endpoint. |
| DeletedOpportunities | Table | Returns a collection of opportunities that have been deleted from Capsule since the date specified in the since parameter. Also contains opportunities that have been made restricted for the user calling the API endpoint. |
| DeletedParties | Table | Returns a collection of parties that have been deleted from Capsule since the date specified in the since parameter. Also contains parties that have been made restricted for the user calling the API endpoint. |
| Employees | Table | Returns the collection of employees linked to this organisation. |
| Entries | Table | List notes, emails and the details of completed party tasks in descending order starting with the most recent entry date first. |
| LostReasons | Table | Returns collection of all the lost reasons on this Capsule account. |
| Milestones | Table | Returns the collection of all the milestones on the Capsule account. |
| Opportunities | Table | Returns the collection of Opportunities on the Capsule account. |
| OpportunityCases | Table | Returns the collection of cases related to a given opportunity. |
| OpportunityEntries | Table | List notes, emails and completed tasks for opportunities. |
| OpportunityParties | Table | Returns the collection of additional parties related to a given opportunity. |
| OpportunityTags | Table | Returns the collection of all of the opportunity tags on this Capsule account |
| Parties | Table | Returns the collection of Parties on the Capsule account. |
| PartyCases | Table | Returns the collection of cases related to a given party. |
| PartyEntries | Table | List notes, emails and completed tasks for parties. |
| PartyOpportunities | Table | Returns the collection of all opportunities associated with the given party. |
| PartyTags | Table | Returns the collection of all of the party tags on this Capsule account |
| SearchCases | Table | Search for cases on the Capsule account. This will return the same results as the global search inside Capsule. |
| SearchOpportunities | Table | Search for opportunities on the Capsule account. This will return the same results as the global search inside Capsule. |
| SearchParties | Table | Search for parties on the Capsule account. This will return the same results as the global search inside Capsule. |
| Tasks | Table | Returns the collection of Tasks on the Capsule account. |
| Teams | Table | Returns all the teams on the Capsule account. |
| Users | Table | Returns all the users on the Capsule account. |
Advanced Settings
To view a detailed advanced settings options, go to CapsuleCrm Advanced Settings. Complete list of the parameters you can configure in the connection string can be found by clicking Connection String Parameters.