opentripmodel / otm5-change-requests

Tracking and reporting bugs and change requests of the OTM5 specification.
5 stars 1 forks source link

Maintain & offer OTM5-endpoints for code lists #27

Closed BobZuidhoek closed 2 years ago

BobZuidhoek commented 3 years ago

I'd like to add something to the OTM 5 spec.

What would you like to add or change to the specification? Please be as clear and concise as possible.

Within Transport Orders (and its relating context such as Goods, Location, etc.) a handful of code lists are used to populate fields. I would like to see that OTM maintains these code lists in a central place and offers API's to download (sync) the code list to local systems (e.g. TMS, ERP).

The desired way is that we position the code lists as advisory code lists (to promote standardization).

A couple of code lists come to mind...

A code list for list for tertiary & secondary packaging This would be the code list for the PackagingMaterial / EquipmentType / EquipmentSubtype attribute in Goods.

This is the code list for things like pallets, trolleys, crates, carton, box, etc. They can be one-way packaging, but also RTI (Returnable/Reusable Transport Items). If this is not standardized and we would, for example, want to communicate a 120x80 Euro pallet, different codings like "EPAL", "Europallet", "EPAL120x80", "Euro", etc pass by. It makes sense that a OTM-standardized list is kept for this. This ensures proper and quick mapping of messages from and to internal company systems.

The challenge with this particular code list is that several code lists exist, that all complement each other.

So for this list, OTM should take a leading role in maintaining the content of the code list.

Other code lists should be maintained & downloadable via API for completeness and ensuring standardization

Describe alternatives you've considered None. Particularly packaging codes are hard to standardize if not not centrally maintained.

bmeesters commented 3 years ago

Hello Bob,

We have talked about using more standardized code lists in OTM before and as far as I can tell everyone is in favor. The problem however is indeed the one you describe, there are already quite a few and they seem to be partly overlapping and partly complementary.

Up until now we did not have time to start digging into this too much ourselves, which is why the code lists did not make it in yet. Our focus has been mostly about enabling parties to express their use cases and extend OTM where necessary. I am sure it will make it in eventually, but if you want it quickly you can take a leading role and start assembling the ones you need. Otherwise I am not sure how soon this will land.

edit There already was some work done that I overlooked. We are checking how much work we still need to do.

bmeesters commented 3 years ago

@woutvandenheuvel did some preliminary work together with Menno Lambooy looking at available code lists.

OTM5 currently supports (part of) the GS1 transport role parties and GS1 transport modes

Wout and Menno propose (if I understood correctly):

On top of that I think the suggestions of Bob are good:

Regarding document types I am also not sure whether one exists, but we could maintain one ourselves for now.

BobZuidhoek commented 3 years ago

Note about the CBS commodity codes:

Customs organizations (countries or trade zones) further specify HS-code system into more specific parts (as EU does with TARIC). Some countries or trade zones make no further specification other than the HS-code itself.

Note that technically 'numbers' in these nomenclature can begin with leading 0's (which truly are part of the number). Therefore, these fields are essentially alfanumerical.

bmeesters commented 2 years ago

This issue is partly resolved. We have included the ISO standard for country codes, currencies, GS1 standard for package material and more thoroughly documented the use of other types measure units. There is still room for improvement but those are better tracked in separate smaller tickets.