Harvest Forecast (v1.0) | Stitch Documentation

Harvest Forecast is supported by the Singer community
This integration is powered by Singer's Harvest Forecast tap. For support, visit the GitHub repo or join the Singer Slack.

Harvest Forecast integration summary

Stitch’s Harvest Forecast integration replicates data using the Harvest Forecast Experimental API. Refer to the Schema section for a list of objects available for replication.

Harvest Forecast feature snapshot

A high-level look at Stitch's Harvest Forecast integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release Status	Released	Supported By	Singer Community
Stitch Plan	Free	Singer GitHub Repository	Harvest Forecast Repository
DATA SELECTION
Table Selection	Unsupported	Column Selection	Unsupported
REPLICATION SETTINGS
Anchor Scheduling	Supported	Advanced Scheduling	Unsupported
Table-level Reset	Unsupported	Configurable Replication Methods	Unsupported
TRANSPARENCY
Extraction Logs	Supported	Loading Reports	Supported

Connecting Harvest Forecast

Harvest Forecast setup requirements

To set up Harvest Forecast in Stitch, you need:

A Harvest account with access to Harvest Forecast. Your Harvest ID will be used to authorize the integration using OAuth.

Step 1: Add Harvest Forecast as a Stitch data source

Sign into your Stitch account.
On the Stitch Dashboard page, click the Add Integration button.
Click the Harvest Forecast icon.
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

For example, the name “Stitch Harvest Forecast” would create a schema called stitch_harvest_forecast in the destination. Note: Schema names cannot be changed after you save the integration.
Enter your Harvest Forecast account ID in the Harvest Forecast Account ID field. For example: If your Harvest Forecast account shows the URL as forecastapp.com/123456/schedule/projects, you’d enter 123456 in this field.

Step 2: Define the historical sync

The Sync Historical Data setting will define the starting date for your Harvest Forecast integration. This means that data equal to or newer than this date will be replicated to your data warehouse.

Change this setting if you want to replicate data beyond Harvest Forecast’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.

Step 3: Create a replication schedule

Replication schedules affect the time Extraction begins, not the time to data loaded. Refer to the Replication Scheduling documentation for more information.

In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

Harvest Forecast integrations support the following replication scheduling methods:

To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.

Step 4: Authorize Stitch to Access Harvest Forecast

Lastly, you’ll be directed to Harvest’s website to complete the setup.

If not already logged into Harvest Forecast, enter your credentials and click Sign In.
A screen asking for authorization to Forecast will display. Note that Stitch will only ever read your data.
Click Connect.
After the authorization process successfully completes, you’ll be redirected back to Stitch.
Click All Done.

Initial and historical replication jobs

After you finish setting up Harvest Forecast, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.

Initial replication jobs with Anchor Scheduling

If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.

Replication will continue after the seven days are over. If you’re no longer interested in this source, be sure to pause or delete the integration to prevent unwanted usage.

Harvest Forecast table schemas

Table and column names in your destination

Depending on your destination, table and column names may not appear as they are outlined below.

For example: Object names are lowercased in Redshift (CusTomERs > customers), while case is maintained in PostgreSQL destinations (CusTomERs > CusTomERs). Refer to the Loading Guide for your destination for more info.

assignments

View table schema on GitHub

Replication Method :	Key-based Incremental	Replication Key :	updated_at
Primary Key :	id

The assignments table contains info about the assignments assigned to the people in your Harvest Forecast account.

assignments table schema

id
INTEGER

The assignment ID.

updated_at
STRING

The time the assignment was last updated.

active_on_days_off
BOOLEAN

If true, the assignment takes place on a non-work day.

allocation
INTEGER

The number of hours allocated to the assignment.

end_date
STRING

The day the assignment ended.

notes
STRING

Any notes about the assignment.

project_id
INTEGER

The ID of the project associated with the assignment.

Reference:

milestones.project_id
projects.id

person_id
INTEGER

The ID of the assignee.

Reference:

clients.updated_by_id
milestones.updated_by_id
people.id
people.updated_by_id
projects.updated_by_id

placeholder_id
INTEGER

If the assignment is a placeholder, this column will contain the placeholder ID.

repeated_assignment_set_id
INTEGER

start_date
STRING

The day the assignment started.

updated_by_id
INTEGER

The ID of the person who last updated the assignment.

Reference:

clients.updated_by_id
milestones.updated_by_id
people.id
people.updated_by_id
projects.updated_by_id

clients

View table schema on GitHub

Replication Method :	Key-based Incremental	Replication Key :	updated_at
Primary Key :	id

The clients table contains info about the clients in your Harvest Forecast account.

clients table schema

id
INTEGER

The client ID.

Reference:

projects.client_id

updated_at
STRING

The time the client was last updated.

archived
BOOLEAN

If true, the client has been archived.

harvest_id
INTEGER

The ID of the client in Harvest.

name
STRING

The name of the client.

updated_by_id
INTEGER

The ID of the person who last updated the client.

Reference:

assignments.person_id
assignments.updated_by_id
milestones.updated_by_id
people.id
people.updated_by_id
projects.updated_by_id

milestones

View table schema on GitHub

Replication Method :	Key-based Incremental	Replication Key :	updated_at
Primary Key :	id

The milestones table contains info about the project milestones in your Harvest Forecast account.

milestones table schema

id
INTEGER

The milestone ID.

updated_at
STRING

The time the milestone was last updated.

date
STRING

The date of the milestone.

name
STRING

The name of the milestone.

project_id
INTEGER

The ID of the project associated with the milestone.

Reference:

assignments.project_id
projects.id

updated_by_id
INTEGER

The ID of the person who last updated the milestone.

Reference:

assignments.person_id
assignments.updated_by_id
clients.updated_by_id
people.id
people.updated_by_id
projects.updated_by_id

people

View table schema on GitHub

Replication Method :	Key-based Incremental	Replication Key :	updated_at
Primary Key :	id

The people table contains info about the people in your Harvest Forecast account.

people table schema

id
INTEGER

The person ID.

Reference:

assignments.person_id
assignments.updated_by_id
clients.updated_by_id
milestones.updated_by_id
projects.updated_by_id

updated_at
STRING

The last time the person was updated.

admin
BOOLEAN

If true, the person is an admin in Harvest Forecast.

archived
BOOLEAN

If true, the person has been archived.

avatar_url
STRING

The full URL of the avatar associated with the person.

color_blind
STRING

Indicates if the person uses Harvest Forecast’s color blind-friendly version of the heat map feature.

email
STRING

The email address associated with the person.

first_name
STRING

The person’s first name.

harvest_user_id
INTEGER

The ID of the person in Harvest.

last_name
STRING

The person’s last name.

login
STRING

personal_feed_token_id
INTEGER

roles
ARRAY

A list of the roles assigned to the person.

Click to expand roles

value
STRING

The name of the role assigned to the person.

people (table), roles (attribute)

subscribed
BOOLEAN

If true, the person is subscribed to the weekly schedule digest.

updated_by_id
STRING

The ID of the person who last updated the person.

Reference:

assignments.person_id
assignments.updated_by_id
clients.updated_by_id
milestones.updated_by_id
projects.updated_by_id

weekly_capacity
INTEGER

The total number of hours the person is available during the week.

working_days
OBJECT

Details about the person’s availability during the week.

Click to expand working_days

monday
BOOLEAN