Merge pull request #190102 from Clare-Zheng82/0301-Add_connector_docs_Zendesk_Smartsheet

Add Zendesk and Smartsheet connector docs

Author: ttorble

articles/data-factory/TOC.yml

@@ -524,6 +524,8 @@ items:
       displayName: timeout 
     - name: Shopify
       href: connector-shopify.md
+    - name: Smartsheet
+      href: connector-smartsheet.md
     - name: Snowflake
       href: connector-snowflake.md
     - name: Spark
@@ -545,6 +547,8 @@ items:
       href: connector-web-table.md
     - name: Xero
       href: connector-xero.md
+    - name: Zendesk
+      href: connector-zendesk.md
     - name: XML format
       href: format-xml.md
     - name: Zoho
@@ -839,7 +843,7 @@ items:
         - name: Diagnostic tool for self-hosted integration runtime
           href: self-hosted-integration-runtime-diagnostic-tool.md
           displayName: self hosted
-        - name: Monitoring self-hosted intgegration runtime in Azure
+        - name: Monitoring self-hosted integration runtime in Azure
           href: monitor-shir-in-azure.md
         - name: Configuring self-hosted integration runtime for log analytics collection
           href: how-to-configure-shir-for-log-analytics-collection.md

articles/data-factory/connector-smartsheet.md

@@ -0,0 +1,104 @@
+---
+title: Transform data in Smartsheet (Preview)
+titleSuffix: Azure Data Factory & Azure Synapse
+description: Learn how to transform data in Smartsheet (Preview) by using Data Factory or Azure Synapse Analytics.
+ms.author: jianleishen
+author: jianleishen
+ms.service: data-factory
+ms.subservice: data-movement
+ms.topic: conceptual
+ms.custom: synapse
+ms.date: 02/28/2022
+---
+
+#  Transform data in Smartsheet (Preview) using Azure Data Factory or Synapse Analytics
+
+[!INCLUDE[appliesto-adf-asa-md](includes/appliesto-adf-asa-md.md)]
+
+This article outlines how to use Data Flow to transform data in Smartsheet (Preview). To learn more, read the introductory article for [Azure Data Factory](introduction.md) or [Azure Synapse Analytics](../synapse-analytics/overview-what-is.md).
+
+## Supported capabilities
+
+This Smartsheet connector is supported for the following activities:
+
+- [Mapping data flow](concepts-data-flow-overview.md)
+
+## Create a Smartsheet linked service using UI
+
+Use the following steps to create a Smartsheet linked service in the Azure portal UI.
+
+1. Browse to the Manage tab in your Azure Data Factory or Synapse workspace and select Linked Services, then select New:
+
+    # [Azure Data Factory](#tab/data-factory)
+
+    :::image type="content" source="media/doc-common-process/new-linked-service.png" alt-text="Screenshot of creating a new linked service with Azure Data Factory U I.":::
+
+    # [Azure Synapse](#tab/synapse-analytics)
+
+    :::image type="content" source="media/doc-common-process/new-linked-service-synapse.png" alt-text="Screenshot of creating a new linked service with Azure Synapse U I.":::
+
+2. Search for Smartsheet (Preview) and select the Smartsheet (Preview) connector.
+
+    :::image type="content" source="media/connector-smartsheet/smartsheet-connector.png" alt-text="Screenshot showing selecting Smartsheet connector.":::
+
+3. Configure the service details, test the connection, and create the new linked service.
+
+    :::image type="content" source="media/connector-smartsheet/configure-smartsheet-linked-service.png" alt-text="Screenshot of configuration for Smartsheet linked service.":::
+
+## Connector configuration details
+
+The following sections provide information about properties that are used to define Data Factory and Synapse pipeline entities specific to Smartsheet.
+
+## Linked service properties
+
+The following properties are supported for the Smartsheet linked service:
+
+| Property | Description | Required |
+|:--- |:--- |:--- |
+| type | The type property must be set to **Smartsheet**. |Yes |
+| apiToken | Specify an API token for the Smartsheet. Mark this field as **SecureString** to store it securely. Or, you can [reference a secret stored in Azure Key Vault](store-credentials-in-key-vault.md). |Yes |
+
+**Example:**
+
+```json
+{
+    "name": "SmartsheetLinkedService",
+    "properties": {
+        "type": "Smartsheet",
+        "typeProperties": {
+            "apiToken": {
+                "type": "SecureString",
+                "value": "<API token>"
+            }
+        }
+    }
+}
+```
+
+## Mapping data flow properties
+
+When transforming data in mapping data flow, you can read tables from Smartsheet. For more information, see the [source transformation](data-flow-source.md) in mapping data flows. You can only use an [inline dataset](data-flow-source.md#inline-datasets) as source type.
+
+### Source transformation
+
+The below table lists the properties supported by Smartsheet source. You can edit these properties in the **Source options** tab.
+
+| Name | Description | Required | Allowed values | Data flow script property |
+| ---- | ----------- | -------- | -------------- | ---------------- |
+| Entity type | The type of the data asset in Smartsheet. | Yes when use inline mode| `sheets`  `reports` | entityType |
+| Entity name | The name of a sheet or a report in Smartsheet. | Yes when use inline mode| String | entityId |
+
+#### Smartsheet source script examples
+
+```
+source(allowSchemaDrift: true,
+	validateSchema: false,
+	store: 'smartsheet',
+	format: 'rest',
+	entityId: 'Sheet1',
+	entityType: 'sheets') ~> SmartsheetSource
+```
+
+## Next steps
+
+For a list of data stores supported as sources and sinks by the copy activity, see [Supported data stores](copy-activity-overview.md#supported-data-stores-and-formats).

articles/data-factory/connector-zendesk.md

@@ -0,0 +1,143 @@
+---
+title: Transform data in Zendesk (Preview)
+titleSuffix: Azure Data Factory & Azure Synapse
+description: Learn how to transform data in Zendesk (Preview) by using Data Factory or Azure Synapse Analytics.
+ms.author: jianleishen
+author: jianleishen
+ms.service: data-factory
+ms.subservice: data-movement
+ms.topic: conceptual
+ms.custom: synapse
+ms.date: 02/28/2022
+---
+
+#  Transform data in Zendesk (Preview) using Azure Data Factory or Synapse Analytics
+
+[!INCLUDE[appliesto-adf-asa-md](includes/appliesto-adf-asa-md.md)]
+
+This article outlines how to use Data Flow to transform data in Zendesk (Preview). To learn more, read the introductory article for [Azure Data Factory](introduction.md) or [Azure Synapse Analytics](../synapse-analytics/overview-what-is.md).
+
+## Supported capabilities
+
+This Zendesk connector is supported for the following activities:
+
+- [Mapping data flow](concepts-data-flow-overview.md)
+
+## Create a Zendesk linked service using UI
+
+Use the following steps to create a Zendesk linked service in the Azure portal UI.
+
+1. Browse to the Manage tab in your Azure Data Factory or Synapse workspace and select Linked Services, then select New:
+
+    # [Azure Data Factory](#tab/data-factory)
+
+    :::image type="content" source="media/doc-common-process/new-linked-service.png" alt-text="Screenshot of creating a new linked service with Azure Data Factory U I.":::
+
+    # [Azure Synapse](#tab/synapse-analytics)
+
+    :::image type="content" source="media/doc-common-process/new-linked-service-synapse.png" alt-text="Screenshot of creating a new linked service with Azure Synapse U I.":::
+
+2. Search for Zendesk (Preview) and select the Zendesk (Preview) connector.
+
+    :::image type="content" source="media/connector-zendesk/zendesk-connector.png" alt-text="Screenshot showing selecting Zendesk connector.":::
+
+3. Configure the service details, test the connection, and create the new linked service.
+
+    :::image type="content" source="media/connector-zendesk/configure-zendesk-linked-service.png" alt-text="Screenshot of configuration for Zendesk linked service.":::
+
+## Connector configuration details
+
+The following sections provide information about properties that are used to define Data Factory and Synapse pipeline entities specific to Zendesk.
+
+## Linked service properties
+
+The following properties are supported for the Zendesk linked service:
+
+| Property | Description | Required |
+|:--- |:--- |:--- |
+| type | The type property must be set to **Zendesk**. |Yes |
+| url | The base URL of your Zendesk service. | Yes |
+| authenticationType | Type of authentication used to connect to the Zendesk service. Allowed values are **basic** and **token**. Refer to corresponding sections below on more properties and examples respectively.|Yes |
+
+### Basic authentication
+
+Set the **authenticationType** property to **basic**. In addition to the generic properties that are described in the preceding section, specify the following properties:
+
+| Property | Description | Required |
+|:--- |:--- |:--- |
+| userName | The user name used to log in to Zendesk. |Yes  |
+| password | Specify a password for the user account you specified for the user name. Mark this field as **SecureString** to store it securely. Or, you can [reference a secret stored in Azure Key Vault](store-credentials-in-key-vault.md). |Yes  |
+
+**Example:**
+
+```json
+{
+    "name": "ZendeskLinkedService",
+    "properties": {
+        "type": "Zendesk",
+        "typeProperties": {
+            "url": "<base url>",
+            "authenticationType": "basic",
+            "userName": "<user name>",
+            "password": {
+                "type": "SecureString",
+                "value": "<password>"
+            }
+        }
+    }
+}
+```
+
+### Token authentication
+
+Set the **authenticationType** property to **token**. In addition to the generic properties that are described in the preceding section, specify the following properties:
+
+| Property | Description | Required |
+|:--- |:--- |:--- |
+| apiToken | Specify an API token for the Zendesk. Mark this field as **SecureString** to store it securely. Or, you can [reference a secret stored in Azure Key Vault](store-credentials-in-key-vault.md). |Yes |
+
+**Example:**
+
+```json
+{
+    "name": "ZendeskLinkedService",
+    "properties": {
+        "type": "Zendesk",
+        "typeProperties": {
+            "url": "<base url>",
+            "authenticationType": "token",
+            "apiToken": {
+                "type": "SecureString",
+                "value": "<API token>"
+            }
+        }
+    }
+}
+```
+
+## Mapping data flow properties
+
+When transforming data in mapping data flow, you can read tables from Zendesk. For more information, see the [source transformation](data-flow-source.md) in mapping data flows. You can only use an [inline dataset](data-flow-source.md#inline-datasets) as source type.
+
+### Source transformation
+
+The below table lists the properties supported by Zendesk source. You can edit these properties in the **Source options** tab.
+
+
+| Name | Description | Required | Allowed values | Data flow script property |
+| ---- | ----------- | -------- | -------------- | ---------------- |
+| Entity | The logical name of the entity in Zendesk. | Yes when use inline mode| `activities`<br/>`group_memberships`<br/>`groups`<br/>`organizations`<br/>`requests`  <br/>`satisfaction_ratings`<br/>`sessions`<br/>`tags`<br/>`targets`<br/>`ticket_audits`<br/>`ticket_fields`<br/>`ticket_metrics`<br/>`tickets`<br/>`triggers`<br/>`users`<br/>`views`  | entity |
+
+#### Zendesk source script examples
+
+```
+source(allowSchemaDrift: true,
+	validateSchema: false,
+	store: 'zendesk',
+	format: 'rest',
+	entity: 'tickets') ~> ZendeskSource
+```
+
+## Next steps
+
+For a list of data stores supported as sources and sinks by the copy activity, see [Supported data stores](copy-activity-overview.md#supported-data-stores-and-formats).