Header and History item management

[danyill]

Is your feature request related to a problem? Please describe.

Currently the SCL, Header element has limited support in OpenSCD.

For version control, file management and handling and lifecycle management this would be of use to use.

The current state is that there is a menu plugin which shows entries, see screenshot below.

However currently:

• we cannot create new history items, which include the follow attributes:

  • version -- can be empty if there is only one version (required, type: xs:normalizedString). I suggest this be a free text string.
  • revision -- defaults to empty string (i.e. before any revision / change) (required, type: xs:normalizedString). I suggest this be strictly increasing whole numbers.
  • when -- date when this version was released (according to the standard), however no format is given (required, type: xs:normalizedString). I suggest using a ISO 8601 representation of date, time and time zone in the form: 2023-08-25T23:25:42±12:00 or 2023-08-25T23:25:42Z.
  • who -- who made/approved a version/revision, optional
  • what -- what has changed, optional. I suggest this be used similar to the first line in a commit message as a summary, and a Text element be used for a more detailed description.
  • why -- why the change has happened, optional
  • within an Hitem, a Text element can be used to provide additional information on changes.

• there is no way to manipulate the Header item. The header item should include:

  • id a string identifying the SCL (can be empty) (required, type: xs:normalizedString)
  • version - the current version (should match the latest history item, presumably) (type: xs:normalizedString)
  • revision - the current revision (should match the latest history item, presumably) (default, an empty string, type: xs:normalizedString)
  • toolID - The manufacturer specific identification of the tool that was used to create the SCL file. I'd like to see OpenSCD inserted here if any modifications are made to a fail prior to saving, and ideally include the OpenSCD version (and possibly even the latest main branch commit hash to uniquely identify a rolling CI based distribution).

Describe the solution you'd like

• When a file is saved, if any changes have occurred since the previous save:
  • A new Hitem is created. The revision is incremented, the version remains the same, and the date is provided
  • There might be a setting to determine whether a popup should occur in the Save dialog for a user to change the the what, why and Text elements.
  • The toolID is updated with the correct OpenSCD ifnormation

There is also an interface where:

• The Header item can be edited to adjust and see the id and also edit a Text element with a long form description.

Suggestions for a specific user interaction

I think an editor or a menu plugin might be desirable or perhaps this information could be a dialog on a "Manage" editor plugin.

Additional information

See IEC 61850-6 Ed 2.1

See example file: TPMulticastNaming-Test-2Bus-Prot2.scd.zip with Header information from Siemens DIGSI 5.

Screenshots

[danyill]

fyi @jarradraumati

[Sander3003]

CoMPAS does have some features related to the automatic storage and creationf of the history items. See and modify the header is cleary missing.

https://demo.compas.energy/

[trusz]

@danyill will look into CoMPAS' solution and will see if that could cover this use-case.

[github-actions[bot]]

Hello there,

Thank you for opening this issue! We appreciate your interest in our project. However, it seems that this issue hasn't had any activity for a while. To ensure that our issue tracker remains organized and efficient, we occasionally review and address stale issues.

If you believe this issue is still relevant and requires attention, please provide any additional context, updates, or details that might help us understand the problem better. Feel free to continue the conversation here.

If the issue is no longer relevant, you can simply close it. If you're uncertain, you can always reopen it later.

Remember, our project thrives on community contributions, and your input matters. We're here to collaborate and improve. Thank you for being part of this journey!

[github-actions[bot]]

Hello there,

Thank you for opening this issue! We appreciate your interest in our project. However, it seems that this issue hasn't had any activity for a while. To ensure that our issue tracker remains organized and efficient, we occasionally review and address stale issues.

If you believe this issue is still relevant and requires attention, please provide any additional context, updates, or details that might help us understand the problem better. Feel free to continue the conversation here.

If the issue is no longer relevant, you can simply close it. If you're uncertain, you can always reopen it later.

Remember, our project thrives on community contributions, and your input matters. We're here to collaborate and improve. Thank you for being part of this journey!