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
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 email messages
• How activity logging should take place
Data-Gathering Parameters
The following parameters affect how Conga Composer gathers data from Salesforce.
PARAMETER DESCRIPTION
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 **
Requires:
A Salesforce Id of any record (Contact, Lead, Account, Custom Object, etc.) or a field that contains an Id
PARAMETER DESCRIPTION
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.
Requires:
A 15-character Salesforce Id of a Report. May optionally include filter criteria.
Example 1:
…&ReportId=00143532453dg3A Example 2: (two reports)
…&ReportId=00O43532453dg3A,00O43532453dgF2 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]00143532453dg3A Example 2: (two reports)
…&ReportId=[MyAccounts]00O43532453dg3A, [MyCases]00O43532453dgF2
For more options and a complete discussion of using Reports with Conga Composer, please see Using Salesforce Reports with Conga Composer , page 13
PARAMETER DESCRIPTION
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.
Requires:
A 15-character Salesforce Id of a Query record. May optionally include filter criteria.
Example 1:
…&QueryId=a00143532453dg3 Example 2: (two queries)
…&QueryId=a00143532453dg32,00143532453dgF2 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]a00143532453dg3 Example 2: (two queries)
…&QueryId=[MyAccounts]a00143532453dg32, [MyCases]a0043532453dgF2
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.
Template Selection Parameters
The following parameters pertain to merge templates.
PARAMETER DESCRIPTION
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).
Requires:
A 15-character Salesforce Id of a Template record Example 1:
…&TemplateId=00143532453dg3B Example 2 (multiple templates):
…&TemplateId=00143532453dg3B,001435121234499
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.
Requires:
• 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.
PARAMETER DESCRIPTION
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.
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:
https://www.appextremes.com/apps/Conga/Composer.aspx
?SessionID={!API.Session_ID}
&ServerURL={!API.Partner_Server_URL_210}
&Id={!Contact.Id}
&TemplateId=01H500000005tMS
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
This page intentionally left blank
Email Parameters
The standard Conga Composer dialog includes the option to generate the desired merge output and attach it directly to an outbound Salesforce email message. This feature can greatly reduce the time required to otherwise generate a merge file, save it to disk, launch an email message and attach the file – a great productivity tool.
Tip! The Email Parameters work with Conga's integration with SendGrid.
PARAMETER DESCRIPTION
EmailToId=[id] Sets the value of the To field.
Requires:
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 Email Templates, must use SendGrid integration, Leads and Conga Email Templates do not work with Salesforce email.
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., “…&EmailToId=+”
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:
…&EmailToId={!Contact.Id}
Example 2:
…&EmailToId=00143532453dg3C
NOTE: This parameter will not work when the master object is a Lead and you are using Conga email templates, there is a Salesforce limitation concerning Leads. It will however work when using standard Salesforce email templates.
EmailRelatedToId=[id] Sets the value of the Related To field.
Requires:
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 email 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:
…&EmailRelatedToId={!Opportunity.Id}
Example 2:
…&EmailRelatedToId=00143532453dg3D
EmailAdditionalTo=[text] Sets the value of the Additional To field.
Requires:
An email address or a field that contains one or more email addresses.
Example 1:
PARAMETER DESCRIPTION
EmailCC=[text] Sets the value of the CC field.
Requires:
An email address or a field that contains one or more email addresses.
Example 1:
…&EmailCC [email protected] Example 2:
…&EmailCC={!Contact.OtherEmailAddress}
EmailBCC=[text] Sets the value of the BCC field.
Requires:
An email address or a field that contains one or more email addresses.
Example 1:
…&EmailBCC [email protected] Example 2:
…&EmailBCC={!Contact.OtherEmailAddress}
EmailTemplateId=[id] Loads the subject and body fields from a Salesforce email template.
** Note: Attachments stored directly in the email template are not applied unless EmailTemplateAttachments is set to 1 **
Requires:
• A 15-character Salesforce Id of an email template stored in Setup | Communication Templates | Email Templates
• EmailRelatedToId parameter or EmailToId parameter must be set Example:
…&EmailTemplateId=00143532453dg7A
EmailSubject=[text] Sets the value of the Subject field.
If you set this parameter and use EmailTemplateId, this value will override the value of the Email Template’s Subject.
Requires:
Any text. Use + to indicate spaces.
Example 1:
…&EmailSubject=Thank+You Example 2:
…&EmailSubject=Account+Brief+for+{!Account.Name}
EmailTemplateAttachments=
[0 or 1] Indicates to preserve attachments stored with the Email Template.
• If set to 0, attachments stored on the Email Template are ignored
• If set to 1, attachments stored on the Email Template are
PARAMETER DESCRIPTION
EmailFromId=[id] Indicates an Organization-Wide Address as the From identity of the email.
Requires
• A 15-character Salesforce Id of an Organization-Wide Address as defined in Setup | Email 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
EmailReplyToId=[id] Changes the apparent sender of an email 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 email that is delivered in an unattended manner, e.g., Background Mode (DS7=12), Conga Conductor and Conga Workflow.
EmailUseSignature=[0 or 1] Indicates whether to include or exclude the sending user's signature from appearing in the email 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 email that is delivered in an unattended manner, e.g., Background Mode (DS7=12), Conga Conductor and Conga Workflow.
FAQ: Detailed example of using the Email parameters
Here’s an example that would be applicable to a Conga Composer button contained on a Case. It specifies who to address the Email to, establishes the Related object, specifies the Additional To and CC fields, and then specifies an Email Template.
https://www.appextremes.com/apps/Conga/Composer.aspx
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 DESCRIPTION
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-PARAMETER DESCRIPTION
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 Requires:
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=00553532453dg3D
LG6=[id] Sets the Assigned To field in the Follow-Up Activity Requires:
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=00553532453dg3D
PARAMETER DESCRIPTION
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
[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”
Requires:
• &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.
Requires:
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.
Requires:
• 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.
PARAMETER DESCRIPTION
MFTS0=[ApiFieldName]
Also available:
MFTS1, MFTS2
Master Field to Set Requires:
• 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 Requires:
• 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 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 DESCRIPTION
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
PARAMETER DESCRIPTION
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 Email Button
• If set to 0, the Email Button is enabled (default)
• If set to 1, the Email 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 Requires:
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