Skip to content

Files

Latest commit

 

History

History
220 lines (172 loc) · 9.22 KB

connector-zoho.md

File metadata and controls

220 lines (172 loc) · 9.22 KB
title description titleSuffix author ms.service ms.subservice ms.custom ms.topic ms.date ms.author
Copy data from Zoho (Preview)
Learn how to copy data from Zoho to supported sink data stores using a copy activity in an Azure Data Factory or Synapse Analytics pipeline.
Azure Data Factory & Azure Synapse
jianleishen
data-factory
data-movement
synapse
conceptual
09/09/2021
jianleishen

Copy data from Zoho using Azure Data Factory or Synapse Analytics (Preview)

[!INCLUDEappliesto-adf-asa-md]

This article outlines how to use the Copy Activity in an Azure Data Factory or Synapse Analytics pipeline to copy data from Zoho. It builds on the copy activity overview article that presents a general overview of copy activity.

Important

This connector is currently in preview. You can try it out and give us feedback. If you want to take a dependency on preview connectors in your solution, please contact Azure support.

Supported capabilities

This Zoho connector is supported for the following activities:

You can copy data from Zoho to any supported sink data store. For a list of data stores that are supported as sources/sinks by the copy activity, see the Supported data stores table.

This connector supports Xero access token authentication and OAuth 2.0 authentication.

The service provides a built-in driver to enable connectivity, therefore you don't need to manually install any driver using this connector.

Getting started

[!INCLUDE data-factory-v2-connector-get-started]

Create a linked service to Zoho using UI

Use the following steps to create a linked service to Zoho in the Azure portal UI.

  1. Browse to the Manage tab in your Azure Data Factory or Synapse workspace and select Linked Services, then click New:

    Azure Data Factory

    :::image type="content" source="media/doc-common-process/new-linked-service.png" alt-text="Create a new linked service with Azure Data Factory UI.":::

    Azure Synapse

    :::image type="content" source="media/doc-common-process/new-linked-service-synapse.png" alt-text="Create a new linked service with Azure Synapse UI.":::

  2. Search for Zoho and select the Zoho connector.

    :::image type="content" source="media/connector-zoho/zoho-connector.png" alt-text="Select the Zoho connector.":::

  3. Configure the service details, test the connection, and create the new linked service.

    :::image type="content" source="media/connector-zoho/configure-zoho-linked-service.png" alt-text="Configure a linked service to Zoho.":::

Connector configuration details

The following sections provide details about properties that are used to define Data Factory entities specific to Zoho connector.

Linked service properties

The following properties are supported for Zoho linked service:

Property Description Required
type The type property must be set to: Zoho Yes
connectionProperties A group of properties that defines how to connect to Zoho. Yes
Under connectionProperties:
endpoint The endpoint of the Zoho server (crm.zoho.com/crm/private). Yes
authenticationType Allowed values are OAuth_2.0 and Access Token. Yes
clientId The client ID associated with your Zoho application. Yes for OAuth 2.0 authentication
clientSecrect The clientsecret associated with your Zoho application. Mark this field as a SecureString to store it securely, or reference a secret stored in Azure Key Vault. Yes for OAuth 2.0 authentication
refreshToken The OAuth 2.0 refresh token associated with your Zoho application, used to refresh the access token when it expires. Refresh token will never expire. To get a refresh token, you must request the offline access_type, learn more from this article.
Mark this field as a SecureString to store it securely, or reference a secret stored in Azure Key Vault.		 Yes for OAuth 2.0 authentication
accessToken The access token for Zoho authentication. Mark this field as a SecureString to store it securely, or reference a secret stored in Azure Key Vault. Yes
useEncryptedEndpoints Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. No
useHostVerification Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over TLS. The default value is true. No
usePeerVerification Specifies whether to verify the identity of the server when connecting over TLS. The default value is true. No

Example: OAuth 2.0 authentication

{
    "name": "ZohoLinkedService",
    "properties": {
        "type": "Zoho",
        "typeProperties": {
            "connectionProperties": { 
                "authenticationType":"OAuth_2.0", 
                "endpoint": "crm.zoho.com/crm/private", 
                "clientId": "<client ID>", 
                "clientSecrect": {
                    "type": "SecureString",
                    "value": "<client secret>"
                },
                "accessToken": {
                    "type": "SecureString",
                    "value": "<access token>"
                }, 
                "refreshToken": {
                    "type": "SecureString",
                    "value": "<refresh token>"
                }, 
                "useEncryptedEndpoints": true,
                "useHostVerification": true, 
                "usePeerVerification": true
            }
        }
    }
}

Example: access token authentication

{
    "name": "ZohoLinkedService",
    "properties": {
        "type": "Zoho",
        "typeProperties": {
            "connectionProperties": { 
                "authenticationType":"Access Token", 
                "endpoint": "crm.zoho.com/crm/private", 
                "accessToken": {
                    "type": "SecureString",
                    "value": "<access token>"
                }, 
                "useEncryptedEndpoints": true, 
                "useHostVerification": true, 
                "usePeerVerification": true
            }
        }
    }
}

Dataset properties

For a full list of sections and properties available for defining datasets, see the datasets article. This section provides a list of properties supported by Zoho dataset.

To copy data from Zoho, set the type property of the dataset to ZohoObject. The following properties are supported:

Property Description Required
type The type property of the dataset must be set to: ZohoObject Yes
tableName Name of the table. No (if "query" in activity source is specified)

Example

{
    "name": "ZohoDataset",
    "properties": {
        "type": "ZohoObject",
        "typeProperties": {},
        "schema": [],
        "linkedServiceName": {
            "referenceName": "<Zoho linked service name>",
            "type": "LinkedServiceReference"
        }
    }
}

Copy activity properties

For a full list of sections and properties available for defining activities, see the Pipelines article. This section provides a list of properties supported by Zoho source.

Zoho as source

To copy data from Zoho, set the source type in the copy activity to ZohoSource. The following properties are supported in the copy activity source section:

Property Description Required
type The type property of the copy activity source must be set to: ZohoSource Yes
query Use the custom SQL query to read data. For example: "SELECT * FROM Accounts". No (if "tableName" in dataset is specified)

Example:

"activities":[
    {
        "name": "CopyFromZoho",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<Zoho input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "ZohoSource",
                "query": "SELECT * FROM Accounts"
            },
            "sink": {
                "type": "<sink type>"
            }
        }
    }
]

Lookup activity properties

To learn details about the properties, check Lookup activity.

Next steps

For a list of data stores supported as sources and sinks by the copy activity, see supported data stores.