Durchsuchbare Dokumentation aufrufen | Zurück zur Dokumentationsübersicht

Navigation: Dokumentationen agorum core > agorum core für Administratoren > Konfigurationen zum Import und Export > In Start Project Template konvertieren

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: 
  - agorumcorepro: ">= 11.10.0"
  - Standard:

license: true
translationoffset: <translationoffset Ihres Projekts> 

Einstellungen in der Datei

Projektdefinitionen


name

name: <Projektname>

Den Projektnamen definieren Sie bei der 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.

Hinweis: Ändern Sie den Projektnamen nicht. Änderungen, die Sie in der Datei durchführen, greifen ansonsten nicht. Das System verwendet diese Informationen, um etwa eigene Templates aus Ihrer Konfiguration zu erstellen und ermöglicht Ihnen, Textersetzungen vorzunehmen.


description

description: <Projektbeschreibung>

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

Hinweis: Ändern Sie die Beschreibung nicht. Änderungen, die Sie in der Datei durchführen, greifen ansonsten nicht. Das System verwendet diese Informationen, um etwa eigene Templates aus Ihrer Konfiguration zu erstellen und ermöglicht Ihnen, Textersetzungen vorzunehmen.


prefix

prefix: <Metadatenprefix>

Das Präfix für Metadaten definieren Sie bei der 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.

Hinweis: Ändern Sie das Präfix nicht. Änderungen, die Sie in der Datei durchführen, greifen ansonsten nicht. Das System verwendet diese Informationen, um etwa eigene Templates aus Ihrer Konfiguration zu erstellen und ermöglicht Ihnen, Textersetzungen vorzunehmen.


version

version: <Angabe der Version>

Für Ihre Konfigurationen können Sie eine Versionsnummer angeben, um Abhängigkeitsänderungen zwischen verschiedenen Konfigurationsupdates zu signalisieren. Wir empfehlen Ihnen, die Regeln der semantischen Versionierung anzuwenden.

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, Plugins oder eigenen Konfigurationen setzen.


Beispiel anhand des Plugins agorum core electronic invoicing

# project definitions

name: agorum.electronic.invoicing               # nicht ändern
description: agorum core electronic invoicing   # nicht ändern
prefix: agorum_electronic_invoicing_            # nicht ändern
license: true                                   # Eine separate Lizenz ist erforderlich
version: 1.0.65                                 # Versionsnummer des Projekts, bei Änderungen hochzählen   

# define dependencies for this project
dependencies:
  - agorumcorepro: ">= 11.9.0"            # agorum core pro wird vorausgesetzt, mindestens in Version 11.9.0
  - docform: ">= 1.0.7"                   # DocForm muss installiert sein, mindestens in Version 1.0.7
  - agorum.accounting: ">= 1.0.47"        # Accounting muss installiert sein, mindestens in Version 1.0.47 
  - DocFormItem: ">= 1.0.0"               # DocFormItem muss installiert sein, mindestens in Version 1.0.0
  - Standard:                             # Standard muss installiert sein

translationoffset: agorum.electronic.invoicing  # Basis-Key für generierte Übersetzungskeys

 

Abhängigkeit Beschreibung E​inzutragender Wert

agorum core open/pro

Ihre Konfiguration darf auf einem System verwendet werden, auf dem entweder agorum core open oder agorum core pro installiert ist.

 
- agorumcore: <Version, etwa >= 11.0.0>

Für das Angeben von Versionsnummern siehe Versionsnummern angeben.

agorum core pro

Ihre Konfiguration darf ausschließlich auf einem System verwendet werden, auf dem agorum core pro installiert ist. Diese Einstellung ist standardmäßig in der angelegten Datei enthalten.

 
- agorumcorepro: <Version, etwa >= 11.0.0>

Für das Angeben von Versionsnummern siehe Versionsnummern angeben.

Solr-Suchmaschine

Ihre Konfiguration darf nur auf einem System verwendet werden, auf dem Solr als Suchmaschine vorhanden ist.

Hinweis: In älteren agorum core Versionen wurde Lucene als Suchmaschine verwendet. Solr erlaubt wesentlich mehr Einstellungen, wie die Verwendung des Filters aus der Suche.

 
- solr:

Eine Versionsnummer ist nicht notwendig.

Module

Einige Konfigurationen benötigen als Grundlage bestimmte Module von agorum core, etwa eine Konfiguration aus agorum core docform. Eine solche Konfiguration benötigt in diesem Falle diese Module:

  • docform
  • docform extend
  • ggf. docform positions
  • ggf. docform verify
 
- docform:

Eine Versionsnummer ist nicht notwendig. Sie sollten die Versionsnummer angeben, wenn eine bestimmte Version der Komponente für die Verwendung des aktuellen Konfigurationsprojekts erforderlich ist.

- docform: ">= 1.0.7"

Sie können als Modul Folgendes angeben:

  • die konfigurierbaren Module
    • AdminSync
    • DatevCsv
    • DatevCsvItem
    • DatevXmlOnline
    • DatevXmlOnlineItem
    • DocForm
    • DocFormVerify
    • DocFormExtended
    • DocFormItem
    • MailAdapter
    • MailCompression
    • Preview
    • PreviewThumbnails
    • SAP
    • Storage
    • StorageContainerBackend
    • StorageDeduplicate
  • Konfigurationspakete oder Plugins über ihre Bezeichnung in der Datei project.yml
Lizenzierung Für Ihre Konfiguration können Sie angeben, ob eine Lizenzierung notwendig ist. Diese Information taucht später etwa im agorum core plugin manager als Indikator Pro in der Spalte Lizenz auf. 
license: true

Dieses Konfigurationsprojekt benötigt zur Installation eine Lizenz.

license: false

Dieses Konfigurationsprojekt benötigt zur Installation keine Lizenz.
Mehrsprachigkeit

Ihre Konfiguration können Sie mit Übersetzungskeys in mehreren Sprachen anbieten (siehe Übersetzungskeys konfigurieren).

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


Beispiel

translationoffset: acds

Wenn Sie den agorum core template manager zur Unterstützung bei der Übersetzung verwenden, ist das der Basis-Property-Key für dieses Plugin / Projekt, in diesem Falle acds.

Versionsnummern angeben

Die Angabe einer Versionsnummer ist optional.


Aufbau

">= 11.0.0"


Mögliche Vorzeichen

Vorzeichen Beschreibung
> Vorhandene Version muss größer sein als angegeben.
>= Vorhandene Version muss größer oder gleich sein als angegeben.
= Vorhandene Version muss denselben angegebenen Wert aufweisen.

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

Abhängigkeit zu Plugins und eigenen Konfigurationen

Sie können Ihre Konfiguration von eigenen Konfigurationen in Abhängigkeit setzen oder in Abhängigkeit zu Plugins 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 Konfigurationsprojekts 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.