New Feature: Quiet Trigger Modifier: Optionally run scheduled jobs invisible from the UI, and/or ephemeral so they auto-self-delete upon completion.

Author: jhuckaby

docs/data.md

@@ -890,6 +890,14 @@ If the [Job.state](#job-state) is `queued`, this property will indicate what pos
 
 While the job is running, i.e. in the data passed to the Event Plugin, the job object will contain a `serverData` property.  This will be a copy of the [Server.userData](#server-userdata) object, if applicable for the current server.
 
+### Job.invisible
+
+If set to `true`, the job is running invisibly to the UI.  See [Quiet Trigger](triggers.md#quiet) for details.
+
+### Job.ephemeral
+
+If set to `true`, the job will self-delete upon completion.  See [Quiet Trigger](triggers.md#quiet) for details.
+
 ## Monitor
 
 A monitor keeps track on a specific numeric server metric.  These are graphed in the UI so you can see trends over time, and you can also point alerts at them.  Here is an example monitor in JSON format:

docs/triggers.md

@@ -266,7 +266,7 @@ Example:
 
 ### Range
 
-Restrict scheduling to a date/time window. Prevents launches before `start` and after `end` (unless time is inside another range). Endpoints are inclusive.
+Restrict scheduling to a date/time window. Prevents launches before `start` and after `end` (unless time is inside another range). Endpoints are inclusive.  As a "modifier" this option only takes effect when jobs are launched from a scheduler trigger (i.e. not launched manually via UI or API).
 
 Parameters:
 
@@ -293,7 +293,7 @@ Example: Only run between March 1 and May 31 (inclusive):
 
 ### Blackout
 
-Prevent any automatic launches during a specific date/time window. Endpoints are inclusive.
+Prevent any automatic launches during a specific date/time window. Endpoints are inclusive.  As a "modifier" this option only takes effect when jobs are launched from a scheduler trigger (i.e. not launched manually via UI or API).
 
 Parameters:
 
@@ -320,7 +320,7 @@ Example:
 
 ### Delay
 
-Add a starting delay to all scheduler-launched jobs for the event. Does not affect manual/API runs. Mutually exclusive with `interval` and `precision`.
+Add a starting delay to all scheduler-launched jobs for the event. Does not affect manual/API runs. Mutually exclusive with `interval` and `precision`.  As a "modifier" this option only takes effect when jobs are launched from a scheduler trigger (i.e. not launched manually via UI or API).
 
 Parameters:
 
@@ -340,7 +340,7 @@ Example (delay all launches by 2 minutes):
 
 ### Precision
 
-Launch within the scheduled minute at specific second offsets. Augments other automatic triggers to achieve sub-minute starts. Mutually exclusive with `interval` and `delay`.
+Launch within the scheduled minute at specific second offsets. Augments other automatic triggers to achieve sub-minute starts. Mutually exclusive with `interval` and `delay`.  As a "modifier" this option only takes effect when jobs are launched from a scheduler trigger (i.e. not launched manually via UI or API).
 
 Parameters:
 
@@ -363,6 +363,23 @@ Example (launch at :05, :20, :35, :50 within each matched minute):
 }
 ```
 
+### Quiet
+
+The "Quiet" modifier allows you to configure jobs to run silently (i.e. completely invisible to the UI), and also optionally ephemeral (so they self-delete upon completion).  As a "modifier" this option only takes effect when jobs are launched from a scheduler trigger (i.e. not launched manually via UI or API).  Each quiet mode can be enabled or disabled separately:
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `invisible` | Boolean | Yes | Upcoming, queued and running jobs are completely hidden from the UI. |
+| `ephemeral` | Boolean | Yes | Auto-delete jobs upon completion (no permanent storage). |
+
+A few notes about behaviors:
+
+- Invisible mode affects running jobs, queued jobs, as well as upcoming jobs.
+	- You can still access running invisible jobs via the API (i.e. [get_job](api.md#get_job), [get_jobs](api.md#get_job)).
+	- As soon as jobs complete, they will be visible in the UI (unless `ephemeral` is also set).
+- Ephemeral mode will automatically disable itself if the job produces output files.
+- Both invisible and ephemeral modes are passed down to child sub-jobs if set on a workflow.
+
 ### Plugin
 
 Use a custom [Trigger Plugin](plugins.md#trigger-plugins) to decide whether to launch a job or not. The plugin runs with configured parameters and returns a launch/no-launch decision per each scheduled run.  This is a "modifier" so it needs to be used in conjunction with a standard schedule trigger.

htdocs/js/pages/Base.class.js

@@ -1253,6 +1253,7 @@ Page.Base = class Base extends Page {
 		if (job.icon) icon = '<i class="mdi mdi-' + job.icon + '"></i>';
 		else if (job.type == 'workflow') icon = '<i class="mdi mdi-clipboard-play-outline"></i>';
 		else if (job.workflow) icon = '<i class="mdi mdi-clipboard-clock-outline"></i>';
+		else if (job.invisible) icon = '<i class="mdi mdi-selection-ellipse"></i>';
 
 		var html = '<span class="nowrap">';
 		if (link) {
@@ -1928,6 +1929,10 @@ Page.Base = class Base extends Page {
 			var schedules = triggers.filter( function(trigger) { return trigger.type.match(/^(schedule|single|interval)$/); } );
 			if (!schedules.length) return false;
 
+			// quiet (invisible) mode
+			var quiet = find_object( triggers, { type: 'quiet' } );
+			if (quiet && quiet.invisible) return false;
+			
 			// setup all unique timezones (intl formatters)
 			schedules.forEach( function(trigger) {
 				if (trigger.type != 'schedule') return;

htdocs/js/pages/Events.class.js

@@ -171,6 +171,7 @@ Page.Events = class Events extends Page.PageUtils {
 								{ id: 'blackout', title: "Blackout", icon: 'circle' },
 								{ id: 'delay', title: "Delay", icon: 'chat-sleep-outline' },
 								{ id: 'precision', title: "Precision", icon: 'progress-clock' },
+								{ id: 'quiet', title: "Quiet", icon: 'volume-mute' },
 								{ id: 'plugin', title: "Plugin", icon: 'power-plug' }
 							].concat(
 								this.buildOptGroup( scheduler_plugins, "Trigger Plugins:", 'power-plug-outline', 'p_' )
@@ -941,7 +942,7 @@ Page.Events = class Events extends Page.PageUtils {
 			var { nice_icon, nice_type, nice_desc } = self.getTriggerDisplayArgs(item);
 
 			var tds = [
-				'<div class="nowrap ellip">' + nice_desc + '</div>',
+				'<div class="nowrap ellip">' + nice_desc.replace(/\&nbsp\;/g, '') + '</div>',
 				'<div class="td_big nowrap">' + nice_icon + nice_type + '</div>',
 			];
 
@@ -3190,21 +3191,21 @@ Page.Events = class Events extends Page.PageUtils {
 		html += this.getFormRow({
 			id: 'd_et_range_desc',
 			label: 'Description:',
-			content: 'This option allows you to set a starting and/or ending date/time for the event.  Jobs will not be scheduled before your start date/time, nor after your end date/time.  This is designed to accompany other triggers.'
+			content: 'This modifier allows you to set a starting and/or ending date/time for the event.  Jobs will not be scheduled before your start date/time, nor after your end date/time.  This is designed to accompany other triggers.'
 		});
 
 		// blackout
 		html += this.getFormRow({
 			id: 'd_et_blackout_desc',
 			label: 'Description:',
-			content: 'This option allows you to set a "blackout" period for the event, meaning jobs will not be scheduled during this time.  Examples include company holidays, and maintenance windows.  This is designed to accompany other triggers.'
+			content: 'This modifier allows you to set a "blackout" period for the event, meaning jobs will not be scheduled during this time.  Examples include company holidays, and maintenance windows.  This is designed to accompany other triggers.'
 		});
 
 		// delay
 		html += this.getFormRow({
 			id: 'd_et_delay_desc',
 			label: 'Description:',
-			content: 'This option allows you to set a custom delay for each job launched by the scheduler.  This does not affect jobs launched manually in the UI or via the API.'
+			content: 'This modifier allows you to set a custom delay for each job launched by the scheduler.  This does not affect jobs launched manually in the UI or via the API.'
 		});
 		html += this.getFormRow({
 			id: 'd_et_delay',
@@ -3272,7 +3273,7 @@ Page.Events = class Events extends Page.PageUtils {
 		html += this.getFormRow({
 			id: 'd_et_precision_desc',
 			label: 'Description:',
-			content: 'This option allows you to set the precise seconds when each job should launch via the scheduler.  This does not affect jobs launched manually in the UI or via the API.'
+			content: 'This modifier allows you to set the precise seconds when each job should launch via the scheduler.  This does not affect jobs launched manually in the UI or via the API.'
 		});
 
 		// precision seconds
@@ -3292,6 +3293,37 @@ Page.Events = class Events extends Page.PageUtils {
 			})
 		});
 
+		// quiet desc
+		html += this.getFormRow({
+			id: 'd_et_quiet_desc',
+			label: 'Description:',
+			content: 'This modifier allows you to hide jobs from the UI, and/or delete jobs after completion.  This does not affect jobs launched manually in the UI or via the API.'
+		});
+		
+		// quiet invisible
+		html += this.getFormRow({
+			id: 'd_et_quiet_invisible',
+			label: 'Visibility:',
+			content: this.getFormCheckbox({
+				id: 'fe_et_quiet_invisible',
+				label: 'Invisible Jobs',
+				checked: !!trigger.invisible
+			}),
+			caption: 'Make all running jobs completely invisible to the UI.'
+		});
+		
+		// quiet ephemeral
+		html += this.getFormRow({
+			id: 'd_et_quiet_ephemeral',
+			label: 'Permanence:',
+			content: this.getFormCheckbox({
+				id: 'fe_et_quiet_ephemeral',
+				label: 'Ephemeral Jobs',
+				checked: !!trigger.ephemeral
+			}),
+			caption: 'Delete all jobs after completion.  Note that if a job produces output files, it automatically disables ephemeral mode.'
+		});
+		
 		// timezone (shared by schedule and crontab types)
 		var zones = [
 			['', "Server Default (" + app.config.tz + ")"],
@@ -3519,6 +3551,15 @@ Page.Events = class Events extends Page.PageUtils {
 					}
 				break;
 
+				case 'quiet':
+					// quiet mode
+					trigger.invisible = $('#fe_et_quiet_invisible').is(':checked');
+					trigger.ephemeral = $('#fe_et_quiet_ephemeral').is(':checked');
+					if (!trigger.invisible && !trigger.ephemeral) {
+						return app.doError("You must select at least one mode for the quiet modifier.");
+					}
+				break;
+				
 				case 'plugin':
 					trigger.plugin_id = $('#fe_et_plugin').val();
 					if (!trigger.plugin_id) return app.badField('#fe_et_plugin', "Please select a Plugin for scheduling.");
@@ -3680,6 +3721,13 @@ Page.Events = class Events extends Page.PageUtils {
 					new_btn_label = 'Add Modifier';
 				break;
 
+				case 'quiet':
+					$('#d_et_quiet_desc').show();
+					$('#d_et_quiet_invisible').show();
+					$('#d_et_quiet_ephemeral').show();
+					new_btn_label = 'Add Modifier';
+				break;
+				
 				case 'plugin':
 					$('#d_et_plugin').show();
 					$('#d_et_plugin_params').show();

htdocs/js/pages/Job.class.js

@@ -69,6 +69,7 @@ Page.Job = class Job extends Page.PageUtils {
 			this.live = false;
 
 			if (job.icon) icon = job.icon;
+			else if (job.invisible) icon = 'selection-ellipse';
 			else {
 				if (is_workflow) icon = 'clipboard';
 				else icon = 'timer';

htdocs/js/pages/PageUtils.class.js

@@ -3939,7 +3939,7 @@ Page.PageUtils = class PageUtils extends Page.Base {
 		if (!trigger.enabled) short_desc = '(Disabled)';
 		if (trigger.type.match(/^(interval|single|startup)$/)) nice_title = alt_type;
 
-		if (trigger.type.match(/^(catchup|range|blackout|delay|precision|plugin)$/)) {
+		if (trigger.type.match(/^(catchup|range|blackout|delay|precision|quiet|plugin)$/)) {
 			// option triggers are rendered as pure circles with no pole
 			nice_title = alt_type;
 			inner_classes.push('wf_option');
@@ -5163,6 +5163,26 @@ Page.PageUtils = class PageUtils extends Page.Base {
 				nice_desc = '<i class="mdi mdi-progress-clock">&nbsp;</i><b>Seconds:</b> ' + short_desc;
 			break;
 
+			case 'quiet':
+				nice_icon = '<i class="mdi mdi-cog-outline"></i>';
+				nice_type = 'Modifier';
+				alt_type = 'Quiet';
+				short_desc = '';
+				nice_desc = '';
+				if (item.invisible) {
+					short_desc += 'Invisible';
+					nice_desc += '<i class="mdi mdi-selection-ellipse">&nbsp;</i><b>Invisible</b>';
+				}
+				if (item.ephemeral) {
+					if (short_desc) short_desc += ', ';
+					if (nice_desc) nice_desc += ', ';
+					short_desc += 'Ephemeral';
+					nice_desc += '<i class="mdi mdi-trash-can-outline">&nbsp;</i><b>Ephemeral</b>';
+				}
+				if (!short_desc) short_desc = '(None)';
+				if (!nice_desc) nice_desc = '(None)';
+			break;
+			
 			case 'plugin':
 				nice_icon = '<i class="mdi mdi-power-plug"></i>';
 				nice_type = alt_type = 'Plugin';

htdocs/js/pages/Workflows.class.js

@@ -1994,12 +1994,12 @@ Page.Workflows = class Workflows extends Page.Events {
 			// compute x/y for new node
 			if (this.wfPausedSolder) {
 				// resume paused solder
-				if (trigger.type.match(/^(catchup|range|blackout|delay|precision)$/)) {
+				if (trigger.type.match(/^(catchup|range|blackout|delay|precision|quiet|plugin)$/)) {
 					// special trigger type has no solder poles, so abort the solder, but place the node in the correct location
 					var solder = this.wfPausedSolder;
 					delete this.wfPausedSolder;
-					node.x = solder.x - (width / 2);
-					node.y = solder.y - (height / 2);
+					node.x = solder.x - (node_width / 2);
+					node.y = solder.y - (node_height / 2);
 				}
 				else {
 					this.resumePausedSolder(node.id, node_width, node_height);

htdocs/js/utils.js

@@ -67,6 +67,7 @@ function summarize_event_timings(event) {
 			case 'blackout': opts.push("Blackout"); break;
 			case 'delay': opts.push("Delay"); break;
 			case 'precision': opts.push("Precision"); break;
+			case 'quiet': opts.push("Quiet"); break;
 			case 'plugin':
 				var plugin = find_object( app.plugins, { id: trigger.plugin_id } );
 				if (plugin) opts.push(plugin.title);

internal/ui.json

@@ -1146,6 +1146,7 @@
 		{ "id": "blackout", "title": "Blackout", "icon": "circle" },
 		{ "id": "delay", "title": "Delay", "icon": "chat-sleep-outline" },
 		{ "id": "precision", "title": "Precision", "icon": "progress-clock" },
+		{ "id": "quiet", "title": "Quiet", "icon": "volume-mute" },
 		{ "id": "plugin", "title": "Plugin", "icon": "power-plug" }
 	],
 

lib/api/events.js

@@ -942,6 +942,10 @@ class Events {
 					if (!trigger.seconds) return this.doError('api',  err_prefix + ": Precision rule is missing seconds array.", callback);
 				break;
 
+				case 'quiet':
+					if (!trigger.invisible && !trigger.ephemeral) return this.doError('api',  err_prefix + ": Quiet rule must have one or more modes enabled.", callback);
+				break;
+				
 				case 'plugin':
 					if (!Tools.findObject(this.plugins, { id: trigger.plugin_id, type: 'scheduler' })) {
 						return this.doError('api', "Scheduler Plugin not found: " + trigger.plugin_id, callback);
@@ -969,6 +973,9 @@ class Events {
 		if (Tools.findObjects(etriggers, { type: 'precision' }).length > 1) {
 			return this.doError('api', "Only one precision rule is allowed in trigger list.", callback);
 		}
+		if (Tools.findObjects(etriggers, { type: 'quiet' }).length > 1) {
+			return this.doError('api', "Only one quiet rule is allowed in trigger list.", callback);
+		}
 		if (Tools.findObjects(etriggers, { type: 'plugin' }).length > 1) {
 			return this.doError('api', "Only one plugin rule is allowed in trigger list.", callback);
 		}