ADAPT Common Object Model

Syncing with code:

• Adds list of GeopoliticalContext to Catalog
• Adding HitchPoint class to model
• Sync Catalog w code

• Added CalibrationFactors to LoggedData
• Added OMCode to Obs and ObsCollection
• Rearranged class diagrams to combat overlapping entities.

• Added new classes (Container, PackagedProduct, & PackagedProductInstance) to the model.

• Added and synchronized classes from the source code.

• Ported model from ArgoUML into Enterprise Architect and recreated class diagrams.

Incremental progress in syncing the model with the source code. Includes:

• Cleaned up Document class diagram. LoggedData now includes IrrRecords, and also uses LoggedData and Summaries by reference (as opposed to by value).
• Cleaned up Irrigation Equipment class diagram. Added relationships between DeviceElement and Manufacturer / Brand / DeviceSeries.
• Note: There are some required attributes in DeviceElement that should probably be optional. This happens in both code and model, and will need to be discussed with the Technical Team.
• Note: Logger is in the Model's DeviceElementTypeEnum, but not in the code. We'll need to add and make a pull request accordingly when we add the corresponding Logger and LoggerConfiguration classes, for full Observations & Measurements Setup/Configuration support.
• Synced up model OperationTypeEnum with source code.
• The code-model sync is still work in progress!

Adds / modifies classes related to Products and packaging, discussed in 18 Mar 2020 meeting of ADAPT Technical Team, as follows:

• ContainerModel: Added supply-chain-friendly physical dimension attributes.
• PackagedProduct: Added class and attributes therein. Represents all instances of a given Product packaged into a given ContainerModel. Should have support for a geopolitical-context-specific label in the next iteration.
• ContainedPackagedProduct: Added class and attributes therein. Supports explicitly describing a hierarchy; for example, a pallet that has N cases, each of which has M jugs. This class can take SKUs and GTINs via ContextItems.
• PackagedProductInstance: Added Class and attributes therein. Represents a specific instance of a packagedProduct (and its contained instances of PackagedProducts). Supports Batch, Lot and Serial numbers via ContextItems, a Holy Grail we've been wanting for a long time!
• ProductLabel: Added the class and a few initial attributes. This is a placeholder for a class that represents a Product's label. Please don't use yet.
• LabeledForUse: Added the class and a few initial attributes. This is a placeholder for a class that puts the PackagedProduct (and underlying Product) into context of a ProductLabel and the conditions set forth by that ProductLabel. Please don't use yet.

• Fixes a couple of discrepancies between this data model and the ADAPT source code (e.g., in FIeldBoundary).

• Includes multiple adjustments that bring the ArgoUML model closer to the actual ADAPT 2.0 source (an ongoing task).
• Includes implementation of PAIL-related irrigation operations classes.
• Includes Observations & Measurements (O&M) documents classes (Observations, ObsDataset, ObsCollection, Obs)
• Includes a draft of the O&M semantics-related classes. This is an as-yet incomplete port of the corresponding PAIL classes, and many of these classes are not yet in the source code. (Expect some changes)
• Includes a class diagram with the class hierarchy to use in the USDA Cotton Data plug-in being worked on with Cotton, Inc.
• Includes most recent work on linking Loads, Containers, operations, Load/Unload events, etc. as per Traceability WG work. These classes are not 100% stable yet and are not yet in the source code. (Expect some changes) 

• Includes more progress on bringing materials from the PAIL project (Irrigation operations and Observations & Measurements) into ADAPT (This is incomplete).
• Includes recent work (to be proposed in v2.1) on Traceability: Containers, and ProductContainerActions (generalization of Transfer, Transport, and Container-centric events)
• Includes recent work on getting the UML model synced with the ADAPT source code. This likely makes this version the best starting point for a UML diagram that represents ADAPT v2.0 (work to come).
• Proposed implementation of Place is different from the previously-posted version, seeking to be non-breaking and use composition instead of inheritance. Place is needed for Transfer events (see ProductCOntainerAction class) and the features of interest of Observations. 
• DISCLAIMER: This model is incomplete, in that it does not include all the recent additions to the source code related to PAIL (irrigation). Also, the walkthrough to bring it in line with the source code, while started, is not yet complete. Please check back in December 2018, after the v2.0 release.

• Incremental progress on proposed ISO 19156 (Observations & Measurements) implementation.
• Includes an (as-yet incomplete) proposed common ancestor class to Position, Location and Facility, called Place. (An upcoming version will propose a common ancestor to Person and Company, called Party).
• The Observations & Measurements work is included in a new Class diagram.
• This is incomplete; there are numerous places (e.g., Product, DeviceElement) where it will likely make sense to include OM objects or a container thereof.

Includes materials added during CART F2F in Minneapolis on May 16-18. Major points:

• Changed the name of the ContainerUse class to ContainerAction
• Changed cardinality of ContainerAction.ProductId from 1 to 0..1, to enable actions that do not involve products (e.g., cleaning)
• Changed ContainerUseTypeEnum.Permanent to "Fixed", for greater consistency with the concepts of fixed and mobile assets.
• Changed ContainerActionEnum.BringToEmpty to SetAmount, following a long discussion about
• Added several classes to the Observations class diagram, fleshing out (albeit slightly incompletely) the Observations Core Document, the Code Components functionality, and PAIL (observations) compatibility. A little more work is needed here.

Cleans up some of the class diagrams.

Includes some recent assorted v2 tweaks from Technical Team meetings.

Adds GrowerId to field for ISO 11783 compatibility.

Replaces, in OperationSummary, ProductId[0..1]: Integer with ProducttUses[0..*]: ProductUse. This is meant to make it possible to keep together references to multiple products used in a single field operation, in the context where a tank mix is not explicitly declared.

Result from today's Technical Meeting:

• Removes ModeOfAction id list from ActiveIngredient (Modes of action will be best implemented as ContextItems)
• Adds TimeScopes list to AvailableProduct. (Enables capturing validity ranges for the relationship with the grower.)
• Converts CropNutritionIngredientEnum to an EnumeratedRepresentation

• Introduces a Source object usable by ContextItemDefinitions and ContextItemEnumItems
• Introduces a "Candidate" status for ContextItemDefinitions and ContextItemEnumItems
• Rearranged shapes on the main class diagram to print nicely.

• Removed CompoundIdentifiers because ContextItemDefinitions are referenced by their code (as opposed to an arbitrary ID).
• Also, given the local scope of CompoundIdentifiers' (required) ReferenceIds, it makes little sense to attempt to import one into a target ADM instance where that ReferenceId may already be in use.

Known Issues:

• We need to implement a mechanism for representing the source of a ContextItemDefinition and possibly other things.

• Adds GeoPoliticalContext and ModelScope literals to the RelationSubjectTypeEnum and RelationObjectTypeEnum. This enables:
  • Asserting relationships among corresponding elements in different GPC andModelScope vocabularies (e.g., ADAPT.Farm to ISO11783.FRM, the FAO and GeoNames entries for USA, etc.)
  • Linking individual entries in the ModelScope and GeopoliticalContext vocabularies with external URIs for documetation. (IsDescribedBy relationship!)

• Adds a SourceValue attribute to both GeoPoliticalContext and ModelScope classes, to enable the simultaneous existence of a unique, composite (Type+SourceValue) Code along with the original value from the source vocabulary (the SourceValue).

• Adds GPCTypeEnum to accommodate multiple sources of geopolitical context data.
• Adds comments regarding the naming convention for enum items that will be used for querying from the ContextItem reference data API (e.g., ModelScopeTypeEnum)
• Adds IsBroaderThan and IsNarrowerThan literals to RelationTypeEnum
• Labels all relationships

• Adds TemporaryStorage to FacilityTypeEnum as per request by SPADE3 Crop Nutrition Team.
• Corrections to relationship types and cardinalities in classes shown in Person class diagram, as per OAGi-NIST feedback.

20160720 Common Data Model.zargo

Corresponds generally to 1.1.0.6 release.

Known issues:

• Load / ContainerUse / ProductAllocation still needs to be harmonized.
• Need to finish incorporating agreed-upoon changes to Equipment classes and Product classes.
• TImeScope is used inconsistently (but has been fixed in code)
  • Must ensure it's used by Value throughout
  • Multiplicity on classes that bind 2 other things: 0..N

latest working copy. Primarily includes sub-classes of GuidancePattern. There are still a couple of unresolved issues there. Known issues:

• Load / ContainerUse / ProductAllocation still needs to be harmonized.
• Need to finish incorporating agreed-upoon changes to Equipment classes and Product classes.
• TImeScope is used inconsistently (but has been fixed in code)
  • Must ensure it's used by Value throughout
  • Multiplicity on classes that bind 2 other things: 0..N

Latest working copy. Known issues:

• Load / ContainerUse / ProductAllocation still needs to be harmonized.
• TImeScope is used inconsistently.
  • Must ensure it's used by Value throughout
  • Multiplicity on classes that bind 2 other things: 0..N

Many small changes, some cosmetic, some important. The vast majority were:

• Changing "ID" to "Id" throughout.
• Ensuring that standalone objects' Id is of type CompoundIdentifier (and not Integer)
• Ensuring that objects include ContextItems by value (i.e., list of ContextItem) and not by reference (i.e., list of Integer)
• Cleaned up all spurious or redundant inheritance relationships
• Named all inheritance relationships

Modified Trait, based on document from Seed Council / Standards & Guidelines

Changed type of CropVariety.TraitIDs from Trait to Integer

Removed SPADE Extensions view (redundant).

ArgoUML
(143K)

ArgoUML

(99K)