Articles in this section

See more

Cross Module - Notification Tokens

Avatar
Jessica Peck
  • Updated
Follow

Overview

When creating notifications via the Notifications maintenance table you can edit and customize the content of the email subject and body.  These fields also support field replacement tokens {} that allow you to insert a field reference into the text that will dynamically pull content from the given document.

notification.jpg

The above proposal notification has numerous tokens utilized to insert information from that given record. For example, the {PROPOSAL_NUMBER} token will pull the proposal number within the specific record and automatically populate it in the sent notification.  All tokens must be within {} for them to work properly.

Below outlines the available tokens you can use in your notifications by the associated module.

Available Tokens

Generic Tokens (All Modules)

  • USER_FULLNAME
  • DOCHANDLER_PREFIX
  • RICE_SERVER_URL
  • APPLICATION_URL_PARM
  • APP_LINK_PREFIX

Note: You can use the APP_LINK_PREFIX to add a link directly to your document or it's route log from a notification.

  • This will add a link to the route log of the document the notification was sent from. This link will open without the Kuali Research Dashboard.
    • <a href="{APP_LINK_PREFIX}/kew/RouteLog.do?documentId={DOCUMENT_NUMBER}" target='_blank'>Approval History for this Document</a> 
  • This will add a link directly to the document the notification was sent from. This link will open without the Kuali Research Dashboard.
    • <a href="{APP_LINK_PREFIX}/kew/DocHandler.do?command=displayDocSearchView&docId={DOCUMENT_NUMBER}" target='_blank'>Review Full Document</a> 
  • This will add a link directly to the document the notification was sent from in the Kuali Research Dashboard. You must replace {Institution Subdomain} with the portion of your url unique to your institution and environment.
    • <a href="https://{Institution Subdomain}.kuali.co/dashboard/iframe?dest=https%3A%2F%2F{Institution Subdomain}.kuali.co%2Fres%2Fkew%2FDocHandler.do%3Fcommand%3DdisplayDocSearchView%26docId%3D{DOCUMENT_NUMBER}" target='_blank'>Review Full Document</a> 
  • This will add a link to a Proposal Development document with the Kuali Research Dashboard
    • <a href="{APP_LINK_PREFIX}/kc-common/development-proposals/{PROPOSAL_NUMBER}">{PROPOSAL_NUMBER}</a>
  • This will add a link to the most recent version of an Institutional Proposal with the Kuali Research Dashboard
    • <a href="{APP_LINK_PREFIX}/kc-common/proposals/{PROPOSAL_NUMBER}" target="_blank">{PROPOSAL_NUMBER}</a>
  • This will add a link to the most recent version of an Award with the Kuali Research Dashboard
    • <a href="{APP_LINK_PREFIX}/kc-common/awards/{AWARD_NUMBER}" target="_blank">{AWARD_NUMBER}</a>
  • This will add a link to the most recent version of an Subaward with the Kuali Research Dashboard
    • <a href="{APP_LINK_PREFIX}/kc-common/subawards/{SUBAWARD_ID}" target="_blank">{SUBAWARD_ID}</a>
  • This will add a link to a Negotiation document with the Kuali Research Dashboard
    • <a href="{APP_LINK_PREFIX}/kc-common/negotiations/{NEGOTIATION_ID}" target="_blank">{NEGOTIATION_ID}</a>

Supplemental Data Tokens (All Modules)

You can pull data from Supplemental Data in all modules as tokens in a system notification.  To include you need the following format of {SUPP_INFO_1} where the number at the end correlates to the ID for the field in the Custom Attribute maintenance table.  It will pull the value from the module you are sending the notification; even if that Custom Attribute is in several different modules.  Attributes with multiple values will display all values comma-separated.  If the Supplemental Data is pointed to an Arg Value Lookup it will use the same display logic in the notification token as is set up in the ARG_VALUE_VALUES_FINDER_DEFAULT_CONFIG parameter.

More information on configuration required for Supplemental Data can be found in the Cross Module - Supplemental Information Fields article.

Questionnaire Tokens (Proposal Development)

You can pull data from Questionnaire responses in the proposal as tokens in a system notification.  To include you need the following format of {QUESTION_10001} where the number at the end correlates to the Question ID from the Question maintenance table of the desired question you want to insert.  Questions with multiple values will display all values comma-separated. 

More information on configuration required for Question/Questionnaire can be found in the Maintenance - Create a Question and Maintenance - Create a Questionnaire articles. Please note that these tokens can only be used with General Questionnaires, not Person Certification Questionnaires. 

Proposal Development Tokens

  • DOCUMENT_NUMBER
  • PROPOSAL_NUMBER
  • PROPOSAL_TITLE
  • PRINCIPAL INVESTIGATOR
  • SPONSOR_CODE
  • SPONSOR_NAME
  • SPONSOR_TYPE
  • START_DATE
  • END_DATE
  • PROGRAM_ANNOUNCEMENT_NUMBER
  • PROGRAM_ANNOUNCEMENT_TITLE
  • CFDA_NUMBER
  • DEADLINE_DATE
  • PI_NAME
  • LEAD_UNIT
  • LEAD_UNIT_NAME
  • PRIME_SPONSOR_CODE
  • PRIME_SPONSOR_NAME
  • INSTITUTIONAL_PROPOSAL_NUMBER
  • INSTITUTIONAL_PROPOSAL_DOC_NBR
  • OVERRIDE_FIELD_NAME
  • OVERRIDE_FIELD_VALUE
  • NARRATIVE_MODULE_NUM
  • NARRATIVE_TYPE
  • NARRATIVE_MODULE_DESCRIPTION
  • USER_NAME - typically used in person certification notifications since it's user specific.
  • OTHER_ORGANIZATIONS - a comma separated list of organization names.
  • APPLICANT_ORGANIZATION
  • PERFORMING_ORGANIZATION
  • PERFORMANCE_SITES - a comma separated list of organization names
  • USER_FULL_NAME - typically used in person certification notifications since it's user specific.
  • USER_FULL_NAME_ORGS - typically used in person certification notifications since it's user specific; pulls Person full name and their "Home Unit" number (if present).
  • PI_NAME_ORGS* - Person full name and “Home Unit” number (if present) with role of PI.
  • MPI_NAM_ORGS* - a comma separated list of Person(s) full name and “Home Unit” number (if present) with role of MPI.
  • COI_NAME_ORGS* - a comma separated list of Person(s) full name and “Home Unit” number (if present) with role of COI.
  • KP_NAME_ORGS* - a comma separated list of Person(s) full name and “Home Unit” number (if present) with role of KP.

    *can be any preface based on the Proposal Award Person Role table ID

Institutional Proposal Tokens

  • PROPOSAL_NUMBER
  • PROPOSAL_TITLE
  • PI_NAME
  • PROTOCOL_NUMBER
  • LEAD_UNIT
  • LEAD_UNIT_NAME
  • SPONSOR_CODE
  • SPONSOR_NAME
  • ACTIVITY_TYPE_CODE
  • ACTIVITY_TYPE_NAME
  • DEADLINE_DATE
  • DEADLINE_TIME
  • CFDA_NUMBER
  • CFDA_NUMBER

Award Tokens:

  • AWARD_NUMBER
  • SEQUENCE_NUMBER
  • AWARD_TITLE
  • AWARD_TYPE_CODE
  • PI_NAME
  • LEAD_UNIT
  • LEAD_UNIT_NAME
  • ACCOUNT_NUMBER
  • SPONSOR_AWARD_NUMBER
  • STATUS_CODE
  • STATUS_NAME
  • BEGIN_DATE
  • EXECUTION_DATE
  • EFFECTIVE_DATE
  • SPONSOR_CODE
  • SPONSOR_NAME
  • SPONSOR_TYPE
  • FINAL_EXPIRATION_DATE
  • OBLIGATION_EFFECTIVE_DATE
  • OBLIGATION_EXPIRATION_DATE
  • OBLIGATED_TOTAL_AMOUNT
  • ANTICIPATED_TOTAL_AMOUNT
  • PRIME_SPONSOR_CODE
  • PRIME_SPONSOR_NAME
  • PRIME_SPONSOR_TYPE
  • PROTOCOL_NUMBER
  • ACTIVITY_TYPE_CODE
  • ACTIVITY_TYPE_NAME
  • ACCOUNT_TYPE_CODE
  • ACCOUNT_TYPE_NAME
  • AWARD_NOTICE_ID
  • AWARD_NUMBER
  • DOCUMENT_NUMBER
  • COMMENTS*
  • AWARD_TRANSACTION_TYPE_CODE
  • AWARD_TRANSACTION_TYPE_NAME

*COMMENTS is only applicable to Award Report Tracking notifications - this is the Comments field in each report row in the Reports panel of the Payment, Reports, and Terms tab of the Award.  Also, any token for Award Report Tracking notifications must be within the `{BEGIN_REPEAT_SECTION}` and `{END_REPEAT_SECTION}' tags.

Negotiation Tokens

  • NEGOTIATION_ID
  • NEGOTIATOR
  • NEGOTIATION_STATUS
  • ANTICIPATED_START_DATE
  • START_DATE
  • END_DATE
  • TITLE
  • PI
  • LEAD_UNIT_NUMBER
  • LEAD_UNIT_NAME
  • SPONSOR_NAME
  • SPONSOR_CODE
  • PRIME_SPONSOR_NAME
  • PRIME_SPONSOR_CODE
  • DOCUMENT_NUMBER

Subaward Tokens

  • SUBAWARD_ID
  • SEQUENCE_NUMBER
  • SUBAWARD_TITLE
  • LEAD_UNIT
  • LEAD_UNIT_NAME
  • ACCOUNT_NUMBER
  • STATUS_CODE
  • STATUS_NAME
  • BEGIN_DATE
  • USER_FULLNAME
  • DOCUMENT_NUMBER

Related articles

Comments

0 comments

Article is closed for comments.