From bec86c57b07598d59e676c68d783dab51a022a2d Mon Sep 17 00:00:00 2001 From: Joe Markiewicz <74217849+fivetran-joemarkiewicz@users.noreply.github.com> Date: Thu, 5 Sep 2024 16:15:52 -0500 Subject: [PATCH] Documentation Standard Updates (#13) * MagicBot/documentation-updates * Update README.md --- .github/ISSUE_TEMPLATE/bug-report.yml | 23 ++++++- .github/ISSUE_TEMPLATE/config.yml | 8 +-- .github/ISSUE_TEMPLATE/feature-request.yml | 11 ++- .../maintainer_pull_request_template.md | 13 ++-- .github/pull_request_template.md | 8 ++- .quickstart/quickstart.yml | 11 ++- README.md | 67 +++++++++---------- 7 files changed, 90 insertions(+), 51 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/maintainer_pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/maintainer_pull_request_template.md index ddc4d56..3220674 100644 --- a/.github/PULL_REQUEST_TEMPLATE/maintainer_pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/maintainer_pull_request_template.md @@ -14,12 +14,11 @@ Please acknowledge that you have successfully performed the following commands l - [ ] dbt run (if incremental models are present) && dbt test Before marking this PR as "ready for review" the following have been applied: -- [ ] The appropriate issue has been linked, tagged, and properly assigned. -- [ ] All necessary documentation and version upgrades have been applied. - <!--- Be sure to update the package version in the dbt_project.yml, integration_tests/dbt_project.yml, and README if necessary. --> -- [ ] docs were regenerated (unless this PR does not include any code or yml updates). -- [ ] BuildKite integration tests are passing. -- [ ] Detailed validation steps have been provided below. +- [ ] The appropriate issue has been linked, tagged, and properly assigned +- [ ] All necessary documentation and version upgrades have been applied +- [ ] docs were regenerated (unless this PR does not include any code or yml updates) +- [ ] BuildKite integration tests are passing +- [ ] Detailed validation steps have been provided below ### Detailed Validation Please share any and all of your validation steps: @@ -27,4 +26,4 @@ Please share any and all of your validation steps: ### 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: +:dancer: \ No newline at end of file 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 775367f..a57da9c 100644 --- a/.quickstart/quickstart.yml +++ b/.quickstart/quickstart.yml @@ -13,4 +13,13 @@ destination_configurations: databricks: dispatch: - macro_namespace: dbt_utils - search_order: [ 'spark_utils', 'dbt_utils' ] \ No newline at end of file + search_order: [ 'spark_utils', 'dbt_utils' ] +public_models: [ + "servicenow__user_enhanced", + "servicenow__change_request_enhanced", + "servicenow__user_aggregated", + "servicenow__problem_enhanced", + "servicenow__activity_summary", + "servicenow__task_enhanced", + "servicenow__incident_enhanced" +] diff --git a/README.md b/README.md index dffada9..c07cef1 100644 --- a/README.md +++ b/README.md @@ -13,29 +13,29 @@ # ServiceNow dbt Package ([Docs](https://fivetran.github.io/dbt_servicenow/)) -# 📣 What does this dbt package do? +## What does this dbt package do? This package models ServiceNow data from [Fivetran's connector](https://fivetran.com/docs/applications/servicenow). It uses data in the format described by [this ERD](https://fivetran.com/docs/applications/servicenow#schemainformation). The main focus of the package is to transform the core object tables into analytics-ready models, including: -<!--section="servicenow_model"--> - - Materializes [ServiceNow staging and output models](https://fivetran.github.io/dbt_servicenow/#!/overview/servicenow/models/?g_v=1) which leverage data in the format described by [this ERD](https://fivetran.com/docs/applications/servicenow/#schemainformation). - - The staging tables clean, test, and prepare your ServiceNow data from [Fivetran's connector](https://fivetran.com/docs/applications/servicenow) for analysis by doing the following: + +- Materializes [ServiceNow staging and output models](https://fivetran.github.io/dbt_servicenow/#!/overview/servicenow/models/?g_v=1) which leverage data in the format described by [this ERD](https://fivetran.com/docs/applications/servicenow/#schemainformation). +- The staging tables clean, test, and prepare your ServiceNow data from [Fivetran's connector](https://fivetran.com/docs/applications/servicenow) for analysis by doing the following: - Renames fields for consistency and standardization. For example, primary keys `sys_id` are renamed to `<table_name>_id`. - Adds column-level testing where applicable. For example, all primary keys are tested for uniqueness and non-null values. - Generates a comprehensive data dictionary of your ServiceNow data through the [dbt docs site](https://fivetran.github.io/dbt_servicenow/). - - The output models are focused around task management. +- The output models are focused around task management. - Summarizes task, problem, change, incident, and change request data by varying grains including last updated day, status, priority, impact, and urgency. - Enhances each task record with additional information about its associated problem, incident, or change request. Finally, it contains user information for who opened, started, updated, reported, fixed, closed, requested, reported, or confirmed the task. - Enhances user data with associated roles and groups. The output models are focused around the task management feature of ServiceNow in addition to enhancing user records. -<!--section="servicenow_model"--> -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_servicenow/#!/overview/servicenow). +<!--section="servicenow_transformation_model"--> +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_servicenow/#!/overview/servicenow). -| **Model** | **Description** | +| **Table** | **Description** | | ------------------------- | ------------------------------------------------------------------------------------------------------------------ | | [servicenow__activity_summary](https://fivetran.github.io/dbt_servicenow/#!/model/model.servicenow.servicenow__activity_summary) | Each record represents aggregate task, problem, change, incident, and change request data by varying grains including update date, status, priority, impact, and urgency. | | [servicenow__task_enhanced](https://fivetran.github.io/dbt_servicenow/#!/model/model.servicenow.servicenow__task_enhanced) | Each record represents a task with additional information about its associated problem, incident, or change request. Additionally, it contains user information for who opened, started, updated, reported, fixed, closed, requested, reported, or confirmed the task. | @@ -47,19 +47,19 @@ The following table provides a detailed list of all models materialized within t <!--section-end--> -## Opinionated Modelling Decisions +### Opinionated Modelling Decisions Servicenow tables can be complex, for example exhibiting many-to-many relationships. For more information on table relationships and how they informed our model development, you may refer to the [DECISIONLOG](https://github.com/fivetran/dbt_servicenow/blob/main/DECISIONLOG.md). -# 🎯 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 ServiceNow connector syncing data into your destination. - A **BigQuery**, **Snowflake**, **Redshift**, **Databricks**, or **PostgreSQL** destination. -### Databricks dispatch configuration +#### Databricks dispatch configuration If you are using a Databricks destination with this package, you must add the following (or a variation of the following) dispatch configuration within your `dbt_project.yml`. This is required in order for the package to accurately search for macros within the `dbt-labs/spark_utils` then the `dbt-labs/dbt_utils` packages respectively. ```yml dispatch: @@ -67,7 +67,7 @@ dispatch: search_order: ['spark_utils', 'dbt_utils'] ``` -## Step 2: Install the package +### Step 2: Install the package Include the following ServiceNow 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. ```yml @@ -76,8 +76,8 @@ packages: version: [">=0.3.0", "<0.4.0"] # we recommend using ranges to capture non-breaking changes automatically ``` -## Step 3: Define database and schema variables -### Single connector +### Step 3: Define database and schema variables +#### Single connector By default, this package runs using your destination and the `servicenow` schema. If this is not where your ServiceNow data is (for example, if your ServiceNow schema is named `servicenow_fivetran`), add the following configuration to your root `dbt_project.yml` file: ```yml @@ -87,7 +87,7 @@ vars: servicenow_database: your_database_name servicenow_schema: your_schema_name ``` -### Union multiple connectors +#### Union multiple connectors If you have multiple ServiceNow 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 the `servicenow_union_schemas` OR `servicenow_union_databases` variables (cannot do both) in your root `dbt_project.yml` file: ```yml @@ -98,14 +98,14 @@ vars: servicenow_union_databases: ['servicenow_usa','servicenow_canada'] # use this if the data is in different databases/projects but uses the same schema name ``` -Please be aware that the native `source.yml` connection set up in the package will not function when the union schema/database feature is utilized. Although the data will be correctly combined, you will not observe the sources linked to the package models in the Directed Acyclic Graph (DAG). This happens because the package includes only one defined `source.yml`. +> NOTE: The native `source.yml` connection set up in the package will not function when the union schema/database feature is utilized. Although the data will be correctly combined, you will not observe the sources linked to the package models in the Directed Acyclic Graph (DAG). This happens because the package includes only one defined `source.yml`. To connect your multiple schema/database sources to the package models, follow the steps outlined in the [Union Data Defined Sources Configuration](https://github.com/fivetran/dbt_fivetran_utils/tree/releases/v0.4.latest#union_data-source) section of the Fivetran Utils documentation for the union_data macro. This will ensure a proper configuration and correct visualization of connections in the DAG. -## (Optional) Step 4: Additional configurations +### (Optional) Step 4: Additional configurations -### Populating the User Models -Our user grain models are disabled by default because not everyone syncs the underlying tables: `sys_user_role`, `sys_user_has_role`, and `sys_user_grmember`. If these tables do exist in your schema, set this following variable `servicenow__using_roles` to True in order to populate the user models `servicenow__user_aggregated` and `servicenow__user_enhanced`. +#### Populating the User Models +Our user grain models are disabled by default because not everyone syncs the underlying tables: `sys_user_role`, `sys_user_has_role`, and `sys_user_grmember`. If these tables do exist in your schema, set this following variable `servicenow__using_roles` to True in order to populate the user models `servicenow__user_aggregated` and `servicenow__user_enhanced`. ```yml # dbt_project.yml @@ -114,7 +114,7 @@ vars: servicenow__using_roles: True ``` -### Changing the Build Schema +#### Changing the Build Schema By default this package will build the ServiceNow staging models within a schema titled (<target_schema> + `_stg_servicenow`) and the ServiceNow final models within a schema titled (<target_schema> + `_servicenow`) in your target database. If this is not where you would like your modeled qualtrics data to be written to, add the following configuration to your `dbt_project.yml` file: ```yml @@ -127,7 +127,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_servicenow/blob/main/dbt_project.yml) variable declarations to see the expected names. @@ -141,7 +141,7 @@ 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™ <details><summary>Expand for details</summary> <br> @@ -149,8 +149,8 @@ Fivetran offers the ability for you to orchestrate your dbt project through [Fiv </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 @@ -161,17 +161,16 @@ 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/servicenow/latest/) of the package and refer to the [CHANGELOG](https://github.com/fivetran/dbt_servicenow/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_servicenow/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_servicenow/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 be part of the community discourse? Create a post in the [Fivetran community](https://community.fivetran.com/t5/user-group-for-dbt/gh-p/dbt-user-group) and our team along with the community can join in on the discussion!