dbt_netsuite

KO | EN

gitlite — search

#python #hacktoberfest #react #typescript #go #deep-learning #linux #docker #macos #java #windows #cli #pytorch #ios

(★ 56)

Data models for Fivetran's Netsuite connector, built using dbt.

dbt_netsuite 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Netsuite dbt Package

This dbt package transforms data from Fivetran's Netsuite connector into analytics-ready tables.

## Resources

- Number of materialized models¹: 92
- Connector documentation
 - [Netsuite connector documentation](https://fivetran.com/docs/connectors/applications/netsuite-suiteanalytics#netsuitesuiteanalytics)
 - [Netsuite ERD](https://fivetran.com/docs/connectors/applications/netsuite-suiteanalytics#schemainformation)
- dbt package documentation
 - [GitHub repository](https://github.com/fivetran/dbt_netsuite)
 - [dbt Docs](https://fivetran.github.io/dbt_netsuite/#!/overview)
 - [DAG](https://fivetran.github.io/dbt_netsuite/#!/overview?g_v=1)
 - [Changelog](https://github.com/fivetran/dbt_netsuite/blob/main/CHANGELOG.md)
- dbt Core™ supported versions
 - `>=1.3.0, <3.0.0`

## What does this dbt package do?
This package enables you to recreate both the balance sheet and income statement, and recreate commonly used data by using the transaction lines as the base table and joining other data. It creates enriched models with metrics focused on financial statement reporting and deeper transactional analysis.

### Output schema
Final output tables are generated in the following target schema:

```
<your_database>.<connector/schema_name>_netsuite
```

### Final output tables

By default, this package materializes the following final tables:

| Table | Description |
| :---- | :---- |
| [netsuite2__balance_sheet](https://fivetran.github.io/dbt_netsuite/#!/model/model.netsuite.netsuite2__balance_sheet) | All transaction lines necessary to generate a balance sheet with proper currency conversion for the parent subsidiary. The model categorizes non-balance sheet transactions as Retained Earnings or Net Income, with manual calculation of Cumulative Translation Adjustment. Data is output at the transaction line grain by default, and aggregated when `netsuite2__aggregate_balance_sheet` is set to `true`. **Example Analytics Questions:**<ul><li>What is our current cash position and working capital across subsidiaries?</li><li>How has our debt-to-equity ratio changed over the past year?</li><li>How have retained earnings and total equity evolved across accounting periods?</li></ul> |
| [netsuite2__income_statement](https://fivetran.github.io/dbt_netsuite/#!/model/model.netsuite.netsuite2__income_statement) | All transaction lines needed for income statement generation with currency conversion and department, class, and location details. Data is output at the transaction line grain by default, and aggregated when `netsuite2__aggregate_income_statement` is set to `true`. **Example Analytics Questions:**<ul><li>What is our gross margin by product line, department, or location?</li><li>How has operating income changed quarter over quarter?</li><li>Which expense categories are growing the fastest this period?</li></ul> |
| [netsuite2__transaction_details](https://fivetran.github.io/dbt_netsuite/#!/model/model.netsuite.netsuite2__transaction_details) | Comprehensive transaction-level view combining transaction lines with detailed context including accounting period, account, subsidiary, customer, vendor, location, item, and department information. **Example Analytics Questions:**<ul><li>Which customers or vendors generate the highest transaction volumes?</li><li>What are the most common transaction types by subsidiary or department?</li><li>Which accounts show the largest transaction fluctuations month over month?</li></ul> |
| [netsuite2__entity_subsidiary_relationships](https://fivetran.github.io/dbt_netsuite/#!/model/model.netsuite.netsuite2__entity_subsidiary_relationships) | Unified view of customer and vendor relationships across subsidiaries, showing which entities operate in which subsidiaries with primary subsidiary designations and currency details. **Example Analytics Questions:**<ul><li>Which customers operate across multiple subsidiaries?</li><li>What currencies are most commonly used by our entities?</li><li>Which subsidiaries have the most vendor relationships?</li></ul> |

¹ 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`.

---

## Visualizations

Many of the above reports are now configurable for [visualization via Streamlit](https://github.com/fivetran/streamlit_netsuite). Check out some [sample reports here](https://fivetran-netsuite.streamlit.app/).

## Prerequisites
To use this dbt package, you must have the following:

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

## How do I use the dbt package?
You can either add this dbt package in the Fivetran dashboard or import it into your dbt project:

- To add the package in the Fivetran dashboard, follow our [Quickstart guide](https://fivetran.com/docs/transformations/data-models/quickstart-management).
- To add the package to your dbt project, follow the setup instructions in the dbt package's [README file](https://github.com/fivetran/dbt_netsuite/blob/main/README.md#how-do-i-use-the-dbt-package) to use this package.

To use this dbt package, you must have at least one Fivetran **Netsuite** (netsuite.com) or **Netsuite2** (netsuite2) connection syncing the respective tables to your destination:

#### Netsuite.com
- accounts
- accounting_periods
- accounting_books
- consolidated_exchange_rates
- currencies
- customers
- classes
- departments
- expense_accounts
- income_accounts
- items
- locations
- partners
- transaction_lines
- transactions
- subsidiaries
- vendors
- vendor_types

#### Netsuite2
- account
- accountingperiod
- currency
- customer
- transactionaccountingline
- transactionline
- transaction
- subsidiary
- vendor
- **Not required but recommended**:
  - accounttype
  - accountingbook
  - accountingbooksubsidiary
  - accountingperiodfiscalcalendar
  - accountingbook
  - classification
  - consolidatedexchangerate
  - department
  - entity
  - entityaddress
  - fiscalcalendar (required for non–January 1 fiscal year start)
  - item
  - job
  - location
  - locationmainaddress
  - nexus
  - vendorcategory
  - vendorsubsidiaryrelationship

> All required sources and staging models are now bundled into this transformation package. Do not include `fivetran/netsuite_source` in your `packages.yml` since this package has been deprecated.

### Install the package
Include the following netsuite 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
packages:
 - package: fivetran/netsuite
 version: [">=1.7.0", "<1.8.0"]
```

#### 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:
  - macro_namespace: dbt_utils
    search_order: ['spark_utils', 'dbt_utils']
```

### Define Netsuite.com or Netsuite2 Source
As of April 2022 Fivetran released a new Netsuite connector version which leverages the Netsuite2 endpoint opposed to the original Netsuite.com endpoint. This package is designed to run for either or, not both. By default the `netsuite_data_model` variable for this package is set to the original `netsuite` value which runs the netsuite.com version of the package. If you would like to run the package on Netsuite2 data, you may adjust the `netsuite_data_model` variable to run the `netsuite2` version of the package.
```yml
vars:
    netsuite_data_model: netsuite2 #netsuite by default
```

> The `netsuite_data_model` variable is automatically configured for Fivetran Quickstart users.

### Define database and schema variables
#### Option A: Single connection
By default, this package runs using your destination and the `netsuite` schema. If this is not where your Netsuite data is (for example, if your Netsuite schema is named `netsuite_fivetran`), add the following configuration to your root `dbt_project.yml` file:

```yml
vars:
    netsuite_database: your_destination_name
    netsuite_schema: your_schema_name
```

#### Option B: Union multiple connections (Netsuite2 only)
If you have multiple Netsuite2 connections in Fivetran and would like to use this package on all of them simultaneously, we have provided functionality to do so. For each source table, the package will union all of the data together and pass the unioned table into the transformations. The `source_relation` column in each model indicates the origin of each record.

To use this functionality, you will need to set the `netsuite2_sources` variable in your root `dbt_project.yml` file:

```yml
# dbt_project.yml

vars:
  netsuite2_sources:
    - database: connection_1_destination_name # Required
      schema: connection_1_schema_name # Required
      name: connection_1_source_name # Required only if following the step in the following subsection

- database: connection_2_destination_name
      schema: connection_2_schema_name
      name: connection_2_source_name
```

#### Optional: Incorporate unioned sources into DAG

If you use [Fivetran Transformations for dbt Core™](https://fivetran.com/docs/transformations/dbt#transformationsfordbtcore) and are unioning multiple Netsuite connections, you can define your sources in a property `.yml` file, [using this as a template](https://github.com/fivetran/dbt_netsuite/blob/main/models/netsuite2/staging/src_netsuite.yml). Set the variable `has_defined_sources: true` under the Netsuite namespace in your `dbt_project.yml`. Otherwise, your Netsuite connections won't appear in your DAG. See the `union_connections` macro [documentation](https://github.com/fivetran/dbt_fivetran_utils/tree/releases/v0.4.latest#optional-union-connections-defined-sources-configuration) for full configuration details.

### Disable models for non-existent sources (Netsuite2 only)

> _This step is unnecessary (but still available for use) if you are unioning multiple connectors together in the previous step. That is, the `union_data` macro we use will create completely empty staging models for sources that are not found in any of your Netsuite2 schemas/databases. However, you can still leverage the below variables if you would like to avoid this behavior._

Your Netsuite connection may not sync every table that this package expects. If your syncs exclude certain tables, it is because you either don't use that feature in Netsuite or actively excluded some tables from your syncs. To disable the corresponding functionality in the package, you must add the relevant variables. By default, most variables are assumed to be true with the exception of `netsuite2__fiscal_calendar_enabled`. Add variables for only the tables you would like to disable/enable:
```yml
vars:
    # Features
    netsuite2__fiscal_calendar_enabled: true # False by default. Enable `fiscalcalendar` if you have a fiscal year starting on a month different than January.
    netsuite2__multibook_accounting_enabled: true # False by default. Disable `accountingbooksubsidiary` and `accountingbook` if you are not using the Multi-Book Accounting feature

# Sources
    netsuite2__using_employees: false # True by default. Disable `employee` if you don't use employees.
    netsuite2__using_exchange_rate: false #True by default. Disable `exchange_rate` if you don't utilize exchange rates.
    netsuite2__using_jobs: false # True by default. Disable `job` if you don't use jobs
    netsuite2__using_vendor_categories: false # True by default. Disable `vendorcategory` if you don't categorize your vendors
    netsuite2__using_customer_subsidiary_relationships: false # True by default. Disable `customersubsidiaryrelationships` if you don't use this table
    netsuite2__using_vendor_subsidiary_relationships: false # True by default. Disable `vendorsubsidiaryrelationships` if you don't use this table
```
> **Note**: The Netsuite dbt package currently only supports disabling of the previously listed source tables. Please create an issue to request additional tables and/or [features](https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/bridgehead_N233872.html) to exclude.
>
> To determine if a table or field is activated by a feature, access the [Records Catalog](https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/article_159367781370.html).

## (Optional) Additional configurations
<details open><summary>Expand/collapse configurations</summary>

#### Enable additional features

##### Multi-Book (Netsuite2 only)
To include `accounting_book_id` and `accounting_book_name` columns in the end models, set the below variable to `true` in your `dbt_project.yml`. This feature is disabled by default.
> **Note**: The Netsuite dbt package currently only supports disabling of the source tables listed above. Please create an issue to request additional tables and/or [features](https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/bridgehead_N233872.html) to exclude.
>Notes:
> - If you choose to enable this feature, this adds rows for transactions for any non-primary `accounting_book_id`, and your downstream use cases may need to be adjusted.
> - The surrogate keys for the end models are dynamically generated depending on the enabled/disabled features, so adding these rows will not cause test failures.
> - If you are leveraging a `*_pass_through_columns` variable to include the added columns, you may need to remove them to avoid a duplicate column error.
```yml
vars:
    netsuite2__multibook_accounting_enabled: true # False by default.
```

**IMPORTANT**: If you are using multi-book accounting, this variable must be set to true, or you see test failures in your data.

##### To Subsidiary (Netsuite2 only)
To include `to_subsidiary_id` and `to_subsidiary_name` columns in the end models, set the below variable to `true` in your `dbt_project.yml`. This feature is disabled by default. You also need to be using exchange rates, which is enabled by default.

>Notes:
> - If you choose to enable this feature, this adds rows for transactions where `to_subsidiary` is not a top-level subsidiary. Your downstream use cases may need to be adjusted.
> - The surrogate keys for the end models are dynamically generated depending on the enabled/disabled features, so adding these rows will not cause test failures.
> - If you are leveraging a `*_pass_through_columns` variable to include the added columns, you may need to remove them to avoid a duplicate column error.

```yml
vars:
    netsuite2__using_to_subsidiary: true # False by default.
```

#### Passing Through Additional Fields
This package includes all source columns defined in the macros folder. To add additional columns to this package, do so by adding our pass-through column variables to your `dbt_project.yml` file:

```yml
vars:
    accounts_pass_through_columns: # Included in all end models
        - name: "new_custom_field"
          alias: "custom_field"
    classes_pass_through_columns: # Included in income_statement model
        - name: "this_field"
    customers_pass_through_columns: # Included in transaction_details model
        - name: "customer_custom_field"
          alias: "customer_field"
    items_pass_through_columns: # Included in transaction_details model
        - name: "items_custom_field"
    departments_pass_through_columns: # Included in income_statement and transaction_details models
        - name: "unique_string_field"
          alias: "field_id"
          transform_sql: "cast(field_id as string)"
    transactions_pass_through_columns: # Included in transaction_details model
        - name: "that_field"
    transaction_lines_pass_through_columns: # Included in transaction_details model
        - name: "other_id"
          alias: "another_id"
          transform_sql: "cast(another_id as int64)"
    locations_pass_through_columns: # Included in transaction_details model
        - name: "location_custom_field"
    subsidiaries_pass_through_columns: # Included in transaction_details model
        - name: "sub_field"
          alias: "subsidiary_field"
    consolidated_exchange_rates_pass_through_columns: # Not included in end models; only in stg consolidated_exchange_rates model
        - name: "consolidate_this_field"
    entities_pass_through_columns: # Not included in end models; only in stg entities model
        - name: "entity_custom_field"
          alias: "entity_field"
    accounting_periods_pass_through_columns: # Not included in end models; only in stg accounting_periods model
        - name: "custom_field"
          transform_sql: "cast(custom_field as string)"
    vendors_pass_through_columns: # Not included in end models; only in stg vendors model
        - name: "vendors_custom_field"
          alias: "vendors_field"
    nexuses_pass_through_columns: # Not included in end models; only in stg nexuses model
        - name: "items_custom_field"
```

> If you would like any of the above passthrough columns to be persisted to additional downstream models (i.e. `netsuite2__income_statement`, `netsuite2__balance_sheet`, `netsuite2__transaction_details`), or passthrough column support for other source tables, please create a Feature Request [issue](https://github.com/fivetran/dbt_netsuite/issues).

#### Passing Through Transaction Detail Fields
Additionally, this package allows users to pass columns from the `netsuite__transaction_details` table into
the `netsuite__balance_sheet` and `netsuite__income_statement` tables. See below for an example
of how to passthrough transaction detail columns into the respective balance sheet and income statement final tables
within your `dbt_project.yml` file.

```yml
vars:
    balance_sheet_transaction_detail_columns: ['company_name','vendor_name']
    income_statement_transaction_detail_columns: ['is_account_intercompany','location_name']
```

#### Transaction-Level vs Aggregated Balance Sheet and Income Statement (Netsuite2 only)
By default, `netsuite2__balance_sheet` and `netsuite2__income_statement` output one row per transaction line and include the `transaction_id` and `transaction_line_id` columns. Depending on your dataset, this may be a large volume of data, making full refresh runs cumbersome. Routine full refreshes are highly encouraged due to potential data drift caused by retroactively deleted and/or updated transactions.

To reduce runtime and/or compute, you may aggregate these models and remove transactions and transaction lines from their granularity by setting their respective variables to `true` in your `dbt_project.yml`:

```yml
vars:
    netsuite2__aggregate_balance_sheet: true # False by default. Set to true to roll up netsuite2__balance_sheet to the account/period/subsidiary/account_category grain
    netsuite2__aggregate_income_statement: true # False by default. Set to true to roll up netsuite2__income_statement to the account/period/subsidiary/department/location/class grain
```

**Limitations:**
* When aggregated, `netsuite2__balance_sheet` and `netsuite2__income_statement` will materialize as tables rather than incrementally.
* Any columns passed via `balance_sheet_transaction_detail_columns` or `income_statement_transaction_detail_columns` are ignored, since those require transaction-level granularity.

#### Adding incremental materialization for Bigquery and Databricks
Since pricing and runtime priorities vary by customer, by default we chose to materialize the below models as tables instead of an incremental materialization for Bigquery and Databricks. For more information on this decision, see the [Incremental Strategy section](https://github.com/fivetran/dbt_netsuite/blob/main/DECISIONLOG.md#incremental-strategy) of the DECISIONLOG.

If you wish to enable incremental materializations leveraging the `merge` strategy, you can add the below materialization settings to your `dbt_project.yml` file. You only need to add lines for the specific model materializations you wish to change.
```yml
models:
  netsuite:
    netsuite2:
      netsuite2__income_statement:
        +materialized: incremental # default is table for Bigquery and Databricks
      netsuite2__transaction_details:
        +materialized: incremental # default is table for Bigquery and Databricks
      netsuite2__balance_sheet:
        +materialized: incremental # default is table for Bigquery and Databricks
```

##### Lookback Window
Records from the source can sometimes arrive late. On incremental runs, we look back 3 days from the `_fivetran_synced_date` of transaction records to capture late arrivals and reduce the need for frequent full refreshes. We recommend running `dbt --full-refresh` periodically to maintain data quality.

To change the default lookback window, add the following variable to your `dbt_project.yml` file:

```yml
vars:
  netsuite:
    lookback_window: number_of_days # default is 3
```

#### Change the build schema
By default, this package builds the Netsuite staging models within a schema titled (`<target_schema>` + `_netsuite_source`) and your Netsuite modeling models within a schema titled (`<target_schema>` + `_netsuite`) in your destination. If this is not where you would like your Netsuite data to be written to, add the following configuration to your root `dbt_project.yml` file:

```yml
models:
    netsuite:
      +schema: my_new_schema_name # Leave +schema: blank to use the default target_schema.
      netsuite2: # if you're using netsuite2.com
        staging:
            +schema: my_new_schema_name # Leave +schema: blank to use the default target_schema.
      netsuite: # if you're using netsuite.com
        staging:
            +schema: my_new_schema_name # Leave +schema: blank to use the default target_schema.
```

#### 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_netsuite/blob/main/dbt_project.yml) variable declarations to see the expected names.

```yml
vars:
 # For all Netsuite source tables
 netsuite_<default_source_table_name>_identifier: your_table_name

# For all Netsuite2 source tables
 netsuite2_<default_source_table_name>_identifier: your_table_name 
```

#### Source casing for case-sensitive destinations
By default, the package applies case-insensitive comparisons when resolving `source_relation` values. If your destination is case-sensitive and you want downstream transformations to respect the exact casing of your source database and schema names, set the following variable:

```yml
vars:
    fivetran_using_source_casing: true
```

#### Override the data models variable
This package is designed to run **either** the Netsuite.com or Netsuite2 data models. However, for documentation purposes, an additional variable `netsuite_data_model_override` was created to allow for both data model types to be run at the same time by setting the variable value to `netsuite`. This is only to ensure the [dbt docs](https://fivetran.github.io/dbt_netsuite/) (which is hosted on this repository) is generated for both model types. While this variable is provided, we recommend you do not adjust the variable and instead change the `netsuite_data_model` variable to fit your configuration needs.

</details>

### (Optional) Produce Analytics-Ready Reports with Streamlit App (Bigquery and Snowflake users only)
For those who want to take their reports a step further, our team has created the [Fivetran Netsuite Streamlit App](https://fivetran-netsuite.streamlit.app/) to generate end model visualizations based off of the reports we created in this package.  This way you can replicate much of the reporting you see internally in Netsuite and automate a lot of the work needed to report on your core metrics.

[We recommend following the instructions here](https://github.com/fivetran/streamlit_netsuite) to fork the app for your own data and create end reports leveraging our Netsuite models. You can see a sample version of [these reports here](https://fivetran-netsuite.streamlit.app/).

### (Optional) Orchestrate your models with Fivetran Transformations for dbt Core™
<details><summary>Expand for details</summary>

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).

</details>

## 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
packages:
 - package: fivetran/fivetran_utils
 version: [">=0.4.0", "<0.5.0"]

- package: dbt-labs/dbt_utils
 version: [">=1.0.0", "<2.0.0"]

- package: dbt-labs/spark_utils
 version: [">=0.3.0", "<0.4.0"]
```

## How is this package maintained and can I contribute?

### Package Maintenance
The Fivetran team maintaining this package only maintains the [latest version](https://hub.getdbt.com/fivetran/netsuite/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_netsuite/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.

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).

## 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_netsuite/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).

dbt_netsuite

dbt_netsuite 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

dbt_netsuite

dbt_netsuite 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README