Changes for page Plugin-Entwicklung

From version 1.1
edited by gru
on 20.01.2021, 16:18
Change comment: Imported from XAR
To version 1.27
edited by awa
on 15.03.2023, 18:15
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.gru
1 +XWiki.awa
Content
... ... @@ -1,8 +1,8 @@
1 1  {{content/}}
2 2  
3 -== Plugins for extending {{formcycle/}} ==
3 +Plugins let you extend {{formcycle/}} and add new features. Various different [[plugin type>>doc:Formcycle.PluginDevelopment.Types.WebHome]] exist, such as plugins for adding custom workflow actions ands triggers, or plugins for new form elements.
4 4  
5 -Many services and functions of {{formcycle/}} can be customized and extended by using plugins. Each [[plugin type>>doc:Formcycle.PluginDevelopment.Types.WebHome]] extends a certain aspect of {{formcycle/}}, such as workflow processing or preprocessing forms. To create a custom plugin, you need to setup a Java project first of all.
5 +A plugin must be a JAR file with the appropriate class files. To create a custom plugin, you need to setup a Java project, such as via Maven.
6 6  
7 7  == API documentation ==
8 8  
... ... @@ -10,134 +10,311 @@
10 10  
11 11  == Project setup ==
12 12  
13 -Setup a new Java project with the IDE of your choice. {{formcycle/}} uses the build management system [[Apache Maven>>url:https://maven.apache.org/]]) to resolve dependencies. Dependencies are provided by our public artifactory {{code language="none"}}http://artifactory.xima-services.de/artifactory/fc-plugin-dev{{/code}}. It contains all components needed for developing plugins. The main artifact you will need is the artifact [[fc-plugin-common>>url:http://artifactory.xima-services.de/artifactory/fc-plugin-dev/de/xima/fc/fc-plugin-common/]], containing all Java interfaces available for plugins.
13 +To get started with developing plugins, you need to create and configure new project.
14 14  
15 -Maven uses configuration files named {{code language="none"}}pom.xml{{/code}} (project object model). A pom for plugin development might look as follows:
15 +We recommend the build tool [[Apache Maven>>url:https://maven.apache.org/||rel="__blank"]]. Other build tools such as Gradle are possible, but you will not find any help for those tools here.
16 16  
17 -{{panel title="Example for a pom.xml" initial="hidden" triggerable="true" fullwidth="true"}}
17 +To access the {{formcycle case="dat"/}} dependencies, you need to use the Maven repository [[https:~~/~~/artifactory.xima-services.de/artifactory/fc-plugin-dev>>url:https://artifactory.xima-services.de/artifactory/fc-plugin-dev]]. This contains all Maven artifacts required for developing plugins.
18 +
19 +To get Maven to recognize that repository, add it tot the Maven configuration file //settings.xml//. Usually, you can find this settings file in the //.m2// folder in your home directory, i.e. //~~/.m2/settings.xml// for Linux and //%homepath%\.m2\settings.xml// for Windows:
20 +
21 +{{panel title="~~~~/.m2/settings.xml" fullwidth="true" initial="hidden" triggerable="true"}}
18 18  {{code language="xml"}}
19 -<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
20 - xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
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">
21 21  
22 -...
27 + <!-- Add XIMA artifactory -->
28 + <profiles>
29 + <profile>
30 + <!-- FORMCYCLE dependencies -->
31 + <repositories>
32 + <repository>
33 + <snapshots>
34 + <enabled>false</enabled>
35 + </snapshots>
36 + <id>xima</id>
37 + <name>fc-plugin-dev</name>
38 + <url>https://artifactory.xima-services.de/artifactory/fc-plugin-dev</url>
39 + </repository>
40 + </repositories>
41 + <!-- Maven plugins for FORMCYCLE -->
42 + <pluginRepositories>
43 + <pluginRepository>
44 + <snapshots>
45 + <enabled>false</enabled>
46 + </snapshots>
47 + <id>xima</id>
48 + <name>fc-plugin-dev</name>
49 + <url>https://artifactory.xima-services.de/artifactory/fc-plugin-dev</url>
50 + </pluginRepository>
51 + </pluginRepositories>
52 + <id>xima-artifactory</id>
53 + </profile>
54 + </profiles>
23 23  
24 - <properties>
25 - <!-- Configuration -->
26 - <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
56 + <!-- Enable XIMA artifactory by default -->
57 + <activeProfiles>
58 + <activeProfile>xima-artifactory</activeProfile>
59 + </activeProfiles>
27 27  
28 - <!-- Dependencies -->
29 - <xfc-version>4.2.3</xfc-version>
61 + <!-- FORMCYCLE specific Maven plugins provided by XIMA -->
62 + <pluginGroups>
63 + <pluginGroup>de.xima.fc.maven.plugin</pluginGroup>
64 + </pluginGroups>
65 +</settings>
66 +{{/code}}
67 +{{/panel}}
30 30  
31 - <!-- Plugins -->
32 - <maven-compiler-plugin-version>3.3</maven-compiler-plugin-version>
33 - <maven-jar-plugin-version>2.4</maven-jar-plugin-version>
34 - </properties>
69 +== Maven project setup
35 35  
36 - <repositories>
37 - <repository>
38 - <id>xima</id>
39 - <name>fc-plugin-dev</name>
40 - <url>http://artifactory.xima-services.de/artifactory/fc-plugin-dev</url>
41 - </repository>
42 - </repositories>
71 +The following lists a few important steps required for setting up a Maven project for a {{formcycle/}} plugin, but we assume you have basic knowledge of how to work with Maven.
43 43  
44 - <dependencies>
45 - <dependency>
46 - <groupId>de.xima.fc</groupId>
47 - <artifactId>fc-plugin-common</artifactId>
48 - <version>${xfc-version}</version>
49 - <scope>provided</scope>
50 - </dependency>
51 - </dependencies>
73 +To get started with a plugin, you can also use of of the available [[Maven archetypes>>||anchor="HMavenarchetypes"]].
52 52  
53 - <build>
54 - <plugins>
55 - <plugin>
56 - <groupId>org.apache.maven.plugins</groupId>
57 - <artifactId>maven-compiler-plugin</artifactId>
58 - <version>${maven-compiler-plugin-version}</version>
59 - <configuration>
60 - <source>1.7</source>
61 - <target>1.7</target>
62 - <encoding>UTF-8</encoding>
63 - </configuration>
64 - </plugin>
75 +=== Artekfakte und Abhängigkeiten
65 65  
66 - <plugin>
67 - <groupId>org.apache.maven.plugins</groupId>
68 - <artifactId>maven-jar-plugin</artifactId>
69 - <version>${maven-jar-plugin-version}</version>
70 - <configuration>
71 - <archive>
72 - <manifest>
73 - <addDefaultImplementationEntries>true</addDefaultImplementationEntries>
74 - </manifest>
75 - <manifestEntries>
76 - <formcycle-version-requirement>${xfc-version}</formcycle-version-requirement>
77 - <Build-Time>${maven.build.timestamp}</Build-Time>
78 - </manifestEntries>
79 - </archive>
80 - </configuration>
81 - </plugin>
77 +{{info}}
78 +All dependencies to {{formcycle/}} must be declared with the scope //provided//.
79 +{{/info}}
82 82  
83 - </plugins>
84 - </build>
85 -</project>
81 +You can download a complete //pom.xml// for plugin development [[here>>attach:pom.xml||rel="__blank"]].
86 86  
83 +The main artifact you need to include is the artifact [[fc-plugin-common>>url:http://artifactory.xima-services.de/artifactory/fc-plugin-dev/de/xima/fc/fc-plugin-common/]]. It contains all Java interfaces available for plugins.
84 +
85 +Add the following to the //pom.xml// of the plugin project to include that artifact:
86 +
87 +{{code language="xml"}}
88 + <properties>
89 + <xfc.version>7.2.1</xfc.version>
90 + </properties>
91 +
92 + <dependencies>
93 + <dependency>
94 + <groupId>de.xima.fc</groupId>
95 + <artifactId>fc-plugin-common</artifactId>
96 + <version>${xfc.version}</version>
97 + <scope>provided</scope>
98 + </dependency>
99 + </dependencies>
87 87  {{/code}}
88 -{{/panel}}
89 89  
90 -Certain plugins may require additional classes and functionality of the {{formcycle/}} system, which is provided by the artifact //fc-logic//. To add it as a dependency, modify the pom as follows:
102 +For more complicated plugins, you can also include //fc-logic//, which provides more {{formcycle/}} related classes, such as the database access objects when you need to access the database. If you want to use it, replace dependency to //fc-plugin-common// with:
91 91  
92 92  {{code language="xml"}}
93 -...
94 94   <dependency>
95 95   <groupId>de.xima.fc</groupId>
96 96   <artifactId>fc-logic</artifactId>
97 - <version>${xfc-version}</version>
108 + <version>${xfc.version}</version>
98 98   <scope>provided</scope>
99 99   </dependency>
100 -...
101 101  {{/code}}
102 102  
103 -This artifact becomes necessary especially when working with databases or the [[workflow processing>>doc:Formcycle.PluginDevelopment.Types.IPluginProcessing.WebHome]]. You can also [[download a template for a pom file>>attach:pom.xml||rel="__blank"]] that includes the //fc-logic// artifact.
113 +Note that all dependencies must be declared with the //provide// scope. This prevents class path issues and keeps the plugin size small. When possible, use libraries already used by {{formcycle/}}, e.g. certain Apache Common libraries or guava. Also use the provided scope for such dependencies. A simple way to manage versions and avoid mistakes is by including the FORMCYCLE Bom:
104 104  
115 +{{code language="xml"}}
116 + <dependencyManagement>
117 + <dependencies>
118 + <!--Import dependency versions from FORMCYCLE -->
119 + <dependency>
120 + <groupId>de.xima.fc</groupId>
121 + <artifactId>fc</artifactId>
122 + <version>${xfc.version}</version>
123 + <type>pom</type>
124 + <scope>import</scope>
125 + </dependency>
126 + </dependencies>
127 + </dependencyManagement>
128 +{{/code}}
129 +
130 +Then just declare the dependency you wish to use without a {{code}}<version>...</version>{{/code}}. If FORMCYCLE already provides that dependency, you won't get a build error. Otherwise you need to include the dependency in the plugin: Remove the provided scope and add the version.
131 +
132 +
133 +=== Manifest und Fat JAR
134 +
135 +The //META-INF/MANIFEST.MF// file in the plugin JAR should contain the following entries:
136 +
137 +; formcycle-version-requirement
138 +: Required. The version of {{formcycle/}} against which the plugin was compiled. This is required for {{formcycle/}} to check the compatibility when the plugin is installed.
139 +; Implementation-Version
140 +: Required. The version of the plugin, which is for example shown in the UI.
141 +; Plugin-Key
142 +: Required. This is used by {{formcycle/}} to identify the plugin, and also used by e.g. the deploy or server plugin. Recommended value is {{code}}${project.groupId}:${project.artifactId}{{/code}}.
143 +; Build-Time oder Build-Timestamp
144 +: Optional. This is displayed in the UI when the plugin version is a SNAPSHOT.
145 +
105 105  {{info}}
106 -For version of {{formcycle/}} earlier than 4.1.1, you need to exclude the non-public dependency on the //aspose-processor// of the //fc-logic// artifact.
147 +Up until and including version 7.x of {{formcycle/}}, {{code}}Implementation-Title{{/code}} with the same value as {{code}}Plugin-Key{{/code}} is also required.
107 107  {{/info}}
108 108  
109 -Furthermore, note that all dependencies must be declared with the //provide// scope. This prevent class path issues and keeps the plugin size small. When possible, use libraries already in use by {{formcycle/}}, eg. certain Apache Common libraries.
150 +You can use the //maven-assembly-plugin// to add these entries to the manifest.
110 110  
152 +Furthermore, it is required that you create a fat JAR. Dependencies provided by {{formcycle/}} should be declared with the scope //provided//, as mentioned above. However, any additional dependencies that your plugin needs must be included in the JAR file.
153 +
154 +This can be done via the [[maven-assembly-plugin>>url:https://maven.apache.org/plugins/maven-assembly-plugin/]] or via the [[maven-shade-plugin>>url:https://maven.apache.org/plugins/maven-shade-plugin/]]. The latter one is meant for advanced use cases, such as when multiple dependencies have conflicting files and you need to merge those.
155 +
156 +For many plugins, the //maven-assembly-plugin// is sufficient. You can configure this plugin in the //pom.xml// as follows:
157 +
158 +{{panel title="maven-assembly-plugin in pom.xml" fullwidth="true" initial="hidden" triggerable="true"}}
159 +{{code language="java"}}
160 + <properties>
161 + <maven-assembly-plugin.version>3.3.0</maven-assembly-plugin.version>
162 + </properties>
163 + <build>
164 + <finalName>${project.artifactId}</finalName>
165 + <plugins>
166 + <plugin>
167 + <groupId>org.apache.maven.plugins</groupId>
168 + <artifactId>maven-assembly-plugin</artifactId>
169 + <version>${maven-assembly-plugin.version}</version>
170 + <executions>
171 + <execution>
172 + <id>fat-jar</id>
173 + <phase>package</phase>
174 + <goals>
175 + <goal>single</goal>
176 + </goals>
177 + <configuration>
178 + <finalName>${project.artifactId}</finalName>
179 + <appendAssemblyId>false</appendAssemblyId>
180 + <descriptorRefs>
181 + <descriptorRef>jar-with-dependencies</descriptorRef>
182 + </descriptorRefs>
183 + <archive>
184 + <manifest>
185 + <addDefaultImplementationEntries>true</addDefaultImplementationEntries>
186 + </manifest>
187 + <manifestEntries>
188 + <formcycle-version-requirement>${xfc-version}</formcycle-version-requirement>
189 + <Build-Timestamp>${maven.build.timestamp}</Build-Timestamp>
190 + <Implementation-Title>${project.groupId}:${project.artifactId}</Implementation-Title>
191 + <Implementation-Vendor-Id>${project.groupId}</Implementation-Vendor-Id>
192 + <Implementation-Version>${project.version}</Implementation-Version>
193 + </manifestEntries>
194 + </archive>
195 + </configuration>
196 + </execution>
197 + </executions>
198 + </plugin>
199 + </plugins>
200 + </build>
201 +{{/code}}
202 +{{/panel}}
203 +
204 +=== Build and install ===
205 +
206 +In general, the command to build the plugin depends on the settings in the //pom.xml//. In most cases, however, the following standard command should be enough:
207 +
208 +{{code}}
209 +mvn clean install
210 +{{/code}}
211 +
212 +This creates a JAR file in the //target// folder. You can then upload this plugin to a running {{formcycle/}} server, either as a [[client plugin>>doc:Formcycle.UserInterface.Client.Plugins]] or as a [[system plugin>>doc:Formcycle.SystemSettings.UserInterface.SystemPlugins]].
213 +
214 +See the [[deploy plugin>>||anchor="HDeployplugin"]] to upload the plugin to a running {{formcycle/}} server during the Maven build process.
215 +
216 +See the [[FC server plugin>>||anchor="HFCserverplugin"]] for starting a simple {{formcycle/}} server.
217 +
218 +== Maven archetypes ==
219 +
220 +{{figure image="eclipse-archetype.png" width="500"}}
221 + Adding an archetype catalog in Eclipse
222 +{{/figure}}
223 +
224 +{{figure image="eclipse-archetype-select.png" width="500"}}
225 + Selecting an archetype in Eclispe when creating a new Maven project
226 +{{/figure}}
227 +
228 +For some common plugin types, we provide [[Maven archetypes>>url:https://maven.apache.org/guides/introduction/introduction-to-archetypes.html||target="_blank"]] to help you get started.
229 +
230 +If you added the XIMA artifactory to the //~~/.m2/settings.xml// as described above, you can create a new plugin project from an archetype via the following CLI command:
231 +
232 +{{code}}
233 +mvn archetype:generate -DarchetypeArtifactId=plugin-archetype-workflow-element-simple -DarchetypeGroupId=de.xima.fc.archetype
234 +{{/code}}
235 +
236 +This prompts for a few required details such as the desired Maven coordinates of the new project, then creates a new folder in the current working directory with a preconfigured Maven project.
237 +
238 +See the [[archetype catalog>>url:https://artifactory.xima-services.de/artifactory/libs-release-local/archetype-catalog.xml||target="_blank"]] for a list of available archetypes.
239 +
240 +If you are using Eclipse, you can also add the archetype catalog in the Eclipse settings. Eclipse will then show you the available archetypes when you create a new Maven project with the builtin wizard.
241 +
242 +{{code language="plaintext"}}https://artifactory.xima-services.de/artifactory/libs-release-local/archetype-catalog.xml{{/code}}
243 +
244 +== Deploy plugin
245 +
246 +When developing a plugin, you often need to build a new snapshot version and upload it to a running {{formcycle/}} server. To ease that process, the deploy plugin can be used to upload the plugin automatically as part of the Maven build process. It consists of two parts:
247 +
248 +* A Maven plugin, which is run at the end of the build process and sends the plugin JAR file to a running {{formcycle/}} server via HTTP.
249 +* A {{formcycle/}} plugin, which provides the endpoint that takes the plugin from the HTTP requests and installs it to {{formcycle/}}.
250 +
251 +For more details, see [[help page of the deploy plugin>>doc:Formcycle.PluginDocumentation.FormcycleDeployPluginPlugin]]. For most cases, you do not need any configuration in your pom, but we recommend you at least pin the version to a specific release:
252 +
253 +{{code language="xml"}}
254 + <properties>
255 + <fc-deploy-plugin-maven-plugin.version>7.0.1</fc-deploy-plugin-maven-plugin.version>
256 + <build>
257 + <plugins>
258 + <plugin>
259 + <groupId>de.xima.fc.maven.plugin</groupId>
260 + <artifactId>fc-deploy-plugin-maven-plugin</artifactId>
261 + <version>${fc-deploy-plugin-maven-plugin.version}</version>
262 + </plugin>
263 + </plugins>
264 + </build>
265 +{{/code}}
266 +
267 +Assuming the deploy plugin is installed as a system plugin of a {{formcycle/}} server, you can build and upload your plugin project as follows:
268 +
269 +{{code language="bash"}}
270 +mvn fc-deploy:deploy
271 +{{/code}}
272 +
273 +This assumes that {{formcycle/}} is running on the standard URL {{code}}http://localhost:8080/xima-formcycle{{/code}} and that the deploy plugin uses the default password "admin". If that is not the case, you can also change these values:
274 +
275 +{{code language="bash"}}
276 +mvn package fc-deploy:deploy -DfcDeployUrl=http://localhost:8080/xima-formcycle -DfcDeployToken=admin
277 +{{/code}}
278 +
111 111  {{info}}
112 -All dependencies must be declared with the scope //provided//.
280 + Up to and including version 7.x of {{formcycle/}} and the Maven plugin, you need to run the package phase explicitly and always specify the URL and the password. Starting with version 8.x, the package phase is executed automatically and the URL and password have default values.
113 113  {{/info}}
114 114  
115 -Developing a plugin for {{formcycle/}} can be as simple as implementing one of the plugin interfaces. To install a plugin, upload them on the administrative interface either as a [[client>>doc:Formcycle.UserInterface.Client.Plugins]] or [[system plugin>>doc:Formcycle.SystemSettings.UserInterface.SystemPlugins]].
283 +If you want to upload the plugin in a client scope, add the parameter //-DfcDeployClientId=3// with the ID of the client.
116 116  
117 -== Demo plugins ==
285 +== FC server plugin ==
118 118  
119 -As an introduction and to help you getting started with developing plugins, we provide several fully commented demo maven projects for each plugin type [[on our download pages>>url:https://customer.formcycle.eu/index.php/s/PgdMrNOvbYEzhmr]]. After downloading them, you can import them into the IDE of your choice, compile them and upload them to {{formcycle/}}.
287 +To test a plugin, you will need a running {{formcycle/}} server. The //fc-server-maven-plugin// can be used to start a fully configured {{formcycle/}} server with just a single command. It also comes with the deploy plugin preinstalled.
120 120  
121 -== Special terms ==
289 +If you added the //pluginGroup// to the //~~/.m2/settings.xml// as described above, you can start a {{formcycle/}} server with the following CLI command:
122 122  
123 -Some Java methods and classes contain German technical terms as used by {{formcycle/}}. For reference, see the following list for their English counterparts.
291 +{{code language="bash"}}
292 +# Start the current version
293 +mvn fc-server:run-ms-war
124 124  
125 -{{table dataTypeAlpha="0-1" preSort="0-asc"}}
295 +# Start a specific version
296 +mvn de.xima.fc.maven.plugin:fc-server-maven-plugin:7.0.4:run-ms-war -DxfcVersion=7.0.16
297 +{{/code}}
126 126  
127 -|=German|=English|=Example
128 -|Mandant|[[Client>>doc:Formcycle.SystemSettings.UserInterface.Clients]]|{{code language="Java"}}public Mandant getMandant(){{/code}} (get client)
129 -|Benutzer|[[User>>doc:Formcycle.UserInterface.UserSettings.WebHome]]|{{code language="Java"}}public Benutzer getCurrentBenutzer(){{/code}} (get user currently logged in)
130 -|Projekt|Project, a former term for a //form// containing files and multiple form versions|{{code language="Java"}}public Projekt getProjekt(){{/code}}
131 -|Aktion|[[Action>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.WebHome]] (workflow)|{{code language="Java"}}public Aktion getFolgeAktion(){{/code}} (get next action)
132 -|Weiterverarbeitung|Further processing|{{code language="Java"}}public EWeiterverarbeitung_Aktion getWeiterverarbeitungBeiFehler(){{/code}} (how to continue when an error has occurred)
133 -|Bedingung|[[Condition>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.ActionConditions]] (action)|{{code language="Java"}}public Bedingung getBedingung(){{/code}} (get the condition of an action)
134 -|Datei|[[File>>doc:Formcycle.UserInterface.FilesAndTemplates.Files]]|{{code language="Java"}}public FormEingangDatei getDatei(){{/code}} (get attached file)
135 -|Textbaustein|[[Template>>doc:Formcycle.UserInterface.FilesAndTemplates.WebHome]]|{{code language="Java"}}public ETextbausteinKategorie getKategorie(){{/code}} (get template type)
136 -|Vorgang|Form record|{{code language="Java"}}public Postfach getByVorgang(UserContext uc, Vorgang vorgang){{/code}} (get inbox for form record)
137 -|Postfach|[[Inbox>>doc:Formcycle.Inbox.WebHome]]|{{code language="Java"}}public Postfach getCurrentPostfach(){{/code}} (get current inbox)
138 -|Rolle|[[Role>>doc:Formcycle.UserInterface.UserSettings.Roles]]|{{code language="Java"}}public List<Rolle> getRollen(){{/code}} (get all roles for a user)
139 -|Datenquelle|[[Data source>>doc:.Types.IPluginDataSource]]|{{code language="Java"}}public IPluginDataSourceRetVal executeDatenquelle(...){{/code}} (get serializable JSON array from a data source)
140 -|Beschreibung|Description|{{code language="Java"}}public String getBeschreibung(){{/code}}
141 -|Kategory|Category|{{code language="Java"}}public ETextbausteinKategorie getKategorie(){{/code}}
299 +{{info}}
300 + We recommend you use Java 11. You may encounter issues when yout attempt to start {{formcycle/}} with Java 17.
301 +{{/info}}
142 142  
143 -{{/table}}
303 +{{info}}
304 + Up to and including version 7.x of {{formcycle/}} and the Maven plugin, you need to run the package phase explicitly: {{code}}mvn package fc-server:run-ms-war{{/code}}. Starting with version 8.x, this is not required anymore.
305 +{{/info}}
306 +
307 +{{info}}
308 + The major and minor version of the Maven plugin should always be equal to the major and minor version of the {{formcycle/}} application you are running. For example, to start {{formcycle/}} 7.0.x, you should the Maven plugin version 7.0.x. To start {{formcycle/}} 7.1.x, you should use the Maven plugin version 7.1.x etc.
309 +{{/info}}
310 +
311 +After a short amount of time (may take longer when you start it for the first time), you have a local {{formcycle/}} server running. The URL is printed in the command line, and should be http://localhost:8080/xima-formcycle by default. The super user login is {{code language="plaintext"}}sadmin{{/code}} (password: {{code language="plaintext"}}admin{{/code}}), the client admin access is {{code language="plaintext"}}admin{{/code}} (password {{code language="plaintext"}}/admin_{{/code}}).
312 +
313 +When you run the command in the root folder of a Maven project, the project is packaged, uploaded to server and installed. Also, the FC server Maven plugin tries to read the {{formcycle/}} version from the plugin.
314 +
315 +Falls der Befehl in einem Maven-Projekt eines {{formcycle/}}-Plugins ausgeführt wird, dann wird das Plugin automatisch gebaut und nach dem Starten des Servers hochgeladen und installiert.
316 +
317 +This command works even in a directory without a Maven project. When no {{formcycle/}} version is given, a default one is used.
318 +
319 +For advanced usage, see the [[README.md>>attach:README-FC-SERVER.md||rel="__blank"]].
320 +