Metadaten mit YML definieren (metadata.yml)

Anstelle des Metadaten-Designers bietet sich die metadata.yml-Datei an. Hier deklarierte Metadaten werden einfacher und schneller migriert. Des Weiteren ist ein Export von etwa einem Testsystem in ein Entwicklungs- oder Produktivsystem schnell und problemlos möglich.

Speicherort der Datei

Legen Sie Metadaten an, findet dies immer im Kontext eines Projekts statt. Hierbei definieren Sie ein Projekt als eine Konfigurationsaufgabe.

Etwa soll ein agorum core-System komplett neu für einen Interessenten angepasst werden, oder es kommt zur Konfiguration eines neuen Moduls oder Anforderungen einer Abteilung werden umgesetzt, die abteilungsspezifisch sind.

Egal, wie Sie für sich selbst ein Projekt definieren, Sie erstellen es in einem Konfigurationsordner. Dieser Ordner besitzt einen Unterordner, der sich yml nennt. Darunter befindet sich die Datei metadata.yml.

Beispiel

Eigene Dateien‎/Administration‎/customers‎/TestMetadata‎/yml‎

Aufbau der Datei

Einführung

In der Datei metadata.yml werden anhand von Keywords und einem speziellen Aufbau Metadaten angelegt.

Aufbau

Zu Beginn einer Zeile steht entweder ein globales Keyword oder ein zu definierendes Metadatum.

Beispiel globales Keyword

_group: Demo

Ein solches Keyword beginnt mit einem Unterstrich und endet mit einem Doppelpunkt.

• Ein # am Anfang der Zeile indiziert einen Kommentar:

# Dies ist ein Kommentar

• Ein zusammengehöriger String kann mit "" eingeschlossen werden: "01 - Januar"
• Existieren unterhalb eines Keywords oder eines Metadatums weitere Keywords, werden diese um 2 Leerzeichen eingerückt:

Beispiel 1

lieferantenBereich:
  displayName: Lieferantenbereich
  data:
    - Mails
    - Notizen
    - Dokumente
    - Korrespondenz

Beispiel 2

lieferantenBereich:
  displayName: Lieferantenbereich
  data: [ Mails, Notizen, Dokumente, Korrespondenz ]

Globale Keywords

Über Keywords definieren Sie Metadaten oder setzen Informationen global. Diese gelten dann für alle Metadaten.

_group

Definiert, zu welcher Benutzergruppe die definierten Metadaten im Metadaten-Designer zugeordnet werden.

Beispiel

_group: demo

_prefix

Definiert, welches Präfix vor die Namen der Metadaten geschrieben wird. Dadurch wird die yml-Datei besser lesbar.

Beispiel

_prefix: dem_

Soll ein Metadatum kein Präfix erhalten, wird ein - vor den Namen des Metadatums geschrieben:

-<metadaten-name>

_dataPrefix

Definiert, wo die Information für das Keyword data in der MetaDB abgelegt werden.

Beispiel

_dataPrefix: MAIN_MODULE_MANAGEMENT/customers/demo/Data/

_csvPrefix

Definiert, wo die CSV-Datei für das Metadatum abgelegt wird.

Beispiel

_csvPrefix: /agorum/roi/customers/demo/csv/

_encoding

Definiert, welches Encoding die CSV-Datei hat.

Verwenden Sie UTF-8.

Beispiel

_encoding: UTF-8

_default

Definiert Standard-Keywords, die zutreffen, wenn ein Metadatum keines beschrieben hat. Darunter fallen type, kind und restricted, die die folgenden Werte haben können:

type

Definiert den Datentyp des Metadatums.

Möglich sind:

• string
• int (nicht empfohlen, da agorum core int mit 64 Bit verwendet und daher kein int (32 Bit) nötig ist.)
• long
• float (nicht empfohlen, da agorum core float mit 64 Bit verwendet und daher kein float (32 Bit) nötig ist.)
• double
• date
• boolean

kind

Definiert, um was für ein Metadatum es sich handelt.

Möglich sind:

• inherited (vererbtes Metadatum)
• notInherited (nicht vererbtes Metadatum)
• builtIn (internes Metadatum - ist als Spalte in einer Datenbank-Tabelle gespeichert)

restricted

Definiert, ob ein Wert exakt mit der Datenquelle übereinstimmen muss, oder ob auch ein eigener Wert eingegeben werden kann.

Möglich sind:

• true
• false

Beispiel für _default:

_default:
   type: string
   kind: inherited
   restricted: true

Hat ein Metadatum keine Beschreibung für diese Keywords, werden ihm automatisch die Werte string, inherited und true zugewiesen.

Beispiel für die global gesetzten Keywords

# _....   damit fangen Globale Einstellungen an, die hinterlegt werden können
# -- global

# Hier wird eingestellt, welcher Gruppe die Daten im Metadaten-Designer zugeordnet werden
_group: demo

# Hier wird eingestellt, welches Präfix den Metadaten vorangestellt wird
# möchte man kein Präfix vor das Metadatum haben, muss dieses mit - beginnen
# Beispiel: -name: Das Metadatum heißt intern "name"
# Beispiel: kontrolle: Das Metadatum heißt intern dann "dem_kontrolle"
_prefix: dem_

# Damit wird eingestellt, wo die Information für "data" des Metadatums in der MetaDB abgelegt werden
_dataPrefix: MAIN_MODULE_MANAGEMENT/customers/demo/Data/

# Damit wird eingestellt, wo die csv-Datei für das Metadatum abgelegt wird
_csvPrefix: /agorum/roi/customers/demo/csv/

# Damit wird eingestellt, welches Encoding die csv-Datei hat.
_encoding: UTF-8

# Hiermit können Defaultwerte vorbelegt werden. Wenn diese dann bei der Definition eines Metadatums nicht definiert werden, werden diese auf den hier eingestellten Defaultwert gesetzt
_default:
  # string, int, long, double, float, date, boolean
  type: string
  # inherited, notInherited, builtIn
  kind: inherited
  restricted: true

Metadatum

Alle Worte, die keine Keywords sind, definieren ein Metadatum. Der eingegebene Name ist der interne Name, der in der Datenbank abgelegt wird.

Beispiel

kundenName:
  displayName: Kunde

kundenName (ggf. + _prefix) ist der interne Name, d. h. die Bezeichnung des Metadatums in der Datenbank. Der definierte angezeigte Name für Benutzer (displayName) ist Kunde.

Im Folgenden werden die Parameter für Metadaten beschrieben.

format

Definiert, wie das Metadatum angezeigt wird.

• Format für Datumsangaben:
  • Sie können die in Java üblichen Formatierungsstrings verwenden, siehe Standard-Java-SimpleDateFormat-Angaben.
  • Im Standard verwendet das System für die Formatierung die Sprache des Benutzers.

  
  Beispiel

  createDate:
    displayName: Anlegedatum
    format: "dd.MM.yyyy"
  

  In älteren Versionen von agorum core konnten auch andere Formatierungsstrings verwendet werden. Diese älteren Formatierungsstrings werden von agorum.explorer wie folgt dem aktuell gültigen Format zugewiesen:

  Zweck	Alter Formatierungsstring	Aktueller Formatierungsstring
  Anzeige des Datums	'd.m.Y'	'dd.MM.yyyy'
  Anzeige der Uhrzeit	'H:i:s'	'HH:mm:ss'
  Anzeige von Datum und Uhrzeit	'd.m.Y H:i:s'	'dd.MM.yyyy HH:mm:ss'

  Hinweis: Sie sollten in neuen Umgebungen und Konfigurationen ausschließlich die aktuell unterstützten Formatierungsstrings verwenden. Die Zuweisung von alten auf aktuell unterstützte Formatierungsstrings dient nur der Herstellung einer eingeschränkten Rückwärtskompatibilität für bestehende Installationen.

• Format für Float-, Double-, Integer-, Long-Zahl:  
  • In der Definition ist ein Komma das Tausendertrennzeichen und der Punkt das Dezimaltrennzeichen.
  • 0 = keine Nachkommastellen
  • 0.00 = 2 Nachkommastellen
  • 0.0000 = 4 Nachkommastellen
  • ,000 = zeigt Tausendertrennzeichen und keine Nachkommastellen
  • ,000.00 = zeigt Tausendertrennzeichen und 2 Nachkommastellen
  • 0.#### = Maximal 4 Nachkommastellen, Nullen rechts werden weggelassen
  • ,000.00 € = Schreibt die Zahl und nach der Zahl das Währungssymbol, in diesem Fall €

  
  Beispiel 1

  geld:
    displayname: Umsatz
    format: "0.00"
  

  
  Beispiel 2

  geld:
    displayname: Umsatz
    format: "#,###,##0.00 €/Monat"
  

  Hinweis: Geben Sie das Format bei Zahlen als String an. Anstatt 0.00 tragen Sie "0.00" ein.

displayName

Definiert, mit welchem Namen das Metadatum angezeigt wird:

createDate:
  displayName: Anlegedatum

Soll der Name übersetzbar sein, kann stattdessen ein Übersetzungsschlüssel angegeben werden, der mit Übersetzungsdateien aufgelöst wird:

createDate:
  displayName: metadatum.demo.createDate

data

Definiert, dass der Inhalt des Metadatums aus einer externen Datenquelle kommt.

Diese Datenquellen können sein:

• CSV-Datei
• über eine Suche
• Zugriff aus Benutzer, Benutzergruppen und Benutzer + Benutzergruppen
• Zugriff über einen JavaScript-Handler, mit dem beliebige Datenquellen angezapft werden können.

Keywords für alle Handler

Bei allen Handlern können optional folgende Parameter deklariert werden.

limit

Beschränkt die Anzahl der zurückgegebenen Elemente, die gleichzeitig angezeigt werden.

• Der Standard-Wert ist 100.
• Bei Comboboxen liegt der derzeitig maximale Wert bei 100.

minChars

Bei der Benutzung der Datenquelle in einer Combobox können Sie definieren, wie viele Zeichen mindestens eingegeben werden müssen, bis mit einer Suche begonnen wird.

Der Standard-Wert ist 2.

Beispiel

projektMitarbeiter:
  displayName: Mitarbeiter
  data: user
  minChars: 1
  limit: 50

csv

Wenn nach dem Keyword data: eine Definition in [...] angegeben wird, beschreibt diese einen Eintrag aus einer CSV-Datei.

Das csv-Keyword benötigt die folgenden Standard-Keywords, damit klar ist, wohin die Einstellungsdaten geschrieben werden müssen:

• _dataPrefix  (Ablageort des DataHandlers)
• _csvPrefix   (Ablageort der CSV-Datei)

Eine Definition, die zwischen [...] steht, bedeutet, dass Text und Wert der CSV-Datei gleich ist.

Beispiel data = csv (value = text)

monat:
  displayName: Monat
  data: [ "01 - Januar", "02 - Februar", "03 - März", "04 - April", "05 - Mai", "06 - Juni", "07 - Juli", "08 - August", "09 - September", "10 - Oktober", "11 - November", "12 - Dezember" ]

value;text
01 - Januar;01 - Januar
02 - Februar;02 - Februar
...

Werden die einzelnen Wertepaare angeben, können value und text verschiedene Werte annehmen:

vertragKuendigung:
  displayName: Kündigung
  data:
    # [ value, text ...
    - [ 1WocheVe, 1 Woche zum Vertragsende ]
    - [ 2WochenVe, 2 Wochen zum Vertragsende ]
    - [ 1MonatVe, 1 Monat zum Vertragsende ]
    - [ 3MonateVe, 3 Monate zum Vertragsende ]

Die Texte können übergesetzt werden:

1. Legen Sie eine Übersetzungsdatei an
2. Stellen Sie den Parameter translate: text ein.

Beispiel

vertragKuendigung:
  displayName: Kündigung
  # Achtung erst ab Version 1.2 von metadata-builder.js
  translate: text
  data:
    # [ value, text ...
    - [ 1WocheVe, agorum.modul.vertragsende.EineWoche ]
    - [ 2WochenVe, agorum.modul.vertragsende.ZweiWochen ]
    - [ 1MonatVe, agorum.modul.vertragsende.EinMonat ]
    - [ 3MonateVe, agorum.modul.vertragsende.DreiMonate ]

Möchten Sie keine data-Einträge in der Datei metadata.yml anlegen, übergeben Sie eine leere eckige Klammer data.

Beispiel

csv-nachträglich-ausfüllen-Beispiel:
  type: string
  displayName: test
  kind: inherited
  data: [ ]

Egal für welche Schreibweise Sie sich entscheiden, sobald Sie die Datei metadata.yml speichern und ausführen, wird eine CSV-Datei in dem dazugehörigen Konfigurationsordner angelegt:

/agorum/roi/customers/<Konfigurationsordner>/csv/<metadatum>.csv

Änderungen der data-Einträge müssen nun in der CSV-Datei stattfinden und nicht in der Datei metadata.yml, denn das System verwendet ausschließlich die <metadatum>.csv.

/agorum/roi/workspace/<Konfigurationsordner>/csv/

csv: Benutzer und Benutzergruppen mit wenig Einstellungen

Wählt Benutzer und / oder Benutzergruppen.

Folgende Parameter existieren unter data: 

Beispiel

### Benutzer einer bestimmten Benutzergruppe wählen ###

userFromGroupSelection:
  displayName: "Benutzer auswählen"
  data: group-users
  type: string
  kind: notInherited
# Hier die Gruppe, aus der die Benutzer und Benutzergruppen gewählt werden können. Es werden auch die Benutzer und Benutzergruppen aus Untergruppen angezeigt
  group: GRP_agorum core Basic Archive_Read
  restricted: true
  minChars: 0
  limit: 50

csv: Benutzer und Benutzergruppen mit vielen Einstellungen

Sie können einen detaillierteren Einfluss auf die Benutzer-/Gruppen-Auswahl vornehmen. Dazu verwenden Sie indirekt den DataHandler user-group.

Beispiel

zur_kenntnisnahme:
  data: custom
  #dataSource: "MAIN_MODULE_MANAGEMENT/customers/<konfigurationsprojekt>/Data/<Name des Metadatums>"
  dataSource: "MAIN_MODULE_MANAGEMENT/customers/musterfirma/Data/musterfirma_zur_kenntnisnahme"
  dataSourceConfig:
    # required
    Class: "agorum.api.object.data.JsDataHandler"
    MinChars: 0
    Script: "/agorum/roi/customers/Standard/js/data/user-group.js"
    # optional
    ExcludeWorld: true
    SearchUsers: true

Obligatorische Parameter

Optionale Parameter

JavaScript (JS)

Hinterlegt eine Definition eines JavaScript-DataHandlers (siehe Beispiel Metadatum mit einem JS-Handler).

Beispiel

testJS:
  displayName: Test JavaScript
  data: js
  script: "/agorum/roi/customers/test/js/JSDataHandler.js"

search

Erstellt einen Suchhandler, der im vom Metadatum angelegten Feld (wird bei Setzen des Metadatums erzeugt) eine Suche durchführt.

Der Rückgabewert ist im Standard, wenn nichts angegeben wird, der name des Objekts. Dieser kann mit den beiden Keywords value und text gesetzt werden.

• value: <welches Attribut soll zurückgegeben werden>
  • Wenn value nicht angegeben ist, wird dort name übergeben (der Name des gefundenen Objekts)
  • value: id
    • Gibt die ID des Objekts zurück.
• text: <welches Attribut soll angezeigt werden>
  • Wenn text nicht angegeben ist, wird dort name übergeben (der Name des gefundenen Objekts)

aktenName:
  data: search
  query: ...
  text: name
  # Hier wird die ID des Objektes zurückgegeben
  value: id

Wenn es sich bei text oder value um ein nicht vererbtes Metadatum handelt, muss ~ vorangestellt werden.

Beispiel

rechnungsNummer:
  data: search
  query: ...
  # prefix des Projektes muss hier mit angegeben werden
  text: ~prefix_rechnungsNummer
  # Hier wird die ID des Objektes zurückgegeben
  value: id

Wenn es sich bei text oder value um ein vererbtes Metadatum handelt, muss ~~ vorangestellt werden. Da ein Array zurückgegeben wird, muss das erste Element mit [0] ausgelesen werden.

Beispiel

kundenName:
  data: search
  query: ...
  # prefix des Projektes muss hier mit angegeben werden 
  text: ~~prefix_kundenName[0]
  # Hier wird die ID des Objektes zurückgegeben
  value: id

query

Wenn ein Metadatum gesetzt wird, können Sie als Entwickler nicht nur einen Einfluss darauf nehmen, welchen Datentyp das Metadatum hat, sondern auch, ob der Benutzer Vorschläge bei seiner Eingabe angezeigt bekommt. Diese Vorschläge können Sie anhand einer Query definieren und von anderen Metadaten abhängig machen.

Dabei gelten folgende Regeln:

?<Feld>
Feld des Objektes/ Metadatums, in dem der vom Benutzer eingegebene Text gesucht wird, etwa:

query: [ ?name ]

+<Wert>
Möchten Sie eine Abhängigkeit zu einem bestimmten Identifier setzen, verwenden Sie entweder das Metadatum identifer oder ein Plus-Zeichen vor dem zu suchenden Wert.

Dieses Beispiel kann auch so geschrieben werden:

query: [ identifier:Bestellakte ] //zu bevorzugen, da diese Schreibart leserlicher ist
// oder
query: [ +Bestellakte ]

<Wert>

Verwenden Sie etwa eine Eingabeoberfläche des agorum core explorers, um verschiedene Metadaten abzufragen, können Sie die Eingaben aufbauend voneinander in Abhängigkeit setzen.

Beispiel
Die Auswahl an Werten des Lieferantenstatus soll abhängig vom gewählten Lieferant sein. Hierzu sollte das Metadatum des Lieferantenstatus eine Query enthalten, die als Wert den Lieferanten enthält (Parameters).

Der Wert ist der Name eines Metadatums, nach dem gesucht wird und dessen Inhalt in der Eingabeoberfläche definiert wurde.

In der Datei metadata-yml passen Sie die Query wie folgt an:

query: [ aktesection ]

Gesucht wird jetzt nach einem Wert, der das Metadatum acbasicarchive_aktesection in den Parameters enthält.

Die folgende Query führt zu demselben Ergebnis, wird nur länger ausgeschrieben:

query: [ "acbasicarchive_aktesection:'${acbasicarchive_aktesection}'" ]
// Das System sucht somit innerhalb des Metadatums acbasicarchive_aktesection nach dem übergebenen Wert aus der Eingabeoberfläche ${acbasicarchive_aktesection}.
// Verwenden Sie diese Schreibweise, müssen Sie den Präfix mit angeben.

Das Präfix wird automatisch gesetzt und bezieht sich somit automatisch auf Metadaten, die in derselben metadata.yml definiert wurden.

Möchten Sie auf ein Metadatum verweisen, das ein anderes Präfix besitzt, setzen Sie ein führendes Minuszeichen (-) vor das Metadatum.

query: [ -sample_aktesection ] // Sie verweisen durch das Minus somit auf das Metadatum "sample_aktesection" eines anderen Projektes

Die gesetzten Abhängigkeiten müssen sich nicht auf die Eingabewerte einer Eingabeoberfläche beziehen. Genauso gut können Sie feste und immer gültige Werte eintragen. Hier ein Beispiel, in dem festgelegt wird, dass das Metadatum area den Wert mandanten haben muss:

query: [ (area:mandanten) ]

Sie können auch mehr als eine Abhängigkeit:

query: [ "acbasicarchive_aktesection_cs:${acbasicarchive_aktesection}", "acbasicarchive_aktearea_cs:${acbasicarchive_aktearea}" ]

Jeder Wert ergänzt die auszuführende Query nur, wenn die Ersetzung geklappt, d. h. wenn das zu ersetzende Metadatum auch vorhanden ist.

Alle Abhängigkeiten sind mit einem UND zueinander verknüpft, und alles muss für die anzuzeigenden Werte zutreffen.

Beispiel

aktenName:
  data: search
  query: [ ?name, +Bestellakte, lieferantenakte, lieferantBereich, rahmenabschlussakte, einzelabschlussakte, bestellungJahr, area:mandanten, dem_aktenzeichen:abc* ]

Sind keine der oben angegebenen Metadaten belegt worden, wird nach name:([Eingabe]) identifier:Bestellakte area:mandanten dem_aktenzeichen:abc* gesucht.

Wäre das Metadatum lieferantenakte mit abc belegt, sieht die Suche so aus:

name:([Eingabe]) identifier:Bestellakte dem_lieferantenakte:abc area:mandanten dem_aktenzeichen:abc*

custom

Verweist auf einen vorhandenen MetaDB-data-Eintrag:

Beispiel

aktenName:
  data: custom
  dataSource: "MAIN_MODULE_MANAGEMENT/customers/Standard/aktenName"

multi

Ermöglicht es, einem Metadatum mehrere Werte zuzuweisen. Sie erhalten damit bei der Abfrage ein Array zurück.

• true
• false (Standard, wenn nicht angegeben)

Beispiel

jahr:
  displayName: jahr
  data: [ 2015, 2016, 2017, 2018, 2019, 2020 ]
  multi: true

Hier ist es möglich, dem Metadatum dem_jahr mehrere Werte zuzuordnen.

readOnly

Definiert, ob das Metadatum geändert werden kann.

Beispiel

bezeichnungTask:
  displayName: Task
  readOnly: true

optional

Definiert, ob es sich um ein optionales Feld oder ein Pflichtfeld handelt.

Beispiel

bezeichnungTask:
  displayName: Task
  optional: true

facet

Schlägt automatisch alle für dieses Metadatum schon einmal eingegebenen Daten vor, sodass Sie aus diesen wählen können.

• Der Benutzer erhält nur die Werte, für die er auch berechtigt ist.
• Geht nur bei Verwendung von Solr als Index.
• Ist facet leer, wird automatisch innerhalb des aktuellen Metadatums gesucht
• + bedeutet hier die Belegung des levels (level = direkte Unterordner/-objekte des Identifiers)

Beispiel 1 für facet

holdingBereich:
  displayName: Bereich
  data: search
  facet: -name 
  query: [ +Holding GmbH ]

Hier wird innerhalb vom holdingBereich im facet Name (ohne Präfix) nach allem, was den Identifier Holding GmbH besitzt, gesucht.

Beispiel 2 für facet der vereinfachten, inzwischen bevorzugten Schreibweise:

holdingBereich:
  displayName: Bereich
  type: string
  kind: notInherited
  data: search
  facet:
  query: []

Hierdurch werden automatisch alle Werte angeboten, die das Metadatum holdingBereich im System bereits hat.

regex und regexText

regex stellt per RegExp ein Muster ein, dem die Eingabe entsprechen muss.

regexText stellt dagegen den Text ein, der ausgegeben wird, wenn das Muster der Eingabe nicht stimmt.

Damit es bei der Eingabe korrekt validiert und eine Falscheingabe signalisiert wird, halten Sie die folgende Schreibweise ein:

"^<regex Ausdruck>$"

//^: Anfang des Ausdrucks
//$: Ende des Ausdrucks

Beispiel

MandantenNr:
  displayName: Mandanten-Nr
  # validation
  regex: "^ma[345][0-9]{2,2}$"
  regexText: "Folgendes Format eintragen: maXYY (wobei X: 3-5 und Y: 0-9 ist)"

"(^ma[345][0-9]{2,2}$)|^$").

Testen

Um Ihre regex-Ausdrücke zu testen, erstellen Sie ein JavaScript in agorum core und fügen Sie folgenden Code ein:

'<String>'.match(/^<regex-Ausdruck>$/);

Beispiel

displayType

Definiert die Darstellung eines Metadatums in Formularen.

Das Metadatum wird für Drop-down-Felder (bei gesetztem data-Keyword) automatisch belegt.

translate

Definiert, welche Spalten (value oder text) der Datenquelle für die Anzeige übersetzt werden müssen.

Beispiel

fileType:
  displayName: _agorum.sample.fileType.displayName
  translate: text
  data:
    - [ customer, agorum.sample.fileType.customer ]
    - [ supplier, agorum.sample.fileType.supplier ]

list

Definiert das Metadatum als Liste (etwa Rechnungsposition) und ermöglicht gleichzeitig die Definition von Elementen innerhalb dieser Liste (etwa Nummer der Rechnungsposition).

Diese Elemente sind analog zur Definition von Positionen innerhalb von docform-Typen (ein docform-Typ hat mehrere Positionen).

• Ggf. vorhandene type-Deklaration wird ignoriert, da list bereits ein Typ ist.
• Positions-Metadaten werden wie Basis-Metadaten definiert:
  • Die kind-Definition eines Positions-Metadatums kann nicht geändert werden und entspricht der des umgebenden Listen-Metadatums.
  • Positions-Metadaten erhalten kein eigenes Präfix, da sie gemeinsam mit dem Listen-Metadatum indiziert werden.

Beispiel

invoice_items:
  displayName: Rechnungspositionen
  list:
    number:
      displayName: Nummer
      type: string

    description:
      displayName: Bezeichnung
      type: string

    net:
      displayName: Nettobetrag
      type: double

Für das Suchen nach einem list-Metadatum siehe Suchsyntax in Solr verwenden.

Einen Übersetzungskey (Metadatum) übersetzen

Übersetzt vor der Anzeige der Wert des Metadatums durch translate und kommt dann erst zur Anzeige.

Ein Metadatum definieren

-_([~ oder ~~ oder nichts]<Name des Metadatums):

Beispiele

Internes Metadatum

-_(workflowDefinition.description):
  displayName: Workflow-Art
  kind: builtIn
  type: string
  readOnly: true

Nicht vererbtes Metadatum

-_(~acmf_beispielNichtVererbt):
  displayName: Workflow-Art
  kind: notInherited 
  type: string
  readOnly: true

Vererbtes Metadatum

-_(~~acmf_beispielVererbt):
  displayName: Workflow-Art
  kind: inherited 
  type: string
  readOnly: true

Beispiel einer metadata.yml-Datei

# -- global
_group: demo
_prefix: dem_
_dataPrefix: MAIN_MODULE_MANAGEMENT/customers/demo/Data/
_csvPrefix: /agorum/roi/customers/demo/csv/
_encoding: UTF-8

_default:
  # string, int, long, double, float, date, boolean
  type: string
  # inherited, notInherited, builtIn
  kind: inherited
  restricted: true

MandantenNr:
  displayName: Mandanten-Nr
  data: search
#  readOnly: true
  facet:
  query: [ ]
  restricted: false
  regex: "^ma[345][0-9]{2,2}"
  regexText: "maXYY (X: 3-5, Y: 0-9)"

Metadaten der metadata.yml anlegen

1. Öffnen Sie links in der Seitenleiste Explorer.
2. Navigieren Sie zu Ihrem Pfad, in der sich Ihre Konfiguration befindet, die Sie exportieren möchten:

   Eigene Dateien/Administration/customers/<Name der Konfiguration>/yml/export.yml
   

3. Klicken Sie die Datei export.yml mit einem Rechtsklick an.
4. Wählen Sie im Kontextmenü Administration > Metadaten anlegen (YML).

   Hinweis: Diese Aktion erscheint nur, wenn der Dateiname mit export beginnt und mit .yml endet.

Import/Export

Export

Die metadata.yml-Datei wird im Zuge eines Konfigurationsprojektes erstellt und liegt in einer speziellen Ordnerstruktur vor (siehe ZIP-Dateien und Konfigurationsprojekte installieren). In dem yml-Ordner muss für einen Export eine export.yml-Datei (siehe Beschreibung der Datei "export.yml") definiert sein. Diese Datei erstellt ein ZIP-Package des kompletten Konfigurationsordners und schließt somit auch die metadata.yml mit ein.

Für einen direkten Import während der Installation des ZIP-Packages muss ein JavaScript vorliegen, dass die yml-Datei gleich installiert und ausführt.

Import

Um die Metadaten aus einer metadata.yml beim Import wieder auszulesen, kann diese in einem Package mit JavaScript eingebunden werden. Dieses wird dann im Ordner deploy abgelegt.

Beispiel

/* global sc */

let mb = require('/agorum/roi/customers/Standard/js/metadata-builder');
let yaml = require('common/objects').find('/agorum/roi/customers/<NamederKonfiguration>/yml/metadata.yml').contentString;

mb(yaml).install(sc);