Transform data in AppFigures (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 AppFigures (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 AppFigures 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 an AppFigures linked service using UI

Use the following steps to create an AppFigures 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:

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

    Screenshot showing selecting AppFigures connector.

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

    Screenshot of configuration for AppFigures 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 AppFigures.

Linked service properties

The following properties are supported for the AppFigures linked service:

Property Description Required
type The type property must be set to AppFigures. Yes
userName Specify a user name for the AppFigures. Yes
password Specify a password for the AppFigures. Mark this field as SecureString to store it securely. Or, you can reference a secret stored in Azure Key Vault. Yes
clientKey Specify a client key for the AppFigures. Mark this field as SecureString to store it securely. Or, you can reference a secret stored in Azure Key Vault. Yes

Example:

{
    "name": "AppFiguresLinkedService",
    "properties": {
        "type": "AppFigures",
        "typeProperties": {
            "userName": "<username>",
            "password": "<password>",
            "clientKey": "<client key>"
        }
    }
}

Mapping data flow properties

When transforming data in mapping data flow, you can read tables from AppFigures. 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 AppFigures 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 entity in AppFigures. Yes products
ads
sales
(for inline dataset only)
entityType

AppFigures source script examples

When you use AppFigures as source type, the associated data flow script is:

source(allowSchemaDrift: true,
	validateSchema: false,
	store: 'appfigures',
	format: 'rest',
	entityType: 'products') ~> AppFiguresSource

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