Difference between revisions of "How do I enter a report range?"

From Catalyst
Jump to: navigation, search
m (Les Ward moved page How do I Enter a Report Range? to How do I enter a report range?: Lower case (except for Platinum menu options))
Line 1: Line 1:
{{Incomplete}} {{Review}}
 
 
 
== Summary ==
 
== Summary ==
 
This article explains how to enter ranges for a report generator report.
 
This article explains how to enter ranges for a report generator report.
Line 16: Line 14:
 
== Fields ==
 
== Fields ==
 
=== Var ===
 
=== Var ===
* Enter the variables on which you want to range your report.
+
* Enter the variables on which you want to range your report. You can search for the appropriate and available variables using the {{DataPrompt|Help}} function.
  
 
=== Parameters ===
 
=== Parameters ===
* If your variable has parameters, enter the one you want here.
+
* If your variable has parameters, enter the ones you want here.
  
 
=== Op. ===
 
=== Op. ===
* Enter the {{DataPrompt|Op.}} that you want for the first variable. This defines how you want the variable compared to the {{DataPrompt|Limit/Comparison}} field.  
+
* Enter the {{DataPrompt|Op.}} that you want for this variable. This defines how you want the variable to be evaluated against the {{DataPrompt|Limit/Comparison}} field.  
 
{{Note|Title=Note|text=For a list of Op. values, use the {{DataPrompt|Help}} function on the field.}}
 
{{Note|Title=Note|text=For a list of Op. values, use the {{DataPrompt|Help}} function on the field.}}
  
 
=== Limit/Comparison ===
 
=== Limit/Comparison ===
* Enter the value for this variable.
+
* Enter the value for the variable on this line.
  
 
=== AND/OR ===
 
=== AND/OR ===
 
* This field will only take the value of {{DataValue|A}} for And, or {{DataValue|O}} for Or. How you set this will depend on what you are trying to do with your report and the range or ranges that you are setting.
 
* This field will only take the value of {{DataValue|A}} for And, or {{DataValue|O}} for Or. How you set this will depend on what you are trying to do with your report and the range or ranges that you are setting.
{{Note|Title=Note|text=You will need to make sure that the logic of your filter is clear,.
+
{{Note|Title=Note|text=You will need to make sure that the logic of your filter is clear. For example, the same variable cannot be equal to one value AND equal to a second value in the range; it could however be equal to one value OR equal to a second value. Bear in mind though that an OR will split your range unless you put the variables being compared by the ORs in brackets.}}
 +
 
 +
== Other options ==
 +
There are three layouts that you can use for ranges.
 +
=== Simple ===
 +
The simple layout has the {{DataPrompt|variables}} down the left hand side of the screen and the {{DataPrompt|AND/OR}} down the right hand side. This works well if you are creating a simple report where {{DataPrompt|AND/OR}} is always one setting and you don't use a lot of variables.
 +
 
 +
=== Detail Line Filter ===
 +
This layout is more complicated to use as you have to select the variable from the search or know the code for the variable that you want, and you will have to choose the {{DataPrompt|AND/OR}} option that you want. Brackets may also be appropriate if you are using {{DataPrompt|OR}} in the filter.
 +
 
 +
=== Detail Filter ===
 +
This layout is an extension of the Detail Line Filter above but converts the whole range into a page to enter the variables and the operators that you want to use. For sophisticated reports where the range needs to cover a lot of options, this is the range layout to use.
 +
 
 +
== See also ==
 +
* [[Getting started - Report Generator]]
 +
* [[What is a Report Generator variable?]]
 +
* [[How do I Create a Report Sort Order?]]

Revision as of 10:14, 17 December 2018

Summary

This article explains how to enter ranges for a report generator report.

More Information

The Range for a report defines the limits of what will be included.

Examples of how you might set your ranges could include just a single date or range of dates, a range of customers or suppliers or any other item that takes your fancy!

There are three levels of ranges - see Why are there three ranges? to understand the purpose of this.

Entering a Range

  • Edit the report and go to " Range Filter (1)".

Fields

Var

  • Enter the variables on which you want to range your report. You can search for the appropriate and available variables using the "Help" function.

Parameters

  • If your variable has parameters, enter the ones you want here.

Op.

  • Enter the "Op." that you want for this variable. This defines how you want the variable to be evaluated against the "Limit/Comparison" field.
For a list of Op. values, use the "Help" function on the field.

Limit/Comparison

  • Enter the value for the variable on this line.

AND/OR

  • This field will only take the value of 'A' for And, or 'O' for Or. How you set this will depend on what you are trying to do with your report and the range or ranges that you are setting.
You will need to make sure that the logic of your filter is clear. For example, the same variable cannot be equal to one value AND equal to a second value in the range; it could however be equal to one value OR equal to a second value. Bear in mind though that an OR will split your range unless you put the variables being compared by the ORs in brackets.

Other options

There are three layouts that you can use for ranges.

Simple

The simple layout has the "variables" down the left hand side of the screen and the "AND/OR" down the right hand side. This works well if you are creating a simple report where "AND/OR" is always one setting and you don't use a lot of variables.

Detail Line Filter

This layout is more complicated to use as you have to select the variable from the search or know the code for the variable that you want, and you will have to choose the "AND/OR" option that you want. Brackets may also be appropriate if you are using "OR" in the filter.

Detail Filter

This layout is an extension of the Detail Line Filter above but converts the whole range into a page to enter the variables and the operators that you want to use. For sophisticated reports where the range needs to cover a lot of options, this is the range layout to use.

See also