Advanced Template Features

Format number function provides formatting numbers without having to create formula fields. Only the following EXACT patterns/values are supported for a number format:

#,###.##  (Typical Currency with cents)

#,###     (Comma delimited whole number)

#.###     (EU formatting)

#.###,##

{{!Opportunity.amount #,###.##}}

43222300.8 ➤ 4,222,300.80

{{!Opportunity.amount #,###}}

43222300.8 ➤ 4,222,301

{{!Opportunity.amount #.###}}

43222300.8 ➤ 4.222.301

• Larger numbers will still follow the pattern even if they exceed the 4 digits shown in the pattern. Rounding is applied when precision exceeds formatting.
• If you need to include a currency symbol, you can add it just before the merged field. E.g . ${{!Opportunity.amount #.###}}

Format date allows Salesforce date and datetime fields to be formatted into any valid java pattern.

{{!opportunity.createdDate MM/dd/yyyy}}

2018-10-28 ➤ 04/04/2017

{{!opportunity.createdDate MMMMM}}

2018-10-28 ➤ October

{{!opportunity.datetime__c MM/dd/yy hh:mm:ss TZ:America/New_York}}

2018-10-28 ➤ 10/28/2018 12:56:32 EST

• Patterns are case sensitive. E.g. MM=month while mm=minutes. Reference to available patterns.

• Times are formatted per the database time (GMT).
• Time zones must be written using Java time codes.
• Only Salesforce-supported time zones are accepted.
• Long descriptions (e.g. Month, day of week) are in English. You can use formula fields if needed to meet a specific requirement.

The checkbox attribute allows you to map checked/unchecked checkbox images to boolean fields.

{{!opportunity.checkbox__c checkbox="true"}}

Displays a checkbox with a dotted white border; includes a black checkmark if checked.

{{!opportunity.checkbox__c checkbox="black"}}

Displays a checkbox with a solid black border; fills in with black and includes a white checkmark if checked.

{{!opportunity.checkbox__c checkbox="radio"}}

Displays a radio button.

• When this attribute is added, the merge field will display as the checkbox in its current state on the record once the document is generated.

MICR E-13B font (Magnetic Ink Character Recognition) is used for banking and more specifically for generating checks.

{{!Check__c.RoutingNumber__c MICR="11"}}

To adjust spacing between MICR characters:

{{!Opportunity.Description MICR="[FONTSIZE (REQUIRED)],[SPACING (OPTIONAL)]"}}
e.g.
{{!Opportunity.Description MICR="20"}}
{{!Opportunity.Description MICR="20,-5"}}

{{!Opportunity.Description MICR="20,5"}}

• The output is a series of images that can be used in PDF generation of checks. Only digits and ‘t,’ ’o,' ’a,’ ’d,’ are transformed. Other characters are ignored.
• The number following MICR represents the font width. E.g.  MICR="16" will be larger than MICR="8".

• Spacing defaults to 0 if it is not specified. As shown, negative spacing values are allowed. The lower the spacing value, the closer together MICR characters.

Transforms data to all uppercase characters.

{{!contact.billingStreet ToUpperCase="true"}}

123 Main Street, Apt 3 ➤ 123 MAIN ST, APT 3

Transforms data to all lowercase characters.

{{!contact.billingStreet ToLowerCase="true"}}

123 MAIN ST, APT 3 ➤ 123 Main Street, Apt 3

Reverses the character string in the output. This is useful for RTL languages like Hebrew when generating to a PDF.{{!account.greeting__c RTL="true"}}

שלום➤ םולש

• Using the RTL merge field attribute will transform merge field data only, not static text.
• To apply RTL for both merge fields and static text,  use the following style in the template source:

<rtl>reverse</rtl>

• When using <rtl> tags, there is no need to add the RTL attribute to your  merge fields. You can wrap an entire template in <rtl> tags to transform both merge field data and static text.
• Note that <rtl> tags will not work properly with text that breaks across two lines in the generated document. You should use separate <rtl> tags for each line if text breaks across two lines.

Uses Salesforce Translation Workbench feature to return the picklist value based on the users locale/language. settings{{!product2.color translate="true"}}

BLUE ➤ BLEU

• This feature leverages Salesforce toLabel() function within a SOQL query. It is particularly useful for orgs that have Translation Workbench enabled. Translate keyword will cause an error if used on field types that do not support toLabel().

Translate can be used only on fields and field labels.

• For related list translations, or lookup fields, you should use direct SOQL query. If you set the class to "none" then only the data is returned – not in a table format.  Here is an example usage from the S-Docs template source:

<!--{{!
<LineItemsSOQL>
<class>none</class>
<soql>Select tolabel(color__c) From product2 where id='{!ObjectID15}' and toLabel(color__c) =’BLEU’</soql>
<column>color__c</column>
</LineItemsSOQL>
}}-->

• Additionally, for fields merged within related lists, you may find the substitute column attribute feature useful.

The Display attribute will render picklist field values as the field value (the value shown to users on records). By default, S-Docs renders the field value API name.

{{!Opportunity.PicklistField__c Display="true"}}

• In most cases, picklist field values are identical to their API names. This attribute covers instances when the two differ.

The msnl attribute will replace the semicolons between values from a multi-select picklist with new lines.

{{!Opportunity.Multi_Select_Picklist_Field__c msnl="true"}}

The breakeverynchars attribute will insert a line break after the character number that you specify

{{!Opportunity.Long_Field__c breakeverynchars="10"}}

This Is A Long Field Of Text ➤ This Is A
Long Field
Of Text

• Negative, zero, or blank values will not insert any line breaks.

Allows for replacing values with other values whenever a match is made. It checks the value against a series of values. If it is equal to a value, it returns the corresponding  result. If it does not match, no substitution is made unless a final catch-all value is provided in the list.

Substitute functionality can be useful for translating values to different languages for a template. While you may be able to do the same using a Salesforce formula field, this can drastically reduce the number of formula fields you would need to create.

<column substitute=" value1tomatch, value1ToSubstitute, value2ToMatch,Value2ToSubstitute,

…,

OptionalCatchall-substitution">Field__c

</column>

If the substitute list contains an odd number of values, then the last value will be the catch-all that is substituted when no matches are made.

• Substitute a checkbox for German language. values:substitute="true,Ja,false,nien"
• Matches are made ignoring case sensitivity and white spaces are trimmed, but the substitute values are exact.
• For checkbox fields use true and false as the value to match on.
• For organization purposes you can optionally use parenthesis to organize your list, e.g.:

substitute= " (1,one),(2,two),(3,three)"

• If your value is null, you should not
  use the substitute attribute but rather use the  nullprefix= attribute that will
  allow you to insert a value whenever null data is encountered for that field.
• If you are matching a numeric value, the precision needs to also match.

<column substitute "2.00,2">quantity</column>

• Example:  Use Substitute feature to correctly display the full month Name of field that contains the month number:

<column substitute="1, Januar,
2, Februar,
3, März,
4, April,
5, Mai,
6, Juni,
7, Juli,
8, August,
9, September,
10,Oktober,
11,November,
12,December,
unknown">MonthNumber__c</column>

Allows for replacing values with other values. This is very similar to the substitute feature, with the following two exceptions:

1) substitute matches against (and replaces) the ENTIRE string, where as replaceall matches against (and replaces) all substring appearances of the specified string.   

2) There is no "else" condition in replaceall (since we're replacing substrings, an "else" condition would be nonsensical)

This attribute supports regexs.

<column replaceall="replaceThis1,replaceWithThis1,replaceThis2,replaceWithThis2,...replaceThisN,replaceWithThisN">

Regex Syntax: start your replaceall string      with [regex] (including brackets)

For example, say you want to replace all        "a) This is a test", "b) This is a test", etc. with " a) This is a test", " b) This is a test" but NOT replace anything that looks like "1. This is a    test", "2. This is a test", etc. (i.e. you want to       indent a) b) c) but not 1. 2. 3. and the data   structure / related list formatting prohibit     simpler solutions like using <li></li>). To    achieve this, you could use the following:       <column replaceall="[regex]([a-zA-Z]\)),     &nbsp;&nbsp;&nbsp;&nbsp;$1">

• If the data value is "Burlington
  Textiles Corp," but you want it to be "Boston Textiles Corp," use <column replaceall="Burlington,Boston">

<column showcolumn="{{!Object.Fieldname}} == 'FieldValueThatTriggersColumnHiding'">...</column>

Note that the column will be hidden if the syntax resolves to true.

If your table has a header row, you will need to apply the same condition to the header row as a RENDER statement:

<!--RENDER='{{!Object.Fieldname}}' == 'FieldValueThatTriggersColumnHiding'--><th>Column Name</th><!--ENDRENDER-->

• You can conditionally hide an entire column in your related list if the Opportunity record's StageName
  field has a value of 'Prospecting' or 'Closed' by using the following: <column showcolumn="{{!Opportunity.StageName}} == 'Prospecting'|| {{!Opportunity.StageName}} == 'Closed'">...</column>

If your field contains markup that you wish to preserve and display in your document, you can specify type="rtf"

This is useful for inserting blocks of information that already contains formatting/markup.

If you want to display a checkbox or radio button image (checked and unchecked) rather than the database values of true/false or yes/no, you can use type ="checkbox" or ="radio"

<column type="rtf">Your content goes here.

</column>

• When using type ="checkbox" the checkbox images have a class called "sdcheckbox." If needed, you can modify the CSS treatment of the checkbox. E.g.

<style type="text/css">
.sdcheckbox {
width: 10px;
height: 10px;
border: 1px solid #73AD21;
}
</style>

• Example: <column header="Grand Total">will place "Grand Total" over that column as a header.

<column format-number="#,###.##">

• Format number supports these four types:#,###

#,###.##

#.###

#.###,##

• For example, if a number in your column was stored as 123456 and
  you chose the 2^nd type listed above, the number would appear as 1,234.56

<column format-date="MM/dd/yyyy">

• To turn a date into just a day, month, or
  a year, you can use <column format-date="MMMMM"> (for days, use D, and for years, use Y)

• If you have a currency symbol column and an amount column,
  like           $        |        12

                            $        |        4

• You can merge these two columns together and the resulting column will be

$12

$4

• Prefix and postfix are useful to put any spacing between cell values.

Note: mergenext is not supported when using group-by functionality.

<column prefix="$"> would put a
dollar sign at the beginning of each
column like so:$                12

                            $                4

<column postfix="dollars"> would put "dollars" at the end of each column like so:12                dollars

4                  dollars

<lineitems>
<class>table646</class>
<listname>opportunitylineitems</listname>
<column startIndex="3">rownum</column>
<column>PricebookEntry.Product2.name</column>
<column>PricebookEntry.Product2.description</column>
<column>unitprice</column>
<column>quantity</column>
<column>totalprice</column>
</lineitems>
}}-->

This example would output a table with row numbers beginning at 4.

• This feature is only supported with <lineitemsSOQL> statements
• You must use <soql>...</soql> tags and include any field specifed in your subsitute="..." attributes in your SOQL query
• You should not specify a field between the <column></column> tags. Doing this may cause issues
• You can use RECORD.Field_Name to use related list record data fields within the render="..." attribute

Examples:

<column render="RECORD.Product_Type__c STARTSWITH Vacuum && RECORD.Product_Type__c ENDSWITH Cleaner,RECORD.Vacuum_Name__c,Not a Vacuum"></column>

• If the Product's Type field starts with Vacuum and ends with Cleaner, the column will output the name of the vacuum, otherwise the column will output "Not a Vacuum."

<column render="RECORD.Title==null,No Title Available,RECORD.Title"></column>

• If the Contact's title field is blank, the column will output "No Title Available," otherwise it will output the Contact's title.

You can also use nested render statements:

<column render="RECORD.Country__c == usa,[RENDER1]RECORD.City__c == new york,S-Docs HQ,[RENDER2]RECORD.City__c == ann arbor,S-Docs Innovation Center,[ENDRENDER2][ENDRENDER1],Work From Home"></column>

• If the record's Country field is USA, and the city is New York, the column will output "S-Docs HQ." If the record's Country field is USA and the city is Ann Arbor, the column will output "S-Docs Innovation Center." If the record's Country field is not USA, the column will output "Work From Home."

<column type="rtf" render="RECORD.StageName == 'Closed',<span style='font-color:red;'>Closed</span>,Open"></column>

• If the Opportunity is Closed, the column will output "Closed" in red. Otherwise, the column will output "Open" in the default font color.

<column breakeverychars="10">Long_Line__c</column> will insert a line break after every 10 characters.