ManagedEngine ServiceDesk Plus (Zoho) Connector for 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.
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.
Let's follow the steps below to see how we can accomplish that!
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
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)
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
Optional 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
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.
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)
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)
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
Optional 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
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:
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.
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) using either raw file data (i.e., POST raw file data) or send data using the multi-part encoding method (i.e. Content-Type: multipart/form-data).
A multi-part request allows you to mix key/value pairs and upload files in the same request. On the other hand, raw upload allows only a single file to be uploaded (without any key/value data).
==== Raw Upload (Content-Type: application/octet-stream) =====
To upload a single file in raw mode, check this option and specify the full file path starting with the @ 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 in the RequestData field (i.e., Body). Each key/value pair should be entered on a new line, and key/value are separated using an equal sign (=). Leading and trailing spaces are ignored, and blank lines are also ignored.
If a field value contains any special character(s), use escape sequences (e.g., for NewLine: \r\n, for Tab: \t, for at (@): @). When the value of any field starts with the at sign (@), it is automatically treated as a file you want to upload. By default, the file content type is determined based on the file extension; however, you can supply a content type manually for any field using this format: [YourFileFieldName.Content-Type=some-content-type].
By default, file upload fields always include Content-Type in the request (non-file fields do not have Content-Type by default unless you supply it manually). If, for some reason, you don't want to use the Content-Type header in your request, then supply a blank Content-Type to exclude this header altogether (e.g., SomeFieldName.Content-Type=).
In the example below, we have supplied Content-Type for file2 and SomeField1. All other fields are using the default content type.
See the example below 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 start with multipart/ or it 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 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) using either raw file data (i.e., POST raw file data) or send data using the multi-part encoding method (i.e. Content-Type: multipart/form-data).
A multi-part request allows you to mix key/value pairs and upload files in the same request. On the other hand, raw upload allows only a single file to be uploaded (without any key/value data).
==== Raw Upload (Content-Type: application/octet-stream) =====
To upload a single file in raw mode, check this option and specify the full file path starting with the @ 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 in the RequestData field (i.e., Body). Each key/value pair should be entered on a new line, and key/value are separated using an equal sign (=). Leading and trailing spaces are ignored, and blank lines are also ignored.
If a field value contains any special character(s), use escape sequences (e.g., for NewLine: \r\n, for Tab: \t, for at (@): @). When the value of any field starts with the at sign (@), it is automatically treated as a file you want to upload. By default, the file content type is determined based on the file extension; however, you can supply a content type manually for any field using this format: [YourFileFieldName.Content-Type=some-content-type].
By default, file upload fields always include Content-Type in the request (non-file fields do not have Content-Type by default unless you supply it manually). If, for some reason, you don't want to use the Content-Type header in your request, then supply a blank Content-Type to exclude this header altogether (e.g., SomeFieldName.Content-Type=).
In the example below, we have supplied Content-Type for file2 and SomeField1. All other fields are using the default content type.
See the example below 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 start with multipart/ or it 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.
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 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.
Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link.
