Config Set XML

Produktlinien: Standard, Expert
Module: Leistung & CRM
Erstellt: 02.03.2018, Änderung:
configset-requirement und configset-reference (inkl. ref-name und ref-alias) aus Beschreibung entfernt. Werden ab Vertec 6.2.0.9 nicht mehr unterstützt. | Artikel umformuliert.
Mehr ansehen

Die Config Set Definition besteht aus folgenden Elementen:

<?xml version="1.0" encoding="utf-8"?>
<configset name="Spezial" author="Vertec AG">
  <comment>
  Das ist ein Kommentar, der das Configset noch näher beschreibt.
  </comment>
  <requirements/>
  <references>
    <entryid-reference class="OrdnerOeffentlich" alias="OrdnerOeffentlich0" entryid="FolderPublicFolders" />
  </references>
  <objects>
    <object class="Ordner" alias="Ordner_Spezialauswertungen0">
      <member name="Bezeichnung">Spezialauswertungen</member>
      <member name="Parentordner">
        <reference-object alias="OrdnerOeffentlich0" />
      </member>
    </object>
    <object class="ExpressionOrdner" alias="ExpressionOrdner_Projektegross1">
      <member name="Bezeichnung">Projekte gross</member>
      <member name="Parentordner">
        <reference-object alias="Ordner_Spezialauswertungen0" />
      </member>
      <member name="Expression">Projekt.allInstances-&gt;select(offeneLeistungen.wertExt-&gt;sum &gt; 10000)</member>
    </object>
  </objects>
  <settings />
</configset>

configset

Das configset Element ist das Haupt-Element eines Config-Sets. Es enthält folgende Attribute:

  • author: Autor des Config Sets. Der Wert aus dem Feld Autor im Config Set Builder wird automatisch eingetragen.
  • name: Name des Config Sets. Der Wert aus dem Feld Name im Config Set Builder wird automatisch eingetragen.
<configset name="Spezial" author="Vertec AG">
...
</configset>

Das configset Element enthält folgende Unterelemente:

comment

Das comment Element ist ein Unter-Element von configset und enthält einen beliebigen Kommentar.

 <comment>Das ist ein Kommentar, der das Configset noch näher beschreibt.</comment>

requirements

Das requirements Element ist ein Unter-Element von configset. Es kann ocl-requirements als Unter-Elemente enthalten.

Mit Requirements können Vorbedingungen definiert werden, welche erfüllt sein müssen, damit das Config Set eingelesen werden kann. Dies kann eine beliebige OCL-Expression sein. Die Requirements werden im Feld Elemente im Config Set Builder eingetragen.

Werden keine requirements angegeben, wird das Element wie folgt angegeben:

<requirements />

ocl-requirements

Das ocl-requirement: ist ein Unter-Element von requirements. Es enthält eine beliebige OCL Expression, welche True ergeben muss, damit das Config-Set importiert wird. Damit können Vorbedingungen abgefragt werden, welche für den Import des Config Sets erfüllt sein müssen, z.B. die Sicherstellung, dass eine bestimmte Zusatzklasse noch nicht belegt ist.

<requirements>
    <ocl-requirement>ClassSettings.allInstances->select(klasse='ZusatzKlasse0')->size = 0</ocl-requirement>
</requirements>

references

Das references Element ist ein Unter-Element von configset und kann selbst die Unter-Elemente entryid-reference und ocl-reference enthalten.

Es handelt sich dabei um eine Auflistung von Referenzen, welche innerhalb des Config Sets verwendet werden. Jede Referenz erhält einen innerhalb des Config Sets eindeutigen Namen.

Werden keine references angegeben, wird das Element wie folgt angegeben:

<references />

entryid-reference

Das entryid-reference Element ist ein Unter-Element von references. Es referenziert ein Objekt aufgrund seiner Klasse und seiner Eintrag Id. Auf diese Art werden im Zielsystem bereits vorhandene Objekte identifiziert. Es enhält folgende Attribute:

  • class: Klasse des Objekts mit EintragId
  • entryid : Eintrag Id des Objekts
  • alias : interner Alias zur Verwendung innerhalb des Configsets
<references>
    <entryid-reference class="OrdnerOeffentlich" alias="Alias_Parentordner" entryid="FolderPublicFolders" />
</references>

entryid-references werden beim Erstellen vom Config Set via Config Set Builder automatisch eingetragen.

ocl-reference

Das ocl-reference Element ist ein Unter-Element von references. Es referenziert ein Objekt durch Angabe einer OCL Expression. Die OCL Expression wird global ausgewertet. So kann ein im Zielsystem vorhandenes Objekt identifiziert und im Config Set damit gearbeitet werden. Es enhält folgende Attribute:

  • expression: OCL-Expression welche ein einzelnes Objekt ergeben muss.
  • alias: interner Alias zur Verwendung innerhalb des Configsets.
<references>
    <ocl-reference expression="TimSession.allInstances->first.login" alias="aktBearb" />
</references>

ocl-references werden im Feld Elemente im Config Set Builder eingetragen.

objects

Das objects Element ist ein Unter-Element von configset. Enthält die durch das Configset anzulegenden Objekte.

Die objects inklusive aller Unter-Elemente werden beim Erstellen vom Config Set via Config Set Builder automatisch eingetragen.

Es enthält folgende Unter-Elemente:

object

Das object Element ist ein Unter-Element von objects. Stellt ein durch das Configset zu erstellendes Objekt dar. Enthält eine Sammlung von member Elementen. Attribute:

  • class: Klassenname des Objekts
  • alias: Alias des Objekts

member

Das member Element ist ein Unter-Element von object. Stellt eine Eigenschaft eines Objektes dar. Attribute:

name: Name des Members (Eigenschaft)

Ein Member Element hat als Inhalt eine der folgenden Dinge:

  • Einfacher Text bei simplen Werten (string, zahl, boolean, etc)
  • object Element bei Objekten, die zum übergeordneten Objekt gehören und durch das Configset mit angelegt werden.
  • reference-object Element bei Referenzen auf Objekte, die bereits im Configset enthalten oder als reference vorausgesetzt werden.

reference-object

Das reference-object Element ist ein Unter-Element von member. Stellt ein Objekt dar, welches an anderer Stelle im Configset bereits enthalten ist. Attribute:

  • alias: Alias des referenzierten Objektes.
<objects>
    <object class="Ordner" alias="Ordner_Spezialauswertungen0">
        <member name="Bezeichnung">Spezialauswertungen</member>
        <member name="Parentordner">
            <reference-object alias="OrdnerOeffentlich0" />
        </member>
    </object>
    <object class="ExpressionOrdner" alias="ExpressionOrdner_Projektegross1">
        <member name="Bezeichnung">Projekte gross</member>
        <member name="Parentordner">
            <reference-object alias="Ordner_Spezialauswertungen0" />
        </member>
        <member name="Expression">Projekt.allInstances-&gt;select(offeneLeistungen.wertExt-&gt;sum &gt; 10000)</member>
    </object>
</objects>

settings

Das settings Element ist ein Unter-Element von configset. Es enthält system-setting Elemente, welche Systemeinstellungen darstellen, die durch das Configset gesetzt werden sollen.

settings Elemente werden im Feld Elemente im Config Set Builder eingetragen.

system-setting

Das system-setting Element ist ein Unter-Element von settings. Damit kann eine Systemeinstellung gesetzt werden. Attribute:

  • name: Als Name wird der PropertyName angegeben. Diesen finden Sie bei der Beschreibung der jeweiligen Systemeinstellung.
  • alias: bei Objekt-Properties: Alias des zu setzenden Objekts (muss im Configset oder in den externen references enthalten sein)
<settings>
    <system-setting name="GlobalWordTemplatePath">C:\Testpfad</system-setting>
</settings>