diff --git a/CHANGELOG.md b/CHANGELOG.md index 88bd0c0f..870681f8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,6 +19,7 @@ Each section shall contain a list of action items of the following format: `>, localized texts for parameter labels, alert strings, enumerations, etc. can be retrieved with the provided *LocalizedText/@Ref* (text reference) and language code from the <> *LOCALIZATION SERVICE*. + + +Text references are unique within a device scope. However, <> vendors typically use the same text strings and text references for several of their products. + +In order to reduce the effort for a <> for managing individual lookup tables per <>, a lookup table that resolves the text references for multiple <> from the same <> vendor is desirable for a <>. + +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 <> that has implemented the *<> LOCALIZATION SERVICE* is supposed to provide a unique *TEXT CATALOG* identifier in the *pm:MdsDescriptor++++++/pm:ProductionSpecification* list with *pm:ProductionSpecification++++++/pm:SpecType++++++/@Code = 68008 (MDC_ATTR_VMS_MDS_TEXT_CAT)*. + +NOTE: The unique *TEXT CATALOG* identifier defined in the corresponding *pm:ProductionSpecification++++++/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 <> that has implemented the *<> 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++++++/ProductionSpecification++++++/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 <> that provides a unique *TEXT CATALOG* identifier in the *pm:MdsDescriptor++++++/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*. +**** \ No newline at end of file diff --git a/asciidoc/volume3/tf3-ch-8.3.2-biceps-content.adoc b/asciidoc/volume3/tf3-ch-8.3.2-biceps-content.adoc index c9c8f16b..b19098c9 100644 --- a/asciidoc/volume3/tf3-ch-8.3.2-biceps-content.adoc +++ b/asciidoc/volume3/tf3-ch-8.3.2-biceps-content.adoc @@ -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[] \ No newline at end of file