OS4X plugin os4xplugin prowl - Revision history

Admin at 12:48, 21 January 2025

2025-01-21T12:48:30Z

Admin: /* Example configuration */

2016-11-08T13:08:57Z

Example configuration

Admin: /* Configuration */

2016-11-08T12:17:30Z

Configuration

Admin at 12:15, 8 November 2016

2016-11-08T12:15:32Z

Admin: /* Requirements */

2016-11-08T10:15:48Z

Requirements

Admin at 10:07, 8 November 2016

2016-11-08T10:07:58Z

Admin: /* Screenshots */

2016-11-08T09:59:13Z

Screenshots

Admin: /* Purpose */

2016-11-08T09:58:52Z

Purpose

Admin: /* Clients */

2016-11-08T09:55:42Z

Clients

Admin: New page: Category:Plugins == Purpose == Send a notification to connected devices which use the Prowl service (compatible with Growl). Notifications can be displayed on mobile devices (such as m...

2016-11-08T09:49:59Z

New page: Category:Plugins == Purpose == Send a notification to connected devices which use the Prowl service (compatible with Growl). Notifications can be displayed on mobile devices (such as m...

New page

[[Category:Plugins]]
== Purpose ==
Send a notification to connected devices which use the Prowl service (compatible with Growl). Notifications can be displayed on mobile devices (such as mobile phones, smart watches, tablets) or even desktop systems.

The plugin is designed to run in two modes:
*Default plugin mode: can be executed at any situation in a job processing
*Event handler: the "[[OS4X_Core_event_scripts#OS4X_Enterprise_job_abort_script|OS4X Enterprise job abort event]] can be configured to the plugin executable.

== Screenshots ==
Prowl on an iPhone (iOS 10):

[[Image:Prowl-iPhone.png]]

Prowl on an Apple Watch (WatchOS 3):

[[Image:Prowl-Apple Watch.png]]

== Requirements ==

* File <code>/etc/os4x.conf</code> or configuration file pointed to in environment variable <code>$OS4X_CFGFILE</code>. Via the used configuration file, the information are retrieved used by the plugin (such as default configuration etc.).
* Either source file or renamed target file must exist. If none of these exist, the plugin stops execution.
* Prowl account (API key): https://www.prowlapp.com/

== Configuration ==
*API key: when having registered for free at https://www.prowlapp.com, you can generate as many API keys you want in the "API key" section. You can use different API keys for different situations, with different notification situations depending on your device and program configuration.
*(''optional'') API URL for message: If you want a different message API server than https://api.prowlapp.com/publicapi/add (i.e. if you plan to use your own messaging service), you can override the default value here.
*(''optional'') Application name: You can override the default "OS4X" value with this config, which is also capable to interpret XPath expressions, indicated by a single dollar sign ("$"), based on the job XML (i.e. for dynamic parameter calculation).
*Description: The text message which is being displayed at the connected devices. This configuration also supports XPath expressions, indicated by a single dollar sign ("$"), based on the job XML (i.e. for dynamic parameter calculation).
**When configured globally in "Configuration" -> "OS4X Enterprise" -> "Plugins", this configuration is used for the event handler for aborted jobs. You may use a default value such as:
$/OS4X_job/job_information/job_direction OS4X job $/OS4X_job/job_information/job_number aborted!
*(''optional'') Priority: numeric priority, with value from "-2" (very low) to "2" (emergency). Clients can be configured to display only priority messages of a given level or above.
*(''optional'') Convert first character to uppercase: For a better readability, the calculated message description can be converted to a upper case message (useful when dealing with dynamic values, like XPath expressions).

== Clients ==
*Desktop client: http://growl.info/
*iOS (with Apple Watch support): https://itunes.apple.com/de/app/prowl-easy-push-notifications/id320876271?mt=8#

== Return values ==
0: everything OK

1: Configfile (/etc/os4x.conf or value of environment variable "<code>OS4X_CFGFILE</code>", read in as file) cannot be found or database unavailable.

2: License error

3: XML parameter file cannot be parsed

@@ Line 48: / Line 48: @@
 The textual description information (for copy&paste) of both configs are:
-*Plugin mode: <code>$/OS4X_job/job_information/job_direction OS4X job $/OS4X_job/job_information/job_number successfully transfered!</code>
+*Plugin mode: <code>$/OS4X_job/job_information/job_direction OS4X job $/OS4X_job/job_information/job_number successfully transferred!</code>
 *Event handler mode: <code>$/OS4X_job/job_information/job_direction OS4X job $/OS4X_job/job_information/job_number aborted!</code>

← Older revision		Revision as of 13:08, 8 November 2016
Line 46:		Line 46:

	[[Image:ProwlDefaultConfig.png]]		[[Image:ProwlDefaultConfig.png]]
		+
		+	The textual description information (for copy&paste) of both configs are:
		+	*Plugin mode: <code>$/OS4X_job/job_information/job_direction OS4X job $/OS4X_job/job_information/job_number successfully transfered!</code>
		+	*Event handler mode: <code>$/OS4X_job/job_information/job_direction OS4X job $/OS4X_job/job_information/job_number aborted!</code>

	== Clients ==		== Clients ==

@@ Line 26: / Line 26: @@
 == Configuration ==
 *API key: when having registered for free at https://www.prowlapp.com, you can generate as many API keys you want in the "API key" section. You can use different API keys for different situations, with different notification situations depending on your device and program configuration.
 *(''optional'') API URL for message: If you want a different message API server than https://api.prowlapp.com/publicapi/add (i.e. if you plan to use your own messaging service), you can override the default value here.
 *(''optional'') Application name: You can override the default "OS4X" value with this config, which is also capable to interpret XPath expressions, indicated by a single dollar sign ("$"), based on the job XML (i.e. for dynamic parameter calculation).

@@ Line 33: / Line 33: @@
 *(''optional'') Priority: numeric priority, with value from "-2" (very low) to "2" (emergency). Clients can be configured to display only priority messages of a given level or above.
 *(''optional'') Convert first character to uppercase: For a better readability, the calculated message description can be converted to a upper case message (useful when dealing with dynamic values, like XPath expressions).
 == Clients ==

@@ Line 20: / Line 20: @@
 == Requirements ==
-* File <code>/etc/os4x.conf</code> or configuration file pointed to in environment variable <code>$OS4X_CFGFILE</code>. Via the used configuration file, the information are retrieved used by the plugin (such as default configuration etc.).
+* File <code>/etc/os4x.conf</code> or the configuration file which points to the environment variable <code>$OS4X_CFGFILE</code>. Via the used configuration file, the information are retrieved used by the plugin (such as default configuration etc.).
 * Either source file or renamed target file must exist. If none of these exist, the plugin stops execution.
 * Prowl account (API key): https://www.prowlapp.com/

@@ Line 6: / Line 6: @@
 *Default plugin mode: can be executed at any situation in a job processing
 *Event handler: the "[[OS4X_Core_event_scripts#OS4X_Enterprise_job_abort_script|OS4X Enterprise job abort event]]" can be configured to use the plugin executable directly.
 == Screenshots ==

@@ Line 8: / Line 8: @@
 == Screenshots ==
 Prowl on an iPhone (iOS 10):
 [[Image:Prowl-iPhone.png]]
 == Requirements ==

@@ Line 34: / Line 34: @@
 == Clients ==
 *iOS (with Apple Watch support): https://itunes.apple.com/de/app/prowl-easy-push-notifications/id320876271?mt=8#
 == Return values ==