Import ServiceDesk Plus Data Using Azure Data Factory
Microsoft Azure Data Factory (ADF) is a completely managed, serverless data integration service. When combined with CData Connect AI, ADF enables immediate cloud-to-cloud access to ServiceDesk Plus data within data flows. This article outlines the process of connecting to ServiceDesk Plus through Connect AI and accessing ServiceDesk Plus data within ADF.
CData Connect AI offers a cloud-to-cloud interface tailored for ServiceDesk Plus, granting you the ability to access live data from ServiceDesk Plus data within Azure Data Factory without the need for data replication to a natively supported database. Equipped with optimized data processing capabilities by default, CData Connect AI seamlessly channels all supported SQL operations, including filters and JOINs, directly to ServiceDesk Plus. This harnesses server-side processing to expedite the retrieval of the desired ServiceDesk Plus data.
Configure ServiceDesk Plus Connectivity for ADF
Connectivity to ServiceDesk Plus from Azure Data Factory is made possible through CData Connect AI. To work with ServiceDesk Plus data from Azure Data Factory, we start by creating and configuring a ServiceDesk Plus connection.
CData Connect AI uses a straightforward, point-and-click interface to connect to data sources.
- Log into Connect AI, click Sources, and then click Add Connection
- Select "ServiceDesk Plus" from the Add Connection panel
-
Enter the necessary authentication properties to connect to ServiceDesk Plus.
Using OAuth Authentication
ServiceDeskPlus uses Zoho OAuth 2.0 for secure authentication. To set up OAuth access:
- Register your application in the Zoho Developer Console at https://api-console.zoho.com
- Configure your redirect URI to match your application setup
- Note your Client ID and Client Secret from the application settings
After setting the following connection properties, you are ready to connect:
- AuthScheme: Set this to OAuth.
- OAuthClientId: Set this to your Zoho application Client ID.
- OAuthClientSecret: Set this to your Zoho application Client Secret.
- Scope: Set this to the required ServiceDeskPlus permissions (default includes read access to requests, problems, assets, and projects).
- Domain: Set this to your ServiceDeskPlus domain
- Portal: Set this to your ServiceDeskPlus portal
Example Connection String
Profile=C:\profiles\ServiceDeskPlus.apip;ProfileSettings="Portal=itdesk;Domain=.in;Scope=SDPOnDemand.requests.READ SDPOnDemand.problems.READ SDPOnDemand.assets.READ SDPOnDemand.projects.READ";AuthScheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;
- Click Save & Test
-
Navigate to the Permissions tab in the Add ServiceDesk Plus Connection page and update the User-based permissions.
Add a Personal Access Token
When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.
- Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
- On the Settings page, go to the Access Tokens section and click Create PAT.
-
Give the PAT a name and click Create.
- The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.
With the connection configured and a PAT generated, you are ready to connect to ServiceDesk Plus data from Azure Data Factory.
Access Live ServiceDesk Plus Data in Azure Data Factory
To establish a connection from Azure Data Factory to the CData Connect AI Virtual SQL Server API, follow these steps.
- Login to Azure Data Factory.
- If you have not yet created a Data Factory, Click New -> Dataset.
- In the search bar, enter SQL Server and select it when it appears. On the following screen, enter a name for the server. In the Linked service field, select New.
-
Enter the connection settings.
- Name - enter a name of your choice.
- Server name - enter the Virtual SQL Server endpoint and port separated by a comma: tds.cdata.com,14333
- Database name - enter the Connection Name of the CData Connect AI data source you want to connect to (for example, API1).
- User Name - enter your CData Connect AI username. This is displayed in the top-right corner of the CData Connect AI interface. For example, [email protected].
- Password - select Password (not Azure Key Vault) and enter the PAT you generated on the Settings page.
- Click Create.
- In Set properties, set the Name, choose the Linked service we just created, select a Table name from those available, and Import schema from connection/store. Click OK.
- After creating the linked service, the following screen should appear:
- Click preview data to see the imported ServiceDesk Plus table.
You can now use this dataset when creating data flows in Azure Data Factory.
Get CData Connect AI
To get live data access to hundreds of SaaS, Big Data, and NoSQL sources directly from your cloud applications, try CData Connect AI today!