Difference between revisions of "What is a report generator variable?"

From Catalyst
Jump to: navigation, search
(New page: == Summary == This article attempts to describe what a variable is and how they are used. == More Information == === What is it? === Essentially, a variable is a substitution for dynamic ...)
 
m
 
(14 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
== Summary ==
 
== Summary ==
This article attempts to describe what a variable is and how they are used.
+
This article describes what a ''variable'' is and how they are used.
  
 
== More Information ==
 
== More Information ==
=== What is it? ===
+
=== What are they? ===
 
Essentially, a variable is a substitution for dynamic information.
 
Essentially, a variable is a substitution for dynamic information.
  
 
=== How are they used? ===
 
=== How are they used? ===
This information comes from your database (customer, supplier, stock, vehicle etc) and is inserted into report. They can also be calculated from a collection of information (period balances etc).
+
This information comes from your database (customers, suppliers, stock, units, etc.) and is inserted into a report. The information can also be calculated from a collection of information (period balances, etc).
  
== Example ==
+
{{Example|text=
* A01 is the ''variable'' for if an account is a customer or supplier.  
+
* [[REF:rprgva01|A01]] is the ''variable'' for whether an account is a customer or supplier.
* A02 is the ''variable'' for a customer or supplier code.
+
* [[REF:rprgva02|A02]] is the ''variable'' for a customer or supplier code.
  
To filter a report for a customer code of {{DataValue|ABC001}} you would need a range of :-
+
To produce a report for customer {{DataValue|ABC001}} you would need a ''range'' of:
  
 
   A01 = "S" AND A02 = "ABC001"
 
   A01 = "S" AND A02 = "ABC001"
  
The ''variables'' {{DataValue|A01}} and {{DataValue|A02}} would be replaced with the values from your customer database before the range was executed.
+
The ''variables'' {{DataValue|A01}} and {{DataValue|A02}} are substituted with the values from your customer database and then the range is tested. "'''='''" indicates a comparison that tests whether two values match.
  
For a customer code of {{DataValue|ABB001}} the range would be evaluated as :-
+
For a customer code of {{DataValue|ABB001}} the range would be evaluated as:
  
 
   "S" = "S" AND "ABB001" = "ABC001"
 
   "S" = "S" AND "ABB001" = "ABC001"
  
This range would fail as the second comparison doesn't match.
+
This test would fail as the second comparison doesn't match.
  
For a customer code of {{DataValue|ABC001}} the range would be evaluated as :-
+
For a customer code of {{DataValue|ABC001}} the range would be evaluated as:
  
 
   "S" = "S" AND "ABC001" = "ABC001"
 
   "S" = "S" AND "ABC001" = "ABC001"
  
This range would pass as the both comparisons match.
+
This test would pass as both comparisons match.
 +
}}
  
== Where Used ==
+
=== Where Used ===
 
* Sort Order
 
* Sort Order
 
* Ranges
 
* Ranges
 
* Columns
 
* Columns
  
{{FAQ}}{{MClass}}{{KB_Tags|report generator variable, data, information}}{{KB_RGen}}
+
== Variable Details ==
 +
Each Variable has a reference file. This contains information about the variable and how it can be used. It also explains any parameters attached to a variable and, where relevant, what the default
 +
parameter will be.
 +
 
 +
On any field where you can enter a variable press {{KeyPress|S-F2}} or, where present, click on the {{Button|Reference}} button at the top of the screen.
 +
 
 +
== See also ==
 +
* [[:Category:Reports & Settings Report Generator functions|Report Generator functions]]
 +
* [[Column types in the report generator]]
 +
* [[Hidden report generator columns]]
 +
* [[How do I use calculation sequence?]]
 +
* [[Why are there three report ranges?]]
 +
* [[REF:rprgvc01|Accessing the values of other columns.]]
 +
 
 +
{{KB_Tags|report generator variable, data, information}}
 +
{{FAQ}}{{MClass}}{{KB_RGen}}

Latest revision as of 08:11, 17 April 2019

Summary

This article describes what a variable is and how they are used.

More Information

What are they?

Essentially, a variable is a substitution for dynamic information.

How are they used?

This information comes from your database (customers, suppliers, stock, units, etc.) and is inserted into a report. The information can also be calculated from a collection of information (period balances, etc).

  • A01 is the variable for whether an account is a customer or supplier.
  • A02 is the variable for a customer or supplier code.

To produce a report for customer 'ABC001' you would need a range of:

 A01 = "S" AND A02 = "ABC001"

The variables 'A01' and 'A02' are substituted with the values from your customer database and then the range is tested. "=" indicates a comparison that tests whether two values match.

For a customer code of 'ABB001' the range would be evaluated as:

 "S" = "S" AND "ABB001" = "ABC001"

This test would fail as the second comparison doesn't match.

For a customer code of 'ABC001' the range would be evaluated as:

 "S" = "S" AND "ABC001" = "ABC001"
This test would pass as both comparisons match.

Where Used

  • Sort Order
  • Ranges
  • Columns

Variable Details

Each Variable has a reference file. This contains information about the variable and how it can be used. It also explains any parameters attached to a variable and, where relevant, what the default parameter will be.

On any field where you can enter a variable press <Shift+F2> or, where present, click on the [Reference] button at the top of the screen.

See also


Feedback
Thank you for using our Knowledge Base, we value your feedback. Did you find this article useful? 'Yes' or 'No'
Keywords AND Misspellings
report generator variable, data, information