Changes for page FORMCYCLE-Deploy-Plugin-Plugin

From version < 1.14 >

edited by awa
on 12.03.2020, 14:25

To version < 1.11

edited by awa
on 08.12.2020, 17:19

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Default language

...	...	@@ -1,0 +1,1 @@
	1	+de

Content

@@ -1,3
          +1,5 @@
++[[**Plugin download**>>url:https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/fc-plugin-deploy-plugin&fileid=12657||target="_blank"]] (requires login)
++
  This is a plugin for deploying plugin to {{formcycle/}}, hence the name //FORMCYCLE deploy-plugin plugin//.
  {{content/}}
@@ -12,113
          +12,112 @@
  The uploaded plugin may already exist in the system. In this this, you usually want to update plugin - not have it installed twice. This requires a way to identify whether a plugin exists already. The servlet action allows for four different possibilities:
  * (**recommended**) The plugin is identified based on an entry in its manifest. The manifest needs to be located at //META-INF/MANIFEST.MF// in the plugin JAR file, such as the group ID or artifact ID. Make sure you prepare the JAR file properly when building the plugin. This method is slightly harder to setup, but offers the advantage that the identifier always remains the same and does not depend on the file name or some internal ID.
--* The plugin is identified based on its name, i.e. the file name of the upload JAR file. This is also the named [[as it is shown in the plugin menu>>doc:Formcycle.UserInterface.Client.Plugins]].
--* Das Plugin wird anhand seiner internen Datenbank-ID identifiziert. Diese ist aktuell nicht an der Oberfläche zu sehen. Diese Option sollte nur von Entwicklern genutzt werden.
--* Das Plugin wird anhand seiner internen UUID identifiziert. Diese ist aktuell nicht an der Oberfläche zu sehen. Diese Option sollte nur von Entwicklern genutzt werden.
++* The plugin is identified based on its name, i.e. the file name of the upload JAR file. This is also the name [[as it is shown in the plugin menu>>doc:Formcycle.UserInterface.Client.Plugins]].
++* The plugin is identified based on its internal database ID. This ID is not shown in the UI currently and should only be used by developers.
++* The plugin is identified based on its UUID. This ID is not shown in the UI currently and should only be used by developers.
--Standardmäßig ist eine Servlet-Aktion für alle frei zugänglich. Da es in der Regel unerwünscht ist, dass jeder (auch unangemeldete) Nutzer Plugins installieren kann, kann das Deploy-Plugin durch ein Passwort abgesichert werden. Dazu muss in der Plugin-Konfiguration der Passwort-Hash hinterlegt werden und das Passwort dann im HTTP-POST-Request mitgesendet werden.
++By default, a servlet action is accessible to everybody. Usually, you do not want anonymous users to modifying the installed plugins. To secure the servlet, you can specify a password in the plugin configuration. You then need to include this password in the HTTP POST request.
--== Plugin-Konfiguration ==
++== Plugin configuration ==
--Am Plugin selber kann konfiguriert werden, ob das Deploy-Servlet durch ein Passwort geschützt werden soll. Dieses Passwort muss dann im Klartext beim HTTP-POST-Request mit angegeben werden.
++You can optionally set a password for securing the access to the plugin deploy servlet. If you do, you need to include the password in the HTTP POST request to authorize that request.
--Zur Konfiguration des Passworts gibt es die eine Plugin-Eigenschaft //token//, diese hat das folgende Format
++Specify the token by entering a value for the plugin property //token//. It must be entered in the following format:
  {{code language="none"}}
  hash_method:hashed_value
  {{/code}}
--Folgende Hash-Methoden stehen zur Verfügung:
++The following hash methods are available.
  ; plain
--: Identitätsfunktion, das Passwort im Klartext angegeben.
++: Identity function. Lets you enter a plain text password.
  ; sha256
--: SHA-256-Algorithmus.
++: SHA-256 algorithm.
  ; sha384
--: SHA-384-Algorithmus.
++: SHA-384 algorithm.
  ; sha512
--: SHA-512-Algorithmus.
++: SHA-512 algorithm.
--Um das Passwort im Klartext beispielsweise auf //admin// festzulegen, wird der folgende Wert für die Plugin-Eigenschaft //token// eingegeben:
++To enter the password //admin// as plain text, use:
  {{code language="none"}}
  plain:admin
  {{/code}}
--Um das Passwort mit SHA-256 beispielsweise auf //admin// festzulegen, wird der folgende Wert für die Plugin-Eigenschaft //token// eingegeben:
++To enter the password //admin// hashed with SHA-256, use:
  {{code language="none"}}
  sha256:S+32GI3fWXwHHulUMtWmjpQ15EqMvgVYguuO9SKxfNw+ckAGQljP6tKlf1EITnU7
  {{/code}}
--Der Hash ist gesalzen. Ein gültiger Hash für ein bestimmtes Passwort kann mit dem //create-token//-Servlet erzeugt werden, siehe unten.
++The hash is salted. You can generate a valid hash for a given password via the //create-token// servlet, see below.
++== Deploy servlet ==
--== Deploy-Servlet ==
++The following describes the structure of the HTTP request you need to adhere to in order to install, update, or delete a plugin.
--Im Folgenden wird der Aufbau des HTTP-Requests beschrieben, um ein Plugin zu installieren, zu aktualisieren oder zu löschen.
++The HTTP method must be POST, other methods will result in an error. The [[endpoint URL is as follows>>doc:Formcycle.PluginDevelopment.Types.IPluginServletAction]] (change the name of the FORMCYCLE server and the client ID):
--Es muss immer ein HTTP-Post-Request verwendet werden und [[sich an folgende URL richten>>doc:Formcycle.PluginDevelopment.Types.IPluginServletAction]] (Namen des FORMCYCLE-Servers entsprechend anpassen):
--
  {{code language="none"}}
  POST http://localhost:8080/formcycle/plugin?name=deploy-plugin&client-id=154 HTTP/1.1
  {{/code}}
--Die //client-id// muss nicht angegeben werden, wenn das Plugin als System-Plugin installiert ist.
++The //client-id// is not required in case the plugin is installed as a system plugin.
--=== Request-Parameter ===
++=== Request parameter ===
--Die Parameter können direkt als URL-Parameter, als //multipart/form-data// oder als //application/x-www-form-urlencoded// übergeben werden. Folgende Parameter werden vom Deploy-Plugin unterstützt und können übergeben werden:
++You can specify the parameters either directly as URL parameters, or as //multipart/form-data// or //application/x-www-form-urlencoded//. The following parameters are available and supported by the plugin deploy servlet:
  ; deploy-action
--: Aktion, welche mit dem Plugin durchgeführt werden soll. Erlaubte Werte sind //save//, //update-properties//, //activate//, //deactivate// und //delete//. Ein Erklärung zu diesen Aktionen findet sich unten.
++: Action to be performed on the plugin. Allowed values are //save//, //update-properties//, //activate//, //deactivate// and //delete//. See below for a description of each method.
  ; client-id
--: ID des Mandanten, in dem ein Plugin installiert, aktualisiert oder gelöscht werden soll. Es darf nur entweder //client-id// oder //client-uuid// angegeben werden
++: ID of the client where the plugin is installed, updated, or deleted. You must specify only one of //client-id// or //client-uuid//.
  ; client-uuid
--: UUID des Mandanten, in dem ein Plugin installiert, aktualisiert oder gelöscht werden soll. Es darf nur entweder //client-id// oder //client-uuid// angegeben werden. Es ist zu beachten, dass der Aufruf eines als Mandant-Plugin installierten Servlet-Aktion immer der Parameter //client-id// erforderlich ist.
++: UUID of the client where the plugin is installed, updated, or deleted. You must specify only one of //client-id// or //client-uuid//. Please note that a plugin installed as a client plugin always required the parameter //client-id//.
  ; jar-file
--: Binärdaten mit der JAR-Datei des Plugins, welches aktualisert oder installiert werden soll.
++: Binary data of the JAR file with the plugin (required only when installing or updating the plugin).
  ; token
--: Das Token (Password) für die Authorisierung des Requests. Nur erforderlich, wenn in der Plugin-Konfiguration ein Token festgelegt wurde.
++: The token (password) for authorizing the request. Required only when the a token was set in the plugin configuration.
  ; plugin-ident
--: Die Art, wie nach einem vorhandenen Plugin gesucht wird (siehe oben). Folgende Werte sind erlaubt:
++: The method used for searching an already existing plugin, see above. The following methods are supported:
  :; manifest
--:: Identifiziert ein Plugin anhand eines Eintrags im Manifest.
++:: Identifies a plugin based on an entry in its manifest.
  :; id
--:: Identifiziert ein Plugin anhand seiner Datenbank-ID.
++:: Identifies a plugin based on its database ID.
  :; name
--:: Identifiziert ein Plugin anhand seines Namens (Dateiname der JAR-Datei)
++:: Identifies a plugin based on its name (the file name of the plugin JAR file).
  :; uuid
--:: Identifiziert ein Plugin anhand seiner UUID.
++:: Identifies a plugin based on its UUID.
  ; plugin-identifier
--: Identifikator des Plugins, welches aktualisiert oder gelöscht werden soll. Die konkrete Bedeutung dieses Parameters ist abhängig von dem Wert von //plugin-ident//:
++: Identifier of the plugin that should be installed, updated, or deleted. The exact meaning of this parameter depends on the chosed //plugin-ident// method:
  :; plugin-ident=manifest
--:: //plugin-identifier// muss den Namen der Manifest-Eigenschaft und dessen Wert enthalten, im Format //ATTRIBUTE_NAME=VALUE//. Wird zum Beispiel //Implementation-Title=com.example.fc.plugin:my-plugin// übergeben wird, wird nach einem existierenden Plugin gesucht, welches im Manifest in der Eigenschaft //Implementation-Title// den Wert //com.example.fc.plugin:my-plugin// stehen hat.
++:: //plugin-identifier// must contain the name of the manifest property and its value, in the format //Attribute-Name=value//. For example, if this property is set to //Implementation-Title=com.example.fc.plugin:my-plugin//, this will search for a plugin with a manifest entry //Implementation-Title// set to //com.example.fc.plugin:my-plugin//.
  :; plugin-ident=id
--:: //plugin-identifier// muss die gewünschte ID des Plugins enthalten, etwa //53// oder /893//.//
++:: //plugin-identifier// must contain the data base ID of the target plugin, such as //53// or /893//.//
  :; plugin-ident=name
--:: //plugin-identifier// muss den gewünschten Names des Plugins enthalten, etwa //my-plugin.jar// oder /foobar.jar//.//
++:: //plugin-identifier// must contain the name of the target plugin, such as //my-plugin.jar// or //foobar.jar//.
  :; plugin-ident=uuid
--:: //plugin-identifier// muss die gewünschte UUID des Plugins enthalten, etwa //03022599-903d-429b-9822-80a324a542fc//.
--Andernfalls wird das Plugin installiert, falls noch nicht vorhanden, oder aktualisiert, falls vorhanden.
++:: //plugin-identifier// must contain the UUID of the target plugin, such as //03022599-903d-429b-9822-80a324a542fc//.
  ; clear-properties
--: Entweder //true// oder //false//. Wenn //true//, werden alle Plugin-Eigenschaften entfernt beziehungsweise deren Werte geleert. Dies wird ausgeführt, bevor die neu zu setzenden Plugin-Eigenschaften (Parameter ///property//) angewendet werden.
++: Either //true// or //false//. If set to //true//, all plugin property values are cleared. This is done before the new properties (see parameter //property//) are applied.
  ; property
--: Name und Wert einer Plugin-Eigenschaft, die an der Plugin-Konfiguration gesetzt werden soll, im Format //key=value//. Dieser HTTP-Parameter kann mehrfach angegeben werden, um mehrere Plugin-Eigenschafte zu setzen. Wird etwa //database.username=max// übergeben, wird die Plugin-Eigenschaft //database.username// auf //max// gesetzt.
++: Name and value of a plugin property to set, in the format //key=value//. This HTTP parameter may be specified multiple times if you want set multiple properties. For example, if set to //database.username=john//, this sets the plugin property //database.username// to //john//.
  ; disallow-install
--: Entweder //true// oder //false//. Ist diese Option auf //true// gesetzt und existiert das Plugin noch nicht (bezüglich der angegebenen //plugin-ident// und //plugin-identifier//), wird das Plugin nicht neu installiert und eine Fehlermeldung zurückgegeben. ; locale
--: Die Sprache, welche während der Installation, Aktualisierung oder Löschung des Plugins verwendet werden soll, etwa //en// oder //de//. Beeinflusst nur einige Fehlermeldungen und kann in der Regel weggelassen werden.
++: Either //true// or //false//. When this is set to //true// and the plugin does not exists yet (as determined by the given //plugin-ident// and //plugin-identifier// parameters), the plugin is not installed and an error is returned. Otherwise, when set to //false//, the plugin is installed if it does not exists yet and updated if it does.
++; locale
++: The language to be used when the plugin is modified, such as //en// or //de//. May affect some error messages. Usually this parameter is not neccessary.
--=== Deploy-Action ===
++=== Deploy actions ===
--Der Wert des Parameters //deploy-action// gibt an, was genau mit dem Plugin geschehen soll. Es gibt dabei die folgenden Möglichkeiten:
++The value of the parameter //deploy-action// specifies what should happen with the selected plugin. The following actions are available:
  ; save
--: Überträgt das angegebene Plugin auf das FORMCYCLE-System. Es muss hierbei eine JAR-Datei übertragen werden. Falls das Plugin noch nicht existiert (und der Parameter //disallow-install// nicht gesetzt ist), wird das Plugin neu installiert und ist dann aktiviert. Andernfalls, falls das Plugin bereits existiert, wird es aktualisiert, dabei bleibt das Plugin aktiviert oder deaktiviert.
++: Transmits the plugin to the {{formcycle/}} server. You need to specify a JAR file. If the plugin does not exists yet (and the parameters //disallow-install// is not set), the plugin is installed and activated. Otherwise, if the plugin exists already, it is only updated and left active or inactive. For example:
  (((
  {{code language="bash"}}
--# Installiert oder aktualisiert das Plugin mit dem Implementation-Title com.example:plugin
++# Installs or updates the given plugin.
   curl -X POST \
     -F deploy-action=save \
     -F token=admin \
@@ -130,7
          +130,7 @@
  )))
  ; delete
--: Löscht das angegebene Plugin. Es darf hierbei keine JAR-Datei übertragen werden. Existiert das angegebene Plugin nicht, wird ein Fehler zurückgegeben. Beispiel:
++: Deletes the given plugin. You must not specify a JAR file. If the specified plugin does not exist yet, an error is returned. For example:
  (((
  {{code language="bash"}}
@@ -145,11
          +145,11 @@
  )))
  ; activate
--: Aktiviert das angegebene Plugin. Es darf hierbei keine JAR-Datei übertragen werden. Existiert das angegebene Plugin nicht, wird ein Fehler zurückgegeben. Ist das Plugin bereits aktiviert, wird nicht getan und ein Erfolg zurückgegeben. Beispiel:
++: Activates the given plugin. You must not specify a JAR file. If the specified plugin is already active, no action is performed an a success is returned. For example:
  (((
  {{code language="bash"}}
--# Aktiviert das Plugin mit dem Implementation-Title com.example:plugin
++# Activates the given plugin
   curl -X POST \
     -F deploy-action=activate \
     -F token=admin \
@@ -160,11
          +160,11 @@
  )))
  ; deactivate
--: Deaktiviert das angegebene Plugin. Es darf hierbei keine JAR-Datei übertragen werden. Existiert das angegebene Plugin nicht, wird ein Fehler zurückgegeben. Ist das Plugin bereits deaktiviert, wird nicht getan und ein Erfolg zurückgegeben. Beispiel:
++: Deactivates the given plugin. You must not specify a JAR file. If the specified plugin is already inactive, no action is performed an a success is returned. For example:
  (((
  {{code language="bash"}}
--# Deaktiviert oder aktualisiert das Plugin mit dem Implementation-Title com.example:plugin
++# Deactivates the given plugin
   curl -X POST \
     -F deploy-action=deactivate \
     -F token=admin \
@@ -175,11
          +175,11 @@
  )))
  ; update-properties
--: Aktualisiert die Eigenschaften des angegebenen Plugins. Es darf hierbei keine JAR-Datei übertragen werden. Entweder die Eigenschaft //clear-properties// oder //property// sollte gesetzt sein. Existiert das angegebene Plugin nicht, wird ein Fehler zurückgegeben. Beispiel:
++: Updates the properties of the given plugin. You must not specify a JAR file. You should specify at least one of //clear-properties// or //property//. If the given plugin does not exist yet, an error is returned. For example:
  (((
  {{code language="bash"}}
--# Löscht alle vorhandenen Plugin-Eigenschaften und setzt dann die Eigenschaft "foo" auf den Wert "bar"
++# Delete all existing plugin properties and set the property //foo// to //bar//
   curl -X POST \
     -F deploy-action=update-properties \
     -F token=admin \
@@ -193,9
          +193,9 @@
  === Response ===
--Das Deploy-Plugin liefert einen Statuscode und ein JSON-Objekt mit den Details zurück. Der Status-Code ist 2xx, falls das Deploy-Plugin erfolgreich ausgeführt wurde.
++The plugin deploy servet returns a status code and a JSON object with the details. The status code is 2xx if (and only if) the deploy servlet was executed successfully.
--Das JSON-Objekt hat dabei [[die folgende Struktur>>https://json-schema.org/]]:
++The JSON object that is returned adheres to the following [[JSON schema>>https://json-schema.org/]]:
  {{code language="json"}}
  {
@@ -296,7
          +296,7 @@
  }
  {{/code}}
--Beispiel für die Antwort beim Aktualisieren eines Plugins:
++Example for a response when a plugin was updated successfully:
  {{code language="json"}}
  {
@@ -321,7
          +321,7 @@
  }
  {{/code}}
--Beispiel für die Antwort beim Löschen, falls das angegebene Plugin nicht gefunden wurde:
++Example for a response when a plugin could not be deleted:
  {{code language="json"}}
  {
@@ -344,20
          +344,20 @@
  {{/code}}
--== Create-Token-Servlet ==
++== Create token servlet ==
--Mit diesem Servlet kann ein Hash für ein bestimmtes Klartextpasswort erzeugt werden, welcher dann in der Plugin-Eigenschaft //token// hinterlegt werden kann. Es muss hierbei ein HTTP-GET-Request verwendet werden (Pfad auf den FORMCYCLE-Servet und die Mandant-ID entsprechend ersetzen):
++This servlet lets you create a hash for a password that you can enter in the plugin property //token//. Make an HTTP GET request to the following URL (change to path to the {{formcycle/}} server and the client ID):
  {{code language="none"}}
--http://localhost:8080/formcycle/plugin?client-id=1&name=create-token&token=<PASSWORT>&method=<METHOD>
++http://localhost:8080/formcycle/plugin?client-id=1&name=create-token&token=<PASSWORD>&method=<METHOD>
  {{/code}}
  ; token
--: Der Klartext des Passwort, zu dem ein Hash ermittelt werden soll.
++: The password to hash.
  ; method
--: Methode zum Berechnen des Hashes. Erlaubte Werte sind //plain//, //sha256//, //sha384// und //sha512//. Optional, Standardwert ist //sha256//.
++: Hash method, default to //sha256//. Supported values are //plain//, //sha256//, //sha384// and //sha512//.
--Als Antwort wird ein JSON zurückgeliefert, welches das gleiche Format wie die Antwort des Deploy-Plugins hat. Beispiel für eine Antwort:
++This returns a JSON object with the same schema as returned by the plugin deploy servlet. For example:
  {{code language="json"}}
  {
@@ -376,11
          +376,11 @@
  }
  {{/code}}
--== Maven-Deploy-Plugin ==
++== Maven deploy plugin ==
--Um ein Plugin nach dem Bauen über Maven in FORMCYCLE hochzuladen, gibt es auch ein Maven-Plugin, welches das Deploy-Servlet anspricht. Dieses ist über die Artifactory von XIMA erhältlich, falls man die entsprechenden Rechte hierfür hat:
++To upload a plugin to {{formcycle/}} after building a plugin project via Maven, you can use the maven deploy plugin. It is available from the XIMA artifactory (please note you may need the correct permissions to access this artifact).
--=== Konfiguration ===
++=== Confguration ===
  {{code language="xml"}}
  <plugin>
@@ -407,41
          +407,40 @@
  </plugin>
  {{/code}}
--Das Plugin hat die folgenden Optionen zur Konfiguration:
++The plugin offers the following configurable settings:
--; url [Standardwert: //${fcDeployUrl}//]
--: URL mit Kontextpfad zum FORMCYCLE-Server, etwa //{{{http://localhost:8080/formcycle}}}//
--; pluginName [Standardwert: //deploy-plugin//]
--: Der Name des Deploy-Plugins für den URL-Parameter //name//. In der Regel muss diese Option nicht gesetzt werden, der Standardwert ist ausreichend.
--; clientId [Standardwert: //${fcDeployClientId}//]
--: ID des Mandanten, für den das Plugin installiert, aktualisiert oder gelöscht werden soll. Entspricht dem Parameter //client-id// des Deploy-Plugins, siehe oben.
++; url [Default value: //${fcDeployUrl}//]
++: URL to the {{formcycle/}} server, including the context path, such as //{{{http://localhost:8080/formcycle}}}//
++; pluginName [Default value: //deploy-plugin//]
++: Name of the deploy plugin, the value for the parameter //name//. Usually you do not need to change this.
++; clientId [Default value: //${fcDeployClientId}//]
++: ID of the client with the plugin to be installed, updated, or deleted. Corresponds to the parameter //client-id// of the plugin deploy servlet, see above.
  ; clientUuid
--: Alternative zu //clientID//. UUID des Mandanten, für den das Plugin installiert, aktualisiert oder gelöscht werden soll. Entspricht dem Parameter //client-uuid// des Deploy-Plugins, siehe oben.
++: Alternative for //clientUUID//. The UUID of the client with the plugin to be installed, updated, or deleted.Corresponds to the parameter //client-uuid// of the plugin deploy servlet, see above.
  ; token [Standardwert: //${fcDeployToken}//]
--: Passwort für das Servlet-Plugin, falls in der Konfiguration des Deploy-Plugins ein Passwort gesetzt wurde.
--; deployAction [Standardwert: //save//]
--: Aktion, welche mit dem Plugin durchgeführt werden soll. Erlaubte Werte sind //save//, //update-properties//, //activate//, //deactivate// und //delete//. Entspricht dem Parameter //deploy-action// des Deploy-Plugins, siehe oben.
--; pluginIdent [Standardwert: //manifest//]
--: Die Art, wie nach einem vorhandenen Plugin gesucht wird. Entspricht dem Parameter //plugin-ident// des Deploy-Plugins, siehe oben.
--; pluginIdentifier [Standardwert: //Implementation-Title=${project.groupId}:${project.artifactId}//]
--: Identifikator des Plugins, welches aktualisiert oder gelöscht werden soll. Entspricht dem Parameter //plugin-identifier// des Deploy-Plugins, siehe oben.
--; jarFile [Standartwert: Haupt-Build-Artifakt des Maven-Projekts]
--: Pfad zur JAR-Datei, die hochgeladen werden soll, relativ zum Basisverzeichnis des Maven-Projekts.
--; disallowInstall [Standardwert: //false//]
--: Wenn //true// und das Plugin noch nicht existiert, wird abgebrochen und ein Fehler zurückgegeben. Entspricht dem Parameter //disallow-install// des Deploy-Plugins, siehe oben.
++: Password for the plugin deploy servlet, if one was set in the plugin configuration.
++; deployAction [Default value: //save//]
++: Method to be executed. Allowed values are //save//, //update-properties//, //activate//, //deactivate// and //delete//. Corresponds to the parameter //deploy-action// of the plugin deploy servlet, see above.
++; pluginIdent [Default value: //manifest//]
++: The method for identifying existing plugins. Corresponds to the parameter //plugin-ident// of the plugin deploy servlet, see above.
++; pluginIdentifier [Default value: //Implementation-Title=${project.groupId}:${project.artifactId}//]
++: Identifier of the plugin to be installed, updated, or deleted. Corresponds to the parameter //plugin-identifier// of the plugin deploy servlet, see above.
++; jarFile [Default value: Haupt-Build-Artifakt des Maven-Projekts]
++: Path to the JAR file to be uploaded, relative to the base directory of the maven project.
++; disallowInstall [Default value: //false//]
++: When set to //true// and the plugin does not exists yet, the plugin is not installed and an error is returned. Corresponds to the parameter //disallow-install// of the plugin deploy servlet, see above.
  ; locale [Standardwert: //en//]
--: Sprache, die für die Installation, Aktualisierung oder Löschung des Plugins genutzt wird. Entspricht dem Parameter //locale// des Deploy-Plugins, siehe oben.
--; clearProperties [Standardwert: //false//]
--: Löscht die Werte aller Plugin-Eigenschaften. Entspricht dem Parameter //clear-properties// des Deploy-Plugins, siehe oben.
++: Language for the installations. Corresponds to the parameter //locale// of the plugin deploy servlet, see above.
++; clearProperties [Default value: //false//]
++: Clears all properties of the plugin. Corresponds to the parameter //clear-properties// of the plugin deploy servlet, see above.
  ; properties
--: Key-Value-Paare mit Eigenschaften, die an dem Plugin gesetzt werden sollen. Entspricht dem Parameter //clear-properties// des Deploy-Plugins, siehe oben.
++: Key value pair with the properties to be set on the plugin. Corresponds to the parameter //property// of the plugin deploy servlet, see above.
--=== Empfehlung für Plugin-Projekt ===
++=== Recommendations for your plugin project ===
--Während das Plugin zahlreiche Einstellunsgmöglichkeiten anbietet, reichen meist die Standardwerte aus. Empfohlen wird das folgende Vorgehen bei der Entwicklung von Plugin-Projekten.
++While the Maven plugin offers a wide variety of options, the default settings are usually sufficient. We recommend the following steps for your plugin:
--Folgendes Schnippsel sollte in der Profil-Sektion der //pom.xml// eingefügt werden:
--
++Add this code snippet to the profile section of the //pom.xml//:
  {{code language="xml"}}
   <properties>
    <fc-deploy-plugin-maven-plugin.version>1.1.0</fc-deploy-plugin-maven-plugin.version>
@@ -464,7
          +464,7 @@
        <executions>
         <execution>
          <goals>
--         <goal>install</goal>
++         <goal>deploy</goal>
          </goals>
         </execution>
        </executions>
@@ -475,7
          +475,7 @@
   </profiles>
  {{/code}}
--Das Plugin wird dann anhand des Eintrags //Implementation-Title// im Manifest identifiziert. Hierzu muss der Wert korrekt im Manifest gesetzt werden. Dies kann entweder über das maven-jar-plugin oder über das maven-assembly-plugin geschehen, je nachdem, welches von diesen im Plugin-Projekt genutzt wird:
++The plugin is identified based on the entry //Implementation-Title// in its //Manifest.MF// file. For this to work, you need to prepare the manifest correctly. You can do so either with the //maven-jar-plugin// or with the //maven-assembly-plugin//, depending on which plugin your project uses.
  {{code language="xml"}}
   <properties>
@@ -510,7
          +510,7 @@
      </configuration>
     </plugin>
--            <!-- If using the maven-assembly-plugin -->
++   <!-- If using the maven-assembly-plugin -->
     <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-assembly-plugin</artifactId>
@@ -547,10
          +547,28 @@
   </build>
  {{/code}}
--Nun kann das Plugin über Maven gebaut und hochgeladen werden. Die URL auf FORMCYCLE, die Mandant-ID und das Token (Passwort) wird dynamisch über Parameter an Maven übergeben:
++Now you can build the plugin via Maven and upload it to a {{formcycle}} server. The URL, the client ID and the token (password) can be passed to Maven via command line parameters:
  {{code language="bash"}}
  mvn clean install -DfcDeployUrl="http://localhost:8080/xima-formcycle" -DfcDeployClientId="1" -DfcDeployToken="admin"
  {{/code}}
--Hinweis: IDE wie Eclipse und IntelliJ erlauben es, eine Build-Konfiguration für das Plugin-Projekt zu erstellen, wo die Parameter //fcDeployUrl//, //fcDeployClientId// und //fcDeployToken// hinterlegt werden können.
++If you do not pass these parameters, the deploy plugin is not executed and the plugin is not uploaded.
++
++On a side note: IDE such as Eclipse and IntelliJ let you create a build configuration for your plugin project, where you can enter the parameters //fcDeployUrl//, //fcDeployClientId// and //fcDeployToken//. This way you can upload the plugin simply by running the build configuration.
++
++== Changelog
++
++This is a list of available version of this plugin and which changes took place in which version.
++
++=== 1.1.0
++
++* Modifications to make the plugin work with {{formcycle/}} 6.4.
++
++=== 1.0.1
++
++* Improved error handling when an uploaded plugin is installed
++
++=== 1.0.0
++
++* Initial release

Changes for page FORMCYCLE-Deploy-Plugin-Plugin

Summary

Details

Navigation