Home / Apps / Harvest Two-Way Sync / Documentation

Documentation

Harvest Two-Way Sync

Getting started

1. Install

A Jira site administrator installs Harvest Two-Way Sync from the Atlassian Marketplace. There is nothing to configure centrally. The app is available to every user who can access the Jira site.

2. Connect your Harvest account

Open any Jira issue. Find the Harvest Two-Way Sync panel in the issue’s details area. Select Connect Harvest and authorise the connection in the window that opens. Each person connects their own Harvest login. You need at least one active project assignment with tasks in Harvest.

3. Book your first entry

Start Timer: choose project and task, add a note if you like, and start. Use Stop & log to Jira when you are done. Log Time: choose project and task, pick the date, enter the hours and save. To skip the pickers next time, choose your usual project and task and select Save as default.

4. Synchronize entries from Harvest

Open Apps → Harvest Two-Way Sync in Jira. Choose a period. Review the list; for unassigned entries, search for the Jira issue right on the entry. Select Synchronize new worklogs.

5. Apply changes and deletions

Switch to the Changes tab. It lists entries that were edited or deleted in Harvest after they had been synced. Select the ones you want and choose Apply selected.

6. Personal settings

Open the settings from the panel to choose language, time format, note format, the starting tab, and whether the panel shows the ticket summary and today’s entries.

7. Disconnect

Settings → Log out completely walks you through disconnecting inside the app and revoking the Harvest authorisation in your Atlassian account under Connected apps.

Sync states

StateMeaningWhat to do
NewThe entry has an issue and no worklog yet.Synchronize.
SyncedHarvest and Jira match.Nothing.
ChangedThe entry was edited in Harvest after the sync.Open the Changes tab and apply it.
UnassignedNo Jira issue was detected, or the detected issue cannot be opened.Search for the issue right on the entry, or leave it; unassigned entries are never synced.
RunningThe timer is still running.Stop it first; running timers are not synced.
ErrorJira could not be checked for this entry.Try again; if it persists, download the diagnostics log and contact support.

Tips

  1. Save a default project and task. Most people book against the same pair all day. With a default, a booking is hours and one click.
  2. Tracking in the Harvest app? Put the issue key in the note. Something like KAN-12 client call is enough.
  3. Stop timers from the Jira panel. Stop & log to Jira writes the worklog right away.
  4. Make Monday the sync day. Choose Last week, transfer what is new, then check the Changes tab.
  5. Check the Changes tab before timesheets are approved or invoiced.
  6. Correct hours in Harvest or in the panel, not in the Jira worklog.
  7. Use Hide synced entries in long periods. What is left is your to-do list.
  8. Choose Issue key only if summaries should stay in Jira.
  9. Match the time format to your timesheets.
  10. Coming from another integration? Start syncing from the day you switch.
  11. Something looks wrong? Settings → Diagnostics → Download logs, and send the file to support.
  12. Leaving the team or switching Harvest accounts? Use Log out completely.

Limits

  • Entries booked, changed or deleted directly in Harvest are transferred when you run the sync. There is no background job.
  • Worklogs created with Jira’s own “Log work” dialog are not copied to Harvest.
  • The worklog comment contains the issue key. Your Harvest note stays in Harvest.
  • The app does not change the remaining estimate of an issue.
  • Worklogs carry the date of the Harvest entry. Durations are rounded to full minutes.
  • The sync window covers the last three months.
  • Jira Cloud only.

Need help?

See the product FAQ or contact support.