Seon Server-side plugin philosophy - Revision history

Admin at 09:26, 6 April 2018

2018-04-06T09:26:42Z

Admin at 13:50, 8 August 2017

2017-08-08T13:50:45Z

Admin at 17:41, 15 June 2008

2008-06-15T17:41:50Z

Admin: /* plugin parameters */

2008-06-15T17:02:34Z

‎plugin parameters

Admin at 16:57, 15 June 2008

2008-06-15T16:57:31Z

Admin: New page: == german == Server-seitige Plugins werden (wie der Name schon aussagt) am Seon-Server ausgeführt. Plugins können ausführbare Dateien sein, daher können es Binaries oder Scripte (Shel...

2007-03-27T11:42:39Z

New page: == german == Server-seitige Plugins werden (wie der Name schon aussagt) am Seon-Server ausgeführt. Plugins können ausführbare Dateien sein, daher können es Binaries oder Scripte (Shel...

New page

== german ==

Server-seitige Plugins werden (wie der Name schon aussagt) am Seon-Server ausgeführt. Plugins können ausführbare Dateien sein, daher können es Binaries oder Scripte (Shell, Perl, PHP etc.) sein.

Es gibt zwei Arten von Plugins: synchrone und asynchrone.
* Synchrone Plugins werden gestartet und der startende Prozess wartet solange, bis das Plugin beendet wurde.
* Asynchrone Plugins werden gestartet (für das Prozessmanagement sind sie selbst verantwortlich) und der Plugin-Handler beendet sich. Es muss nach Abarbeitung des Plugins ein asynchroner Plugin-Handler aufgerufen werden, der dann die Jobabarbeitung wieder aufnimmt.

Plugins erhalten als Parameter (ohne vorangehendes "<code>-</code>" zur Deklarierung, dass es sich hierbei um einen anderen Parameter handeln könnte) eine XML-Datei oder die Auftragsnummer, je nach Plugin. Manche Plugins erlauben auch beide Arten von Parametern und/oder weitere Parameter. Mindestens jedoch muss ein Plugin eine XML-Datei als Parameter interpretieren können.

Die Standard-(Fehler-)Ausgabe "<code>stdout</code>" und "<code>stderr</code>" werden vom Plugin-Handler aufgenommen und dem Auftrag in die Plugin-Logs hinzugefügt.

Der Returncode des Plugins wird erfasst und bei einem Wert ungleich 0 wird der Auftrag abgebrochen.
Im Abbruchfall werden Dateien mit dem Nodeattribut "<code>copy</code>" oder "<code>ENGDAT</code>" automatisch gelöscht, damit keine temporären Dateien als Leichen im Filesystem liegen bleiben.

== english ==

@@ Line 31: / Line 31: @@
 ==== asynchronous plugin abort ====
 Asynchronous plugins must understand the parameter "<code>-c</code>" as first parameter in order to cancel the job, given as second parameter.
 [[Category:Seon Enterprise]]

← Older revision		Revision as of 13:50, 8 August 2017
Line 31:		Line 31:
	==== asynchronous plugin abort ====		==== asynchronous plugin abort ====
	Asynchronous plugins must understand the parameter "<code>-c</code>" as first parameter in order to cancel the job, given as second parameter.		Asynchronous plugins must understand the parameter "<code>-c</code>" as first parameter in order to cancel the job, given as second parameter.
		+
		+	[[Category:Seon Enterprise]]

← Older revision		Revision as of 17:41, 15 June 2008
Line 1:		Line 1:
−	Server-side Seon plugins are programs which are executed during job processing. Plugins can be any type of executable: compiled programs, Java programs, shell/Perl/PHP/... scripts.	+	Server-side Seon plugins are programs which are executed during job processing. Plugins can be any type of executable: compiled programs, Java programs, shell/Perl/PHP/... scripts. Plugins can be put together into so-called plugin groups.

	There are two types of plugins:		There are two types of plugins:

← Older revision		Revision as of 17:02, 15 June 2008
Line 28:		Line 28:
	==== configuration ====		==== configuration ====
	In order to display configuration possibilities, plugins may support the parameter "<code>-x</code>". The output of the plugin must be a plugin with a special structure. Refer to the [[Seon Enterprise plugin configuration\|plugin configuration]] documentation for more information.		In order to display configuration possibilities, plugins may support the parameter "<code>-x</code>". The output of the plugin must be a plugin with a special structure. Refer to the [[Seon Enterprise plugin configuration\|plugin configuration]] documentation for more information.
		+
		+	==== asynchronous plugin abort ====
		+	Asynchronous plugins must understand the parameter "<code>-c</code>" as first parameter in order to cancel the job, given as second parameter.

@@ Line 1: / Line 1: @@
-== german ==
+Server-side Seon plugins are programs which are executed during job processing. Plugins can be any type of executable: compiled programs, Java programs, shell/Perl/PHP/... scripts.
-Server-seitige Plugins werden (wie der Name schon aussagt) am Seon-Server ausgeführt. Plugins können ausführbare Dateien sein, daher können es Binaries oder Scripte (Shell, Perl, PHP etc.) sein.
+There are two types of plugins:
-Es gibt zwei Arten von Plugins: synchrone und asynchrone.
+Plugins receive an XML as parameter which contain all job parameters. The plugin may modify this XML file. The plugin handler starts the plugin with the last actual XML file, afterwards it reads in this XML file and saves is in the database as the actual XML.
-Plugins erhalten als Parameter (ohne vorangehendes "<code>-</code>" zur Deklarierung, dass es sich hierbei um einen anderen Parameter handeln könnte) eine XML-Datei oder die Auftragsnummer, je nach Plugin. Manche Plugins erlauben auch beide Arten von Parametern und/oder weitere Parameter. Mindestens jedoch muss ein Plugin eine XML-Datei als Parameter interpretieren können.
+The standard output "stdout" and "stderr" will be read in and saved in the plugins logs, attached to the actual job.
-Die Standard-(Fehler-)Ausgabe "<code>stdout</code>" und "<code>stderr</code>" werden vom Plugin-Handler aufgenommen und dem Auftrag in die Plugin-Logs hinzugefügt.
+The return code of the executed plugin is received by the plugin handler (synchronous or asynchronous). If the return code is zero (0), job processing continues. If it's non-zero, job processing stops and the job receives the status "aborted".
-Der Returncode des Plugins wird erfasst und bei einem Wert ungleich 0 wird der Auftrag abgebrochen.
+At the end of plugin execution (even successful or unsuccessful), all files contained in the job XML with the attribute "<code>copy</code>" or "<code>ENGDAT</code>" will be deleted from the filesystem.
-== english ==
+=== plugin parameters ===