User E-mail Template Tags

The e-mail template tags below can only be used in browser e-mail templates; in addition, Base template tags can be used in all e-mail templates. Base template tags are discussed in Base Global Template Tags and Base Item Template Tags.

$FILEATTACHMENTLINKS()

  • Description

    This tag adds links to files attached to items associated with the e-mail message.

  • Usage

    For HTML e-mail templates, users can click the links to open the attachments. For e-mail templates formatted as text, the URL to the attachment on the Web server is provided. Users can copy and paste this tag into a browser address bar to open the attachment. Links to file attachments only appear in the e-mail message if users have permissions to view those attachments in the associated item.

  • Parameters

    Use the optional parameter external to link to attachments in an external instance of your system.

  • Sample
    The attached images display the reported issue. $FILEATTACHMENTLINKS(external).

    Result:

    The attached images display the reported issue. File Attachment(s):
    
    image1:
    http://servername/tmtrack/tmtrack.dll?AttachmentPage&AttachmentId=45

$ITEMNUMBER()

  • Description

    For primary items, this tag provides the prefix and ID number of the item associated with the e-mail. For auxiliary items, this tag inserts the singular item name and a description of the item.

  • Usage

    Use this tag to include the singular item name. The singular item name is defined in SBM Composer and can be viewed on the General tab of the Edit Table dialog box for the applicable auxiliary table.

  • Parameters

    None.

  • Sample
    $BEGINSUBJECT()$USERSUBJECT()$TTID()$ENDSUBJECT()$STRING(IDS_EMAIL_NOTEFROM)$SENTBY()
    $STRING(IDS_EMAIL_ABOUT)$ITEMNUMBER()

    Result:

    Note from Administrator about BUG000173 [ttid: 1000,109]

$ITEMTYPENAME()

  • Description

    This tag inserts the singular item name of the primary or auxiliary item.

  • Usage

    This name is provided in SBM Composer and can be viewed on the General tab of the Edit Table dialog box for the applicable primary or auxiliary table.

  • Parameters

    None.

  • Sample
    $STRING(IDS_EMAIL_TOVIEW) $ITEMTYPENAME(): $LINK()

    Result:

    To View Issue: 
    http://servername/tmtrack/tmtrack.dll?View&I=109&T=1000

$TTID()

  • Description

    This tag inserts the [ttid: table ID, record ID] identifier required by the E-mail Recorder feature, which attaches e-mail messages sent from an external e-mail client to the item from which they were sent.

  • Usage

    By default, the $TTID() tag is enclosed by the $BEGINSUBJECT() and $ ENDSUBJECT() base template tags in the default.txt user e-mail template. If the E-mail Recorder is not configured, this tag is ignored. For details on the E-mail Recorder, refer to the SBM Installation and Configuration Guide.

  • Parameters

    None.

  • Sample
    $BEGINSUBJECT()$USERSUBJECT()$TTID()$ENDSUBJECT()$STRING(IDS_EMAIL_NOTEFROM)$SENTBY()
    $STRING(IDS_EMAIL_ABOUT)$ITEMNUMBER()

    Result:

    Note from Administrator about BUG000173 [ttid: 1000,109]

$USERSUBJECT()

  • Description

    This tag provides the text in the Subject box of the Send E-mail dialog box.

  • Usage

    To insert the text into the Subject line of the message, it must be enclosed by the $BEGINSUBJECT() and $ENDSUBJECT() base template tags discussed in Base Global Template Tags.

  • Parameters

    None.

  • Sample
    $BEGINSUBJECT()$USERSUBJECT()$TTID()$ENDSUBJECT()$STRING(IDS_EMAIL_NOTEFROM)$SENTBY()
    $STRING(IDS_EMAIL_ABOUT)$ITEMNUMBER()

    Result:

    Note from Administrator about BUG000173 [ttid: 1000,109]

$USERBODY()

  • Description

    This tag inserts the text provided by the user in the Message box of the Send E-mail dialog box into the body of the message.

  • Usage

    Include this tag to see the body of the e-mail message.

  • Parameters

    None.

  • Sample
    $BEGINSUBJECT()$USERSUBJECT()$TTID()$ENDSUBJECT()$STRING(IDS_EMAIL_NOTEFROM)$SENTBY()
    $STRING(IDS_EMAIL_ABOUT)$ITEMNUMBER()
    
    $USERBODY()
    
    $STRING(IDS_EMAIL_TOVIEW) $ITEMTYPENAME(): $LINK()

    Result:

    note from Administrator about BUG000173
    
    Hi, Bill.  Can you please assign this issue to me?  Thanks, Carmen.
    
    To View Issue: 
    http://or-pu-en2k8x32/tmtrack/tmtrack.dll?View&I=109&T=1000