commit 345d8458a7319e8be03136194cfdb2d38af1dfc2
parent 2fc866b914e462493ebce9723680bcc404bcb2b2
Author: Lynn Foster <foster.j.lynn@gmail.com>
Date: Sun, 14 Apr 2019 10:03:52 -0500
claim model (#489)
Diffstat:
3 files changed, 104 insertions(+), 29 deletions(-)
diff --git a/docs/introduction/flows.md b/docs/introduction/flows.md
@@ -19,6 +19,10 @@ Commitments describe potential future events which the involved agents already a
Economic Events describes past events, something observed, never some potential future event. They can fulfill Commitments or satisfy Intents (when there is no Commitment).
+## Claims
+
+Claims resemble commitments, but are initiated by the receiver, not the provider. An economic event can trigger a reciprocal claim. Claims do not have to be instantiated, often they can be implied from an economic event and an agreement.
+
## Timeline, plans and observations
Figure below shows that Economic Events have to be observed and for that reason only appear as records of the past. Future plans get represented with Intents and Commitments.
diff --git a/examples/claim.yaml b/examples/claim.yaml
@@ -0,0 +1,59 @@
+# Example: Claim (simple)
+
+'@context':
+ - https://git.io/vf-examples-jsonld-context
+ - bob: https://bob.example/
+ mfg: https://manufacturer.example/
+
+'@id': rgh:valueflows/valueflows/master/examples/claim.yaml
+'@graph':
+
+ # Bob does some work to create a product that the mfg team wishes to sell on the marketplace
+
+ - '@id': mfg:02b39a30-3e04-4305-9656-7f261aa63c83
+ '@type': EconomicEvent
+ action: work
+ provider: https://bob.example/
+ receiver: https://manufacturing.example/
+ resourceClassifiedAs: https://www.wikidata.org/wiki/Q192047 # machining
+ quantifiedAs:
+ qudt:unit: unit:Hour
+ qudt:numericValue: 7
+ hasBeginning: 2018-10-14T8:00:00-0:00
+ hasEnd: 2018-10-14T15:00:00-0:00
+
+ # this triggers a claim for payment in the future based on an income distribution agreement among the mfg group
+
+ - '@id': mfg:d4d2fd71-34f2-41c3-b1c5-19ad5ed2da58
+ '@type': Claim
+ action: receive
+ provider: https://manufacturing.example/
+ receiver: https://bob.example/
+ resourceClassifiedAs: https://www.wikidata.org/wiki/Q1104069 # Canadian dollar
+ quantifiedAs:
+ qudt:unit: unit:Number
+ qudt:numericValue: 140
+ dcterms:created: 2018-10-14T15:30:00-0:00
+ triggeredBy: mfg:02b39a30-3e04-4305-9656-7f261aa63c83
+ under: mfg:e1721a61-cd47-4556-84b9-8b1b81da15be # a distribution agreement (not detailed in example)
+
+ # half of the manufactured product is sold along with some other products, and income is distributed
+
+ - '@id': mfg:c7897c39-7f05-4a5d-a487-80e130a2414a
+ '@type': EconomicEvent
+ action: receive
+ provider: https://bob.example/
+ receiver: https://manufacturing.example/
+ resourceClassifiedAs: https://www.wikidata.org/wiki/Q1104069 # Canadian dollar
+ quantifiedAs:
+ qudt:unit: unit:Number
+ qudt:numericValue: 260 # here Bob received income for more than one work event (others not included in the example)
+ time:inXSDDateTimeStamp: 2018-10-25T09:30:00-0:00
+
+ - '@id': mfg:b52a5815-fae9-43bf-be95-833b95dc0ada
+ '@type': Settlement
+ settles: mfg:d4d2fd71-34f2-41c3-b1c5-19ad5ed2da58 # the claim
+ settlededBy: mfg:c7897c39-7f05-4a5d-a487-80e130a2414a # the economic event
+ setledQuantity:
+ qudt:unit: unit:Number
+ qudt:numericValue: 70 # half of the original claim for the work
diff --git a/release-doc-in-process/all_vf.TTL b/release-doc-in-process/all_vf.TTL
@@ -117,10 +117,15 @@ vf:Fulfillment a owl:Class ;
vs:term_status "unstable" ;
rdfs:comment "The quantity that the economic event fulfilled towards the commitment." .
-#vf:Reciprocity a owl:Class ;
-# rdfs:label "vf:Reciprocity" ;
-# vs:term_status "unstable" ;
-# rdfs:comment "The quantity that the economic event implies towards creation of the reciprocal commitment." .
+vf:Claim a owl:Class ;
+ rdfs:label "vf:Claim" ;
+ vs:term_status "unstable" ;
+ rdfs:comment "." .
+
+vf:Settlement a owl:Class ;
+ rdfs:label "vf:Settlement" ;
+ vs:term_status "unstable" ;
+ rdfs:comment "." .
vf:Appreciation a owl:Class ;
rdfs:label "vf:Appreciation" ;
@@ -138,7 +143,7 @@ vf:Appreciation a owl:Class ;
vf:action
a owl:ObjectProperty ;
rdfs:label "action" ;
- rdfs:domain [ owl:unionOf (vf:EconomicEvent vf:Commitment vf:Intent vf:RecipeFlow) ] ;
+ rdfs:domain [ owl:unionOf (vf:EconomicEvent vf:Commitment vf:Intent vf:RecipeFlow vf:Claim) ] ;
rdfs:range vf:Action ;
vs:term_status "unstable" ;
rdfs:comment "Relates a process input or output to a verb, such as consume, produce, work, improve, etc." .
@@ -215,14 +220,14 @@ vf:appreciationWith
rdfs:comment "The economic event implemented in appreciation (gift economy)." .
vf:provider a owl:ObjectProperty ;
- rdfs:domain [ owl:unionOf (vf:EconomicEvent vf:Commitment vf:Intent) ] ;
+ rdfs:domain [ owl:unionOf (vf:EconomicEvent vf:Commitment vf:Intent vf:Claim) ] ;
rdfs:label "provider" ;
rdfs:range foaf:Agent ;
vs:term_status "testing" ;
rdfs:comment "The economic agent from whom the intended, committed, or actual economic event is initiated." .
vf:receiver a owl:ObjectProperty ;
- rdfs:domain [ owl:unionOf (vf:EconomicEvent vf:Commitment vf:Intent) ] ;
+ rdfs:domain [ owl:unionOf (vf:EconomicEvent vf:Commitment vf:Intent vf:Claim) ] ;
rdfs:label "receiver" ;
rdfs:range foaf:Agent ;
vs:term_status "testing" ;
@@ -250,25 +255,32 @@ vf:inScopeOf a owl:ObjectProperty ;
rdfs:comment "Grouping around something to create a boundary or context, used for documenting, accounting, planning." .
vf:under a owl:ObjectProperty ;
- rdfs:domain [ owl:unionOf (vf:EconomicEvent vf:Commitment vf:Intent vf:Fulfillment ) ] ;
+ rdfs:domain [ owl:unionOf (vf:EconomicEvent vf:Commitment vf:Intent vf:Fulfillment vf:Claim) ] ;
rdfs:label "under" ;
rdfs:range vf:Agreement ;
vs:term_status "unstable" ;
rdfs:comment "Reference to an agreement between agents which specifies the rules or policies or calculations which govern this flow." .
-#vf:createdBy a owl:ObjectProperty ;
-# rdfs:label "created by" ;
-# rdfs:domain vf:Reciprocity ;
-# rdfs:range vf:EconomicEvent ;
-# vs:term_status "unstable" ;
-# rdfs:comment "References the economic event that fully or partially created the commitment, often based on a prior agreement." .
+vf:triggeredBy a owl:ObjectProperty ;
+ rdfs:label "triggered by" ;
+ rdfs:domain vf:Claim ;
+ rdfs:range vf:EconomicEvent ;
+ vs:term_status "unstable" ;
+ rdfs:comment "References an economic event that implied the claim, often based on a prior agreement." .
-#vf:creates a owl:ObjectProperty ;
-# rdfs:label "creates" ;
-# rdfs:domain vf:Reciprocity ;
-# rdfs:range vf:Commitment ;
-# vs:term_status "unstable" ;
-# rdfs:comment "References the commitment that was fully or partially created because of the economic event, often based on a prior agreement." .
+vf:settles a owl:ObjectProperty ;
+ rdfs:label "settles" ;
+ rdfs:domain vf:Settlement ;
+ rdfs:range vf:Claim ;
+ vs:term_status "unstable" ;
+ rdfs:comment "References a claim that fully or partially settled by the economic event." .
+
+vf:settledBy a owl:ObjectProperty ;
+ rdfs:label "settled by" ;
+ rdfs:domain vf:Settlement ;
+ rdfs:range vf:EconomicEvent ;
+ vs:term_status "unstable" ;
+ rdfs:comment "References an economic event that fully or partially settles the claim." .
vf:contains a owl:ObjectProperty ;
rdfs:label "contains" ;
@@ -331,12 +343,12 @@ vf:satisfiedQuantity a owl:ObjectProperty ;
vs:term_status "unstable" ;
rdfs:comment "The quantity of the satisfaction of an commitment towards an intent." .
-#vf:reciprocalQuantity a owl:ObjectProperty ;
-# rdfs:label "reciprocal quantity" ;
-# rdfs:domain vf:Reciprocity ;
-# rdfs:range qudt:QuantityValue ;
-# vs:term_status "unstable" ;
-# rdfs:comment "The quantity of the reciprocity when an event creates a commitment." .
+vf:claimedQuantity a owl:ObjectProperty ;
+ rdfs:label "claimed quantity" ;
+ rdfs:domain vf:Claim ;
+ rdfs:range qudt:QuantityValue ;
+ vs:term_status "unstable" ;
+ rdfs:comment "The quantity of the initial expected reciprocity when an event materializes a claim." .
vf:definedQuantity a owl:ObjectProperty ;
rdfs:label "defined quantity" ;
@@ -409,7 +421,7 @@ vf:satisfiedBy
rdfs:comment "A commitment or economic event fully or partially satisfying an intent" .
vf:finished a owl:DatatypeProperty ;
- rdfs:domain [ owl:unionOf (vf:Commitment vf:Process vf:Intent) ] ;
+ rdfs:domain [ owl:unionOf (vf:Commitment vf:Process vf:Intent vf:Claim) ] ;
rdfs:label "finished" ;
rdfs:range xsd:boolean ;
vs:term_status "testing" ;
@@ -477,7 +489,7 @@ vf:classifiedAs
vf:resourceClassifiedAs
a owl:ObjectProperty ;
rdfs:label "resource classified as" ;
- rdfs:domain [ owl:unionOf (vf:ResourceSpecification vf:Intent vf:Commitment vf:EconomicEvent vf:RecipeFlow) ] ;
+ rdfs:domain [ owl:unionOf (vf:ResourceSpecification vf:Intent vf:Commitment vf:EconomicEvent vf:RecipeFlow vf:Claim) ] ;
rdfs:range owl:Thing ;
vs:term_status "unstable" ;
rdfs:comment "References a concept in a common taxonomy or other classification scheme for purposes of categorization." .
@@ -493,7 +505,7 @@ vf:processClassifiedAs
vf:resourceConformsTo
a owl:ObjectProperty ;
rdfs:label "resource conforms to" ;
- rdfs:domain [ owl:unionOf (vf:Commitment vf:EconomicResource vf:Intent vf:RecipeFlow vf:EconomicEvent ) ] ;
+ rdfs:domain [ owl:unionOf (vf:Commitment vf:EconomicResource vf:Intent vf:RecipeFlow vf:EconomicEvent vf:Claim ) ] ;
rdfs:range vf:ResourceSpecification ;
vs:term_status "unstable" ;
rdfs:comment "The primary resource knowledge specification or definition of an existing or potential resource." .
