Skip to main content

Notification Variables

  • Updated

This article lists and describes the variables available in OnePlan Notifications.

Important

OnePlan notification customization was designed to allow end users to put their own custom message into the out of the box notifications, rather than being an open notification workflow.

Notification settings are available in the Config pages > General > Notifications.

Global Variables

These variables are global variables that 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 use the following variables as well:

  • {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 names from the specified plan.

Notification Specific Variables

Important

These variables are only available in the out of the box notifications. They can only be used in the notifications that they exist in out of the box. These variables cannot be used in other notifications. This information is included in this article so you can better understand how the out of the box notifications work.

Note

Even though the following variables are locked into their specific notifications, you can still customize the message text for the notifications.

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 that are 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 time off category for a time off request.

  • {Start}: Populates with time off start date for a time off request.

  • {End}: Populates with 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.

Satus 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.

Related articles

Comments

0 comments

Article is closed for comments.