| ... |
... |
@@ -5,7 +5,7 @@ |
| 5 |
5 |
|
| 6 |
6 |
== API-Dokumentation == |
| 7 |
7 |
|
| 8 |
|
-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/]] |
| 9 |
9 |
|
| 10 |
10 |
== Maven-Setup == |
| 11 |
11 |
|
| ... |
... |
@@ -65,7 +65,7 @@ |
| 65 |
65 |
{{/code}} |
| 66 |
66 |
{{/panel}} |
| 67 |
67 |
|
| 68 |
|
-== Maven-Projekteinrichtung === |
|
68 |
+== Maven-Projekteinrichtung == |
| 69 |
69 |
|
| 70 |
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"]]. |
| 71 |
71 |
|
| ... |
... |
@@ -77,7 +77,7 @@ |
| 77 |
77 |
|
| 78 |
78 |
Eine fertige einfache //pom.xml// können Sie [[hier herunterladen>>attach:pom.xml||rel="__blank"]]. |
| 79 |
79 |
|
| 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||target="_blank"]]. |
|
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 |
81 |
|
| 82 |
82 |
In der //pom.xml// des Plugin-Projekts kann diese Abhängigkeit wie folgt eingebunden werden: |
| 83 |
83 |
|
| ... |
... |
@@ -202,7 +202,7 @@ |
| 202 |
202 |
Auswahl eines Archetypes beim Erstellen eines Maven-Projekts in Eclipse |
| 203 |
203 |
{{/figure}} |
| 204 |
204 |
|
| 205 |
|
-Für einige häufig verwendete Plugin-Typen stehen [[Maven-Archetypes>>url:https://maven.apache.org/guides/introduction/introduction-to-archetypes.html||target="_blank"]] bereits, um schnell ein Maven-Projekt aufsetzen zu können. |
|
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. |
| 206 |
206 |
|
| 207 |
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: |
| 208 |
208 |
|
| ... |
... |
@@ -212,11 +212,13 @@ |
| 212 |
212 |
|
| 213 |
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. |
| 214 |
214 |
|
| 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||target="_blank"]] eingesehen werden. |
|
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. |
| 216 |
216 |
|
| 217 |
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 |
218 |
|
| 219 |
|
-{{code language="plaintext"}}https://artifactory.xima-services.de/artifactory/libs-release-local/archetype-catalog.xml{{/code}} |
|
219 |
+{{code language="plaintext"}} |
|
220 |
+https://artifactory.xima-services.de/artifactory/libs-release-local/archetype-catalog.xml |
|
221 |
+{{/code}} |
| 220 |
220 |
|
| 221 |
221 |
== Deploy-Plugin == |
| 222 |
222 |
|
| ... |
... |
@@ -229,10 +229,10 @@ |
| 229 |
229 |
|
| 230 |
230 |
{{code language="xml"}} |
| 231 |
231 |
<properties> |
| 232 |
|
- <fc-deploy-plugin-maven-plugin.version>7.0.1<fc-deploy-plugin-maven-plugin.version/> |
|
234 |
+ <fc-deploy-plugin-maven-plugin.version>7.0.1<fc-deploy-plugin-maven-plugin.version></fc-deploy-plugin-maven-plugin> |
| 233 |
233 |
<build> |
| 234 |
234 |
<plugins> |
| 235 |
|
- <plugin> |
|
237 |
+ <plugin> |
| 236 |
236 |
<groupId>de.xima.fc.maven.plugin</groupId> |
| 237 |
237 |
<artifactId>fc-deploy-plugin-maven-plugin</artifactId> |
| 238 |
238 |
<version>${fc-deploy-plugin-maven-plugin.version}</version> |
| ... |
... |
@@ -256,7 +256,8 @@ |
| 256 |
256 |
mvn package fc-deploy:deploy -DfcDeployUrl=http://localhost:8080/xima-formcycle -DfcDeployToken=admin |
| 257 |
257 |
{{/code}} |
| 258 |
258 |
|
| 259 |
|
-Wird Eclipse benutzt, kann auch eine Launch-Configuration mit den //fcDeployUrl// und dem //fcDeployToken// angelegt werden. |
|
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. |
| 260 |
260 |
|
| 261 |
261 |
== FC-Server-Plugin == |
| 262 |
262 |
|
| ... |
... |
@@ -265,10 +265,21 @@ |
| 265 |
265 |
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: |
| 266 |
266 |
|
| 267 |
267 |
{{code language="bash"}} |
| 268 |
|
-mvn package fc-server:run-ms-war -DxfcVersion=7.0.10 |
|
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 |
| 269 |
269 |
{{/code}} |
| 270 |
270 |
|
|
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 |
+ |
| 271 |
271 |
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}}). |
| 272 |
272 |
|
| 273 |
273 |
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. |
| 274 |
|
- |
