The vintrace Vineyard to vintrace integration automatically transfers your harvest bookings and fruit receivals from the Vineyard product to vintrace. The integration gives you access to relevant vineyard data so that you can plan harvest dates and start the winemaking process.
How It Works
The integration uses the vintrace API to connect vintrace Vineyard and vintrace. After configuring the integration, fruit booking and intake events entered in Vineyard will automatically synchronise with vintrace within 10 minutes of saving the events. Changes to existing events in Vineyard will also be reflected in vintrace.
The integration uses the following vintrace API endpoints:
Fruit bookings are sent from Vineyard to vintrace using the Upsert This Booking into vintrace endpoint. This endpoint transfers the following data.
| Field Name | Example |
|---|---|
| Booking Number | AG1245668 |
| Winery | Estate 1 |
| Block Name | APS B1 |
| Vintage | 2024 |
| Expected Quantity in Tons | 12 |
| Booking State | Scheduled |
| Owner | VIN |
After weighing is completed in vintrace Vineyard, the booking is updated in vintrace using the Record a New Fruit Intake Transaction endpoint. This endpoint transfers the following data.
| Field Name | Example |
|---|---|
| External Weigh Tag | 5002 |
| Scale Name | Scale 1 |
| Net Value | 25000 |
| Net Unit | lb |
| Metric Brix | 23 |
| Metric pH | 5.9 |
| Metric TA | 3.3 |
If you want to do the weighing in vintrace, you do not need to use the Record a New Fruit Intake Transaction endpoint.
After the second data transfer updates the booking, the Fruit Intake Console in vintrace displays fruit receival information.
Considerations
- The data transfer from vintrace Vineyard to vintrace is unidirectional. The fruit booking and fruit intake events must be recorded in Vineyard in order for the data to appear in vintrace. If either of the events is only recorded in vintrace, the data will NOT be transferred to or recorded in the Vineyard product.
- Deletion of events is not synchronised. If a fruit booking or fruit intake event is deleted in either Vineyard or vintrace, the data must be manually deleted from the other.
- If a synchronisation error occurs, the vintrace Vineyard calendar event that’s missing from vintrace will need to be edited and re-saved in order to trigger the re-synchronisation to vintrace. When troubleshooting an issue with the integration, be sure to always edit and re-save the affected records in Vineyard. If you do not edit and re-save the record from Vineyard, the record will be considered erroneous and not re-sent to vintrace.
Before You Begin
Prerequisites
The following are prerequisites for the vintrace Vineyard to vintrace integration:
- The organisation must have an account for both vintrace and vintrace Vineyard (formerly eVineyard).
- You must obtain an API token from vintrace. This token will be used by Vineyard to transfer data to vintrace.
- You must enable vintrace integration in vintrace Vineyard. If your organisation doesn’t have vintrace integration enabled, or you’re not sure if the vintrace integration is enabled, contact vintrace using the support form in the profile menu of the vintrace application ('Help & Support' option), the question mark icon in the bottom left corner of the vintrace application, or via e-mail.
Key Data Fields
To successfully integrate vintrace Vineyard and vintrace, the data fields across the two systems must match. Below are the fields that you’ll need to check.
- Block Name – The block name in vintrace must be unique and match the name in the Vineyard product. When you configure the integration, you’ll need to link the block ID from Vineyard to vintrace.
- Winery Name – The winery name in vintrace must be unique and match the Vineyard winery name.
- Owner Name – The owner name in vintrace must be unique and match the Vineyard owner name. When you configure the integration, you’ll need to link the organisation ID from Vineyard to vintrace.
- Scale Name – The scale name in vintrace must be unique and match the scale name in Vineyard.
Configuring vintrace Vineyard Integration
You’ll need to complete the following steps to configure the vintrace Vineyard integration with vintrace:
- Configure the vintrace URL and token.
- Link the organisation id from Vineyard to vintrace.
- Link blocks from Vineyard to vintrace.
Configuring the vintrace URL and Token
In order to send data to your vintage account, you must point vintrace Vineyard to your vintrace instance and give it access to send data by doing the following:
- From the top right corner of vintrace Vineyard, select Profile & Settings.
- From the System Settings menu on the left, select vintrace.
Important: If the option vintrace is not available in the menu, then the integration with vintrace was not yet enabled for your Vineyard profile. Contact vintrace using the support form in the profile menu of the vintrace application ('Help & Support'), the question mark icon in the bottom left corner of the vintrace application, or via e-mail to request that the vintrace integration be enabled.
- From the integration settings window, enter the following.
- URL – Your vintrace URL that you use to log in just before “/1.app”. It’s important that the configured URL ends just before “/1.app” as in the example below.
- Token – The token you received from vintrace.
- Click Update.
Linking the Organisation ID from Vineyard to vintrace
In vintrace Vineyard, the Organisation ID is specific to your account and will need to be added to vintrace.
To link the Vineyard organisation ID to vintrace:
- From your vintrace address book, click the Advanced button that’s beside the winery name that you’ll use to interact with Vineyard.
- In the External ID field, enter the Vineyard organisation ID.
- Click Save.
- From the vintrace address book, click the winery name.
- Click the Edit button that’s beside the Owner role.
- In the Auto Code field, enter the Vineyard organisation ID.
- Click OK.
Linking Blocks from vintrace Vineyard to vintrace
In Vineyard, each block has its own ID. You’ll need to enter this ID in the Auto Code field of the same block in vintrace.
- Find the block ID in Vineyard by doing the following:
- From the System Settings menu, select vintrace.
- Under Vineyard Blocks Details, note the block ID that’s under the Block ID column.
- Specify the block IDs in vintrace. For example, if the Vineyard Block ID in Vineyard is 1877, you’ll need to enter 1877 in the block’s Auto Code field in vintrace.
Adding Fruit Bookings and Fruit Intakes in Vineyard
The easiest way to add fruit booking or fruit intake events in Vineyard is through the Vineyard Calendar.
From the Vineyard Calendar, add the event.
- After saving the event, be sure that the following details are entered correctly on the event details screen. These details must match the data in vintrace.
- Business Unit – For fruit bookings and fruit intakes, this must be the winery name in vintrace.
- Scale – For fruit intakes, this must be one of the scales in vintrace.
For fruit intakes, be sure to select the fruit booking entry that the fruit intake event is linked to.
- Be sure to save all event updates made from the Vineyard calendar. If the integration with vintrace is properly configured, the updates will be automatically synchronised within 10 minutes.
Troubleshooting
If fruit booking and fruit intake events don’t appear in vintrace after 10 minutes from the time they were saved in vintrace Vineyard, there’s likely an error in the settings or event data.
In the Vineyard calendar, be sure that the Business Unit and Scale properties match the properties in vintrace.
You can also check Vineyard for vintrace integration errors.
Checking Error Messages
Integration error messages can provide insight into why data isn’t being transferred to vintrace. To check for vintrace integration messages from Vineyard:
- From the top right corner of vintrace Vineyard, select Profile & Settings.
- From the System Settings menu on the left, select vintrace.
- Check the Integration Messages section at the bottom of the screen for errors.