Difference between revisions of "Criteria Template"

From SmartWiki
Jump to: navigation, search
(→‎Variables)
Line 3: Line 3:
 
The Criteria Template section on the [[Report Template]] tab of the [[Creating a Basic Report|Edit Report Page]] defines the criteria section of a custom report template containing the prompt(s) for report [[parameter]](s) when [[criteria|report criteria]] are used.
 
The Criteria Template section on the [[Report Template]] tab of the [[Creating a Basic Report|Edit Report Page]] defines the criteria section of a custom report template containing the prompt(s) for report [[parameter]](s) when [[criteria|report criteria]] are used.
  
−
The Criteria Template section accepts HTML code. When the Criteria Template is used, the report parameter prompt does not manifest as a pop-up when the report is run, but remains at the top of the page.  
+
When the Criteria Template is used, the report parameter prompt does not manifest as a pop-up when the report is run, but remains at the top of the page.  
  
−
'''Example:''' A simple report is built as follows that prompts the user for the first name of a contact when run:<br /><br />
+
''Example'': Our report prompts the user for two criteria:<br />
  
−
[[Image:CriteriaTemplate-ReportBuilder.png|link=|400px]]<br /><br />
+
[[Image:CriteriaTemplate-CriteriaSetInReport.png|link=]]
−
The default prompt for the report will appear as follows, a concatenation of the recordset and field name specified in the [[Report Builder]]:<br /><br />
 
−
[[Image:CriteriaTemplate-DefaultPrompt.png|link=|350px]]<br /><br />
 
−
Right click on the page and choose the option in your [[browser]] that will expose the page HTML source. Then scroll down to and copy the section that contains the criteria table: <br /><br />
 
−
[[Image:CriteriaTemplate-SourceTable.png|link=|450px]]<br /><br />
 
−
Then go to your Edit Report page, select the Report Template tab and paste the HTML code for the criteria table into the Criteria Template section:<br /><br />
 
−
[[Image:CriteriaTemplate-PasteIntoTemplate.png|link=|650px]]<br /><br />
 
−
You can then edit the HTML code:<br /><br />
 
−
[[Image:CriteriaTemplate-EditedTemplate.png|link=|650px]]<br /><br />
 
−
The resultant report, when run, will contain the criteria section you have defined at the top of the report:<br /><br />
 
−
[[Image:CriteriaTemplate-ResultantReport.png|link=|450px]]
 
−
<br /><br />
 
  
  

Revision as of 10:35, 16 May 2014

The Criteria Template section on the Report Template tab of the Edit Report Page defines the criteria section of a custom report template containing the prompt(s) for report parameter(s) when report criteria are used.

When the Criteria Template is used, the report parameter prompt does not manifest as a pop-up when the report is run, but remains at the top of the page.

Example: Our report prompts the user for two criteria:

CriteriaTemplate-CriteriaSetInReport.png


Variables

To show certain buttons on the criteria page, you can reference variables in the Criteria Template:

  • @submitbutton@
  • @exportbutton@
  • @fileexportbutton@

For reports containing multiple criteria, the variable syntax for the different criteria elements is argn where n is the order of the criteria defined in the Report Builder.

  • @arg1.label@ returns the text label of the input
  • @arg1@ returns the input field for the criteria
  • @arg1.id@ returns the element ID of the input

Notes

  • The Criteria template is not rebuilt when the report is rebuilt.

See Also

Retrieved from ‘https://wiki.smartsimple.com/index.php?title=Criteria_Template&oldid=21968’