diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
index e57b62a..38c56bc 100644
--- a/.github/ISSUE_TEMPLATE/bug-report.yml
+++ b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -35,6 +35,12 @@ body:
description: A concise description of what you expected to happen.
validations:
required: true
+ - type: textarea
+ attributes:
+ label: Possible solution
+ description: Were you able to investigate and/or discover a potential fix to this bug in your investigation? If so, it would be much appreciated if you could submit code samples to show us how your fix resolved this issue.
+ validations:
+ required: false
- type: textarea
attributes:
label: dbt Project configurations
@@ -61,6 +67,19 @@ body:
- other (mention it in "Additional Context")
validations:
required: true
+ - type: dropdown
+ id: orchestration_type
+ attributes:
+ label: How are you running this dbt package?
+ multiple: true
+ options:
+ - Fivetran Quickstart Data Model
+ - Fivetran Transformations
+ - dbt Core™
+ - dbt Cloud™
+ - other (mention it in "Additional Context")
+ validations:
+ required: true
- type: textarea
attributes:
label: dbt Version
@@ -83,6 +102,6 @@ body:
description: Our team will assess this issue and let you know if we will add it to a future sprint. However, if you would like to expedite the solution, we encourage you to contribute to the package via a PR. Our team will then work with you to approve and merge your contributions as soon as possible.
options:
- label: Yes.
- - label: Yes, but I will need assistance and will schedule time during our [office hours](https://calendly.com/fivetran-solutions-team/fivetran-solutions-team-office-hours) for guidance
+ - label: Yes, but I will need assistance.
- label: No.
required: false
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
index d916947..496b3bd 100644
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,7 +1,7 @@
contact_links:
- - name: Chat with us in our Fivetran dbt community
- url: https://community.fivetran.com/t5/user-group-for-dbt/gh-p/dbt-user-group
- about: Submit any questions you have about our dbt packages so our Fivetran Analytics Engineering team can provide guidance as quickly as possible!
+ - name: Provide feedback to our dbt package team
+ url: https://www.surveymonkey.com/r/DQ7K7WW
+ about: Fill out our survey form to provide valuable feedback to the Fivetran team developing and maintaining the dbt packages.
- name: Fivetran connector question
url: https://support.fivetran.com/hc
about: Have a question about your connector? Check out the Fivetran support portal for more details.
@@ -10,4 +10,4 @@ contact_links:
about: Check out the dbt docs for all dbt related information
- name: Hang out in dbt Slack
url: https://www.getdbt.com/community/
- about: Have a question or just want to chat with fellow data friends, join dbt Slack and hangout in the tools-fivetran channel with us!
\ No newline at end of file
+ about: Have a question or just want to chat with fellow data friends, join dbt Slack and hangout in the tools-fivetran channel with us!
diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml
index 731682e..529e9bc 100644
--- a/.github/ISSUE_TEMPLATE/feature-request.yml
+++ b/.github/ISSUE_TEMPLATE/feature-request.yml
@@ -20,6 +20,13 @@ body:
description: A clear and concise description of what you want to happen and why you want the new feature.
validations:
required: true
+ - type: textarea
+ attributes:
+ label: How would you implement this feature?
+ description: |
+ How would you build out this feature with your existing data? Any code examples you can provide to help accelerate development on this issue?
+ validations:
+ required: true
- type: textarea
attributes:
label: Describe alternatives you've considered
@@ -34,7 +41,7 @@ body:
description: Our team will assess this feature and let you know if we will add it to a future sprint. However, if you would like to expedite the feature, we encourage you to contribute to the package via a PR. Our team will then work with you to approve and merge your contributions as soon as possible.
options:
- label: Yes.
- - label: Yes, but I will need assistance and will schedule time during your [office hours](https://calendly.com/fivetran-solutions-team/fivetran-solutions-team-office-hours) for guidance.
+ - label: Yes, but I will need assistance.
- label: No.
required: false
- type: textarea
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index b4e7e8e..30849fd 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -19,7 +19,13 @@
- [ ] Yes
-**Provide an emoji that best describes your current mood**
+**Typically there are additional maintenance changes required before this will be ready for an upcoming release. Are you comfortable with the Fivetran team making a few commits directly to your branch?**
+
+
+- [ ] Yes
+- [ ] No
+
+**If you had to summarize this PR in an emoji, which would it be?**
:dancer:
diff --git a/.quickstart/quickstart.yml b/.quickstart/quickstart.yml
index 9b779a9..ec74779 100644
--- a/.quickstart/quickstart.yml
+++ b/.quickstart/quickstart.yml
@@ -18,3 +18,13 @@ destination_configurations:
dispatch:
- macro_namespace: dbt_utils
search_order: [ 'spark_utils', 'dbt_utils' ]
+
+public_models: [
+ "zuora__billing_history",
+ "zuora__account_daily_overview",
+ "zuora__line_item_history",
+ "zuora__subscription_overview",
+ "zuora__monthly_recurring_revenue",
+ "zuora__account_overview",
+ "zuora__line_item_enhanced"
+]
diff --git a/README.md b/README.md
index 801a6fe..320125b 100644
--- a/README.md
+++ b/README.md
@@ -10,12 +10,12 @@
-# Zuora dbt package ([Docs](https://fivetran.github.io/dbt_zuora/))
+# Zuora dbt package ([Docs](https://fivetran.github.io/dbt_zuora/))
-# 📣 What does this dbt package do?
+## What does this dbt package do?
- Produces modeled tables that leverage Zuora data from [Fivetran's connector](https://fivetran.com/docs/applications/zuora) in the format described by [this ERD](https://fivetran.com/docs/applications/zuora#schemainformation) and builds off the output of our [Zuora source package](https://github.com/fivetran/dbt_zuora_source).
-- Enables you to better understand your Zuora data. The package achieves this by performing the following:
+- Enables you to better understand your Zuora data. The package achieves this by performing the following:
- Enhancing the balance transaction entries with useful fields from related tables
- Creating customized analysis tables to examine churn by subscriptions
- Developing a look at gross, net, and discount monthly recurring revenue by account
@@ -23,42 +23,42 @@
- Generates a comprehensive data dictionary of your source and modeled Zuora data through the [dbt docs site](https://fivetran.github.io/dbt_zuora/).
-The following table provides a detailed list of all models materialized within this package by default.
-> TIP: See more details about these models in the package's [dbt docs site](https://fivetran.github.io/dbt_zuora/#!/overview?g_v=1).
-
-| **model** | **description** |
+The following table provides a detailed list of all tables materialized within this package by default.
+> TIP: See more details about these tables in the package's [dbt docs site](https://fivetran.github.io/dbt_zuora/#!/overview?g_v=1).
+
+| **Table** | **Description** |
|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [zuora__account_daily_overview](https://fivetran.github.io/dbt_zuora/#!/model/model.zuora.zuora__account_daily_overview) | Each record is a day in an account and its accumulated balance totals based on all line item transactions up to that day. |
| [zuora__account_overview](https://fivetran.github.io/dbt_zuora/#!/model/model.zuora.zuora__account_overview) | Each record represents an account, enriched with metrics about their associated transactions. |
| [zuora__billing_history](https://fivetran.github.io/dbt_zuora/#!/model/model.zuora.zuora__billing_history) | Each record represents an invoice and its various transaction details. |
-| [zuora__line_item_history](https://fivetran.github.io/dbt_zuora/#!/model/model.zuora.zuora__line_item_history) | Each record represents a specific invoice item and its various transaction details. |
+| [zuora__line_item_history](https://fivetran.github.io/dbt_zuora/#!/model/model.zuora.zuora__line_item_history) | Each record represents a specific invoice item and its various transaction details. |
| [zuora__monthly_recurring_revenue](https://fivetran.github.io/dbt_zuora/#!/model/model.zuora.zuora__monthly_recurring_revenue) | Each record represents an account and MRR generated on a monthly basis. |
| [zuora__subscription_overview](https://fivetran.github.io/dbt_zuora/#!/model/model.zuora.zuora__subscription_overview) | Each record represents a subscription, enriched with metrics about time, revenue, state, and period. |
-| [zuora__line_item_enhanced](https://fivetran.github.io/dbt_zuora/#!/model/model.zuora.zuora__line_item_enhanced) | This model constructs a comprehensive, denormalized analytical table that enables reporting on key revenue, subscription, customer, and product metrics from your billing platform. It’s designed to align with the schema of the `*__line_item_enhanced` model found in Zuora, Recharge, Stripe, Shopify, and Recurly, offering standardized reporting across various billing platforms. To see the kinds of insights this model can generate, explore example visualizations in the [Fivetran Billing Model Streamlit App](https://fivetran-billing-model.streamlit.app/). Visit the app for more details. |
+| [zuora__line_item_enhanced](https://fivetran.github.io/dbt_zuora/#!/model/model.zuora.zuora__line_item_enhanced) | This table is a comprehensive, denormalized analytical table that enables reporting on key revenue, subscription, customer, and product metrics from your billing platform. It’s designed to align with the schema of the `*__line_item_enhanced` table found in Zuora, Recharge, Stripe, Shopify, and Recurly, offering standardized reporting across various billing platforms. To see the kinds of insights this table can generate, explore example visualizations in the [Fivetran Billing Model Streamlit App](https://fivetran-billing-model.streamlit.app/). Visit the app for more details and refer to these [docs](https://github.com/fivetran/dbt_zuora/tree/main?tab=readme-ov-file#enabling-standardized-billing-model) for how to enable the table, which is disabled by default. |
-An example churn model is separately available in the analysis folder:
+An example churn report is separately available in the analysis folder:
| **analysis model** | **description** |
|---------------------|------------------|
-| [zuora__account_churn_analysis](https://fivetran.github.io/dbt_zuora/#!/analysis/analysis.zuora.zuora__account_churn_analysis) | Each record represents an account and whether it has churned in that month or not. |
+| [zuora__account_churn_analysis](https://fivetran.github.io/dbt_zuora/#!/analysis/analysis.zuora.zuora__account_churn_analysis) | Each record represents an account and whether it has churned in that month or not. |
-## Example Visualizations
-Curious what these models can do? Check out example visualizations from the [zuora__line_item_enhanced](https://fivetran.github.io/dbt_zuora/#!/model/model.zuora.zuora__line_item_enhanced) model in the [Fivetran Billing Model Streamlit App](https://fivetran-billing-model.streamlit.app/), and see how you can use these models in your own reporting. Below is a screenshot of an example report—-explore the app for more.
+### Example Visualizations
+Curious what these tables can do? Check out example visualizations from the [zuora__line_item_enhanced](https://fivetran.github.io/dbt_zuora/#!/model/model.zuora.zuora__line_item_enhanced) table in the [Fivetran Billing Model Streamlit App](https://fivetran-billing-model.streamlit.app/), and see how you can use these tables in your own reporting. Below is a screenshot of an example report—-explore the app for more.
-
+
-
+
-# 🎯 How do I use the dbt package?
-## Step 1: Prerequisites
+## How do I use the dbt package?
+### Step 1: Prerequisites
To use this dbt package, you must have the following:
-- At least one Fivetran Zuora connector syncing data into your destination
+- At least one Fivetran Zuora connector syncing data into your destination
- A **BigQuery**, **Snowflake**, **Redshift**, **PostgreSQL**, **Databricks** destination
-### Databricks Dispatch Configuration
+#### Databricks Dispatch Configuration
If you are using a Databricks destination with this package, you will need to add the below (or a variation of the below) dispatch configuration within your `dbt_project.yml`. This is required for the package to accurately search for macros within the `dbt-labs/spark_utils` then the `dbt-labs/dbt_utils` packages, respectively.
```yml
@@ -67,7 +67,7 @@ dispatch:
search_order: ['spark_utils', 'dbt_utils']
```
-## Step 2: Install the package
+### Step 2: Install the package
Include the following zuora package version in your `packages.yml` file.
> 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.
```yaml
@@ -78,7 +78,7 @@ packages:
Do NOT include the `zuora_source` package in this file. The transformation package itself has a dependency on it and will install the source package as well.
-## Step 3: Define database and schema variables
+### Step 3: Define database and schema variables
By default, this package runs using your destination and the `zuora` schema. If this is not where your Zuora data is (for example, if your Zuora schema is named `zuora_fivetran`), add the following configuration to your root `dbt_project.yml` file:
```yml
@@ -87,7 +87,7 @@ vars:
zuora_schema: your_schema_name
```
-## Step 4: Disable models for non-existent sources
+### Step 4: Disable models for non-existent sources
Your Zuora connector may not be syncing all tables that this package references. This might be because you are excluding those tables. If you are not using those tables, you can disable the corresponding functionality in the package by specifying the variable in your dbt_project.yml. By default, all packages are assumed to be true. You only have to add variables for tables you want to disable in the following way:
```yml
@@ -98,20 +98,20 @@ vars:
zuora__using_taxation_item: false # Disable if you do not have the taxation item table
```
-## Step 5: Configure the multicurrency variable for customers billing in multiple currencies
+### Step 5: Configure the multicurrency variable for customers billing in multiple currencies
Zuora allows the functionality for multicurrency to bill customers in various currencies. If you are an account utilizing multicurrency, make sure to set the `zuora__using_multicurrency` variable to `true` in `dbt_project.yml` so the amounts in our data models accurately reflect the home currency values in your native account currency.
```yml
vars:
zuora__using_multicurrency: true #Enable if you are utilizing multicurrency, false by default.
```
-### Multicurrency Support Disclaimer (and how you can help)
-We were not able to develop the package using the multicurrency variable, so we had to execute our best judgement when building these models. If you encounter any issues with enabling the variable, [please file a bug report with us](https://github.com/fivetran/dbt_zuora/issues/new?assignees=&labels=type%3Abug&template=bug-report.yml&title=%5BBug%5D+%3Ctitle%3E) and we can work together to fix any issues you encounter!
+#### Multicurrency Support Disclaimer (and how you can help)
+We were not able to develop the package using the multicurrency variable, so we had to execute our best judgement when building these models. If you encounter any issues with enabling the variable, [please file a bug report with us](https://github.com/fivetran/dbt_zuora/issues/new?assignees=&labels=type%3Abug&template=bug-report.yml&title=%5BBug%5D+%3Ctitle%3E) and we can work together to fix any issues you encounter.
-## (Optional) Step 6: Additional configurations
+### (Optional) Step 6: Additional configurations
Expand to view configurations
-### Enabling Standardized Billing Model
+#### Enabling Standardized Billing Model
This package contains the `zuora__line_item_enhanced` model which constructs a comprehensive, denormalized analytical table that enables reporting on key revenue, subscription, customer, and product metrics from your billing platform. It’s designed to align with the schema of the `*__line_item_enhanced` model found in Recurly, Recharge, Stripe, Shopify, and Zuora, offering standardized reporting across various billing platforms. To see the kinds of insights this model can generate, explore example visualizations in the [Fivetran Billing Model Streamlit App](https://fivetran-billing-model.streamlit.app/). For the time being, this model is disabled by default. If you would like to enable this model you will need to adjust the `zuora__standardized_billing_model_enabled` variable to be `true` within your `dbt_project.yml`:
```yml
@@ -119,10 +119,10 @@ vars:
zuora__standardized_billing_model_enabled: true # false by default.
```
-### Setting the date range for the account daily overview and monthly recurring revenue models
-By default, the `zuora__account_daily_overview` will aggregate data for the entire date range of your data set based on the minimum and maximum `invoice_date` values from the `invoice` source table, and `zuora__monthly_recurring_revenue` based on the `service_start_date` from the `invoice_item` source table.
+#### Setting the date range for the account daily overview and monthly recurring revenue models
+By default, the `zuora__account_daily_overview` will aggregate data for the entire date range of your data set based on the minimum and maximum `invoice_date` values from the `invoice` source table, and `zuora__monthly_recurring_revenue` based on the `service_start_date` from the `invoice_item` source table.
-However, you may limit this date range if desired by defining the following variables for each respective model (the `zuora_overview_` variables refer to the `zuora__account_daily_overview`, the `zuora_mrr_` variables apply to `zuora__monthly_recurring_revenue`).
+However, you may limit this date range if desired by defining the following variables for each respective model (the `zuora_overview_` variables refer to the `zuora__account_daily_overview`, the `zuora_mrr_` variables apply to `zuora__monthly_recurring_revenue`).
```yml
vars:
@@ -133,7 +133,7 @@ vars:
zuora_mrr_last_date: "yyyy-mm-dd"
```
-### Passing Through Additional Fields
+#### Passing Through Additional Fields
This package includes all source columns defined in the [macros folder of the dbt_zuora_source package](https://github.com/fivetran/dbt_zuora_source/tree/main/macros). You can add more columns using our pass-through column variables. These variables allow the pass-through fields to be aliased (`alias`) and casted (`transform_sql`) if desired, but not required. Datatype casting is configured via a SQL snippet within the `transform_sql` key. You may add the desired SQL while omitting the `as field_name` at the end and your custom pass-though fields will be casted accordingly. Use the below format for declaring the respective pass-through variables:
```yml
@@ -153,7 +153,7 @@ vars:
- name: "yet_another_field"
alias: "coolest_field_name"
```
-### Change the build schema
+#### Change the build schema
By default this, package will build the Zuora staging models within a schema titled ( + `_stg_zuora`), the Zuora intermediate models within a schema titled ( + `_zuora_int`), and the Zuora final models within a schema titled ( + `_zuora`) in your target database. If this is not where you would like your modeled Zuora data to be written to, add the following configuration to your `dbt_project.yml` file:
```yml
@@ -166,7 +166,7 @@ models:
+schema: my_new_schema_name # leave blank for just the target_schema
```
-### Change the source table references
+#### Change the source table references
If an individual source table has a different name than the package expects, add the table name as it appears in your destination to the respective variable:
> IMPORTANT: See this project's [`dbt_project.yml`](https://github.com/fivetran/dbt_zuora_source/blob/main/dbt_project.yml) variable declarations to see the expected names.
@@ -175,27 +175,27 @@ vars:
zuora__identifier: your_table_name
```
-### 🚨 Snowflake Users
-If you do **not** use the default all-caps naming conventions for Snowflake, you may need to provide the case-sensitive spelling of your source tables that are also Snowflake reserved words.
+#### Snowflake Users
+If you do **not** use the default all-caps naming conventions for Snowflake, you may need to provide the case-sensitive spelling of your source tables that are also Snowflake reserved words.
In this package, this would apply to the `ORDER` source. If you are receiving errors for this source, include the below identifier in your `dbt_project.yml` file:
```yml
vars:
- zuora_order_identifier: "ORDER" # as an example, must include the double-quotes and correct case!
+ zuora_order_identifier: "ORDER" # as an example, must include the double-quotes and correct case
```
-
+
Expand to view details
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).