OS4X plugin os4xplugin approve - Revision history

Admin: /* Plugin configuration */

2020-05-08T14:17:37Z

Plugin configuration

Admin: /* Plugin configuration */

2020-05-08T14:16:04Z

Plugin configuration

Admin: /* Behaviour */

2020-05-08T14:15:38Z

Behaviour

Admin: /* Behaviour */

2020-05-08T14:15:03Z

Behaviour

Admin: /* Mail template variables */

2020-05-08T11:55:22Z

Mail template variables

Admin: /* Mail template variables */

2020-05-08T11:38:48Z

Mail template variables

Admin at 11:30, 8 May 2020

2020-05-08T11:30:08Z

Admin: /* Mail template variables */

2020-05-08T11:28:26Z

Mail template variables

Admin: /* Approver configuration */

2020-05-08T11:25:51Z

Approver configuration

Admin: /* Plugin configuration */

2020-05-08T11:24:26Z

Plugin configuration

@@ Line 34: / Line 34: @@
 The meaning of the configuration values is as follows:
-*Alternative mail FROM address:	The sender of the approving email. By default, it is "OS4X <os4x>". It may be required to configure a defined value for some MTA wo work.
+*Alternative mail FROM address:	The sender of the approving email. By default, it is "OS4X <os4x>". It may be required to configure a defined value for some MTA to work.
 *Mail subject: The subject of the approver email. This configuration option supports XPath expressions on the OS4X Enterprise job's XML.
 **default value: <code>OS4X-Auftrag $/OS4X_job/job_information/job_number an $/OS4X_job/job_information/recipient/partner_longname benötigt Freigabe</code>
 *Send subject UTF-8 encoded?: If required, it is possible to send email subject as UTF-8 (with a special email encoding).
 *Debug mail execution?: If mailing fails, you can enable debug output for analysis reasons.
-*MTA (sendmail) command: A specific sendmail MTA command can be configured.
+*MTA (sendmail) command: An overridden sendmail MTA command can be configured.
 **default: (empty) <code>sendmail</code>
 *URL to approve API: A resolvable URL for the approver. This URL is the OS4Xapi part of the approving, so it must be available over network of the approver.
 **Example values: http://my-os4x-server/webaccess/os4xapi/index.php/job/approve
-*Send email as HTML?: For nice layout, HTML emails are possible (on by default).
+*Send email as HTML?: For nice layout, HTML emails are possible (activated by default).
 Templates:

@@ Line 29: / Line 29: @@
 == Plugin configuration ==
-All plugin configuration is done in the administrative web interface OS4Xadmin in "Configuration" -> "Enterprise" -> "Plugins" -> "Approve plugin":
+All plugin configuration is done in the administrative web interface OS4Xadmin in "Configuration" -> "OS4X Enterprise" -> "Plugins" -> "Approve plugin":
 [[File:Bildschirmfoto 2020-05-08 um 12.46.53.png]]

@@ Line 20: / Line 20: @@
 If an approver is found, the plugin switches to asynchronous mode (see [[OS4X Server-side plugin philosophy]] for more details on synchronity of plugins).
 The approver receives an email, rendered with the email template (see below). It typically includes an accept and a deny hyperlink. After clicking on the appropriate link, the job does:
-*Accept: A log entry will be added to the job's plugin logs with detailled approver information. The job continues its configured plugin group.
+*Accept: A log entry will be added to the job's plugin logs with detailled approver information. The job continues its configured plugin group with the next step.
 *Deny: A log entry will be added to the job's plugin logs with detailled approver information. The job will be cancelled.

@@ Line 16: / Line 16: @@
 *partner
-If no approver is configured, the plugin continues synchronously and the plugin group continues its work.
+If no approver is configured, the plugin continues synchronously and the plugin group continues its work without the need to ask for permission to continue.
 If an approver is found, the plugin switches to asynchronous mode (see [[OS4X Server-side plugin philosophy]] for more details on synchronity of plugins).

@@ Line 59: / Line 59: @@
 = Mail template variables =
-Beside the typical XPath expressions for dynamic content generation, the approve plugin contains two specific variables:
+Beside the typical [[OS4X Enterprise text template|template rules]] for dynamic content generation, the approve plugin contains two specific variables:
 *<code>$approveLink</code>
 *<code>$denyLink</code>

← Older revision		Revision as of 11:38, 8 May 2020
Line 64:		Line 64:

	These links are using the configured "URL to approve API" (see above) for creating dynamically links. These hyperlinks contain the generated dynamic hashes used for approving or denying a job.		These links are using the configured "URL to approve API" (see above) for creating dynamically links. These hyperlinks contain the generated dynamic hashes used for approving or denying a job.
		+
		+	Also keep in mind the handy special variables
		+	*<code>JOBFILES_HTML</code>: Generate a HTML list of all files contained in the job (with "ul" and "li" HTML tags)
		+	*<code>JOBFILES_TEXT</code>: Generate a textual list of all files contained in the job (with "- " as a prefix before the filename)

	= Mail example =		= Mail example =

← Older revision		Revision as of 11:30, 8 May 2020
Line 64:		Line 64:

	These links are using the configured "URL to approve API" (see above) for creating dynamically links. These hyperlinks contain the generated dynamic hashes used for approving or denying a job.		These links are using the configured "URL to approve API" (see above) for creating dynamically links. These hyperlinks contain the generated dynamic hashes used for approving or denying a job.
		+
		+	= Mail example =
		+	A sample mail may look like this:
		+
		+	[[File:Bildschirmfoto 2020-05-08 um 13.29.35.png]]

← Older revision		Revision as of 11:28, 8 May 2020
Line 59:		Line 59:

	= Mail template variables =		= Mail template variables =
		+	Beside the typical XPath expressions for dynamic content generation, the approve plugin contains two specific variables:
		+	*<code>$approveLink</code>
		+	*<code>$denyLink</code>
		+
		+	These links are using the configured "URL to approve API" (see above) for creating dynamically links. These hyperlinks contain the generated dynamic hashes used for approving or denying a job.

← Older revision		Revision as of 11:25, 8 May 2020
Line 54:		Line 54:

	== Approver configuration ==		== Approver configuration ==
		+	Approving person can be defined in all hierarchy levels. The contact can be selected, changed, reverted (to none), and edited:
		+
		+	[[File:Bildschirmfoto 2020-05-08 um 13.25.17.png]]

	= Mail template variables =		= Mail template variables =