Skip to content

Commit

Permalink
Added Unique Localized Text Catalog Identification section to volume 3.
Browse files Browse the repository at this point in the history
  • Loading branch information
PeterKranich committed Nov 29, 2024
1 parent 33d8816 commit 8ceac6c
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
[#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.

Text ids are unique within a device scope. However, <<acronym_pocd>> vendors usually use the same text catalog 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 ids for multiple <<actor_somds_provider>> from the same <<acronym_pocd>> vendor is desirable for a <<actor_somds_consumer>>.

.R0709
[sdpi_requirement#r0709,sdpi_req_level=should]
****
A <<actor_somds_provider>> that has implemented the *<<acronym_biceps>> LOCALIZATION SERVICE* should provide a unique text catalog identifier in the *pm:MdsDescriptor+++<wbr/>+++/ProductionSpecification*.
NOTE: The unique text catalog identifier can be an *urn* of type *uuid* or *oid*, e. g. *"urn:oid:1.3.6.1.4.1.1234.4.1.2.1"*.
****

.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 along with the unique text catalog identifier in the *pm:MdsDescriptor+++<wbr/>+++/ProductionSpecification*.
NOTE: The version number can be part of unique text catalog identifier, e. g. the last sub-node of the *OID*. In this case, it is not necessary that the <<actor_somds_provider>> provides a text catalog verion number in the *pm:MdsDescriptor+++<wbr/>+++/ProductionSpecification*.
****

*TBD*: #which codes can be used for the text catalog id and the version in the ProductSpecification? Do we need new codes? Can we define SDPi OIDs or some similar for that?#
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[]

0 comments on commit 8ceac6c

Please sign in to comment.