symon-ai/tap-workday-raas

tap-workday-raas

Singer tap that extracts data from a Workday report and produces JSON-formatted data following the Singer spec.

$ mkvirtualenv -p python3 tap-workday-raas
$ pip install tap-workday-raas
$ tap-workday-raas --config config.json --discover
$ tap-workday-raas --config config.json --properties properties.json --state state.json

Quickstart

Ensure poetry is installed on your machine.

• This command will return the installed version of poetry if it is installed.

poetry --version

• If not, install poetry using the following commands (from https://python-poetry.org/docs/#installation):

curl -sSL https://install.python-poetry.org | python3 -
PATH=~/.local/bin:$PATH

Within the tap-workday-raas directory, install dependencies:

poetry install

Then run the tap:

poetry run tap-workday-raas <options>

Create Config

Create your tap's config.json file. The tap config file for this tap should include these entries:

• username - The username of the workday account with access to the reports to extract
• password - The password of the workday account with access to the reports to extract
• reports - An array containing a list of objects containing the report_name and report_url. report_name is the name of the stream for the report, and the report_url is the URL to the Workday XML REST link for the report you wish to extract.

{
    "username": "<username>",
    "password": "<password>",
    "reports": [{"report_name": "abitrary_name", "report_url": "https://..."},]
}

Run Discovery

To run discovery mode, execute the tap with the config file.

> tap-workday-raas --config config.json --discover > properties.json

Sync Data

To sync data, select fields in the properties.json output and run the tap.

> tap-workday-raas --config config.json --properties properties.json [--state state.json]

Copyright © 2020 Stitch