View Issue Details

IDProjectCategoryView StatusLast Update
000413010000-009: Alarms and ConditionsSpecpublic2021-07-27 16:57
ReporterUstinov Vetcheslav Assigned ToPaul Hunkar  
PrioritynormalSeverityfeatureReproducibilityalways
Status closedResolutionfixed 
Fixed in Version1.05.00 
Summary0004130: 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 0006405 closedPaul Hunkar 10000-009: Alarms and Conditions Confirm Method should have text addressing empty comments 
related to 0007142 closedRandy Armstrong NodeSets, XSDs and Generated Code OPC UA Part 9. Alarm shelving methods should support "Comment" parameter 

Activities

Laszlo Szakony

2019-04-11 09:33

reporter   ~0010167

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

2019-07-18 03:02

developer   ~0010503

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

2019-07-18 15:55

reporter   ~0010533

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

2020-03-05 17:48

developer   ~0011691

Last edited: 2020-06-15 18:49

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

2020-06-15 18:51

developer   ~0012315

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

Paul Hunkar

2021-06-01 16:12

developer   ~0014454

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

Paul Hunkar

2021-07-27 04:43

developer   ~0014698

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

Jim Luth

2021-07-27 16:56

administrator   ~0014701

Agreed to changes in telecon.

Issue History

Date Modified Username Field Change
2018-01-15 14:43 Ustinov Vetcheslav New Issue
2018-01-23 17:38 Jim Luth Assigned To => Paul Hunkar
2018-01-23 17:38 Jim Luth Status new => assigned
2019-04-11 09:33 Laszlo Szakony Note Added: 0010167
2019-07-18 03:02 Paul Hunkar Status assigned => feedback
2019-07-18 03:02 Paul Hunkar Note Added: 0010503
2019-07-18 15:55 Laszlo Szakony Note Added: 0010533
2020-03-05 17:48 Paul Hunkar Note Added: 0011691
2020-03-05 20:28 Paul Hunkar Assigned To Paul Hunkar =>
2020-03-05 20:28 Paul Hunkar Assigned To => Paul Hunkar
2020-03-05 20:28 Paul Hunkar Status feedback => assigned
2020-06-15 18:49 Paul Hunkar Note Edited: 0011691
2020-06-15 18:51 Paul Hunkar Note Added: 0012315
2021-03-03 06:18 Paul Hunkar Relationship added related to 0006405
2021-06-01 16:12 Paul Hunkar Note Added: 0014454
2021-07-27 04:43 Paul Hunkar Status assigned => resolved
2021-07-27 04:43 Paul Hunkar Resolution open => fixed
2021-07-27 04:43 Paul Hunkar Fixed in Version => 1.05.00
2021-07-27 04:43 Paul Hunkar Note Added: 0014698
2021-07-27 16:56 Jim Luth Status resolved => closed
2021-07-27 16:56 Jim Luth Note Added: 0014701
2021-07-27 16:57 Jim Luth Issue cloned: 0007142
2021-07-27 16:57 Jim Luth Relationship added related to 0007142