Merge pull request #8 from swishbi/dev

Incorporate customer categories

Author: phillem15

CHANGELOG.md

@@ -1,3 +1,15 @@
+# dbt_netsuite_source v0.2.1
+
+## 🎉 Feature Updates 🎉
+[PR #8](https://github.com/swishbi/dbt_netsuite_source/pull/8) includes the following feature updates:
+- Incorporates customer categories as a feature via the `netsuite__using_customer_categories` variable.
+
+## Contributors
+- [phillem15](https://github.com/phillem15) ([#8](https://github.com/swishbi/dbt_netsuite_source/pull/8))
+
+# dbt_netsuite_source v0.1.0
+Refer to the relevant release notes on the Github repository for specific details for the previous releases. Thank you!
+
 # dbt_netsuite_source v0.2.0
 
 ## 🚨 Breaking Changes 🚨:

README.md

@@ -108,6 +108,7 @@ vars:
     netsuite__time_off_management_enabled: true # Enable `timeofftype`, `workcalendar`, and `workcalendarholiday` if you are using the Time Off Management feature
     netsuite__time_tracking_enabled: true # Enable `timebill` if you are using the Time Tracking feature
     netsuite__using_budgets: true # Enable `budget`, `budgetcategory`, and `budgetsmachine` if you use budgets
+    netsuite__using_customer_categories: true # Enable `customercategory` if you categorize your customers
     netsuite__using_vendor_categories: true # Enable `vendorcategory` if you categorize your vendors
     netsuite__using_jobs: true # Enable `job`, `jobstatus`, and `jobtype` if you use jobs
 ```

dbt_project.yml

@@ -27,6 +27,7 @@ vars:
     netsuite_classes: "{{ source('netsuite', 'classification') }}"
     netsuite_consolidated_exchange_rates: "{{ source('netsuite', 'consolidated_exchange_rate') }}"
     netsuite_currencies: "{{ source('netsuite', 'currency') }}"
+    netsuite_customer_categories: "{{ source('netsuite', 'customer_category') }}"
     netsuite_customers: "{{ source('netsuite', 'customer') }}"
     netsuite_departments: "{{ source('netsuite', 'department') }}"
     netsuite_employee_status_categories: "{{ source('netsuite', 'employee_status_categories') }}"

models/_netsuite__docs.md

@@ -10,6 +10,8 @@
 
 {% docs consolidated_exchange_rates_table %} Table detailing average, historical and current exchange rates for all accounting periods. {% enddocs %}
 
+{% docs customer_categories_table %} A table containing categories and how they map to customers. {% enddocs %}
+
 {% docs customers_table %} Table detailing all customer information. {% enddocs %}
 
 {% docs currencies_table %} Table detailing all currency information. {% enddocs %}
@@ -115,4 +117,6 @@
 
 {% docs accounting_book_id %} Unique identifier of the accounting book. {% enddocs %}
 
-{% docs account_type_id %} Unique identifier of thea account type. {% enddocs %}
+{% docs account_type_id %} Unique identifier of thea account type. {% enddocs %}
+
+{% docs customer_category_id %} Unique identifier of the customer category. {% enddocs %}

models/_netsuite__sources.yml

@@ -244,6 +244,19 @@ sources:
           - name: symbol
             description: Currency symbol.
 
+      - name: customer_category
+        identifier: "{{ var('netsuite_customer_category_identifier', 'customercategory') }}"
+        description: "{{ doc('customer_categories_table') }}"
+        config:
+          enabled: "{{ var('netsuite__using_customer_categories', true) }}"
+        columns:
+          - name: id
+            description: "{{ doc('customer_category_id') }}"
+          - name: name
+            description: Name of the customer category.
+          - name: _fivetran_synced
+            description: "{{ doc('_fivetran_synced') }}"
+
       - name: customer
         identifier: "{{ var('netsuite_customer_identifier', 'customer') }}"
         description: "{{ doc('customers_table') }}"
@@ -620,55 +633,78 @@ sources:
 
       - name: employees
         identifier: "{{ var('netsuite_employee_identifier', 'employee') }}"
+
       - name: employee_statuses
         identifier: "{{ var('netsuite_employee_status_identifier', 'employeestatus') }}"
+
       - name: employee_status_categories
         identifier: "{{ var('netsuite_employee_status_category_identifier', 'employeestatuscategory') }}"
+
       - name: employee_types
         identifier: "{{ var('netsuite_employee_type_identifier', 'employeetype') }}"
+
       - name: employee_type_categories
         identifier: "{{ var('netsuite_employee_type_category_identifier', 'employeetypecategory') }}"
+
       - name: item_subtypes
         identifier: "{{ var('netsuite_item_subtype_identifier', 'itemsubtype') }}"
+
       - name: item_types
         identifier: "{{ var('netsuite_item_type_identifier', 'itemtype') }}"
+
       - name: job_resources
         identifier: "{{ var('netsuite_job_resources_identifier', 'jobresources') }}"
+
       - name: job_statuses
         identifier: "{{ var('netsuite_job_status_identifier', 'jobstatus') }}"
+
       - name: job_types
         identifier: "{{ var('netsuite_job_type_identifier', 'jobtype') }}"
+
       - name: project_tasks
         identifier: "{{ var('netsuite_project_task_identifier', 'projecttask') }}"
+
       - name: project_task_assignees
         identifier: "{{ var('netsuite_project_task_assignee_identifier', 'projecttaskassignee') }}"
+
       - name: revenue_elements
         identifier: "{{ var('netsuite_revenue_element_identifier', 'revenueelement') }}"
         tags: ['arm']
+
       - name: revenue_plans
         identifier: "{{ var('netsuite_revenue_plan_identifier', 'revenueplan') }}"
         tags: ['arm']
+
       - name: revenue_plan_planned_costs
         identifier: "{{ var('netsuite_revenue_plan_planned_cost_identifier', 'revenueplanplannedcost') }}"
         tags: ['arm']
+
       - name: revenue_plan_planned_revenue
         identifier: "{{ var('netsuite_revenue_plan_planned_revenue_identifier', 'revenueplanplannedrevenue') }}"
         tags: ['arm']
+
       - name: revenue_plan_statuses
         identifier: "{{ var('netsuite_revenue_plan_status_identifier', 'revenueplanstatus') }}"
         tags: ['arm']
+
       - name: revenue_plan_types
         identifier: "{{ var('netsuite_revenue_plan_type_identifier', 'revenueplantype') }}"
         tags: ['arm']
+
       - name: time_entries
         identifier: "{{ var('netsuite_time_entry_identifier', 'timebill') }}"
+
       - name: time_off_types
         identifier: "{{ var('netsuite_time_off_type_identifier', 'timeofftype') }}"
+
       - name: transaction_sales_teams
         identifier: "{{ var('netsuite_transaction_sales_team_identifier', 'transactionsalesteam') }}"
+
       - name: transaction_statuses
         identifier: "{{ var('netsuite_transaction_status_identifier', 'transactionstatus') }}"
+
       - name: work_calendars
         identifier: "{{ var('netsuite_work_calendar_identifier', 'workcalendar') }}"
+
       - name: work_calendar_holidays
         identifier: "{{ var('netsuite_work_calendar_holiday_identifier', 'workcalendarholiday') }}"

models/_stg_netsuite__models.yml

@@ -224,6 +224,19 @@ models:
       - name: symbol
         description: Currency symbol.
 
+  - name: stg_netsuite__customer_categories
+    description: "{{ doc('customer_categories_table') }}"
+    columns:
+      - name: customer_category_id
+        description: "{{ doc('customer_category_id') }}"
+        tests:
+          - unique
+          - not_null
+      - name: name
+        description: Name of the customer category.
+      - name: _fivetran_synced
+        description: "{{ doc('_fivetran_synced') }}"
+
   - name: stg_netsuite__customers
     description: "{{ doc('customers_table') }}"
     columns:

models/base/base_netsuite__customers.sql

@@ -7,6 +7,11 @@ entity_address as (
 employees as (
     select * from {{ ref('base_netsuite__employees') }}
 ),
+{% if var('netsuite__using_customer_categories', false) %}
+customer_categories as (
+    select * from {{ ref('stg_netsuite__customer_categories') }}
+),
+{% endif %}
 joined as (
 
     select
@@ -19,6 +24,9 @@ joined as (
         sales_rep.employee_name_first_last as sales_rep_name_first_last,
         coalesce(parent_customer.company_name, customers.company_name) as parent_company_name,
         coalesce(parent_customer.customer_name, customers.customer_name) as parent_customer_name
+        {% if var('netsuite__using_customer_categories', false) %}
+        ,customer_categories.customer_category_name
+        {% endif %}
 
     from customers
 
@@ -30,5 +38,9 @@ joined as (
 
     left join customers as parent_customer 
         on parent_customer.customer_id = customers.parent_id
+    {% if var('netsuite__using_customer_categories', false) %}
+    left join customer_categories 
+        on customer_categories.customer_category_id = customers.customer_category_id
+    {% endif %}
 )
 select * from joined

models/stg_netsuite__customer_categories.sql

@@ -0,0 +1,13 @@
+{{ config(enabled=(var('netsuite__using_customer_categories', false))) }}
+
+with source as (
+      select * from {{ var('netsuite_customer_categories') }}
+),
+renamed as (
+    select
+        id as customer_category_id,
+        name as customer_category_name
+
+    from source
+)
+select * from renamed