feat(wizards/reportcontrol): add create wizard (openscd#544)

* refactor(wizards/trgops): improve code for better sharing

* refactor(wizards/optfields): improve code for better sharing

* feat(icons): add report control

* feat(foundation): add function that gives unique names

* refactor(wizards/fcda): move finder-list definition

* add to optfields commit

* add to trgops commit

* feat(wizards/reportcontrol): add create wizard and location selector

* refactor(wizards/reportcontrol): restrict parent selection to IED

* refactor(wizards/reportcontrol): better naming

* fix(wizards/reportcontrol): fix invalid parent handling

* feat(wizards/reportcontrol): hide add report button with missing valid parent

* test(wizards/reportcontrol): improve unit tests

* test(wizards/reportcontrol): add integration tests

* test: remove dead snapshot definitions

* fix: merge conflicts

* fix(wizards/reportcontrol): wrong rptID definition

* fix(wizards/reportcontrol): configuration revision handling

* fix(icons): remove unused icon

Author: JakobVogelsang

src/foundation.ts

@@ -2587,6 +2587,18 @@ export function depth(t: Record<string, unknown>, mem = new WeakSet()): number {
     }
 }
 
+export function getUniqueElementName(
+  parent: Element,
+  tagName: string,
+  iteration = 1
+): string {
+  const newName = 'new' + tagName + iteration;
+  const child = parent.querySelector(`:scope > ${tagName}[name="${newName}"]`);
+
+  if (!child) return newName;
+  else return getUniqueElementName(parent, tagName, ++iteration);
+}
+
 export function findFCDAs(extRef: Element): Element[] {
   if (extRef.tagName !== 'ExtRef' || extRef.closest('Private')) return [];
 

src/translations/de.ts

@@ -30,20 +30,34 @@ export const de: Translations = {
     dchg: 'Detenänderung ist Auslöser',
     qchg: 'Qualitätsanderung ist Auslöser',
     dupd: 'Datenupdate ist Auslöser',
+    period: 'Periodisch übertragen',
+    gi: 'Manuelle Abfrage',
     fixedOffs: 'Fester Offset',
     securityEnable: 'Aktive Sicherungsmaßnahmen',
-    DataSet: 'Datensetz',
+    DataSet: 'Datensatz',
     Communication: 'Kommunikation',
     TrgOps: 'Triggerbedingungen',
     OptFields: 'Optionale felder',
     multicast: 'SMV nach IEC 61850 9-2',
     smpMod: 'Abtast-Art',
     smpRate: 'Abtastrate',
     nofASDU: 'Abtastpunkte pro Datenpacket',
+    seqNum: 'Sequenznummer mitschicken',
+    timeStamp: 'Zeitstempel mitschicken',
+    dataSet: 'Datensatz-Reference mitschicken',
+    reasonCode: 'Was hat den Report getriggert?',
+    dataRef: 'Beschreibung der Datensatzes',
+    entryID: 'Entry ID mitschicken',
+    configRef: 'Konfigurations-Revision mitschicken',
+    bufOvfl: 'Überlauf des internen Speichers signalisieren',
+    indexed: 'Mehrere Instanzen möglich',
+    buffered: 'Gepufferter Report',
+    maxReport: 'Anzahl Instanzen',
+    bufTime: 'Min. Intervall zwischen zwei Reports',
+    intgPd: 'Intervall zwischen zwei periodischen Reports',
     SmvOpts: 'Optionale Informationen',
     refreshTime: 'Zeitstempel des Abtastwertes zu Telegram hinzufügen',
     sampleRate: 'Abtastrate zu Telegram hinzufügen',
-    dataSet: 'Datensatznamen zu Telegram hinzufügen',
     security: 'Potentiel in Zukunft für z.B. digitale Signature',
     synchSourceId: 'Identität der Zeitquelle zu Telegram hinzufügen',
   },
@@ -56,8 +70,10 @@ export const de: Translations = {
     showieds: 'Zeige IEDs im Substation-Editor',
     selectFileButton: 'Datei auswählen',
     loadNsdTranslations: 'NSDoc-Dateien hochladen',
-    invalidFileNoIdFound: 'Ungültiges NSDoc; kein \'id\'-Attribut in der Datei gefunden',
-    invalidNsdocVersion: 'Die Version {{ id }} NSD ({{ nsdVersion }}) passt nicht zu der geladenen NSDoc ({{ nsdocVersion }})'
+    invalidFileNoIdFound:
+      "Ungültiges NSDoc; kein 'id'-Attribut in der Datei gefunden",
+    invalidNsdocVersion:
+      'Die Version {{ id }} NSD ({{ nsdVersion }}) passt nicht zu der geladenen NSDoc ({{ nsdocVersion }})',
   },
   menu: {
     new: 'Neues projekt',
@@ -448,6 +464,13 @@ export const de: Translations = {
       yCoordinateHelper: 'Y-Koordinate im Einphasenersatzschaltbild',
     },
   },
+  dataset: {
+    fcda: { add: 'Daten-Attribute hinzufügen' },
+    fcd: { add: 'Daten-Objekte hinzufügen' },
+  },
+  report: {
+    wizard: { location: 'Ablageort der Reports wählen' },
+  },
   add: 'Hinzufügen',
   new: 'Neu',
   remove: 'Entfernen',

src/translations/en.ts

@@ -28,6 +28,8 @@ export const en = {
     dchg: 'Trigger on data change',
     qchg: 'Trigger on quality change',
     dupd: 'Trigger on data update',
+    period: 'Periodical Publishing',
+    gi: 'General Interrogation',
     fixedOffs: 'Fixed offset',
     securityEnable: 'Security enabled',
     DataSet: 'Dataset',
@@ -38,10 +40,22 @@ export const en = {
     smpMod: 'Sample mode',
     smpRate: 'Sample rate',
     nofASDU: 'Samples per packet',
+    seqNum: 'Add Sequence Number',
+    timeStamp: 'Add Timestamp',
+    dataSet: 'Add DataSet Reference',
+    reasonCode: 'Add Trigger Reason',
+    dataRef: 'Add description of the payload',
+    entryID: 'Add Entry ID',
+    configRef: 'Add Configuration Revision',
+    bufOvfl: 'Add Buffered Overflow information',
+    indexed: 'Multiple instances possible',
+    buffered: 'Buffered Report',
+    maxReport: 'Number of Instances',
+    bufTime: 'Min. time between two Reports',
+    intgPd: 'Time between two periodic Reports',
     SmvOpts: 'Optional Information',
     refreshTime: 'Add timestamp to SMV packet',
     sampleRate: 'Add sample rate to SMV packet',
-    dataSet: 'Add DataSet name to SMV packet',
     security: 'Potential future use. e.g. digital signature',
     synchSourceId: 'Add sync source id to SMV packet',
   },
@@ -54,8 +68,9 @@ export const en = {
     showieds: 'Show IEDs in substation editor',
     selectFileButton: 'Select file',
     loadNsdTranslations: 'Uploading NSDoc files',
-    invalidFileNoIdFound: 'Invalid NSDoc; no \'id\' attribute found in file',
-    invalidNsdocVersion: 'The version of {{ id }} NSD ({{ nsdVersion }}) does not correlate with the version of the corresponding NSDoc ({{ nsdocVersion }})'
+    invalidFileNoIdFound: "Invalid NSDoc; no 'id' attribute found in file",
+    invalidNsdocVersion:
+      'The version of {{ id }} NSD ({{ nsdVersion }}) does not correlate with the version of the corresponding NSDoc ({{ nsdocVersion }})',
   },
   menu: {
     new: 'New project',
@@ -445,6 +460,13 @@ export const en = {
       yCoordinateHelper: 'Y-Coordinate for Single Line Diagram',
     },
   },
+  dataset: {
+    fcda: { add: 'Add Data Attributes' },
+    fcd: { add: 'Add Data Objects' },
+  },
+  report: {
+    wizard: { location: 'Select Report Control Location' },
+  },
   add: 'Add',
   new: 'New',
   remove: 'Remove',

src/wizards/fcda.ts

@@ -1,23 +1,24 @@
 import { html } from 'lit-element';
-import { get, translate } from 'lit-translate';
+import { get } from 'lit-translate';
 
-import '../finder-list.js';
 import {
   createElement,
-  identity,
   selector,
   Wizard,
   WizardAction,
   WizardActor,
   WizardInput,
 } from '../foundation.js';
-import { getChildren } from './foundation/functions.js';
-import { Directory, FinderList } from '../finder-list.js';
+import { FinderList } from '../finder-list.js';
+import {
+  dataAttributePicker,
+  getDataModelChildren,
+} from './foundation/finder.js';
 
-function newFCDA(parent: Element, path: string[]): Element | undefined {
+export function newFCDA(parent: Element, path: string[]): Element | undefined {
   const [leafTag, leafId] = path[path.length - 1].split(': ');
   const leaf = parent.ownerDocument.querySelector(selector(leafTag, leafId));
-  if (!leaf || getChildren(leaf).length > 0) return;
+  if (!leaf || getDataModelChildren(leaf).length > 0) return;
 
   const lnSegment = path.find(segment => segment.startsWith('LN'));
   if (!lnSegment) return;
@@ -31,7 +32,7 @@ function newFCDA(parent: Element, path: string[]): Element | undefined {
   const prefix = ln.getAttribute('prefix') ?? '';
   const lnClass = ln.getAttribute('lnClass');
   const lnInst =
-    (ln.getAttribute('inst') && ln.getAttribute('inst') !== '')
+    ln.getAttribute('inst') && ln.getAttribute('inst') !== ''
       ? ln.getAttribute('inst')
       : null;
 
@@ -95,28 +96,6 @@ function createFCDAsAction(parent: Element): WizardActor {
   };
 }
 
-function getDisplayString(entry: string): string {
-  return entry.replace(/^.*>/, '').trim();
-}
-
-function getReader(server: Element): (path: string[]) => Promise<Directory> {
-  return async (path: string[]) => {
-    const [tagName, id] = path[path.length - 1]?.split(': ', 2);
-    const element = server.ownerDocument.querySelector(selector(tagName, id));
-
-    if (!element)
-      return { path, header: html`<p>${translate('error')}</p>`, entries: [] };
-
-    return {
-      path,
-      header: undefined,
-      entries: getChildren(element).map(
-        child => `${child.tagName}: ${identity(child)}`
-      ),
-    };
-  };
-}
-
 export function createFCDAsWizard(parent: Element): Wizard {
   const server = parent.closest('Server');
 
@@ -128,17 +107,7 @@ export function createFCDAsWizard(parent: Element): Wizard {
         icon: 'add',
         action: createFCDAsAction(parent),
       },
-      content: [
-        server
-          ? html`<finder-list
-              multi
-              .paths=${[['Server: ' + identity(server)]]}
-              .read=${getReader(server)}
-              .getDisplayString=${getDisplayString}
-              .getTitle=${(path: string[]) => path[path.length - 1]}
-            ></finder-list>`
-          : html``,
-      ],
+      content: [server ? dataAttributePicker(server) : html``],
     },
   ];
 }

src/wizards/foundation/finder.ts

@@ -0,0 +1,80 @@
+import { html, TemplateResult } from 'lit-element';
+import { translate } from 'lit-translate';
+
+import '../../finder-list.js';
+import { Directory } from '../../finder-list.js';
+import { identity, isPublic, selector } from '../../foundation.js';
+
+function getDisplayString(entry: string): string {
+  if (entry.startsWith('IED:')) return entry.replace(/^.*:/, '').trim();
+  if (entry.startsWith('LN0:')) return 'LLN0';
+  return entry.replace(/^.*>/, '').trim();
+}
+
+function getReader(
+  server: Element,
+  getChildren: (element: Element) => Element[]
+): (path: string[]) => Promise<Directory> {
+  return async (path: string[]) => {
+    const [tagName, id] = path[path.length - 1]?.split(': ', 2);
+    const element = server.ownerDocument.querySelector(selector(tagName, id));
+
+    if (!element)
+      return { path, header: html`<p>${translate('error')}</p>`, entries: [] };
+
+    return {
+      path,
+      header: undefined,
+      entries: getChildren(element).map(
+        child => `${child.tagName}: ${identity(child)}`
+      ),
+    };
+  };
+}
+
+function getIED(parent: Element): Element[] {
+  if (parent.tagName === 'SCL')
+    return Array.from(parent.querySelectorAll('IED')).filter(isPublic);
+
+  return [];
+}
+
+export function iEDPicker(doc: XMLDocument): TemplateResult {
+  return html`<finder-list
+    path="${JSON.stringify(['SCL: '])}"
+    .read=${getReader(doc.querySelector('SCL')!, getIED)}
+    .getDisplayString=${getDisplayString}
+    .getTitle=${(path: string[]) => path[path.length - 1]}
+  ></finder-list>`;
+}
+
+export function getDataModelChildren(parent: Element): Element[] {
+  if (['LDevice', 'Server'].includes(parent.tagName))
+    return Array.from(parent.children).filter(
+      child =>
+        child.tagName === 'LDevice' ||
+        child.tagName === 'LN0' ||
+        child.tagName === 'LN'
+    );
+
+  const id =
+    parent.tagName === 'LN' || parent.tagName === 'LN0'
+      ? parent.getAttribute('lnType')
+      : parent.getAttribute('type');
+
+  return Array.from(
+    parent.ownerDocument.querySelectorAll(
+      `LNodeType[id="${id}"] > DO, DOType[id="${id}"] > SDO, DOType[id="${id}"] > DA, DAType[id="${id}"] > BDA`
+    )
+  );
+}
+
+export function dataAttributePicker(server: Element): TemplateResult {
+  return html`<finder-list
+    multi
+    .paths=${[['Server: ' + identity(server)]]}
+    .read=${getReader(server, getDataModelChildren)}
+    .getDisplayString=${getDisplayString}
+    .getTitle=${(path: string[]) => path[path.length - 1]}
+  ></finder-list>`;
+}