Transmittal variables

Adding custom Date and Time format strings to date-based variables

When using a date-based variable, you can add custom format strings to the variable to customize how the date and time will appear in the cover letter. Here are some examples:

If you want the cover letter to include the date that responses for the transmittal are due, use this variable in your cover letter template:

{$Transmittal.ResponseDueDate$}

This and other date-based variables use the (yyyy MMMM dd h:mm tt) date and time format string by default, which automatically renders the date in this format: 2020 June 08 12:55 PM

If you want to customize the way the date and time appears for that variable, you would insert the date and time format string that matches your culture into the variable. For example, use this format if you want to display the date as month-day-year:

{$Transmittal.ResponseDueDate(MMMM dd yyyy h:mm tt)$}

Or, use this format if you want to display the date as day-month-year:

{$Transmittal.ResponseDueDate(dd MMMM yyyy h:mm tt)$}

If you want to add the time zone to the date variable, you need to add the "K" format specifier which generates the UTC (GMT) offset time:

{$Transmittal.ResponseDueDate(yyyy MMMM dd h:mm tt "(UTC"K")")$}

The UTC offset time is the number of hours ahead of or behind UTC/GMT. When configuring the format string you can type either UTC or GMT, whichever you prefer. If the response due date occurs in a time zone that is 5 hours behind UTC, the variable and format string above would render the date in this format: 2020 June 08 12:55 PM UTC-05:00

Adding a custom date and time format string to a date-based document attribute variable is slightly different:

{$DocumentAttribute.GetValue(attribute name, yyyy MMMM dd h:mm tt "(GMT"K")")$}

For details about using custom date and time format strings, see the following Microsoft article: https://msdn.microsoft.com/en-us/library/8kb3ddd4(v=vs.110).aspx

Document variables

Document attribute variables

Depends on the attributes configured in the portal settings. Below are only examples.

Reference document variables

Reference document attribute variables

Depends on the attributes configured in the portal settings. Below are only examples.

Transmittal recipient variables

Folder variables

Work area property variables

You can use custom work area properties in transmittal cover letters.

When inserting variables into the cover letter template, use this format:

{$ProjectAttribute.GetValue(customworkareapropertyname)$}

For example:

{$ProjectAttribute.GetValue(Project Name)$}

Repeater variables