Zusatzfelder

Die Liste der vorhandenen Felder in Vertec wird durch das Modell vorgegeben und kann nicht geändert werden. Da es jedoch vorkommt, dass Sie auf Daten noch zusätzliche Informationen ablegen wollen (z.B. Auftragswahrscheinlichkeit auf Projekt), gibt es Zusatzfelder.

Zusatzfelder werden unter Einstellungen > Customizing > Zusatzfelder verwaltet. Jedes Zusatzfeld basiert auf einer Zusatzfeldklasse. Wenn Sie ein neues Zusatzfeld erzeugen müssen, klicken Sie via Neu-Menü oder Rechtsklick auf den Ordner und wählen Sie Zusatzfeld.

Die Zusatzfelder erscheinen in der Einzelansicht der entsprechenden Einträge auf der Seite Weitere Info:

Ausserdem können sie auch via Customizing an einem anderen Ort platziert werden.

Übersetzung von Auswahlzusatzfeldern

Ab Vertec 6.5.0.15 werden die Strings in Auswahlzusatzfeldern übersetzt, wenn die Zusatzfeld-Definition (ZusatzfeldKlasse) über eine Eintrag Id verfügt.

• Bei einem Auswahl-Zusatzfeld in einer Liste:
  • Expression: zusatzfeldint(<name>)
  • Steuerelement: cmbZusatzfeld
  • Renderer: rndZusatzfeld
  sind die Auswahloptionen übersetzt, falls die Zusatzfeld-Definition eine Eintrag Id gesetzt hat.
• Auch in nicht selektierten Zellen in der Liste erscheint der übersetzte Text.
• Wenn ein übersetztes Auswahlzusatzfeld als erstes Feld einer Zusatzklasse verwendet wird, dann zeigt die Stringrepresentation einer Zusatzklassen-Instanz auf den übersetzten Wert. Die Zusatzklassen Instanz muss dazu keine Eintrag Id haben (es reicht die Eintrag Id auf der Zusatzklassen Definition).
• Im Code können zum Setzen des Auswahlzusatzfeldes alle 3 folgenden Varianten verwendet werden:
  • Setzen des Auswahl Index (integer Wert)
  • Setzen des übersetzten Textes in der ausgewählten Sprache
  • Setzen des unübersetzten Textes (native Sprache)

Falls Sie Auswahlzusatzfelder definiert haben und diese übersetzen möchten, setzen Sie auf der entsprechenden Zusatzfeld-Definition eine Eintrag Id. Wie das geht, finden Sie im Artikel Sprachen/Begrifflichkeit im Abschnitt mit den Übersetzungen ab Version 6.4.0.9.

Sie können diese Zusatzfelder auch in Listen anzeigen, in Scripts und Berichten verwenden oder in einem Expression-Ordner danach filtern, indem Sie via OCL darauf zugreifen. Auch die Abfrage via SQL-Ordner ist möglich.

Wichtig ist dabei, zu beachten, dass die Zusatzfelder auf schon bestehenden Vertec-Objekten erst erzeugt werden, wenn darauf entsprechend zugegriffen wird. Vorher sind sie in der Datenbank nicht vorhanden, was beim Zugriff via SQL aber essenziell ist.

Wann werden Zusatzfelder angelegt?

Neues Objekt wird erzeugt

Wird ein neues Objekt erzeugt, werden alle zugehörigen Zusatzfelder angelegt.

Neues Zusatzfeld wird auf einem bestehenden Objekt angelegt

Bei bereits bestehenden Objekten werden die Zusatzfelder bei folgenden Vorgängen angelegt:

• Bei der Darstellung in einem Detailfenster.
• Per Script wird das Feld angelegt, wenn es beschrieben wird: projekt.jahr = 2022 (Beispiel: Ganzzahl-Zusatzfeld jahr auf Projekt). Es kann auch einfach entsprechend initialisiert werden: projekt.jahr = 0
• Per Script wird das Feld auch angelegt, wenn es gelesen wird, aber nur via OCL. Das heisst: der Lese-Zugriff via Python (z.B. myyear = projekt.jahr) legt das Feld nicht an, aber der Lesezugriff via OCL schon: myyear = projekt.evalocl("zusatzfeldint('jahr')")
• Via Listeneinstellungen, wenn in einer Spalte auf das Feld "schreibend" zugegriffen wird. Das muss nicht wirklich schreibend sein, aber es muss so sein, dass Vertec das Gefühl hat, dass geschrieben werden könnte: zusatzfeldasstring(...) beispielsweise geht nicht, da dies ein reiner Lesezugriff ist; zusatzfeldint(...) hingegen legt das Feld an, da über diese Expression auch geschrieben werden kann. (Hinweis: Diese Einschränkung gilt nur bei Listeneinstellungen. Beim Lesezugriff via OCL in Scripts, wie in Punkt 3 beschrieben, gilt das nicht, dort wird das Feld auch beim reinen Lesezugriff angelegt)

Der Grund für das etwas komplexe Verhalten bei Variante 3 und 4 ist die Optimierung, welches bei einem nicht vorhandenen Zusatzfeld den Standardwert zurückgibt, da ein Schreibzugriff nur aufgrund einer Anzeige möglichst verhindert werden, aber keine Fehlermeldung erscheinen soll.

Via SQL (z.B. via SQL-Ordner) ist das Feld erst zugänglich, wenn es angelegt wurde. Deshalb sollten die Zusatzfelder auf Klassen, von denen bereits Objekte bestehen, immer direkt angelegt werden.

Zusatzfelder für bestehende Objekte anlegen

Nach Anlegen eines Zusatzfeldes kann man ein Script laufen lassen, welches das Feld auf allen bereits bestehenden Objekten anlegt, in der Art:

projekte = vtcapp.evalocl("projekt")
for projekt in projekte:
    projekt.jahr = 0

vtcapp.updatedatabase()

Wie die verschiedenen Zusatzfeldtypen initialisiert werden, finden Sie im Abschnitt Python weiter unten.

Über OCL kann auf die verschiedenen Zusatzfelder folgendermassen zugegriffen werden:

• zusatzfeldAsString(name): liefert den Wert eines Zusatzfeldes unabhängig von dessen Typ als Stringwert.
  • Abhängig vom Typ wird das Feld folgendermassen abgefragt:

    Zusatzfeldtyp	Operator	Default Rückgabewert (wenn noch nichts explizit gesetzt wurde)
    Zeichen	zusatzfeld	Leerstring
    Wahr, Falsch	zusatzfeldbool	Falsch
    Ganzzahl	zusatzfeldint	0
    Minuten	zusatzfeldint	0
    Festkommazahl	zusatzfeldcurr	0.00
    Datum	zusatzfelddate	NULL
    Bild	zusatzfeldblob	NULL
    Objekt	zusatzfeldobj (siehe Tipps weiter unten)	NULL
    Auswahl	zusatzfeldint (gibt Position der Auswahl zurück) zusatzfeldasstring (gibt den Auswahltext zurück)	0 Erster Wert der Liste
    Text	zusatzfeld	Leerstring
    ANSI Text (Legacy)	zusatzfeldblob	NULL

    Beispiel: Alle Adressen, die als ABC-Adressen gekennzeichnet sind (Wahr,Falsch-Zusatzfeld "ABC-Adresse" auf Adresseintrag):

    adresseintrag->select(zusatzfeldbool('ABC-Adresse'))

Python

Der Zugriff auf Zusatzfelder erfolgt in Python ganz einfach über den Zusatzfeldnamen, also z.B. projekt.jahr.

Der reine Lesezugriff ( myyear = projekt.jahr) legt das Feld nicht an (siehe Abschnitt Wann werden Zusatzfelder angelegt weiter oben), der Schreibzugriff hingegen schon ( projekt.jahr = 2022). Möchte man das Feld anlegen, ohne einen Wert zu setzen, kann es wie folgt initialisiert werden:

Über SQL kann auf die verschiedenen Zusatzfelder folgendermassen zugegriffen werden:

Detaillierte Beschreibung und Beispiele finden Sie im Artikel SQL-Expressions für SQL-Ordner.

Zusatzfelder können via Customizing auch in Listen und in den Seiten platziert werden. Dabei gilt folgende Matrix zur Auswahl des Steuerelementes:

<AddressReferenceBox Label="Adresse" 
    ValueExpression="zusatzfeldobj('ZeichenAdresse')" />

<PathBox Label="File" 
    ValueExpression="zusatzfeld('File')" SelectType="FileOpen" />

<PathBox Label="File" 
    ValueExpression="zusatzfeld('File')" ShowNavLinkButton="True" SelectType="FileOpen" />

<PathBox Label="Pfad" 
    ValueExpression="zusatzfeld('Pfad')" SelectType="Folder" />

<PathBox Label="Pfad"
    ValueExpression="zusatzfeld('Pfad')" ShowNavLinkButton="True" SelectType="Folder" />

<TextBox Label="Zeichen" ValueExpression="zusatzfeld('Zeichen')" />

<CheckBox Label="Wahr, Falsch" 
    ValueExpression="zusatzfeldbool('WahrFalsch')" />

<TextBox Label="Ganzzahl" 
    ValueExpression="zusatzfeldint('Ganzzahl')" />

<TextBox Label="Minuten" ValueExpression="zusatzfeldint('Minuten')" 
    Converter="Minutes" />

<TextBox Label="Festkommazahl" 
    ValueExpression="zusatzfeldcurr('Festkommazahl')" />

<DatePicker Label="Datum" 
    ValueExpression="zusatzfelddate('Datum')" />

<TextArea Label="Text" 
    ValueExpression="zusatzfeldblob('Text')" Lines="4" />

<Image Label="Bild" 
    ValueExpression="zusatzfeldblob('Bild')" Height="150" />

<AddressReferenceBox Label="Adresse" 
    ValueExpression="zusatzfeldobj('ObjektAdresse')" />

<TreeReferenceBox Label="Ordner" 
    ValueExpression="zusatzfeldobj('ObjektOrdner')" 
    BrowseClass="Container" SelectFilter="AbstractOrdner" />

<AdditionalFieldComboBox Label="Objekt" 
    ValueExpression="zusatzfeldobj('Objekt')" />

<AdditionalFieldComboBox Label="Auswahl" 
    ValueExpression="zusatzfeldint('Auswahl')" />

<TextArea Label="Text" ValueExpression="zusatzfeld('Text')" Lines="4" />

In den meisten Fällen kommt das auf der Oberfläche auf dasselbe heraus, da schlussendlich meist ein String dargestellt wird.

Unterschied gibt vor allem bei Auswahl-Zusatzfeldern. Diese sind intern als Integer Zusatzfelder implementiert. Das bedeutet, dass die Expression zusatzfeldint(name) eine Zahl liefert. Wenn der Text der Auswahl angezeigt werden soll, dann sollte die expression zusatzfeldasstring(name) verwendet werden.

Ebenso liefern die typspezifischen OCL Operatoren NULL Werte, falls das Zusatzfeld den Wert NULL hat. Dies stellt aber in den meisten Fällen kein Problem dar, da NULL Werte als Leerstrings dargestellt werden. Falls ein NULL Wert Probleme macht, kann dies durch Verwendung von zusatzfeldAsString vermieden werden.

Der Operator zusatzfeldObj zum Abfragen von Objekt-Zusatzfeldern kann zu Fehlern führen, wenn er in einer OCL Expression auf einer Liste von Objekten angewendet wird. Die Fehlermeldung lautet:

TBoldObjectList.AddElement: Element not a TBoldObject

Beispiel: Objektzusatzfeld 'Niederlassung' auf Projektbearbeiter. Zeigt z.B. auf eine Adresse.

offeneLeistungen.bearbeiter.zusatzfeldobj('Niederlassung')->asset->size

sollte die Anzahl verschiedener Niederlassungen in einer Leistungliste angeben. Gibt aber den obigen Fehler.

offeneLeistungen.bearbeiter->collect(zusatzfeldObj('Niederlassung')->oclasType(UserEintrag))->asset->size

Die Anwendung von zusatzfeldObj auf eine Liste entspricht einer impliziten "collect" Operation. Diese schlägt fehl, weil zusatzfeldObj nicht direkt das verknüpfte Objekt, sondern das Verknüpfungsfeld liefert.

Eine Typumwandlung auf einen kompatiblen Objekttyp (den eigentlichen Typ des Objekts oder UserEintrag) behebt das Problem. Damit die Typumwandlung stattfinden kann, muss die collect Operation explizit formuliert werden.