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

Merged
merged 11 commits into from
Apr 4, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Each section shall contain a list of action items of the following format: `<bri

### Changes
- Removed "and ignore" from BICEPS Content Consumer requirement ([#380](https://github.com/IHE/DEV.SDPi/issues/380))
- Added new section "Unique Localized Text Catalog Identification" to volume 3 ([#256](https://github.com/IHE/DEV.SDPi/issues/256))
- Rephrased notes, mostly to correct and maintain references to SDPi versions ([#366](https://github.com/IHE/DEV.SDPi/issues/366))
### Editorial Fixes
- Corrected typos and grammar ([#363](https://github.com/IHE/DEV.SDPi/issues/363))
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
[#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 reference) and language code from the <<acronym_biceps>> *LOCALIZATION SERVICE*.


Text references are unique within a device scope. However, <<acronym_pocd>> vendors typically use the same text strings and text references for several of their products.

In order to reduce the effort for a <<actor_somds_consumer>> for managing individual lookup tables per <<actor_somds_provider>>, a lookup table that resolves the text references for multiple <<actor_somds_provider>> from the same <<acronym_pocd>> vendor is desirable for a <<actor_somds_consumer>>.

The set of all localized text strings with their unique text reference and language code is referred to as "*TEXT CATALOG*" in the following paragraphs. When localized text strings have been added, changed, or deleted in the *TEXT CATALOG*, this is considered as a new version of the *TEXT CATALOG*.

The following best practices are highly recommended when using *TEXT CATALOGS*:

.Recommendation A
****
A <<actor_somds_provider>> that has implemented the *<<acronym_biceps>> LOCALIZATION SERVICE* is supposed to provide a unique *TEXT CATALOG* identifier in the *pm:MdsDescriptor+++<wbr/>+++/pm:ProductionSpecification* list with *pm:ProductionSpecification+++<wbr/>+++/pm:SpecType+++<wbr/>+++/@Code = 68008 (MDC_ATTR_VMS_MDS_TEXT_CAT)*.

NOTE: The unique *TEXT CATALOG* identifier defined in the corresponding *pm:ProductionSpecification+++<wbr/>+++/pm:ProductionSpec* can be a URN of type *uuid* or *oid*, e. g. *"urn:oid:1.3.6.1.4.1.1234.4.1.2.1"*.
****

.Recommendation B
****
A <<actor_somds_provider>> that has implemented the *<<acronym_biceps>> LOCALIZATION SERVICE* and supports explicit versioning of the *TEXT CATALOG* is supposed to provide a URN that includes the unique version number as part of the unique *TEXT CATALOG* identifier in the *pm:MdsDescriptor+++<wbr/>+++/ProductionSpecification+++<wbr/>+++/pm:ProductionSpec*.

NOTE: "_urn:oid:1.3.6.1.4.1.1234.4.1.2_.*1.2.2*" is an example of a unique *TEXT CATALOG* id with the *TEXT CATALOG* version "*1.2.2*" added as additional nodes to the OID.

NOTE: If the version number is already part of the unique *TEXT CATALOG* identifier, e. g. the last sub-node of the *OID*, this recommenation does not apply.
****

.Recommendation C
****
A <<actor_somds_provider>> that provides a unique *TEXT CATALOG* identifier in the *pm:MdsDescriptor+++<wbr/>+++/pm:ProductionSpecification* needs to ensure that the unique *TEXT CATALOG* identifier is updated when the *TEXT CATALOG* has changed (e. g. due to a firmware update of device with modified localized text strings).

NOTE: It is also important to ensure that the unique *TEXT CATALOG* identifier is not the same as a *TEXT CATALOG* identifier from a previous version of the *TEXT CATALOG*.
****
2 changes: 2 additions & 0 deletions asciidoc/volume3/tf3-ch-8.3.2-biceps-content.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -274,5 +274,7 @@ include::biceps-extension-provisions/tf3-ch-8.3.2.9.6-extension-equipment-identi

include::biceps-content-module/tf3-ch-8.3.2.9.7-compound-metric-modelling.adoc[]

include::biceps-content-module/tf3-ch-8.3.2.9.8-localized-text-catalog-identification.adoc[]

// 8.3.2.10
include::mdib-efficiency/tf3-ch-8.3.2.10-mdib-efficiency-considerations.adoc[]