Service Titan

tap-service-titan (archdotdev variant)🥇

Service Titan is a software platform for commercial and residential trades

The tap-service-titan extractor pulls data from Service Titan 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:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the tap-service-titan extractor to your project using 
    meltano add
     : 
    2. meltano add extractor tap-service-titan
  2. Configure the tap-service-titan settings using 
    meltano config
     : 
    3. meltano config tap-service-titan set --interactive
  3. Test that extractor settings are valid using 
    meltano config
     : 
    4. meltano config tap-service-titan test

Next steps

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

Capabilities

The current capabilities for tap-service-titan 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
  • batch
  • catalog
  • discover
  • schema-flattening
  • state
  • stream-maps

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

Settings

The tap-service-titan 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:

You can also list these settings using 

meltano config
with the list subcommand: 

meltano config tap-service-titan 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 URL (api_url)

  • Environment variable: TAP_SERVICE_TITAN_API_URL
  • Default Value: https://api-integration.servicetitan.io

The url for the ServiceTitan API


Configure this setting directly using the following Meltano command:

meltano config tap-service-titan set api_url [value]

Auth URL (auth_url)

  • Environment variable: TAP_SERVICE_TITAN_AUTH_URL
  • Default Value: https://auth-integration.servicetitan.io/connect/token

The url for the ServiceTitan OAuth API


Configure this setting directly using the following Meltano command:

meltano config tap-service-titan set auth_url [value]

Client ID (client_id)

  • Environment variable: TAP_SERVICE_TITAN_CLIENT_ID

The client ID to use in authenticating.


Configure this setting directly using the following Meltano command:

meltano config tap-service-titan set client_id [value]

Client Secret (client_secret)

  • Environment variable: TAP_SERVICE_TITAN_CLIENT_SECRET

The client secret to use in authenticating.


Configure this setting directly using the following Meltano command:

meltano config tap-service-titan set client_secret [value]

Custom Reports (custom_reports)

  • Environment variable: TAP_SERVICE_TITAN_CUSTOM_REPORTS

Custom reports to extract.


Configure this setting directly using the following Meltano command:

meltano config tap-service-titan set custom_reports [value]

St App Key (st_app_key)

  • Environment variable: TAP_SERVICE_TITAN_ST_APP_KEY

The app key for the Service Titan app used to authenticate.


Configure this setting directly using the following Meltano command:

meltano config tap-service-titan set st_app_key [value]

Start Date (start_date)

  • Environment variable: TAP_SERVICE_TITAN_START_DATE

The start date for the records to pull.


Configure this setting directly using the following Meltano command:

meltano config tap-service-titan set start_date [value]

Tenant ID (tenant_id)

  • Environment variable: TAP_SERVICE_TITAN_TENANT_ID

Tenant ID to pull records for.


Configure this setting directly using the following Meltano command:

meltano config tap-service-titan set tenant_id [value]
Expand To Show SDK Settings

Batch Config Encoding Compression (batch_config.encoding.compression)

  • Environment variable: TAP_SERVICE_TITAN_BATCH_CONFIG_ENCODING_COMPRESSION

Compression format to use for batch files.


Configure this setting directly using the following Meltano command:

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

Batch Config Encoding Format (batch_config.encoding.format)

  • Environment variable: TAP_SERVICE_TITAN_BATCH_CONFIG_ENCODING_FORMAT

Format to use for batch files.


Configure this setting directly using the following Meltano command:

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

Batch Config Storage Prefix (batch_config.storage.prefix)

  • Environment variable: TAP_SERVICE_TITAN_BATCH_CONFIG_STORAGE_PREFIX

Prefix to use when writing batch files.


Configure this setting directly using the following Meltano command:

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

Batch Config Storage Root (batch_config.storage.root)

  • Environment variable: TAP_SERVICE_TITAN_BATCH_CONFIG_STORAGE_ROOT

Root path to use when writing batch files.


Configure this setting directly using the following Meltano command:

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

Faker Config Locale (faker_config.locale)

  • Environment variable: TAP_SERVICE_TITAN_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-service-titan set faker_config locale [value]

Faker Config Seed (faker_config.seed)

  • Environment variable: TAP_SERVICE_TITAN_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-service-titan set faker_config seed [value]

Flattening Enabled (flattening_enabled)

  • Environment variable: TAP_SERVICE_TITAN_FLATTENING_ENABLED

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


Configure this setting directly using the following Meltano command:

meltano config tap-service-titan set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

  • Environment variable: TAP_SERVICE_TITAN_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.


Configure this setting directly using the following Meltano command:

meltano config tap-service-titan set flattening_max_depth [value]

Stream Map Config (stream_map_config)

  • Environment variable: TAP_SERVICE_TITAN_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-service-titan set stream_map_config [value]

Stream Maps (stream_maps)

  • Environment variable: TAP_SERVICE_TITAN_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-service-titan 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-service-titan 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.

Install

meltano add extractor tap-service-titan

Maintenance Status

  • Maintenance Status
  • Built with the Meltano SDK

Repo

https://github.com/archdotdev/tap-service-titan
  • Stars
  • Forks
  • Last Commit Date
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • archdotdev

Keywords

  • meltano_sdk