Skip to content

Commit 535ad5c

Browse files
committed
Add AppFigures connector doc
1 parent 3740841 commit 535ad5c

File tree

5 files changed

+120
-0
lines changed

5 files changed

+120
-0
lines changed

articles/data-factory/TOC.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -353,6 +353,8 @@ items:
353353
href: connector-amazon-simple-storage-service.md
354354
- name: Amazon S3 Compatible Storage
355355
href: connector-amazon-s3-compatible-storage.md
356+
- name: AppFigures
357+
href: connector-appfigures.md
356358
- name: Asana
357359
href: connector-asana.md
358360
- name: Avro format
Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
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>*&#9312; Azure integration runtime &#9313; 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+
"type": "Microsoft.DataFactory/factories/linkedservices",
78+
"properties": {
79+
"type": "AppFigures",
80+
"typeProperties": {
81+
"userName": "<username>",
82+
"password": "<password>",
83+
"clientKey": "<client key>"
84+
}
85+
}
86+
}
87+
```
88+
89+
## Mapping data flow properties
90+
91+
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.
92+
93+
### Source transformation
94+
95+
The below table lists the properties supported by AppFigures source. You can edit these properties in the **Source options** tab.
96+
97+
| Name | Description | Required | Allowed values | Data flow script property |
98+
| ---- | ----------- | -------- | -------------- | ---------------- |
99+
| Entity type | The type of the entity in AppFigures. | Yes | `products`<br>`ads`<br>`sales` | *(for inline dataset only)*<br>entityType |
100+
101+
102+
#### AppFigures source script examples
103+
104+
When you use AppFigures as source type, the associated data flow script is:
105+
106+
```
107+
source(allowSchemaDrift: true,
108+
validateSchema: false,
109+
store: 'appfigures',
110+
format: 'rest',
111+
entityType: 'products') ~> AppFiguresSource
112+
```
113+
114+
## Next steps
115+
116+
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).
16.3 KB
Loading
34 KB
Loading

articles/synapse-analytics/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -981,6 +981,8 @@ items:
981981
href: ../data-factory/connector-amazon-simple-storage-service.md?context=/azure/synapse-analytics/context/context&tabs=synapse-analytics
982982
- name: Amazon S3 Compatible Storage
983983
href: ../data-factory/connector-amazon-s3-compatible-storage.md?context=/azure/synapse-analytics/context/context&tabs=synapse-analytics
984+
- name: AppFigures
985+
href: ../data-factory/connector-appfigures.md?context=/azure/synapse-analytics/context/context&tabs=synapse-analytics
984986
- name: Asana
985987
href: ../data-factory/connector-asana.md?context=/azure/synapse-analytics/context/context&tabs=synapse-analytics
986988
- name: Avro format

0 commit comments

Comments
 (0)