3
0
Fork 0
mirror of https://github.com/farmOS/farmOS.git synced 2024-02-23 11:37:38 +01:00

Document type-specific fields on assets, logs, and terms.

This commit is contained in:
Michael Stenta 2021-03-31 10:05:27 -04:00
parent 864d90aa29
commit eaef284f07
3 changed files with 124 additions and 0 deletions

View file

@ -220,3 +220,48 @@ For more information, see [farmOS Group Membership Logic](/model/logic/group).
This field is added to all Log types by default only if the Group module is
enabled.
## Type-specific fields
In addition to the fields that are common to all Asset types described
above, some types add additional type-specific fields. These include:
#### Animal Assets
Animal Assets have the following additional attributes:
- Birthdate (timestamp)
- Is castrated (boolean)
- Nicknames (multiple strings)
- Sex ("F" or "M" string)
And the following additional relationships:
- Animal type (References a Term in the "Animal type" vocabulary)
#### Equipment Assets
Equipment Assets have the following additional attributes:
- Manufacturer (string)
- Model (string)
- Serial number (string)
#### Land Assets
Land Assets have the following additional attributes:
- Land type (string)
#### Plant Assets
Plant Assets have the following additional relationships:
- Plant type (references a Term in the "Plant type" vocabulary)
- Season (references a Term in the "Season" vocabulary)
#### Structure Assets
Structure Assets have the following additional attributes:
- Structure type (string)

View file

@ -248,3 +248,64 @@ This field is added to all Log types by default only if the Group module is
enabled.
For more information, see [farmOS Membership Logic](/model/logic/group).
## Type-specific fields
In addition to the fields that are common to all Log types described
above, some types add additional type-specific fields. These include:
#### Harvest Logs
Harvest Logs have the following additional attributes:
- Lot number (string)
#### Input Logs
Input Logs have the following additional attributes:
- Lot number (string)
- Method (string)
- Purchase date (timestamp)
- Source (string)
And the following additional relationships:
- Material (References Terms in the "Material" vocabulary)
#### Lab Test Logs
Lab Test Logs have the following additional attributes:
- Laboratory (string)
- Test type (string)
#### Medical Logs
Medical Logs have the following additional attributes:
- Veterinarian (string)
#### Purchase Logs
Purchase Logs have the following additional attributes:
- Invoice number (string)
- Seller (string)
- Lot number (string)
#### Sale Logs
Sale Logs have the following additional attributes:
- Customer (string)
- Invoice number (string)
- Lot number (string)
#### Seeding Logs
Seeding Logs have the following additional attributes:
- Lot number (string)
- Purchase date (timestamp)
- Source (string)

View file

@ -75,3 +75,21 @@ Relationships that are common to all Term types include:
Terms can specify "Parent" Terms to create a hierarchy. See related "Weight"
attribute above for ordering Terms within the hierarchy.
## Type-specific fields
In addition to the fields that are common to all Term types described
above, some types add additional type-specific fields. These include:
#### Plant Type Terms
Terms in the "Plant type" vocabulary have the following additional attributes:
- Days to maturity (Integer)
- Days to transplant (Integer)
And the following additional relationships:
- Companions (references other Terms in the "Plant type" vocabulary)
- Crop family (references a Term in the "Crop Family" vocabulary)
- Images (references uploaded image files)