ManagedEngine ServiceDesk Plus (Zoho) Connector for SSIS
In this article you will learn how to quickly and efficiently
integrate ManagedEngine ServiceDesk Plus (Zoho) data in SSIS 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 SSIS.
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.
Let's follow the steps below to see how we can accomplish that!
Download
Documentation
ManagedEngine ServiceDesk Plus (Zoho) Connector for SSIS is based on ZappySys API Connector Framework
which is a part of SSIS PowerPack.
It is a collection of high-performance SSIS connectors that enable you
to integrate data with virtually any data provider supported by SSIS, including SQL Server.
SSIS PowerPack supports various file formats, sources and destinations,
including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few
(if you are new to SSIS and SSIS PowerPack, find out more on how to use them).
|
Connect to ManagedEngine ServiceDesk Plus (Zoho) in other apps
|
Video Tutorial - Integrate ManagedEngine ServiceDesk Plus (Zoho) data in SSIS
This video covers following and more so watch carefully. After watching this video follow the steps described in this article.
- How to download / install required driver for ManagedEngine ServiceDesk Plus (Zoho) integration in SSIS
- How to configure connection for ManagedEngine ServiceDesk Plus (Zoho)
- Features about API Source (Authentication / Query Language / Examples / Driver UI)
- Using ManagedEngine ServiceDesk Plus (Zoho) Connection in SSIS
Prerequisites
Before we begin, make sure the following prerequisites are met:
-
SSIS designer installed.
Sometimes it is referred as BIDS or SSDT
(download it from Microsoft).
-
Basic knowledge of SSIS package development using
Microsoft SQL Server Integration Services.
-
SSIS PowerPack
is installed
(if you are new to SSIS PowerPack, then get started!).
Read data from ManagedEngine ServiceDesk Plus (Zoho) in SSIS (Export data)
In this section we will learn how to configure and use ManagedEngine ServiceDesk Plus (Zoho) Connector in API Source to extract data from ManagedEngine ServiceDesk Plus (Zoho).
-
Begin with opening Visual Studio and Create a New Project.
Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.
-
In the new SSIS project screen you will find the following:
- SSIS ToolBox on left side bar
- Solution Explorer and Property Window on right bar
- Control flow, data flow, event Handlers, Package Explorer in tab windows
- Connection Manager Window in the bottom
Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to
this help link.
-
Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.
-
From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:
-
Select New Connection to create a new connection:
-
Use a preinstalled ManagedEngine ServiceDesk Plus (Zoho) Connector from Popular Connector List or press Search Online radio button to download ManagedEngine ServiceDesk Plus (Zoho) Connector. Once downloaded simply use it in the configuration:
ManagedEngine ServiceDesk Plus (Zoho)
-
Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in 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.
Configuring authentication parameters
ManagedEngine ServiceDesk Plus (Zoho)
OAuth [OAuth]
https://sdpondemand.manageengine.com/api/v3
-
Select the desired endpoint, change/pass the properties values, and click on Preview Data button to make the API call.
API Source - 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.
-
That's it! We are done! Just in a few clicks we configured the call to ManagedEngine ServiceDesk Plus (Zoho) using ManagedEngine ServiceDesk Plus (Zoho) Connector.
You can load the source data into your desired destination using the Upsert Destination, which supports SQL Server, PostgreSQL, and Amazon Redshift. We also offer other destinations such as CSV, Excel, Azure Table, Salesforce, and more. You can check out our SSIS PowerPack Tasks and components for more options. (*loaded in Trash Destination)
Write data to ManagedEngine ServiceDesk Plus (Zoho) using SSIS (Import data)
In this section we will learn how to configure and use ManagedEngine ServiceDesk Plus (Zoho) Connector in the API Destination to write data to ManagedEngine ServiceDesk Plus (Zoho).
Video tutorial
This video covers following and more so watch carefully. After watching this video follow the steps described in this article.
- How to download SSIS PowerPack for ManagedEngine ServiceDesk Plus (Zoho) integration in SSIS
- How to configure connection for ManagedEngine ServiceDesk Plus (Zoho)
- How to write or lookup data to ManagedEngine ServiceDesk Plus (Zoho)
- Features about SSIS API Destination
- Using ManagedEngine ServiceDesk Plus (Zoho) Connector in SSIS
Step-by-step instructions
In upper section we learned how to read data, now in this section we will learn how to configure ManagedEngine ServiceDesk Plus (Zoho) in the API Source to POST data to the ManagedEngine ServiceDesk Plus (Zoho).
-
Read the data from the source, being any desired source component. In example we will use ZappySys Dummy Data Source component.
-
From the SSIS Toolbox drag and drop API Destination (Predefined Templates) on the Data Flow Designer surface and connect source component with it, and double click to edit it.
-
Select New Connection to create a new connection:
API Destination - 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.
-
Use a preinstalled ManagedEngine ServiceDesk Plus (Zoho) Connector from Popular Connector List or press Search Online radio button to download ManagedEngine ServiceDesk Plus (Zoho) Connector. Once downloaded simply use it in the configuration:
ManagedEngine ServiceDesk Plus (Zoho)
-
Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in 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.
Configuring authentication parameters
ManagedEngine ServiceDesk Plus (Zoho)
OAuth [OAuth]
https://sdpondemand.manageengine.com/api/v3
-
Select the desired endpoint, change/pass the properties values, and go to the Mappings tab to map the columns.
API Destination - 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.
-
Finally, map the desired columns:
API Destination - 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.
-
That's it; we successfully configured the POST API Call. In a few clicks we configured the ManagedEngine ServiceDesk Plus (Zoho) API call using ZappySys ManagedEngine ServiceDesk Plus (Zoho) Connector
Load ManagedEngine ServiceDesk Plus (Zoho) data into SQL Server using Upsert Destination (Insert or Update)
Once you configured the data source, you can load ManagedEngine ServiceDesk Plus (Zoho) data into SQL Server using Upsert Destination.
Upsert Destination can merge or synchronize source data with the target table.
It supports Microsoft SQL Server, PostgreSQL, and Redshift databases as targets.
Upsert Destination also supports very fast bulk upsert
operation along with bulk delete
.
Upsert operation
- a database operation which performs INSERT
or UPDATE
SQL commands
based on record's existence condition in the target table.
It inserts records that don't have matching records in the target table
or updates them, if they do,
by matching them by key columns.
Upsert Destination supports INSERT
, UPDATE
, and DELETE
operations,
so it is similar to SQL Server's MERGE
command, except it can be used directly in SSIS package.
-
From the SSIS Toolbox drag-and-drop Upsert Destination component onto the Data Flow designer background.
-
Connect your SSIS source component to Upsert Destination.
-
Double-click on Upsert Destination component to open configuration window.
-
Start by selecting the Action from the list.
-
Next, select the desired target connection
or create one by clicking <New [provider] Connection> menu item from the Target Connection dropdown.
-
Then select a table from the Target Table list
or click New button to create a new table based on the source columns.
-
Continue by checking Insert and Update options according to your scenario
(e.g. if Update option is unchecked, no updates will be made).
-
Finally, click Map All button to map all columns
and then select the Key columns to match the columns on:
-
Click OK to save the configuration.
-
Run the package and ManagedEngine ServiceDesk Plus (Zoho) data will be merged with the target table in SQL Server, PostgreSQL, or Redshift:
-
Done!
Deploy and schedule SSIS package
After you are done creating SSIS package, most likely, you want to deploy it to SQL Server Catalog and run it periodically.
Just follow the instructions in this article:
Running SSIS package in Azure Data Factory (ADF)
To use SSIS PowerPack in ADF, you must first prepare Azure-SSIS Integration Runtime.
Follow this link for detailed instructions:
Advanced topics
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 Request Task Comments
Get Request Task Comment Details
[
Read more...
]
Parameter |
Description |
RequestId |
|
TaskId |
|
CommentId |
|
Get Request Worklog Details
Get Request Task Worklogs
Get Request Task Worklog Details
[
Read more...
]
Parameter |
Description |
RequestId |
|
TaskId |
|
WorklogId |
|
Get Change Task Comment Details
[
Read more...
]
Parameter |
Description |
ChangeId |
|
TaskId |
|
CommentId |
|
Get Change Worklog Details
Get Change Task Worklog Details
[
Read more...
]
Parameter |
Description |
ChangeId |
|
TaskId |
|
WorklogId |
|
Get Problem Task Comments
Get Problem Task Comment Details
[
Read more...
]
Parameter |
Description |
ProblemId |
|
TaskId |
|
CommentId |
|
Get Problem Worklog Details
Get Problem Task Worklogs
Get Problem Task Worklog Details
[
Read more...
]
Parameter |
Description |
ProblemId |
|
TaskId |
|
WorklogId |
|
Get Project Milestone Tasks
[
Read more...
]
Parameter |
Description |
ProjectId |
|
MilestoneId |
|
Get Project Task Comments
Get Project Task Comment Details
[
Read more...
]
Parameter |
Description |
ProjectId |
|
TaskId |
|
CommentId |
|
Get Project Worklog Details
Get Project Task Worklogs
Get Project Task Worklog Details
[
Read more...
]
Parameter |
Description |
ProjectId |
|
TaskId |
|
WorklogId |
|
Get Release Task Comments
Get Release Task Comment Details
[
Read more...
]
Parameter |
Description |
ReleaseId |
|
TaskId |
|
CommentId |
|
Get Release Worklog Details
Get Release Task Worklogs
Get Release Task Worklog Details
[
Read more...
]
Parameter |
Description |
ReleaseId |
|
TaskId |
|
WorklogId |
|
Get Purchase Order Details
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 |
Set 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
Option |
Value |
No filter |
|
Example1 |
$.store.books[*] |
Example2 (Sections Under Books) |
$.store.books[*].sections[*] |
Example3 (Equals) |
$.store.books[?(@author=='sam')] |
Example4 (Equals - Any Section) |
$..[?(@author=='sam')] |
Example5 (Not Equals - Any Section) |
$..[?(@author!='sam')] |
Example6 (Number less than) |
$.store.books[?(@.price<10)]
Example7 (Regular Expression - Contains Pattern)=$.store.books[?(@author=~ /sam|bob/ )] |
Example8 (Regular Expression - Does Not Contain Pattern) |
$.store.books[?(@author=~ /^((?!sam|bob).)*$/ )] |
Example9 (Regular Expression - Exact Pattern Match) |
$.store.books[?(@author=~ /^sam|bob$/ )] |
Example10 (Regular Expression - Starts With) |
$.store.books[?(@author=~ /^sam/ )] |
Example11 (Regular Expression - Ends With) |
$.store.books[?(@author=~ /sam$/ )] |
Example12 (Between) |
$.store.employees[?( @.hiredate>'2015-01-01' && @.hiredate<'2015-01-04' )] |
|
Headers |
Headers for Request. To enter multiple headers use double pipe or new line after each {header-name}:{value} pair
|
Generic Request (Bulk Write)
This is a generic endpoint for bulk write purpose. 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
|
IsMultiPart |
Set 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
|
Conclusion
In this article we showed you how to connect to ManagedEngine ServiceDesk Plus (Zoho) in SSIS and integrate data without any coding, saving you time and effort.
We encourage you to download ManagedEngine ServiceDesk Plus (Zoho) Connector for SSIS 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 SSIS
Documentation
More integrations
Other connectors for SSIS
Other application integration scenarios for ManagedEngine ServiceDesk Plus (Zoho)
Common Searches:
How to connect ManagedEngine ServiceDesk Plus (Zoho) in SSIS?
How to get ManagedEngine ServiceDesk Plus (Zoho) data in SSIS?
How to read ManagedEngine ServiceDesk Plus (Zoho) data in SSIS?
How to load ManagedEngine ServiceDesk Plus (Zoho) data in SSIS?
How to import ManagedEngine ServiceDesk Plus (Zoho) data in SSIS?
How to pull ManagedEngine ServiceDesk Plus (Zoho) data in SSIS?
How to push data to ManagedEngine ServiceDesk Plus (Zoho) in SSIS?
How to write data to ManagedEngine ServiceDesk Plus (Zoho) in SSIS?
How to POST data to ManagedEngine ServiceDesk Plus (Zoho) in SSIS?
Call ManagedEngine ServiceDesk Plus (Zoho) API in SSIS
Consume ManagedEngine ServiceDesk Plus (Zoho) API in SSIS
ManagedEngine ServiceDesk Plus (Zoho) SSIS Automate
ManagedEngine ServiceDesk Plus (Zoho) SSIS Integration
Integration ManagedEngine ServiceDesk Plus (Zoho) in SSIS
Consume real-time ManagedEngine ServiceDesk Plus (Zoho) data in SSIS
Consume real-time ManagedEngine ServiceDesk Plus (Zoho) API data in SSIS
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 SSIS
Load ManagedEngine ServiceDesk Plus (Zoho) in SSIS
Load ManagedEngine ServiceDesk Plus (Zoho) data in SSIS
Read ManagedEngine ServiceDesk Plus (Zoho) data in SSIS
ManagedEngine ServiceDesk Plus (Zoho) API Call in SSIS