Zoho SalesIQ Connector for PowerShell

Zoho SalesIQ Connector can be used to integrate Zoho SalesIQ API in your App / BI Tools. You can exchange data on Chats, Visits and more.

In this article you will learn how to quickly and efficiently integrate Zoho SalesIQ data in PowerShell without coding. We will use high-performance Zoho SalesIQ Connector to easily connect to Zoho SalesIQ and then access the data inside PowerShell.

Let's follow the steps below to see how we can accomplish that!

Download Documentation

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:

  1. Download and install ODBC PowerPack.

  2. Open ODBC Data Sources (x64):

    Open ODBC Data Source
  3. Create a User data source (User DSN) based on ZappySys API Driver

    ZappySys API Driver
    Create new User DSN for ZappySys API Driver
    • Create and use User DSN if the client application is run under a User Account. This is an ideal option in design-time, when developing a solution, e.g. in Visual Studio 2019. Use it for both type of applications - 64-bit and 32-bit.
    • Create and use System DSN if the client application is launched under a System Account, e.g. as a Windows Service. Usually, this is an ideal option to use in a production environment. Use ODBC Data Source Administrator (32-bit), instead of 64-bit version, if Windows Service is a 32-bit application.
  4. 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:

    ZohoSalesiqDSN
    Zoho SalesIQ
    ODBC DSN Template Selection
  5. 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 reference]

    Steps how to get and use Zoho SalesIQ credentials : OAuth [OAuth]
    To register custom App, perform the following steps (Detailed steps found in the help link at the end)
    1. Go to Zoho API Console
    2. Click Add Client link
    3. Select Server-based Applications option
    4. Enter desired client name (Display purpose only)
    5. Enter some URL for Company homepage
    6. 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.
    7. Click CREATE.
    8. Copy Client ID and Secret and paste on Zoho Connector UI.

    Fill in all required parameters and set optional parameters if needed:

    ZohoSalesiqDSN
    Zoho SalesIQ
    OAuth [OAuth]
    https://salesiq.zoho.com/api/v2/[$Compnay$]
    Optional Parameters
    Company Screen Name for URL (e.g. mycompany)
    ClientId
    ClientSecret
    Permissions SalesIQ.operators.READ SalesIQ.conversations.READ SalesIQ.feedbacks.READ SalesIQ.departments.READ
    AccountUrl https://accounts.zoho.com
    RedirectUrl https://zappysys.com/oauth
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ODBC DSN Oauth Connection Configuration

  6. Once the data source connection has been configured, it's time to configure the SQL query. Select the Preview tab and then click Query Builder button to configure the SQL query:

    ZappySys API Driver - Zoho SalesIQ
    Zoho 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
    Open Query Builder in API ODBC Driver to read and write data to REST API
  7. Start by selecting the Table or Endpoint you are interested in and then configure the parameters. This will generate a query that we will use in PowerShell to retrieve data from Zoho SalesIQ. Hit OK button to use this query in the next step.

    SELECT * FROM Departments
    Configure table/endpoint parameters in ODBC data source based on API Driver
    Some parameters configured in this window will be passed to the Zoho SalesIQ API, e.g. filtering parameters. It means that filtering will be done on the server side (instead of the client side), enabling you to get only the meaningful data much faster.
  8. Now hit Preview Data button to preview the data using the generated SQL query. If you are satisfied with the result, use this query in PowerShell:

    ZappySys API Driver - Zoho SalesIQ
    Zoho 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
    SELECT * FROM Departments
    API ODBC Driver-based data source data preview
    You can also access data quickly from the tables dropdown by selecting <Select table>.
    A WHERE clause, LIMIT keyword will be performed on the client side, meaning that the whole result set will be retrieved from the Zoho SalesIQ API first, and only then the filtering will be applied to the data. If possible, it is recommended to use parameters in Query Builder to filter the data on the server side (in Zoho SalesIQ servers).
  9. Click OK to finish creating the data source.

Video Tutorial

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
Saving data to a file
  • 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
Saving data to a database
  • Store data internally for analysis or for further ETL processes
  • Create a schedule to make it an automatic process
Sending data to another API
  • 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

  1. Open your favorite PowerShell IDE (we are using Visual Studio Code).
  2. Then simply follow these instructions:
    "DSN=ZohoSalesiqDSN"
    Read API data with PowerShell using ODBC DSN in Visual Code

    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:
    $field = $row["ColumnName"]
    You will find more info on how to manipulate DataTable.Rows property in Microsoft .NET reference.
    For demonstration purposes we are using sample tables which may not be available in Zoho SalesIQ.
  3. To read values in a console, save the script to a file and then execute this command inside PowerShell terminal: Read API data in PowerShell using ODBC DSN
    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:

"DSN=ZohoSalesiqDSN"
Read all API columns from ODBC data source in PowerShell

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
}
You can limit the numbers of lines to retrieve by using a 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:

  1. Open ODBC data source configuration and click Copy settings:
    ZappySys API Driver - Configuration [Version: 2.0.1.10418]
    ZappySys API Driver - Zoho SalesIQ
    Zoho 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
    Copy connection string for ODBC application
  2. The window opens, telling us the connection string was successfully copied to the clipboard: Successful connection string copying for ODBC application
  3. Then just paste the connection string into your script: Paste ODBC connection string in PowerShell to read API data
  4. You are good to go! The script will execute the same way as using a DSN.

Have in mind that 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 (or sometimes more). It usually happens when API provider generates a very long Refresh Token when OAuth is at play. If you are using such a long ODBC connection string, you may get this error:

"Connection string exceeds maximum allowed length of 1024"

But there is a solution to this by storing the full connection string in a file. Follow the steps below to achieve this:

  1. Open your ODBC data source.
  2. Click Copy settings button to copy a full connection string (see the previous section on how to accomplish that).
  3. Then create a new file, let's say, in C:\temp\odbc-connection-string.txt.
  4. Continue by pasting the copied connection string into a newly created file and save it.
  5. Finally, the last step! Just construct a shorter ODBC connection string using this format:
    DRIVER={ZappySys API Driver};SettingsFile=C:\temp\odbc-connection-string.txt
  6. Our troubles are over! Now you should be able to use this connection string in PowerShell with no problems.
This feature requires ODBC PowerPack v1.9.0 or later.

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
Check useful PowerShell cmdlets other than ConvertTo-Csv, ConvertTo-Json, and ConvertTo-Html for other data manipulation scenarios.

Actions supported by Zoho SalesIQ Connector

Learn how to perform common Zoho SalesIQ actions directly in PowerShell with these how-to guides:

Conclusion

In this article we showed you how to connect to Zoho SalesIQ in PowerShell and integrate data without any coding, saving you time and effort. It's worth noting that ZappySys API Driver allows you to connect not only to Zoho SalesIQ, but to any Java application that supports JDBC (just use a different JDBC driver and configure it appropriately).

We encourage you to download Zoho SalesIQ Connector for PowerShell and see how easy it is to use it for yourself or your team.

If you have any questions, feel free to contact ZappySys support team. You can also open a live chat immediately by clicking on the chat icon below.

Download Zoho SalesIQ Connector for PowerShell Documentation

More integrations

Other connectors for PowerShell

All
Big Data & NoSQL
Database
CRM & ERP
Marketing
Collaboration
Cloud Storage
Reporting
Commerce
API & Files

Other application integration scenarios for Zoho SalesIQ

All
Data Integration
Database
BI & Reporting
Productivity
Programming Languages
Automation & Scripting
ODBC applications

  • 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