View Issue Details

IDProjectCategoryView StatusLast Update
000901810000-005: Information ModelSpecpublic2023-06-20 19:29
ReporterJim Luth Assigned ToJeff Harding  
PrioritynormalSeverityfeatureReproducibilityhave not tried
Status closedResolutionfixed 
Product Version1.05.01 RC1 
Target Version1.05.03 RC1Fixed in Version1.05.03 
Summary0009018: Need a way to express metadata for Key- Value pairs
Description

Part 14 makes extensive use of Key-Value pairs for configuration and suggest the use of vendor specific pairs but offers no way to express any metadata for the values (e.g. description, mandatory/optional, limits ...).

TagsNo tags attached.
Commit Version1.05.03 RC
Fix Due Date

Relationships

related to 0008062 closedMatthias Damm 10000-014: PubSub Need a way to express metadata for Key- Value pairs 

Activities

Matthias Damm

2023-06-20 15:12

developer   ~0019566

This is something we can expose similar to meta data for method arguments.
Variables (in a defined location) can provide

  • BrowseName Attribute is used as key
  • DataType Attribute is the DataType of the value
  • Description
  • Value could be the default value
  • Properties like EURange provide additional information like limits or unit

Matthias Damm

2023-06-20 15:12

developer   ~0019567

Added SupportedConfigurationProperties Folder to PubSubCapabilitiesType

The Folder SupportedConfigurationProperties is the entry point for the description of configuration properties in the PubSub component KeyValuePair arrays. A configuration property is described by Variables with the following information:
• BrowseName of the Variable is used as Key for the property.
• DataType of the Variable defines the DataType of the Value in the KeyValuePair.
• Value of the Variable provides the default value for the property.
• Description of the Variable provides additional information.
• Properties like EURange or EngineeringUnits can be used to provide value ranges and units.
All common configuration properties are diretly in the SupportedConfigurationProperties Folder. For PubSub component specific configuration properties the following Folders are created in SupportedConfigurationProperties:
• PubSubConnection
• WriterGroup
• DataSetReader
• ReaderGroup
• DataSetReader
• SecurityGroup
• PushTarget

Jim Luth

2023-06-20 15:12

administrator   ~0019568

define a non-hierarchical reference to go from the instances and types directly to the metadata for the key-value pairs.

Matthias Damm

2023-06-20 15:12

developer   ~0019569

Added SupportedPubSubProperty reference type, removed SupportedConfigurationProperties Folder from PubSubCapabilitiesType and added text on how to use the SupportedPubSubProperty reference type from key-value pair configuration properties to the description.

Jim Luth

2023-06-20 15:12

administrator   ~0019570

Last edited: 2023-06-20 15:14

We decided to move this generic reference type to Part 5 and use it in Part 14. We already reviewed the text that needs to be moved to Part 5.

Jeff Harding

2023-06-20 19:07

developer   ~0019578

Added the HasKeyValueDescription ReferenceType

Note: new conformance unit ''Base Info HasKeyValueDescription" proposed to be added.

Jim Luth

2023-06-20 19:29

administrator   ~0019583

Agreed to changes in virtual F2F.

Issue History

Date Modified Username Field Change
2023-06-20 15:12 Jim Luth New Issue
2023-06-20 15:12 Jim Luth Status new => assigned
2023-06-20 15:12 Jim Luth Assigned To => Jeff Harding
2023-06-20 15:12 Jim Luth Issue generated from: 0008062
2023-06-20 15:12 Jim Luth Note Added: 0019566
2023-06-20 15:12 Jim Luth Note Added: 0019567
2023-06-20 15:12 Jim Luth Note Added: 0019568
2023-06-20 15:12 Jim Luth Note Added: 0019569
2023-06-20 15:12 Jim Luth Note Added: 0019570
2023-06-20 15:12 Jim Luth Relationship added related to 0008062
2023-06-20 15:13 Jim Luth Project 10000-014: PubSub => 10000-005: Information Model
2023-06-20 15:13 Jim Luth Commit Version => 1.05.03 RC
2023-06-20 15:14 Jim Luth Note Edited: 0019570
2023-06-20 19:07 Jeff Harding Status assigned => resolved
2023-06-20 19:07 Jeff Harding Resolution open => fixed
2023-06-20 19:07 Jeff Harding Fixed in Version => 1.05.03
2023-06-20 19:07 Jeff Harding Note Added: 0019578
2023-06-20 19:29 Jim Luth Status resolved => closed
2023-06-20 19:29 Jim Luth Note Added: 0019583