Zoho SalesIQ Connector for PowerShell
In this article you will learn how to integrate Using Zoho SalesIQ Connector you will be able to connect, read, and write data from within PowerShell. Follow the steps below to see how we would accomplish that. The driver mentioned above is part of ODBC PowerPack which is a collection of high-performance Drivers for various API data source (i.e. REST API, JSON, XML, CSV, Amazon S3 and many more). Using familiar SQL query language you can make live connections and read/write data from API sources or JSON / XML / CSV Files inside SQL Server (T-SQL) or your favorite Reporting (i.e. Power BI, Tableau, Qlik, SSRS, MicroStrategy, Excel, MS Access), ETL Tools (i.e. Informatica, Talend, Pentaho, SSIS). You can also call our drivers from programming languages such as JAVA, C#, Python, PowerShell etc. If you are new to ODBC and ZappySys ODBC PowerPack then check the following links to get started. |
Connect to Zoho SalesIQ in other apps
|
Create ODBC Data Source (DSN) based on ZappySys API Driver
Step-by-step instructions
To get data from Zoho SalesIQ using PowerShell we first need to create a DSN (Data Source) which will access data from Zoho SalesIQ. We will later be able to read data using PowerShell. Perform these steps:
-
Install ZappySys ODBC PowerPack.
-
Open ODBC Data Sources (x64):
-
Create a User Data Source (User DSN) based on ZappySys API Driver
ZappySys API DriverYou should create a System DSN (instead of a User DSN) if the client application is launched under a Windows System Account, e.g. as a Windows Service. If the client application is 32-bit (x86) running with a System DSN, use ODBC Data Sources (32-bit) instead of the 64-bit version. -
When the Configuration window appears give your data source a name if you haven't done that already, then select "Zoho SalesIQ" from the list of Popular Connectors. If "Zoho SalesIQ" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:
ZohoSalesIqDSNZoho SalesIQ -
Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.
OAuth Connection for Zoho CRM API [API Help..]
Steps to get Zoho SalesIQ Credentials : OAuth [OAuth]
To register custom App, perform the following steps (Detailed steps found in the help link at the end)- Go to Zoho API Console
- Click Add Client link
- Select Server-based Applications option
- Enter desired client name (Display purpose only)
- Enter some URL for Company homepage
- For Authorized Redirect URI enter https://zappysys.com/oauth (Or enter your own but we recommend using ZappySys one if possible). This URL must match on Zoho Connector UI.
- Click CREATE.
- Copy Client ID and Secret and paste on Zoho Connector UI.
Fill in all required parameters and set optional parameters if needed:
ZohoSalesIqDSNZoho SalesIQOAuth [OAuth]https://salesiq.zoho.com/api/v2/[$Compnay$]Required Parameters Optional Parameters Company Screen Name for URL (e.g. mycompany) Fill in the parameter... ClientId Fill in the parameter... ClientSecret Fill in the parameter... Permissions Fill in the parameter... AccountUrl Fill in the parameter... RedirectUrl Fill in the parameter... RetryMode Fill in the parameter... RetryStatusCodeList Fill in the parameter... RetryCountMax Fill in the parameter... RetryMultiplyWaitTime Fill in the parameter... -
Once the data source has been configured, you can preview data. Select the Preview tab and use settings similar to the following to preview data:
-
Click OK to finish creating the data source.
Video instructions
Read Zoho SalesIQ data in PowerShell
Sometimes, you need to quickly access and work with your Zoho SalesIQ data in PowerShell. Whether you need a quick data overview or the complete dataset, this article will guide you through the process. Here are some common scenarios:
Viewing data in a terminal- Quickly peek at Zoho SalesIQ data
- Monitor data constantly in your console
- Export data to a CSV file so that it can be sliced and diced in Excel
- Export data to a JSON file so that it can ingested by other processes
- Export data to an HTML file for user-friendly view and easy sharing
- Create a schedule to make it an automatic process
- Store data internally for analysis or for further ETL processes
- Create a schedule to make it an automatic process
- Integrate data with other systems via external APIs
In this article, we will delve deeper into how to quickly view the data in PowerShell terminal and how to save it to a file. But let's stop talking and get started!
Reading individual fields
- Open your favorite PowerShell IDE (we are using Visual Studio Code).
-
Then simply follow these instructions:
"DSN=ZohoSalesIqDSN"
For your convenience, here is the whole PowerShell script:
# Configure connection string and query $connectionString = "DSN=ZohoSalesIqDSN" $query = "SELECT * FROM Customers" # Instantiate OdbcDataAdapter and DataTable $adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString) $table = New-Object System.Data.DataTable # Fill the table with data $adapter.Fill($table) # Since we know we will be reading just 4 columns, let's define format for those 4 columns, each separated by a tab $format = "{0}`t{1}`t{2}`t{3}" # Display data in the console foreach ($row in $table.Rows) { # Construct line based on the format and individual Zoho SalesIQ fields $line = $format -f ($row["CustomerId"], $row["CompanyName"], $row["Country"], $row["Phone"]) Write-Host $line }
Access specific Zoho SalesIQ table field using this code snippet:
You will find more info on how to manipulate$field = $row["ColumnName"]
DataTable.Rows
property in Microsoft .NET reference.For demonstration purposes we are using sample tables which may not be available in Zoho SalesIQ. -
To read values in a console, save the script to a file and then execute this command inside PowerShell terminal:
You can also use even a simpler command inside the terminal, e.g.:
. 'C:\Users\john\Documents\dsn.ps1'
Retrieving all fields
However, there might be case, when you want to retrieve all columns of a query. Here is how you do it:
Again, for your convenience, here is the whole PowerShell script:
# Configure connection string and query
$connectionString = "DSN=ZohoSalesIqDSN"
$query = "SELECT CustomerId, CompanyName, Country, Phone FROM Customers"
# Instantiate OdbcDataAdapter and DataTable
$adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString)
$table = New-Object System.Data.DataTable
# Fill the table with data
$adapter.Fill($table)
# Display data in the console
foreach ($row in $table.Rows) {
$line = ""
foreach ($column in $table.Columns) {
$value = $row[$column.ColumnName]
# Let's handle NULL values
if ($value -is [DBNull])
{
$value = "(NULL)"
}
$line += $value + "`t"
}
Write-Host $line
}
LIMIT
keyword in the query, e.g.:
SELECT * FROM Customers LIMIT 10
Using a full ODBC connection string
In the previous steps we used a very short format of ODBC connection string - a DSN. Yet sometimes you don't want a dependency on an ODBC data source (and an extra step). In those times, you can define a full connection string and skip creating an ODBC data source entirely. Let's see below how to accomplish that in the below steps:
-
Open ODBC data source configuration and click Copy settings:
ZappySys API Driver - Zoho SalesIQZoho SalesIQ Connector can be used to integrate Zoho SalesIQ API in your App / BI Tools. You can exchange data on Chats, Visits and more.ZohoSalesIqDSN
- The window opens, telling us the connection string was successfully copied to the clipboard:
- Then just paste the connection string into your script:
- You are good to go! The script will execute the same way as using a DSN.
Have in mind that using a full connection string has length limitations.
Proceed to the next step to find out the details.
Limitations of using a full connection string
Despite using a full ODBC connection string may be very convenient it comes with a limitation: it's length is limited to 1024 symbols. It usually happens when API provider generates a very long Refresh Token when OAuth is at play. If it happens you use such API, you may get this error:
"Connection string exceeds maximum allowed length of 1024"
But there is a solution to this by storing the Refresh Token in a file instead of directly in ODBC connection string. Follow the steps below to achieve this.
- Open your ODBC data source
-
Hit Advanced tab and enter a file path:
ZappySys API Driver - Zoho SalesIQZoho SalesIQ Connector can be used to integrate Zoho SalesIQ API in your App / BI Tools. You can exchange data on Chats, Visits and more.ZohoSalesIqDSNIf you cannot find the Advanced tab, try looking for Click to Configure link in Properties tab, under URL text box. Click it, and then configure the file path in OAuth Grant Options tab.
- Then click Copy settings button to copy a full connection string and paste it into your script.
- Proceed by pasting the connection string into your C# code as an argument when calling the OdbcConnection object's constructor.
- Before using it we still have to shorten it manually like this:
- Our troubles are over, now you should be able to execute the script with no problems.
Write Zoho SalesIQ data to a file in PowerShell
Save data to a CSV file
Export data to a CSV file so that it can be sliced and diced in Excel:
# Configure connection string and query
$connectionString = "DSN=ZohoSalesIqDSN"
$query = "SELECT * FROM Customers"
# Instantiate OdbcDataAdapter and DataTable
$adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString)
$table = New-Object System.Data.DataTable
# Fill the table with data
$adapter.Fill($table)
# Export table data to a file
$table | ConvertTo-Csv -NoTypeInformation -Delimiter "`t" | Out-File "C:\Users\john\saved-data.csv" -Force
Save data to a JSON file
Export data to a JSON file so that it can ingested by other processes (use the above script, but change this part):
# Export table data to a file
$table | ConvertTo-Json | Out-File "C:\Users\john\saved-data.json" -Force
Save data to an HTML file
Export data to an HTML file for user-friendly view and easy sharing (use the above script, but change this part):
# Export table data to a file
$table | ConvertTo-Html | Out-File "C:\Users\john\saved-data.html" -Force
ConvertTo-Csv
, ConvertTo-Json
, and ConvertTo-Html
for other data manipulation scenarios.
Advanced topics
Create Custom Stored Procedure in ZappySys Driver
You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.
Steps to create Custom Stored Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
-
Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
-
Enter the desired Procedure name and click on OK:
-
Select the created Stored Procedure and write the your desired stored procedure and Save it and it will create the custom stored procedure in the ZappySys Driver:
Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
CREATE PROCEDURE [usp_get_orders] @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>' AS SELECT * FROM Orders where OrderDate >= '<@fromdate>';
-
That's it now go to Preview Tab and Execute your Stored Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:
Exec usp_get_orders '1996-01-01';
-
Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC usp_get_orders @fromdate=''1996-07-30''')
-
Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
Create Custom Virtual Table in ZappySys Driver
ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.
If you're dealing with Microsoft Access and need to import data from an SQL query, it's important to note that Access doesn't allow direct import of SQL queries. Instead, you can create custom objects (Virtual Tables) to handle the import process.
Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.
-
Go to Custom Objects Tab and Click on Add button and Select Add Table:
-
Enter the desired Table name and click on OK:
-
And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.
-
Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here
SELECT "ShipCountry", "OrderID", "CustomerID", "EmployeeID", "OrderDate", "RequiredDate", "ShippedDate", "ShipVia", "Freight", "ShipName", "ShipAddress", "ShipCity", "ShipRegion", "ShipPostalCode" FROM "Orders" Where "ShipCountry"='USA'
-
That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:
SELECT * FROM "vt__usa_orders_only"
-
Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')
-
Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
Actions supported by Zoho SalesIQ Connector
Zoho SalesIQ Connector support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.Parameter | Description | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Ratings |
|
||||||||||||||||||||||||||||||||||
OperatorIds |
|
||||||||||||||||||||||||||||||||||
DepartmentIds |
|
||||||||||||||||||||||||||||||||||
AppIds |
|
||||||||||||||||||||||||||||||||||
StartTime |
|
||||||||||||||||||||||||||||||||||
EndTime |
|
||||||||||||||||||||||||||||||||||
TimezoneOffset |
|
||||||||||||||||||||||||||||||||||
VisitorEmail |
|
Parameter | Description | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status |
|
||||||||||||||||||||||||||||||||||
OperatorIds |
|
||||||||||||||||||||||||||||||||||
DepartmentId |
|
||||||||||||||||||||||||||||||||||
AppId |
|
||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||
StartTime |
|
||||||||||||||||||||||||||||||||||
EndTime |
|
||||||||||||||||||||||||||||||||||
VisitorType |
|
||||||||||||||||||||||||||||||||||
UpdatedTimeStart |
|
||||||||||||||||||||||||||||||||||
UpdatedTimeEnd |
|
||||||||||||||||||||||||||||||||||
SortBy |
|
Parameter | Description | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
LastSyncTime |
|
Parameter | Description | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
LastSyncTime |
|
Parameter | Description |
---|---|
Url |
|
Body |
|
IsMultiPart |
|
Filter |
|
Headers |
|
Zoho SalesIQ Connector Examples for PowerShell Connection
This page offers a collection of SQL examples designed for seamless integration with the ZappySys API ODBC Driver under ODBC Data Source (36/64) or ZappySys Data Gateway, enhancing your ability to connect and interact with Prebuilt Connectors effectively.
Get Departments [Read more...]
List all departments
SELECT * FROM Departments
Get Operators [Read more...]
List all operators
SELECT * FROM Operators
Get Feedbacks (i.e. ratings) [Read more...]
List all feedbacks (ratings)
SELECT * FROM Feedbacks
Get Conversations (i.e. chats) [Read more...]
List all conversations (chats)
SELECT * FROM Conversations
Get Total Feedbacks by Rating Type and Operator for Last Year [Read more...]
Count Feedbacks by Rating Type and Operator for Last Year.
SELECT
OwnerEmail,
OwnerId,
RatingString,
COUNT(Id) Total
FROM Conversations
GROUP BY OwnerEmail, OwnerId, RatingString
Order BY OwnerEmail,RatingString
WITH(
--OperatorIds='81565000003048017,81565000002408043,81565000013131025' --You can supply Operator Ids to filter result for those Operators only
StartTime='yearstart-1y'
, EndTime='yearstart-1d'
)
Get Feedbacks (more than 99 rows) [Read more...]
Get Feedbacks (more than 99 rows). Pagination is not supported so this example shows how to workaround this issue to fetch more rows (assuming each month has less than 99 rows).
SELECT * into #t1 FROM Feedbacks WITH(OperatorId='81565000003048017', StartTime='2023-01-01', EndTime='2023-02-01');
SELECT * into #t2 FROM Feedbacks WITH(OperatorId='81565000003048017', StartTime='2023-02-01', EndTime='2023-03-01');
SELECT * into #t3 FROM Feedbacks WITH(OperatorId='81565000003048017', StartTime='2023-03-01', EndTime='2023-04-01');
SELECT * into #t4 FROM Feedbacks WITH(OperatorId='81565000003048017', StartTime='2023-04-01', EndTime='2023-05-01');
SELECT * into #t5 FROM Feedbacks WITH(OperatorId='81565000003048017', StartTime='2023-05-01', EndTime='2023-06-01');
SELECT * into #t6 FROM Feedbacks WITH(OperatorId='81565000003048017', StartTime='2023-06-01', EndTime='2023-07-01');
SELECT * into #t7 FROM Feedbacks WITH(OperatorId='81565000003048017', StartTime='2023-07-01', EndTime='2023-08-01');
SELECT * into #t8 FROM Feedbacks WITH(OperatorId='81565000003048017', StartTime='2023-08-01', EndTime='2023-09-01');
SELECT * into #t9 FROM Feedbacks WITH(OperatorId='81565000003048017', StartTime='2023-09-01', EndTime='2023-10-01');
SELECT * into #t10 FROM Feedbacks WITH(OperatorId='81565000003048017', StartTime='2023-10-01', EndTime='2023-11-01');
SELECT * into #t11 FROM Feedbacks WITH(OperatorId='81565000003048017', StartTime='2023-11-01', EndTime='2023-12-01');
SELECT * into #t12 FROM Feedbacks WITH(OperatorId='81565000003048017', StartTime='2023-12-01', EndTime='2024-01-01');
select * from #t1 UNION
select * from #t2 UNION
select * from #t3 UNION
select * from #t4 UNION
select * from #t5 UNION
select * from #t6 UNION
select * from #t7 UNION
select * from #t8 UNION
select * from #t9 UNION
select * from #t10 UNION
select * from #t11 UNION
select * from #t12;
Conclusion
In this article we discussed how to connect to Zoho SalesIQ in PowerShell and integrate data without any coding. Click here to Download Zoho SalesIQ Connector for PowerShell and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).
Download Zoho SalesIQ Connector for PowerShell
Documentation
More integrations
Other application integration scenarios for Zoho SalesIQ
Other connectors for PowerShell
Download Zoho SalesIQ Connector for PowerShell
Documentation
How to connect Zoho SalesIQ in PowerShell?
How to get Zoho SalesIQ data in PowerShell?
How to read Zoho SalesIQ data in PowerShell?
How to load Zoho SalesIQ data in PowerShell?
How to import Zoho SalesIQ data in PowerShell?
How to pull Zoho SalesIQ data in PowerShell?
How to push data to Zoho SalesIQ in PowerShell?
How to write data to Zoho SalesIQ in PowerShell?
How to POST data to Zoho SalesIQ in PowerShell?
Call Zoho SalesIQ API in PowerShell
Consume Zoho SalesIQ API in PowerShell
Zoho SalesIQ PowerShell Automate
Zoho SalesIQ PowerShell Integration
Integration Zoho SalesIQ in PowerShell
Consume real-time Zoho SalesIQ data in PowerShell
Consume real-time Zoho SalesIQ API data in PowerShell
Zoho SalesIQ ODBC Driver | ODBC Driver for Zoho SalesIQ | ODBC Zoho SalesIQ Driver | SSIS Zoho SalesIQ Source | SSIS Zoho SalesIQ Destination
Connect Zoho SalesIQ in PowerShell
Load Zoho SalesIQ in PowerShell
Load Zoho SalesIQ data in PowerShell
Read Zoho SalesIQ data in PowerShell
Zoho SalesIQ API Call in PowerShell