How to Use Piping Variables

Sarah Paterson -

Piping Variables are an extremely useful tool to use in your site. They can be used in both Forms and Emails. Piping Variables allow you to customize the text based on the user accessing the form or receiving the email.

There are Basic Information variables that are the consistent across all FluidReview sites, you can use the charts below to identify the Basic variables that can be used in your emails and forms. 

In this Article...

Basic Form Variables

Object Variable This will pipe...
Current date {{ date }} The current date that the form is being accessed
Submission title {{ submission }} The submission title as defined in the General Settings of the site. Please see the Reference Identifier section in the following documentation: Submission Tab
Submission ID {{ submission.id }} A unique ID number as set by FluidReview. Submission IDs are unique across all FluidReview sites
Submission group {{ submission.group }} The group the submission is in
Submission round {{ submission.round }} The round the submission is currently in
Submission reference ID {{ submission.reference_id }} A unique ID as set by the administrators in the General Settings of the site. Please see the Reference Identifier section in the following documentation: Submission Tab
Submission's categories {{ submission.categories }} The submission categories that the submission is in
Submittal date {{ submission.date_submitted }} The date the submission was most recently submitted 
Submission creation date {{ submission.created_at }} The date the submission was originally created 
Actor's first name {{ user.first_name }} The first name of the user that is accessing the form. NOTE: If you are accessing the form as an administrator this will pipe in your information. If this is a variable in your form, ensure that you are making any changes to the form while assuming the role of the user
Actor's last name {{ user.last_name }} The last name of the user accessing the form. NOTE: If you are accessing the form as an administrator this will pipe in your information. If this is a variable in your form, ensure that you are making any changes to the form while assuming the role of the user
Actor's email {{ user.email }} The email address of the user accessing the form. NOTE: If you are accessing the form as an administrator this will pipe in your information. If this is a variable in your form, ensure that you are making any changes to the form while assuming the role of the user
Applicants's first name {{ applicant.first_name }} The first name of the applicant the form belongs to
Applicant's last name {{ applicant.last_name }} The last name of the applicant the form belongs to
Applicant's email {{ applicant.email }} The email address of the applicant the form belongs to
Award Title {{ award }} The title of the award the submission is currently applied to

Return to Top

Basic Trigger Email Variables

Object Variable This will pipe...
Current date {{ date }} The current date that the email is being sent
Current time {{ time }} The current time that the email is being sent
Who activated the trigger {{ actor }} The first and last name of the person that activated the trigger, this could be the applicant that completed a task, the recommender completing the recommendation, or the reviewer that completed their ranking. 
Submission title {{ submission }} The submission title as defined in the General Settings of the site. Please see the Reference Identifier section in the following documentation: Submission Tab
Submission ID {{ submission.id }} A unique ID number as set by FluidReview. Submission IDs are unique across all FluidReview sites
Applicant's first name {{ user.first_name }}

The first name of the owner of the submission.

NOTE: Contrary to the same variable used in forms, the "User" refers to the applicant. If completing actions as an Admin the applicants name will be piped into the email. If the activation of the trigger is based on a Reviewer form completion, the name of the owner of the submission will be piped. Use {{ actor }} if you are looking to pipe reviewer information.

Applicants's last name {{ user.last_name }}

The flast name of the owner of the submission.

NOTE: Contrary to the same variable used in forms, the "User" refers to the applicant. If completing actions as an Admin the applicants name will be piped into the email. If the activation of the trigger is based on a Reviewer form completion, the name of the owner of the submission will be piped. Use {{ actor }} if you are looking to pipe reviewer information.

Applicants's email {{ user.email }}

The email address of the owner of the submission.

NOTE: Contrary to the same variable used in forms, the "User" refers to the applicant. If completing actions as an Admin the applicants email address will be piped into the email. If the activation of the trigger is based on a Reviewer form completion, the email of the owner of the submission will be piped. Use {{ actor }} if you are looking to pipe reviewer information.

Submission group {{ submission.group }} The group the submission is in
Submission round {{ submission.round }}

The round the submission is currently in

Submission reference ID {{ submission.reference_id }} A unique ID as set by the administrators in the General Settings of the site. Please see the Reference Identifier section in the following documentation: Submission Tab
Submission's categories {{ submission.categories }} The submission categories that the submission is in
Submittal date {{ submission.date_submitted }} The date the submission was most recently submitted 
Submission creation date {{ submission.created_at }} The date the submission was originally created 
Submission last edited date {{ submission.last_edited }} The date the submission was last edited and saved
Submission status {{ submission.status }} The current status of the submission. The status could be Active, Archived, Deleted, Withdraw, In Progress, Complete, Awarded or Rejected.
Submission locked (Yes/No) {{ submission.locked }} A Yes or No response as to whether the submission is locked from editing
Submission submitted (Yes/No) {{ submission.submitted }} A Yes or No response as to whether the submission has been submitted or not
Award title {{ award }} The name of the award the submission has applied to
Trigger name {{ trigger }} The name of the trigger that the email is a part of.
Login URL {{ reviewroom_url }} A unique URL that will allow the user to sign in or sign up based on whether or not they have registered for FluidReview yet. 
Transaction Allocated {{ transaction.allocated }}

This piping variable can be piped into trigger emails to display the total amount that the submission has been allocated. For more information on this feature, please see: Funding Awards and Distributing Funds

NOTE: In order for this variable to pipe into the email correctly you will need to use the Trigger Activation "Submissions: Award transaction has been approved."

Installment Distributed {{ installment.distributed }}

This piping variable can be piped into trigger emails to display the installment amount that you are currently distributing to the submission. For more information on this feature, please see: Funding Awards and Distributing Funds

NOTE: In order for this variable to pipe into the email correctly you will need to use the Trigger Activation "Submissions: Award transaction has been approved."

You also have the ability to pipe Metadata and Form responses from an applicant form into another applicant form or a reviewer form. However, these variables will be unique to your site and can be accessed within the specific Email and Form tools.  

Return to Top 

RELATED ARTICLES

 

Have more questions? Submit a request

0 Comments

Article is closed for comments.