|
| 1 | +--- |
| 2 | +title: Transform data in AppFigures (Preview) |
| 3 | +titleSuffix: Azure Data Factory & Azure Synapse |
| 4 | +description: Learn how to transform data in AppFigures (Preview) by using Data Factory or Azure Synapse Analytics. |
| 5 | +ms.author: jianleishen |
| 6 | +author: jianleishen |
| 7 | +ms.service: data-factory |
| 8 | +ms.subservice: data-movement |
| 9 | +ms.topic: conceptual |
| 10 | +ms.custom: synapse |
| 11 | +ms.date: 08/16/2022 |
| 12 | +--- |
| 13 | + |
| 14 | +# Transform data in AppFigures (Preview) using Azure Data Factory or Synapse Analytics |
| 15 | + |
| 16 | +[!INCLUDE[appliesto-adf-asa-md](includes/appliesto-adf-asa-md.md)] |
| 17 | + |
| 18 | +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](introduction.md) or [Azure Synapse Analytics](../synapse-analytics/overview-what-is.md). |
| 19 | + |
| 20 | +> [!IMPORTANT] |
| 21 | +> 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](https://azure.microsoft.com/support/). |
| 22 | +
|
| 23 | +## Supported capabilities |
| 24 | + |
| 25 | +This AppFigures connector is supported for the following capabilities: |
| 26 | + |
| 27 | +| Supported capabilities|IR | |
| 28 | +|---------| --------| |
| 29 | +|[Mapping data flow](concepts-data-flow-overview.md) (source/-)|① | |
| 30 | + |
| 31 | +<small>*① Azure integration runtime ② Self-hosted integration runtime*</small> |
| 32 | + |
| 33 | +For a list of data stores that are supported as sources/sinks, see the [Supported data stores](connector-overview.md#supported-data-stores) table. |
| 34 | + |
| 35 | +## Create an AppFigures linked service using UI |
| 36 | + |
| 37 | +Use the following steps to create an AppFigures linked service in the Azure portal UI. |
| 38 | + |
| 39 | +1. Browse to the Manage tab in your Azure Data Factory or Synapse workspace and select Linked Services, then select New: |
| 40 | + |
| 41 | + # [Azure Data Factory](#tab/data-factory) |
| 42 | + |
| 43 | + :::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."::: |
| 44 | + |
| 45 | + # [Azure Synapse](#tab/synapse-analytics) |
| 46 | + |
| 47 | + :::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."::: |
| 48 | + |
| 49 | +2. Search for AppFigures (Preview) and select the AppFigures (Preview) connector. |
| 50 | + |
| 51 | + :::image type="content" source="media/connector-appfigures/appfigures-connector.png" alt-text="Screenshot showing selecting AppFigures connector."::: |
| 52 | + |
| 53 | +3. Configure the service details, test the connection, and create the new linked service. |
| 54 | + |
| 55 | + :::image type="content" source="media/connector-appfigures/configure-appfigures-linked-service.png" alt-text="Screenshot of configuration for AppFigures linked service."::: |
| 56 | + |
| 57 | +## Connector configuration details |
| 58 | + |
| 59 | +The following sections provide information about properties that are used to define Data Factory and Synapse pipeline entities specific to AppFigures. |
| 60 | + |
| 61 | +## Linked service properties |
| 62 | + |
| 63 | +The following properties are supported for the AppFigures linked service: |
| 64 | + |
| 65 | +| Property | Description | Required | |
| 66 | +|:--- |:--- |:--- | |
| 67 | +| type | The type property must be set to **AppFigures**. |Yes | |
| 68 | +| userName | Specify a user name for the AppFigures. |Yes | |
| 69 | +| 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](store-credentials-in-key-vault.md). |Yes | |
| 70 | +| 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](store-credentials-in-key-vault.md). |Yes | |
| 71 | + |
| 72 | +**Example:** |
| 73 | + |
| 74 | +```json |
| 75 | +{ |
| 76 | + "name": "AppFiguresLinkedService", |
| 77 | + "properties": { |
| 78 | + "type": "AppFigures", |
| 79 | + "typeProperties": { |
| 80 | + "userName": "<username>", |
| 81 | + "password": "<password>", |
| 82 | + "clientKey": "<client key>" |
| 83 | + } |
| 84 | + } |
| 85 | +} |
| 86 | +``` |
| 87 | + |
| 88 | +## Mapping data flow properties |
| 89 | + |
| 90 | +When transforming data in mapping data flow, you can read tables from AppFigures. 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. |
| 91 | + |
| 92 | +### Source transformation |
| 93 | + |
| 94 | +The below table lists the properties supported by AppFigures source. You can edit these properties in the **Source options** tab. |
| 95 | + |
| 96 | +| Name | Description | Required | Allowed values | Data flow script property | |
| 97 | +| ---- | ----------- | -------- | -------------- | ---------------- | |
| 98 | +| Entity type | The type of the entity in AppFigures. | Yes | `products`<br>`ads`<br>`sales` | *(for inline dataset only)*<br>entityType | |
| 99 | + |
| 100 | + |
| 101 | +#### AppFigures source script examples |
| 102 | + |
| 103 | +When you use AppFigures as source type, the associated data flow script is: |
| 104 | + |
| 105 | +``` |
| 106 | +source(allowSchemaDrift: true, |
| 107 | + validateSchema: false, |
| 108 | + store: 'appfigures', |
| 109 | + format: 'rest', |
| 110 | + entityType: 'products') ~> AppFiguresSource |
| 111 | +``` |
| 112 | + |
| 113 | +## Next steps |
| 114 | + |
| 115 | +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). |
0 commit comments