The tap-intacct extractor pulls data from the Sage Intacct API.

Getting Started #

Prerequisites #

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

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration #

Using the Command Line Interface #

  1. Add the tap-intacct extractor to your project using meltano add:

     meltano add extractor tap-intacct

  2. Configure the settings below using meltano config.

Using Meltano UI #

  1. Start Meltano UI using meltano ui:

     meltano ui
  2. Open the Extractors interface at http://localhost:5000/extractors.
  3. Click the “Add to project” button for “Sage Intacct”.
  4. Configure the settings below in the “Configuration” interface that opens automatically.

Next steps #

Follow the remaining steps of the Getting Started guide:

  1. Select entities and attributes to extract
  2. Add a loader to send data to a destination
  3. Run a data integration (EL) pipeline

If you run into any issues, chat with us in #troubleshooting on Slack.

Settings #

tap-intacct requires the configuration of the following settings:

These and other supported settings are documented below. To quickly find the setting you’re looking for, use the Table of Contents in the sidebar.

Minimal configuration #

A minimal configuration of tap-intacct in your meltano.yml project file will look like this:

plugins:
  extractors:
  - name: tap-intacct
    variant: hotgluexyz
    config:
      company_id: 'example company'
      sender_id: 'example sender'
      user_id: 'example user'
      start_date: '2020-10-01T00:00:00Z'

Sensitive values are most appropriately stored in the environment or your project’s .env file:

export TAP_INTACCT_SENDER_PASSWORD=my_sender_password
export TAP_INTACCT_USER_PASSWORD=my_user_password

Company Id #

Your Intacct Company Id

How to use #

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-intacct set company_id <company id>

export TAP_INTACCT_COMPANY_ID=<company id>

Sender Id #

Your Intacct Sender Id

How to use #

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-intacct set sender_id <sender id>

export TAP_INTACCT_SENDER_ID=<sender id>

Sender Password #

Your Intacct Sender Password

How to use #

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-intacct set sender_password <sender password>

export TAP_INTACCT_SENDER_PASSWORD=<sender password>

User Id #

Your Intacct User Id

How to use #

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-intacct set user_id <user id>

export TAP_INTACCT_USER_ID=<user id>

User Password #

Your Intacct User Password

How to use #

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-intacct set user_password <user password>

export TAP_INTACCT_USER_PASSWORD=<user password>

Start Date #

This property determines how much historical data will be extracted.

Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.

How to use #

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-intacct set start_date YYYY-MM-DDTHH:MM:SSZ

export TAP_INTACCT_START_DATE=YYYY-MM-DDTHH:MM:SSZ

# For example:
meltano config tap-intacct set start_date 2020-10-01T00:00:00Z

export TAP_INTACCT_START_DATE=2020-10-01T00:00:00Z

Select Fields By Default #

  • Name: select_fields_by_default
  • Environment variable: TAP_INTACCT_SELECT_FIELDS_BY_DEFAULT
  • Default: true

Select by default any new fields discovered in Intacct objects

How to use #

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-intacct set select_fields_by_default false

export TAP_INTACCT_SELECT_FIELDS_BY_DEFAULT=false

State Message Threshold #

  • Name: state_message_threshold
  • Environment variable: TAP_INTACCT_STATE_MESSAGE_THRESHOLD
  • Default: 1000

Used to throttle how often STATE messages are generated when the tap is using the “REST” API.

This is a balance between not slowing down execution due to too many STATE messages produced and how many records must be fetched again if a tap fails unexpectedly. Defaults to 1000 (generate a STATE message every 1000 records).

How to use #

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-intacct set state_message_threshold 500

export TAP_INTACCT_STATE_MESSAGE_THRESHOLD=500

Max Workers #

Maximum number of threads to use

How to use #

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-intacct set max_workers 16

export TAP_INTACCT_MAX_WORKERS=16