Automations - Revision history

Luke: /* Usage */

2022-11-17T15:38:07Z

Usage

← Older revision		Revision as of 15:38, 17 November 2022
Line 56:		Line 56:

	</syntaxhighlight>		</syntaxhighlight>

			This however is not entirely ideal as it doesn't allow for code completion/ IntelliSense, so if you do suspect that other people will want to tailgate your automation, consider [[Events\|defining an event instead]] then dispatch it at the end of your automation. This has the advantage of being able to pass specific and potentially useful information about the automation run to followup handlers too.

	= Usage tips =		= Usage tips =

Luke: /* Usage tips */

2022-08-24T19:54:40Z

Usage tips

← Older revision		Revision as of 19:54, 24 August 2022
Line 59:		Line 59:
	= Usage tips =		= Usage tips =

	* Online cron expression editors can help you [https://www.google.com/search?q=cron+expression+editor get the expression you need]. NOTE: when selecting a cron formater, use one that supports 7 fields - 6 field cron will result in an incomplete expression		* Online cron expression editors can help you [https://www.google.com/search?q=cron+expression+editor get the expression you need]. NOTE: when selecting a cron formater, use one that supports 7 fields (i.e. seconds resolution), such as [https://www.freeformatter.com/cron-expression-generator-quartz.html this one]. A 6 field cron will result in an incomplete expression.

	* The time is always in UTC, meaning it is not affected by local timezone changes such as daylight savings and it is easier to sync larger jobs within a global cluster.		* The time is always in UTC, meaning it is not affected by local timezone changes such as daylight savings and it is easier to sync larger jobs within a global cluster.

72.201.192.210: /* Usage tips */

2022-08-02T18:43:06Z

Usage tips

← Older revision		Revision as of 18:43, 2 August 2022
Line 59:		Line 59:
	= Usage tips =		= Usage tips =

	* Online cron expression editors can help you [https://www.google.com/search?q=cron+expression+editor get the expression you need]. NOTE: when selecting a cron formater that supports 7 fields - 6 field cron		* Online cron expression editors can help you [https://www.google.com/search?q=cron+expression+editor get the expression you need]. NOTE: when selecting a cron formater, use one that supports 7 fields - 6 field cron will result in an incomplete expression

	* The time is always in UTC, meaning it is not affected by local timezone changes such as daylight savings and it is easier to sync larger jobs within a global cluster.		* The time is always in UTC, meaning it is not affected by local timezone changes such as daylight savings and it is easier to sync larger jobs within a global cluster.

72.201.192.210: /* Usage tips */

2022-08-02T18:05:37Z

Usage tips

← Older revision		Revision as of 18:05, 2 August 2022
Line 59:		Line 59:
	= Usage tips =		= Usage tips =

	* Online cron expression editors can help you [https://www.google.com/search?q=cron+expression+editor get the expression you need].		* Online cron expression editors can help you [https://www.google.com/search?q=cron+expression+editor get the expression you need]. NOTE: when selecting a cron formater that supports 7 fields - 6 field cron

	* The time is always in UTC, meaning it is not affected by local timezone changes such as daylight savings and it is easier to sync larger jobs within a global cluster.		* The time is always in UTC, meaning it is not affected by local timezone changes such as daylight savings and it is easier to sync larger jobs within a global cluster.

Luke: /* Usage */

2022-07-30T22:09:19Z

Usage

← Older revision		Revision as of 22:09, 30 July 2022
Line 12:		Line 12:

	<syntaxhighlight lang="csharp">		<syntaxhighlight lang="csharp">
			using Api.Automations; // for AutomationRunInfo

			..

	// If your automation doesn't need to do anything async:		// If your automation doesn't need to do anything async:

Luke at 22:07, 30 July 2022

2022-07-30T22:07:35Z

← Older revision		Revision as of 22:07, 30 July 2022
Line 53:		Line 53:

	</syntaxhighlight>		</syntaxhighlight>

			= Usage tips =

			* Online cron expression editors can help you [https://www.google.com/search?q=cron+expression+editor get the expression you need].

			* The time is always in UTC, meaning it is not affected by local timezone changes such as daylight savings and it is easier to sync larger jobs within a global cluster.

Luke at 21:58, 30 July 2022

2022-07-30T21:58:11Z

← Older revision		Revision as of 21:58, 30 July 2022
Line 1:		Line 1:
	Automations are a mechanism in SocialStack to create a task which runs on some defined schedule. They're also known as "background jobs" or "daemons". The schedule is defined using a [https://en.wikipedia.org/wiki/Cron cron expression].		Automations are a mechanism in SocialStack to create a task which runs on some defined schedule. They're also known as "background jobs" or "daemons". The schedule is defined using a [https://en.wikipedia.org/wiki/Cron cron expression].

			= Usage =

			First, install the Automations module:

			<syntaxhighlight lang="bash">
			socialstack install Api/Automations
			</syntaxhighlight>

			That adds the Events.Automation method to your project, which can then be used like so:

			<syntaxhighlight lang="csharp">

			// If your automation doesn't need to do anything async:
			Events.Automation("once_a_second", "* * * * * ? *")
			.AddEventListener((Context context, AutomationRunInfo info) => {

			System.Console.WriteLine("- Runs once a second -");

			return new ValueTask<AutomationRunInfo>(info);

			});

			// With async:
			Events.Automation("once_a_second", "* * * * * ? *")
			.AddEventListener(async (Context context, AutomationRunInfo info) => {

			System.Console.WriteLine("- Runs once a second -");

			await _someOtherService.DoSomething(context);

			return info;

			});

			</syntaxhighlight>

			Note that Automation has two args - a name and a schedule. The name is such that your automation can be triggered by hand separately, for example if you need a background job to run "now" rather than waiting for the schedule to trigger it.

			Because of the name, it is also possible to add additional handlers to a particular job run. For example if you know a job is called "update_certificate" then you can add an additional handler to the event like so:

			<syntaxhighlight lang="csharp">

			Events.Automation("update_certificate")
			.AddEventListener((Context context, AutomationRunInfo info) => {

			System.Console.WriteLine("- This runs immediately after the update_certificate automation. -");

			return new ValueTask<AutomationRunInfo>(info);

			}, 11); // Priority 11 ensures we for certain will happen after the main automations listener(s) occur.

			</syntaxhighlight>

Luke: Created page with "Automations are a mechanism in SocialStack to create a task which runs on some defined schedule. They're also known as "background jobs" or "daemons". The schedule is defined..."

2022-07-30T21:51:21Z

Created page with "Automations are a mechanism in SocialStack to create a task which runs on some defined schedule. They're also known as "background jobs" or "daemons". The schedule is defined..."

New page

Automations are a mechanism in SocialStack to create a task which runs on some defined schedule. They're also known as "background jobs" or "daemons". The schedule is defined using a [https://en.wikipedia.org/wiki/Cron cron expression].