Beschreibung der Datei "project.yml"

Eigene Konfigurationen entwickeln sich stetig weiter, sei es aufgrund eines Softwareupdates, neuen Ideen oder der Korrektur von Tippfehlern. Stellen Sie diese Updates nun mehreren Firmen / Abteilungen zur Verfügung, ist es wichtig, auf die Einhaltung bestimmter Voraussetzungen zu achten.

Erstellen Sie etwa eine Konfiguration, die auf agorum core docform beruht, müssen Sie sicherstellen, dass die dazugehörigen Module wie docform, docform verify oder docform extended in den jeweiligen agorum core-Systemen aktiviert sind.

Sollten Sie eine JavaScript-Klasse verwenden, die erst seit einer bestimmten Version von agorum core existiert, ist es etwa wichtig, dass die dazu passende agorum core-Version im System installiert wurde, damit Sie Ihre Klasse verwenden können.

Solche Überprüfungen definieren Sie in der Datei project.yml.

Speicherort der Datei

Die Datei project.yml ist Bestandteil eines Konfigurationsprojekts, die Datei existiert nur im Zuge eines solchen Projekts. Sie entsteht durch die Aktion Neues Projekt installieren (aus Vorlage), die sich im agorum core template manager befindet.

So finden Sie die Datei project.yml:

1. Öffnen Sie links in der Seitenleiste Explorer.
2. Öffnen Sie den Pfad:

   Eigene Dateien/Administration/customers/<Ihr Konfigurationsprojekt>/yml

Aufbau der Datei

# project definitions

name: <Projektname>                        //Ändern Sie diesen Namen nicht ab!
description: <Projektbeschreibung>         //Ändern Sie diese Beschreibung nicht ab!
prefix: <Projektprefix für Metadaten>      //Ändern Sie dieses Präfix nicht ab!

version: 1.0.0

# define dependencies for this project
dependencies: 
  - agorumcore: ">= 9.0.0"
  - Standard:

translationoffset: <translationoffset Ihres Projekts> 

Einstellungen in der Datei

Projektdefinitionen

name

name: <Projektname>

Den Projektnamen definieren Sie bei Erstellung der Konfiguration durch die Aktion Neues Projekt installieren (aus Vorlage). Anhand dieses Eintrags baut das System die Ordnerstruktur auf, unter der Sie später Ihr Konfigurationsprojekt finden.

description

description: <Projektbeschreibung>

Die Projektbeschreibung definieren Sie bei Erstellung der Konfiguration durch die Aktion Neues Projekt installieren (aus Vorlage). Anhand dieses Eintrags erstellt das System die Datei project-decription.html unter Eigene Dateien/Administration/customers/<Projektname>/doc/project-decription.html.

prefix

prefix: <Metadatenprefix>

Das Präfix für Metadaten definieren Sie bei Erstellung der Konfiguration durch die Aktion Neues Projekt installieren (aus Vorlage). Anhand dieses Eintrags legt das System in der Datei metadata.yml ein Metadatenpräfix an.

version

version: <Angabe der Version>

Für Ihre Konfigurationen können Sie eine Versionsnummer angegeben, um Abhängigkeitsänderungen zwischen verschiedenen Konfigurationsupdates zu verwenden.

Ihre gesetzte Versionsnummer muss aus drei Zahlen bestehen:

version: 1.0.0

Dependencies

Sie können für eine Konfiguration Abhängigkeiten (Dependencies) zu anderen Modulen, Plug-ins oder eigenen Konfigurationen setzen.

Beispiel anhand des Plug-ins „agorum core basic archive dsgvo“

# project definitions

name: acbasicarchiveDSGVO
description: agorum core basic archive dsgvo
prefix: acbasicarchive_

version: 1.0.2 

# define dependencies for this project
dependencies: 
  - agorumcore: ">= 9.0.0"         # agorum core open/pro muss mindestens Version >= 9.0.0 haben
  - solr:                          # Suchmaschine Solr muss vorliegen
  - acbasicarchive: ">= 1.0.0"     # Plug-in agorum core basic archive muss vorhanden sein, mindestens Version >= 1.0.0
  - DocForm:                       # Beispiel, wie die Abhängigkeiten mit DocForm weiter aufgebaut werden können
  - MailAdapter:
  - Preview:

license: false                     # Für diese Konfiguration existiert keine Lizenzierung
translationoffset: acds            # Für diese Konfiguration existiert keine Lizenzierung

- agorumcore: <Version, etwa >= 9.0.0>

- agorumcorepro: <Version, etwa >= 9.0.0>

- solr:

- DocForm:

- agorumcore: ">= 9.0.0"

license: true

license: false

translationoffset: <projektname>.<beliebig>....

translationoffset: acds

Versionsnummern angeben

Die Angabe einer Versionsnummer ist optional.

Aufbau

">= 9.0.0"

Mögliche Vorzeichen

Dem Vorzeichen folgt ein Leerzeichen und die gewünschte Versionsnummer in Form von <major.minor.patch>.

Abhängigkeit zu Plug-ins und eigenen Konfigurationen

Sie können Ihre Konfiguration von eigenen Konfigurationen in Abhängigkeit setzen oder in Abhängigkeit zu Plug-ins von agorum core. Geben Sie dazu den Konfigurationsnamen an.

Beispiel

Die eigene Konfiguration soll vom Konfigurationsprojekt acds abhängig sein. Zusätzlich muss die Version dieses Konfigurationsprojekt größer sein als Version 1.0.0.

Beispiel einer eigenen Konfiguration und deren Abhängigkeit

1. Tragen Sie folgenden Wert in die Datei project.yml ein:

   - acds: >1.0.0

Fehlerbehebung

Error installing package file

Beschreibung des Problems

Beim Installieren eines Konfigurationsprojekts erscheint folgende Fehlermeldung:

Error installing package file

date: 2023-04-19 08:59:22
severity: ERROR
logged at: agorum.roi.statistic.action.PackageInstallAction.runActionAsync(PackageInstallAction.java:79)

depending module or package with name "smartassistantconfigdesigner" not found (utils.js#86)
    at utils.js:86 (anonymous)
    at utils.js:25 (checkDependencies)
    at pre.js:9
    ...

Ursache

Das Konfigurationstool smart assistant Konfigurator aktivieren Sie nicht mehr über das support tool. Stellten Sie in eigenen Konfigurationsprojekten vor agorum core 11 sicher, dass dieses Tool auf der Startseite sichtbar sein muss, haben Sie dies mit dem Keyword smartassistantconfigdesigner bei den dependencies hinterlegt. Diese Überprüfung wirft ab agorum core 11 aufgrund von Obsoleszenz die obige Fehlermeldung.

Lösung

1. Entfernen Sie das Keyword smartassistantconfigdesigner aus der Datei project.yml.