ManagedEngine ServiceDesk Plus (Zoho) Connector for PowerShellManagedEngine (Zoho) ServiceDesk Plus Connector can be used to integrate ServiceDesk Plus data in your App / BI Tools. You can read/write Requests, Tasks, Comments, Worklogs and many other items. In this article you will learn how to quickly and efficiently integrate ManagedEngine ServiceDesk Plus (Zoho) data in PowerShell without coding. We will use high-performance ManagedEngine ServiceDesk Plus (Zoho) Connector to easily connect to ManagedEngine ServiceDesk Plus (Zoho) and then access the data inside PowerShell. Let's follow the steps below to see how we can accomplish that! ManagedEngine ServiceDesk Plus (Zoho) Connector for PowerShell is based on ZappySys API Driver which is part of ODBC PowerPack. It is a collection of high-performance ODBC drivers that enable you to integrate data in SQL Server, SSIS, a programming language, or any other ODBC-compatible application. ODBC PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few. |
Connect to ManagedEngine ServiceDesk Plus (Zoho) in other apps
|
Create ODBC Data Source (DSN) based on ZappySys API Driver
Step-by-step instructions
To get data from ManagedEngine ServiceDesk Plus (Zoho) using PowerShell we first need to create a DSN (Data Source) which will access data from ManagedEngine ServiceDesk Plus (Zoho). We will later be able to read data using PowerShell. Perform these steps:
-
Download and install ODBC PowerPack.
-
Open ODBC Data Sources (x64):
-
Create a User data source (User DSN) based on ZappySys API Driver
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.
-
Create and use User DSN
if the client application is run under a User Account.
This is an ideal option
-
When the Configuration window appears give your data source a name if you haven't done that already, then select "ManagedEngine ServiceDesk Plus (Zoho)" from the list of Popular Connectors. If "ManagedEngine ServiceDesk Plus (Zoho)" 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:
ManagedengineServicedeskPlusZohoDSNManagedEngine ServiceDesk Plus (Zoho) -
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 ManageEngine ServiceDesk Plus API [API reference]
Steps how to get and use ManagedEngine ServiceDesk Plus (Zoho) 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:
ManagedengineServicedeskPlusZohoDSNManagedEngine ServiceDesk Plus (Zoho)OAuth [OAuth]https://sdpondemand.manageengine.com/api/v3Optional Parameters ClientId ClientSecret Permissions SDPOnDemand.requests.ALL AccountUrl https://accounts.zoho.com RedirectUrl https://zappysys.com/oauth RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 429 RetryCountMax 5 RetryMultiplyWaitTime True -
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 - ManagedEngine ServiceDesk Plus (Zoho)ManagedEngine (Zoho) ServiceDesk Plus Connector can be used to integrate ServiceDesk Plus data in your App / BI Tools. You can read/write Requests, Tasks, Comments, Worklogs and many other items.ManagedengineServicedeskPlusZohoDSN -
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 ManagedEngine ServiceDesk Plus (Zoho). Hit OK button to use this query in the next step.
SELECT * FROM Requests
Some parameters configured in this window will be passed to the ManagedEngine ServiceDesk Plus (Zoho) 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 datamuch faster . -
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 - ManagedEngine ServiceDesk Plus (Zoho)ManagedEngine (Zoho) ServiceDesk Plus Connector can be used to integrate ServiceDesk Plus data in your App / BI Tools. You can read/write Requests, Tasks, Comments, Worklogs and many other items.ManagedengineServicedeskPlusZohoDSNSELECT * FROM Requests
You can also access data quickly from the tables dropdown by selecting <Select table>.AWHERE
clause,LIMIT
keyword will be performed on the client side, meaning that thewhole result set will be retrieved from the ManagedEngine ServiceDesk Plus (Zoho) 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 ManagedEngine ServiceDesk Plus (Zoho) servers). -
Click OK to finish creating the data source.
Video Tutorial
Read ManagedEngine ServiceDesk Plus (Zoho) data in PowerShell
Sometimes, you need to quickly access and work with your ManagedEngine ServiceDesk Plus (Zoho) 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 ManagedEngine ServiceDesk Plus (Zoho) 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=ManagedengineServicedeskPlusZohoDSN"
For your convenience, here is the whole PowerShell script:
# Configure connection string and query $connectionString = "DSN=ManagedengineServicedeskPlusZohoDSN" $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 ManagedEngine ServiceDesk Plus (Zoho) fields $line = $format -f ($row["CustomerId"], $row["CompanyName"], $row["Country"], $row["Phone"]) Write-Host $line }
Access specific ManagedEngine ServiceDesk Plus (Zoho) 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 ManagedEngine ServiceDesk Plus (Zoho). -
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=ManagedengineServicedeskPlusZohoDSN"
$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 - ManagedEngine ServiceDesk Plus (Zoho)ManagedEngine (Zoho) ServiceDesk Plus Connector can be used to integrate ServiceDesk Plus data in your App / BI Tools. You can read/write Requests, Tasks, Comments, Worklogs and many other items.ManagedengineServicedeskPlusZohoDSN
-
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 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:
- Open your ODBC data source.
- Click Copy settings button to copy a full connection string (see the previous section on how to accomplish that).
- Then create a new file, let's say, in C:\temp\odbc-connection-string.txt.
- Continue by pasting the copied connection string into a newly created file and save it.
-
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
- Our troubles are over! Now you should be able to use this connection string in PowerShell with no problems.
Write ManagedEngine ServiceDesk Plus (Zoho) 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=ManagedengineServicedeskPlusZohoDSN"
$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.
Actions supported by ManagedEngine ServiceDesk Plus (Zoho) Connector
Learn how to perform common ManagedEngine ServiceDesk Plus (Zoho) actions directly in PowerShell with these how-to guides:
- Delete Request
- Get Asset Details
- Get Assets
- Get Change Details
- Get Change Note Details
- Get Change Notes
- Get Change Task Comment Details
- Get Change Task Comments
- Get Change Task Details
- Get Change Task Worklog Details
- Get Change Task Worklogs
- Get Change Tasks
- Get Change Worklog Details
- Get Change Worklogs
- Get Changes
- Get Contract Details
- Get Contracts
- Get Problem Details
- Get Problem Note Details
- Get Problem Notes
- Get Problem Task Comment Details
- Get Problem Task Comments
- Get Problem Task Details
- Get Problem Task Worklog Details
- Get Problem Task Worklogs
- Get Problem Tasks
- Get Problem Worklog Details
- Get Problem Worklogs
- Get Problems
- Get Project Details
- Get Project Members
- Get Project Milestone Tasks
- Get Project Milestones
- Get Project Note Details
- Get Project Notes
- Get Project Task Comment Details
- Get Project Task Comments
- Get Project Task Details
- Get Project Task Worklog Details
- Get Project Task Worklogs
- Get Project Tasks
- Get Project Worklog Details
- Get Project Worklogs
- Get Projects
- Get Purchase Order Details
- Get Purchase Orders
- Get Release Details
- Get Release Note Details
- Get Release Notes
- Get Release Task Comment Details
- Get Release Task Comments
- Get Release Task Details
- Get Release Task Worklog Details
- Get Release Task Worklogs
- Get Release Tasks
- Get Release Worklog Details
- Get Release Worklogs
- Get Releases
- Get Request Details
- Get Request Note Details
- Get Request Notes
- Get Request Task Comment Details
- Get Request Task Comments
- Get Request Task Details
- Get Request Task Worklog Details
- Get Request Task Worklogs
- Get Request Tasks
- Get Request Worklog Details
- Get Request Worklogs
- Get Requests
- Get Task Details
- Get Tasks
- Test Connection
- Generic Request
- Generic Request (Bulk Write)
Conclusion
In this article we showed you how to connect to ManagedEngine ServiceDesk Plus (Zoho) 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 ManagedEngine ServiceDesk Plus (Zoho), but to any Java application that supports JDBC (just use a different JDBC driver and configure it appropriately).
We encourage you to download ManagedEngine ServiceDesk Plus (Zoho) 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 ManagedEngine ServiceDesk Plus (Zoho) Connector for PowerShell Documentation
More integrations
Other connectors for PowerShell
Other application integration scenarios for ManagedEngine ServiceDesk Plus (Zoho)
How to connect ManagedEngine ServiceDesk Plus (Zoho) in PowerShell?
How to get ManagedEngine ServiceDesk Plus (Zoho) data in PowerShell?
How to read ManagedEngine ServiceDesk Plus (Zoho) data in PowerShell?
How to load ManagedEngine ServiceDesk Plus (Zoho) data in PowerShell?
How to import ManagedEngine ServiceDesk Plus (Zoho) data in PowerShell?
How to pull ManagedEngine ServiceDesk Plus (Zoho) data in PowerShell?
How to push data to ManagedEngine ServiceDesk Plus (Zoho) in PowerShell?
How to write data to ManagedEngine ServiceDesk Plus (Zoho) in PowerShell?
How to POST data to ManagedEngine ServiceDesk Plus (Zoho) in PowerShell?
Call ManagedEngine ServiceDesk Plus (Zoho) API in PowerShell
Consume ManagedEngine ServiceDesk Plus (Zoho) API in PowerShell
ManagedEngine ServiceDesk Plus (Zoho) PowerShell Automate
ManagedEngine ServiceDesk Plus (Zoho) PowerShell Integration
Integration ManagedEngine ServiceDesk Plus (Zoho) in PowerShell
Consume real-time ManagedEngine ServiceDesk Plus (Zoho) data in PowerShell
Consume real-time ManagedEngine ServiceDesk Plus (Zoho) API data in PowerShell
ManagedEngine ServiceDesk Plus (Zoho) ODBC Driver | ODBC Driver for ManagedEngine ServiceDesk Plus (Zoho) | ODBC ManagedEngine ServiceDesk Plus (Zoho) Driver | SSIS ManagedEngine ServiceDesk Plus (Zoho) Source | SSIS ManagedEngine ServiceDesk Plus (Zoho) Destination
Connect ManagedEngine ServiceDesk Plus (Zoho) in PowerShell
Load ManagedEngine ServiceDesk Plus (Zoho) in PowerShell
Load ManagedEngine ServiceDesk Plus (Zoho) data in PowerShell
Read ManagedEngine ServiceDesk Plus (Zoho) data in PowerShell
ManagedEngine ServiceDesk Plus (Zoho) API Call in PowerShell