Skip to content

Commit

Permalink
Merge pull request #89 from OpenDataManchester/84-introduction-key-co…
Browse files Browse the repository at this point in the history
…ncepts

Various small tweaks and improvements 2023-08-11
  • Loading branch information
Julianlstar committed Aug 11, 2023
2 parents 6813232 + 5a2b5b0 commit a24f1b7
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 15 deletions.
2 changes: 1 addition & 1 deletion docs/1_Start_Here/1_1_Introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Overall, Open 3P represents an important step forward for the packaging industry

## What is an open data standard?

An open data standard is a set of guidelines that dictate the structure and composition of data. It enables people and organisations to communicate data about the same topic using the same language. Standardisation of data structure ensures consistency, comparability and interconnectivity. Open data standards are publicly accessible and can be used by anyone. This makes it easy to understand, share, and reuse data that has been published and shared by others. Open data standards are especially useful when multiple organisations are publishing data about the same subject, as it allows them to collaborate and create a larger and more comprehensive dataset. By adhering to a set of open standards, data can be shared more efficiently, allowing for greater collaboration, analysis and discovery.
An open data standard is a set of guidelines that dictate the structure and composition of data. It enables people and organisations to communicate data about the same topic using the same language. Standardisation of data structure ensures consistency, comparability and interconnectivity. Open data standards are publicly accessible and can be used by anyone. This makes it easy to understand, share, and reuse data that has been published and shared by others. As a result of open data standards, multiple organisations can collaborate and create a larger and more comprehensive dataset when they publish data about the same topic. By adhering to a set of open standards, data can be shared more efficiently, allowing for greater collaboration, analysis and discovery.

## How is the standard being developed?

Expand Down
12 changes: 11 additions & 1 deletion docs/1_Start_Here/1_2_Key_Concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ description: The key concepts to understanding the open data standard for the pa
# Key Concepts

The Open 3P data standard is to provide information about what packaging is made out of and how these materials flow through the packaging supply chain. With Open 3P, stakeholders in the packaging supply chain will be able to share information about materials, components and packaging in a standardised format. This will allow for better collaboration between manufacturers, brands, retailers, consumers, recyclers, compliance schemes and regulators.

## Packaging Ecosystem Data, Products, Waste Flows
The diagram below can help you to visualise how information might flow across the packaging supply chain using Open 3P. The standard supports data exchange between necessary parties whilst preserving a single source of truth across the industry.
``` mermaid
sequenceDiagram
participant manufacturers
Expand Down Expand Up @@ -73,6 +76,13 @@ sequenceDiagram
- Controlled Lists serve as reference points for key terms and phrases that are commonly used in the packaging industry, which are maintained and administred by the Standard Custodian Board (SCB)

## Relationship List
- Relationship lists are user-defined lists used in data standards to specify the relationships between different data elements. Unlike controlled lists relationship lists are populated by the user to provide context and clarity to the data being recorded.
- Relationship lists are user-defined lists used in data standards to specify the relationships between different data elements. Unlike controlled lists relationship lists are populated by the user to provide context and clarity to the data being recorded

## UUID
- A machine readable unique identifier generated for an entry conforming to the standard
- UUIDs improve data flow by assigning an unambiguous tag to your data
- These IDs are then used to link between layers of the standard e.g. to link components to complete packaging

## Single Source of Truth
- In information science and information technology, single source of truth (SSOT) architecture, or single point of truth (SPOT) architecture, for information systems is the practice of structuring information models and associated data schemas such that every data element is mastered (or edited) in only one place.
- [Singe source of truth wikipedia article](https://en.wikipedia.org/wiki/Single_source_of_truth){target=_blank}
2 changes: 1 addition & 1 deletion docs/3_Data_Specification/3_3_Components.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The components schema contains information regarding the individual components t
|externalIdentifiers|`recommended`|Dictionary|A dictionary of identifiers that might be used to identify the component 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'}`|
|imageURLs|`recommended`|List|A list of URLs that links to a picture of the component. Please see the guidelines below on how to capture the image and name the URL.|
|LOWcode|`recommended`|String|The list of waste code for **only** the component, by itself. 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) or [legislation.gov](https://www.legislation.gov.uk/uksi/2005/895/schedule/1/made) to find the LOWcode. **Note**: The LOWcode can based on its combination with other components and the actual product contained in the completePackaging. Be sure to only include the component LOWcode. If you cannot find the code or are uncertain please enter `Uncertain`.|
|componentConstituents|`required`|List|The information regarding the consituents that are combined to create this component. The entries should be from the [Material Constituents Relationship List](../6_Relationship_Lists/6_002_Component_Constituents.md) identifier.|
|componentConstituents|`required`|List|The information regarding the consituents that are combined to create this component. The entries should be from the [Component Constituents Relationship List](../6_Relationship_Lists/6_002_Component_Constituents.md) identifier.|
|height|`recommended`|Numeric|The height of the component. Please see the guidelines below on how to properly measure and report the height.|
|heightDate|`recommended`|String|The date that the height was last verified/measured. Use the format `dd/mm/yyyy`.|
|width|`recommended`|Numeric|The width of the component. Please see the guidelines below on how to properly measure and report the width.|
Expand Down
24 changes: 12 additions & 12 deletions docs/5_Controlled_Lists/5_012_Product_Type.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,18 @@ The product type controlled list identifies the type of product contained within
|:-|:-|:-|
|cp-product-type-0001|food|The product is fit and suitable to be eaten.|
|cp-product-type-0002|beverage|The product is fit and suitable to be drunk.|
|cp-product-type-0003|comestic|The product is used to enhance or alter the appearance of the face or body.|
|cp-product-type-0003|cosmetic|The product is used to enhance or alter the appearance of the face or body.|
|cp-product-type-0004|medicinal|The product has healing properties.|
|cp-product-type-0005|electronic|The product is electrical, electronic equipment.|
|cp-product-type-0006|clothing||
|cp-product-type-0007|toy||
|cp-product-type-0008|book||
|cp-product-type-0009|cleaning||
|cp-product-type-0010|pet||
|cp-product-type-0011|automotive||
|cp-product-type-0012|gardening||
|cp-product-type-0013|hobby||
|cp-product-type-0014|musical||
|cp-product-type-0015|construction||
|cp-product-type-0016|office||
|cp-product-type-0006|clothing|The product is worn to cover and adorn the body.|
|cp-product-type-0007|toy|The product is meant for play and entertainment.|
|cp-product-type-0008|book|The product contains written or printed material for reading.|
|cp-product-type-0009|cleaning|The product is used to remove dirt and maintain cleanliness.|
|cp-product-type-0010|pet|The product is intended for the care and enjoyment of animals.|
|cp-product-type-0011|automotive|The product is related to vehicles and transportation.|
|cp-product-type-0012|gardening|The product is used for cultivating plants and maintaining a garden.|
|cp-product-type-0013|hobby| The product supports a specific leisure-time interest or activity.|
|cp-product-type-0014|musical|The product is related to creating or producing music.|
|cp-product-type-0015|construction|The product is used in building or assembling structures.|
|cp-product-type-0016|office|The product is designed for use in a work or professional setting.|
|cp-product-type-9999|other|The product is not in the list.|

0 comments on commit a24f1b7

Please sign in to comment.