Mitchell.Hirsche: Mitchell.Hirsche moved page Documentation for the "Send Notification" Node in Pathways to Send Notification Node in Pathways

2025-03-05T23:06:21Z

Mitchell.Hirsche moved page Documentation for the "Send Notification" Node in Pathways to Send Notification Node in Pathways

← Older revision

Revision as of 23:06, 5 March 2025

Mitchell.Hirsche: Send Notification

2025-03-04T23:28:20Z

Send Notification

New page

The '''Send Notification''' node in FojiSoft Pathways facilitates sending dynamic and automated notifications to configured recipients. It supports multiple communication channels and content customization options, making it a flexible tool for integrating messaging into workflows.
----

=== '''Node Properties''' ===

==== '''1. Name''' ====

* '''Description''': A unique identifier for the node within the workflow.
* '''Usage''': Provide a clear and descriptive name to reflect the purpose of the notification (e.g., "Alert on Claim Status Change" or "Notify Staff on Task Completion").
* '''Example''': '''"Notify Patient of Invoice Readiness"'''

----

==== '''2. Text''' ====

* '''Description''': Specifies the notification type and defines how the content will be generated.
* '''Options''':
** '''Communication Type''':
*** '''Email''': Sends an email to designated recipients.
*** '''SMS''': Sends a text message to configured phone numbers.
*** '''Push Notification''': Sends a push notification to connected devices.
** '''Content Creation''':
*** '''Handlebar Template''': Allows dynamic content generation using placeholders (e.g., <nowiki>{{variable_name}}</nowiki>).
*** '''Script''': Enables advanced logic for generating notification content using a scripting language (e.g., Python or JavaScript).
* '''Example''':

'''Handlebar Template''':

Dear <nowiki>{{PatientName}}</nowiki>, your claim status is <nowiki>{{ClaimStatus}}</nowiki>. Please contact us for further details.

'''Script''':

if claim_status == "Approved":

return f"Dear {patient_name}, your claim for {claim_amount} has been approved."

else:

return f"Dear {patient_name}, your claim for {claim_amount} has been rejected."

* '''Usage''':
** Choose '''Handlebar Template''' for simple, straightforward dynamic content.
** Use '''Script''' for complex conditional logic or custom formatting.

----

==== '''3. Data Values''' ====
The '''Data Values''' section allows you to define the variables used to populate the notification content dynamically.

# '''Name'''
#* '''Description''': Assigns a name to each data value that will be injected into the notification content.
#* '''Usage''': Use clear names, such as PatientName, ClaimStatus, or InvoiceAmount, to clarify their roles in the notification.
# '''Expression'''
#* '''Type''': Handlebar Template or Script
#* '''Options''':
#** '''Handlebar Template''': Define the value of the variable using placeholders or simple text.

'''Example''':

<nowiki>{{PatientName}}</nowiki>

* '''Script''': Write logic to define or calculate the value dynamically.

'''Example''' (Script):

return f"{patient_name} - Claim Status: {claim_status}"

# '''Expression Field''':
#* '''Description''': The actual value or logic that determines the variable's value.
#* '''Status''': Required.
#* '''Example''':

'''Handlebars''':

Your invoice for <nowiki>{{InvoiceAmount}}</nowiki> is ready to be downloaded.

'''Script''':

if invoice_ready:

return f"Dear {patient_name}, your invoice for {invoice_amount} is ready for download."
----

=== '''How It Works''' ===

# '''Select Notification Type''':
#* Choose the communication method (e.g., Email, SMS, or Push Notification).
# '''Define Content''':
#* Use '''Handlebar Template''' for simple placeholders or '''Script''' for complex logic to generate dynamic content.
# '''Map Data Values''':
#* Add necessary variables and their definitions (using templates or scripts) to populate the notification dynamically.
# '''Send Notification''':
#* When the workflow reaches this node, the notification is sent to the recipients with the dynamically generated content.

----

=== '''Use Case Examples''' ===

==== '''1. Claim Status Notification''' ====

* '''Name''': Notify Patient of Claim Status
* '''Text''':
** '''Type''': Email

'''Content''': Handlebar Template

Dear <nowiki>{{PatientName}}</nowiki>, your claim for <nowiki>{{ClaimAmount}}</nowiki> is <nowiki>{{ClaimStatus}}</nowiki>.

* '''Data Values''':
** '''Name''': PatientName
** '''Expression''': <nowiki>{{patient_name}}</nowiki>
** '''Name''': ClaimStatus
** '''Expression''': <nowiki>{{claim_status}}</nowiki>
* '''Outcome''': Sends an email to patients updating them on their claim status.

==== '''2. Task Completion Notification''' ====

* '''Name''': Notify Staff of Task Completion
* '''Text''':
** '''Type''': Push Notification

'''Content''': Script

return f"The task '{task_name}' was completed successfully at {completion_time}."

* '''Data Values''':
** '''Name''': TaskName
** '''Expression''': <nowiki>{{task_name}}</nowiki>
* '''Outcome''': Sends a push notification to the team about task completion.

----

=== '''Best Practices''' ===

# '''Select the Right Content Type''':
#* Use Handlebar Templates for quick, dynamic notifications.
#* Use Scripts for notifications requiring conditional logic or data manipulation.
# '''Test Notifications''':
#* Validate notification content and delivery settings before deploying.
# '''Be Concise''':
#* Keep notifications short and actionable for better user understanding.
# '''Dynamic Content''':
#* Leverage data values effectively to make notifications personalized and relevant.

----The '''Send Notification''' node is a versatile tool in Pathways, capable of sending real-time alerts with customizable content through dynamic templates or scripts. Its flexibility ensures effective communication in any automated workflow.
[[Category:ForgeAI]]
[[Category:Pathways]]

Send Notification Node in Pathways - Revision history

Mitchell.Hirsche: Mitchell.Hirsche moved page Documentation for the "Send Notification" Node in Pathways to Send Notification Node in Pathways

Mitchell.Hirsche: Send Notification