table(tablename)
parameter(schemaname) from\_page(start page number) to\_page (end page number)
columName(name of column)
columnValue(column value)
limit(rows limit)
| This method is use to fetch data from API | | execute\_query | tuple | string | This method is use to execute query | | get\_schema\_list | tuple | ConnectorObj | This method is use to get the schema list | | get\_schema\_objects | tuple | ConnectorObj schema | This method is use to get the schema object details | | get\_object\_columns | tuple |ConnectorObj schema
list
number\_of\_page
| This method is use to get the object columns detail | | | | | | ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/accelo/driver-framework). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # System Tables This page contains information about the Lyftrondata system tables. The following tables can be accessed via query maker, as shown in the example above. ### System Tables Information The [Lyftrondata](https://www.lyftrondata.com/) driver for [Accelo](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/accelo/driver-framework/None/README.md) provides information about the framework system tables. You can query the system tables with this syntax: Select \* from sys. | Table Name | Column Type | Query | Purpose | | ---------------- | ----------- | ------------------------------- | --------------------------------------------- | | sys | String | Select \* from sys | To get the system table information | | logs | String | Select \* from logs | To get the logs table information | | constraint | String | Select \* from constraints | To get the constraints table information | | methods | String | Select \* from methods | To get the methods table information | | delta | String | Select \* from delta | To get the delta table information | | usage | String | Select \* from usage | To get the usage table information | | version | String | Select \* from version | To get the version table information | | license | String | Select \* from license | To get the license table information | | connectionstring | String | Select \* from connectionstring | To get the connectionstring table information | ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/accelo/driver-framework). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # Act!Crm This page contains the setup guide and reference information for the Act!Crm source connector. ### Overview The [Lyftrondata](https://www.lyftrondata.com/) integration for [Act!Crm](https://www.lyftrondata.com/integration/sales-analytics/act-crm/) provides the most natural way to access data while requiring no engineering. ### Key Features * Comprehensive incremental load mechanism. * Data from Act!Crm is available in real-time. * ANSI SQL is fully supported to query data with ease. * Ready to query Act!Crm relational schema model. ### Setup Guide To connect to your destination without engineering, follow our step-by-step [Lyftrondata](https://www.lyftrondata.com/) [Act!Crm](https://www.lyftrondata.com/integration/sales-analytics/act-crm/) setup guide. * [ ] [Prerequisite](/sales-analytics/readme/act-crm/prerequisite) * [ ] [Connection Steps](/sales-analytics/readme/act-crm/connection-steps) * [ ] [Data Model](/sales-analytics/readme/act-crm/data-model/erd) * [ ] [Driver Framework](/sales-analytics/readme/act-crm/driver-framework) ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/act-crm/connection-steps). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # Connection Steps This section explains how to connect Lyftrondata to Act!Crm. ### Establishing a connection [Lyftrondata](https://www.lyftrondata.com) offers following methods connecting to [Act!Crm](https://www.lyftrondata.com/integration/sales-analytics/act-crm/). To establish your connection, use the connection strings described below. ### PersonalToken | Key | Value | Field | | --------------- | ------------------- | -------- | | personal\_token | Your Personal Token | Required | Follow the steps below to establish a basic connection ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/act-crm). ### Questions? We're always happy to help with any other questions you might have! [Set up a meeting with our experts](https://www.lyftrondata.com/book-a-meeting/). # Destinations This section contains information about the destinations that Act!Crm supports. ### Supported Destinations The [Lyftrondata](https://www.lyftrondata.com/) driver of [Act!Crm](https://www.lyftrondata.com/integration/sales-analytics/act-crm/) provides support for the below destinations for instant analytics with no engineering in just 4 simple steps. ### Snowflake Load: ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/act-crm). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # Prerequisite This section describes the prerequisites for connecting Act!Crm to Lyftrondata. To complete the prerequisites, the user must have admin access to Act!Crm. ### Setup Instructions Follow the steps below to create an API Credentials for the [Act!Crm](https://www.lyftrondata.com/integration/sales-analytics/act-crm/) driver setup with [Lyftrondata](https://www.lyftrondata.com) ### Video Instruction ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/act-crm). ### Questions? We're always happy to help with any other questions you might have! [Set up a meeting with our experts](https://www.lyftrondata.com/book-a-meeting/). # Data Model This section describes the details of Act!Crm ERD, Tables, and Views. ### Index The [Lyftrondata](https://www.lyftrondata.com/) driver for [Act!Crm](https://www.lyftrondata.com/integration/sales-analytics/act-crm/) provides a data model that enables you to better understand the source platform. * [ ] [ERD](/sales-analytics/readme/act-crm/data-model/erd) * [ ] [Tables](/sales-analytics/readme/act-crm/data-model/tables) * [ ] [Views](/sales-analytics/readme/act-crm/data-model/views) ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/act-crm). ### Questions? We're always happy to help with any other questions you might have! [Set up a meeting with our experts](https://www.lyftrondata.com/book-a-meeting/). # ERD This section contains detailed information about the data dictionary, and entity relationships in the source system. ### Entity Relationship Diagram The [Lyftrondata](https://www.lyftrondata.com/) driver for [Act!Crm](https://www.lyftrondata.com/integration/sales-analytics/act-crm/) provides detailed information about the entity relationships of data objects. ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/act-crm). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with one of our data experts.](https://www.lyftrondata.com/book-a-meeting/) # Tables This section contain information about act!crm connector tables information ### Data Dictionary The [Lyftrondata](https://www.lyftrondata.com/) driver for [Act!Crm](https://www.lyftrondata.com/integration/sales-analytics/act-crm/)[ ](https://www.lyftrondata.com/integration/act!crm/)provides a detailed data dictionary of the tables with data types and column names. ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/act-crm). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # Views This section contain information about act!crm connector views information ### Data Dictionary The [Lyftrondata](https://www.lyftrondata.com/) driver for [Act!Crm](https://www.lyftrondata.com/integration/sales-analytics/act-crm/)[ ](https://www.lyftrondata.com/integration/act!crm/)provides a detailed data dictionary of the views with data types and column names. ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/act-crm). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # Driver Framework This page contains the setup guide and reference information for the Act!Crm source connector. ### Overview The [Lyftrondata](https://www.lyftrondata.com/) integration for [Act!Crm](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/act!crm/driver-framework/None/README.md) provides the most natural way to access data while requiring no engineering. ### Key Features * Comprehensive incremental load mechanism. * Data from Act!Crm is available in real-time. * ANSI SQL is fully supported to query data with ease. * Ready to query Act!Crm relational schema model. ### Setup Guide To connect to your destination without engineering, follow our step-by-step Lyftrondata Act!Crm setup guide. * [ ] [Prerequisite](/sales-analytics/readme/act-crm/prerequisite) * [ ] [Connection Steps](/sales-analytics/readme/act-crm/connection-steps) * [ ] [Data Model](/sales-analytics/readme/act-crm/data-model/erd) * [ ] [Driver Framework](/sales-analytics/readme/act-crm/driver-framework) ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/act-crm/driver-framework). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # Connecting from Code This section provides information on how to connect the connector from the code. ### Working with the connector The [Lyftrondata](https://www.lyftrondata.com/) driver for [Act!Crm](https://www.lyftrondata.com/integration/sales-analytics/act-crm/) provides simple connectivity steps from code. The primary functionality of the Lyftrondata Python Connector lies in querying, which interacts directly with the available services for your connector. However, many of these stored procedures rely on information stored in the provider's tables. These tables must be populated by the user and will contain all of the information that a certain user has on their connector account. The tables will rely on user data provided by connector on their endpoints. Once the needed input data is present, one can execute SELECT queries by running the query maker function of Lyftrondata\_Connector. ### Connecting from code See wheel \[installation]\(../../../Sales Analytics/act!crm/driver-framework/installation.md) for the prerequisite information you need to deploy the source connector. ```python import Lyftrondata.MyConnector.lib.Lyftrondata_MyConnector_Connector as con lyft = con.Connect("My Lyftrondata license key") init = lyft.initialise(username="my username",password="my password") ``` ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/act-crm/driver-framework). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # Connection String This section provides information about the driver supported connection string to connect with the API ### Steps The [Lyftrondata](https://www.lyftrondata.com/) driver for [Act!Crm](https://www.lyftrondata.com/integration/sales-analytics/act-crm/)[ ](https://www.lyftrondata.com/integration/sales-analytics/act-crm/)provides the connection string steps documented below. For more detailed information about driver connectivity, visit the [Connection Steps](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/erp/dynamics-365-business-central/connection-steps.md) section of this document. ```python import Lyftrondata.MyConnector.lib.Lyftrondata_MyConnector_Connector as con lyft = con.Connect("My Lyftrondata license key") init = lyft.initialise(username="my username",password="my password") df = lyft.execute_query("Select * from my sys.connectionstring") print(df) //my pandas dataframe ``` ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/act-crm/driver-framework). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # Installation This sections covers the step-step instruction about the Lyftrondata connector installation. It's must to have Python 3.9 as the default version for our drivers to work efficiently. ### Prerequisite The [Lyftrondata](https://www.lyftrondata.com) driver for [Act!Crm](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/act!crm/driver-framework/None/README.md)) requires the below versions * [ ] Python 3.9 * [ ] Python 3 pip * [ ] Connector Wheel file * [ ] Valid license * [ ] Knowledge of Python programming * [ ] Knowledge of SQL ### Installation Steps To start your installation, you need to download the [wheel](https://pypi.org/project/wheel/) file. The downloaded archive contains several whl files, each of which corresponds to a specific combination of environmental factors. These factors include: * The operating system that the python connector is used in, whether it is Windows, Mac, or Linux. * The Architecture of the operating system, whether it is 32-bit or 64-bit. For Windows systems, this will correspond to the win32 or win\_amd64 wheels. For Linux, this will correspond to the linux\_i686 and linux\_x86\_64 wheels. * The version of Python is in use. The connectors are supported in Python 3.9 for Windows and Linux, and for Mac. * Once the appropriate whl file is identified, install the connector to your Python distribution with the "pip install" command via the command line. This will usually take the form of running the following commands in sequence. The wheel for Python 3.9 is used for the below example: #### Linux {% code title="Lyftrondata\_Linux\_Sdk" lineNumbers="true" %} ```shell sudo apt-get install python3.9 sudo apt-get install python3-pip python3 -m venv myvenv source venv/bin/activate pip install Lyftrondata_Mylibrary.whl ``` {% endcode %} #### Windows {% code title="Lyftrondata\_Win\_Sdk" lineNumbers="true" %} ```shell winget install -e --id Python.Python -v 3.9.0 python3 -m venv myvenv source venv/bin/activate pip install Lyftrondata_Mylibrary.whl ``` {% endcode %} **Mac** ```shell brew install python@3.9 python3 -m venv myvenv source venv/bin/activate pip install Lyftrondata_Mylibrary.whl ``` ### Validation You can confirm whether the connector is successfully installed by running the pip list command. If "Lyftrondata\_Mylibrary.whl" is present in the list output by the command, then the installation was successful. ```shell pip list ``` ### Uninstallation Should the connector need to be uninstalled for any reason, you can do so by running the pip uninstall command, as in the example below: ```shell pip uninstall Lyftrondata_Mylibrary.whl ``` ### License Key The license key will be provided by the Lyftrondata team which will be used for driver connectivity validation. ```shell import Lyftrondata.MyConnector.lib.Lyftrondata_MyConnector_Connector as con lyft = con.Connect("My Lyftrondata license key") ``` ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/act-crm/driver-framework). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # Querying Data This section provides information about the Lyftrondata connector query maker method and how to execute ANSI Sql queries ### Executing Query The [Lyftrondata](https://www.lyftrondata.com/) driver for [Act!Crm](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/act!crm/driver-framework/None/README.md) provides query maker functionality for querying data. To execute SQL statements that return data, use the cursor object's execute method. Once a query is executed, the result set is fetched from the API. This result set is converted into the relational format and returned which can then be printed out. ```shell import Lyftrondata.MyConnector.lib.Lyftrondata_MyConnector_Connector as con lyft = con.Connect("My Lyftrondata license key") init = lyft.initialise(username="my username",password="my password") df = lyft.execute_query("Select * from my table") print(df) //my pandas dataframe ``` ### Querying with where clause We can filter our data directly from the API by providing a where clause for the table. ```shell import Lyftrondata.MyConnector.lib.Lyftrondata_MyConnector_Connector as con lyft = con.Connect("My Lyftrondata license key") init = lyft.initialise(username="my username",password="my password") df = lyft.execute_query("Select * from my table where id=3") print(df) //my pandas dataframe ``` ### Querying Sys & Data Tables The connector possesses system table definition that provides information about the connector framework metadata, and data tables that are used to discover the connector business information in the \[ERD Data Model]\(../../../Sales Analytics/act!crm/data-model/erd.md). ```shell import Lyftrondata.MyConnector.lib.Lyftrondata_MyConnector_Connector as con lyft = con.Connect("My Lyftrondata license key") init = lyft.initialise(username="my username",password="my password") df = lyft.execute_query("Select * from my sys.tables") print(df) //my pandas dataframe ``` ### Querying Sys Views The connector possesses views definition that provides information about how these views are used to discover the connector business information in the \[ERD Data Model]\(../../../Sales Analytics/act!crm/data-model/erd.md). ```shell import Lyftrondata.MyConnector.lib.Lyftrondata_MyConnector_Connector as con lyft = con.Connect("My Lyftrondata license key") init = lyft.initialise(username="my username",password="my password") df = lyft.execute_query("Select * from my sys.views") print(df) //my pandas dataframe ``` ### Usage Logging You will simply need to set two connection properties to begin capturing provider logging. * For the usage logging you have to execute a query "select \* from sys.usage", which will return all the usage of the connector from the beginning. * It shows how much time left, time spent and total allotted time of the connector. You can also access the timestamp.txt from the current driver directory which contains information, such as when authentication is performed or queries are executed. The specified file will be created by the driver in your working directory. ```shell import Lyftrondata.MyConnector.lib.Lyftrondata_MyConnector_Connector as con lyft = con.Connect("My Lyftrondata license key") init = lyft.initialise(username="my username",password="my password") df = lyft.execute_query("Select * from my sys.usage") print(df) //my pandas dataframe ``` ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/act-crm/driver-framework). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # SQL Standard This section discusses the SQL syntax for the Lyftrondata driver. Our driver adheres to ANSI standards, and all of our Python drivers adhere to the Sql Alchemy framework. ### Select Statements The [Lyftrondata](https://www.lyftrondata.com/) driver for [Act!Crm](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/act!crm/driver-framework/None/README.md) provides ANSI SQL standard support. A SELECT statement can consist of the following basic clauses. * SELECT * INTO * FROM * JOIN * WHERE * GROUP BY * HAVING * UNION * ORDER BY * LIMIT * PAGESIZE LIMIT ### SELECT Syntax The following syntax diagram outlines the syntax supported by the SQL engine of the provider: {% code overflow="wrap" %} ```html SELECT { [ TOPtable(tablename)
parameter(schemaname) from\_page(start page number) to\_page (end page number)
columName(name of column)
columnValue(column value)
limit(rows limit)
| This method is use to fetch data from API | | execute\_query | tuple | string | This method is use to execute query | | get\_schema\_list | tuple | ConnectorObj | This method is use to get the schema list | | get\_schema\_objects | tuple | ConnectorObj schema | This method is use to get the schema object details | | get\_object\_columns | tuple |ConnectorObj schema
list
number\_of\_page
| This method is use to get the object columns detail | | | | | | ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/act-crm/driver-framework). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # System Tables This page contains information about the Lyftrondata system tables. The following tables can be accessed via query maker, as shown in the example above. ### System Tables Information The [Lyftrondata](https://www.lyftrondata.com/) driver for [Act!Crm](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/act!crm/driver-framework/None/README.md) provides information about the framework system tables. You can query the system tables with this syntax: Select \* from sys. | Table Name | Column Type | Query | Purpose | | ---------------- | ----------- | ------------------------------- | --------------------------------------------- | | sys | String | Select \* from sys | To get the system table information | | logs | String | Select \* from logs | To get the logs table information | | constraint | String | Select \* from constraints | To get the constraints table information | | methods | String | Select \* from methods | To get the methods table information | | delta | String | Select \* from delta | To get the delta table information | | usage | String | Select \* from usage | To get the usage table information | | version | String | Select \* from version | To get the version table information | | license | String | Select \* from license | To get the license table information | | connectionstring | String | Select \* from connectionstring | To get the connectionstring table information | ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/act-crm/driver-framework). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # Aftershiptracking This page contains the setup guide and reference information for the Aftershiptracking source connector. ### Overview The [Lyftrondata](https://www.lyftrondata.com/) integration for [Aftershiptracking](https://www.lyftrondata.com/integration/sales-analytics/aftership-tracking/) provides the most natural way to access data while requiring no engineering. ### Key Features * Comprehensive incremental load mechanism. * Data from Aftershiptracking is available in real-time. * ANSI SQL is fully supported to query data with ease. * Ready to query Aftershiptracking relational schema model. ### Setup Guide To connect to your destination without engineering, follow our step-by-step [Lyftrondata](https://www.lyftrondata.com/) [Aftershiptracking](https://www.lyftrondata.com/integration/sales-analytics/aftership-tracking/) setup guide. * [ ] [Prerequisite](/sales-analytics/readme/aftershiptracking/prerequisite) * [ ] [Connection Steps](/sales-analytics/readme/aftershiptracking/connection-steps) * [ ] [Data Model](/sales-analytics/readme/aftershiptracking/data-model/erd) * [ ] [Driver Framework](/sales-analytics/readme/aftershiptracking/driver-framework) ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/aftershiptracking/broken-reference/README.md). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # Connection Steps This section explains how to connect Lyftrondata to Aftershiptracking. ### Establishing a connection [Lyftrondata](https://www.lyftrondata.com) offers following methods connecting to [Aftershiptracking](https://www.lyftrondata.com/integration/sales-analytics/aftership-tracking/). To establish your connection, use the connection strings described below. ### PersonalToken | Key | Value | Field | | --------------- | -------------------------------------- | -------- | | personal\_token | Your Aftership tracking Personal Token | Required | Follow the steps below to establish a basic connection {% embed url="table(tablename)
parameter(schemaname) from\_page(start page number) to\_page (end page number)
columName(name of column)
columnValue(column value)
limit(rows limit)
| This method is use to fetch data from API | | execute\_query | tuple | string | This method is use to execute query | | get\_schema\_list | tuple | ConnectorObj | This method is use to get the schema list | | get\_schema\_objects | tuple | ConnectorObj schema | This method is use to get the schema object details | | get\_object\_columns | tuple |ConnectorObj schema
list
number\_of\_page
| This method is use to get the object columns detail | | | | | | ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/aftershiptracking/driver-framework). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # System Tables This page contains information about the Lyftrondata system tables. The following tables can be accessed via query maker, as shown in the example above. ### System Tables Information The [Lyftrondata](https://www.lyftrondata.com/) driver for [Aftershiptracking](https://www.lyftrondata.com/integration/sales-analytics/aftership-tracking//) provides information about the framework system tables. You can query the system tables with this syntax: Select \* from sys. | Table Name | Column Type | Query | Purpose | | ---------------- | ----------- | ------------------------------- | --------------------------------------------- | | sys | String | Select \* from sys | To get the system table information | | logs | String | Select \* from logs | To get the logs table information | | constraint | String | Select \* from constraints | To get the constraints table information | | methods | String | Select \* from methods | To get the methods table information | | delta | String | Select \* from delta | To get the delta table information | | usage | String | Select \* from usage | To get the usage table information | | version | String | Select \* from version | To get the version table information | | license | String | Select \* from license | To get the license table information | | connectionstring | String | Select \* from connectionstring | To get the connectionstring table information | ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/aftershiptracking/driver-framework). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # Agilecrm This page contains the setup guide and reference information for the Agilecrm source connector. ### Overview The [Lyftrondata](https://www.lyftrondata.com/) integration for [Agilecrm](https://www.lyftrondata.com/integration/sales-analytics/agile-crm/) provides the most natural way to access data while requiring no engineering. ### Key Features * Comprehensive incremental load mechanism. * Data from Agilecrm is available in real-time. * ANSI SQL is fully supported to query data with ease. * Ready to query Agilecrm relational schema model. ### Setup Guide To connect to your destination without engineering, follow our step-by-step [Lyftrondata](https://www.lyftrondata.com/) [Agilecrm](https://www.lyftrondata.com/integration/sales-analytics/agile-crm/) setup guide. * [ ] [Prerequisite](/sales-analytics/readme/agilecrm/prerequisite) * [ ] [Connection Steps](/sales-analytics/readme/agilecrm/connection-steps) * [ ] [Data Model](/sales-analytics/readme/agilecrm/data-model/erd) * [ ] [Driver Framework](/sales-analytics/readme/agilecrm/driver-framework) ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/agilecrm/broken-reference/README.md). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # Connection Steps This section explains how to connect Lyftrondata to Agilecrm. ### Establishing a connection [Lyftrondata](https://www.lyftrondata.com) offers following methods connecting to [Agilecrm](https://www.lyftrondata.com/integration/sales-analytics/agile-crm/). To establish your connection, use the connection strings described below. ### Basic | Key | Value | Field | | --------- | ------------------------ | -------- | | Username | Your AgileCRM Username. | Required | | Password | Your AgileCRM Password. | Required | | Subdomain | Your AgileCRM Subdomain. | Required | Follow the steps below to establish a basic connection {% embed url="table(tablename)
parameter(schemaname) from\_page(start page number) to\_page (end page number)
columName(name of column)
columnValue(column value)
limit(rows limit)
| This method is use to fetch data from API | | execute\_query | tuple | string | This method is use to execute query | | get\_schema\_list | tuple | ConnectorObj | This method is use to get the schema list | | get\_schema\_objects | tuple | ConnectorObj schema | This method is use to get the schema object details | | get\_object\_columns | tuple |ConnectorObj schema
list
number\_of\_page
| This method is use to get the object columns detail | | | | | | ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/agilecrm/driver-framework). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # System Tables This page contains information about the Lyftrondata system tables. The following tables can be accessed via query maker, as shown in the example above. ### System Tables Information The [Lyftrondata](https://www.lyftrondata.com/) driver for [Agilecrm](https://www.lyftrondata.com/integration/sales-analytics/agile-crm//) provides information about the framework system tables. You can query the system tables with this syntax: Select \* from sys. | Table Name | Column Type | Query | Purpose | | ---------------- | ----------- | ------------------------------- | --------------------------------------------- | | sys | String | Select \* from sys | To get the system table information | | logs | String | Select \* from logs | To get the logs table information | | constraint | String | Select \* from constraints | To get the constraints table information | | methods | String | Select \* from methods | To get the methods table information | | delta | String | Select \* from delta | To get the delta table information | | usage | String | Select \* from usage | To get the usage table information | | version | String | Select \* from version | To get the version table information | | license | String | Select \* from license | To get the license table information | | connectionstring | String | Select \* from connectionstring | To get the connectionstring table information | ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/agilecrm/driver-framework). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # Android This page contains the setup guide and reference information for the Android source connector. ### Overview The [Lyftrondata](https://www.lyftrondata.com/) integration for [Android](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/android/None/README.md) provides the most natural way to access data while requiring no engineering. ### Key Features * Comprehensive incremental load mechanism. * Data from Android is available in real-time. * ANSI SQL is fully supported to query data with ease. * Ready to query Android relational schema model. ### Setup Guide To connect to your destination without engineering, follow our step-by-step [Lyftrondata](https://www.lyftrondata.com/) [Android](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/android/None/README.md) setup guide. * [ ] [Prerequisite](/sales-analytics/readme/android/prerequisite) * [ ] [Connection Steps](/sales-analytics/readme/android/connection-steps) * [ ] [Data Model](/sales-analytics/readme/android/data-model/erd) * [ ] [Driver Framework](/sales-analytics/readme/android/driver-framework) ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/README.md). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # Connection Steps This section explains how to connect Lyftrondata to Android. ### Establishing a connection [Lyftrondata](https://www.lyftrondata.com) offers following methods connecting to [Android](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/android/None/README.md). To establish your connection, use the connection strings described below. ### PersonalToken | Key | Value | Field | | --------------- | ------------------- | -------- | | personal\_token | Your Personal Token | Required | Follow the steps below to establish a basic connection ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/android). ### Questions? We're always happy to help with any other questions you might have! [Set up a meeting with our experts](https://www.lyftrondata.com/book-a-meeting/). # Destinations This section contains information about the destinations that Android supports. ### Supported Destinations The [Lyftrondata](https://www.lyftrondata.com/) driver of [Android](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/android/None/README.md) provides support for the below destinations for instant analytics with no engineering in just 4 simple steps. ### Snowflake Load: ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/android). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # Prerequisite This section describes the prerequisites for connecting Android to Lyftrondata. To complete the prerequisites, the user must have admin access to Android. ### Setup Instructions Follow the steps below to create an API Credentials for the [Android](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/android/None/README.md) driver setup with [Lyftrondata](https://www.lyftrondata.com) ### Video Instruction ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/android). ### Questions? We're always happy to help with any other questions you might have! [Set up a meeting with our experts](https://www.lyftrondata.com/book-a-meeting/). # Data Model This section describes the details of Android ERD, Tables, and Views. ### Index The [Lyftrondata](https://www.lyftrondata.com/) driver for [Android](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/android/data-model/None/README.md) provides a data model that enables you to better understand the source platform. * [ ] [ERD](/sales-analytics/readme/android/data-model/erd) * [ ] [Tables](/sales-analytics/readme/android/data-model/tables) * [ ] [Views](/sales-analytics/readme/android/data-model/views) ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/android). ### Questions? We're always happy to help with any other questions you might have! [Set up a meeting with our experts](https://www.lyftrondata.com/book-a-meeting/). # ERD This section contains detailed information about the data dictionary, and entity relationships in the source system. ### Entity Relationship Diagram The [Lyftrondata](https://www.lyftrondata.com/) driver for [Android](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/android/data-model/None/README.md) provides detailed information about the entity relationships of data objects. ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/android). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with one of our data experts.](https://www.lyftrondata.com/book-a-meeting/) # Tables This section contain information about android connector tables information ### Data Dictionary The [Lyftrondata](https://www.lyftrondata.com/) driver for [Android](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/android/data-model/None/README.md)[ ](https://www.lyftrondata.com/integration/android/)provides a detailed data dictionary of the tables with data types and column names. ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/android). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # Views This section contain information about android connector views information ### Data Dictionary The [Lyftrondata](https://www.lyftrondata.com/) driver for [Android](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/android/data-model/None/README.md)[ ](https://www.lyftrondata.com/integration/android/)provides a detailed data dictionary of the views with data types and column names. ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/android). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # Driver Framework This page contains the setup guide and reference information for the Android source connector. ### Overview The [Lyftrondata](https://www.lyftrondata.com/) integration for [Android](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/android/driver-framework/None/README.md) provides the most natural way to access data while requiring no engineering. ### Key Features * Comprehensive incremental load mechanism. * Data from Android is available in real-time. * ANSI SQL is fully supported to query data with ease. * Ready to query Android relational schema model. ### Setup Guide To connect to your destination without engineering, follow our step-by-step Lyftrondata Android setup guide. * [ ] [Prerequisite](/sales-analytics/readme/android/prerequisite) * [ ] [Connection Steps](/sales-analytics/readme/android/connection-steps) * [ ] [Data Model](/sales-analytics/readme/android/data-model/erd) * [ ] [Driver Framework](/sales-analytics/readme/android/driver-framework) ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/android/driver-framework). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # Connecting from Code This section provides information on how to connect the connector from the code. ### Working with the connector The [Lyftrondata](https://www.lyftrondata.com/) driver for [Android](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/android/driver-framework/None/README.md) provides simple connectivity steps from code. The primary functionality of the Lyftrondata Python Connector lies in querying, which interacts directly with the available services for your connector. However, many of these stored procedures rely on information stored in the provider's tables. These tables must be populated by the user and will contain all of the information that a certain user has on their connector account. The tables will rely on user data provided by connector on their endpoints. Once the needed input data is present, one can execute SELECT queries by running the query maker function of Lyftrondata\_Connector. ### Connecting from code See wheel \[installation]\(../../../Sales Analytics/android/driver-framework/installation.md) for the prerequisite information you need to deploy the source connector. ```python import Lyftrondata.MyConnector.lib.Lyftrondata_MyConnector_Connector as con lyft = con.Connect("My Lyftrondata license key") init = lyft.initialise(username="my username",password="my password") ``` ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/android/driver-framework). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # Connection String This section provides information about the driver supported connection string to connect with the API ### Steps The [Lyftrondata](https://www.lyftrondata.com/) driver for [Android](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/android/driver-framework/None/README.md) provides the connection string steps documented below. For more detailed information about driver connectivity, visit the [Connection Steps](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/erp/dynamics-365-business-central/connection-steps.md) section of this document. ```python import Lyftrondata.MyConnector.lib.Lyftrondata_MyConnector_Connector as con lyft = con.Connect("My Lyftrondata license key") init = lyft.initialise(username="my username",password="my password") df = lyft.execute_query("Select * from my sys.connectionstring") print(df) //my pandas dataframe ``` ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/android/driver-framework). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # Installation This sections covers the step-step instruction about the Lyftrondata connector installation. It's must to have Python 3.9 as the default version for our drivers to work efficiently. ### Prerequisite The [Lyftrondata](https://www.lyftrondata.com) driver for [Android](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/android/driver-framework/None/README.md)) requires the below versions * [ ] Python 3.9 * [ ] Python 3 pip * [ ] Connector Wheel file * [ ] Valid license * [ ] Knowledge of Python programming * [ ] Knowledge of SQL ### Installation Steps To start your installation, you need to download the [wheel](https://pypi.org/project/wheel/) file. The downloaded archive contains several whl files, each of which corresponds to a specific combination of environmental factors. These factors include: * The operating system that the python connector is used in, whether it is Windows, Mac, or Linux. * The Architecture of the operating system, whether it is 32-bit or 64-bit. For Windows systems, this will correspond to the win32 or win\_amd64 wheels. For Linux, this will correspond to the linux\_i686 and linux\_x86\_64 wheels. * The version of Python is in use. The connectors are supported in Python 3.9 for Windows and Linux, and for Mac. * Once the appropriate whl file is identified, install the connector to your Python distribution with the "pip install" command via the command line. This will usually take the form of running the following commands in sequence. The wheel for Python 3.9 is used for the below example: #### Linux {% code title="Lyftrondata\_Linux\_Sdk" lineNumbers="true" %} ```shell sudo apt-get install python3.9 sudo apt-get install python3-pip python3 -m venv myvenv source venv/bin/activate pip install Lyftrondata_Mylibrary.whl ``` {% endcode %} #### Windows {% code title="Lyftrondata\_Win\_Sdk" lineNumbers="true" %} ```shell winget install -e --id Python.Python -v 3.9.0 python3 -m venv myvenv source venv/bin/activate pip install Lyftrondata_Mylibrary.whl ``` {% endcode %} **Mac** ```shell brew install python@3.9 python3 -m venv myvenv source venv/bin/activate pip install Lyftrondata_Mylibrary.whl ``` ### Validation You can confirm whether the connector is successfully installed by running the pip list command. If "Lyftrondata\_Mylibrary.whl" is present in the list output by the command, then the installation was successful. ```shell pip list ``` ### Uninstallation Should the connector need to be uninstalled for any reason, you can do so by running the pip uninstall command, as in the example below: ```shell pip uninstall Lyftrondata_Mylibrary.whl ``` ### License Key The license key will be provided by the Lyftrondata team which will be used for driver connectivity validation. ```shell import Lyftrondata.MyConnector.lib.Lyftrondata_MyConnector_Connector as con lyft = con.Connect("My Lyftrondata license key") ``` ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/android/driver-framework). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # Querying Data This section provides information about the Lyftrondata connector query maker method and how to execute ANSI Sql queries ### Executing Query The [Lyftrondata](https://www.lyftrondata.com/) driver for [Android](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/android/driver-framework/None/README.md) provides query maker functionality for querying data. To execute SQL statements that return data, use the cursor object's execute method. Once a query is executed, the result set is fetched from the API. This result set is converted into the relational format and returned which can then be printed out. ```shell import Lyftrondata.MyConnector.lib.Lyftrondata_MyConnector_Connector as con lyft = con.Connect("My Lyftrondata license key") init = lyft.initialise(username="my username",password="my password") df = lyft.execute_query("Select * from my table") print(df) //my pandas dataframe ``` ### Querying with where clause We can filter our data directly from the API by providing a where clause for the table. ```shell import Lyftrondata.MyConnector.lib.Lyftrondata_MyConnector_Connector as con lyft = con.Connect("My Lyftrondata license key") init = lyft.initialise(username="my username",password="my password") df = lyft.execute_query("Select * from my table where id=3") print(df) //my pandas dataframe ``` ### Querying Sys & Data Tables The connector possesses system table definition that provides information about the connector framework metadata, and data tables that are used to discover the connector business information in the \[ERD Data Model]\(../../../Sales Analytics/android/data-model/erd.md). ```shell import Lyftrondata.MyConnector.lib.Lyftrondata_MyConnector_Connector as con lyft = con.Connect("My Lyftrondata license key") init = lyft.initialise(username="my username",password="my password") df = lyft.execute_query("Select * from my sys.tables") print(df) //my pandas dataframe ``` ### Querying Sys Views The connector possesses views definition that provides information about how these views are used to discover the connector business information in the \[ERD Data Model]\(../../../Sales Analytics/android/data-model/erd.md). ```shell import Lyftrondata.MyConnector.lib.Lyftrondata_MyConnector_Connector as con lyft = con.Connect("My Lyftrondata license key") init = lyft.initialise(username="my username",password="my password") df = lyft.execute_query("Select * from my sys.views") print(df) //my pandas dataframe ``` ### Usage Logging You will simply need to set two connection properties to begin capturing provider logging. * For the usage logging you have to execute a query "select \* from sys.usage", which will return all the usage of the connector from the beginning. * It shows how much time left, time spent and total allotted time of the connector. You can also access the timestamp.txt from the current driver directory which contains information, such as when authentication is performed or queries are executed. The specified file will be created by the driver in your working directory. ```shell import Lyftrondata.MyConnector.lib.Lyftrondata_MyConnector_Connector as con lyft = con.Connect("My Lyftrondata license key") init = lyft.initialise(username="my username",password="my password") df = lyft.execute_query("Select * from my sys.usage") print(df) //my pandas dataframe ``` ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/android/driver-framework). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # SQL Standard This section discusses the SQL syntax for the Lyftrondata driver. Our driver adheres to ANSI standards, and all of our Python drivers adhere to the Sql Alchemy framework. ### Select Statements The [Lyftrondata](https://www.lyftrondata.com/) driver for [Android](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/android/driver-framework/None/README.md) provides ANSI SQL standard support. A SELECT statement can consist of the following basic clauses. * SELECT * INTO * FROM * JOIN * WHERE * GROUP BY * HAVING * UNION * ORDER BY * LIMIT * PAGESIZE LIMIT ### SELECT Syntax The following syntax diagram outlines the syntax supported by the SQL engine of the provider: {% code overflow="wrap" %} ```html SELECT { [ TOPtable(tablename)
parameter(schemaname) from\_page(start page number) to\_page (end page number)
columName(name of column)
columnValue(column value)
limit(rows limit)
| This method is use to fetch data from API | | execute\_query | tuple | string | This method is use to execute query | | get\_schema\_list | tuple | ConnectorObj | This method is use to get the schema list | | get\_schema\_objects | tuple | ConnectorObj schema | This method is use to get the schema object details | | get\_object\_columns | tuple |ConnectorObj schema
list
number\_of\_page
| This method is use to get the object columns detail | | | | | | ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/android/driver-framework). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # System Tables This page contains information about the Lyftrondata system tables. The following tables can be accessed via query maker, as shown in the example above. ### System Tables Information The [Lyftrondata](https://www.lyftrondata.com/) driver for [Android](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/android/driver-framework/None/README.md) provides information about the framework system tables. You can query the system tables with this syntax: Select \* from sys. | Table Name | Column Type | Query | Purpose | | ---------------- | ----------- | ------------------------------- | --------------------------------------------- | | sys | String | Select \* from sys | To get the system table information | | logs | String | Select \* from logs | To get the logs table information | | constraint | String | Select \* from constraints | To get the constraints table information | | methods | String | Select \* from methods | To get the methods table information | | delta | String | Select \* from delta | To get the delta table information | | usage | String | Select \* from usage | To get the usage table information | | version | String | Select \* from version | To get the version table information | | license | String | Select \* from license | To get the license table information | | connectionstring | String | Select \* from connectionstring | To get the connectionstring table information | ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/android/driver-framework). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # Babelforce This page contains the setup guide and reference information for the Babelforce source connector. ### Overview The [Lyftrondata](https://www.lyftrondata.com/) integration for [Babelforce](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/babelforce/None/README.md) provides the most natural way to access data while requiring no engineering. ### Key Features * Comprehensive incremental load mechanism. * Data from Babelforce is available in real-time. * ANSI SQL is fully supported to query data with ease. * Ready to query Babelforce relational schema model. ### Setup Guide To connect to your destination without engineering, follow our step-by-step [Lyftrondata](https://www.lyftrondata.com/) [Babelforce](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/babelforce/None/README.md) setup guide. * [ ] [Prerequisite](/sales-analytics/readme/babelforce/prerequisite) * [ ] [Connection Steps](/sales-analytics/readme/babelforce/connection-steps) * [ ] [Data Model](/sales-analytics/readme/babelforce/data-model/erd) * [ ] [Driver Framework](/sales-analytics/readme/babelforce/driver-framework) ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/README.md). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # Connection Steps This section explains how to connect Lyftrondata to Babelforce. ### Establishing a connection [Lyftrondata](https://www.lyftrondata.com) offers following methods connecting to [Babelforce](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/babelforce/None/README.md). To establish your connection, use the connection strings described below. ### PersonalToken | Key | Value | Field | | --------------- | ------------------- | -------- | | personal\_token | Your Personal Token | Required | Follow the steps below to establish a basic connection ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/babelforce). ### Questions? We're always happy to help with any other questions you might have! [Set up a meeting with our experts](https://www.lyftrondata.com/book-a-meeting/). # Destinations This section contains information about the destinations that Babelforce supports. ### Supported Destinations The [Lyftrondata](https://www.lyftrondata.com/) driver of [Babelforce](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/babelforce/None/README.md) provides support for the below destinations for instant analytics with no engineering in just 4 simple steps. ### Snowflake Load: ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/babelforce). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # Prerequisite This section describes the prerequisites for connecting Babelforce to Lyftrondata. To complete the prerequisites, the user must have admin access to Babelforce. ### Setup Instructions Follow the steps below to create an API Credentials for the [Babelforce](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/babelforce/None/README.md) driver setup with [Lyftrondata](https://www.lyftrondata.com) ### Video Instruction ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/babelforce). ### Questions? We're always happy to help with any other questions you might have! [Set up a meeting with our experts](https://www.lyftrondata.com/book-a-meeting/). # Data Model This section describes the details of Babelforce ERD, Tables, and Views. ### Index The [Lyftrondata](https://www.lyftrondata.com/) driver for [Babelforce](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/babelforce/data-model/None/README.md) provides a data model that enables you to better understand the source platform. * [ ] [ERD](/sales-analytics/readme/babelforce/data-model/erd) * [ ] [Tables](/sales-analytics/readme/babelforce/data-model/tables) * [ ] [Views](/sales-analytics/readme/babelforce/data-model/views) ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/babelforce). ### Questions? We're always happy to help with any other questions you might have! [Set up a meeting with our experts](https://www.lyftrondata.com/book-a-meeting/). # ERD This section contains detailed information about the data dictionary, and entity relationships in the source system. ### Entity Relationship Diagram The [Lyftrondata](https://www.lyftrondata.com/) driver for [Babelforce](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/babelforce/data-model/None/README.md) provides detailed information about the entity relationships of data objects. ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/babelforce). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with one of our data experts.](https://www.lyftrondata.com/book-a-meeting/) # Tables This section contain information about babelforce connector tables information ### Data Dictionary The [Lyftrondata](https://www.lyftrondata.com/) driver for [Babelforce](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/babelforce/data-model/None/README.md)[ ](https://www.lyftrondata.com/integration/babelforce/)provides a detailed data dictionary of the tables with data types and column names. ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/babelforce). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # Views This section contain information about babelforce connector views information ### Data Dictionary The [Lyftrondata](https://www.lyftrondata.com/) driver for [Babelforce](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/babelforce/data-model/None/README.md)[ ](https://www.lyftrondata.com/integration/babelforce/)provides a detailed data dictionary of the views with data types and column names. ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/babelforce). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # Driver Framework This page contains the setup guide and reference information for the Babelforce source connector. ### Overview The [Lyftrondata](https://www.lyftrondata.com/) integration for [Babelforce](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/babelforce/driver-framework/None/README.md) provides the most natural way to access data while requiring no engineering. ### Key Features * Comprehensive incremental load mechanism. * Data from Babelforce is available in real-time. * ANSI SQL is fully supported to query data with ease. * Ready to query Babelforce relational schema model. ### Setup Guide To connect to your destination without engineering, follow our step-by-step Lyftrondata Babelforce setup guide. * [ ] [Prerequisite](/sales-analytics/readme/babelforce/prerequisite) * [ ] [Connection Steps](/sales-analytics/readme/babelforce/connection-steps) * [ ] [Data Model](/sales-analytics/readme/babelforce/data-model/erd) * [ ] [Driver Framework](/sales-analytics/readme/babelforce/driver-framework) ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/babelforce/driver-framework). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # Connecting from Code This section provides information on how to connect the connector from the code. ### Working with the connector The [Lyftrondata](https://www.lyftrondata.com/) driver for [Babelforce](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/babelforce/driver-framework/None/README.md) provides simple connectivity steps from code. The primary functionality of the Lyftrondata Python Connector lies in querying, which interacts directly with the available services for your connector. However, many of these stored procedures rely on information stored in the provider's tables. These tables must be populated by the user and will contain all of the information that a certain user has on their connector account. The tables will rely on user data provided by connector on their endpoints. Once the needed input data is present, one can execute SELECT queries by running the query maker function of Lyftrondata\_Connector. ### Connecting from code See wheel \[installation]\(../../../Sales Analytics/babelforce/driver-framework/installation.md) for the prerequisite information you need to deploy the source connector. ```python import Lyftrondata.MyConnector.lib.Lyftrondata_MyConnector_Connector as con lyft = con.Connect("My Lyftrondata license key") init = lyft.initialise(username="my username",password="my password") ``` ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/babelforce/driver-framework). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # Connection String This section provides information about the driver supported connection string to connect with the API ### Steps The [Lyftrondata](https://www.lyftrondata.com/) driver for [Babelforce](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/babelforce/driver-framework/None/README.md) provides the connection string steps documented below. For more detailed information about driver connectivity, visit the [Connection Steps](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/erp/dynamics-365-business-central/connection-steps.md) section of this document. ```python import Lyftrondata.MyConnector.lib.Lyftrondata_MyConnector_Connector as con lyft = con.Connect("My Lyftrondata license key") init = lyft.initialise(username="my username",password="my password") df = lyft.execute_query("Select * from my sys.connectionstring") print(df) //my pandas dataframe ``` ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/babelforce/driver-framework). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # Installation This sections covers the step-step instruction about the Lyftrondata connector installation. It's must to have Python 3.9 as the default version for our drivers to work efficiently. ### Prerequisite The [Lyftrondata](https://www.lyftrondata.com) driver for [Babelforce](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/babelforce/driver-framework/None/README.md)) requires the below versions * [ ] Python 3.9 * [ ] Python 3 pip * [ ] Connector Wheel file * [ ] Valid license * [ ] Knowledge of Python programming * [ ] Knowledge of SQL ### Installation Steps To start your installation, you need to download the [wheel](https://pypi.org/project/wheel/) file. The downloaded archive contains several whl files, each of which corresponds to a specific combination of environmental factors. These factors include: * The operating system that the python connector is used in, whether it is Windows, Mac, or Linux. * The Architecture of the operating system, whether it is 32-bit or 64-bit. For Windows systems, this will correspond to the win32 or win\_amd64 wheels. For Linux, this will correspond to the linux\_i686 and linux\_x86\_64 wheels. * The version of Python is in use. The connectors are supported in Python 3.9 for Windows and Linux, and for Mac. * Once the appropriate whl file is identified, install the connector to your Python distribution with the "pip install" command via the command line. This will usually take the form of running the following commands in sequence. The wheel for Python 3.9 is used for the below example: #### Linux {% code title="Lyftrondata\_Linux\_Sdk" lineNumbers="true" %} ```shell sudo apt-get install python3.9 sudo apt-get install python3-pip python3 -m venv myvenv source venv/bin/activate pip install Lyftrondata_Mylibrary.whl ``` {% endcode %} #### Windows {% code title="Lyftrondata\_Win\_Sdk" lineNumbers="true" %} ```shell winget install -e --id Python.Python -v 3.9.0 python3 -m venv myvenv source venv/bin/activate pip install Lyftrondata_Mylibrary.whl ``` {% endcode %} **Mac** ```shell brew install python@3.9 python3 -m venv myvenv source venv/bin/activate pip install Lyftrondata_Mylibrary.whl ``` ### Validation You can confirm whether the connector is successfully installed by running the pip list command. If "Lyftrondata\_Mylibrary.whl" is present in the list output by the command, then the installation was successful. ```shell pip list ``` ### Uninstallation Should the connector need to be uninstalled for any reason, you can do so by running the pip uninstall command, as in the example below: ```shell pip uninstall Lyftrondata_Mylibrary.whl ``` ### License Key The license key will be provided by the Lyftrondata team which will be used for driver connectivity validation. ```shell import Lyftrondata.MyConnector.lib.Lyftrondata_MyConnector_Connector as con lyft = con.Connect("My Lyftrondata license key") ``` ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/babelforce/driver-framework). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # Querying Data This section provides information about the Lyftrondata connector query maker method and how to execute ANSI Sql queries ### Executing Query The [Lyftrondata](https://www.lyftrondata.com/) driver for [Babelforce](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/babelforce/driver-framework/None/README.md) provides query maker functionality for querying data. To execute SQL statements that return data, use the cursor object's execute method. Once a query is executed, the result set is fetched from the API. This result set is converted into the relational format and returned which can then be printed out. ```shell import Lyftrondata.MyConnector.lib.Lyftrondata_MyConnector_Connector as con lyft = con.Connect("My Lyftrondata license key") init = lyft.initialise(username="my username",password="my password") df = lyft.execute_query("Select * from my table") print(df) //my pandas dataframe ``` ### Querying with where clause We can filter our data directly from the API by providing a where clause for the table. ```shell import Lyftrondata.MyConnector.lib.Lyftrondata_MyConnector_Connector as con lyft = con.Connect("My Lyftrondata license key") init = lyft.initialise(username="my username",password="my password") df = lyft.execute_query("Select * from my table where id=3") print(df) //my pandas dataframe ``` ### Querying Sys & Data Tables The connector possesses system table definition that provides information about the connector framework metadata, and data tables that are used to discover the connector business information in the \[ERD Data Model]\(../../../Sales Analytics/babelforce/data-model/erd.md). ```shell import Lyftrondata.MyConnector.lib.Lyftrondata_MyConnector_Connector as con lyft = con.Connect("My Lyftrondata license key") init = lyft.initialise(username="my username",password="my password") df = lyft.execute_query("Select * from my sys.tables") print(df) //my pandas dataframe ``` ### Querying Sys Views The connector possesses views definition that provides information about how these views are used to discover the connector business information in the \[ERD Data Model]\(../../../Sales Analytics/babelforce/data-model/erd.md). ```shell import Lyftrondata.MyConnector.lib.Lyftrondata_MyConnector_Connector as con lyft = con.Connect("My Lyftrondata license key") init = lyft.initialise(username="my username",password="my password") df = lyft.execute_query("Select * from my sys.views") print(df) //my pandas dataframe ``` ### Usage Logging You will simply need to set two connection properties to begin capturing provider logging. * For the usage logging you have to execute a query "select \* from sys.usage", which will return all the usage of the connector from the beginning. * It shows how much time left, time spent and total allotted time of the connector. You can also access the timestamp.txt from the current driver directory which contains information, such as when authentication is performed or queries are executed. The specified file will be created by the driver in your working directory. ```shell import Lyftrondata.MyConnector.lib.Lyftrondata_MyConnector_Connector as con lyft = con.Connect("My Lyftrondata license key") init = lyft.initialise(username="my username",password="my password") df = lyft.execute_query("Select * from my sys.usage") print(df) //my pandas dataframe ``` ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/babelforce/driver-framework). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # SQL Standard This section discusses the SQL syntax for the Lyftrondata driver. Our driver adheres to ANSI standards, and all of our Python drivers adhere to the Sql Alchemy framework. ### Select Statements The [Lyftrondata](https://www.lyftrondata.com/) driver for [Babelforce](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/babelforce/driver-framework/None/README.md) provides ANSI SQL standard support. A SELECT statement can consist of the following basic clauses. * SELECT * INTO * FROM * JOIN * WHERE * GROUP BY * HAVING * UNION * ORDER BY * LIMIT * PAGESIZE LIMIT ### SELECT Syntax The following syntax diagram outlines the syntax supported by the SQL engine of the provider: {% code overflow="wrap" %} ```html SELECT { [ TOPtable(tablename)
parameter(schemaname) from\_page(start page number) to\_page (end page number)
columName(name of column)
columnValue(column value)
limit(rows limit)
| This method is use to fetch data from API | | execute\_query | tuple | string | This method is use to execute query | | get\_schema\_list | tuple | ConnectorObj | This method is use to get the schema list | | get\_schema\_objects | tuple | ConnectorObj schema | This method is use to get the schema object details | | get\_object\_columns | tuple |ConnectorObj schema
list
number\_of\_page
| This method is use to get the object columns detail | | | | | | ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/babelforce/driver-framework). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # System Tables This page contains information about the Lyftrondata system tables. The following tables can be accessed via query maker, as shown in the example above. ### System Tables Information The [Lyftrondata](https://www.lyftrondata.com/) driver for [Babelforce](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/babelforce/driver-framework/None/README.md) provides information about the framework system tables. You can query the system tables with this syntax: Select \* from sys. | Table Name | Column Type | Query | Purpose | | ---------------- | ----------- | ------------------------------- | --------------------------------------------- | | sys | String | Select \* from sys | To get the system table information | | logs | String | Select \* from logs | To get the logs table information | | constraint | String | Select \* from constraints | To get the constraints table information | | methods | String | Select \* from methods | To get the methods table information | | delta | String | Select \* from delta | To get the delta table information | | usage | String | Select \* from usage | To get the usage table information | | version | String | Select \* from version | To get the version table information | | license | String | Select \* from license | To get the license table information | | connectionstring | String | Select \* from connectionstring | To get the connectionstring table information | ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/babelforce/driver-framework). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # Brandwatch This page contains the setup guide and reference information for the Brandwatch source connector. ### Overview The [Lyftrondata](https://www.lyftrondata.com/) integration for [Brandwatch](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/brandwatch/None/README.md) provides the most natural way to access data while requiring no engineering. ### Key Features * Comprehensive incremental load mechanism. * Data from Brandwatch is available in real-time. * ANSI SQL is fully supported to query data with ease. * Ready to query Brandwatch relational schema model. ### Setup Guide To connect to your destination without engineering, follow our step-by-step [Lyftrondata](https://www.lyftrondata.com/) [Brandwatch](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/brandwatch/None/README.md) setup guide. * [ ] [Prerequisite](/sales-analytics/readme/brandwatch/prerequisite) * [ ] [Connection Steps](/sales-analytics/readme/brandwatch/connection-steps) * [ ] [Data Model](/sales-analytics/readme/brandwatch/data-model/erd) * [ ] [Driver Framework](/sales-analytics/readme/brandwatch/driver-framework) ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/README.md). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) # Connection Steps This section explains how to connect Lyftrondata to Brandwatch. ### Establishing a connection [Lyftrondata](https://www.lyftrondata.com) offers following methods connecting to [Brandwatch](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/brandwatch/None/README.md). To establish your connection, use the connection strings described below. ### PersonalToken | Key | Value | Field | | --------------- | ------------------- | -------- | | personal\_token | Your Personal Token | Required | Follow the steps below to establish a basic connection ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/brandwatch). ### Questions? We're always happy to help with any other questions you might have! [Set up a meeting with our experts](https://www.lyftrondata.com/book-a-meeting/). # Destinations This section contains information about the destinations that Brandwatch supports. ### Supported Destinations The [Lyftrondata](https://www.lyftrondata.com/) driver of [Brandwatch](https://github.com/Lyftrondata/GitBook/blob/SalesAnalytics/sales-analytics/brandwatch/None/README.md) provides support for the below destinations for instant analytics with no engineering in just 4 simple steps. ### Snowflake Load: ### Quickstart Steps Do you have questions about how to use the platform? Don't worry; we've got you covered. Simply follow the quickstart instructions [here](/sales-analytics/readme/brandwatch). ### Questions? We're always happy to answer any additional questions you may have! [Set up a meeting with our data experts.](https://www.lyftrondata.com/book-a-meeting/) --- [Next Page](https://docs.lyftrondata.com/sales-analytics/llms-full.txt/1)