Chris.Hansen at 18:21, 23 January 2025

2025-01-23T18:21:01Z

← Older revision		Revision as of 18:21, 23 January 2025
Line 3:		Line 3:

	== Handlebars Expressions Overview ==		== Handlebars Expressions Overview ==
	Handlebars expressions are used to embed dynamic content within templates. These expressions are enclosed in <code><nowiki>{{ }}</nowiki></code> and allow access to variables and helper functions.		Handlebars expressions are used to embed dynamic content within templates. These expressions are enclosed in <code><nowiki>{{ }}</nowiki></code> and allow access to variables and helper functions. Complete Handlebars documentation is available at https://handlebarsjs.com/guide/expressions.html

	Example:		Example:
Line 14:		Line 14:
	The <code>now</code> helper renders the current date and time. It supports the following optional hash parameters:		The <code>now</code> helper renders the current date and time. It supports the following optional hash parameters:

	* <code>'''format'''</code>: Specifies the date/time format. Refer to the date-fns format documentation for available options.		* <code>'''format'''</code>: Specifies the date/time format. Refer to the [https://date-fns.org/v4.1.0/docs/format date-fns format documentation] for available options.
	* <code>'''timeZone'''</code>: Specifies the time zone in which the date/time should be rendered.		* <code>'''timeZone'''</code>: Specifies the time zone in which the date/time should be rendered.

Chris.Hansen: Created page with "FojiSoft's Notification Subscriptions utilize Handlebars template expressions to dynamically insert and format data within notifications. This guide explains the available expressions, helper functions, and variables to help you create meaningful and informative notifications. ---- == Handlebars Expressions Overview == Handlebars expressions are used to embed dynamic content within templates. These expressions are enclosed in `{{ }}` and allo..."

2025-01-23T18:18:33Z

Created page with "FojiSoft's Notification Subscriptions utilize Handlebars template expressions to dynamically insert and format data within notifications. This guide explains the available expressions, helper functions, and variables to help you create meaningful and informative notifications. ---- == Handlebars Expressions Overview == Handlebars expressions are used to embed dynamic content within templates. These expressions are enclosed in <code><nowiki>{{ }}</nowiki></code> and allo..."

New page

FojiSoft's Notification Subscriptions utilize Handlebars template expressions to dynamically insert and format data within notifications. This guide explains the available expressions, helper functions, and variables to help you create meaningful and informative notifications.
----

== Handlebars Expressions Overview ==
Handlebars expressions are used to embed dynamic content within templates. These expressions are enclosed in <code><nowiki>{{ }}</nowiki></code> and allow access to variables and helper functions.

Example:
<code><nowiki>{{variableName}}</nowiki></code>

=== Helper Functions ===
Helpers provide additional functionality to format or manipulate data. In FojiSoft Notifications, the following helper is available:

==== <code>now</code> ====
The <code>now</code> helper renders the current date and time. It supports the following optional hash parameters:

* <code>'''format'''</code>: Specifies the date/time format. Refer to the date-fns format documentation for available options.
* <code>'''timeZone'''</code>: Specifies the time zone in which the date/time should be rendered.

Example:
<code><nowiki>{{now format="yyyy-MM-dd HH:mm:ss" timeZone="UTC"}}</nowiki></code>
----

== Available Variables ==
The variables in FojiSoft Notification Subscriptions are grouped based on specific contexts such as Agent Pools, Billing, Events, Incidents, Pathways, and Visualize. Below is a detailed breakdown of these variables.

=== 1. Agent Pools ===
These variables provide details about the affected agent pool:

* <code>'''agents'''</code>: Number of connected agents in the affected pool.
* <code>'''id'''</code>: ID of the affected pool.
* <code>'''name'''</code>: Name of the affected pool.

----

=== 2. Billing ===
Billing-related notifications are categorized as '''Invoice Created''' and '''Payment Received'''.

==== Invoice Created ====

* <code>'''charges'''</code>: Total amount of charges.
* <code>'''credits'''</code>: Total amount of credits applied to the invoice.
* <code>'''invoiceNumber'''</code>: Invoice number.
* <code>'''period'''</code>: Billing period (From - To dates).
* <code>'''url'''</code>: URL to view the invoice.

==== Payment Received ====

* <code>'''amount'''</code>: Total payment amount.
* <code>'''invoiceNumber'''</code>: Associated invoice number.
* <code>'''paymentNumber'''</code>: Payment number.
* <code>'''period'''</code>: Billing period.
* <code>'''transactionId'''</code>: Transaction ID from the financial system.
* <code>'''url'''</code>: URL to view the payment receipt.

----

=== 3. Events ===
Event notifications include the following variables:

* <code>'''data'''</code>: A data object passed from the source system. Use path expressions to access additional values.
* <code>'''description'''</code>: Optional descriptive text for the event.
* <code>'''labels'''</code>: A string map of label values for the event. Access values using path expressions.
* <code>'''name'''</code>: Name of the event.
* <code>'''severity'''</code>: Numeric severity level of the event (0-100).
* <code>'''url'''</code>: Optional URL passed from the source system.

----

=== 4. Incidents ===
Incident notifications are categorized as '''Event Correlated''' and '''Incident Created'''.

==== Event Correlated ====

* <code>'''category'''</code>:
** <code>'''id'''</code>: ID of the Incident Category.
** <code>'''name'''</code>: Name of the Incident Category.
* <code>'''event'''</code>: Object containing event information (see the "Events" section).
* <code>'''incident'''</code>:
** <code>'''events'''</code>: Number of events correlated in the incident.
** <code>'''id'''</code>: ID of the incident.

==== Incident Created ====

* <code>'''category'''</code>:
** <code>'''id'''</code>: ID of the Incident Category.
** <code>'''name'''</code>: Name of the Incident Category.
* <code>'''incident'''</code>:
** <code>'''id'''</code>: ID of the incident.

----

=== 5. Pathways ===
Pathways variables are tied to the "Send Notification" task within a Pathway.

* <code>'''data'''</code>: Data object containing fields defined in the "Send Notification" task. Values are accessible using path expressions.
* <code>'''path'''</code>:
** <code>'''id'''</code>: ID of the Pathway.
** <code>'''name'''</code>: Name of the Pathway.
* <code>'''text'''</code>: Text value defined in the "Send Notification" task.

----

=== 6. Visualize ===
Visualize variables relate to alerts and dashboards.

* <code>'''data'''</code>:
** <code>'''dashboard'''</code>: URL to the related dashboard.
** <code>'''labels'''</code>: String map of label values for the alert. Access values using path expressions.
** <code>'''panel'''</code>: URL to the related panel.
** <code>'''status'''</code>: Status of the alert (firing or resolved).
** <code>'''values'''</code>: Map of values for each expression in the alert rule. Access values using path expressions.
* <code>'''firing'''</code>: Boolean indicating if the alert status is firing.
* <code>'''labels'''</code>: String map of label values for the alert.
* <code>'''resolved'''</code>: Boolean indicating if the alert status is resolved.
* <code>'''url'''</code>: URL to view the related panel for the alert.

----

== Path Expressions ==
For variables containing objects or maps (e.g., <code>data</code>, <code>labels</code>), use path expressions to access nested values. For example:
<code><nowiki>{{data.someNestedValue}}</nowiki>
<nowiki>{{labels.labelKey}}</nowiki></code>
----

== Example Templates ==
Here are some example templates using the above variables and helpers:

=== Example 1: Agent Pool Notification ===
<code>The agent pool "<nowiki>{{name}}</nowiki>" currently has <nowiki>{{agents}}</nowiki> connected agents. Pool ID: <nowiki>{{id}}</nowiki>.</code>

=== Example 2: Invoice Notification ===
<code>An invoice (<nowiki>{{invoiceNumber}}</nowiki>) for the period <nowiki>{{period}}</nowiki> has been created. Total charges: <nowiki>{{charges}}</nowiki>. View it here: <nowiki>{{url}}</nowiki>.</code>

=== Example 3: Event Notification ===
<code>Event "<nowiki>{{name}}</nowiki>" occurred with severity <nowiki>{{severity}}</nowiki>. Description: <nowiki>{{description}}</nowiki>. More details: <nowiki>{{url}}</nowiki>.</code>
----By leveraging these expressions and variables, you can create highly customized and informative notifications tailored to your organization’s needs.
[[Category:Settings]]

Notification Subscription Templates - Revision history

Chris.Hansen at 18:21, 23 January 2025