Overview
The Lyftron Provider for AgileCRM offers the most natural way to access AgileCRM 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 AgileCRM data into easy-to-integrate relational fully managed ANSI Sql format. Make faster and better business decisions with Lyftron’s AgileCRM 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 AgileCRM.
- Comprehensive full support of ANSI Sql to query data with ease.
- Collaborative query processing.
Prerequisites
The user must have credentials for AgileCRM, Lyftron and your destination data warehouse, lake or database to perform the data pipeline operation with Lyftron
Step1: Setup AgileCRM account
1.1 Create account in AgileCRM and login
1.2. After Login go to →; Admin setting and click on →; Developers & API here you will get a Rest-API key and JavaScript-key
Establishing a Connection with Lyftron's Quickstart Steps
Create your AgileCRM 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 AgileCRM 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 AgileCRM connection with Lyftron.
'Profile=AgileCRM;ProfileSettings='User=[your_email_id];Password=[your_apikey];Domain=[https://yourdomin.agilecrm.com]';'2.3 Give connection name as AgileCRM --> Replace “your_login_id” with AgileCRM login ID ,Replace your_api_key with RestAPI-Key and domain_name with the domain name which is provide by AgileCRM for e.g. https://[YourDomain].aglie.com, 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\AgileCRM.apip | Required |
| User | your AgileCRM < EmailId > | Required |
| Password | your AgileCRM < key > | Required |
| Domain | Your AgileCRM Domain | 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 AgileCRM 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 Click on Normalize section from the left panel → Click on Add Data Source button , Enter data source name → Choose AgileCRM from the existing list → Click next
3.3 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 |
| Campaigns | Tables | Returns a list of campaigns |
| Contacts | Tables | Returns list of contacts in domain which are ordered by creation time. |
| ContactsByType | Tables | Returns list of contacts in domain which are ordered by creation time. |
| Documents | Tables | Returns list of documents in the JSON format related to the contact. |
| Events | Tables | Fetches the list of events happened in particular time. |
| FilterIDs | Tables | Returns list of filter IDs in JSON format. |
| MyOpportunities | Tables | Get deals of current user |
| NotesByContactId | Tables | Returns list of note JSONs related to the contact. |
| NotesByDealId | Tables | Returns list of notes JSONs related to the contact. |
| Opportunities | Tables | Returns list of all 'Deals' in the domain in JSON format, which are ordered by created time. Paging can be applied using the page_size and cursor query parameters. Count of the deals will be in the first deal and the cursor for the next page will be in the last deal of the list. If there is no cursor, it means that it is the end of the list. |
| OpportunityBased | Tables | Fetches list of deals from the particular track. Number of milestones depends upon the milestones added by user to that track. The track id has to be sent as a query parameter. |
| OpportunityByContactId | Tables | Fetches list of deals related to specified contact using the contact id. |
| OpportunityByMilestone | Tables | Fetches list of deals from the default track grouped by milestones. Number of milestones depends upon the milestones added by user to default track. |
| OpportunityByPipline | Tables | Fetches list of deals from the particular track grouped by milestones. Number of milestones depends upon the milestones added by user to that track. The track id has to be sent as a query parameter. If 0 is sent as the parameter, it will give the list of deals from the default track. |
| TaskByContact | Tables | Retrieves the tasks related to contact, sorted by the date (latest first.) |
| Tasks | Tables | Get list of Tasks and Gets the task of the contact with the given ID. |
| TicketNotes | Tables | Returns list of JSON tickets. |
| Tickets | Tables | Returns list of JSON tickets. |
| Tracks | Tables | Gets all the tracks. Each track will be having a set of milestones. |
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. Click on the analyze section on the left panel → Choose data source from the list Drag and drop the table → Choose your querying options
4.2. Click on → EXECUTE and selected query will return data successfully
Advanced Settings
To view a detailed advanced settings options, go to AgileCRM Advanced Settings. Complete list of the parameters you can configure in the connection string can be found by clicking Connection String Parameters.