Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Just in sequence part 1.0.0 #106

Conversation

jacewski-bosch
Copy link
Contributor

@jacewski-bosch jacewski-bosch commented Mar 14, 2023

Description

Just-in-sequence (JiS) parts are parts that are made to order and delivered to a customer in a specific sequence to be built into the customer's product in the delivered sequence. Highly individualized parts like car seats or wiring harnesses are typically JiS-Parts. Some of them can't be identified by a serial number or a batch ID. But they can be identified by using a combination of their parent parts, the call-off numbers, and the call-off date used to order such a part.
Thus in order to improve the traceability of such parts, a combination of these keys is needed.
At the same time, some supply chain participants do not have a part ID (on part type level) for the individual variants of such parts, which is mandatory for serial parts. Because of this and also semantic considerations you can't reuse existing as-built models even if adapting them.

Closes #104

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 BAMM 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 "name" and "description" in English language.
  • no duplicate names or preferredNames within an Aspect (e.g. a 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"
  • file RELEASE_NOTES.md exists and contains entries for proposed model changes

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'

@jacewski-bosch
Copy link
Contributor Author

modeling_team

Improved key descriptions.
fixed encoding conversion errors
@ZazraltMagic
Copy link

  • camel case and pascal case is ok
  • names ok
  • description ok
  • metadata.json and release notes ok
  • not all property have examples

all good

@ZazraltMagic
Copy link

@bs-jokri please approve for MS2

@bs-jokri bs-jokri added the MS2_Approved Checklist "MS2 Valid Model" is approved. label Mar 20, 2023
@jacewski-bosch
Copy link
Contributor Author

[x] All required reviewers have approved this PR (see reviewers section)
[x] The new aspect (version) will be implemented by at least one data provider
[x] The new aspect (version) will be consumed by at least one data consumer
[x] There exists valid test data
[x] In case of a new (incompatible) major version to an existing version, a migration strategy has been developed
[x] The model has at least version '1.0.0'

@jacewski-bosch update copyright
other than that
MS3 approved please merge when copyright is updated @bs-jokri

updated copyright header with current year
@jacewski-bosch
Copy link
Contributor Author

@bs-jokri ready to merge (or rather fork and merge)

@bs-jokri bs-jokri added the MS3_Approved Checklist "MS3 Release Model" is approved. The associated pull request can be merged to the "main-br label Mar 27, 2023
@bs-jokri
Copy link
Contributor

Superseded by #124

@bs-jokri bs-jokri closed this Mar 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
MS2_Approved Checklist "MS2 Valid Model" is approved. MS3_Approved Checklist "MS3 Release Model" is approved. The associated pull request can be merged to the "main-br
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[New Model]: Just-in-sequence part aspect model (JustInSequencePart)
4 participants