Änderungen von Dokument Plugin-Entwicklung


Von Version 11.1
bearbeitet von awa
am 04.12.2022, 00:41
Änderungskommentar: Uploaded new attachment "pom.xml", version 1.8
Auf Version 10.9
bearbeitet von awa
am 02.12.2022, 21:13
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -83,7 +83,7 @@
83 83  
84 84  {{code language="xml"}}
85 85   <properties>
86 - <xfc.version>7.2.1</xfc.version>
86 + <xfc.version>7.0.10</xfc.version>
87 87   </properties>
88 88  
89 89   <dependencies>
... ... @@ -136,15 +136,11 @@
136 136  : Erforderlich. Version von {{formcycle/}}, für die das Plugin gedacht ist. Ist erforderlich, damit {{formcycle/}} bei der Installation die Kompatibilität prüfen kann.
137 137  ; Implementation-Version
138 138  : Erforderlich. Version des Plugins; Diese wird z.B. in der Oberfläche angezeigt.
139 -; Plugin-Key
140 -: Erforderlch. Wird zur Identifizierung des Plugin innherhalb von {{formcycle/}} verwendet, und auch von etwa dem Deploy-Plugin oder Server-Plugin. Empfohlener Wert ist {{code}}${project.groupId}:${project.artifactId}{{/code}}.
141 141  ; Build-Time oder Build-Timestamp
142 142  : Optional. Wird bei SNAPSHOT-Versionen mit angezeigt, um den SNAPSHOT zu identifizieren.
141 +; Implementation-Title
142 +: Optional. Wird standardmäßig etwa vom Deploy-Plugin verwendet, um das Plugin zu identifzieren.
143 143  
144 -{{info}}
145 -Bis einschließlich Version 7.x von {{formcycle/}} ist noch {{code}}Implementation-Title{{/code}} mit dem gleichen Wert wie {{code}}Plugin-Key{{/code}} erforderlich.
146 -{{/info}}
147 -
148 148  Diese Informationen können wie unten beschrieben mittels des //maven-assembly-plugin// in die Manifest-Datei geschrieben werden.
149 149  
150 150  Weiterhin ist beim Bauen zu beachten, dass eine sogenannte Fat-JAR gebaut werden muss. Abhängigkeiten zu {{formcycle case="dat"/}} sowie anderen Bibliotheken, welche bereits durch {{formcycle case="acc"/}} mitgeliefert werden, sollten wie bereits erwähnt im scope //provided// eingebunden werden. Falls im Plugin aber noch andere Abhängigkeiten benutzt werden, müssen diese in der JAR-Datei inkludiert werden (Fat JAR).
... ... @@ -248,7 +248,7 @@
248 248  * Ein Maven-Plugin, welches nach dem Bauen das Plugin via HTTP an einen laufenden {{formcycle/}}-Server sendet
249 249  * Ein Plugin für {{formcycle/}}, welche die Gegenstelle in {{formcycle/}} bereitstellt und das Plugin aus dem HTTP-Request in {{formcycle/}} installiert.
250 250  
251 -Weitere Details können im [[Hilfe-Artikel zum Deploy-Plugin>>doc:Formcycle.PluginDocumentation.FormcycleDeployPluginPlugin]] nachgelesen werden. Für die meisten Fälle ist kene Konfiguration in der //pom.xml// erforderlich. Es empfiehlt sich aber, wenigstens die Version festzusetzen:
247 +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:
252 252  
253 253  {{code language="xml"}}
254 254   <properties>
... ... @@ -259,27 +259,27 @@
259 259   <groupId>de.xima.fc.maven.plugin</groupId>
260 260   <artifactId>fc-deploy-plugin-maven-plugin</artifactId>
261 261   <version>${fc-deploy-plugin-maven-plugin.version}</version>
258 + <executions>
259 + <execution>
260 + <id>upload</id>
261 + <phase>package</phase>
262 + <goals>
263 + <goal>deploy</goal>
264 + </goals>
265 + </execution>
266 + </executions>
262 262   </plugin>
263 263   </plugins>
264 264   </build>
265 265  {{/code}}
266 266  
267 -Sofern das Deploy-Plugin bereits in {{formcycle/}} installiert ist, kann das Plugin-Projekt dann wie folgt gebaut und hochgeladen werden:
272 +Sofern das Deploy-Plugin bereits in {{formcycle/}} installiert ist, kann das Plugin-Projekt dann beim Bauen wie folgt hochgeladen werden:
268 268  
269 269  {{code language="bash"}}
270 -mvn fc-deploy:deploy
271 -{{/code}}
272 -
273 -Es wird hierbei davon ausgegangen, dass {{formcycle/}} unter der Standard-URL {{code}}http://localhost:8080/xima-formcycle{{/code}} läuft und das Standard-Passwort "admin" für das Deploy-Plugin verwendet wird. Ist dies nicht der Fall, können die Werte auch angepasst werden:
274 -
275 -{{code language="bash"}}
276 276  mvn package fc-deploy:deploy -DfcDeployUrl=http://localhost:8080/xima-formcycle -DfcDeployToken=admin
277 277  {{/code}}
278 278  
279 -{{info}}
280 -Bis einschließlich Version 7.x von {{formcycle/}} und dem Maven-Plugin ist es noch erforderlich, die package-Phase explizit aufzuführen. Zudem müssen die URL und das Passwort angegeben werden. Ab Version 8.x sind die Standardwerte gesetzt und die package-Phase wird automatisch ausgeführt.
281 -{{/info}}
282 -
278 +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.
283 283  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.
284 284  
285 285  == FC-Server-Plugin ==
... ... @@ -301,7 +301,7 @@
301 301  {{/info}}
302 302  
303 303  {{info}}
304 -Bis einschließlich Version 7.x von {{formcycle/}} und dem Maven-Plugin ist es noch erforderlich, die package-Phase explizit aufzuführen: {{code}}mvn package fc-server:run-ms-war{{/code}}. Ab Version 8.x geschieht dies automatisch.
300 +Bis einschließlich Version 7.x von {{formcycle/}} und dem Maven-Plugin ist es noch erforderlich, die package-Phase explizit auszuführen: {{code}}mvn package fc-server:run-ms-war{{/code}}. Ab Version 8.x geschieht dies automatisch.
305 305  {{/info}}
306 306  
307 307  {{info}}
pom.xml
Größe
... ... @@ -1,1 +1,1 @@
1 -5.8 KB
1 +5.7 KB
Inhalt
... ... @@ -15,7 +15,7 @@
15 15   <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
16 16  
17 17   <!-- Dependencies -->
18 - <xfc.version>7.2.1</xfc.version>
18 + <xfc.version>7.0.10</xfc.version>
19 19   <junit-jupiter.version>5.6.0</junit-jupiter.version>
20 20  
21 21   <!-- Plugins -->
... ... @@ -139,7 +139,6 @@
139 139   <manifestEntries>
140 140   <formcycle-version-requirement>${xfc.version}</formcycle-version-requirement>
141 141   <Build-Timestamp>${maven.build.timestamp}</Build-Timestamp>
142 - <Plugin-Key>${project.groupId}:${project.artifactId}</Plugin-Key>
143 143   <Implementation-Title>${project.groupId}:${project.artifactId}</Implementation-Title>
144 144   <Implementation-Vendor-Id>${project.groupId}</Implementation-Vendor-Id>
145 145   <Implementation-Version>${project.version}</Implementation-Version>