View Issue Details

IDProjectCategoryView StatusLast Update
0007142NodeSets, XSDs and Generated CodeApi Changepublic2021-11-17 18:27
ReporterJim Luth Assigned ToRandy Armstrong  
PrioritynormalSeverityfeatureReproducibilityalways
Status closedResolutionfixed 
Fixed in Version1.05.01 RC1 
Summary0007142: OPC UA Part 9. Alarm shelving methods should support "Comment" parameter
Description

TimedShelve,OneShotShelve and Unshelve methods should support "Comment" parameter.
It's required in many applications.

TagsNo tags attached.
Commit Version
Fix Due Date

Relationships

related to 0004130 closedPaul Hunkar 10000-009: Alarms and Conditions OPC UA Part 9. Alarm shelving methods should support "Comment" parameter 

Activities

Laszlo Szakony

2021-07-27 16:57

reporter   ~0014702

Other methods should support comment as well: Suppress, Unsuppress, Reset, ... etc.
The comment paramter can be optional.
It would be fine to define, when conditions in 'interesting state' are generating events with Retain = TRUE.
In that case comments can be added to these events as well.

Paul Hunkar

2021-07-27 16:57

reporter   ~0014703

There is an AddComment method that can be called at any time to add a comment to the alarm. This can be called prior to a shelving method or after the shelving method is invoked, in any case the comment will be stored as part of the event.

Changing the signatures of the methods would be a breaking changes and likely not supported by both client and server applications.

Is there a reason that this method is not sufficient?

Laszlo Szakony

2021-07-27 16:57

reporter   ~0014704

The Signature of AddComment has an EventId.
If the condition is in the normal state, it does not have any events. AddComment cannot be used.
However shelving, suppressing can be used on conditions in normal state.
In this case, it is not defined, if the condition should generate an event by RETAIN = TRUE or RETAIN = FALSE.
Or with other words: is the condition in an interesting state or not.
If the event was generated by RETAIN = FALSE, then no comment can be added, either before or after shelving/suppressing.
If the event was generated by RETAIN = TRUE, then comment can be added after shelving/suppressing. (Generating 1 unnecessary event).
After unshelving/usuppressing if the condition is in normal state, then alway RETAIN = FALSE. No comment can be added after unshelving/usuppressing.
Comments may be added before unshelving/usuppressing. But in this case the comment would say e.g: "X.y has the condition unshelved" but the shelved state is still TimedShelved. It is not nice in a historical view.

1.) The first step I guess is to define, when is a condition in an interesting state. At least regarding the OPC UA standard fields.
2.) It should be considered, if AddComment could be called with NULL EventId, to simplify commenting Shelving/Suppressing. unshelving/usuppressing would be still a problem.
3.) Another solution could be to have an AddNextComment method, the would not change any alarm state. On the next user operation the comment would be updated in the state.

Commenting with the current specification is complicated. The above are just some suggestions, that would make commenting easier.

Paul Hunkar

2021-07-27 16:57

reporter   ~0014705

After UA meeting discussion - add optional comment to all method that do not have a comment field - include description that old system might return errors and what behavior a client should have in this case

Paul Hunkar

2021-07-27 16:57

reporter   ~0014706

decision in UA meeting - add a version 2 of all methods that do not support comments, that includes a comment

Paul Hunkar

2021-07-27 16:57

reporter   ~0014707

Agree in call that addition of new method to statemachine is not a breaking change to statemachine

Paul Hunkar

2021-07-27 16:57

reporter   ~0014708

UPdated specification to add all of the required method as version 2

Jim Luth

2021-07-27 16:57

administrator   ~0014709

Agreed to changes in telecon.

Randy Armstrong

2021-11-16 22:42

administrator   ~0015330

Added new methods to 1.05.01

Jim Luth

2021-11-17 18:27

administrator   ~0015346

Reviewed with Randy -- agreed to close.

Issue History

Date Modified Username Field Change
2021-07-27 16:57 Jim Luth New Issue
2021-07-27 16:57 Jim Luth Status new => assigned
2021-07-27 16:57 Jim Luth Assigned To => Randy Armstrong
2021-07-27 16:57 Jim Luth Issue generated from: 0004130
2021-07-27 16:57 Jim Luth Note Added: 0014702
2021-07-27 16:57 Jim Luth Note Added: 0014703
2021-07-27 16:57 Jim Luth Note Added: 0014704
2021-07-27 16:57 Jim Luth Note Added: 0014705
2021-07-27 16:57 Jim Luth Note Added: 0014706
2021-07-27 16:57 Jim Luth Note Added: 0014707
2021-07-27 16:57 Jim Luth Note Added: 0014708
2021-07-27 16:57 Jim Luth Note Added: 0014709
2021-07-27 16:57 Jim Luth Relationship added related to 0004130
2021-07-27 16:57 Jim Luth Project 10000-009: Alarms and Conditions => NodeSets, XSDs and Generated Code
2021-07-27 16:57 Jim Luth Category Spec => Api Change
2021-07-27 16:59 Jim Luth Product Version => 1.05
2021-07-27 16:59 Jim Luth Target Version => 1.05
2021-11-16 22:42 Randy Armstrong Status assigned => resolved
2021-11-16 22:42 Randy Armstrong Resolution open => fixed
2021-11-16 22:42 Randy Armstrong Note Added: 0015330
2021-11-17 18:27 Jim Luth Status resolved => closed
2021-11-17 18:27 Jim Luth Fixed in Version => 1.05.01 RC1
2021-11-17 18:27 Jim Luth Note Added: 0015346