Admin Templates (3.x.x and earlier) - Revision history

Carfey: Carfey moved page Admin Templates to Admin Templates (3.x.x and earlier) without leaving a redirect

2016-07-01T16:55:15Z

Carfey moved page Admin Templates to Admin Templates (3.x.x and earlier) without leaving a redirect

← Older revision	Revision as of 16:55, 1 July 2016
(No difference)

Carfey: /* Template Validation */

2013-06-03T02:31:27Z

Template Validation

← Older revision		Revision as of 02:31, 3 June 2013
Line 42:		Line 42:
	== Template Validation ==		== Template Validation ==

	While templates are validated upon saving, it is possible there are issues in the template that will not be discovered until runtime. If Obsidian encounters an error using a template you've configured, it will use an internal default template so ~~that~~ notifications are ~~not~~ lost. If this is happening in your installation, check your servlet container log files for details on the issue.		While templates are validated upon saving, it is possible there are issues in the template that will not be discovered until runtime. If Obsidian encounters an error using a template you've configured, it will use an internal default template so no notifications are lost. If this is happening in your installation, check your servlet container log files for details on the issue.

	~~For~~ errors ~~that~~ are detected while saving, Obsidian will prevent ~~you~~ with messaging to indicate the type of failure. Since it can be difficult to track down issues in templates, we recommend you save incremental changes while creating the template to catch errors early. If you encounter an error in the UI that is not clear, try removing portions of your template to find the issue, or check your servlet container log files to ~~possibly~~ find additional ~~detail~~.		If errors are detected while saving, Obsidian will prevent it with messaging to indicate the type of failure. Since it can be difficult to track down issues in templates, we recommend you save incremental changes while creating the template to catch errors early. If you encounter an error in the UI that is not clear, try removing portions of your template to find the issue, or check your servlet container log files to find additional details.

	[[Image:EditTemplateError.png\|800px]]		[[Image:EditTemplateError.png\|800px]]

Carfey: /* Adding or Editing a Template */

2013-06-03T02:28:51Z

Adding or Editing a Template

← Older revision		Revision as of 02:28, 3 June 2013
Line 29:		Line 29:


	For categories that are job-related, you may ~~indicate~~ the template is the default for that category by checking the ''Use as Default'' box. If this is not selected, you will be able to select specific jobs that the template applies to. Templates that are linked with specific jobs are always used instead of defaults when they ~~exists~~.		For categories that are job-related, you may select the template as the default for that category by checking the ''Use as Default'' box. If this box is not selected, you will be able to select specific jobs that the template applies to. Templates that are linked with specific jobs are always used instead of defaults when they exist.

	For '''non-job related categories''', an active template is always considered the default.		For '''non-job related categories''', the active template is always considered the default.

	'''Note:''' When an active template is saved, other templates may be updated automatically. If the template is for a non-job category or it is marked as ''Use as Default'', any other templates with the same category will be made inactive. If the template applies to specific jobs, any templates with the same category and job mappings will be updated to remove the overlapping applicable jobs.		'''Note:''' When an active template is saved, other templates may be updated automatically. If the template is for a non-job category or it is marked as ''Use as Default'', any other templates with the same category will be made inactive. If the template applies to specific jobs, any templates with the same category and job mappings will be updated to remove the overlapping applicable jobs.
Line 39:		Line 39:

	[[Image:JobSpecificTemplate.png\|800px]]		[[Image:JobSpecificTemplate.png\|800px]]


	== Template Validation ==		== Template Validation ==

Carfey: /* Listing Templates */

2013-06-03T02:25:18Z

Listing Templates

← Older revision		Revision as of 02:25, 3 June 2013
Line 10:		Line 10:
	== Listing Templates ==		== Listing Templates ==

	The main templates screen shows the current configured templates and their details. Obsidian comes with two default templates. Click on the template name to edit the template ''Add Template'' link in the navigation bar below the tabs to create a new one.		The main templates screen shows the current configured templates and their details. Obsidian comes with two default templates. Click on the template name to edit the template or the ''Add Template'' link in the navigation bar below the tabs to create a new one.

	[[Image:TemplateListing.png\|800px]]		[[Image:TemplateListing.png\|800px]]


	== Adding or Editing a Template ==		== Adding or Editing a Template ==

Carfey at 02:24, 3 June 2013

2013-06-03T02:24:30Z

← Older revision		Revision as of 02:24, 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.

	The email template screens allow users to customize the content of notification emails by event category ~~and even by~~ specific jobs.		The email template screens allow users to customize the content of notification emails by event category or specific jobs.

	Templates management screens are reached via the '''Notifications''' tab and are visible to users with the ''Admin'' role.		Templates management screens are reached via the '''Notifications''' tab and are visible to users with the ''Admin'' role.

Carfey at 02:23, 3 June 2013

2013-06-03T02:23:42Z

← Older revision		Revision as of 02:23, 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.

	The email ~~templates~~ screens allow users to customize the content of notification emails by event category and even by specific jobs.		The email template screens allow users to customize the content of notification emails by event category and even by specific jobs.

	Templates management screens are reached via the '''Notifications''' tab and are visible to users with the ''Admin'' role.		Templates management screens are reached via the '''Notifications''' tab and are visible to users with the ''Admin'' role.

Carfey at 01:14, 3 June 2013

2013-06-03T01:14:39Z

← Older revision		Revision as of 01:14, 3 June 2013
Line 5:		Line 5:
	Templates management screens are reached via the '''Notifications''' tab and are visible to users with the ''Admin'' role.		Templates management screens are reached via the '''Notifications''' tab and are visible to users with the ''Admin'' role.

			For information on authoring or tweaking the email templates, see our complete [[Email Templates]] page.

Carfey at 01:13, 3 June 2013

2013-06-03T01:13:59Z

← Older revision		Revision as of 01:13, 3 June 2013
Line 4:		Line 4:

	Templates management screens are reached via the '''Notifications''' tab and are visible to users with the ''Admin'' role.		Templates management screens are reached via the '''Notifications''' tab and are visible to users with the ''Admin'' role.

Carfey: /* Template Validation */

2013-06-03T01:13:07Z

Template Validation

← Older revision		Revision as of 01:13, 3 June 2013
Line 42:		Line 42:
	== Template Validation ==		== Template Validation ==

	While templates are validated upon saving, it is possible there are issues in the template that will not be discovered until runtime. If Obsidian encounters an error using a template you've configured, it will use an internal default template so that notifications are not lost. If this is happening in your installation, check your servlet ~~conatiner~~ log files for details on the issue.		While templates are validated upon saving, it is possible there are issues in the template that will not be discovered until runtime. If Obsidian encounters an error using a template you've configured, it will use an internal default template so that notifications are not lost. If this is happening in your installation, check your servlet container log files for details on the issue.

	For errors that are detected while saving, Obsidian will prevent you with messaging to indicate the type of failure. Since it can be difficult to track down issues in templates, we recommend you save incremental changes while creating the template to catch errors early.		For errors that are detected while saving, Obsidian will prevent you with messaging to indicate the type of failure. Since it can be difficult to track down issues in templates, we recommend you save incremental changes while creating the template to catch errors early. If you encounter an error in the UI that is not clear, try removing portions of your template to find the issue, or check your servlet container log files to possibly find additional detail.

	[[Image:EditTemplateError.png\|800px]]		[[Image:EditTemplateError.png\|800px]]


	== Deleting a Template ==		== Deleting a Template ==

Carfey at 01:11, 3 June 2013

2013-06-03T01:11:43Z

← Older revision		Revision as of 01:11, 3 June 2013
Line 4:		Line 4:

	Templates management screens are reached via the '''Notifications''' tab and are visible to users with the ''Admin'' role.		Templates management screens are reached via the '''Notifications''' tab and are visible to users with the ''Admin'' role.


	== Listing Templates ==		== Listing Templates ==
Line 10:		Line 11:

	[[Image:TemplateListing.png\|800px]]		[[Image:TemplateListing.png\|800px]]


	== Adding or Editing a Template ==		== Adding or Editing a Template ==
Line 36:		Line 38:

	[[Image:JobSpecificTemplate.png\|800px]]		[[Image:JobSpecificTemplate.png\|800px]]


			== Template Validation ==

			While templates are validated upon saving, it is possible there are issues in the template that will not be discovered until runtime. If Obsidian encounters an error using a template you've configured, it will use an internal default template so that notifications are not lost. If this is happening in your installation, check your servlet conatiner log files for details on the issue.

			For errors that are detected while saving, Obsidian will prevent you with messaging to indicate the type of failure. Since it can be difficult to track down issues in templates, we recommend you save incremental changes while creating the template to catch errors early.

			[[Image:EditTemplateError.png\|800px]]


	== Deleting a Template ==		== Deleting a Template ==