Änderungen von Dokument Plugin-Entwicklung

Von 1.2 nach 2.1 Von 3.1 nach 3.2

Von Version 2.1

bearbeitet von rth
am 14.02.2022, 17:25

Änderungskommentar: Neuen Anhang pom.xml hochladen

Auf Version 3.1

bearbeitet von awa
am 25.02.2022, 11:37

Änderungskommentar: settings.xml

Rohform
Im Layout

Zusammenfassung

Seiteneigenschaften (2 geändert, 0 hinzugefügt, 0 gelöscht)

Details

Seiteneigenschaften

Dokument-Autor

@@ -1,1 +1,1 @@
--XWiki.rth
++XWiki.awa

Inhalt

@@ -10,84 +10,80 @@
  == Projekt-Setup ==
--Zu Beginn der Entwicklung eines Plugins ist es nötig das entsprechende Entwicklungsprojekt aufzusetzten und zu konfigurieren. Für letzteres kommt hierbei das Build-Management-Tool [[Apache Maven>>url:https://maven.apache.org/||rel="__blank"]] zum Einsatz. Um die entsprechenden Abhängigkeiten zu {{formcycle case="dat"/}} bereitzustellen ist ein Repository unter der URL [[https:~~/~~/artifactory.xima-services.de/artifactory/fc-plugin-dev>>url:https://artifactory.xima-services.de/artifactory/fc-plugin-dev]] zu benutzen. Dieses beinhaltet alle öffentlich zur Verfügung stehenden Artefakte welche dem Plugin zur Laufzeit bereitgestellt und während der Entwicklung benötigt werden. Augangspunkt ist hierbei das Artefakt //fc-plugin-common//, welches die einzelnen Plugin-Schnittstellen beinhaltet und auch auf [[unserere Downloadseite zur Verfügung steht>>url:http://artifactory.xima-services.de/artifactory/fc-plugin-dev/de/xima/fc/fc-plugin-common/]]. Ein Auszug des Project Object Models (pom.xml) sieht dem entsprechend beispielhaft wie folgt aus:
++Zu Beginn der Entwicklung eines Plugins ist es nötig das entsprechende Entwicklungsprojekt aufzusetzten und zu konfigurieren.
--{{panel title="Beispiel für pom.xml" fullwidth="true" initial="hidden" triggerable="true"}}
--{{code language="xml"}}
--<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-- xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
++Für letzteres empfehlen wir hierbei das Build-Management-Tool [[Apache Maven>>url:https://maven.apache.org/||rel="__blank"]] zum Einsatz. Andere Build-Tools können prinzipiell benutzt werden, hier können wir aber keine Hilfe bereitstellen.
--...
++Um die entsprechenden Abhängigkeiten zu {{formcycle case="dat"/}} bereitzustellen, ist das Repository unter der URL [[https:~~/~~/artifactory.xima-services.de/artifactory/fc-plugin-dev>>url:https://artifactory.xima-services.de/artifactory/fc-plugin-dev]] zu benutzen. Dieses enthält alle öffentlich zur Verfügung stehenden Artefakte, welche dem Plugin zur Laufzeit bereitgestellt und während der Entwicklung benötigt werden. Ausgangspunkt ist hierbei das Artefakt //fc-plugin-common//, welches die einzelnen Plugin-Schnittstellen beinhaltet und auch auf [[unserere Downloadseite zur Verfügung steht>>url:http://artifactory.xima-services.de/artifactory/fc-plugin-dev/de/xima/fc/fc-plugin-common/]].
-- <properties>
--  <!-- Configuration -->
--  <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
++Damit das Repository auch beim Bauen mit Maven verwendet wird, sollte folgendes in die Maven-Konfigurationsdatei //settings.xml// geschrieben werden. Diese Datei findet sich in der Regeln im //.m2//-Ordner im Home-Verzeichnis des aktuellen Nutzers. Unter Linux //~/.m2/settings.xml// und unter Windows //%homepath%\.m2\settings.xml//:
--  <!-- Dependencies -->
--  <xfc.version>7.0.9</xfc.version>
++{{panel title="~/.m2/settings.xml" fullwidth="true" initial="hidden" triggerable="true"}}
++{{code language="xml"}}
++<?xml version="1.0" encoding="UTF-8"?>
++<settings xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.1.0 http://maven.apache.org/xsd/settings-1.1.0.xsd" xmlns="http://maven.apache.org/SETTINGS/1.1.0"
++    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
--  <!-- Plugins -->
--  <maven-compiler-plugin.version>3.8.1</maven-compiler-plugin.version>
--  <maven-jar-plugin.version>3.1.0</maven-jar-plugin.version>
-- </properties>
++  <!-- Add XIMA artifactory -->
++  <profiles>
++    <profile>
++      <repositories>
++        <repository>
++          <snapshots>
++            <enabled>false</enabled>
++          </snapshots>
++          <id>xima</id>
++          <name>libs-release</name>
++          <url>https://artifactory.xima-services.de/artifactory/fc-plugin-dev</url>
++        </repository>
++      </repositories>
++      <pluginRepositories>
++        <pluginRepository>
++          <snapshots>
++            <enabled>false</enabled>
++          </snapshots>
++          <id>xima</id>
++          <name>plugins-release</name>
++          <url>https://artifactory.xima-services.de/artifactory/fc-plugin-dev</url>
++        </pluginRepository>
++      </pluginRepositories>
++      <id>xima-artifactory</id>
++    </profile>
++  </profiles>
-- <repositories>
--  <repository>
--   <id>xima</id>
--   <name>fc-plugin-dev</name>
--   <url>https://artifactory.xima-services.de/artifactory/fc-plugin-dev</url>
--  </repository>
-- </repositories>
++  <!-- Enable XIMA artifactory by default -->
++  <activeProfiles>
++    <activeProfile>xima-artifactory</activeProfile>
++  </activeProfiles>
-- <dependencies>
--  <dependency>
--   <groupId>de.xima.fc</groupId>
--   <artifactId>fc-plugin-common</artifactId>
--   <version>${xfc.version}</version>
--   <scope>provided</scope>
--  </dependency>
-- </dependencies>
++  <!-- FORMCYCLE specific Maven plugins provided by XIMA -->
++  <pluginGroups>
++    <pluginGroup>de.xima.fc.maven.plugin</pluginGroup>
++  </pluginGroups>
++</settings>
++{{/code}}
++{{/panel}}
-- <build>
--  <plugins>
--   <plugin>
--    <groupId>org.apache.maven.plugins</groupId>
--    <artifactId>maven-compiler-plugin</artifactId>
--    <version>${maven-compiler-plugin.version}</version>
--    <configuration>
--     <release>11</release>
--     <encoding>UTF-8</encoding>
--    </configuration>
--   </plugin>
++In der //pom.xml// des Plugin-Projekts kann die Abhängigkeit dann wie folgt eingebunden werden:
--   <plugin>
--    <groupId>org.apache.maven.plugins</groupId>
--    <artifactId>maven-jar-plugin</artifactId>
--    <version>${maven-jar-plugin.version}</version>
--    <configuration>
--     <archive>
--      <manifest>
--       <addDefaultImplementationEntries>true</addDefaultImplementationEntries>
--      </manifest>
--      <manifestEntries>
--       <formcycle-version-requirement>${xfc.version}</formcycle-version-requirement>
--       <Build-Time>${maven.build.timestamp}</Build-Time>
--      </manifestEntries>
--     </archive>
--    </configuration>
--   </plugin>
++{{code language="xml"}}
++  <properties>
++    <xfc.version>7.0.10</xfc.version>
++  </properties>
--  </plugins>
-- </build>
--</project>
--
++  <dependencies>
++    <dependency>
++     <groupId>de.xima.fc</groupId>
++     <artifactId>fc-plugin-common</artifactId>
++     <version>${xfc.version}</version>
++     <scope>provided</scope>
++    </dependency>
++  </dependencies>
  {{/code}}
--{{/panel}}
  Ferner steht je nach Tiefe der Integration in die bestehende Umgebung von {{formcycle case="dat"/}} und dessen Benutzung als höchste Implementierung das Artefakt //fc-logic// zur Verfügung. Dieses wird wie folgt als weitere (oder einzige) Abhängigkeit definiert:
  {{code language="xml"}}
--...
    <dependency>
     <groupId>de.xima.fc</groupId>
     <artifactId>fc-logic</artifactId>
@@ -94,7 +94,6 @@
     <version>${xfc.version}</version>
     <scope>provided</scope>
    </dependency>
--...
  {{/code}}
  Eine entsprechende Benutzung ist vor allem bei der Verwendung der Datenbankschnittstelle sowie bei der Implementierung von eigenen Verarbeitungen nötig. Eine Vorlage für ein somit entstehendes Project Object Model finden Sie [[hier>>attach:pom.xml||rel="__blank"]].
@@ -107,6 +107,8 @@
  Basierend auf der hiermit zur Verfügung stehenden Infrastruktur steht der Entwicklung von eigenen Plugin-Implementierungen nichts mehr im Wege. Die Installation erfolgt anschließend je nach Verwendungszweck über die Oberflächen [[Mandant-Plugins>>doc:Formcycle.UserInterface.Client.Plugins]] oder [[System-Plugins>>doc:Formcycle.SystemSettings.UserInterface.SystemPlugins]].
--== Demo-Plugins ==
++== Archetypes ==
--Um einen besseren Einstieg in die Plugin-Entwicklung zu finden, [[bieten wir auf unserer Downloadseite>>url:https://customer.formcycle.eu/index.php/s/PgdMrNOvbYEzhmr]] auch für jeden Plugintyp ein kommentiertes Demo-Maven-Projekt an. Sie können diese herunterladen und in der Entwicklungsumgebung ihrer Wahl einsehen und kompilieren.
++TODO
++
++Um einen besseren Einstieg in die Plugin-Entwicklung zu finden, [[bieten wir auf unserer Downloadseite>>url:https://customer.formcycle.eu/index.php/s/PgdMrNOvbYEzhmr]]