Skip to content

Commit 52e9221

Browse files
fivetran-data-model-botClaude README Updaterfivetran-joemarkiewiczgithub-actions[bot]fivetran-catfritz
authored
Update .quickstart.yml and README (#50)
* Update .quickstart.yml and README for fy26 q4 * Apply suggestions from code review * Generate dbt docs via GitHub Actions * Fix spelling errors CHANGELOG and/or quickstart.yml * Update README.md * Fix spelling errors CHANGELOG and/or quickstart.yml * Fix spelling errors CHANGELOG and/or quickstart.yml * Fix spelling errors CHANGELOG and/or quickstart.yml * Fix spelling errors CHANGELOG and/or quickstart.yml * Fix typo in CHANGELOG.md * Generate dbt docs via GitHub Actions --------- Co-authored-by: Claude README Updater <noreply@fivetran.com> Co-authored-by: Joe Markiewicz <74217849+fivetran-joemarkiewicz@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Catherine Fritz <111930712+fivetran-catfritz@users.noreply.github.com>
1 parent 1ce4af0 commit 52e9221

7 files changed

Lines changed: 94 additions & 39 deletions

File tree

.quickstart/quickstart.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,13 @@ table_variables:
99
asana__using_task_tags:
1010
- _task_tag
1111

12+
_fivetran_quickstart_section:
13+
- section
14+
_fivetran_quickstart_task_follower:
15+
- _task_follower
16+
_fivetran_quickstart_task_section:
17+
- _task_section
18+
1219
destination_configurations:
1320
databricks:
1421
dispatch:
@@ -23,3 +30,10 @@ public_models: [
2330
"asana__project",
2431
"asana__tag"
2532
]
33+
34+
supported_vars:
35+
task_pass_through_columns:
36+
type: dictionary
37+
description: "Additional `TASK` fields to include in `asana__task`"
38+
display_name: "Additional Task Columns"
39+

CHANGELOG.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1+
# dbt_asana v1.3.0
2+
3+
[PR #50](https://github.com/fivetran/dbt_asana/pull/50) includes the following updates:
4+
5+
## Documentation
6+
- Updates README with standardized Fivetran formatting.
7+
8+
## Under the Hood
9+
- In the `quickstart.yml` file:
10+
- Adds `table_variables` for relevant sources to prevent missing sources from blocking downstream Quickstart models.
11+
- Adds `supported_vars` for Quickstart UI customization.
12+
113
# dbt_asana v1.2.0
214
[PR #49](https://github.com/fivetran/dbt_asana/pull/49) includes the following updates:
315

@@ -182,4 +194,4 @@ PR [#19](https://github.com/fivetran/dbt_asana/pull/19) introduced the following
182194
- Please note, if you are installing a version of `dbt_utils` in your `packages.yml` that is not in the range above then you will encounter a package dependency error.
183195

184196
# dbt_asana v0.1.0 -> v0.4.0
185-
Refer to the relevant release notes on the Github repository for specific details for the previous releases. Thank you!
197+
Refer to the relevant release notes on the Github repository for specific details for the previous releases. Thank you!

README.md

Lines changed: 63 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
2-
# Asana dbt Package ([Docs](https://fivetran.github.io/dbt_asana/))
1+
<!--section="asana_transformation_model"-->
2+
# Asana dbt Package
33

44
<p align="left">
55
<a alt="License"
@@ -12,52 +12,76 @@
1212
<a alt="PRs">
1313
<img src="https://img.shields.io/badge/Contributions-welcome-blueviolet" /></a>
1414
<a alt="Fivetran Quickstart Compatible"
15-
href="https://fivetran.com/docs/transformations/dbt/quickstart">
15+
href="https://fivetran.com/docs/transformations/data-models/quickstart-management#quickstartmanagement">
1616
<img src="https://img.shields.io/badge/Fivetran_Quickstart_Compatible%3F-yes-green.svg" /></a>
1717
</p>
1818

19+
This dbt package transforms data from Fivetran's Asana connector into analytics-ready tables.
20+
21+
## Resources
22+
23+
- Number of materialized models¹: 28
24+
- Connector documentation
25+
- [Asana connector documentation](https://fivetran.com/docs/connectors/applications/asana)
26+
- [Asana ERD](https://fivetran.com/docs/connectors/applications/asana#schemainformation)
27+
- dbt package documentation
28+
- [GitHub repository](https://github.com/fivetran/dbt_asana)
29+
- [dbt Docs](https://fivetran.github.io/dbt_asana/#!/overview)
30+
- [DAG](https://fivetran.github.io/dbt_asana/#!/overview?g_v=1)
31+
- [Changelog](https://github.com/fivetran/dbt_asana/blob/main/CHANGELOG.md)
32+
1933
## What does this dbt package do?
34+
This package enables you to enhance task, user, project, team, and tag tables with metrics and provide daily metrics for task tracking. It creates enriched models with metrics focused on work volume, breadth, and velocity.
35+
36+
### Output schema
37+
Final output tables are generated in the following target schema:
2038

21-
- Produces modeled tables that leverage Asana data from [Fivetran's connector](https://fivetran.com/docs/applications/asana) in the format described by [this ERD](https://fivetran.com/docs/applications/asana#schemainformation).
39+
```
40+
<your_database>.<connector/schema_name>_asana
41+
```
2242

23-
- Enhances the task, users, projects, teams, and tags tables. Each of these tables is enriched with metrics that reflect the volume and breadth of current work and also the velocity of completed work.
24-
- Provides a daily metrics table, which lays out a timeline of task creations and completions to show the overall pace of deliverables.
25-
- Generates a comprehensive data dictionary of your source and modeled Asana data through the [dbt docs site](https://fivetran.github.io/dbt_asana/).
43+
### Final output tables
2644

27-
<!--section=“asana_transformation_model"-->
28-
The following table provides a detailed list of all tables materialized within this package by default.
29-
> TIP: See more details about these tables in the package's [dbt docs site](https://fivetran.github.io/dbt_asana/#!/overview?g_v=1&g_e=seeds).
45+
By default, this package materializes the following final tables:
3046

31-
| **Table** | **Description** |
32-
| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- |
33-
| [asana__task](https://fivetran.github.io/dbt_asana/#!/model/model.asana.asana__task) | Each record represents an Asana task, enriched with data about its assignee, projects, sections, tasks, teams, tags, parent task, comments, followers, and activity. |
34-
| [asana__user](https://fivetran.github.io/dbt_asana/#!/model/model.asana.asana__user) | Each record represents an Asana user, enriched with metrics about their completed tasks, open tasks, and the projects they work on. Also includes data about the user's most recently completed task and their next due task. |
35-
| [asana__project](https://fivetran.github.io/dbt_asana/#!/model/model.asana.asana__project) | Each record represents an Asana project, enriched with metrics about their completed tasks, open tasks, and the users involved in the project. Also includes data about the project's most recently completed task and next due tasks. |
36-
| [asana__team](https://fivetran.github.io/dbt_asana/#!/model/model.asana.asana__team) | Each record represents an Asana team, enriched with data about their completed tasks, open tasks, their projects, and the users involved with the team. |
37-
| [asana__tag](https://fivetran.github.io/dbt_asana/#!/model/model.asana.asana__tag) | Each record represents an Asana tag, enriched with metrics about open and completed tasks associated with the tag. |
38-
| [asana__daily_metrics](https://fivetran.github.io/dbt_asana/#!/model/model.asana.asana__daily_metrics) | Each record represents a single day, enriched with metrics about tasks opened at created that day. |
47+
| Table | Description |
48+
| :---- | :---- |
49+
| [asana__task](https://fivetran.github.io/dbt_asana/#!/model/model.asana.asana__task) | Provides comprehensive task-level data including assignments, due dates, completion status, project associations, and custom field values to track work progress and team productivity. <br></br>**Example Analytics Questions:**<ul><li>Which tasks are overdue or at risk of missing their due dates?</li><li>How many tasks are assigned to each team member and what is their completion rate?</li><li>What custom field values correlate with faster task completion times?</li></ul>|
50+
| [asana__user](https://fivetran.github.io/dbt_asana/#!/model/model.asana.asana__user) | Summarizes user activity and workload including assigned tasks, created tasks, completion metrics, and project involvement to understand individual productivity and capacity. <br></br>**Example Analytics Questions:**<ul><li>Which users have the highest task completion rates and productivity metrics?</li><li>What is the current workload (open tasks) for each team member?</li><li>How many tasks has each user created versus completed over time?</li></ul>|
51+
| [asana__project](https://fivetran.github.io/dbt_asana/#!/model/model.asana.asana__project) | Tracks all Asana projects with completion metrics, ownership details, and privacy settings to understand project status, workload distribution, and team organization. <br></br>**Example Analytics Questions:**<ul><li>Which projects have the most open tasks and longest completion times?</li><li>How are projects distributed across teams and owners?</li><li>What is the ratio of completed to total tasks for each active project?</li></ul>|
52+
| [asana__team](https://fivetran.github.io/dbt_asana/#!/model/model.asana.asana__team) | Tracks team-level metrics including total tasks, completion rates, and project counts to monitor team performance and workload balance across the organization. <br></br>**Example Analytics Questions:**<ul><li>Which teams have the highest task volumes and completion rates?</li><li>How are projects and tasks distributed across different teams?</li><li>What is the average task completion time for each team?</li></ul>|
53+
| [asana__tag](https://fivetran.github.io/dbt_asana/#!/model/model.asana.asana__tag) | Aggregates task metrics by tag to categorize work, track themes, and analyze patterns across projects using Asana's tagging system. <br></br>**Example Analytics Questions:**<ul><li>Which tags are associated with the most tasks and longest completion times?</li><li>How are tags distributed across different projects and teams?</li><li>What percentage of tasks with specific tags are completed on time?</li></ul>|
54+
| [asana__daily_metrics](https://fivetran.github.io/dbt_asana/#!/model/model.asana.asana__daily_metrics) | Summarizes daily task activity including tasks created, completed, and overall team productivity to track workflow trends and identify peak productivity periods. <br></br>**Example Analytics Questions:**<ul><li>How many tasks are created versus completed each day across the organization?</li><li>What days of the week show the highest task creation and completion rates?</li><li>Are there daily patterns in task activity that could inform capacity planning?</li></ul>|
3955

40-
### Materialized Models
41-
Each Quickstart transformation job run materializes 28 models if all components of this data model are enabled. This count includes all staging, intermediate, and final models materialized as `view`, `table`, or `incremental`.
42-
<!--section-end-->
43-
## How do I use the dbt package?
44-
### Step 1: Prerequisites
56+
¹ Each Quickstart transformation job run materializes these models if all components of this data model are enabled. This count includes all staging, intermediate, and final models materialized as `view`, `table`, or `incremental`.
57+
58+
---
59+
60+
## Prerequisites
4561
To use this dbt package, you must have the following:
4662

4763
- At least one Fivetran Asana connection syncing data into your destination.
4864
- A **BigQuery**, **Snowflake**, **Redshift**, **PostgreSQL**, or **Databricks** destination.
4965

50-
### Step 2: Install the package
66+
## How do I use the dbt package?
67+
You can either add this dbt package in the Fivetran dashboard or import it into your dbt project:
68+
69+
- To add the package in the Fivetran dashboard, follow our [Quickstart guide](https://fivetran.com/docs/transformations/data-models/quickstart-management).
70+
- To add the package to your dbt project, follow the setup instructions in the dbt package's [README file](https://github.com/fivetran/dbt_asana/blob/main/README.md#how-do-i-use-the-dbt-package) to use this package.
71+
72+
<!--section-end-->
73+
74+
### Install the package
5175
Include the following asana package version in your `packages.yml` file.
5276
> TIP: Check [dbt Hub](https://hub.getdbt.com/) for the latest installation instructions, or [read the dbt docs](https://docs.getdbt.com/docs/package-management) for more information on installing packages.
5377
```yaml
5478
packages:
5579
- package: fivetran/asana
56-
version: [">=1.2.0", "<1.3.0"] # we recommend using ranges to capture non-breaking changes automatically
80+
version: [">=1.3.0", "<1.4.0"] # we recommend using ranges to capture non-breaking changes automatically
5781
```
5882
> All required sources and staging models are now bundled into this transformation package. Do not include `fivetran/asana_source` in your `packages.yml` since this package has been deprecated.
5983

60-
### Step 3: Define database and schema variables
84+
### Define database and schema variables
6185

6286
#### Option A: Single connection
6387
By default, this package runs using your [destination](https://docs.getdbt.com/docs/running-a-dbt-project/using-the-command-line-interface/configure-your-profile) and the `asana` schema. If this is not where your Asana data is (for example, if your Asana schema is named `asana_fivetran`), add the following configuration to your root `dbt_project.yml` file:
@@ -116,7 +140,7 @@ sources:
116140
tables: # copy and paste from asana/models/staging/src_asana.yml - see https://support.atlassian.com/bitbucket-cloud/docs/yaml-anchors/ for how to use anchors to only do so once
117141
```
118142

119-
> **Note**: If there are source tables you do not have (see [Step 4](https://github.com/fivetran/dbt_asana?tab=readme-ov-file#step-4-disable-models-for-non-existent-sources)), you may still include them, as long as you have set the right variables to `False`.
143+
> **Note**: If there are source tables you do not have (see [Enabling/Disabling Models](https://github.com/fivetran/dbt_asana?tab=readme-ov-file#enablingdisabling-models)), you may still include them, as long as you have set the right variables to `False`.
120144

121145
2. Set the `has_defined_sources` variable (scoped to the `asana` package) to `True`, like such:
122146
```yml
@@ -126,7 +150,7 @@ vars:
126150
has_defined_sources: true
127151
```
128152

129-
### Step 4: Enabling/Disabling Models
153+
### Enabling/Disabling Models
130154

131155
Your Asana connection might not sync every table that this package expects. If your syncs exclude certain tables, it is either because you do not use that functionality in Asana or have actively excluded some tables from your syncs. In order to enable or disable the relevant tables in the package, you will need to add the following variable(s) to your `dbt_project.yml` file.
132156

@@ -138,7 +162,7 @@ vars:
138162
asana__using_task_tags: false # default is true
139163
```
140164

141-
### (Optional) Step 5: Additional configurations
165+
### (Optional) Additional configurations
142166
<details open><summary>Expand/Collapse details</summary>
143167

144168
#### Passing Through Additional Columns
@@ -173,10 +197,10 @@ vars:
173197

174198
</details>
175199

176-
### (Optional) Step 6: Orchestrate your models with Fivetran Transformations for dbt Core™
200+
### (Optional) Orchestrate your models with Fivetran Transformations for dbt Core™
177201
<details><summary>Expand for more details</summary>
178202

179-
Fivetran offers the ability for you to orchestrate your dbt project through [Fivetran Transformations for dbt Core™](https://fivetran.com/docs/transformations/dbt). Learn how to set up your project for orchestration through Fivetran in our [Transformations for dbt Core setup guides](https://fivetran.com/docs/transformations/dbt#setupguide).
203+
Fivetran offers the ability for you to orchestrate your dbt project through [Fivetran Transformations for dbt Core™](https://fivetran.com/docs/transformations/dbt#transformationsfordbtcore). Learn how to set up your project for orchestration through Fivetran in our [Transformations for dbt Core setup guides](https://fivetran.com/docs/transformations/dbt/setup-guide#transformationsfordbtcoresetupguide).
180204

181205
</details>
182206

@@ -192,15 +216,20 @@ packages:
192216
- package: dbt-labs/dbt_utils
193217
version: [">=1.0.0", "<2.0.0"]
194218
```
219+
220+
<!--section="asana_maintenance"-->
195221
## How is this package maintained and can I contribute?
222+
196223
### Package Maintenance
197-
The Fivetran team maintaining this package _only_ maintains the latest version of the package. We highly recommend you stay consistent with the [latest version](https://hub.getdbt.com/fivetran/asana/latest/) of the package and refer to the [CHANGELOG](https://github.com/fivetran/dbt_asana/blob/main/CHANGELOG.md) and release notes for more information on changes across versions.
224+
The Fivetran team maintaining this package only maintains the [latest version](https://hub.getdbt.com/fivetran/asana/latest/) of the package. We highly recommend you stay consistent with the latest version of the package and refer to the [CHANGELOG](https://github.com/fivetran/dbt_asana/blob/main/CHANGELOG.md) and release notes for more information on changes across versions.
198225

199226
### Contributions
200227
A small team of analytics engineers at Fivetran develops these dbt packages. However, the packages are made better by community contributions.
201228

202-
We highly encourage and welcome contributions to this package. Check out [this dbt Discourse article](https://discourse.getdbt.com/t/contributing-to-a-dbt-package/657) on the best workflow for contributing to a package.
229+
We highly encourage and welcome contributions to this package. Learn how to contribute to a package in dbt's [Contributing to an external dbt package article](https://discourse.getdbt.com/t/contributing-to-a-dbt-package/657).
230+
231+
<!--section-end-->
203232

204233
## Are there any resources available?
205234
- If you have questions or want to reach out for help, see the [GitHub Issue](https://github.com/fivetran/dbt_asana/issues/new/choose) section to find the right avenue of support for you.
206-
- If you would like to provide feedback to the dbt package team at Fivetran or would like to request a new dbt package, fill out our [Feedback Form](https://www.surveymonkey.com/r/DQ7K7WW).
235+
- If you would like to provide feedback to the dbt package team at Fivetran or would like to request a new dbt package, fill out our [Feedback Form](https://www.surveymonkey.com/r/DQ7K7WW).

dbt_project.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
config-version: 2
22
name: 'asana'
3-
version: '1.2.0'
3+
version: '1.3.0'
44
require-dbt-version: [">=1.3.0", "<3.0.0"]
55
models:
66
asana:

docs/catalog.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

docs/manifest.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

integration_tests/dbt_project.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
config-version: 2
22
name: 'asana_integration_tests'
3-
version: '1.2.0'
3+
version: '1.3.0'
44
profile: 'integration_tests'
55
vars:
66
asana_schema: asana_integrations_tests_03

0 commit comments

Comments
 (0)