tap-erpnext - Meltano Hub

Erpnext

Meltano Community

tap-erpnext (adriaan90 variant)

Open source connector supported by the Meltano Community, a growing community of over 5500+ data engineers.

Open source Join Slack community

The tap-erpnext extractor pulls data from Erpnext that can then be sent to a destination using a loader.

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

Installation and configuration

Add the tap-erpnext extractor to your project using
```
meltano add
```
:

meltano add tap-erpnext

Configure the tap-erpnext settings using

meltano config

:

meltano config tap-erpnext set --interactive

Test that extractor settings are valid using

meltano config

:

meltano config tap-erpnext test

Next steps

Follow the remaining steps of the Getting Started guide:

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-erpnext may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

about
activate-version
batch
catalog
discover
schema-flattening
state
stream-maps
structured-logging

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-erpnext settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

api_key
api_secret
api_url
doctypes
flattening_max_key_length
flattening_separator
limit_page_length
start_date

Expand To Show SDK Settings

batch_config.encoding.compression
batch_config.encoding.format
batch_config.storage.prefix
batch_config.storage.root
faker_config.locale
faker_config.seed
flattening_enabled
flattening_max_depth
stream_map_config
stream_maps

You can also list these settings using

meltano config

with the list subcommand:

meltano config tap-erpnext list

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

API Key (api_key)

Environment variable: TAP_ERPNEXT_API_KEY

ERPNext API key

Configure this setting directly using the following Meltano command:

meltano config tap-erpnext set api_key [value]

API Secret (api_secret)

Environment variable: TAP_ERPNEXT_API_SECRET

ERPNext API secret

Configure this setting directly using the following Meltano command:

meltano config tap-erpnext set api_secret [value]

API URL (api_url)

Environment variable: TAP_ERPNEXT_API_URL

The base URL of the ERPNext instance (e.g. https://erp.example.com)

Configure this setting directly using the following Meltano command:

meltano config tap-erpnext set api_url [value]

Doctypes (doctypes)

Environment variable: TAP_ERPNEXT_DOCTYPES

Specific DocType names to sync. If omitted, all accessible DocTypes are discovered.

Configure this setting directly using the following Meltano command:

meltano config tap-erpnext set doctypes [value]

Max Key Length (flattening_max_key_length)

Environment variable: TAP_ERPNEXT_FLATTENING_MAX_KEY_LENGTH

The maximum length of a flattened key.

Configure this setting directly using the following Meltano command:

meltano config tap-erpnext set flattening_max_key_length [value]

Flattening Separator (flattening_separator)

Environment variable: TAP_ERPNEXT_FLATTENING_SEPARATOR

The separator to use when flattening keys.

Configure this setting directly using the following Meltano command:

meltano config tap-erpnext set flattening_separator [value]

Page Length (limit_page_length)

Environment variable: TAP_ERPNEXT_LIMIT_PAGE_LENGTH
Default Value: 200

Number of records to fetch per API request

Configure this setting directly using the following Meltano command:

meltano config tap-erpnext set limit_page_length [value]

Start Date (start_date)

Environment variable: TAP_ERPNEXT_START_DATE

The earliest record date to sync

Configure this setting directly using the following Meltano command:

meltano config tap-erpnext set start_date [value]

Expand To Show SDK Settings

Batch Compression Format (batch_config.encoding.compression)

Environment variable: TAP_ERPNEXT_BATCH_CONFIG_ENCODING_COMPRESSION

Compression format to use for batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-erpnext set batch_config encoding.compression [value]

Batch Encoding Format (batch_config.encoding.format)

Environment variable: TAP_ERPNEXT_BATCH_CONFIG_ENCODING_FORMAT

Format to use for batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-erpnext set batch_config encoding.format [value]

Batch Storage Prefix (batch_config.storage.prefix)

Environment variable: TAP_ERPNEXT_BATCH_CONFIG_STORAGE_PREFIX

Prefix to use when writing batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-erpnext set batch_config storage.prefix [value]

Batch Storage Root (batch_config.storage.root)

Environment variable: TAP_ERPNEXT_BATCH_CONFIG_STORAGE_ROOT

Root path to use when writing batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-erpnext set batch_config storage.root [value]

Faker Locale (faker_config.locale)

Environment variable: TAP_ERPNEXT_FAKER_CONFIG_LOCALE

One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization

Configure this setting directly using the following Meltano command:

meltano config tap-erpnext set faker_config locale [value]

Faker Seed (faker_config.seed)

Environment variable: TAP_ERPNEXT_FAKER_CONFIG_SEED

Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator

Configure this setting directly using the following Meltano command:

meltano config tap-erpnext set faker_config seed [value]

Enable Schema Flattening (flattening_enabled)

Environment variable: TAP_ERPNEXT_FLATTENING_ENABLED

'True' to enable schema flattening and automatically expand nested properties.

Configure this setting directly using the following Meltano command:

meltano config tap-erpnext set flattening_enabled [value]

Max Flattening Depth (flattening_max_depth)

Environment variable: TAP_ERPNEXT_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.

Configure this setting directly using the following Meltano command:

meltano config tap-erpnext set flattening_max_depth [value]

User Stream Map Configuration (stream_map_config)

Environment variable: TAP_ERPNEXT_STREAM_MAP_CONFIG

User-defined config values to be used within map expressions.

Configure this setting directly using the following Meltano command:

meltano config tap-erpnext set stream_map_config [value]

Stream Maps (stream_maps)

Environment variable: TAP_ERPNEXT_STREAM_MAPS

Config object for stream maps capability. For more information check out Stream Maps.

Configure this setting directly using the following Meltano command:

meltano config tap-erpnext set stream_maps [value]

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-erpnext extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the

#plugins-general

channel.

Meltano Cloud

For ambitious analytics engineering teams that want an efficient, fully managed solution with personalised expert support, explore Meltano Cloud

No maintenance overhead
Rigorously tested
Expert support from Meltano

Learn more Book a demo

Install

meltano add
                tap-erpnext

Maintenance Status

Repo

https://github.com/adriaan90/tap-erpnext

Maintainer

Keywords