Overview
The Lyftron Provider for Highrise offers the most natural way to access Highrise 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 Highrise data into easy-to-integrate relational fully managed ANSI Sql format. Make faster and better business decisions with Lyftron’s Highrise 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 Highrise.
- Comprehensive full support of ANSI Sql to query data with ease.
- Collaborative query processing.
Prerequisites
The user must have credentials for Highrise, 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 Highrise 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 Highrise 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 Highrise connection with Lyftron.
InitiateOAuth=GETANDREFRESH;OAuthClientId=[your_ClientId];OAuthClientSecret=[your_ClientSecret]; CallbackURL=[your_url];AccountId=[your_AccountId];Key | Value | Field |
Connection Name | Enter your connection details | Required |
InitiateOAuth | GETANDREFRESH | Required |
OAuthClientId | Your Highrise OAuthClientId | Required |
OAuthClientSecret | Your Highrise OAuthClientSecret | Required |
CallbackURL | http://localhost | Required |
AccountId | Your Highrise AccountId | 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 Highrise connector and can utilize the connector to Extract, Warehouse, Analyze, Visualize and Share your data.
Data Model
The Lyftron Provider for Highrise models the Highrise API as relational tables, views, and stored procedures. API limitations and requirements are documented in this section; you can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations.
Tables
The Lyftron Provider for Highrise models writable Highrise APIs as easy-to-access Tables. Most tables are defined in simple, text-based schema files. However, some tables, such as Companies, Deals, and People, are dynamic. When you connect, the provider gets the metadata for dynamic tables by calling the appropriate Web services.
Views
Views are read-only tables. Typically, data that cannot be modified is represented in views.
Name | Type | Description |
Cases | Tables | Create, update, delete, and query Cases that are visible to the authenticated user. |
Comments | Tables | Create, update, delete, and query Comments associated with a Note or Email and visible to the authenticated user. |
Companies | Tables | Create, update, delete, and query Highrise Companies. This table is dynamic. |
CustomFields | Tables | Return all custom fields used in the account. |
DealCategories | Tables | Create, update, delete, and query Deal Categories. |
Deals | Tables | Create, update, delete, and query Highrise Deals. This table is dynamic. |
Groups | Tables | Query, create, update and delete your account's groups |
Notes | Tables | Create, update, delete, and query Notes that are visible to the authenticated user and related to a specific Person, Company, Case, or Deal. |
People | Tables | Create, update, delete, and query Highrise People. This table is dynamic. |
TaskCategories | Tables | Create, update, delete, and query Task Categories. |
Account | Views | Retrieve information about the current user's account. |
Deletions | Views | Query deleted resources. |
Emails | Views | Query Emails that are visible to the authenticated user and related to a specific Person, Company, Case, or Deal. |
GroupUsers | Views | Query the groups created in your account and the users that are associated with the groups. |
Memberships | Views | Query information about your account's memberships. |
Tags | Views | Query information about your account's tags. |
Tasks | Views | Retrieve Tasks created in the account. |
Users | Views | Return information about your account's active users. |
Advanced Settings
To view a detailed advanced settings options, go to Highrise Advanced Settings. Complete list of the parameters you can configure in the connection string can be found by clicking Connection String Parameters.