PROTOCOL FORMAT / VERSION 1.3
Share a protocol in one standard format.
A protocol is one crop's reference plan per dunum: what is used and what it costs, what is sold, and, when the source gives it, when each activity is done and the rules for deciding. The Ministry crop budgets in the library are protocols in this format. Extension services, advisors, researchers and growers can describe their own the same way, so growers can compare their seasons with the reference that fits them.
Examples: Apple, Cripps Pink (Rules level) Rainfed wheat (Economic level)
Two levels
The level follows what the protocol carries; nothing is invented to fill a gap. Money is in NIS and everything is per dunum. Insurance, financing and overheads are kept but left out of direct-cost comparisons unless the user includes them. Everything is in English for now; Hebrew only in the columns labelled "(Hebrew, reference)", for tracing back to a source.
The tabs
Protocol
One value per row: who made the protocol, for which crop and place, and from which source.
| Field | Required | Kind | What goes in it |
|---|---|---|---|
| Protocol name | Yes | Text | Made from the fields below, never typed: Crop, variety – regions – season – author. The check warns when it differs. Example: Apple, Cripps Pink – Upper Galilee, Golan Heights – Perennial – Hula extension service |
| Crop | Yes | Text | The crop in English, as named in the library where it is there. Example: Apple |
| Variety | Text | Example: Cripps Pink | |
| Crop group | Yes | From a list | Field crops, Vegetables, Deciduous orchards, Citrus, Subtropical, Other |
| Season | Yes | Tags | When the crop is grown: one or more, separated by semicolons; Perennial for orchards. Example: Autumn; Winter One or more of: Autumn, Winter, Spring, Summer, Year-round, Perennial (separated by semicolons) |
| Production system | Yes | Tags | Tags, separated by semicolons: cover, planting, management, market, orchard stage. Example: Open field; Conventional; Fresh market Cover: Open field, Net house, Shade net, Greenhouse, Walk-in tunnel, Low tunnel; Planting: Traditional planting, Intensive or mechanised; Management: Conventional, Organic; Market: Fresh market, Export, Processing, Grain or feed, Forage, Seed production; Orchard stage: Mature (bearing), Establishment (separated by semicolons) |
| Production details | Text | Optional: what the tags do not say, such as density or spacing. Example: 166 trees per dunum, 4 × 1.5 m, no hail net | |
| Water | Yes | From a list | Irrigated, Rain-fed |
| Regions | Yes | Regions | Where this budget was built: one or more of the regions, separated by semicolons, or "Whole country". A region says where the numbers come from, not that the crop suits it. Example: Upper Galilee; Golan Heights One or more of: Upper Galilee, Western Galilee, Hula Valley, Golan Heights, Jezreel and northern valleys, Beit She'an Valley, Coastal plain and Sharon, Centre, Shefela and Lachish, Jerusalem hills, Northern Negev, Western Negev and Besor, Arava, Dead Sea, Jordan Valley, Whole country (separated by semicolons) |
| Author or organisation | Yes | Text | Who stands behind the protocol (shown with it). |
| Author type | Yes | From a list | Ministry or extension service, Advisor, Grower, Researcher, Other |
| Based on protocol | Text | Optional: the ID of the library protocol this one was adapted from. Example: IL-MOA-OR-056 | |
| Source | Text | Optional: other documents or data it comes from, with publisher and year. | |
| Benchmark year | Yes | Whole number | The year of the prices and quantities. |
| Orchard | Yes | Yes or No | Yes for perennial crops with establishment years (then the Lifecycle tab is useful). |
| Stated total cost NIS per dunum | Number | Optional: the source's own total. When given, the input lines must add up to it (within 1 NIS). | |
| Stated revenue NIS per dunum | Number | Optional: the source's own revenue. When given, the revenue rows must add up to it (within 1 NIS). | |
| Version | Text | Your version of this protocol. Example: 1.0 | |
| Permission to share | Yes | Yes or No | Yes: I have the right to share this protocol with FarmHive and its users. |
| Notes | Text |
Input Lines
Every input and every piece of work per dunum, with its quantity and price.
| Column | Required | Kind | What goes in it |
|---|---|---|---|
| Line ID | Yes | Text | Unique within the protocol: L001, L002, … Example: L001 |
| Activity code | Text | The activity this line belongs to (Activities tab). Needed on every production line for a Rules-level protocol. Example: A01 | |
| Cost group | Yes | From a list | Water, Labor, Machinery and contract work, Fertilizers, Plant protection, Seed and plants, Harvest, packing and marketing, Other materials and services, Insurance, overheads and interest |
| Cost type | Yes | From a list | Production for inputs and work; Insurance, Financing (interest, capital recovery) and Overhead (vehicle, office, municipal tax, land lease, fees, contingency) are left out of direct-cost comparisons unless the user includes them. Production, Insurance, Financing, Overhead |
| Item | Yes | Text | The input or work in English. Example: Hand pruning |
| Input list name | From a list | Optional: the same input on the FarmHive input list, so prices can be compared and a user's own price applies. 699 names from the input list | |
| Unit | Yes | Text | Example: workday |
| Rate per application | Number | Optional, for inputs applied several times (sprays, fertigation): the quantity per dunum in one application. | |
| Applications | Number | Optional, with the rate: how many applications in the season (0.5 = once on half the area). | |
| Quantity per dunum | Yes | Number | For the season. With a rate and applications it is rate × applications (the template works it out). |
| Price NIS per unit | Yes | Number | |
| Cost NIS per dunum | Number (filled in by the template) | Filled in by the template (quantity × price). | |
| Source label (Hebrew, reference) | Text | Optional: the wording in the source, for tracing. | |
| Notes | Text |
Activities optional
Optional. Activities with timing windows make the protocol Rules level.
| Column | Required | Kind | What goes in it |
|---|---|---|---|
| Activity code | Yes | Text | Example: A01 |
| Activity | Yes | Text | Example: Dormant pruning and pruning-waste mulching |
| Group | Text | Example: Canopy management | |
| Stage | Text | Crop stage. Example: Dormancy | |
| Timing window | Yes | Text | When it is done, in words. Example: Winter (dormancy) |
| Start month | Month 1–12 | Optional: 1 to 12, one span for the whole activity. For an activity done at several times, use the Activity windows tab instead. | |
| End month | Month 1–12 | Optional: 1 to 12. An end month before the start runs over the new year. | |
| Trigger | Text | What tells the grower it is time. | |
| Source | Yes | Text | Where the timing comes from. |
| Notes | Text |
Activity windows optional
Optional (format 1.3). When in the year each activity is done: one row per window, several rows for an activity done at different times (nitrogen in spring and again after harvest). These windows draw the protocol's season timeline; where an activity has windows here, its Start and End month on the Activities tab are not used.
| Column | Required | Kind | What goes in it |
|---|---|---|---|
| Activity code | Yes | Text | The activity (Activities tab). Example: A03 |
| Start month | Yes | Month 1–12 | |
| Start day | Whole number | Optional: the day of the month; the 1st when empty. | |
| End month | Yes | Month 1–12 | An end month before the start runs over the new year. |
| End day | Whole number | Optional: the day of the month; the last day of the month when empty. | |
| Placed by | Yes | From a list | Stated in the source: the source gives the date or month. By crop stage, or relative to bloom or harvest: worked out from the stage or event (proposed). Trigger window: when the trigger can come. Set by the author: your own timing. Stated in the source, By crop stage, Relative to bloom or harvest, Trigger window, Set by the author |
| What happens | Text | Optional: what is done in this window. Example: Nitrogen, spring with the start of irrigation | |
| Placed from | Text | Optional: the words of the source, or how the window was worked out. Example: Spring with the start of irrigation (pome-fruit manual) |
Rules optional
Optional. Decision rules: what to watch, the threshold, the recommended response.
| Column | Required | Kind | What goes in it |
|---|---|---|---|
| Rule code | Yes | Text | Example: R01 |
| Activity code | Text | Optional: the activity the rule decides. | |
| Watch for | Yes | Text | Example: Dormancy release |
| How to monitor | Text | ||
| Threshold | Yes | Text | |
| Recommended response | Yes | Text | |
| Source | Yes | Text | |
| Status | From a list | Draft, To confirm with an agronomist, Reviewed, Official |
Revenue
What is sold per dunum. Exactly one main product.
| Column | Required | Kind | What goes in it |
|---|---|---|---|
| Product | Yes | Text | Example: Apples, Cripps Pink |
| Unit | Yes | Text | The unit of quantity and price, e.g. ton or kg. Example: ton |
| Quantity per dunum | Yes | Number | |
| Price NIS per unit | Yes | Number | |
| Revenue NIS per dunum | Number (filled in by the template) | Filled in by the template. | |
| Main product | Yes | Yes or No | |
| Source label (Hebrew, reference) | Text |
Lifecycle optional
Optional, orchards: the yield in each year of the orchard's life as a share of the mature yield.
| Column | Required | Kind | What goes in it |
|---|---|---|---|
| Year | Yes | Whole number | 0 is the planting year. |
| Yield share of mature | Yes | Number | 0 before bearing, 1 at full yield. |
| Notes | Text |
What the check looks at
| Check | |
|---|---|
| Error | A required value is missing. |
| Error | A value is not of the right kind (a number, a whole number, a month 1–12, Yes or No). |
| Error | A number is outside its allowed range. |
| Error | A value is not one of the allowed choices. |
| Error | A region is not one of the FarmHive regions. |
| Error | An ID or code is used twice. |
| Error | An activity code points to no activity. |
| Error | A required tab has no rows. |
| Error | Revenue needs exactly one main product. |
| Error | "Permission to share" must be Yes. |
| Error | The input lines do not add up to the stated total cost. |
| Error | The revenue rows do not add up to the stated revenue. |
| Error | Hebrew outside a "(Hebrew, reference)" column: everything else is in English for now. |
| Error | A tab or column of the template is missing. |
| Error | A day does not exist in its month (for example 30 February). |
| Error | With a rate per application, give the number of applications too (and the other way round); quantity per dunum must be rate × applications. |
| Warning | A price is far (more than 3×) outside the range of the same input in the Ministry models: check the unit and the decimal point. |
| Warning | The unit differs from the unit of the same input on the input list. |
| Warning | The protocol is Economic level: some production lines have no activity with a timing window. |
| Warning | An activity has no input lines. |
| Warning | Lifecycle years should run 0, 1, 2, … without gaps, and reach a share of 1. |
| Warning | The protocol name should be made from the fields: Crop, variety – regions – season – author. |
Sending a protocol
The easiest way to make one is the builder, which fills and checks the template as you go. A template filled by hand can be checked on the check page. Check the file first (it is read in your browser and not sent anywhere), then email it to adama@migal.org.il. Protocols are reviewed before they appear in the library, with their author and source shown.