Config Sets

Zusatzfunktionen werden als XML-Datei in Form von Config Sets in Vertec importiert. Eine Übersicht der zur Verfügung stehenden Zusatzfunktionen finden Sie hier. Da sich Config Sets auf das gesamte Vertec auswirken, können Sie nur durch einen Administrator importiert werden.

Artikelübersicht:

• Config Sets importieren
• Config Sets erstellen
• Config Sets exportieren
• Config Sets bearbeiten
• Config Sets entfernen/löschen

In den jeweiligen Artikeln können die Zusatzfunktionen via Link heruntergeladen und anschliessend in Vertec über das Menü Einstellungen mithilfe des Config Set Dialogs importiert werden:

Mit dem Button Importieren kann das heruntergeladene Config Set schliesslich ausgewählt und importiert werden:

Hinweis: In der Web App sind die Buttons Neu und Bearbeiten nicht vorhanden, da es sich um einen nicht-modalen Dialog handelt, welcher Klicks in den Vertec Baum zulässt, was in der Web App nicht abgebildet werden kann.

Beim Importieren wird das Config Set zuerst auf Plausibilität geprüft. Folgende Bedingungen müssen erfüllt sein:

• Im Config Set explizit formulierte Vorbedingungen sind erfüllt
• Alle aufgeführten externen Referenzen sind vorhanden
• Alle internen Aliases sind eindeutig
• Members mit Referenzen verweisen auf definierte Aliases
• Im Config Set enthaltene Zusatzklassen sind im System noch nicht vorhanden
• Im Config Set enthaltene Zusatzfelder sind im System noch nicht vorhanden

Falls Fehler auftreten, wird eine Fehlermeldung ausgegeben und das Config Set nicht angewendet. Sind keine Fehler vorhanden, wird die Zusatzfunktion importiert und die entsprechenden Objekte in Vertec erzeugt.

Nach dem Import eines Config Sets erscheint dieses in der Liste des Config Set Dialogs:

In Python gibt es eine Methode importconfigset(), welche ein Config Set als String (oder als Datei) akzeptiert.

Für das Erstellen von Config Sets steht in der Cloud und Desktop App der Config Set Builder zur Verfügung. Dieser ermöglicht das interaktive Zusammenstellen der Zusatzfunktionen und exportiert daraus das Config Set in Form einer XML-Datei. Um ein neues Config Set zu erstellen, klicken Sie im Config Set Dialog auf den Button Neu.

Es öffnet sich der Config Set Builder:

Dieser hat folgende Felder:

<version-requirement>6.7.0.1</version-requirement>

In diesem Feld können Vertec-Objekte hinzugefügt oder entfernt werden. Alle Objekte, die im Config Set enthalten sind, werden hier aufgelistet.

Um ein bestimmtes Objekt in die Liste aufzunehmen, wird dieses im aktiven Vertec-Fenster selektiert und anschliessend im Config Set Builder via + Button oder direkt per Drag&Drop ins Feld gezogen. Bei hierarchischen Objekten werden die Unterobjekte automatisch mitgenommen. Im Falle einer Ordnerstruktur muss z.B. nur der Überordner eingefügt werden. Durch Mehrfach-Auswahl in einer Vertec-Liste und Drag&Drop können mehrere Objekte gleichzeitig in ein Config Set gezogen werden.

Um ein Objekt aus der Config Set Liste zu entfernen, wird es markiert und der - Button geklickt.

Listeneinstellungen und Objekt Aliases

Um nur die Listeneinstellungen eines Objektes im Config Set aufzunehmen, kann via Rechtsklick die Option Listeneinstellungen anstelle von Ordner verwenden ausgewählt werden. Damit werden nur die Listeneinstellungen, nicht aber der Ordner exportiert. In diesem Fall muss der entsprechende Ordner jedoch via Eintrag Id bereits im Zielsystemvorhanden sein.

Ausserdem werden Objekte mit einem Alias versehen und können damit innerhalb des Config Sets oder von einem anderen Config Set aus explizit referenziert werden. Innerhalb eines Config Sets muss ein Alias eindeutig sein. Der Alias kann via Rechtsklick auf das Objekt umbenannt werden:

Bestehende Objekte

In bestimmten Situationen wird für ein Objekt-Element in einem Config Set kein neues Objekt angelegt, sondern die Eigenschaften eines bestehenden Objekts geschrieben.

• Falls das Objekt eine Eintrag Id hat, wird zuerst in der entsprechenden Klasse nach dem bestehenden Objekt gesucht und dieses aktualisiert.
• Klasseneinstellungen werden speziell behandelt: Normalerweise wird aufgrund des Klassennamens nach dem bestehendem Objekt gesucht. Diese Spezialbehandlung gilt jedoch nicht für Klasseneinstellungen von Zusatzklassen – dort wird ein Fehler gemeldet, falls Klasseneinstellungen für eine bestehende Zusatzklasse verändert werden sollen. Siehe dazu auch den Abschnitt Behandlung von Spezialfällen weiter unten.
• Das Setzen von Eigenschaften auf ihren Standardwert (z.B. String auf Leerstring) bei bestehenden Objekten wird nicht unterstützt.

Verwendung der Eintrag Id

Die Eintrag Id von Vertec Objekten ist zentral bei der Handhabung von Config Sets. Über die Eintrag Id wird identifiziert, ob das Objekt in der Zieldatenbank bereits besteht oder nicht.

Objekte, die ohne Eintrag Id Referenz übergeben werden, werden im Zielsystem neu erzeugt.

Bei der Erstellung eines Config Sets wird beim Einfügen eines Objekts darauf geachtet, ob der Überordner (Parentordner) eine Eintrag Id hat. In diesem Fall wird davon ausgegangen, dass der Überordner im Zielsystem bereits besteht und das Objekt darin erzeugt werden kann.

Wird ein Objekt, welches mit einer Eintrag Id referenziert wird, im Zielsystem nicht gefunden, wirft der Import einen Fehler.

Wichtig ist deshalb, dass alle von Vertec mitgelieferten Strukturdaten (Ordner, Linktypen) in Vertec eine Eintrag Id haben bzw. auf jedem Objekt eine Eintrag Id gesetzt wird.

Soll im Rahmen eines Config Sets eine bestimmte Zusatzklasse konfiguriert werden, muss sichergestellt werden, dass diese im Zielsystem noch nicht verwendet wird. Dazu kann ein entsprechendes OCL-Requirement formuliert werden.

Wird ein Objekt, welches über Zusatzfelder verfügt, zu einem Config Set hinzugefügt, dann werden automatisch auch die Feldwerte und die entsprechenden Zusatzfeld-Definitionen hinzugefügt. Diese müssen über keine Eintrag Id verfügen, sondern werden via Klasse und Name eindeutig identifiziert.

Falls sich die Zusatzfelder auf einer Zusatzklasse befinden, wird die Referenz ebenfalls direkt eingetragen. Hier muss sichergestellt sein, dass im Zielsystem nicht bereits eine andere Zusatzklasse mit derselben Nummer befindet, denn die Klasse wird auf den Zusatzfeldern einfach entsprechend eingetragen und wären somit falsch verknüpft.

Möchte man die Klasseneinstellungen der Zusatzklasse ebenfalls übertragen, müssen diese dem Config Set separat hinzugefügt werden.

Berechtigungen können nicht einzeln via Config Set übertragen werden, sonst erscheint eine Fehlermeldung in der Art

Die Eigenschaft "Benutzer" von "ObjektRecht" verweist auf ein Objekt welches nicht im Config Set enthalten ist

Stattdessen muss dem Config Set die übergeordnete Benutzergruppe hinzugefügt werden. Dadurch werden auch alle ihre Berechtigungen mit exportiert. Dabei muss darauf geachtet werden, dass jede Berechtigung über eine Eintrag-Id verfügt, sonst wird sie bei wiederholtem Import mehrfach angelegt.

Bei der Übergabe von MLStrings wird nicht mehr nur der Text in der aktuellen Sprache, sondern alle angegebenen Sprachen inklusive der mit dieser Version eingeführten nativen Sprache übertragen.

Das bedeutet folgendes:

• Ist nur ein Begriff in der aktuellen Sprache angegeben, wird das Attribut als normaler String übertragen. In diesem Fall funktioniert der Import weiterhin mit allen Versionen.
• In jedem anderen Fall (also auch wenn nur ein nativer Begriff angegeben ist) werden die angegebenen Sprachen als mltext-Attribute übergeben. Dieses Element besteht erst ab Version 6.4, was bedeutet:
  • Früher erstellte Config Sets können auch mit neueren Vertec Versionen importiert werden
  • Ab Vertec 6.4 erstellte Config Sets können mit älteren Vertec Versionen nicht importiert werden, wenn mehr als ein Begriff in der aktuellen Sprache in den MLString-Attributen angegeben ist.

Sollen bestehende Systemeinstellungen geschrieben oder neue Systemeinstellungen angelegt werden, muss dies manuell geschehen. Das genaue Vorgehen ist im Artikel Config Set XML beschrieben.

Custom-Links

Ab Vertec 6.7.0.7 können Custom-Links via Config Set angelegt werden.

Dafür müssen beide verlinkten Objekte sowie der Custom-Link-Typ im Config Set vorhanden oder auf dem Zielsystem mit korrekter Eintrag Id bereits vorhanden sein.

Durch Klick auf den Button Export erstellt der Config Set Builder eine XML-Datei, welche auf dem Dateisystem abgespeichert werden kann.

Um ein bestehendes Config Set zu bearbeiten, markieren Sie es in der Liste und klicken auf den Button Bearbeiten (nur Desktop App und Cloud App). So gelangen Sie wieder in den Config Set Builder und können das Config Set wie beschrieben anpassen und danach wieder exportieren.

Fortgeschrittene können das Config Set natürlich auch direkt im XML-File anpassen, unter Berücksichtigung der beschriebenen Config Set XML Gültigkeitsbedingungen.

Dieses Config Set kann dann in der Zielinstallation importiert werden.

Config Sets können im Config Set Dialog entweder entfernt oder gelöscht werden:

• Beim Entfernen bleiben die Objekte im System.
• Beim Löschen werden alle mit dem Config Set verbundenen Objekte gelöscht.

Entfernen

Markieren Sie das entsprechende Config Set in der Liste und klicken Sie auf Entfernen.

Das Config Set wird aus der Liste entfernt, die Objekte verbleiben jedoch im System. Das Entfernen von Config Sets dient vor allem dazu, diese vor einem allfälligen Löschvorgang zu schützen.
Das Config Set kann nicht erneut importiert werden, da die Objekte sonst doppelt vorhanden sind. Es gibt keine Möglichkeit, ein Config Set in die Liste aufzunehmen, ohne damit die Objekte neu zu erzeugen.

Löschen

Klicken Sie mit der rechten Maustaste auf das entsprechende Config Set und wählen Sie Löschen:

Achtung! Dieser Vorgang löscht alle durch das Config Set erzeugten Objekte. Wurde mit diesen bereits weitergearbeitet, gehen damit auch alle gemachten Änderungen verloren. Vom Config Set ausgelöste Anpassungen an bereits vorher bestehenden Objekten werden nicht rückgängig gemacht. Um ein Config Set vor dem Löschen zu schützen, kann es aus der Liste entfernt werden (Entfernen).