Machinery work order / work items aligning with ADAPT/ISObus

[cookeac]

Define classes that support land application work orders and work records
These should align with AgGateway's ADAPT Data Model (documentation | GitHub) where possible (recognising that ADAPT has a GeoJSON plug-in which is good for the spatial representations, and that its data model is weighted towards the flat tabular approach of traditional ISOBus)

This is a part of issue #39

[cookeac]

Here's a diagram of a potential object model based on the entities from ADAPT but using the spatial features and based on ObservationType

[cookeac]

1. WorkOrderResource

Property	Type	Description
items	array of WorkItemResource	Contains the list of work items within the work order.

All other Work Order fields are come from the base classes - ObservationType or ResourceType.

2. WorkItemResource

Defines activities carried out "in a single pass" of the feature.

Property	Type	Description
operation	string	Describes the principle operation to be carried out (or which has been carried out). This could be an enumeration.
status	enumeration	ADAPT or ISO status codes. To document which we choose.
priority	enumeration	ADAPT or ISO priority codes. Document which we choose.
operations	array of WorkItemOperationType	A list of (at least one) operation that is carried out in this pass/activity.

All other Work Item fields come from ObservationType or ResourceType.

3. WorkItemOperationType

Defines details of a single operation within a work item (a single pass).

Property	Type	Description
operation	string	Describes the detailed operation. This could/should be an enumeration.
operationName	string	A human-readable description of the operation.
machines	array of MachineResource	The equipment used/to be used in this operation.
products	array of OperationProductType	The product(s) and their rates used in this operation.

Additional ADAPT details could be added at the WorkItemOperation level - for instance, WorkRecord summary and LoggedData.

4. MachineResource

MachineResource will include all attributes from ResourceType.

Property	Type	Description
manufacturer	string (URI)	Manufacturer URI or identifier.
model	string	Model identifier.
serial	string	Equipment serial number.
implements	array of ImplementResource	Details of zero or more attached implements.

5. ImplementResource

MachineResource will include all attributes from ResourceType.

Property	Type	Description
manufacturer	string (URI)	Manufacturer URI or identifier.
manufacturer	string (URI)	Manufacturer URI or identifier.
model	string	Model identifier.
serial	string	Equipment serial number.
workingWidth	number	Working width in metres.
trackSpacing	number	Track spacing in metres.

[cookeac]

6. OperationProductType

Identifies a product (or product component) used in the operation.

Property	Type	Description
product	ProductReferenceType	A related items reference to the product (for instance in a reference set of product information).
rate	number	The application or mixing rate of the product within the operation.
rateUnits	enumeration	One of the SI units in a rates unit list. For instance KGM (kilogram) or LTR (litre)...
denominatorUnits	enumeration	One of the SI or extended units. E.g. MTR (per metre), MTK (per sq. metre), HAR (per hectare).

7. ProductReferenceType

References a product in a product listing and provides some human-readable information.
This incorporates the existing elements of RelationType (rel, type, related).

Property	Type	Description
id	string	A unique identifier for the product (could be IdentifierType with scheme and ID?).
manufacturer	string (URI)	Manufacturer identification or URI.
category	enumeration	Product category. To be defined.
form	enumeration	Product form (e.g. solid, liquid, gel). To be defined.