Fork me on GitHub

Template perishable-goods@0.7.1

Clause Ergo ^0.8.0 b284bf02672dbdee674c7ef45ae7859528a3f94982fcd985807759edce73a9b7

This clause specifies penalties if the transport conditions (temperature and humidity) for a package are breached.

Download Archive

Perishable Goods

This clause specifies penalties if the transport conditions (temperature and humidity) for a package are breached.

Sample

On receipt of the shipment "SHIP_001" the importer "DAN" pays the grower "PETER" 1.50 USD per KG. The shipment must contain between 3000 and 3500 KG of "Grade I, Size 4, Zutano Mexican Avocados".

Shipping containers used must be temperature and humidity controlled, and sensor readings must be logged at least 1 per hours.

Shipments that arrive after 07/02/2018 are to be considered spoiled and must be arranged to be returned to or disposed of by grower at cost to grower.

Temperature readings for the shipment must be between 2 and 13.

Humidity readings for the shipment must be between 70 and 90.

Shipments that have a temperature or humidity reading outside the agreed range have a price penalty applied calculated using the Formula for Breach Penalty Calculation below. The breach penalty factor to be used is 0.2.

Formula for Breach Penalty Calculation:
   penalty = number of shipment units x difference between sensor reading and agreed range x breach penalty factor

Model Dependencies

Technical Integration

Please refer to the Cicero documentation for details and examples of how to integrate a call to a Cicero template into your application.

View the Latest code for this template on on GitHub.

Sample Instance

{
    "$class": "org.accordproject.perishablegoods.PerishableGoodsClause",
    "clauseId": "eee66c37-ea4d-4b7c-9941-22027945c8af",
    "grower": "PETER",
    "importer": "DAN",
    "shipment": "SHIP_001",
    "dueDate": "2018-07-02",
    "unitPrice": {
        "$class": "org.accordproject.money.MonetaryAmount",
        "doubleValue": 1.5,
        "currencyCode": "USD"
    },
    "unit": "KG",
    "minUnits": 3000,
    "maxUnits": 3500,
    "product": "Grade I, Size 4, Zutano Mexican Avocados",
    "sensorReadingFrequency": 1,
    "duration": "hours",
    "minTemperature": 2,
    "maxTemperature": 13,
    "minHumidity": 70,
    "maxHumidity": 90,
    "penaltyFactor": 0.2
}

State Types

Type Sample JSON
org.accordproject.cicero.contract.AccordContractState 
{
    "$class": "org.accordproject.cicero.contract.AccordContractState",
    "stateId": "cf4c2760-bb5c-11e8-b3c5-657cf5dcd85b"
}

Request Types

Type Sample JSON
org.accordproject.perishablegoods.ShipmentReceived 
{
    "$class": "org.accordproject.perishablegoods.ShipmentReceived",
    "unitCount": 8173,
    "shipment": "resource:org.accordproject.perishablegoods.Shipment#4238",
    "transactionId": "cf4b3d00-bb5c-11e8-b3c5-657cf5dcd85b",
    "timestamp": "2018-09-18T16:06:32.400Z"
}

Response Types

Type Sample JSON
org.accordproject.perishablegoods.PriceCalculation 
{
    "$class": "org.accordproject.perishablegoods.PriceCalculation",
    "totalPrice": {
        "$class": "org.accordproject.money.MonetaryAmount",
        "doubleValue": 194.663,
        "currencyCode": "XXX"
    },
    "penalty": {
        "$class": "org.accordproject.money.MonetaryAmount",
        "doubleValue": 62.053,
        "currencyCode": "BMD"
    },
    "late": true,
    "shipment": "resource:org.accordproject.perishablegoods.Shipment#6139",
    "transactionId": "cf4c0050-bb5c-11e8-b3c5-657cf5dcd85b",
    "timestamp": "2018-09-18T16:06:32.405Z"
}

Events Types

Type Sample JSON
org.hyperledger.composer.system.Event 
{
    "abstract": "this is an abstract type"
}