Azure Data Factory (ADF) ManagedEngine ServiceDesk Plus (Zoho) Connector

In this article you will learn how to integrate ManagedEngine ServiceDesk Plus (Zoho) data to Azure Data Factory (ADF) without coding in just a few clicks (live / bi-directional connection to 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..

Using ManagedEngine ServiceDesk Plus (Zoho) Connector you will be able to connect, read, and write data from within Azure Data Factory (ADF). Follow the steps below to see how we would accomplish that.

Download  Help File  Buy 

Create ODBC Data Source (DSN) based on ZappySys API Driver

To get data from ManagedEngineServiceDeskPlus(Zoho) using Azure Data Factory (ADF) 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 Azure Data Factory (ADF). Perform these steps:

  1. Install ZappySys ODBC PowerPack.

  2. Open ODBC Data Sources (x64):
    Open ODBC Data Source

  3. Create a System Data Source (System DSN) based on ZappySys API Driver

    ZappySys API Driver
    Create new System DSN for ZappySys API Driver
    You 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. Furthermore, a User DSN may be created instead, but then you will not be able to use the connection from Windows Services (or any application running under a Windows System Account).
  4. 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)DSN
    ManagedEngine ServiceDesk Plus (Zoho)
    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 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)
    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:

    ManagedEngineServiceDeskPlus(Zoho)DSN
    ManagedEngine ServiceDesk Plus (Zoho)
    OAuth [OAuth]
    https://sdpondemand.manageengine.com/api/v3
    Required 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...
    ODBC DSN Oauth Connection Configuration

  6. 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:
    ODBC ZappySys Data Source Preview

  7. Click OK to finish creating the data source.

Read data in Azure Data Factory (ADF) from ODBC datasource (ManagedEngine ServiceDesk Plus (Zoho))

  1. To start press New button:

    Create new Self-Hosted integration runtime
  2. Select "Azure, Self-Hosted" option:

    Create new Self-Hosted integration runtime
  3. Select "Self-Hosted" option:

    Create new Self-Hosted integration runtime
  4. Set a name, we will use "OnPremisesRuntime":

    Set a name for IR
  5. Download and install Microsoft Integration Runtime.

  6. Launch Integration Runtime and copy/paste Authentication Key from Integration Runtime configuration in Azure Portal:

    Copy/paste Authentication Key
  7. After finishing registering the Integration Runtime node, you should see a similar view:

    Check Integration Runtime node status
  8. Go back to Azure Portal and finish adding new Integration Runtime. You should see it was successfully added:

    Integration Runtime status
  9. Go to Linked services section and create a new Linked service based on ODBC:

    Add new Linked service
  10. Select "ODBC" service:

    Add new ODBC service
  11. Configure new ODBC service. Use the same DSN name we used in the previous step and copy it to Connection string box:

    ManagedEngineServiceDeskPlus(Zoho)DSN
    DSN=ManagedEngineServiceDeskPlus(Zoho)DSN
    Configure new ODBC service
  12. For created ODBC service create ODBC-based dataset:

    Add new ODBC dataset
  13. Go to your pipeline and add Copy data connector into the flow. In Source section use OdbcDataset we created as a source dataset:

    Set source in Copy data
  14. Then go to Sink section and select a destination/sink dataset. In this example we use precreated AzureBlobStorageDataset which saves data into an Azure Blob:

    Set sink in Copy data
  15. Finally, run the pipeline and see data being transferred from OdbcDataset to your destination dataset:

    Run the flow

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

  1. Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
    ZappySys Driver - Add Store Procedure

  2. Enter the desired Procedure name and click on OK:
    ZappySys Driver - Add Store Procedure Name

  3. 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>';
    

    ZappySys Driver - Create Custom Store Procedure

  4. 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';

    ZappySys Driver - Execute Custom Store Procedure

  5. 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''')

    ZappySys Driver - Generate SQL Server Query

  6. Now go to SQL served and execute that query and it will make the API call using store procedure and provide you the response.
    ZappySys Driver - Generate SQL Server Query

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.

  1. Go to Custom Objects Tab and Click on Add button and Select Add Table:
    ZappySys Driver - Add Table

  2. Enter the desired Table name and click on OK:
    ZappySys Driver - Add Table Name

  3. And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.

  4. 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'

    ZappySys Driver - Create Custom Table

  5. 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"

    ZappySys Driver - Execute Custom Virtual Table Query

  6. 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''')

    ZappySys Driver - Generate SQL Server Query

  7. Now go to SQL served and execute that query and it will make the API call using store procedure and provide you the response.
    ZappySys Driver - Generate SQL Server Query

Conclusion

In this article we discussed how to connect to ManagedEngine ServiceDesk Plus (Zoho) in Azure Data Factory (ADF) and integrate data without any coding. Click here to Download ManagedEngine ServiceDesk Plus (Zoho) Connector for Azure Data Factory (ADF) 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 Azure Data Factory (ADF) 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.
 Get Requests
   [Read more...]
Parameter Description
 Get Request Details
   [Read more...]
Parameter Description
RequestId
 Delete Request
   [Read more...]
Parameter Description
RequestId
 Test Connection
   [Read more...]
 Get Request Tasks
   [Read more...]
Parameter Description
RequestId
 Get Request Task Details
   [Read more...]
Parameter Description
RequestId
TaskId
 Get Request Task Comments
   [Read more...]
Parameter Description
RequestId
TaskId
 Get Request Task Comment Details
   [Read more...]
Parameter Description
RequestId
TaskId
CommentId
 Get Request Notes
   [Read more...]
Parameter Description
RequestId
 Get Request Note Details
   [Read more...]
Parameter Description
RequestId
NoteId
 Get Request Worklogs
   [Read more...]
Parameter Description
RequestId
 Get Request Worklog Details
   [Read more...]
Parameter Description
RequestId
WorklogId
 Get Request Task Worklogs
   [Read more...]
Parameter Description
RequestId
TaskId
 Get Request Task Worklog Details
   [Read more...]
Parameter Description
RequestId
TaskId
WorklogId
 Generic Request
This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.    [Read more...]
Parameter Description
Url API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains
Body Request Body content goes here
IsMultiPart Check this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value) ==== Raw Upload (Content-Type: application/octet-stream) ===== To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip ) ==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) ===== To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored. If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type. See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored). file1=@c:\data\Myfile1.txt file2=@c:\data\Myfile2.json file2.Content-Type=application/json SomeField1=aaaaaaa SomeField1.Content-Type=text/plain SomeField2=12345 SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab SomeFieldStartingWithAtSign=\@MyTwitterHandle
Filter Enter filter to extract array from response. Example: $.rows[*] --OR-- $.customers[*].orders[*]. Check your response document and find out hierarchy you like to extract
Headers Headers for Request. To enter multiple headers use double pipe or new line after each {header-name}:{value} pair

ManagedEngine ServiceDesk Plus (Zoho) Connector Examples for Azure Data Factory (ADF) 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 Azure Data Factory (ADF)


Download ManagedEngine ServiceDesk Plus (Zoho) Connector for Azure Data Factory (ADF) Documentation 

  • How to connect ManagedEngine ServiceDesk Plus (Zoho) in Azure Data Factory (ADF)?

  • How to get ManagedEngine ServiceDesk Plus (Zoho) data in Azure Data Factory (ADF)?

  • How to read ManagedEngine ServiceDesk Plus (Zoho) data in Azure Data Factory (ADF)?

  • How to load ManagedEngine ServiceDesk Plus (Zoho) data in Azure Data Factory (ADF)?

  • How to import ManagedEngine ServiceDesk Plus (Zoho) data in Azure Data Factory (ADF)?

  • How to pull ManagedEngine ServiceDesk Plus (Zoho) data in Azure Data Factory (ADF)?

  • How to push data to ManagedEngine ServiceDesk Plus (Zoho) in Azure Data Factory (ADF)?

  • How to write data to ManagedEngine ServiceDesk Plus (Zoho) in Azure Data Factory (ADF)?

  • How to POST data to ManagedEngine ServiceDesk Plus (Zoho) in Azure Data Factory (ADF)?

  • Call ManagedEngine ServiceDesk Plus (Zoho) API in Azure Data Factory (ADF)

  • Consume ManagedEngine ServiceDesk Plus (Zoho) API in Azure Data Factory (ADF)

  • ManagedEngine ServiceDesk Plus (Zoho) Azure Data Factory (ADF) Automate

  • ManagedEngine ServiceDesk Plus (Zoho) Azure Data Factory (ADF) Integration

  • Integration ManagedEngine ServiceDesk Plus (Zoho) in Azure Data Factory (ADF)

  • Consume real-time ManagedEngine ServiceDesk Plus (Zoho) data in Azure Data Factory (ADF)

  • Consume realtime ManagedEngine ServiceDesk Plus (Zoho) API data in Azure Data Factory (ADF)

  • 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 Azure Data Factory (ADF)

  • Load ManagedEngine ServiceDesk Plus (Zoho) in Azure Data Factory (ADF)

  • Load ManagedEngine ServiceDesk Plus (Zoho) data in Azure Data Factory (ADF)

  • Read ManagedEngine ServiceDesk Plus (Zoho) data in Azure Data Factory (ADF)

  • ManagedEngine ServiceDesk Plus (Zoho) API Call in Azure Data Factory (ADF)