material-identity / CoA-schemas

A JSON data structure for Digital Certificates of Analysis of plastics and other materials
https://materialidentity.org
GNU Affero General Public License v3.0
3 stars 1 forks source link

[EP] Suppress translation of CAMPUS property names #44

Open stiebitzhofer opened 2 years ago

stiebitzhofer commented 2 years ago

Describe the problem

In schema version 0.2.0 support for CAMPUS property identifiers was added. In addition an automated translation of property names to all languages supported by the CoA format was implemented.

Some industry stakeholders expressed concerns about the validity of the translations, despite the fact that translations have been provided by an ISO 17100 certified translation agency. They want to be able to provide the CAMPUS property identifiers but keep the property names currently provided.

This EP specifies a solution to control the translation by a simple flag to be added to the JSON document.

Specify the details

  1. Convert PropertiesStandard into an object
"PropertiesStandard": {
    "Name": "CAMPUS",
    "Translation": false
}
  1. If the value of Translation is false the value for Property in each Inspection object won't be substituted with the value from the translation tables.
"Inspections": [
    {
      "PropertyId": "46",
      "Property": "Viskositaetszahl",
      "Method": "ISO 1628-5",
      "Unit": "ml/g",
      "Value": "133.0"
    }
]
  1. If the value of PropertiesStandard/Translation is true the value for Property in each Inspection object won't be substituted with the value from the translation tables. For the example above the value Viskositaetszahl will be substituted with Coefficient de viscosité for rendering the certificate in French.

Explain the benefits

The creator of certificates has more control over the names of properties used in PDF and HTML renderings.

getlarge commented 2 years ago

Changing PropertiesStandard to an object is a big breaking change, instead creating a new property inside the analysis would keep compatibility with current schema-tools implementation and v0.2 of the schema. Something like a boolean called UsePropertiesStandardTranslations

stiebitzhofer commented 2 years ago

Agree.