| ... |
... |
@@ -1,22 +1,21 @@ |
| 1 |
1 |
{{content/}} |
| 2 |
2 |
|
| 3 |
|
-== Plugins für zusätzliche Funktionalitäten == |
| 4 |
4 |
|
| 5 |
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 |
6 |
|
| 7 |
7 |
== API-Dokumentation == |
| 8 |
8 |
|
| 9 |
|
-Die API-Dokumentation für {{formcycle/}} findet sich hier auf unserer Seite: [[Javadocs>>https://docs.formcycle.eu/]] |
|
8 |
+Die API-Dokumentation für {{formcycle/}} findet sich hier auf unserer Seite: [[JavaScript und JavaDocs>>https://docs.formcycle.eu/]] |
| 10 |
10 |
|
| 11 |
11 |
== Maven-Setup == |
| 12 |
12 |
|
| 13 |
|
-Zu Beginn der Entwicklung eines Plugins ist es nötig das entsprechende Entwicklungsprojekt aufzusetzten und zu konfigurieren. |
|
12 |
+Zu Beginn der Entwicklung eines Plugins ist es nötig, das entsprechende Entwicklungsprojekt aufzusetzten und zu konfigurieren. |
| 14 |
14 |
|
| 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. |
|
14 |
+Für letzteres empfehlen wir hierbei das Build-Management-Tool [[Apache Maven>>url:https://maven.apache.org/||rel="__blank"]] zu verwenden. Andere Build-Tools können prinzipiell auch genutzt werden, hier können wir aber keine Hilfe bereitstellen. |
| 16 |
16 |
|
| 17 |
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. |
| 18 |
18 |
|
| 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//: |
|
18 |
+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//: |
| 20 |
20 |
|
| 21 |
21 |
{{panel title="~~~~/.m2/settings.xml" fullwidth="true" initial="hidden" triggerable="true"}} |
| 22 |
22 |
{{code language="xml"}} |
| ... |
... |
@@ -34,7 +34,7 @@ |
| 34 |
34 |
<enabled>false</enabled> |
| 35 |
35 |
</snapshots> |
| 36 |
36 |
<id>xima</id> |
| 37 |
|
- <name>libs-release</name> |
|
36 |
+ <name>fc-plugin-dev</name> |
| 38 |
38 |
<url>https://artifactory.xima-services.de/artifactory/fc-plugin-dev</url> |
| 39 |
39 |
</repository> |
| 40 |
40 |
</repositories> |
| ... |
... |
@@ -45,7 +45,7 @@ |
| 45 |
45 |
<enabled>false</enabled> |
| 46 |
46 |
</snapshots> |
| 47 |
47 |
<id>xima</id> |
| 48 |
|
- <name>plugins-release</name> |
|
47 |
+ <name>fc-plugin-dev</name> |
| 49 |
49 |
<url>https://artifactory.xima-services.de/artifactory/fc-plugin-dev</url> |
| 50 |
50 |
</pluginRepository> |
| 51 |
51 |
</pluginRepositories> |
| ... |
... |
@@ -66,16 +66,20 @@ |
| 66 |
66 |
{{/code}} |
| 67 |
67 |
{{/panel}} |
| 68 |
68 |
|
| 69 |
|
-== Projekt-Setup |
|
68 |
+== Maven-Projekteinrichtung == |
| 70 |
70 |
|
| 71 |
|
-=== Artekfakte und Abhängigkeiten |
|
70 |
+Im Folgenden werden einige Punkte beschrieben, die beim Einrichten eines Maven-Projekts für ein {{formcycle/}}-Plugin beachtet werden müssen. Für den schnellen Einstieg gibt auch einige [[Maven-Archetypes>>||anchor="HMaven-Archetypes"]]. |
| 72 |
72 |
|
|
72 |
+=== Artekfakte und Abhängigkeiten === |
|
73 |
+ |
| 73 |
73 |
{{info}} |
| 74 |
74 |
Alle Abhängigkeiten zu {{formcycle case="dat"/}} sind im scope "provided" zu definieren! |
| 75 |
75 |
{{/info}} |
| 76 |
76 |
|
| 77 |
|
-Ausgangspunkt für die Entwicklung von Plugin ist das Maven-Artefakt //fc-plugin-common//. Dieses enthält die einzelnen Plugin-Schnittstellen und steht auch auf [[unserere Downloadseite zur Verfügung>>url:http://artifactory.xima-services.de/artifactory/fc-plugin-dev/de/xima/fc/fc-plugin-common/]]. |
|
78 |
+Eine fertige einfache //pom.xml// können Sie [[hier herunterladen>>attach:pom.xml||rel="__blank"]]. |
| 78 |
78 |
|
|
80 |
+Ausgangspunkt für die Entwicklung von Plugin ist das Maven-Artefakt //fc-plugin-common//. Dieses enthält die einzelnen Plugin-Schnittstellen und steht auch auf [[unsererer Downloadseite zur Verfügung>>url:http://artifactory.xima-services.de/artifactory/fc-plugin-dev/de/xima/fc/fc-plugin-common||rel="noopener noreferrer" target="_blank"]]. |
|
81 |
+ |
| 79 |
79 |
In der //pom.xml// des Plugin-Projekts kann diese Abhängigkeit wie folgt eingebunden werden: |
| 80 |
80 |
|
| 81 |
81 |
{{code language="xml"}} |
| ... |
... |
@@ -93,7 +93,7 @@ |
| 93 |
93 |
</dependencies> |
| 94 |
94 |
{{/code}} |
| 95 |
95 |
|
| 96 |
|
-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: |
|
99 |
+Ferner steht je nach Tiefe der Integration in die bestehende Umgebung von {{formcycle case="dat"/}} und deren Benutzung als höchste Implementierung das Artefakt //fc-logic// zur Verfügung. Dieses wird wie folgt als weitere (oder einzige) Abhängigkeit definiert: |
| 97 |
97 |
|
| 98 |
98 |
{{code language="xml"}} |
| 99 |
99 |
<dependency> |
| ... |
... |
@@ -104,22 +104,22 @@ |
| 104 |
104 |
</dependency> |
| 105 |
105 |
{{/code}} |
| 106 |
106 |
|
| 107 |
|
-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"]]. |
|
110 |
+Eine entsprechende Benutzung ist vor allem bei der Verwendung der Datenbankschnittstelle sowie bei der Implementierung von eigenen Verarbeitungen nötig. |
| 108 |
108 |
|
| 109 |
109 |
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). |
| 110 |
110 |
|
| 111 |
|
-=== Manifest und Fat JAR |
|
114 |
+=== Manifest und Fat JAR === |
| 112 |
112 |
|
| 113 |
113 |
In der //META-INF/MANIFEST.MF// in der Plugin-JAR-Datei sollten folgende Informationen stehen: |
| 114 |
114 |
|
| 115 |
115 |
; formcycle-version-requirement |
| 116 |
|
-: Erforderlich. Version von {{formcycle/}}, für die das Plugin gedacht ist.Ist erforderlich, damit {{formcycle/}} bei der Installation die Kompatibilität prüfen kann. |
|
119 |
+: Erforderlich. Version von {{formcycle/}}, für die das Plugin gedacht ist. Ist erforderlich, damit {{formcycle/}} bei der Installation die Kompatibilität prüfen kann. |
| 117 |
117 |
; Implementation-Version |
| 118 |
|
-: Erforderlich. Version des Plugins, wird etwa in der Oberfläche angezeigt. |
|
121 |
+: Erforderlich. Version des Plugins; Diese wird z.B. in der Oberfläche angezeigt. |
| 119 |
119 |
; Build-Time oder Build-Timestamp |
| 120 |
|
-: Optional, wird bei SNAPSHOT-Versionen mit angezeigt, um den SNAPSHOT zu identifizieren. |
|
123 |
+: Optional. Wird bei SNAPSHOT-Versionen mit angezeigt, um den SNAPSHOT zu identifizieren. |
| 121 |
121 |
; Implementation-Title |
| 122 |
|
-: Optional, wird standardmäßig etwa vom Deploy-Plugin verwendet, um das Plugin zu identifzieren. |
|
125 |
+: Optional. Wird standardmäßig etwa vom Deploy-Plugin verwendet, um das Plugin zu identifzieren. |
| 123 |
123 |
|
| 124 |
124 |
Diese Informationen können wie unten beschrieben mittels des //maven-assembly-plugin// in die Manifest-Datei geschrieben werden. |
| 125 |
125 |
|
| ... |
... |
@@ -135,7 +135,7 @@ |
| 135 |
135 |
<maven-assembly-plugin.version>3.3.0</maven-assembly-plugin.version> |
| 136 |
136 |
</properties> |
| 137 |
137 |
<build> |
| 138 |
|
- <finalName>${project.parent.artifactId}</finalName> |
|
141 |
+ <finalName>${project.artifactId}</finalName> |
| 139 |
139 |
<plugins> |
| 140 |
140 |
<plugin> |
| 141 |
141 |
<groupId>org.apache.maven.plugins</groupId> |
| ... |
... |
@@ -149,7 +149,7 @@ |
| 149 |
149 |
<goal>single</goal> |
| 150 |
150 |
</goals> |
| 151 |
151 |
<configuration> |
| 152 |
|
- <finalName>${project.parent.artifactId}</finalName> |
|
155 |
+ <finalName>${project.artifactId}</finalName> |
| 153 |
153 |
<appendAssemblyId>false</appendAssemblyId> |
| 154 |
154 |
<descriptorRefs> |
| 155 |
155 |
<descriptorRef>jar-with-dependencies</descriptorRef> |
| ... |
... |
@@ -183,24 +183,103 @@ |
| 183 |
183 |
mvn clean install |
| 184 |
184 |
{{/code}} |
| 185 |
185 |
|
| 186 |
|
-Nachdem das Plugin erfolgreich gebaut wurde, kann die so entstandene JAR-Datei in {{formcycle/}} über die Oberfläche [[Mandant-Plugins>>doc:Formcycle.UserInterface.Client.Plugins]] beziehungsweise [[System-Plugins>>doc:Formcycle.SystemSettings.UserInterface.SystemPlugins]] hochgeladen werden. |
|
189 |
+Nachdem das Plugin erfolgreich gebaut wurde, kann die so entstandene JAR-Datei im //target//-Verzeichnis in {{formcycle/}} über die Oberfläche [[Mandant-Plugins>>doc:Formcycle.UserInterface.Client.Plugins]] beziehungsweise [[System-Plugins>>doc:Formcycle.SystemSettings.UserInterface.SystemPlugins]] hochgeladen werden. |
| 187 |
187 |
|
| 188 |
|
-Zum automatischen Hochladen gibt es zudem das Deploy-Plugin, siehe unten. |
|
191 |
+Siehe [[Deploy-Plugin>>||anchor="HDeploy-Plugin"]] zum automatischen Hochladen beim Maven-Build. |
| 189 |
189 |
|
| 190 |
|
-Zum Starten eines einfachen {{formcycle}}-Servers gibt es das FC-Server-Plugin, siehe ebenfalls unten. |
|
193 |
+Siehe [[FC-Server-Plugin>>||anchor="HFC-Server-Plugin"]] zum Starten eines einfachen {{formcycle/}}-Servers. |
| 191 |
191 |
|
| 192 |
192 |
== Maven-Archetypes == |
| 193 |
193 |
|
| 194 |
|
-TODO |
|
197 |
+{{figure image="eclipse-archetype.png" width="500"}} |
|
198 |
+ Hinzufügen des Archetypes-Katalogs in Eclipse |
|
199 |
+{{/figure}} |
| 195 |
195 |
|
| 196 |
|
-Um einen besseren Einstieg in die Plugin-Entwicklung zu finden, [[bieten wir auf unserer Downloadseite>>url:https://customer.formcycle.eu/index.php/s/PgdMrNOvbYEzhmr]] |
|
201 |
+{{figure image="eclipse-archetype-select.png" width="500"}} |
|
202 |
+ Auswahl eines Archetypes beim Erstellen eines Maven-Projekts in Eclipse |
|
203 |
+{{/figure}} |
| 197 |
197 |
|
| 198 |
|
-== Deploy-Plugin |
|
205 |
+Für einige häufig verwendete Plugin-Typen stehen [[Maven-Archetypes>>url:https://maven.apache.org/guides/introduction/introduction-to-archetypes.html||rel="noopener noreferrer" target="_blank"]] bereits, um schnell ein Maven-Projekt aufsetzen zu können. |
| 199 |
199 |
|
| 200 |
|
-TODO |
|
207 |
+Voraussetzung für die Verwendung ist, dass in den //~~/.m2/settings.xml// wie oben beschrieben das XIMA-Artifactory eingerichtet wurde. Dann kann etwa über die Kommandozeile wie folgt eine Archetype generiert werden: |
| 201 |
201 |
|
| 202 |
|
-== FC-Server-Plugin |
|
209 |
+{{code}} |
|
210 |
+mvn archetype:generate -DarchetypeArtifactId=plugin-archetype-workflow-element-simple -DarchetypeGroupId=de.xima.fc.archetype -DarchetypeVersion=7.0.4 |
|
211 |
+{{/code}} |
| 203 |
203 |
|
| 204 |
|
-TODO |
|
213 |
+Es werden dann einige wenige Informationen wie die gewünschten Maven-Koordinaten des neuen Plugin-Projekts abgefragt und anschließend ein neues vorkonfiguriertes Projekt erstellt. |
| 205 |
205 |
|
|
215 |
+Alle vorhandenen Archetypes und deren Versionen können im [[Archetype-Katalog>>url:https://artifactory.xima-services.de/artifactory/libs-release-local/archetype-catalog.xml||rel="noopener noreferrer" target="_blank"]] eingesehen werden. |
| 206 |
206 |
|
|
217 |
+In Eclipse kann der Archetype-Katalog in den Einstellungen hinzugefügt werden. Bei der Erstellung eines neuen Maven-Projekt werden dann alle verfügbaren Archetypes angezeigt: |
|
218 |
+ |
|
219 |
+{{code language="plaintext"}} |
|
220 |
+https://artifactory.xima-services.de/artifactory/libs-release-local/archetype-catalog.xml |
|
221 |
+{{/code}} |
|
222 |
+ |
|
223 |
+== Deploy-Plugin == |
|
224 |
+ |
|
225 |
+Um beim Entwickeln nicht jedes Mal eine neue Plugin-Version manuell über die Oberfläche hochladen zu müssen, kann das Deploy-Plugin verwendet werden. Dieses besteht aus 2 Teilen: |
|
226 |
+ |
|
227 |
+* Ein Maven-Plugin, welches nach dem Bauen das Plugin via HTTP an einen laufenden {{formcycle/}}-Server sendet |
|
228 |
+* Ein Plugin für {{formcycle/}}, welche die Gegenstelle in {{formcycle/}} bereitstellt und das Plugin aus dem HTTP-Request in {{formcycle/}} installiert. |
|
229 |
+ |
|
230 |
+Weitere Details können im [[Hilfe-Artikel zum Deploy-Plugin>>doc:Formcycle.PluginDocumentation.FormcycleDeployPluginPlugin]] nachgelesen werden. Für die meisten Fälle reicht folgende Konfiguration in der //pom.xml// des Plugin-Projekts aus: |
|
231 |
+ |
|
232 |
+{{code language="xml"}} |
|
233 |
+ <properties> |
|
234 |
+ <fc-deploy-plugin-maven-plugin.version>7.0.1<fc-deploy-plugin-maven-plugin.version></fc-deploy-plugin-maven-plugin> |
|
235 |
+ <build> |
|
236 |
+ <plugins> |
|
237 |
+ <plugin> |
|
238 |
+ <groupId>de.xima.fc.maven.plugin</groupId> |
|
239 |
+ <artifactId>fc-deploy-plugin-maven-plugin</artifactId> |
|
240 |
+ <version>${fc-deploy-plugin-maven-plugin.version}</version> |
|
241 |
+ <executions> |
|
242 |
+ <execution> |
|
243 |
+ <id>upload</id> |
|
244 |
+ <phase>package</phase> |
|
245 |
+ <goals> |
|
246 |
+ <goal>deploy</goal> |
|
247 |
+ </goals> |
|
248 |
+ </execution> |
|
249 |
+ </executions> |
|
250 |
+ </plugin> |
|
251 |
+ </plugins> |
|
252 |
+ </build> |
|
253 |
+{{/code}} |
|
254 |
+ |
|
255 |
+Sofern das Deploy-Plugin bereits in {{formcycle/}} installiert ist, kann das Plugin-Projekt dann beim Bauen wie folgt hochgeladen werden: |
|
256 |
+ |
|
257 |
+{{code language="bash"}} |
|
258 |
+mvn package fc-deploy:deploy -DfcDeployUrl=http://localhost:8080/xima-formcycle -DfcDeployToken=admin |
|
259 |
+{{/code}} |
|
260 |
+ |
|
261 |
+Wird Eclipse benutzt, kann auch eine Launch-Configuration mit den //fcDeployUrl// und dem //fcDeployToken// angelegt werden. Das Plugin wird dann unter den System-Plugins registriert. |
|
262 |
+Soll das Plugin im Bereich eines bestimmten Mandanten registriert werden, so kann dies über den zusätzlichen Launch-Configuration Parameter //fcDeployClientId //erreicht werden. Dieser Parameter muss als Wert die Id des Mandanten enthalten. |
|
263 |
+ |
|
264 |
+== FC-Server-Plugin == |
|
265 |
+ |
|
266 |
+Zum Testen eines Plugins ist es erforderlich, einen laufenden {{formcycle/}}-Server zu haben. Zur Vereinfachung der Entwicklung gibt es das //fc-server-maven-plugin//, welches mittels eines einzigen Befehls ein fertig eingerichtetes {{formcycle/}} lokal startet, wo auch bereits das Deploy-Plugin vorinstalliert ist. |
|
267 |
+ |
|
268 |
+Sofern wie oben beschrieben in //~~/.m2/settings.xml// die //pluginGroup// hinterlegt wurde, kann in einem beliebiegen Verzeichnis wie folgt ein {{formcycle/}}-Server per Maven gestartet werden: |
|
269 |
+ |
|
270 |
+{{code language="bash"}} |
|
271 |
+# Aktuelle Version starten |
|
272 |
+mvn package fc-server:run-ms-war |
|
273 |
+ |
|
274 |
+# Spezifische Version starten |
|
275 |
+mvn de.xima.fc.maven.plugin:fc-server-maven-plugin:7.0.4:run-ms-war -DxfcVersion=7.0.16 |
|
276 |
+{{/code}} |
|
277 |
+ |
|
278 |
+{{info}} |
|
279 |
+Wir empfehlen die Nutzung von Java 11. Bei Nutzung von Java 17 kann es aktuell zu Problemen beim Starten von {{formcycle/}} kommen. |
|
280 |
+{{/info}} |
|
281 |
+ |
|
282 |
+{{info}} |
|
283 |
+Die Major- und Minor-Version des Maven-Plugins sollte immer der Major- und Minor-Version des zu startenden {{formcycle case="gen"/}} entsprechen. Für {{formcycle/}} 7.0.x sollte also das Maven-Plugin in Version 7.0.x verwendet werde, für {{formcycle/}} 7.1.x das Maven-Plugin in Version 7.1.x usw. |
|
284 |
+{{/info}} |
|
285 |
+ |
|
286 |
+Nach kurzer Wartezeit (beim ersten Mal kann es länger dauern) ist dann ein {{formcycle/}}-Server gestartet. Die URL steht am Ende in der Kommandozeile, standardmäßig http://localhost:8080/xima-formcycle Der Zugang für den Superadmin ist {{code language="plaintext"}}sadmin{{/code}} (Passwort {{code language="plaintext"}}admin{{/code}}), der Zugang für den Mandantadministrator {{code language="plaintext"}}admin{{/code}} (Passwort {{code language="plaintext"}}/admin_{{/code}}). |
|
287 |
+ |
|
288 |
+Dies funktioniert auch in einem Ordner ohne Maven-Projekt. Falls keine {{formcycle/}} angegeben ist, wird eine Standard-Version genommen. Wird der Befehl innerhalb eines Plugin-Maven-Projekts ausgeführt, wird versucht, die Version von {{formcycle/}} aus dem Plugin-Projekt auszulesen. |
