Merge pull request #111 from OpenDataManchester/working-on-2-1

Working on 2 1

.github/workflows/ci.yml

@@ -18,4 +18,4 @@ jobs:
       - run: git config user.name github-actions 
       - run: git config user.email github-actions@github.com 
       - run: git fetch origin gh-pages --depth=1
-      - run: mike deploy --push --update-aliases 2.0 latest
+      - run: mike deploy --push --update-aliases 2.1 future

docs/3_Data_Specification/3_1_Base_Materials.md

@@ -17,6 +17,7 @@ The base materials schema contains information regarding the core materials. The
 |externalIdentifiers|`recommended`|Dictionary|A dictionary of identifiers that might be used to identify the base material in other systems. For example: manufacturer's own internal identifier, bar codes or global trade item number (gtin). To provide external identifiers please follow this format. `{'externalIdentifierName1': 'identifier1', 'externalIdentifierName2': 'identifier2'}`|
 |certification|`recommended`|Boolean|Does the base material have a certificate (e.g. FSC, REACH, FSA etc.)? Answer as: `TRUE` for yes and `FALSE` for no.|
 |certificationClaims|`recommended`|List|The information regarding the certification. The entries should be the [Certification Claims Relationship List](../6_Relationship_Lists/6_005_Certification_Claims.md) identifiers.|
+|manufacturers|`recommended`|List|The information regarding the manufacturer(s). The entries should be the [Organisations Relationship List](../6_Relationship_Lists/6_010_Organisations.md) identifiers.|
 |manufacturedCountry|`recommended`|Numeric|The country the component was manufactured in. Use the country numeric [ISO codes](https://www.iban.com/country-codes){target=_blank} as described in the ISO 3166 international standard.|
 |updateDate|`required`|String|The date that the base material was provided/last updated. Use the format `dd/mm/yyyy`.|
 
@@ -32,6 +33,7 @@ erDiagram
     externalIdentifiers Dictionary
     certification Boolean
     certificationClaims List
+    manufacturers List
     manufacturedCountry Numeric
     updateDate String
   }
@@ -42,6 +44,7 @@ erDiagram
     materialType recommended }
       RELATIONSHIP_LISTS {
     certificationClaims recommended
+    organisations recommended
       }
   }
 ```
@@ -69,6 +72,7 @@ Base materials should be provided as a separate csv file. The specification of t
       "certification": "TRUE",
       "certificationClaims": ["1","35"],
       "certificationDate": "01/08/2022",
+      "manufacturers": [""],
       "manufacturedCountry": 724,
       "updateDate": "01/08/2022",
     }
@@ -99,6 +103,7 @@ Base materials should be provided as a separate csv file. The specification of t
         },
         "certificationDate": "01/08/2022",
       }],
+      "manufacturers": [""],
       "manufacturedCountry": {
         "Country": "United Kingdom of Great Britain and Northern Ireland (the)",
         "Numeric": 826

docs/3_Data_Specification/3_2_Materials.md

@@ -15,8 +15,14 @@ The materials schema contains information regarding the materials that are used
 |externalIdentifiers|`recommended`|Dictionary|A dictionary of identifiers that might be used to identify the material in other systems. For example: manufacturer's own internal identifier, bar codes or global trade item number (gtin). To provide external identifiers please follow this format. `{'externalIdentifierName1': 'identifier1', 'externalIdentifierName2': 'identifier2'}`|
 |materialConstituents|`required`|List|The information regarding the consituents that are combined to create this material. The entries should be from the [Material Constituents Relationship List](../6_Relationship_Lists/6_001_Material_Constituents.md) identifier.|
 |combinationPurpose|`recommended`|String|Why is this material being used? Use the identifier of the function that this row relates to. The entry here should be drawn from the [Function Controlled List](../5_Controlled_Lists/5_004_Function.md).|
+|areaDensity|`recommended`|Numeric|The area density of the material. Where area density is the measure of how much mass is packed into a given area of a two-dimensional object. Provided in grams per square metre (gsm).|
+|areaDensityUnit|`recommended`|String|Either `gsm` or `m^2/kg` to describe the area density unit of measure.|
+|areaDensityTolerance|`recommended`|Numeric|The threshold of area density that the material can vary by. This is given as a +/- value.|
+|areaDensityToleranceType|`recommended`|String|Either `unit` or `percentage` based on the value provided in `areaDensityTolerance`. Where `unit` is equal to the value provided in `areaDensityUnit`.|
+|areaDensityDate|`recommended`|String|The date that the area density was last verified/measured. Use the format `dd/mm/yyyy`.|
 |certification|`recommended`|Boolean|Does the material have a certificate (e.g. FSC, REACH, FSA etc.)? Answer as: `TRUE` for yes and `FALSE` for no.|
 |certificationClaims|`recommended`|List|The information regarding the certification. The entries should be the [Certification Claims Relationship List](../6_Relationship_Lists/6_005_Certification_Claims.md) identifiers.|
+|manufacturers|`recommended`|List|The information regarding the manufacturer(s). The entries should be the [Organisations Relationship List](../6_Relationship_Lists/6_010_Organisations.md) identifiers.|
 |manufacturedCountry|`recommended`|Numeric|The country the component was manufactured in. Use the country numeric [ISO codes](https://www.iban.com/country-codes){target=_blank} as described in the ISO 3166 international standard.|
 |updateDate|`required`|String|The date that the material was provided/last updated. Use the format `dd/mm/yyyy`.|
 
@@ -31,8 +37,14 @@ BASE_MATERIALS }o--o{ MATERIALS : within
     externalIdentifiers Dictionary
     materialConstituents List
     combinationPurpose String
+    areaDensity Numeric
+    areaDensityUnit String
+    areaDensityTolerance Numeric
+    areaDensityToleranceType String
+    areaDensityDate String
     certification Boolean
     certificationClaims List
+    manufacturers List
     manufacturedCountry Numeric
     updateDate String
   }
@@ -45,6 +57,7 @@ BASE_MATERIALS }o--o{ MATERIALS : within
         RELATIONSHIP_LISTS {
     materialConstituents required
     certificationClaims recommended
+    organisations recommended
       }
 ```
 
@@ -67,8 +80,14 @@ Materials should be provided as a separate csv file. The specification of this c
         },
       "materialConstituents":["DCEE1F88-A83B-5BBC-D2D9-6A862B344977"],
       "combinationPurpose": "",
+      "areaDensity": "138",
+      "areaDensityUnit": "gsm",
+      "areaDensityTolerance": "3.3",
+      "areaDensityToleranceType": "percentage",
+      "areaDensityDate": "01/08/2022",
       "certification": "TRUE",
       "certificationClaims": ["1"],
+      "manufacturers": [""],
       "manufacturedCountry": 826,
       "updateDate": "01/08/2022",
     }
@@ -101,6 +120,7 @@ Materials should be provided as a separate csv file. The specification of this c
               },
             "certification": "FALSE",
             "certificationClaims": null,
+            "manufacturers": [""],
             "manufacturedCountry": {
               "Country": "United Kingdom of Great Britain and Northern Ireland (the)",
               "Numeric": 826
@@ -144,6 +164,7 @@ Materials should be provided as a separate csv file. The specification of this c
               },
             "certification": "FALSE",
             "certificationClaims": null,
+            "manufacturers": [""],
             "manufacturedCountry": {
               "Country": "United Kingdom of Great Britain and Northern Ireland (the)",
               "Numeric": 826
@@ -187,6 +208,7 @@ Materials should be provided as a separate csv file. The specification of this c
               },
             "certification": "FALSE",
             "certificationClaims": null,
+            "manufacturers": [""],
             "manufacturedCountry": {
               "Country": "United Kingdom of Great Britain and Northern Ireland (the)",
               "Numeric": 826
@@ -230,6 +252,7 @@ Materials should be provided as a separate csv file. The specification of this c
               },
             "certification": "FALSE",
             "certificationClaims": null,
+            "manufacturers": [""],
             "manufacturedCountry": {
               "Country": "United Kingdom of Great Britain and Northern Ireland (the)",
               "Numeric": 826
@@ -251,8 +274,14 @@ Materials should be provided as a separate csv file. The specification of this c
         "category": "carton",
         "detailed": "Box or container used for transporting and storaging goods."
       },
+      "areaDensity": "543.5",
+      "areaDensity": "gsm",
+      "areaDensityTolerance": "6",
+      "areaDensityToleranceType": "unit",
+      "areaDensityDate": "01/08/2022",
       "certification": "FALSE",
       "certificationClaims": null,
+      "manufacturers": [""],
       "manufacturedCountry": {
         "Country": "United Kingdom of Great Britain and Northern Ireland (the)",
         "Numeric": 826
@@ -271,6 +300,7 @@ Materials should be provided as a separate csv file. The specification of this c
 All measurements should be given using the metric system.
 
 - Weight: grams (g)
+- Area Density: grams per square metre (gsm) or square metres per kilogram (m^2/kg)
 
 Numbers should be entered with a decimal place. Use the decimal / full stop / period character as a separator. Do not exceed 3 decimal places. When rounding, use convential rounding methods: for 5 and above round up, 4 and below round down. For example: volume = 0.67952 rounded to 0.68. 
 

docs/3_Data_Specification/3_3_Components.md

@@ -45,6 +45,7 @@ The components schema contains information regarding the individual components t
 |recyclabilityClaims|`recommended`|List|The information regarding this recyclability claims. The entries should be the [recyclability claims relationship list](../6_Relationship_Lists/6_006_Recyclability_Claims.md) identifiers.|
 |certification|`recommended`|Boolean|Does the component have a certificate (e.g. FSC, REACH, FSA etc.)? Answer as: `TRUE` for yes and `FALSE` for no.|
 |certificationClaims|`recommended`|List|The information regarding the certifications. The entries should be the [certification claims relationship list](../6_Relationship_Lists/6_005_Certification_Claims.md) identifiers.|
+|manufacturers|`recommended`|List|The information regarding the manufacturer(s). The entries should be the [Organisations Relationship List](../6_Relationship_Lists/6_010_Organisations.md) identifiers.|
 |manufacturedCountry|`recommended`|Numeric|The country the component was manufactured in. Use the country numeric [ISO codes](https://www.iban.com/country-codes){target=_blank} as described in the ISO 3166 international standard.|
 |updateDate|`required`|String|The date that the component was provided/last updated. Use the format `dd/mm/yyyy`.|
 |releaseDate|`recommended`|String|The date that the component will be available to use. Use the format `dd/mm/yyyy`.|
@@ -83,6 +84,7 @@ MATERIALS }o--o{ COMPONENTS : within
     opacity String
     loaned Boolean
     reuseSystems String
+    manufacturers List
     manufacturedCountry Numeric
     recycledContent Numeric
     recycledContentClaims List
@@ -116,6 +118,7 @@ MATERIALS }o--o{ COMPONENTS : within
     recycledContentClaims required
     recyclabilityClaims recommended
     certificationClaims recommended
+    organisations recommended
   }
 ```
 
@@ -182,6 +185,7 @@ Components should be provided as a separate csv file. The specification of this
         "certificationClaims": [
             "eed87ac3-6e3e-45fb-af2c-dd0f64fdb597"
         ],
+        "manufacturers": [""],
         "manufacturedCountry": 372,
         "updateDate": "01/08/2022",
         "releaseDate": "01/08/2022",

docs/3_Data_Specification/3_4_Complete_Packaging.md

@@ -18,7 +18,6 @@ The complete packaging schema contains information regarding the complete packag
 |completePackagingConstituentsIdentifier|`required`|List|The information regarding the consituents that are combined to create this complete packaging. The entries should be from the [Complete Packaging Constituents Relationship List](../6_Relationship_Lists/6_003_Complete_Packaging_Constituents.md) identifier.|
 |LOWcodeWOproduct|`recommended`|String|The list of waste code for **only** the complete packaging, by itself (excluding the product). LOW code is synonymous with European Waste Catalogue Code (EWC). For example: an empty bottle would have a LOWcode of `15 01 02`. Please use [Dsposal](https://dsposal.uk/browse/ewc){target=_blank} or [legislation.gov](https://www.legislation.gov.uk/uksi/2005/895/schedule/1/made){target=_blank} to find the LOWcode. **Note**: The LOWcode can based on its combination with other components and the actual product contained in the complete packaging. Be sure to only include the complete packaging LOWcode and not the complete packaging with the product. If you cannot find the code or are uncertain please enter `Uncertain`.|
 |productType|`recommended`|String|Information about the product contained in the complete packaging. The entry here should be drawn from the [product type controlled list](../5_Controlled_Lists/5_012_Product_Type.md).|
-|componentContactWithProduct|`required`|List|What components (if any) come into direct contact with the product before purchased by a consumer? If none of the components come into contact with the product use `NA`.|
 |LOWcodeWproduct|`recommended`|String|The list of waste code for **everything** in the complete packaging. LOW code is synonymous with European Waste Catalogue Code (EWC). For example: an empty bottle would have a LOWcode of `15 01 02`. Please use [Dsposal](https://dsposal.uk/browse/ewc){target=_blank} or [legislation.gov](https://www.legislation.gov.uk/uksi/2005/895/schedule/1/made){target=_blank} to find the LOWcode. **Note**: The LOWcode can based on its combination with other components and the actual product contained in the complete packaging. Be sure to include the complete packaging LOWcode with the product. If you cannot find the code or are uncertain please enter `Uncertain`.|
 |onTheGo|`required`|Boolean|Is the complete packaging often classed as packaging that will end up in street bins? Answer as: `TRUE` for yes and `FALSE` for no.|
 |householdWaste|`required`|Boolean|Is the complete packaging often classed as packaging that will end up in kerbside collections? Answer as: `TRUE` for yes and `FALSE` for no.|
@@ -43,6 +42,8 @@ The complete packaging schema contains information regarding the complete packag
 |partOfMultipack|`required`|Boolean|Is the complete packaging part of a multipack? Answer as: `TRUE` for yes and `FALSE` for no.|
 |certification|`recommended`|Boolean|Does the complete packaging have a certificate (e.g. FSC, REACH, FSA etc.)? Answer as: `TRUE` for yes and `FALSE` for no.|
 |certificationClaims|`recommended`|List|The information regarding the certifications. The entries should be the [certification claims relationship list](../6_Relationship_Lists/6_005_Certification_Claims.md) identifiers.|
+|manufacturers|`recommended`|List|The information regarding the manufacturer(s). The entries should be the [Organisations Relationship List](../6_Relationship_Lists/6_010_Organisations.md) identifiers.|
+|manufacturedCountry|`recommended`|Numeric|The country the complete packaging was manufactured and/or combined in. Use the country numeric [ISO codes](https://www.iban.com/country-codes){target=_blank} as described in the ISO 3166 international standard.|
 |updateDate|`required`|String|The date that the complete packaging was provided/last updated. Use the format `dd/mm/yyyy`.|
 |releaseDate|`recommended`|String|The date that the complete packaging will be available to use. Use the format `dd/mm/yyyy`.|
 |discontinueDate|`recommended`|String|The date that the complete packaging will no longer be available to use. Use the format `dd/mm/yyyy`.|
@@ -61,7 +62,6 @@ COMPONENTS }o--o{ COMPLETE_PACKAGING : within
     completePackagingConstituentsIdentifier List
     LOWcodeWOproduct String
     productType String
-    componentContactWithProduct List
     LOWcodeWproduct String
     onTheGo Boolean
     householdWaste Boolean
@@ -86,6 +86,8 @@ COMPONENTS }o--o{ COMPLETE_PACKAGING : within
     partOfMultipack Boolean
     certification Boolean
     certificationClaims List
+    manufacturers List
+    manufacturedCountry Numeric
     updateDate String
     releaseDate String
     discontinueDate String
@@ -106,6 +108,7 @@ COMPONENTS }o--o{ COMPLETE_PACKAGING : within
       completePackagingConstituentsIdentifier required
       recyclabilityClaims recommended
       certificationClaims recommended
+      organisations recommended
     }
 ```
 
@@ -136,9 +139,6 @@ Complete packaging should be provided as a separate csv file. The specification
         ],
         "LOWcodeWOproduct": "15 01 06",
         "productType": "cp-product-type-0001",
-        "componentContactWithProduct": [
-            "9F459508-E365-0B9F-E3BB-FF4A7AED481B", "7197de37-8b77-4032-b0fd-84f27bae97be"
-        ],
         "LOWcodeWproduct": "20 01 08",
         "onTheGo": false,
         "householdWaste": true,
@@ -171,6 +171,7 @@ Complete packaging should be provided as a separate csv file. The specification
         "certificationClaims": [
             "eed87ac3-6e3e-45fb-af2c-dd0f64fdb597"
         ],
+        "manufacturers": [""],
         "manufacturedCountry": 826,
         "updateDate": "01/01/2023",
         "releaseDate": "01/01/2023",

docs/3_Data_Specification/3_5_Multipack.md

@@ -19,6 +19,8 @@ The multipack schema contains information regarding the multipacks that are used
 |multipackConstituentsIdentifiers|`required`|List|The information regarding the consituents that are combined to create this multipack. The entries should be from the [Multipack Constituents Relationship List](../6_Relationship_Lists/6_004_Multipack_Constituents.md) identifier.|
 |tier|`recommended`|Integer|The tier associated with the multipack. The inner most tier denoted as 1, and the outermost tier is the biggest number.|
 |identicalQuantity|`required`|Numeric|Number of identical units for the unique complete packaging item or a component this row corresponds to.|
+|manufacturers|`recommended`|List|The information regarding the manufacturer(s). The entries should be the [Organisations Relationship List](../6_Relationship_Lists/6_010_Organisations.md) identifiers.|
+|manufacturedCountry|`recommended`|Numeric|The country the multipack was manufactured and/or combined. Use the country numeric [ISO codes](https://www.iban.com/country-codes){target=_blank} as described in the ISO 3166 international standard.|
 |updateDate|`required`|String|The date that the multipack was provided/last updated. Use the format `dd/mm/yyyy`.|
 |releaseDate|`recommended`|String|The date that the component will be available to use. Use the format `dd/mm/yyyy`.|
 |discontinueDate|`recommended`|String|The date that the component will no longer be available to use. Use the format `dd/mm/yyyy`.|
@@ -38,6 +40,8 @@ COMPLETE_PACKAGING }o..o{ MULTIPACK : within
     multipackConstituentsIdentifiers List
     tier String
     identicalQuantity Numeric
+    manufacturers List
+    manufacturedCountry Numeric
     updateDate String
     releaseDate String
     discontinueDate String
@@ -48,6 +52,7 @@ COMPLETE_PACKAGING }o..o{ MULTIPACK : within
   COMPONENTS }o--o{ LOAD_CATALOGUE : within
       RELATIONSHIP_LISTS {
         multipackConstituentsIdentifier required
+        organisations recommended
     }
 ```
 
@@ -73,6 +78,8 @@ Multipack should be provided as a separate csv file. The specification of this c
       "packagingItems": "C29B4703-121C-7552-D905-FD5AB263D611",
       "tier": "1",
       "identicalQuantity": "4",
+      "manufacturers": [""],
+      "manufacturedCountry": 826,
       "updateDate": "01/08/2022",
       "releaseDate": "01/08/2022",
       "discontinueDate": "",