Release 7 - Winter 13

Transcription

1 Conga Conga Composer Configuration Guide Release 7 - Winter 13 Welcome Conga Composer lets you generate documents and spreadsheets by gathering data from Salesforce 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. Contacting Conga Conga is a leading provider of software solutions to enrich your Salesforce experience, specializing in document creation tools that integrate data from Salesforce. Founded in 2006, Conga has since built a substantial market presence with thousands of customers worldwide. Technical Support At Conga, we are committed to providing you with timely answers to your technical support questions. We provide support to system administrators for our products via or telephone. Generally, we re available weekdays, during the following hours: North America Support Hours: 8 a.m. 8 p.m. Eastern Time Tech Support support@congamerge.com Telephone: or (866) Europe, Middle East, Africa (EMEA) Support Hours: 9 a.m. 5 p.m. British Time Tech Support support@congamerge.com Telephone: Asia / Pacific (APAC) Support Hours: 9 a.m. 5 p.m. Eastern Time Tech Support support@congamerge.com Telephone: Sales For information on other products from Conga, please contact our New Business team: Sales Information sales@congamerge.com Telephone: 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 Resources Examples: For detailed examples, including sample templates, report designs and sample output, please visit the knowledgebase article on our Conga Starter Template Library. Articles and Videos: Conga provides an online knowledge base and YouTube channel that are available 24X7 to help you answer questions. QuickStarts: Want to get started right away? Our QuickStart library will help you quickly generate your first Conga Composer solutions. The topics in the QuickStart library include: Creating a Simple Document Creating Your First Custom Solution Creating a Complete Solution Conga Composer Winter 13 Release Page 2

3 Table of Contents 1. What is Conga Composer? Create a Conga Composer button... 6 Create the button... 6 Adjust the Window Open Properties... 7 Add the button to a Page Layout Gather Salesforce Data... 9 What fields are available for merging? What if I need data from an object related to the Master Object? Using Salesforce Reports with Conga Composer Using Conga Queries with Conga Composer Create and Store a Merge Template Refine Conga Composer Solutions with Parameters Basic Configuration Parameters Data-Gathering Parameters Template Selection Parameters Parameters Activity Logging Parameters Conga Window Appearance Background Mode Parameters Output File Parameters General Output File Parameters PDF (Output File) Parameters Excel Parameters PowerPoint Parameters Word Parameters Template Parameters Integration Parameters DocuSign Integration Parameters EchoSign Integration Parameters Salesforce Chatter Integration Parameters Salesforce Content Integration Parameters SendGrid Integration Parameters Sertifi Integration Parameters SpringCM Integration Parameters Advanced Parameters Advanced Data Gathering Parameters Advanced Template Selection Parameters Advanced Data-Formatting Parameters Advanced Control Parameters Formula-Driven Parameters Conga Composer URL Examples Conga Template Manager Know Your Limits Other Parameters Supported Culture Codes Index of Conga Composer Parameters Conga Composer Winter 13 Release Page 3

4 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 Composer Winter 13 Release Page 4

5 Conga Composer 1. What is Conga Composer? Conga Composer allows you to create an individual document from a button or link placed on a standard or custom object page layout. With Conga Composer, you can retrieve data from multiple Salesforce objects using specially configured Salesforce reports (or other search requests), and then merge the data into a Word, Excel, PowerPoint, PDF template or HTML . This chapter provides guidance on building Conga Composer solutions that leverage Salesforce Reports as a data source. The following illustration depicts a common business scenario in which Conga Composer retrieves data from multiple reports to produce a sophisticated document. Conga Composer Winter 13 Release Page 5

6 2. Create a Conga Composer button Create the button You ll need to create a button (or link) from which you will invoke Conga Composer. 1. Choose Setup App Setup Customize [Object] Buttons and Links 2. Click New in the Custom Buttons and Links section 3. For the Label, enter something that will describe the kind of document you will create with Conga Composer, or simply enter Conga Composer. 4. For the Display type, choose Detail Page Button 5. In the URL text box, type or paste the Conga Composer Base URL: &ServerUrl={!API.Partner_Server_URL_210} &Id= 6. Append your object s Id to the end of the URL (after Id=) using the Insert Merge Field list. For example, a Contact would require {!Contact.Id}, an Account would require {!Account.Id} and a custom object would require {!Record.Id}. Tip! Always use the Insert Merge Field list to locate the desired Id field. This id is the Master Object Id. Tip! Your button URL must not contain spaces, particularly at the ends of lines 7. Click Save. Tip! Conga Composer will retrieve all fields from the Master Object, automatically making them available for merging. Conga Composer Winter 13 Release Page 6

7 Adjust the Window Open Properties 1. Choose Setup App Setup Customize [Object] Buttons and Links 2. Click the name of the button you created (not the Edit link) 3. Click Window Open Properties 4. Set the Height to Clear the checkbox on #6 Show Scrollbars 6. Click Save Conga Composer Winter 13 Release Page 7

8 Add the button to a Page Layout 1. Choose Setup App Setup Customize [Object] Page Layouts and edit the desired Page Layout. From the Page Layout Properties screen, click Buttons or Custom Links. 2. Drag your new button to the appropriate region on the page layout. 3. Click Save. Tip! The button you have created is ready for use. Open a record of this type in Salesforce and click your new button to see Conga Composer in action! Note: The Preview As button will not work. Watch a Video This video demonstrates how to create a basic Conga Composer button Conga Composer Winter 13 Release Page 8

9 3. Gather Salesforce Data The process of gathering the correct data from Salesforce is iterative. Generally, you start by examining the fields that Conga Composer has automatically retrieved. If those fields are sufficient for your solution, you re ready to build your template. If not, you ll need to add as many Reports or Queries necessary to retrieve whatever data is required for your solution. (1) Examine the Template Builder window (2) Add or modify Salesforce Reports (3) Modify Conga Composer Button URL How do you know which fields are available to you? To answer that question, let s discover the power of the Template Builder. Conga Composer Winter 13 Release Page 9

10 What fields are available for merging? An essential tool in the development of Conga Composer solutions is the Template Builder. The Template Builder is located at the lower-left corner of the Conga Composer page. Tip! You ll use the Template Builder frequently in the upcoming sections. 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. (The use of Salesforce Reports and Conga Queries is described later in this chapter.) Select the desired dataset to view the available merge field names. The field names listed in the left column indicate the field names you must use in your templates. Filter the list of fields by entering search criteria in the Live Search box. You may search the field names or the sample data (drawn from the first row of data available). Click the field name to copy it to the clipboard, then switch to your template (in Word, Excel, PowerPoint or a PDF Form) and paste the field name into the appropriate location (see the template-specific guides for information on how to create a merge field). See the next page for several tips on how to best use the Template Builder. Conga Composer Winter 13 Release Page 10

11 Tip! If an Opportunity is your Master Object, Conga Composer will automatically make the Opportunity Line Items available for merging in the OppLineItems dataset. Tip! If a Quote is your Master Object, Conga Composer will automatically make the Quote Line Items available for merging in the QuoteLineItems dataset. Tip! The View Data link allows you to download the available data as an Excel workbook. Tip! The User and Org datasets appear only if Track Activities is enabled for the Master Object Conga Composer Winter 13 Release Page 11

12 What if I need data from an object related to the Master Object? To gather information from Salesforce that isn t contained in the Master Object, you may use: One or more Salesforce Reports One or more Conga Queries The benefit of using Salesforce Reports to gather additional data for Conga Composer is that creating reports and linking them to Conga Composer is quick and easy, but they re somewhat limited in the information you can access. Conga Queries, on the other hand, are more powerful in that they can access most objects in Salesforce, but they re more complicated to set up. Let s examine each method. Conga Composer Winter 13 Release Page 12

13 Using Salesforce Reports with Conga Composer You can use a Salesforce report to retrieve data related to your Master Object. Conga Composer will automatically filter the report by passing the Master Object Id into the report s Advanced Filters. (You may override the default behavior and instead use other information to filter the report.) Conga Composer filters the report by passing the Master Object Id into the first cell of the value column in the report when the merge begins Example: Let s say your Conga Composer button is located on an Account and you d like to use a report to retrieve all Contacts related to that Account so you can print a phone directory. 1. Create a Conga Composer button and place it on your Account page layout 2. Create a report based on Contacts & Accounts 3. Drag and drop the fields you re interested in from Fields to Preview 4. In the Filters section, set the following: a. Show: View drop-down list to All Accounts b. Date Field: Clear any values in Start Date and End Date c. Add Field Filter: Field drop-down list to Account Id 5. Save the report into any publicly accessible folder, we recommend Conga Composer Reports. (See Best Practice: Report Naming Conventions for advice about report names and folders.) Conga Composer Winter 13 Release Page 13

14 This report is now ready to receive the Master Object Id (which is the Account Id) from Conga Composer. Next, we ll explore how to include the report in the Conga Composer button. Tip! Test your report by pasting sample data into the Advanced Filters and choose Run Report. Don t save the report with the sample data. (In our example, you would paste an Account Id.) Tip! Focus the scope of each Conga Composer report to pull only the objects and fields necessary. Tip! Conga Composer will retrieve a report that contains a maximum of 1,500 rows and contains less than 5 Mb of total data. Additionally, each Conga Composer solution has a combined row limit of 25,000. Tip! If you include an Id column in your report, position it as the last (right-most) column. Referencing the Report in the Conga Composer button To include the new report in the Conga Composer button, do the following: 1. Open the Reports Tab 2. Run the report by clicking the report name 3. Select the report s Id in the browser s URL and copy it to the clipboard (the 15- character value after the last / (slash)) 4. Edit the Conga Composer button: Setup App Setup Customize [Object] Buttons and Links Edit 5. Move to the end of the URL and enter the following parameters: &ReportId= 6. Paste the Report Id from the clipboard 7. Save the button Tip! After including a report in the Conga Composer button, click the Conga Composer button and then open the Template Builder to test whether Conga Composer has retrieved the correct data. Tip! You may use up to 50 reports in a Conga Composer button. Create another report (as directed above) and include its Id after the previous Report Id, separated by a comma. Watch a Video This video demonstrates how to include a Salesforce report in a Conga Composer button Conga Composer Winter 13 Release Page 14

15 Frequently Asked Questions about using Salesforce Reports in Conga Composer FAQ: How can I filter the report on something other than the Master Object Id? Although Conga Composer will use the Master Object Id as the default filter value in the report s Advanced Filters, you may override this behavior and use any field from the master object. Tip! You can also use a field from a parent of the master object, like an Account field related to a Contact. To use a different field, you ll need to do the following: Configure your report to receive the desired value Update your Conga Composer button to send the desired value Configure your report to receive some other field value: 1. Edit the report 2. In the Filters section, Add a Field Filter and select the field you d like to use in the field drop-down list 3. Leave the Value field empty (This cell is known as pv0) 4. Save the report Example: Let s extend our example from earlier. Instead of creating a directory of Contacts at a given Account, let s say we want all Contacts who are in the same state as the Account (but not necessarily affiliated with the Account). In the image above, the Account Id field has been replaced with Contact s Mailing State/Province so that we can search for Contacts who are in the same State/Province as the Account. Update your Conga Composer button to send the desired value: 1. Edit the Conga Composer button: Setup App Setup Customize [Object] Buttons and Links Edit 2. Move to the end of the URL and add the following to the ReportId parameter:?pv0= 3. Select the field that contains the desired search criteria from the Insert Merge Field drop-down list. Example: Change the Report Id parameter so that it uses the Account s Billing State as the search criteria. The parameter would appear as: &ReportId=00O LNBd?pv0={!Account.BillingState} Tip! When including a?pv0= parameter, the pv must be lowercase. Tip! Don t use fields that might contain commas or ampersands to filter reports. Best practice: Use Id fields to ensure correct results. Conga Composer Winter 13 Release Page 15

16 Tip! When passing numeric date values to a report, you must pass them in the US date format, mm/dd/yyyy. You can ensure the correct format by using a Salesforce formula field to parse a Date field. Conga Composer Winter 13 Release Page 16

17 FAQ: How can I filter the report with criteria from two or more fields? For even more demanding situations, you can pass a second, a third and even as many as five parameters to the same report. The values for those parameters are numbered sequentially: pv0, pv1, pv2, etc. Each pv parameter must be separated with a tilde symbol (~). Example: Extending the example from above, let s say we want a list of all Contacts in the same State/Province as the Account and who are also doctors. The selection criteria of the report would need to be: The Report Id parameter Conga Composer button URL would need to be: Conga Composer Winter 13 Release Page 17

18 FAQ: How can I filter the report with two or more values from one field? You may use multiple values in a single pv value by separating each value with a pipe symbol ( ). Example: Again, extending the previous example, let s say we want a list of all Contacts in the same State/Province, who are either doctors or professors. In this case, the report is already ready to receive the filter criteria. We only need to change the Report Id parameter of the Conga Composer button: Conga Composer Winter 13 Release Page 18

19 FAQ: My report already has filter criteria under Advanced Filters. Can Conga Composer filter the report using subsequent rows in Advanced Filters? Yes. If you want Conga Composer to filter your report with a value in, say, the pv1 position, you may define the ReportId parameter in your button to use any combination of pv positions. Example: Let s say your report has filter criteria in the first row of the Advanced Filters (i.e., the pv0 position) and you want Conga Composer to supply filter criteria for the second row (pv1). You could specify that as: &ReportId=00O LNBd?pv1={!Account.BillingState} FAQ: What if I don t want to dynamically filter the report? I just want the report contents as-is. You can retrieve the contents of a report without applying any dynamic filtering by passing an empty value for pv0 : &ReportId=00O LNBd?pv0= FAQ: How can I gather data from multiple reports? Conga Composer Winter 13 Release Page 19

20 You may include up to 50 ReportId parameters in a Conga Composer URL, thus making 50 reports accessible in a single merge operation. To do so, enter a comma, then the next Id as shown below. Example: Here, we have Conga Composer configured to pull data from four reports: &ServerURL={!API.Partner_Server_URL_210} &Id={!Contact.Id} &ReportID=00O NGuW, 00O O2gr, 00O NGv5?pv1={!Contact.MailingState}, 00O NGvL Each of these reports would be visible through the Template Builder window as a separate dataset. Conga Composer automatically assigns the worksheet names based on the sequence of report IDs included in a Conga Composer URL. You may also use Report Aliases to name the worksheets. See Using Report Aliases for details. Conga Composer Winter 13 Release Page 20

21 FAQ: How can I control the sort-order of the data retrieved from a report? You can control the sort-order of the information Conga Composer retrieves from a report: 1. From the Reports Tab, run the Report by clicking its name 2. Click the column-header label of the desired column to sort by 3. Save the report Example: Say your report shows a list of Contacts related to an Account and you d like the list of contacts sorted by Last Name. To set the sort-order, you would run the report, click on the Last Name column (even though the report may have zero rows of information currently on it), then save the report. When Conga Composer interacts with the report, the data it gathers is sorted according to your sort-order choice. Tip! You can sort on multiple columns by changing the report to a Summary Report and summarizing on another field. Conga Composer doesn t use the summary information, but will adhere to the sort-order of the report. Conga Composer Winter 13 Release Page 21

22 FAQ: I m creating Quotes (or Invoices) from an Opportunity and its related Opportunity Line Items. Do I need a report to retrieve the Opportunity Line Items? No, in this particular case, you don t. Conga Composer automatically makes Opportunity Line Items available to you without any reports because the master object is an Opportunity. Opportunity Line Items appear as a separate dataset ( OppLineItems ) in the Template Builder window: Tip! Conga Composer will automatically retrieve the line items from a Salesforce Quote record, too. Conga Composer Winter 13 Release Page 22

23 FAQ: How can I use my own label for a data sheet? You may supply an alias for a Report (or Query) to override the default name. Please follow these guidelines: The alias must precede the Salesforce Report (or Query) Id It must be enclosed in square brackets ( [ and ] ) It may contain only alphanumeric characters; punctuation marks and other special characters are not permitted It must contain at least 2 characters and but not more than 20 characters It must be unique within the entire Conga Composer URL Spaces are not permitted within an alias, or between the brackets and the Report Id Reserved sheet names ( Master, Org, User, ReportData, etc.) may not be used as an alias Example: In this example, an alias has been added to each Report Id. The resulting datasets in the Template Builder window appear as: The field names in your template must then refer to the alias name. For example, in Microsoft Word would you create a field for { TableStart:Contacts } and { TableEnd:Contacts }. Conga Composer Winter 13 Release Page 23

24 Best Practice: Report Naming Conventions When naming reports created for use with Conga Composer, we suggest you adopt a naming convention that reflects: The Conga Composer solution the reports are intended to support (Account Plan, Custom Invoice, etc.) The sequence in which the reports are listed in the Conga Composer URL (ReportData, ReportData1, ReportData2, etc.) or the Report Alias (see FAQ: How can I use my own label for a data sheet? above for further details) A description of the data being retrieved The Salesforce Report Type In the example below, four Salesforce reports called from a Conga Composer solution titled Executive Brief on a Contact page layout might be named as follows: By following this guidance, you will find it much easier to locate the Salesforce report responsible for the tables revealed on the Template Builder window. Tip! If you follow this guidance and for some reason change the order of the report IDs in the URL, or insert or delete one, remember to update the impacted Salesforce Report Names to ensure they reflect their position(s) in the URL. You can avoid having to make this update by using Report Aliases instead. Conga Composer Winter 13 Release Page 24

25 Using Report Fields in Templates Fields retrieved from Conga Composer reports require special attention in templates. This is true of Word, Excel and PDF templates, though the conventions differ from one to the other. For complete details about designing templates, please see the various guides on the Documentation page of our support website: Microsoft Word Merge Templates Microsoft Excel Merge Templates Microsoft PowerPoint Merge Templates PDF Templates Conga HTML Templates Storing Merge Templates Conga Composer Winter 13 Release Page 25

26 Using Conga Queries with Conga Composer In addition to using Salesforce reports to gather information from Salesforce, you may also use Conga Queries, records stored in the Conga Query Manager. The link to this private listing is located on our website. Locate Conga Query Manager, click Get It Now for your appropriate Salesforce edition and then follow the instructions to install the additional component. This custom object stores Salesforce Object Query Language (SOQL) statements that will retrieve data related to the Master Object. Complete details on the installation and use of the Conga Query Manager are provided on the Support page from our website. Using Queries instead of Reports Conga Queries have certain strengths over the use of Salesforce Reports for gathering data: Queries are slightly faster and more reliable than Salesforce Reports Queries can access objects that cannot be displayed in Salesforce Reports (Notes, Approval History) Queries reduce clutter on the Reports Tab Queries have tighter security and visibility controls than Salesforce Reports Queries are more reliable when multiple queries (say, over 10) are including in Conga Composer solution Using Salesforce reports remains a viable option for basic requirements. Warning! Conga Composer will retrieve a report (or query) that contains a maximum of 1,500 rows and contains less than 5 Mb of total data. Additionally, each Conga Composer solution has a combined row limit of 25,000. For complete details on how to use Conga Queries, please visit our Documentation page, and look for the Conga Query Manager link. Conga Composer Winter 13 Release Page 26

27 Create and Store a Merge Template Now that your Conga Composer button is configured to retrieve the desired data from Salesforce, your next task is to create a merge template using Word, Excel, PowerPoint, HTML , or PDF form. Each type of template has its own benefits and naming conventions regarding merge fields, so please refer to the appropriate guide for your template type: Microsoft Word Merge Templates Microsoft Excel Merge Templates Microsoft PowerPoint Merge Templates PDF Templates HTML Templates Finally, after designing a template you may store your template in any of three locations: The Conga Template Manager The Salesforce template repository Your local hard drive or network drive Each of these is discussed in Storing Merge Templates. Conga Composer Winter 13 Release Page 27

28 4. Refine Conga Composer Solutions with Parameters Conga Composer solutions can be highly customized to enhance the user experience. If desired, you may include any of the following parameters in your Conga Composer URL. Append each parameter to the URL value in your Conga Composer button. A few caveats: 1. Each parameter/value pair must be entered with the following convention: &Parameter=Value 2. Each parameter must begin with an ampersand (&) 3. Spaces are not permitted anywhere in Conga Composer URLs, including parameter/value pairs. If your Value requires spaces, replace them with plus signs (+). Quotes ( ) are not permitted anywhere in URLs either. 4. Parameter names are not case-sensitive, but the values you set them to may be, so it s a best practice to observe case closely 5. Parameters may be appended to the Conga Composer URL in any order 6. Several complete examples are available in the last section of this chapter 7. The Conga Composer URL should not exceed 1750 characters We invite you to explore the following categories: 1. Basic Configuration 2. Dialog Box Appearance 3. Output File Parameters 4. Integration Parameters Conga Composer Winter 13 Release Page 28

29 Basic Configuration Parameters The Basic Configuration Group lists the most popular parameters for Conga Composer. These parameters define: How data is gathered Which templates are presented to users How to address outbound messages How activity logging should take place Data-Gathering Parameters The following parameters affect how Conga Composer gathers data from Salesforce. PARAMETER Id=[id] Sets the master object. All fields are retrieved from this object. ** Note: A Conga Composer URL must contain one (and only one) instance of this parameter ** A Salesforce Id of any record (Contact, Lead, Account, Custom Object, etc.) or a field that contains an Id Conga Composer Winter 13 Release Page 29

30 PARAMETER ReportId=[id] Retrieves the contents of the specified report(s) (identified by its 15- character Salesforce id) and makes the report contents available through a ReportData dataset as seen on the Template Builder window. You may include up to 50 ReportId values in a Conga Composer URL, thus making 50 reports accessible in a single merge operation. Conga Composer will retrieve a report that contains a maximum of 1,500 rows. A 15-character Salesforce Id of a Report. May optionally include filter criteria. Example 1: &ReportId= dg3A Example 2: (two reports) &ReportId=00O dg3A,00O dgF2 Report Aliases: An optional report alias may precede the report id: Enclose the alias in square brackets Minimum 2 characters, maximum 20 Alphanumeric characters only Reserved sheet names may not be used ( Master, Org, etc.) The alias must be unique within the button URL Example 1: &ReportId=[MyContacts] dg3A Example 2: (two reports) &ReportId=[MyAccounts]00O dg3A, [MyCases]00O dgF2 For more options and a complete discussion of using Reports with Conga Composer, please see Using Salesforce Reports with Conga Composer, page 13 Conga Composer Winter 13 Release Page 30

31 PARAMETER QueryId=[id] Retrieves the SOQL query stored in the specified Salesforce record(s), executes the SOQL query and makes the SOQL query results available through a QueryData dataset as seen on the Template Builder window. You may include up to 50 QueryId values in a Conga Composer URL, thus making 50 queries accessible in a single merge operation. Conga Composer will retrieve a query that contains a maximum of 1,500 rows. A 15-character Salesforce Id of a Query record. May optionally include filter criteria. Example 1: &QueryId=a dg3 Example 2: (two queries) &QueryId=a dg32, dgF2 Query Aliases: An optional query alias may precede the query id: Enclose the alias in square brackets Minimum 2 characters, maximum 20 Alphanumeric characters only Reserved sheet names may not be used ( Master, Org, etc.) The alias must be unique within the button URL Example 1: &QueryId=[MyContacts]a dg3 Example 2: (two queries) &QueryId=[MyAccounts]a dg32, [MyCases]a dgF2 For more options and a complete discussion of using Queries with Conga Composer, please see Using Conga Queries with Conga Composer, page 26 You can find other, more advanced parameters for Data Gathering in the Advanced Parameters section. Conga Composer Winter 13 Release Page 31

32 Template Selection Parameters The following parameters pertain to merge templates. PARAMETER TemplateId=[id] Pre-selects the template(s) specified in the File Template list box You may include up to 10 TemplateIds. Additional limitations apply. With multiple templates specified and the output format set to Adobe PDF, the system will convert each output files to PDF, join the collection and return a single PDF. With multiple templates specified and the output format set to Same as Template, the system will return a zipped file containing each output file. To return a zipped collection of PDFs, include the parameter &ZipPDFs=1 (see below). A 15-character Salesforce Id of a Template record Example 1: &TemplateId= dg3B Example 2 (multiple templates): &TemplateId= dg3B, Example 3 (referencing a field that contains the template id): &TemplateId={!Contact.TemplateId} TemplateGroup=[value] Filters the list of file templates that appear on the Conga Composer dialog box to those that match this criteria. May include one or more values, separated by commas. Templates must be stored in Conga Template Manager Template Group value set on each Template Manager record Each record in the Conga Template Manager can be set with one or more Template Group values, separated by commas. This parameter filters the available templates using this field. Conga Composer Winter 13 Release Page 32

33 PARAMETER SelectTemplates=[0 or 1] Displays the Multiple Template Selection dialog box which allows users to select and arrange up to 10 templates from any of the following template sources: Conga Template Manager Salesforce Content Salesforce Documents Tab The Salesforce Content Title and Description fields are searchable through the dialog box. At this time, the attachments are not indexed. Salesforce Content may be suppressed by including the &HideContent=1 parameter. Salesforce Content can be set as the default option by including the &DefaultPane=1 parameter. Tips: This parameter works especially well with the TemplateGroup parameter, which can be used to ensure that each template has appropriate merge fields. This parameter also works especially well as an inline window, rather than as a traditional pop-up window. If Background Mode (DS7) is also included, a template must be selected This parameter won t work with a QVar that results in a list of template ids. You can find other, more advanced parameters for Template Selection in the Advanced Parameters section. Conga Composer Winter 13 Release Page 33

34 FAQ: Pre-Selecting a Merge Template for Conga Composer Solution For most Conga Composer solutions, it s often desirable to pre-select the template that you ve intended to use with this particular merge operation. You may do so by including the TemplateId parameter in the URL that calls Conga Composer. Example: &ServerURL={!API.Partner_Server_URL_210} &Id={!Contact.Id} &TemplateId=01H tMS The Id of the desired template is found by navigating to the template, stored in either the Salesforce template repository or the Conga Template Manager. Click the name of the template and select the id from the template s URL. Tip! The id required is from the Template Manager record, not the attachment stored with the record Conga Composer Winter 13 Release Page 34

35 This page intentionally left blank Conga Composer Winter 13 Release Page 35

36 Parameters The standard Conga Composer dialog includes the option to generate the desired merge output and attach it directly to an outbound Salesforce message. This feature can greatly reduce the time required to otherwise generate a merge file, save it to disk, launch an message and attach the file a great productivity tool. Tip! The Parameters work with Conga's integration with SendGrid. Conga Composer Winter 13 Release Page 36

37 PARAMETER ToId=[id] Sets the value of the To field. A Salesforce Id of a Contact or Lead, or a field that contains the Id of a Contact or Lead. Note: If using a Lead Id with Conga Templates, must use SendGrid integration, Leads and Conga Templates do not work with Salesforce . If the Conga Composer Master Object is an Opportunity, the To field is automatically set to the Primary Contact, without the use of this parameter. To override this behavior from an Opportunity, set the parameter to +, e.g., & ToId=+ If the Conga Composer Master Object is a Quote, the To field is automatically set to the Contact on the Quote, without the use of this parameter. Example 1: & ToId={!Contact.Id} Example 2: & ToId= dg3C NOTE: This parameter will not work when the master object is a Lead and you are using Conga templates, there is a Salesforce limitation concerning Leads. It will however work when using standard Salesforce templates. RelatedToId=[id] Sets the value of the Related To field. The Salesforce ID of an Account, Opportunity or other Salesforce object, or a field that contains this kind of ID. The Related To field causes the sent to appear in the Activity History related list of the object identified. In the absence of this parameter, Conga defaults the Related To field to the Master Object. The supported objects for the Related To field are: Account, Asset, Campaign, Case, Contract, Opportunity, Order, Product, Solution, custom objects with track activities enabled. Example 1: & RelatedToId={!Opportunity.Id} Example 2: & RelatedToId= dg3D AdditionalTo=[text] Sets the value of the Additional To field. An address or a field that contains one or more addresses. Example 1: & AdditionalTo=support@appextremes.com Example 2: & AdditionalTo=support@appextremes.com, support@xyz.com Example 3: & AdditionalTo={!Contact.Other Address} Conga Composer Winter 13 Release Page 37

38 PARAMETER CC=[text] Sets the value of the CC field. An address or a field that contains one or more addresses. Example 1: & CC =support@appextremes.com Example 2: & CC={!Contact.Other Address} BCC=[text] Sets the value of the BCC field. An address or a field that contains one or more addresses. Example 1: & BCC =support@appextremes.com Example 2: & BCC={!Contact.Other Address} TemplateId=[id] Loads the subject and body fields from a Salesforce template. ** Note: Attachments stored directly in the template are not applied unless TemplateAttachments is set to 1 ** A 15-character Salesforce Id of an template stored in Setup Communication Templates Templates RelatedToId parameter or ToId parameter must be set Example: & TemplateId= dg7A Subject=[text] Sets the value of the Subject field. If you set this parameter and use TemplateId, this value will override the value of the Template s Subject. Any text. Use + to indicate spaces. Example 1: & Subject=Thank+You Example 2: & Subject=Account+Brief+for+{!Account.Name} TemplateAttachments= [0 or 1] Indicates to preserve attachments stored with the Template. If set to 0, attachments stored on the Template are ignored If set to 1, attachments stored on the Template are preserved TemplateId parameter must be set Conga Composer Winter 13 Release Page 38

39 PARAMETER FromId=[id] Indicates an Organization-Wide Address as the From identity of the . Requires A 15-character Salesforce Id of an Organization-Wide Address as defined in Setup Administration Organization-Wide Addresses Tip After setting up the Org-Wide Address, edit the record to locate the Salesforce Id. It will begin with 0D2 Each Org-Wide Address may be restricted by Profile ReplyToId=[id] Changes the apparent sender of an by setting the message's ReplyTo and DisplayName properties to those of the specified User. Requires A 15-character Salesforce User Id Important This parameter only affects that is delivered in an unattended manner, e.g., Background Mode (DS7=12), Conga Conductor and Conga Workflow. UseSignature=[0 or 1] Indicates whether to include or exclude the sending user's signature from appearing in the body. If set to 0, the signature block is excluded If set to 1, the signature block is included (default) Important This parameter only affects that is delivered in an unattended manner, e.g., Background Mode (DS7=12), Conga Conductor and Conga Workflow. FAQ: Detailed example of using the parameters Here s an example that would be applicable to a Conga Composer button contained on a Case. It specifies who to address the to, establishes the Related object, specifies the Additional To and CC fields, and then specifies an Template. &ServerURL={!API.Partner_Server_URL_210} &Id={!Contact.Id} &TemplateId=01H t & ToId={!Contact.Id} & RelatedToId={!Case.Id} & AdditionalTo={!Case.Owner } & CC=support@mycompany.com & TemplateId=00X vrZ4 Conga Composer Winter 13 Release Page 39

40 Activity Logging Parameters The following parameters affect the Log Activity Options of the Conga Composer dialog box. Tip! For clarity, the following LG parameters are shown in uppercase, however they are not case-sensitive in practice. PARAMETER LG0=[0 or 1] Save Text Determines whether to store the text of the document (post-merge) to the body of the Task If set to 0, Save Text: is -None- If set to 1, Save Text: is Document Text (Word only) (default) ** Note: This feature only works with Microsoft Word templates ** LG1=[text] Activity Subject Sets the Subject to the text specified. Also used as in the subject of a Follow- Up Task, if one is created. If not specified and the Activity Subject is blank, the output filename is used for the Activity Subject. Important: Do not use the less than (<) or greater than symbol (>) with this parameter Example 1: &LG1=Quote+Generated Example 2: &LG1={!Opportunity. Subject} Conga Composer Winter 13 Release Page 40

41 PARAMETER LG2=[integer] Follow-Up Date Sets the follow-up date by using the integer to add days to today s date Example:...&LG2=14 would set a follow-up date 14 days from today LG3=[0, 1 or 2] Attach File Sets the file attachment options If set to 0, "Attach File:" is "-None-" (default) If set to 1, "Attach File:" is "Attach to [record]" where [record] would be the type of master object record, e.g., Opportunity If set to 2, "Attach File:" is "Attach only, No Task Record" LG4=[0, 1 or 2] Automatic Logging Sets whether to automatically log an activity after merging If set to 0, Automatic Logging is disabled (default) If set to 1, Automatic Logging is enabled If set to 2, Master Field to Set fields are updated but no Task record is created LG5=[id] Sets the Assigned To field in the Activity A Salesforce Id of a User or a field that contains this kind of Id. In the absence of this parameter, the Assigned To field is set to the current user. Example 1: &LG5={!Opportunity.Assistant c} Example 2: &LG5= dg3D LG6=[id] Sets the Assigned To field in the Follow-Up Activity A Salesforce Id of a User or a field that contains this kind of Id. In the absence of this parameter, the Assigned To field of a follow-up activity is set to the current user. Example 1: &LG6={!Opportunity.Assistant c} Example 2: &LG6= dg3D Conga Composer Winter 13 Release Page 41

42 PARAMETER LG7=[text] Sets the Activity Subject in the Follow-Up Activity Sets the Subject to the text specified. If not specified the Follow-Up Activity Subject is set to Follow-Up: and the Activity Subject value. Important: Do not use the less than (<) or greater than symbol (>) with this parameter Example 1: &LG7=Please+follow-up Example 2: &LG7={!Opportunity. Subject} LGAttachOption= [0, 1, 2 or 3] Sets the Salesforce object to which attachments generated during Activity Logging are stored If set to 0, attachments are saved to Notes & Attachments (default) If set to 1, attachments are saved to Salesforce Content If set to 2, attachments are saved to Salesforce Chatter If set to 3, attachments are saved to SpringCM &LG3=1 or 2 &LG4=1 or 2 Works with: AttachmentParentId (see below) AttachmentParentId=[id] Specifies the record in Salesforce to which the output file is attached, when requested. In the absence of this parameter, the default attachment parent record is the Master Object. A Salesforce Id of a object to which attachments are allowed. When used with LGAttachOption=2 (Chatter), this parameter may be set to a Chatter User Id or Chatter Group Id. LGParentId=[id] Overrides the default record against which a completed task is created. In the absence of this parameter, the task is created against the Master Object. A Salesforce Id of an object which allows Activity Tracking Example: &Id={!Opportunity.Id} &LGParentId={!Account.Id} LGWhoId=[id] Specifies the WhoId (the related Contact/Lead) when creating a Task record. A Salesforce Id of an object which allows Activity Tracking Conga Composer Winter 13 Release Page 42

43 PARAMETER MFTS0=[ApiFieldName] Also available: MFTS1, MFTS2 Master Field to Set The API Field Name of the field that should be set as part of the activity logging activity A value in the corresponding MFTSValue parameter (see below) As part of the Activity Logging family of parameters, this feature is usually triggered through Automatic Logging (&LG4=1 or 2) MFTSValue0=[text] Also available: MFTSValue1, MFTSValue2 Master Field to Set Value A value in the corresponding MFTS parameter Don t use with &, %, < or > or other special characters MFTSId0= Also available: MFTSId1, MFTSId2 Set a field on a non-master record For a long time Composer has allowed you to set a field on the Master Object. This behavior (known as Master Field to Set ) has been enhanced so that you may set a field on another record instead of the Master Object. This parameter must be used in conjunction with &MFTS0 and &MFTSValue0. Example: &id={!opportunity.id} &MFTSId0={!Account.Id} &MFTS0=Opportunity_Status c &MFTSValue0=Proposal+Created In this example, the Master Object is an Opportunity, however the Master Field to Set parameters are configured to set the Opportunity_Status c field on the related Account. The field would be set to Proposal Created. As is customary with Master Field to Set, fields are set as part of the Activity Logging options. Frequently, administrators choose to include the &LG4=1 or 2 parameter so that Activity Logging takes place automatically, and field updates are therefore automatically included. This parameter may be populated via a QVar query. Conga Composer Winter 13 Release Page 43

44 Conga Window Appearance The Conga Window Appearance Group lists the parameters that primarily affect the appearance of the Conga window. These parameters define: Interface Restriction Parameters Background Mode Parameters Interface Restriction Parameters For a variety of reasons, it may sometimes be desirable to pre-set certain settings on the Conga Composer dialog and restrict the user s ability to alter them. Note: This is a navigation/convenience feature, not a security feature. Though the parameters are deliberately cryptic to obscure their purpose, a determined user could potentially alter them in a URL and override the intended behavior. PARAMETER FP0=[0, 1 or 2] Locks the output file format If set to 0, Output Format is Same as template and the output format radio buttons are not locked (default) If set to 1, Output Format is Adobe Acrobat and the output format radio buttons are locked If set to 2, Output Format is Same as template and the output format radio buttons are locked DS0=[0 or 1] Disable Controls If set to 0, all controls in the Conga Composer dialog box (including buttons) are enabled (default) If set to 1, all controls in the Conga Composer dialog box (except the buttons) are disabled Conga Composer Winter 13 Release Page 44

45 PARAMETER DS1=[0 or 1] Disable Merge Button If set to 0, the Merge Button is enabled (default) If set to 1, the Merge Button is disabled DS2=[0 or 1] Disable Button If set to 0, the Button is enabled (default) If set to 1, the Button is disabled DS3=[0 or 1] Disable Log Activity Button If set to 0, the Log Activity Button is enabled (default) If set to 1, the Log Activity Button is disabled DS4=[0 or 1] Lock Template Choices If set to 0, the list of template choices is not locked (default) If set to 1, the selected template choice is locked TemplateId parameter must be configured In the absence of this parameter, the template indicated by the TemplateId parameter is pre-selected in the list, but the user may select a different template. This parameter prevents the user from selecting a different template. DS5=[0 or 1] Disable View Data link If set to 0, the View Data link is enabled (default) If set to 1, the View Data link is disabled DS6=[0 or 1] Disable View Template link If set to 0, the View Template link is enabled (default) If set to 1, the View Template link is disabled DS7=[code] Background Mode: Initiate Conga Composer without user intervention Complete details about Background Mode are contained in the next section, Background Mode Parameters DS8=[0 or 1] When enabled, makes the Choose a template from your local computer radio button visible, regardless of the corresponding setting on the Setup page If set to 0, the Local Templates radio button behaves according to the setting on the Setup page (default) If set to 1, the Local Templates radio button is displayed DS9=[0 or 1] Disable Template Builder link If set to 0, the Template Builder link is enabled (default) If set to 1, the Template Builder link is disabled You can find other, more advanced parameters for Conga Window Restrictions in the Advanced Parameters section. Conga Composer Winter 13 Release Page 45