From 1a97acb076af552b4d073519a7915f1902174671 Mon Sep 17 00:00:00 2001 From: Joe Markiewicz Date: Wed, 28 Aug 2024 14:34:19 -0500 Subject: [PATCH 1/5] MagicBot/documentation-updates --- .github/ISSUE_TEMPLATE/bug-report.yml | 23 ++++++++++- .github/ISSUE_TEMPLATE/config.yml | 8 ++-- .github/ISSUE_TEMPLATE/feature-request.yml | 11 ++++- .github/pull_request_template.md | 8 +++- .quickstart/quickstart.yml | 7 ++++ README.md | 47 +++++++++++----------- 6 files changed, 71 insertions(+), 33 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 17c2c54..38c56bc 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,7 +1,7 @@ name: šŸž Bug description: Report a bug or an issue you've found within the dbt package title: "[Bug] " -labels: ["bug", "triage"] +labels: ["type:bug"] body: - type: markdown attributes: @@ -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 65a074b..496b3bd 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,7 +1,7 @@ contact_links: - - name: Ask a question during our office hours - url: https://calendly.com/fivetran-solutions-team/fivetran-solutions-team-office-hours - about: Schedule time during the external office hours block with the Fivetran Analytics Engineering team for support + - 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 a1d28bb..529e9bc 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -1,7 +1,7 @@ name: šŸŽ‰ Feature description: Suggest a new feature for the Fivetran dbt package title: "[Feature] <title>" -labels: ["enhancement"] +labels: ["type:enhancement"] body: - type: markdown attributes: @@ -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 @@ <!--- To select a checkbox you simply need to add an "x" with no spaces between the brackets (eg. [x] Yes). --> - [ ] 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?** +<!--- If you select Yes this will help expedite your PR in case there are small changes required before approval. We encourage you not to use this branch in a production environment as we may make additional updates. --> +<!--- If you select No, we will not make any changes directly to your branch and will either communicate any planned changes via the PR thread or will merge your PR into a separate branch so we may make changes without modifying your branch.. --> +- [ ] Yes +- [ ] No + +**If you had to summarize this PR in an emoji, which would it be?** <!--- For a complete list of markdown compatible emojis check our this git repo (https://gist.github.com/rxaviers/7360908) --> :dancer: diff --git a/.quickstart/quickstart.yml b/.quickstart/quickstart.yml index 0250eda..e740b1c 100644 --- a/.quickstart/quickstart.yml +++ b/.quickstart/quickstart.yml @@ -14,3 +14,10 @@ destination_configurations: dispatch: - macro_namespace: dbt_utils search_order: [ 'spark_utils', 'dbt_utils' ] + +public_models: [ + "xero__balance_sheet_report", + "xero__profit_and_loss_report", + "xero__invoice_line_items", + "xero__general_ledger" +] diff --git a/README.md b/README.md index 67103a1..4efe5c0 100644 --- a/README.md +++ b/README.md @@ -11,13 +11,13 @@ </p> # Xero Transformation dbt Package ([Docs](https://fivetran.github.io/dbt_xero/)) -# šŸ“£ What does this dbt package do? +## What does this dbt package do? - Produces modeled tables that leverage Xero data from [Fivetran's connector](https://fivetran.com/docs/applications/xero) in the format described by [this ERD](https://fivetran.com/docs/applications/xero#schemainformation) and builds off the output of our [Xero source package](https://github.com/fivetran/dbt_xero_source). - Provides analytics-ready models, including a profit and loss report, general ledger, and balance sheet report. - Generates a comprehensive data dictionary of your source and modeled Xero data through the [dbt docs site](https://fivetran.github.io/dbt_xero/). -The following table provides a detailed list of all models materialized within this package by default. +The following table provides a detailed list of all models materialized within this package by default. | **Model** | **Description** | | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------- | @@ -26,15 +26,15 @@ The following table provides a detailed list of all models materialized within t | [xero__balance_sheet_report](https://github.com/fivetran/dbt_xero/blob/main/models/xero__balance_sheet_report.sql) | Each record represents the state of the balance sheet for a given account on a given month. | | [xero__invoice_line_items](https://github.com/fivetran/dbt_xero/blob/main/models/xero__invoice_line_items.sql) | Each record represents an invoice line item enriched with the account, contact, and invoice information. | -# šŸŽÆ How do I use the dbt package? +## How do I use the dbt package? -## Step 1: Prerequisites +### Step 1: Prerequisites To use this dbt package, you must have the following: - At least one Fivetran Xero connector syncing data into your destination. - A **BigQuery**, **Snowflake**, **Redshift**, **PostgreSQL**, or **Databricks** destination. -## Step 2: Install the package +### Step 2: Install the package Include the following xero 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 @@ -43,7 +43,7 @@ packages: version: [">=0.6.0", "<0.7.0"] # we recommend using ranges to capture non-breaking changes automatically ``` Do NOT include the `xero_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 `xero` schema. If this is not where your Xero data is (for example, if your Xero schema is named `xero_fivetran`), add the following configuration to your root `dbt_project.yml` file: ```yml @@ -52,13 +52,13 @@ vars: xero_database: your_database_name ``` -## (Optional) Step 4: Additional configurations +### (Optional) Step 4: Additional configurations -### Note about currency gains +#### Note about currency gains If you are using multi-currency accounting in Xero, you are likely to have unrealized currency gains as part of your profit and loss statement. These gains/losses do not exist within the actual journals in Xero. As a result, you will find that those lines are missing from the outputs of this package. All realised currency gains will be present and your balance sheet will still balance. -### Unioning Multiple Xero Connectors +#### Unioning Multiple Xero Connectors If you have multiple Xero connectors in Fivetran and would like to use this package on all of them simultaneously, we have provided functionality to do so. The package will union all of the data together and pass the unioned table into the transformations. You will be able to see which source it came from in the `source_relation` column of each model. To use this functionality, you will need to set **either** (**note that you cannot use both**) the `union_schemas` or `union_databases` variables: ```yml @@ -71,7 +71,7 @@ vars: union_databases: ['xero_us','xero_ca'] # use this if the data is in different databases/projects but uses the same schema name ``` -### Disabling and Enabling Models +#### Disabling and Enabling Models When setting up your Xero connection in Fivetran, it is possible that not every table this package expects will be synced. This can occur because you either don't use that functionality in Xero or have actively decided to not sync some tables. In order to disable the relevant functionality in the package, you will need to add the relevant variables. @@ -89,8 +89,8 @@ vars: For additional configurations for the source models, visit the [Xero source package](https://github.com/fivetran/dbt_xero_source). -### Changing the Build Schema -By default this package will build the Xero Source staging models within a schema titled (<target_schema> + `_stg_xero`) and the Xero final transform models within a schema titled (<target_schema> + `_xero`) in your target database. +#### Changing the Build Schema +By default this package will build the Xero Source staging models within a schema titled (<target_schema> + `_stg_xero`) and the Xero final transform models within a schema titled (<target_schema> + `_xero`) in your target database. To overwrite this behavior, add the following configuration to your `dbt_project.yml` file: ```yml @@ -104,7 +104,7 @@ models: +schema: my_new_staging_models_schema # 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_xero/blob/main/dbt_project.yml) variable declarations to see the expected names. @@ -116,14 +116,14 @@ vars: </details> -## (Optional) Step 5: Orchestrate your models with Fivetran Transformations for dbt Coreā„¢ +### (Optional) Step 5: Orchestrate your models with Fivetran Transformations for dbt Coreā„¢ 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). </details> -# šŸ” Does this package have dependencies? -This dbt package is dependent on the following dbt packages. Please be aware that these dependencies are installed by default within this package. For more information on the following packages, refer to the [dbt hub](https://hub.getdbt.com/) site. +## Does this package have dependencies? +This dbt package is dependent on the following dbt packages. These dependencies are installed by default within this package. For more information on the following packages, refer to the [dbt hub](https://hub.getdbt.com/) site. > IMPORTANT: If you have any of these dependent packages in your own `packages.yml` file, we highly recommend that you remove them from your root `packages.yml` to avoid package version conflicts. ```yml @@ -137,16 +137,15 @@ packages: - package: dbt-labs/dbt_utils version: [">=1.0.0", "<2.0.0"] ``` -# šŸ™Œ How is this package maintained and can I contribute? -## Package Maintenance +## How is this package maintained and can I contribute? +### Package Maintenance 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/xero/latest/) of the package and refer to the [CHANGELOG](https://github.com/fivetran/dbt_xero/blob/main/CHANGELOG.md) and release notes for more information on changes across versions. -## Contributions -A small team of analytics engineers at Fivetran develops these dbt packages. However, the packages are made better by community contributions! +### Contributions +A small team of analytics engineers at Fivetran develops these dbt packages. However, the packages are made better by community contributions. -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! +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. -# šŸŖ Are there any resources available? -- If you have questions or want to reach out for help, please refer to the [GitHub Issue](https://github.com/fivetran/dbt_xero/issues/new/choose) section to find the right avenue of support for you. +## Are there any resources available? +- If you have questions or want to reach out for help, see the [GitHub Issue](https://github.com/fivetran/dbt_xero/issues/new/choose) section to find the right avenue of support for you. - 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). -- Have questions or want to just say hi? Book a time during our office hours [on Calendly](https://calendly.com/fivetran-solutions-team/fivetran-solutions-team-office-hours) or email us at solutions@fivetran.com. From df5388a17e55723a657adfd5fa31a31038fb8018 Mon Sep 17 00:00:00 2001 From: Joe Markiewicz <74217849+fivetran-joemarkiewicz@users.noreply.github.com> Date: Wed, 28 Aug 2024 16:49:49 -0500 Subject: [PATCH 2/5] Apply suggestions from code review --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4efe5c0..5e8b711 100644 --- a/README.md +++ b/README.md @@ -17,15 +17,19 @@ - Provides analytics-ready models, including a profit and loss report, general ledger, and balance sheet report. - Generates a comprehensive data dictionary of your source and modeled Xero data through the [dbt docs site](https://fivetran.github.io/dbt_xero/). -The following table provides a detailed list of all models materialized within this package by default. +<!--section=ā€œxero_transformation_model"--> -| **Model** | **Description** | +The following table provides a detailed list of all tables materialized within this package by default. + +| **Table** | **Description** | | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------- | | [xero__general_ledger](https://github.com/fivetran/dbt_xero/blob/main/models/xero__general_ledger.sql) | Each record represents a journal line item. Use the ledger to create the balance sheet and the profit and loss statement. | | [xero__profit_and_loss_report](https://github.com/fivetran/dbt_xero/blob/main/models/xero__profit_and_loss_report.sql) | Each record represents a profit and loss line item at the month and account level. | | [xero__balance_sheet_report](https://github.com/fivetran/dbt_xero/blob/main/models/xero__balance_sheet_report.sql) | Each record represents the state of the balance sheet for a given account on a given month. | | [xero__invoice_line_items](https://github.com/fivetran/dbt_xero/blob/main/models/xero__invoice_line_items.sql) | Each record represents an invoice line item enriched with the account, contact, and invoice information. | +<!--section-end--> + ## How do I use the dbt package? ### Step 1: Prerequisites From 4ce607e5cc9f1051457d905259f828fb521b5e86 Mon Sep 17 00:00:00 2001 From: Jamie Rodriguez <65564846+fivetran-jamie@users.noreply.github.com> Date: Thu, 5 Sep 2024 15:51:04 -0700 Subject: [PATCH 3/5] Apply suggestions from code review --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5e8b711..74def3a 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,8 @@ vars: ``` ### (Optional) Step 4: Additional configurations - +<details open><summary>Expand/Collapse configurations</summary> +<br> #### Note about currency gains If you are using multi-currency accounting in Xero, you are likely to have unrealized currency gains as part of your profit and loss statement. These gains/losses do not exist within the actual journals in Xero. As a result, you will find that those lines are missing from the outputs of this package. All realised currency gains will be present and your balance sheet will still balance. @@ -121,7 +122,8 @@ vars: </details> ### (Optional) Step 5: Orchestrate your models with Fivetran Transformations for dbt Coreā„¢ - +<details><summary>Expand for details</summary> +<br> 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). </details> From 49055f82883e31e9dbf4a27547d7759e394eb6a5 Mon Sep 17 00:00:00 2001 From: Jamie Rodriguez <65564846+fivetran-jamie@users.noreply.github.com> Date: Thu, 5 Sep 2024 15:53:23 -0700 Subject: [PATCH 4/5] Apply suggestions from code review --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 74def3a..5fcd1a0 100644 --- a/README.md +++ b/README.md @@ -59,6 +59,7 @@ vars: ### (Optional) Step 4: Additional configurations <details open><summary>Expand/Collapse configurations</summary> <br> + #### Note about currency gains If you are using multi-currency accounting in Xero, you are likely to have unrealized currency gains as part of your profit and loss statement. These gains/losses do not exist within the actual journals in Xero. As a result, you will find that those lines are missing from the outputs of this package. All realised currency gains will be present and your balance sheet will still balance. @@ -124,6 +125,7 @@ vars: ### (Optional) Step 5: Orchestrate your models with Fivetran Transformations for dbt Coreā„¢ <details><summary>Expand for details</summary> <br> + 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). </details> From 24a01c8d1f3716d07a3ee0b4ad7b69363ce175cd Mon Sep 17 00:00:00 2001 From: Jamie Rodriguez <65564846+fivetran-jamie@users.noreply.github.com> Date: Thu, 5 Sep 2024 16:23:34 -0700 Subject: [PATCH 5/5] Update README.md --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 5fcd1a0..c051639 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,6 @@ vars: ### (Optional) Step 4: Additional configurations <details open><summary>Expand/Collapse configurations</summary> -<br> #### Note about currency gains