Base Item Template Tags

Base Item template tags can be used to customize templates used for e-mail submissions, notifications, and e-mails sent from items.

$FIELDVALUE()

  • Description

    Returns the value of a specified field without the field display name.

  • Usage

    Asterisks replace field values for users who do not have permission to view fields included in the message. Fields in the Not Used fields section are not included in the e-mail notification.

  • Parameters
    • FIELD_NAME - Insert the field display name or database field name between the parentheses. If you use the database field name, be sure to omit the TS_ prefix. If you want to return the value for a Sub-Relational field, use the field display name.
    • PROJECTID - Returns the name of the project in which the primary item associated with the e-mail message resides.
    • PROJECTID, FULL - Returns the full path of the project in which the primary item associated with the e-mail message resides.
    • USER_FIELD_NAME - For User and Multi-User fields, returns the name and a link to the e-mail address (HTML templates only) of the users associated with the field.
    • (USER_FIELD_NAME, NO_EMAIL) - For User and Multi-User fields, returns the name of the user associated with the field.
    • (JOURNAL_FIELD_NAME, 1) - For Journal fields, this displays the last comment in the specified Journal field. Use the second parameter to specify how many entries to include from the end of the Journal field.
      Important: If the second parameter is not specified, the contents of the entire Journal field are included.
  • Sample
    $FIELDVALUE(DOC_LEAD)
    <br>
    <br>
    $FIELDVALUE(PROJECTID)
    <br>
    <br>
    $FIELDVALUE(PROJECTID, FULL)
    <br>
    <br>
    $FIELDVALUE(SUBMIT_DATE)
    <br>
    <br>
    $FIELDVALUE(WRITER, NO_EMAIL)
    <br>
    <br>
    $FIELDVALUE(STATUS_LOG, 2)

    Result:

    image

$MAILHEADERPARAM()

$RECORDID()

  • Description

    Returns the database ID for the primary or auxiliary item to which the e-mail pertains.

  • Usage

    Useful for providing users with the internal identifier for specific items.

  • Parameters

    None.

$SYSFIELDNAME()

  • Description

    Returns the logical field name for specific system fields.

  • Usage

    Useful for providing a label in the message for system field names that may be different in various applications.

  • Parameters
    • TS_SYSFLD_TEXT_DISPLAYID - Returns the logical field name for the Item ID field.
    • TS_SYSFLD_TITLE - Returns the logical field name for the system Title field.
    • TS_SYSFLD_DESC - Returns the logical field name for the system Description field.
  • Sample
    <b>$SYSFIELDNAME(TS_SYSFLD_TEXT_DISPLAYID):</b> $FIELDVALUE(Item ID)
    <br>
    <br>
    <b>$SYSFIELDNAME(TS_SYSFLD_TITLE):</b> $FIELDVALUE(Title)
    <br>
    <br>
    <b>$SYSFIELDNAME(TS_SYSFLD_DESC):</b> $FIELDVALUE(Description)

    Result:

    image

$TABLEID()

  • Description

    Returns the database ID for the primary or auxiliary table to which the e-mail pertains.

  • Usage

    Useful for providing users with the internal identifier for specific tables.

  • Parameters

    None.