C# ManagedEngine ServiceDesk Plus (Zoho) Connector
In this article you will learn how to integrate Using ManagedEngine ServiceDesk Plus (Zoho) Connector you will be able to connect, read, and write data from within C#. Follow the steps below to see how we would accomplish that. Driver mentioned in this article 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. |
See also
|
Create ODBC Data Source (DSN) based on ZappySys API Driver
To get data from ManagedEngineServiceDeskPlus(Zoho) using C# we first need to create a DSN (Data Source) which will access data from ManagedEngineServiceDeskPlus(Zoho). We will later be able to read data using C#. 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 "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:
ManagedEngineServiceDeskPlus(Zoho)DSNManagedEngine 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 Help..]
Steps to get 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:
ManagedEngineServiceDeskPlus(Zoho)DSNOAuth [OAuth]https://sdpondemand.manageengine.com/api/v3Required Parameters Optional Parameters 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.
Read data in C# from the DSN
-
Create a new Console project and use this code to read the data:
"ManagedEngineServiceDeskPlus(Zoho)DSN"; -
Press F5 to run the code and read the data:
-
Here is the code in text format:
using System; using System.Data.Odbc; namespace ConsoleApp { class Program { static void Main() { var dsn = "ManagedEngineServiceDeskPlus(Zoho)DSN"; using (var conn = new OdbcConnection(String.Format("DSN={0}", dsn))) { conn.Open(); var cmd = new OdbcCommand("SELECT * FROM Products", conn); //Increase the timeout duration from the default 30 seconds, which may be insufficient in certain scenarios cmd.CommandTimeout=600; // 600-Seconds var rdr = cmd.ExecuteReader(); while (rdr.Read()) { for (int i = 0; i < rdr.FieldCount; i++) { Console.Write("{0}\t", rdr[i]); } Console.WriteLine(); } } Console.ReadKey(); } } }
-
If you want to avoid being dependent on a DSN and creating multiple DSNs for each platform (x86, x64), then you can use a fully qualified connection string. Simply go to your DSN and copy the Connection String . Then in your C# code, pass the connection string as an argument when calling the OdbcConnection object's constructor, for example:
var connectionString = "DRIVER={ZappySys API Driver};ServiceUrl=https://yourservices.provider.com/api/xxxx....;AuthName=Http;"; using (var conn = new OdbcConnection(connectionString)) { // ... }
Please follow the instructions below to retrieve the connection string for the ZappySys driver.
Click on the Windows Start menu.
In the search bar, type ODBC and press Enter.
From the search results, choose ODBC Data Sources or ODBC Data Sources (32-bit) or a similar option depending on your system architecture and ODBC driver configuration.
- Choose your data source from the list, then click on the Configure button.
- After opening the Data Source UI, you should copy the connection string to a Notepad or text file for reference.
-
Click on Copy Connection String button.
When you click 'Copy Connection String,' you may encounter the following option:
Choose the third option All Settings to copy everything and click on OK button.
That's it connection string has been successfully copied.
How to Overcome the Long Connection String Issue
This issue is typically caused when the connection string includes a long RefreshToken attribute (i.e. RefreshToken=xxxxxxxxxxxx...xxx, especially if it's more than 1,000 characters).
A good solution is to supply the RefreshToken by a file. Simply copy and paste the RefreshToken into a text file and save it, and then pass that file path in the connection string instead of directly supplying the RefreshToken.
Here is an example of a connection string that can cause the issue:
var connectionString = "Driver={ZappySys API Driver};RefreshToken=xxxxxxxxxxxx...xxxxxxx;ServiceUrl=...;"; using (var conn = new OdbcConnection(connectionString)) { // ... }
Here is an example of a connection string that has resolved the issue by moving the RefreshToken attribute to the file c:\my_refresh_token.txt:
var connectionString = "Driver={ZappySys API Driver};RefreshTokenFile=c:\my_refresh_token.txt;ServiceUrl=...;"; using (connectionString) { // ... }
Insider Insights
While using ExecuteNonQuery make sure to use output=0.
Sometime Executing `cmd.ExecuteNonQuery` in C# didn't trigger the API call immediately specifically for `INSERT`, `UPDATE`, or `DELETE` statement, as it only initiates the call when the iterator is requested. When using ExecuteNonQuery(), it's primarily intended for SQL statements that don't return data, such as UPDATE, INSERT, or DELETE. If you're not seeing any changes made by the UPDATE statement, there could be several reasons for this.
One potential reason, as you've mentioned, is related to deferred execution. In some cases, the changes made by the UPDATE statement might not be visible immediately, especially if you're not requesting any output from the query. In such cases, explicitly setting Output = 0 can force the iterator to be called, ensuring that the changes are applied.
Here's an example of how you might modify your code to include this:
using System;
using System.Data.Odbc;
namespace ConsoleApp {
class Program {
static void Main() {
var dsn = "ManagedEngineServiceDeskPlus(Zoho)DSN";
using (var conn = new OdbcConnection(String.Format("DSN={0}", dsn)))
{
conn.Open();
//We're currently referring to the example with the Products table. Please substitute it with the table of your choice.
var cmd =new OdbcCommand("UPDATE Products SET ProductName='Chai' Where ProductID=1 WITH(Output=0)", conn);
//Increase the timeout duration from the default 30 seconds, which may be insufficient in certain scenarios
cmd.CommandTimeout=600; // 600-Seconds
// Execute the query
int rowsAffected = cmd.ExecuteNonQuery();
// Check the number of rows affected
if (rowsAffected > 0)
{
Console.WriteLine("Update successful.");
}
else
{
Console.WriteLine("No rows were updated.");
}
}
Console.ReadKey();
}
}
}
Create Custom Store 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 Store 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 Store Procedure and write the your desired store procedure and Save it and it will create the custom store 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 Store 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 store 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 store 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 store 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 store procedure and provide you the response.
Conclusion
In this article we discussed how to connect to ManagedEngine ServiceDesk Plus (Zoho) in C# and integrate data without any coding. Click here to Download ManagedEngine ServiceDesk Plus (Zoho) Connector for C# 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 ManagedEngine ServiceDesk Plus (Zoho) Connector for C#
Documentation
Actions supported by ManagedEngine ServiceDesk Plus (Zoho) Connector
ManagedEngine ServiceDesk Plus (Zoho) 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 |
---|
Parameter | Description |
---|---|
RequestId |
|
Parameter | Description |
---|---|
RequestId |
|
Parameter | Description |
---|---|
RequestId |
|
Parameter | Description |
---|---|
RequestId |
|
TaskId |
|
Parameter | Description |
---|---|
RequestId |
|
TaskId |
|
Parameter | Description |
---|---|
RequestId |
|
TaskId |
|
CommentId |
|
Parameter | Description |
---|---|
RequestId |
|
Parameter | Description |
---|---|
RequestId |
|
NoteId |
|
Parameter | Description |
---|---|
RequestId |
|
Parameter | Description |
---|---|
RequestId |
|
WorklogId |
|
Parameter | Description |
---|---|
RequestId |
|
TaskId |
|
Parameter | Description |
---|---|
RequestId |
|
TaskId |
|
WorklogId |
|
Parameter | Description |
---|---|
Url |
|
Body |
|
IsMultiPart |
|
Filter |
|
Headers |
|
ManagedEngine ServiceDesk Plus (Zoho) Connector Examples for C# 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.
List requests [Read more...]
This example shows how to list requests.
SELECT * FROM Requests
Read request details by ID [Read more...]
This example shows how to read extended information about a single request
SELECT * FROM Requests Where id=111112345
Delete request [Read more...]
This example shows how to delete a request by ID.
DELETE FROM Requests Where id=111112345
List request tasks [Read more...]
This example shows how to read all tasks for a single Request ID
SELECT * FROM get_Request_Tasks WITH (RequestId=111112345)
Read request task details [Read more...]
This example shows how to read request task details by single Request ID and Task ID
SELECT * FROM get_Request_Task_Details (RequestId=111112345, TaskId=222212345)
List request task comments [Read more...]
This example shows how to read all comment for specific task
SELECT * FROM get_Request_Task_Comments (RequestId=111112345, TaskId=222212345)
Read request task comment details [Read more...]
This example shows how to read a single comment details for a specific task
SELECT * FROM get_Request_Task_Comment_Details (RequestId=111112345, TaskId=222212345, CommentId=333312345)
List request notes [Read more...]
This example shows how to read all notes for a single Request ID
SELECT * FROM get_Request_Notes WITH (RequestId=111112345)
Read request note details [Read more...]
This example shows how to read request note details by single Request ID and Note ID
SELECT * FROM get_Request_Note_Details (RequestId=111112345, NoteId=222212345)
List request worklog [Read more...]
This example shows how to read all worklogs for a single Request ID
SELECT * FROM get_Request_Worklogs WITH (RequestId=111112345)
Read request worklog details [Read more...]
This example shows how to read request worklog details by single Request ID and Worklog ID
SELECT * FROM get_Request_Worklog_Details (RequestId=111112345, WorklogId=222212345)
List request task worklog [Read more...]
This example shows how to read all worklogs for a single Request Task ID
SELECT * FROM get_Request_Task_Worklogs WITH (RequestId=111112345, TaskId=22222345)
Read request task worklog details [Read more...]
This example shows how to read request task worklog details by single Request Task ID and Worklog ID
SELECT * FROM get_Request_Task_Worklog_Details (RequestId=111112345, TaskId=22222345, WorklogId=333312345)
Other App Integration scenarios for ManagedEngine ServiceDesk Plus (Zoho)
Other Connectors for C#
Download ManagedEngine ServiceDesk Plus (Zoho) Connector for C#
Documentation
How to connect ManagedEngine ServiceDesk Plus (Zoho) in C#?
How to get ManagedEngine ServiceDesk Plus (Zoho) data in C#?
How to read ManagedEngine ServiceDesk Plus (Zoho) data in C#?
How to load ManagedEngine ServiceDesk Plus (Zoho) data in C#?
How to import ManagedEngine ServiceDesk Plus (Zoho) data in C#?
How to pull ManagedEngine ServiceDesk Plus (Zoho) data in C#?
How to push data to ManagedEngine ServiceDesk Plus (Zoho) in C#?
How to write data to ManagedEngine ServiceDesk Plus (Zoho) in C#?
How to POST data to ManagedEngine ServiceDesk Plus (Zoho) in C#?
Call ManagedEngine ServiceDesk Plus (Zoho) API in C#
Consume ManagedEngine ServiceDesk Plus (Zoho) API in C#
ManagedEngine ServiceDesk Plus (Zoho) C# Automate
ManagedEngine ServiceDesk Plus (Zoho) C# Integration
Integration ManagedEngine ServiceDesk Plus (Zoho) in C#
Consume real-time ManagedEngine ServiceDesk Plus (Zoho) data in C#
Consume realtime ManagedEngine ServiceDesk Plus (Zoho) API data in C#
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 C#
Load ManagedEngine ServiceDesk Plus (Zoho) in C#
Load ManagedEngine ServiceDesk Plus (Zoho) data in C#
Read ManagedEngine ServiceDesk Plus (Zoho) data in C#
ManagedEngine ServiceDesk Plus (Zoho) API Call in C#