Template Guide. HTML . Release 8. This template guide is an overview of how to use and customize an HTML templates with Conga Composer.

Transcription

1 Template Guide HTML Release 8 This template guide is an overview of how to use and customize an HTML templates with Conga Composer. Contact Support: support@congamerge.com Americas EMEA APAC (866) (toll free) (303) Conga. All Rights Reserved. Conga, Conga Suite and Conga Composer are all trademarks or registered trademarks of Conga, as are other names and marks. All other trademarks or registered trademarks are the properties of their respective owners.

2 Contents General Disclaimer... 3 Upgrading from Conga Composer Release 7?... 4 Purpose... 4 Before you get started... 4 Conga What Fields Are Available?... 7 Creating Merge Fields in a Conga Template... 8 How to Format Merge Fields... 9 Formatting Date Values Formatting Number Fields Conga Template Features Row Number Field - How to Number Table Rows Conga Template Parameters Conga Template FAQs Know Your Limits Conga Release 8 2

3 General Disclaimer Conga Composer solutions depend on and leverage technology from a multitude of software and hardware vendors including but not limited to salesforce.com, Microsoft, Google, and the providers of various Internet browsers ( Third Party Technology ). Output from Conga Composer solutions can be impacted by these and numerous other factors beyond the control of Conga, including: Template design errors in Microsoft Word, Excel, PowerPoint templates, PDF Forms or Conga HTML templates The nature and scope of data and/or images being retrieved for merging into templates Individual user s browser, network, ISP and/or hardware settings (see Conga Composer Installation and Administration Guide for additional details) The use of any encryption gateways or appliances that require any re-direct of Conga Composer traffic The availability and performance of the salesforce.com service and other software-as-aservice solutions such as esignature, ecommerce and other AppExchange products, and periodic updates, enhancements or other changes to such services made by their respective vendors Salesforce.com security settings including User Profiles and Permissions, folder and object access and field-level security Internet performance, regional and even global outages For these reasons, Conga cannot guarantee that your particular implementation of Third Party Technology and Conga technologies even if configured based on Conga documentation and/or guidance offered by Conga Support personnel will perform consistent with your expectations or requirements, or provide the output you require. Accordingly, Conga disclaims any and all liability resulting from, or related to, performance issues associated with Conga products to the extent arising from your implementation, configuration, or the behavior of Third Party Technology. 508 Compliance Conga Composer is an installable package from the Salesforce AppExchange, which integrates with an individual customer's existing implementation of Salesforce. When properly configured, Conga Composer will run within an existing Salesforce instance without the need to view, manipulate or configure the application outside of the Salesforce user interface. The use of Conga solutions is entirely represented by standard Salesforce user interface components when properly configured. Therefore, customers seeking the 508 Compliance VPAT documentation are referred to Salesforce Conga Release 8 3

4 Upgrading from Conga Composer Release 7? While Conga has made every effort to make Conga Composer Release 8 backwards compatible with Conga Composer Release 7, a small number of cases have been reported where the behavior of and/or output from Conga Composer Release 8 varies in content or appearance from Composer Release 7. It is the Customer s responsibility to thoroughly test all existing solutions with Composer Release 8 to ensure they perform as desired, and to make any necessary adjustments to templates, queries, reports or other components. Purpose Conga Composer lets you generate documents, spreadsheets and presentations by gathering data from salesforce.com and merging to a template. The resulting file(s) can be printed or ed and you can log the actions you ve taken in Salesforce. Conga Composer solutions let you create individual documents by clicking a button from a record in Salesforce. This template guide will show you how to create HTML templates. Before you get started For this Guide we are making a couple of assumptions: You ll need to be able to build a Conga Composer button. You can find the details on how to do this in Conga Composer QuickStart 1 Creating Your First Conga Composer Solution. You ll need to understand how to use the Conga Template Builder. You ll find details on the Conga Template Builder in the Conga Composer Configuration Guide. Heads Up Due to the potentially complicated nature of HTML source code, our support staff can only assist with the creation of Conga Templates edited using the non-source view mode in the Conga Advanced Editor. Editing the template through the Source view in the Conga Advanced Editor constitutes an unsupportable, "use-at-your-own-risk" configuration. Warning Conga highly recommends excluding the "Use attachment for template body" checkbox field from the Conga Template page layout. Use of this field is only suggested if your Conga Template is more than 32,000 characters, in which case the body of the Conga Template can be added as an attachment to the Conga Template record Conga Release 8 4

5 Conga Since Conga Composer was first released, many customers asked "The output from my Word template is great, but I'd really like to see the same information right in the body of an outbound ". That's exactly the purpose of the Conga feature. With Conga , you create a template record in the new custom object included when you install Conga from the AppExchange. Then, you build a merge template in the record's Rich Text field using the Conga Advanced Editor. You'll find that most of the things you can do in a Microsoft Word template can be accomplished in a Conga Template, such as: 1. Merging data fields from the Master, Org and User datasets 2. Merging Report and Query fields using Table- and Paragraph-based Detail Regions 3. Hiding tables based on the absence of rows on a Report or Query using TableHide 4. Calculating the sum of a table column using SUM(ABOVE) 5. Displaying a comma-separated list of Report or Query values using TableList 6. Merging images into Image fields 7. Generating Hyperlink fields 8. Replacing merge data values using the REPLACE: prefix Heads Up When merging rich text fields in Conga HTML Templates, Conga Composer will automatically read the HTML code behind a rich text field and render the rich text. Therefore, the "HTML:" prefix is not necessary on the merge field for a rich text field Conga Release 8 5

6 A Conga Template may be combined with one or more document templates. Outgoing s may be delivered via Salesforce as well as through Conga Composer's tight integration with SendGrid. Important: If you plan to use Conga with Custom Objects in Salesforce, you must ensure the object has "Allow Activities" enabled in the Custom Object Definition Conga Release 8 6

7 What Fields Are Available? The Template Builder is an essential tool in the development of Conga Composer solutions. The Template Builder exposes the data retrieved by Conga Composer from the Master Object (and from any Salesforce Reports or Conga Queries referenced in the Conga Composer URL). You can then us these fields to build templates. To learn more on how to use the Conga Template Builder, go the Conga Composer Configuration Guide Conga Release 8 7

8 Creating Merge Fields in a Conga Template The basic steps are similar to Conga's other template types: 1. Launch the Template Builder from the Conga Composer window. 2. Select the radio button for the template type. 3. Select the Conga Templates tab and create a record. Enter a description and basic information about the new template. 4. Optionally, save the record, then click the Advanced Editor button to further edit the body of the template. 5. Copy over the desired merge fields from the Template Builder. 6. Save the record. Here's an example of a Conga Template: 2014 Conga Release 8 8

9 How to Format Merge Fields Similar to merge fields in Microsoft Word templates, merge fields in HTML templates provide several formatting switches (called picture switches ) that affect the appearance of your merged data this is invaluable, particularly for numbers and dates. You can use the Template Builder to add these picture switches to your merge fields so the merged data is correctly formatted in your . Alternately, you can manually add a picture switch to your field by simply typing it into your merge field in the HTML template. To manually add a picture switch to a merge field: 1. Place the cursor at the end (far right) of the merge field, but inside of the double curly braces. 2. Type a space after the field name, followed by your desired picture switch. 3. Picture switches should be entered after the field name and the space you entered in step 2. For further information on setting picture switches, please see the following sections on date and number values Conga Release 8 9

10 Formatting Date Values The date formatting picture switch begins with followed by any combination of the following parameters. Please see the examples following this table. Parameter Description Month (M) The letter "M" must be uppercase to distinguish months from minutes. M MM MMM MMMM Displays the month as a number without a leading 0 (zero) for single- digit months. For example, February is "2". Displays the month as a number with a leading 0 (zero) for single- digit months. For example, February is "02". Displays the month as a three-letter abbreviation. For example, February is "Feb". Displays the month as its full name. e.g. February Day (d) Displays the day of the month or the day of the week. The letter "d" can be either uppercase or lowercase. d dd ddd dddd Displays the day of the week or month as a number without a leading 0 (zero) for single-digit days. For example, the sixth day of the month is displayed as "6". Displays the day of the week or month as a number with a leading 0 (zero) for single-digit days. For example, the sixth day of the month is displayed as "06". Displays the day of the week or month as a three-letter abbreviation. For example, Tuesday is displayed as "Tue". Displays the day of the week as its full name. Year (y) Displays the year as two or four digits. The letter "y" can be either uppercase or lowercase. yy Displays the year as two digits with a leading 0 (zero) for years 01 through 09. For example, 1999 is displayed as "99", and 2006 is displayed as "06". yyyy Displays the year as four digits Conga Release 8 10

11 Parameter Description Hours (h) A lowercase "h" bases time on the 12-hour clock. An uppercase "H" bases time on the 24-hour, or military, clock; for example, 5 P.M. is displayed as "17". h or H Displays the hour without a leading 0 (zero) for single-digit hours. For example, the hour of 9 A.M. is displayed as "9". hh or HH Displays the hour with a leading 0 (zero) for single-digit hours. For HH example, the hour of 9 A.M. is displayed as "09". Minutes (m) The letter "m" must be lowercase to distinguish minutes from months. m Displays minutes without a leading 0 (zero) for single-digit minutes. For example, {{TIME \@ "m"}} displays "2". mm Displays minutes with a leading 0 (zero) for single-digit minutes. For example, {{TIME \@ "mm"}} displays "02". A.M. and P.M. (AM/PM) am/pm Displays A.M. and P.M. AM/PM Displays A.M. and P.M. as uppercase. For example, {{NOW \@ "h AM/PM"}} and {{NOW \@ "h am/pm"}} display "9 AM" or " 5 PM" Conga Release 8 11

12 Examples: Here are several common examples of the date appearance parameter. Let s say the field we re formatting is OPPORTUNITY_CLOSEDATE and that it contains the date March 1, Example Output {{OPPORTUNITY_CLOSEDATE \@ MM-dd-yyyy}} {{OPPORTUNITY_CLOSEDATE \@ dd/mm/yyyy}} 01/03/2014 {{OPPORTUNITY_CLOSEDATE \@ "MMM dd, yyyy"}} Mar 01, 2014 Note: The formatting code is enclosed in straight quotes because it contains spaces. {{OPPORTUNITY_CLOSEDATE \@ "MMMM d, yyyy"}} March 1, 2014 Note: The formatting code is enclosed in straight quotes because it contains spaces Conga Release 8 12

13 Formatting Number Fields The number formatting picture switch begins with \#, followed by any combination of the following parameters. Please see the examples following this table. When Conga Composer populates a numeric value, the digit grouping symbol (the thousands separator ) is defined according to your Locale settings (as defined in Salesforce s Setup Personal Information) or according to the Culture or CurrencyCulture Conga Composer parameter. Despite the cultural settings that govern the output from Conga Composer, within an appearance parameter, you must use a comma (",") for the digit grouping symbol (for thousands) and a period (".") as the decimal symbol. Parameter Description 0 (zero) Specifies the requisite numeric places to display in the result. If the result does not include a digit in that place, Word displays a 0 (zero). Example: {{Points \# 00.00}} displays "09.00". # Specifies the requisite numeric places to display in the result. If the result does not include a digit in that place, Word displays a space. Example: {{Cost \# $### } displays "$15"., (digit grouping symbol) Separates a series of three digits. Note: The digit grouping symbol is always entered as a comma into the formatting code, regardless of the country s cultural preference. Conga Composer will format the output according the cultural preference. Example: {{= NetProfit \# $#,###,###}} displays "$2,456,800". %, $, *, and so on Includes the specified character in the result. Example: {{= NetProfit \# "##%"}} displays "33%" Conga Release 8 13

14 Parameter Description "positive; negative" Specifies different number formats for positive and negative results. Example: The field {{Sales95 \# "$#,##0.00;-$#,##0.00"}} displays the value with regular formatting for example, "$1,245.65". A negative value is displayed with a minus sign for example, "-$ ". Currency Formats the value according to the Salesforce Locale, including a currency symbol, digit grouping symbol ( thousands separator ) and two decimal places Note: May be used with =SUM fields, in addition to merge fields. Example: {{OPPORTUNITY_AMOUNT \# Currency}} In Conga Composer solutions, you can override the Salesforce Locale with the &CurrencyCulture or &Culture parameter. Currency0 Also available: Currency1, 2, 3, 4 Formats the value according to the Salesforce Locale, including a currency symbol, digit grouping symbol ( thousands separator ) and zero decimal places (or 1 decimal places, 2 decimal places, 3, 4, or 5 if using Currency1, Currency2, Currency3, etc.) Note: May be used with =SUM fields, in addition to merge fields Example: {{OPPORTUNITY_AMOUNT \# Currency0}} In Conga Composer solutions, you can override the Salesforce Locale with the CurrencyCulture or Culture parameter Conga Release 8 14

15 Parameter Description Number Formats the value according to the Salesforce Locale, excluding a currency symbol, but including a digit grouping symbol ( thousands separator ) and two decimal places Note: May be used with =SUM fields, in addition to merge fields Example: {{OPPORTUNITY_AMOUNT \# Number}} In Conga Composer solutions, you can override the Salesforce Locale with the &CurrencyCulture or &Culture parameter. Percent Formats the value according to the Salesforce Locale, by multiplying the value by 100 and including a digit grouping symbol ( thousands separator ), two decimal places and a percent sign. Note: Not for use with =SUM fields Example: {{OPPORTUNITY_PROBABILITY \# Percent}} In Conga Composer solutions, you can override the Salesforce Locale with the &CurrencyCulture or &Culture parameter Conga Release 8 15

16 Example 1: Here are several common examples of the number appearance parameter. Let s say the field we re formatting is OPPORTUNITY_AMOUNT and that it contains and the Salesforce Locale is English (United States). Example Output {{OPPORTUNITY_AMOUNT \# #,##0}} 5,280 {{OPPORTUNITY_AMOUNT \# $#,##0}} $5,280 {{OPPORTUNITY_AMOUNT \# #,##0.00}} 5, {{OPPORTUNITY_AMOUNT \# Currency}} $5, {{OPPORTUNITY_AMOUNT \# Currency0}} $5,280 {{OPPORTUNITY_AMOUNT \# Number}} 5, Example 2: Let s change the scenario a bit. Let s assume we re formatting the same field value as above, however, the Salesforce Locale is German (Germany). Example Output {{OPPORTUNITY_AMOUNT \# #,##0}} {{OPPORTUNITY_AMOUNT \# #,##0 }} {{OPPORTUNITY_AMOUNT \# #,##0.00}} 5.280,25 {{OPPORTUNITY_AMOUNT \# Currency}} 5.280,25 {{OPPORTUNITY_AMOUNT \# Currency0}} {{OPPORTUNITY_AMOUNT \# Number}} 5.280, Conga Release 8 16

17 Pre-selecting a Conga Template in Composer You can pre-select a Conga Template by copying the template's record ID to the clipboard and pasting it into your Composer button's URL following the new &Conga TemplateId=[id] parameter. An abbreviated parameter name, &CETID=[id], may be used instead. You may only specify one Conga Template Id per Composer button / link. If you specify a Conga Template Id, but not a file template id (&TemplateId), Composer will display the list of "Conga Templates" (with the selected template) by default. Using a Conga Template Since Conga Templates (CET) may be used in conjunction with traditional File Templates, you select the CET by clicking the "Conga Templates" tab. Select the template you d like to use. Then click the Merge & button on the Composer dialog box. After processing is complete, you ll be presented with a Salesforce (or SendGrid) , fully populated with data and ready for review Conga Release 8 17

18 Conga Staging When an outbound is generated from a Conga Template, Composer assembles the on the staging screen. Here you can customize the formatting and delivery options before sending the . At this point you can also use the editor to customize the before you send it. Some of the capabilities include: Text Formatting Alignment Hyperlinks and tagging Styles and Formatting HTML Source 2014 Conga Release 8 18

19 You can also customize the delivery option by adding recipients Note: Composer will automatically change the "Related To" value to the master object record when the is sent so that the resulting completed Task is associated with the master object record. Select the Add Attachment button to attach a file to the . Finally, press the Send button to deliver the Conga Release 8 19

20 Conga Template Features Conga Templates have a rich variety of tools, which are similar to the features available in Conga templates built in Microsoft Word. The following features are available: 1. Merge data fields from the Master, Org and User datasets See Creating Merge Fields for details. 2. Merge Report and Query fields using Table- and Paragraph-based Detail Regions Like Word templates, create a table and include a {{TableStart:DataSet}} and a {{TableEnd:DataSet}} field to indicate where detail data should be located. Insert merge fields from the detail region in the cells between the TableStart and TableEnd. 3. Hide tables based on the absence of rows on a Report or Query using TableHide Within a table, include a {{TableHide:DataSet}} field to indicate that you want the table removed if no data is available in the dataset. 4. Calculate the sum of a table column using SUM(ABOVE) Find the sum of a column of numbers by appending a blank row to a table, and creating a SUM(ABOVE) field. 5. Display a comma-separated list of Report or Query values using TableList You may display a list of detail values with {{TableList:DataSet:FieldName}} 6. Merge images into Image fields Insert images using a {{IMAGE:MergeFieldName}} merge field 7. Generate Hyperlink fields Create dynamic hyperlinks by including a {{HYPERLINK:MergeFieldName}} field. The field from Salesforce must contain an absolute (complete) URL. Optionally, you may include a colon (:) after the merge field name, followed by friendly text to display as the clickable link, rather than simply merging the URL. For example: {{HYPERLINK:ACCOUNT_WEBSITE:Click Here}} 8. Replace merge data values using the REPLACE: prefix Dynamically format a list of values by replacing undesired values with this type of field 2014 Conga Release 8 20

21 Row Number Field - How to Number Table Rows The Row Number field numbers each line item in a detail dataset and is included by default in every report or query dataset. The field name is ROW_NUMBER. Insert this field into any detail region in the template to number the results in the merged output file. In the below example, the {{ROW_NUMBER}} merge field is placed in the far left column: The merged output file looks like this: 2014 Conga Release 8 21

22 Using Conga File Templates with Conga Templates You may include one or more traditional File Templates in your merge operation. The output file from that merge operation will be attached to the outgoing . At this time, the inclusion of static attachments on the Conga Template is not supported, but remains a high-priority for future development. Conga Template Parameters Parameter Description 2014 Conga Release 8 22

23 &CETFilter=[text] Specifies the where clause to filter the list of Conga Templates that display in the user interface. Typically, a custom field is added to the Conga Template object and this parameter is used in conjunction with that field. Example: The system administrator creates a custom field, "Language_c."...&CETFilter=Language_c INCLUDES ('English') &Conga TemplateGroup= [text] (or &CETG) This parameter filters the list of Conga Templates that appear on the Composer dialog box to those that match the specified criteria. The value may include one or more values, separated by commas. This parameter may be populated via a QVAR query. Example 1: &Conga TemplateGroup=Quotes Example 2 (abbreviated, multiple values specified): &CETG=USA,Contact Conga Template Id &Conga TemplateId=[text] (or&cetid) This parameter pre-selects the Conga Template specified in the Templates list on the Composer user interface. Optionally, you may abbreviate this parameter to &CETId= You may specify only one Conga Template Id. This parameter may be populated via a QVAR query. Example 1: &Conga TemplateId=a0WG PNrS Example 2 (abbreviated): &CETId=a0WG PNrS *** Warning *** Currently does not work with DS7Preview Letterhead ID & Letterheadid=[Salesforce Letterhead ID] Specifies which Salesforce letterhead is used in conjunction with a Conga Template. In Release 8, the Conga Staging object has been deprecated and letterheads are no longer required; however, if you wish to use a Salesforce letterhead, you can specify it using this parameter. Note: The Conga Template ID (&CETID) parameter is required when using the & Letterheadid parameter. Example: & Letterheadid=016i fF 2014 Conga Release 8 23

24 Conga Template FAQs Is it possible to add a re-usable logo to all of the outbound messages? Yes. Included with Composer is a "Conga Letterhead" which may be customized to include a logo, modify colors, etc. Changes to this letterhead will be automatically included in subsequent use of Conga Templates. Conga Templates are built with HTML. Do I need to know much about HTML? Although a little experience with HTML would be useful, it's not necessary to know HTML because of the Conga Advanced Editor. Utilizing HTML templates makes sense for Conga Templates because they're easy to format and can include tables. What if the recipient can't open HTML s? Conga includes a plain text version of the alongside the HTML. Special formatting and tables, however, won't look very good in the plain-text version. What best practices can you suggest for developing Conga Templates? We have several suggestions that should help streamline Conga Templates: 1. Important! Keep it simple! An HTML is not a website. 2. Use images sparingly and make sure they're stored in Salesforce or on your own server. 3. Use simple tables to align data. Sure, we love CSS too, but many clients don't work well with CSS. 4. If you do use a little CSS, include it inline Conga Release 8 24

25 Know Your Limits The table below summariezes the limits for each Conga product. Conga Composer Reports per Composer solution 50 Maximum Rows per Report 2,500 Rows per Composer solution (all Reports and Queries combined) Queries per Composer solution 50 25,000 Rows per Query 2,500 Template Size Number of Templates per operation 10 Aggregate Template Size (when specifying multiple templates to use in the merge process) Aggregate Output Size 10 MB 20 MB 40 MB Columns per worksheet in View Data workbook 256 Conga Mail Merge Limits Reports per Mail Merge solution 1 Maximum Rows per Report 5,000 Template Size Output File Size 5 MB 40 MB Documents per batch (Master records) 1,000 Conga Query Manager SM Limits Rows from an Aggregated (SUM, COUNT, etc.) Query. Aggregate or Offset queries are limited to 1,000 rows. Rows of data from a Query Variable (QVar) 50 Conga Conductor Limits Maximum 1,000 Maximum Records in a Conga Conductor batch 50 records for consolidated output. 500 records for distributed output. Conga Workflow Limits Conga Workflow transactions Conga Courier Limits Conga Courier Schedules 200 Recipients for a Courier Schedule 25 Output file size Maximum 500 per day Maximum 5 MB 2014 Conga Release 8 25

26 Browser URL Limits Internet Explorer Chrome, Firefox, Safari Maximum 2,000 bytes (closer to 1,700 bytes in practice) 64,000 bytes 2014 Conga Release 8 26