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

Added Unique Localized Text Catalog Identification section to volume 3 #344

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

PeterKranich
Copy link
Collaborator

@PeterKranich PeterKranich commented Nov 29, 2024

πŸ“‘ Description

Added Unique Localized Text Catalog Identification section to volume 3.

Proposal is to add the text catalog id and version to the MDS/ProductionSpecification.

β˜‘ Mandatory Tasks

The following aspects have been respected by the pull request assignee and at least one reviewer:

  • Changelog update (necessity checked and entry added or not added respectively)
    • Pull Request Assignee
    • Reviewer

@PeterKranich PeterKranich added the Volume 3 Volume 3 contents label Nov 29, 2024
@PeterKranich PeterKranich added this to the SDPi 2.0 Review milestone Nov 29, 2024
@PeterKranich PeterKranich self-assigned this Nov 29, 2024
@PeterKranich PeterKranich linked an issue Nov 29, 2024 that may be closed by this pull request
@PeterKranich
Copy link
Collaborator Author

PeterKranich commented Nov 29, 2024

@d-gregorczyk: if you agree with my proposal, we need to define the codes for entries in the ProductionSpecification for the text catalog id and version. I have not found appropriate codes in the Rosetta DB. There are two codes which may fit for the text catalog id ... but I am not sure:

Status: Published
RefID: MDC_ATTR_LOCALIZN
Term Code: 1::2359
Context Free Code: 67895
Description/Definition:
DIM Name: Localization

Status: Published
RefID: MDC_ATTR_VMS_MDS_LOCALIZN
Term Code: 1::2470
Context Free Code: 68006
Description/Definition:
DIM Name: Mds_localization

Howerver, I didn't find anything for the text catalog version.

@ToddCooper
Copy link
Collaborator

SDPi Friday 2024.11.29 Review -

  1. @mfaughn verified that the two MDC_ codes above were in the first version of the -10101 nomenclature, but the definitions are ... thin.
  2. MDC_ATTR_VMS_MDS_TEXT_CAT (1::2472) - Annex B #defines of -10101 + in RTMMS ... but NO DEFINITION!
  3. Value: ID + version (e.g., OID/URN::OID::12345)

@PeterKranich - Propose a definition for the _TEXT_CAT term.

@ToddCooper
Copy link
Collaborator

SDPi Friday 2024.12.13 Review -

Discussion issues included:

  1. BICEPS does not have a concept of "text catalog", which should be added to this text
  2. Current content needs some editorial updates (e.g., capitalization, more detail in examples, etc.)
  3. Provide background for how this works in conjunction ("under the hood") with the LOCALIZATION SERVICE

@@ -0,0 +1,32 @@
[#vol3_clause_localized_text_catalog_identification]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In all those requirements, I do not see restrictions that help increasing or establishing interoperability. It currently boils down to "there is a code one can use in production specification to indicate use of text catalogs", however, there is no way of a general procedure as to how the use of text catalogs is globally applicable to all manufacturers. From this it follows that the requirements displayed herein have no effect of interoperability between manufacturers. Hence, I do not see a reason to craft requirements at all. We may rather sell this chapter as a good practice in case text catalogs are used.

"You are encouraged to signify the use of text catalogs by adding a production specification item to the affected MDSs"

[#vol3_clause_localized_text_catalog_identification]
====== Unique Localized Text Catalog Identification

In <<acronym_biceps>>, localized texts for parameter labels, alert strings, enumerations, etc. can be retrieved with the provided *LocalizedText/@ref* (text id) and language code from the <<acronym_biceps>> Localization Service.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In <<acronym_biceps>>, localized texts for parameter labels, alert strings, enumerations, etc. can be retrieved with the provided *LocalizedText/@ref* (text id) and language code from the <<acronym_biceps>> Localization Service.
In <<acronym_biceps>>, localized texts for parameter labels, alert strings, enumerations, etc. can be retrieved with the provided *LocalizedText/@Ref* (text id) and language code from the <<acronym_biceps>> Localization Service.

[#vol3_clause_localized_text_catalog_identification]
====== Unique Localized Text Catalog Identification

In <<acronym_biceps>>, localized texts for parameter labels, alert strings, enumerations, etc. can be retrieved with the provided *LocalizedText/@ref* (text id) and language code from the <<acronym_biceps>> Localization Service.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In <<acronym_biceps>>, localized texts for parameter labels, alert strings, enumerations, etc. can be retrieved with the provided *LocalizedText/@ref* (text id) and language code from the <<acronym_biceps>> Localization Service.
In <<acronym_biceps>>, localized texts for parameter labels, alert strings, enumerations, etc. can be retrieved with the provided *LocalizedText/@ref* (text id) and language code from the <<acronym_biceps>> LOCALIZATION SERVICE.

.R0710
[sdpi_requirement#r0710,sdpi_req_level=should]
****
A <<actor_somds_provider>> that has implemented the *<<acronym_biceps>> LOCALIZATION SERVICE* and supports versioning of the text catalog should provide a unique version number concatenated with the unique text catalog identifier and separated from the unique text catalog identifier by two colons (*"::"*) in the *pm:MdsDescriptor+++<wbr/>+++/ProductionSpecification+++<wbr/>+++/pm:ProductionSpec*.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This requirement is too weak to have a significant effect on interoperability.


NOTE: *"urn:oid:1.3.6.1.4.1.1234.4.1.2.1::v1.2.2*" is an example of a unique text catalog id with a concatenated text catalog version.

NOTE: The version number can be part of unique text catalog identifier, e. g. the last sub-node of the *OID*. In this case, the requirement does not apply.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

According to the requirement, that is exactly how it is not supposed to be modelled as such an identifier would lack the double colon, right?

.R0711
[sdpi_requirement#r0711,sdpi_req_level=shall]
****
A <<actor_somds_provider>> that provides a unique text catalog identifier in the *pm:MdsDescriptor+++<wbr/>+++/pm:ProductionSpecification* list but does not support versioning of the text catalog shall provide a new unique text catalog identifier for each new version of the text catalog.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"A provider that does not support versioning of text catalogs shall provide a new identifier for each new version" sounds odd. If versioning is not supported, there is no need to generate new identifiers.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Volume 3 Volume 3 contents
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

Unique identification of text catalog
3 participants