Email Templates - Revision history

Carfey: /* Templating Variables */

2016-07-01T17:31:30Z

Templating Variables

← Older revision		Revision as of 17:31, 1 July 2016
Line 30:		Line 30:
	\| hostName \|\| Text \|\| Always \|\| The host name / designator that originated the event.		\| hostName \|\| Text \|\| Always \|\| The host name / designator that originated the event.
	\|-		\|-
	\| hostUrl \|\| Text \|\| Always \|\| The host URL as configured in the ~~Systems tab~~. This can be used to link to the Obsidian installation in emails.		\| hostUrl \|\| Text \|\| Always \|\| The host URL as configured in the [[Admin Scheduler Settings\|scheduler settings]] screen. This can be used to link to the Obsidian installation in emails.
	\|-		\|-
	\| hasDetail \|\| Boolean \|\| Always \|\| Indicates if any <code>detailItems'</code> exist. Can be used for conditionals.		\| hasDetail \|\| Boolean \|\| Always \|\| Indicates if any <code>detailItems'</code> exist. Can be used for conditionals.

Carfey at 16:39, 1 July 2016

2016-07-01T16:39:57Z

← Older revision		Revision as of 16:39, 1 July 2016
Line 1:		Line 1:
	As of version 2.0, Obsidian supports customizable templates for all email notifications.		As of version 2.0, Obsidian supports customizable templates for all email notifications.

	If you have questions or require help building your own templates, please [[Contact Carfey Software\|~~Contact Us~~]] for free support.		If you have questions or require help building your own templates, please [[Contact Carfey Software\|contact us]] for free support.

	== Template Basics & Language ==		== Template Basics & Language ==

Carfey: /* Templating Variables */

2015-07-15T16:50:49Z

Templating Variables

← Older revision		Revision as of 16:50, 15 July 2015
Line 24:		Line 24:
	\| subject \|\| Text \|\| Always \|\| This the basic event summary message.		\| subject \|\| Text \|\| Always \|\| This the basic event summary message.
	\|-		\|-
	\| detailItems \|\| Text (multiple) \|\| Always \|\| The list of all detail messages provided with the event. For example, when a job's configuration is updated, a separate item for each change will be represented here. In some cases, this may be empty.		\| detailItems \|\| Text (multiple) \|\| Always \|\| The list of all detail messages provided with the event. For example, when a job's configuration is updated, a separate item for each change will be represented here. For job execution failures, this will contain the stack trace. In some cases, this may be empty.
	\|-		\|-
	\| detail \|\| Text \|\| Always \|\| This the combined form of <code>detailItems</code>. In some cases, this may be empty.		\| detail \|\| Text \|\| Always \|\| This the combined form of <code>detailItems</code>. In some cases, this may be empty.

Carfey at 22:17, 1 November 2013

2013-11-01T22:17:01Z

← Older revision		Revision as of 22:17, 1 November 2013
Line 35:		Line 35:
	\|-		\|-
	\| level \|\| Text \|\| Always \|\| Indicates the level of the event. One of: <code>INFO</code>, <code>WARNING</code>, <code>ERROR</code>, <code>FATAL</code>.		\| level \|\| Text \|\| Always \|\| Indicates the level of the event. One of: <code>INFO</code>, <code>WARNING</code>, <code>ERROR</code>, <code>FATAL</code>.
			\|-
			\| category \|\| Text \|\| Always \|\| Indicates the category of the event. Available as of 2.3. One of: <code>SYSTEM_PARAMETER</code>, <code>QUEUE</code>, <code>JOB</code>, <code>JOB_CHAIN</code>, <code>JOB_CONFIG</code>, <code>JOB_RUN</code>, <code>JOB_RECOVERY</code>, <code>LICENCE</code>.
			\|-
			\| levelDisplayName \|\| Text \|\| Always \|\| Indicates the level of the event, in a pretty format. Available as of 2.3. One of: <code>Info</code>, <code>Warning</code>, <code>Error</code>, <code>Fatal</code>.
			\|-
			\| categoryDisplayName \|\| Text \|\| Always \|\| Indicates the category of the event, in a pretty format. Available as of 2.3. One of: <code>System Parameter</code>, <code>Queue</code>, <code>Job</code>, <code>Job Chain</code>, <code>Job Config</code>, <code>Job Run</code>, <code>Job Recovery</code>, <code>Licence</code>.
	\|-		\|-
	\| recipients \|\| Text (multiple) \|\| Always \|\| The email addresses of all recipients of this message.		\| recipients \|\| Text (multiple) \|\| Always \|\| The email addresses of all recipients of this message.
Line 85:		Line 91:
	Host Name: {{hostName}}		Host Name: {{hostName}}
	Host Url: {{hostUrl}}		Host Url: {{hostUrl}}
	Level: {{level}}		Level: {{level}} - {{levelDisplayName}}
			Category: {{category}} - {{categoryDisplayName}}
	Recipients: {{#recipients}}{{^-first}}, {{/-first}}{{.}}{{/recipients}}		Recipients: {{#recipients}}{{^-first}}, {{/-first}}{{.}}{{/recipients}}
	Subject: {{subject}}		Subject: {{subject}}

Carfey: /* Templating Variables */

2013-06-03T02:20:05Z

Templating Variables

← Older revision		Revision as of 02:20, 3 June 2013
Line 15:		Line 15:
	== Templating Variables ==		== Templating Variables ==

	The following table documents all data elements that are available in email templates. Note that some data elements are only available in certain contexts, so your templates should be written accordingly. The ''Available Scope'' column indicates ~~what~~ types of events the ~~variable is~~ used in. For example, some variables are only present for job-related event categories, and some are only present for Job Run events.		The following table documents all data elements that are available in email templates. Note that some data elements are only available in certain contexts, so your templates should be written accordingly. The ''Available Scope'' column indicates which types of events the variables are used in. For example, some variables are only present for job-related event categories, and some are only present for Job Run events.

	If you wish to see a sample template, simply navigate to the '''[[Admin Templates\|Email Templates]]''' screen in the admin UI, and take a look at the default templates that are pre-installed.		If you wish to see a sample template, simply navigate to the '''[[Admin Templates\|Email Templates]]''' screen in the admin UI, and take a look at the default templates that are pre-installed.

Carfey: /* Template Basics & Language */

2013-06-03T02:18:44Z

Template Basics & Language

← Older revision		Revision as of 02:18, 3 June 2013
Line 11:		Line 11:
	Obsidian email templates use [http://mustache.github.io/ Mustache], which is a logic-less templating language commonly used in various applications. Specifically, Obsidian uses [https://github.com/samskivert/jmustache jMustache], and it can be referred to when looking for feature support and general syntax in your templates.		Obsidian email templates use [http://mustache.github.io/ Mustache], which is a logic-less templating language commonly used in various applications. Specifically, Obsidian uses [https://github.com/samskivert/jmustache jMustache], and it can be referred to when looking for feature support and general syntax in your templates.

	'''Note:''' Obsidian cannot guarantee that configured templates are valid. You are responsible for ensuring the correctness or your templates according to the information provided below. If you have configured Obsidian to use invalid templates ~~which~~ fail, Obsidian will fall back to internal templates so that notifications are not lost.		'''Note:''' Obsidian cannot guarantee that configured templates are valid. You are responsible for ensuring the correctness or your templates according to the information provided below. If you have configured Obsidian to use invalid templates that fail, Obsidian will fall back to internal templates so that notifications are not lost.

	== Templating Variables ==		== Templating Variables ==

Carfey: /* Template Basics & Language */

2013-06-03T02:16:37Z

Template Basics & Language

← Older revision		Revision as of 02:16, 3 June 2013
Line 7:		Line 7:
	Obsidian comes with two basic email templates that are suitable for most users. For those that wish to have more control, templates can be configured in the '''[[Admin Templates\|Email Templates]]''' screen.		Obsidian comes with two basic email templates that are suitable for most users. For those that wish to have more control, templates can be configured in the '''[[Admin Templates\|Email Templates]]''' screen.

	Both subject and body fields can be ~~templated~~. Note that body templates are used for '''HTML only'''.		Both subject and body fields can be customized through templates. Note that body templates are used for '''HTML only'''.

	Obsidian email templates use [http://mustache.github.io/ Mustache], which is a logic-less templating language commonly used in various applications. Specifically, Obsidian uses [https://github.com/samskivert/jmustache jMustache], and it can be referred to when looking for feature support and general syntax in your templates.		Obsidian email templates use [http://mustache.github.io/ Mustache], which is a logic-less templating language commonly used in various applications. Specifically, Obsidian uses [https://github.com/samskivert/jmustache jMustache], and it can be referred to when looking for feature support and general syntax in your templates.

Carfey: /* Template Basics & Language */

2013-06-03T02:14:42Z

Template Basics & Language

← Older revision		Revision as of 02:14, 3 June 2013
Line 10:		Line 10:

	Obsidian email templates use [http://mustache.github.io/ Mustache], which is a logic-less templating language commonly used in various applications. Specifically, Obsidian uses [https://github.com/samskivert/jmustache jMustache], and it can be referred to when looking for feature support and general syntax in your templates.		Obsidian email templates use [http://mustache.github.io/ Mustache], which is a logic-less templating language commonly used in various applications. Specifically, Obsidian uses [https://github.com/samskivert/jmustache jMustache], and it can be referred to when looking for feature support and general syntax in your templates.

			'''Note:''' Obsidian cannot guarantee that configured templates are valid. You are responsible for ensuring the correctness or your templates according to the information provided below. If you have configured Obsidian to use invalid templates which fail, Obsidian will fall back to internal templates so that notifications are not lost.

	== Templating Variables ==		== Templating Variables ==

Carfey at 02:13, 3 June 2013

2013-06-03T02:13:00Z

← Older revision		Revision as of 02:13, 3 June 2013
Line 3:		Line 3:
	If you have questions or require help building your own templates, please [[Contact Carfey Software\|Contact Us]] for free support.		If you have questions or require help building your own templates, please [[Contact Carfey Software\|Contact Us]] for free support.

	== Template Basics ==		== Template Basics & Language ==

	Obsidian comes with two basic email templates that are suitable for most users. For those that wish to have more control, templates can be configured in the '''[[Admin Templates\|Email Templates]]''' screen.		Obsidian comes with two basic email templates that are suitable for most users. For those that wish to have more control, templates can be configured in the '''[[Admin Templates\|Email Templates]]''' screen.

	Both subject and body fields can be templated. Note that body templates are used for '''HTML only'''.		Both subject and body fields can be templated. Note that body templates are used for '''HTML only'''.

	~~== Templating Language ==~~

	Obsidian email templates use [http://mustache.github.io/ Mustache], which is a logic-less templating language commonly used in various applications. Specifically, Obsidian uses [https://github.com/samskivert/jmustache jMustache], and it can be referred to when looking for feature support and general syntax in your templates.		Obsidian email templates use [http://mustache.github.io/ Mustache], which is a logic-less templating language commonly used in various applications. Specifically, Obsidian uses [https://github.com/samskivert/jmustache jMustache], and it can be referred to when looking for feature support and general syntax in your templates.

Carfey at 02:11, 3 June 2013

2013-06-03T02:11:39Z

← Older revision		Revision as of 02:11, 3 June 2013
Line 1:		Line 1:
	As of version 2.0, Obsidian supports customizable templates for all email notifications.		As of version 2.0, Obsidian supports customizable templates for all email notifications.

			If you have questions or require help building your own templates, please [[Contact Carfey Software\|Contact Us]] for free support.

	== Template Basics ==		== Template Basics ==