Transform data in Smartsheet (Preview) using Azure Data Factory or Synapse Analytics

APPLIES TO: Azure Data Factory Azure Synapse Analytics

Tip

Try out Data Factory in Microsoft Fabric, an all-in-one analytics solution for enterprises. Microsoft Fabric covers everything from data movement to data science, real-time analytics, business intelligence, and reporting. Learn how to start a new trial for free!

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 or Azure Synapse Analytics.

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 Smartsheet connector is supported for the following capabilities:

Supported capabilities	IR
Mapping data flow (source/-)	①

① Azure integration runtime ② Self-hosted integration runtime

For a list of data stores that are supported as sources/sinks, see the Supported data stores table.

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

   

   Azure Synapse

   

2. Search for Smartsheet (Preview) and select the Smartsheet (Preview) connector.

   

3. Configure the service details, test the connection, and create the new 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.	Yes

Example:

{
    "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 in mapping data flows. You can only use an inline dataset 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

Related content

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