Wiki-Quellcode von Plugin-Entwicklung

Verstecke letzte Bearbeiter
gru 1.1 1 {{content/}}
2
3 == Plugins für zusätzliche Funktionalitäten ==
4
5 {{formcycle/}} bietet ein Vielzahl von Einstiegspunkten für die Erweiterung der Standard-Funktionalitäten durch Plugins. Basierend auf den einzelnen [[Plugin-Typen>>doc:Formcycle.PluginDevelopment.Types.WebHome]] werden diese zu gewissen Zeitpunkten automatisch oder manuell angesprochen und erlauben es somit von der Ersetzung eigener Platzhalter bis hin zur Implementierung eigener Verarbeitungslogik {{formcycle/}} anzupassen. Als fundamentaler erster Schritt für die Entwicklung eigener Plugins ist hierbei das Erstellen eines entsprechenden Java-Projekts anzusehen.
6
7 == API-Dokumentation ==
8
9 Die API-Dokumentation für {{formcycle/}} findet sich hier auf unserer Seite: [[Javadocs>>https://docs.formcycle.eu/]]
10
11 == Projekt-Setup ==
12
awa 3.1 13 Zu Beginn der Entwicklung eines Plugins ist es nötig das entsprechende Entwicklungsprojekt aufzusetzten und zu konfigurieren.
gru 1.1 14
awa 3.1 15 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.
gru 1.1 16
awa 3.1 17 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/]].
gru 1.1 18
awa 3.1 19 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//:
gru 1.1 20
awa 3.3 21 {{panel title="~~~~/.m2/settings.xml" fullwidth="true" initial="hidden" triggerable="true"}}
awa 3.1 22 {{code language="xml"}}
23 <?xml version="1.0" encoding="UTF-8"?>
24 <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"
25 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
gru 1.1 26
awa 3.1 27 <!-- Add XIMA artifactory -->
28 <profiles>
29 <profile>
30 <repositories>
31 <repository>
32 <snapshots>
33 <enabled>false</enabled>
34 </snapshots>
35 <id>xima</id>
36 <name>libs-release</name>
37 <url>https://artifactory.xima-services.de/artifactory/fc-plugin-dev</url>
38 </repository>
39 </repositories>
40 <pluginRepositories>
41 <pluginRepository>
42 <snapshots>
43 <enabled>false</enabled>
44 </snapshots>
45 <id>xima</id>
46 <name>plugins-release</name>
47 <url>https://artifactory.xima-services.de/artifactory/fc-plugin-dev</url>
48 </pluginRepository>
49 </pluginRepositories>
50 <id>xima-artifactory</id>
51 </profile>
52 </profiles>
gru 1.1 53
awa 3.1 54 <!-- Enable XIMA artifactory by default -->
55 <activeProfiles>
56 <activeProfile>xima-artifactory</activeProfile>
57 </activeProfiles>
gru 1.1 58
awa 3.1 59 <!-- FORMCYCLE specific Maven plugins provided by XIMA -->
60 <pluginGroups>
61 <pluginGroup>de.xima.fc.maven.plugin</pluginGroup>
62 </pluginGroups>
63 </settings>
64 {{/code}}
65 {{/panel}}
gru 1.1 66
awa 3.1 67 In der //pom.xml// des Plugin-Projekts kann die Abhängigkeit dann wie folgt eingebunden werden:
gru 1.1 68
awa 3.1 69 {{code language="xml"}}
70 <properties>
71 <xfc.version>7.0.10</xfc.version>
72 </properties>
gru 1.1 73
awa 3.1 74 <dependencies>
75 <dependency>
76 <groupId>de.xima.fc</groupId>
77 <artifactId>fc-plugin-common</artifactId>
78 <version>${xfc.version}</version>
79 <scope>provided</scope>
80 </dependency>
81 </dependencies>
gru 1.1 82 {{/code}}
83
84 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:
85
86 {{code language="xml"}}
87 <dependency>
88 <groupId>de.xima.fc</groupId>
89 <artifactId>fc-logic</artifactId>
90 <version>${xfc.version}</version>
91 <scope>provided</scope>
92 </dependency>
93 {{/code}}
94
95 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"]].
96
97 Ferner ist zu beachten, dass sämtliche Abhängigkeiten zu {{formcycle case="dat"/}} im scope //provided //anzugeben sind. Dies verhindert neben Classpath-Problemen auch das unnötige Anschwellen der Plugin-Größe. Ebenso sollten diesbezüglich Abhängigkeiten auf bereits von {{formcycle case="dat"/}} benutzten und damit bereitstehenden Bibliotheken wiederverwendet werden (z.B. diverse Apache Commons-Implementierungen).
98
99 {{info}}
100 Alle Abhangigkeiten zu {{formcycle case="dat"/}} sind im scope "provided" zu definieren!
101 {{/info}}
102
103 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]].
104
awa 3.1 105 == Archetypes ==
gru 1.1 106
awa 3.1 107 TODO
108
109 Um einen besseren Einstieg in die Plugin-Entwicklung zu finden, [[bieten wir auf unserer Downloadseite>>url:https://customer.formcycle.eu/index.php/s/PgdMrNOvbYEzhmr]]