Batch 2.0.0

[BenediktMuellerIML]

Description

Updated to Batch 2.0.0. Added Regular expression for KeyCharacteristic and removed properties nameAtCustomer and customerId for compliance reasons.

-->

Closes #281

MS2 Criteria

(to be filled out by PR reviewer)

• the model validates with the BAMM SDS SDK in the version specified in the Readme.md of this repository by the time of the MS2 check (e.g., 'java -jar bamm-cli.jar -i <path-to-aspect-model> -v ). The SAMM CLI is available here and in GitHub
• use Camel-Case (e.g., "MyModelElement" or "TimeDifferenceGmtId", when in doubt follow https://google.github.io/styleguide/javaguide.html#s5.3-camel-case)
• the identifiers for all model elements start with a capital letter except for properties
• the identifier for properties starts with a small letter
• all model elements at least contain the fields "preferred name" and "description" in English language. The description must be comprehensible. It is not required to write full sentences but style should be consistent over the whole model
• Property and the referenced Characteristic should not have the same name
• the versioning in the URN follows semantic versioning, where minor version bumps are backwards compatible and major version bumps are not backwards compatible.
• use abbreviations only when necessary and if these are sufficiently common
• avoid redundant prefixes in property names (consider adding properties to an enclosing Entity or even adapt the namespace of the model elements, e.g., instead of having two properties DismantlerId and DismantlerName use an Entity Dismantler with the properties name and id or use a URN like io.catenax.dismantler:0.0.1)
• fields preferredName and description are not the same
• preferredName should be human readable and follow normal orthography (e.g., no camel case but normal word separation)
• name of aspect is singular except if it only has one property which is a Collection, List or Set. In theses cases, the aspect name is plural.
• units are referenced from the BAMM unit catalog whenever possible
• use constraints to make known constraints from the use case explicit in the aspect model
• when relying on external standards, they are referenced through a "see" element
• all properties with an simple type have an example value
• metadata.json exists with status "release"
• generated json schema validates against example json payload
• file RELEASE_NOTES.md exists and contains entries for proposed model changes
• all contributors to this model are mentioned in copyright header of model file

MS3 Criteria

(to be filled out by semantic modeling team before merge to main-branch)

• All required reviewers have approved this PR (see reviewers section)
• The new aspect (version) will be implemented by at least one data provider
• The new aspect (version) will be consumed by at least one data consumer
• There exists valid test data
• In case of a new (incompatible) major version to an existing version, a migration strategy has been developed
• The model has at least version '1.0.0'
• The release date in the Release Note is set to the date of the MS3 approval

[bs-jokri]

Please check my comments. Json will validate as soon as the example value is fixed

[bs-jokri]

needs to be the date of the MS3 release. You can adjust after the MS3 approval on Monday

[BenediktMuellerIML]

done

[bs-jokri]

Do you really import things from the previous version of the batch model? Also, I assume, we do not have a model batch 1.0.3. I would propose to not import anything from an outdated version of a model. Thus, would remove those imports at all and, if required, copy those elements into the model.

[BenediktMuellerIML]

done

[bs-jokri]

As an info but nothing to act upon: with the industry core effort, the handling of the catenax id might be harmonized and it is required to adjust here. For now

[BenediktMuellerIML]

okay thanks

[bs-jokri]

example value does not match the regex constraint

.localIdentifiers[0].key should match pattern "^(manufacturerId|batchId)$"
"BatchID"

change example value to batchId to match

[BenediktMuellerIML]

done

[bs-jokri]

remove whitespace at the end of the string

[BenediktMuellerIML]

done

[bs-jokri]

?assembly? -> question marks? still under discussion or what does that mean?

[BenediktMuellerIML]

done

[bs-jokri]

couldn't this be improved to "^[A-Z]{3}$"?

[BenediktMuellerIML]

done

[bs-jokri]

remove whitespace als please check the remaining document, if there are further places with whitespace and the end of a string (eg L170)

[BenediktMuellerIML]

done

[bs-jokri]

@BenediktMuellerIML I have updated the example value on line 103 to produce a validating example json payload. Now MS2 can be assigned

[BenediktMuellerIML]

@BenediktMuellerIML I have updated the example value on line 103 to produce a validating example json payload. Now MS2 can be assigned

Thank you! I must have overlooked that capital D when correcting the example value.

[bs-jokri]

@BenediktMuellerIML @LuisRickert is anyone of you initiating the MS3 review today?

[LuisRickert]

@BenediktMuellerIML @LuisRickert is anyone of you initiating the MS3 review today?

Not from me, but i didn't work on this model anyway.

[jonbckr]

@BenediktMuellerIML @LuisRickert is anyone of you initiating the MS3 review today?

Yes, we will be able to initiate MS3. However, the Testdata is still in progress: https://jira.catena-x.net/projects/TDG/issues/TDG-26?filter=allopenissues

[bs-jokri]

MS3 approval conditionally given under the condition that the use case and especially the data providers verify that the intended behavior of the localIdentifier-List is to have the possibility to not provide a manufacturerId or batchId.

[jonbckr]

MS3 approval conditionally given under the condition that the use case and especially the data providers verify that the intended behavior of the localIdentifier-List is to have the possibility to not provide a manufacturerId or batchId.

We discussed it internally, and can verify that it is intended like this. However, this will need to be revised in the future.