Output Template Fields
The output template object contains the settings that link the Output Builder to the required objects and, if applicable, the Output Builder interface. For reports that you intend to email, the output template instructs the header component of the email including the subject line and recipient. Here is a description of the fields that make up an output template.
Field | Description |
---|---|
Attachment Message | This setting defines the content of the email to which a report sent to users is attached: for example, "Your report is attached". This can be plain text or use Output Builder markup. |
Automation Criteria | Criteria to use to determine which objects to include in a batch of reports. This must be in the format of the where clause in an SOQL statement. For instance, if you are creating an output template on the Project__c object, you could use one of these:pse__Is_Active__c = true This example has a complete SOQL query embedded: pse__Is_Active__c = true AND pse__Region__c IN (SELECT ID FROM pse__Region__c WHERE Name like ‘Strategic Region %’) pse__Is_Active__c = true OR pse__Inactive_Project_Backlog__c != 0 |
BCC | Person to send a blind copy of the email to. This field works in a similar way to that described in the To field. |
CC | Person to send a copy of the email to. This field works in a similar way to that described in the To field. |
Content Type | Mime type of the template. This specifies the application that the template is written for. For instance, if the template body is written as an Microsoft Excel XML template, select application/vnd.ms-excel. See |
Content Type Extension | File extension of the Content Type. Leave the value blank for HTML content. If you want the report sent as an attachment, specify the extension for the content type. For instance, if the content is a Microsoft Word document, you can set the value to doc. |
BCC Sender | Indicates whether the template is to automatically BCC Blind Carbon Copy. A means of sending an email to several people and concealing the list of recipients of that email. the report to the sender. The default value is false. |
Description | Description of the template and how it is to be used. |
Interface Class Name | The name of the class that Output Builder should call during the batch report generation process. |
Is Default for Class | Indicates whether the report template is the default for the Template Class. When true, the template is selected by default when you run the report. You can change the template to use for a specific record. Output builder remembers this choice. |
Keep History | Indicates whether history of all reports is retained, or whether only the last report is kept. |
Object Description Field | The field in the object specified in Object Name that is to be used to help identify the record that the report is being generated on. The default value is Name. |
Object Name | API name of the Salesforce object that contains the data to generate the report. |
Output Template Name | Name of the Template. |
Related List Field | API name of the field in the Output History object that is to link to the object on which the report is to be run. This is so you can add the Output History related list to your object. For instance, You can link the Project Name field to the Output History. See Setting up the Related List in the Output History |
Reply To | The email address that the recipients are to respond to. This field can be a literal email address, <user> which automatically resolves to the email address of the user generating the report or any valid markup. |
Require Approval to Send | Indicates whether an approval process is required before you can send the report. When selected, and the report is not approved, the Save Only button is visible and the Save and Send button is hidden. |
Save Only | Indicates whether all sending features of the template are turned off. When selected, the To, CC and BCC fields on the report are not displayed. In addition, the Send and Resend links in the output history pages are hidden. When selected, batch processes only save reports and do not send them regardless of whether they are initiated automatically or from a list view. |
Sender Display Name | The name of the person who recipients are to respond to. This field can be a static string, literal email address, <user> which automatically resolves to the email address of the user generating the report or any valid markup. |
Subject | Subject line of the report email. You can include HTML tags with field names to get the object name and the date on which the report was run. Here is an example:<field name="Name"/> Status Report - as of <date format="mm/dd/yyyy"/> |
Template Class | Name for this template that relates all other templates of the same type. This is a type that you define. You can create several templates that belong to the same type. For instance, StatusReport or AccountSummary . You must specify the same value for the Class when adding a button to invoke the report. See
Adding a Button to Run a Report . When you run a report, the template which is the default for the class is selected by default. |
To | Person to send the email to. If you leave this value blank, the person creating the report can supply their own values. If you enter a value in this field, the person generating the report cannot change the email address to send the report to. You can enter email addresses or values from an object field. Here are some examples: <field name="email__c"/> <field name="approver_email__c"/> <field name="MyCustomTable__r.Manager_Email__c" /> <field name="Account.Email"/> <field name="Account.Parent.Email"/> <field name="Account.Parent.Parent.Email"/> |
Use Intelligent Email Limit Management | Indicates whether, when sending reports to email addresses belonging to internal Salesforce users, Output Builder emails the users directly. Applies to recipients in the To , CC or BCC fields on the output template. |
Output Template Body Fields
The output template body can be populated with any XML-based language (for example, HTML) in order to generate the body of the report, as well as the email if reports are intended to be sent by email. Here is a description of the fields that make up an output body template.
Field | Description |
---|---|
Body | HTML Body of the report. See Output Template Body HTML Definitions. |
Description | Description of the template body to help keep track when there is more than one template body in a report, |
Order Template | Template to which the template body applies. |
Sequence | Order of the template body when there is more than one template body in a report. |
Buttons
Button | Description |
---|---|
Edit | Allows you to edit the output template. |
Delete | Allows you to delete the output template. |
Clone | Allows you to copy the output template. |
Automation | Allows you to generate or schedule generation of batches of reports depending on criteria that you specify. See Automation Criteria. |
New Output Template Body | Creates a new output template body and attaches it to the output template. |
Validate | Validates the template for common problems such as incomplete or missing tags. |