Skip to content

Latest commit

 

History

History
157 lines (118 loc) · 3.37 KB

README.md

File metadata and controls

157 lines (118 loc) · 3.37 KB
Raw

tap-workato

tap-workato is a Singer tap for Workato.

Built with the Meltano Tap SDK for Singer Taps.

Installation

This tap is installable via pypi

pipx install tap-workato

Or, if using via Meltano you can add configuration like so in the meltano.yml file:

plugins:
  extractors:
  - name: tap-workato
    namespace: tap_workato
    pip_url: -e .
    capabilities:
    - state
    - catalog
    - discover
    settings:
    - name: user_token
      kind: password
    - name: user_email
      kind: password

and then run the following from the CLI:

meltano install extractor tap-workato

Configuration

Accepted Config Options

A full list of supported settings and capabilities for this tap is available by running:

tap-workato --about

Available streams include:

  • api_clients
  • api_collection
  • connections
  • customer_accounts *
  • customer_api_access_profiles *
  • customer_api_clients *
  • customer_api_collections *
  • customer_api_endpoints *
  • customer_connections *
  • customer_connections *
  • customer_members *
  • customer_recipes *
  • customer_roles *
  • folders
  • jobs
  • on_prem_agents
  • on_prem_groups
  • recipes
  • roles

Notes:

  • * The endpoints utilized by these streams are Embedded Vendor APIs and require the oem_vendor privilege in Workato.
  • The workato Embedded API does not allow for extracting customer jobs data at this time.

Source Authentication and Authorization

You will need authentication tokens set up in your Workato account. Namely a user email and a user token. See the instructions here.

Usage

You can easily run tap-workato by itself or in a pipeline using Meltano.

Executing the Tap Directly

tap-workato --version
tap-workato --help
tap-workato --config CONFIG --discover > ./catalog.json

Developer Resources

Initialize your Development Environment

pipx install poetry
poetry install

Create and Run Tests

Create tests within the tap_workato/tests subfolder and then run:

poetry run pytest

You can also test the tap-workato CLI interface directly using poetry run:

poetry run tap-workato --help

Other useful workflows are included in the tox.ini:

poetry run tox -e format
poetry run tox -e lint
poetry run tox -e pytest

Testing with Meltano

Note: This tap will work in any Singer environment and does not require Meltano. Examples here are for convenience and to streamline end-to-end orchestration scenarios.

Your project comes with a custom meltano.yml project file already created. Open the meltano.yml and follow any "TODO" items listed in the file.

Next, install Meltano (if you haven't already) and any needed plugins:

# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-workato
meltano install

Now you can test and orchestrate using Meltano:

# Test invocation:
meltano invoke tap-workato --version
# OR run a test `elt` pipeline:
meltano elt tap-workato target-jsonl

SDK Dev Guide

See the dev guide for more instructions on how to use the SDK to develop your own taps and targets.