Direct Answer: What Are Notification Variables in OnePlan?
Notification variables in OnePlan are placeholders — written as {VariableName} — that you insert into a customized system notification's subject or message. When the notification is sent, OnePlan replaces each variable with the relevant dynamic value, such as the plan name, the sender's name, or a link back to the item being referenced.
What This Article Covers: Notification Variables
This article covers the global variables available in any notification, and the notification-specific variables that are locked to particular out-of-the-box notifications.
What you will accomplish
After reading this article, you will understand: what notification variables are and how they work | which global variables you can use in any notification | which variables are specific to certain notification types | how to use plan-level, work plan-level, and Stage Gate variables
Who This Article Is For: Notification Variables
This article is for OnePlan Admins and Group Owners who are customizing system notifications. See How to Manage System Notifications in OnePlan for how to open a notification's settings and apply these variables.
Why This Matters: Notification Variables
Personalizing Generic Notifications
Notification variables let you turn a generic out-of-the-box notification into one that speaks directly to the recipient — addressing them by name, naming the specific plan or task involved, or linking straight to the item that needs attention.
Important
OnePlan notification customization is designed to let you insert your own custom message into the out-of-the-box notifications, rather than functioning as an open notification-authoring workflow. You cannot create new notifications from scratch — see How to Manage System Notifications in OnePlan.
Understanding Notification Variables in OnePlan
Notification settings are available in the configuration pages under General > Notifications.
Global Variables
These variables can be included in any notification for customization purposes.
- {SiteUrl} — Populates with the URL for your OnePlan environment.
- {ConfigId} — Populates with the configuration ID for your OnePlan environment.
- {From.Name} — Populates with the user name of the notification sender.
- {From.Email} — Populates with the user email of the notification sender.
- {To.Name} — Populates with the user name of the notification receiver.
- {To.Email} — Populates with the user email of the notification receiver.
- {Now} — Populates with the current date.
- {NotificationId} — Populates with the notification ID.
If a specific plan is included in a notification, you can also use:
- {Plan.Name} — Populates with the name of the specified plan.
- {Plan.Id} — Populates with the ID of the specified plan.
- {Plan.Url} — Populates with the URL of the specified plan.
- {Plan.[Field]} — Populates with field values from the specified plan.
Notification-Specific Variables
Note: These variables are only available in the out-of-the-box notifications they exist in by default — they cannot be used in other notifications. This section is included so you can better understand how the out-of-the-box notifications work. Even though these variables are locked to their specific notifications, you can still customize the surrounding message text.
Task Notification Variables
- {TaskName} — Populates with the name of the task the notification is referencing.
- {TaskList} — Populates with a list of tasks that have not been updated.
- {Comment} — Populates with the latest comment made on a task or resource plan that the notification is referencing.
Resource Notification Variables
- {Resources} — Populates with a list of resources requested for a given plan.
- {Comment} — Populates with the latest comment made on a task or resource plan that the notification is referencing.
Time Off Notification Variables
- {Category} — Populates with the time off category for a time off request.
- {Start} — Populates with the time off start date for a time off request.
- {End} — Populates with the time off end date for a time off request.
- {Notes} — Populates with any notes included with a time off request or timesheet submission.
Timesheet Notification Variables
- {Period} — Populates with the timesheet period referenced by the notification.
- {PeriodList} — Populates with a list of timesheet periods that do not have any hours logged, or have unsubmitted time.
- {Notes} — Populates with any notes included with a time off request or timesheet submission.
Status Report Notification Variables
- {ReportLink} — Populates with a link to the referenced status report.
- {PlanList} — Populates with a list of plans that have status reports available.
- {Comments} — Populates with the latest comment made on status report approval or rejection.
Plan-Level Notification Variables
- {PlanNotificationBody} — Displays the message text defined in the plan notification settings.
- {PlanNotificationTable} — Displays a table of fields selected in the plan notification settings.
Note: Plan-level notifications are configured through the standalone Plan Notifications interface today, but that interface is being removed in an upcoming release in favor of Plan Automations' Send Notification action. See How to Create and Manage Plan-Level Notifications in OnePlan.
Work Plan Notification Variables
- {WorkPlanNotificationBody} — Displays the message text defined in the work plan notification settings.
- {WorkPlanNotificationTable} — Displays a table of fields selected in the work plan notification settings.
Note: Work plan notifications are now configured through a Work Plan Automation's Send Notification action — see How to Configure a Send Notification Action for Work Plan Automations in OnePlan.
Stage Gate Notification Variables
- {StageGatesApprovalNotificationBody} — Displays the message text defined in the Stage Gate approval notification settings.
- {StageGatesApprovalNotificationFieldList} — Displays a table of fields selected in the Stage Gate notification settings.
- {StageGatesRejectionNotificationBody} — Displays the message text defined in the Stage Gate rejection notification settings.
- {StageGatesRejectionCommentsTable} — Displays the comments added by the Stage Gate reviewer(s) upon stage rejection.
See How to Configure Stage Gate Approvals for how these are configured.
Frequently Asked Questions: Notification Variables
Q: Can I use any notification variable in any notification?
A: In OnePlan, no. Global variables like {SiteUrl} and {From.Name} work in any notification, but notification-specific variables (such as {TaskName} or {ReportLink}) only work in the out-of-the-box notifications they already appear in by default.
Q: Can I create a custom notification from scratch using these variables?
A: In OnePlan, no. Notification customization lets you insert your own message and variables into an existing out-of-the-box notification — it is not an open notification-authoring workflow. See How to Manage System Notifications in OnePlan.
Q: Where do I go to use these variables?
A: In OnePlan, go to the configuration pages under General > Notifications, select a notification, and check Select to use custom notification to edit its subject and message with these variables.
Q: What does {Plan.[Field]} mean?
A: In OnePlan, this represents any field on the specified plan — replace [Field] with the actual field name to populate that field's value into the notification.
What to Do Next: Notification Variables
Apply these variables:
Configure the features behind plan-level, work plan, and Stage Gate variables:
Comments
0 comments
Article is closed for comments.