Difference between revisions of "Report Options"

From Lianjapedia
Redirect page
Jump to: navigation, search
(Redirected page to Lianja 5 Report Options)
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
''Under Construction''
+
#REDIRECT [[Lianja 5 Report Options]]
  
 
==See Also==
 
==See Also==
[[Report Section Attributes]]
+
[[Developing Quick Reports]], [[Report Section Attributes]]
  
 
==Overview==
 
==Overview==
Line 21: Line 21:
  
 
The 'Lianja Web UI Demo' (example_webapp2) is included in the Lianja App Builder distribution.  
 
The 'Lianja Web UI Demo' (example_webapp2) is included in the Lianja App Builder distribution.  
 
It has three full page Report Sections.
 
  
 
<br clear=all>
 
<br clear=all>
  
 
[[{{ns:file}}:report2.png|450px|thumb|left|link={{filepath:report2.png}}|example_webapp2 App]]
 
[[{{ns:file}}:report2.png|450px|thumb|left|link={{filepath:report2.png}}|example_webapp2 App]]
 +
 +
 +
 +
 +
It has three full page Report Sections.
  
 
<br clear=all>
 
<br clear=all>
Line 42: Line 45:
  
 
The Details section at the top of the attributes dialog holds the specification of the '''Database''' and '''Table'''.
 
The Details section at the top of the attributes dialog holds the specification of the '''Database''' and '''Table'''.
 +
 +
If the '''Database''' and '''Table''' are omitted, the ''southwind'' database and the ''example'' table are the default values.
  
 
Note that the report is based on a single table.  However, this table can be a Virtual Table based on a SQL Select query to local or remote tables.  See [[:Category:Third Party Database Connectivity|here]] for information on Virtual Tables.
 
Note that the report is based on a single table.  However, this table can be a Virtual Table based on a SQL Select query to local or remote tables.  See [[:Category:Third Party Database Connectivity|here]] for information on Virtual Tables.
  
The Report Section options are described here.
+
 
 +
The Report Section options are described here:
  
 
===Report type===
 
===Report type===
Line 52: Line 58:
 
===Heading===
 
===Heading===
 
The '''Heading''' attribute specifies text to use as the report heading.
 
The '''Heading''' attribute specifies text to use as the report heading.
 +
 +
e.g.
 +
 +
<pre>Client Credit List (over limit)</pre>
  
 
The '''Heading''' attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportHeading]].
 
The '''Heading''' attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportHeading]].
Line 59: Line 69:
 
===Filter===
 
===Filter===
 
The '''Filter''' attribute specifies a logical expression used to restrict which records will be included in the report.
 
The '''Filter''' attribute specifies a logical expression used to restrict which records will be included in the report.
 
The '''Filter''' attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportFilter]].
 
  
 
e.g. the ''Clients over credit limit'' report filters on the ''available'' field being less than zero:
 
e.g. the ''Clients over credit limit'' report filters on the ''available'' field being less than zero:
  
 
<pre>available < 0</pre>
 
<pre>available < 0</pre>
 +
 +
The '''Filter''' attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportFilter]].
 +
 
[[#Notes on Client Support|Notes on Client Support]]
 
[[#Notes on Client Support|Notes on Client Support]]
  
 
===Fields===
 
===Fields===
The '''Fields''' attribute specifies the fields to be included in the report.  This should be a comma separated list of field names or expressions. '''*''' selects all fields in the table.
+
The '''Fields''' attribute specifies the fields to be included in the report.  This should be a comma separated list of field names or expressions.  
 +
 
 +
e.g.
 +
 
 +
<pre>account_no, upper(concat(title," ",first_name,last_name)),limit</pre>
 +
 
 +
or, to select all fields in the table as in the example_webapp2 reports:
 +
 
 +
<pre>*</pre>
  
 
The '''Fields''' attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportFields]].
 
The '''Fields''' attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportFields]].
  
 
[[#Notes on Client Support|Notes on Client Support]]
 
[[#Notes on Client Support|Notes on Client Support]]
 +
 
===Columns===
 
===Columns===
The '''Columns''' attribute specifies the column positions for the selected fields in the report.  This should be a comma separated list of numeric column positions.
+
The '''Columns''' attribute specifies the column positions for the selected fields in the report.  This should be a comma separated list of numeric column positions. If '''Columns''' is left blank, all fields are displayed and in the same order as in the '''Fields''' attribute.
 +
 
 +
e.g. the ''Clients over credit limit'' report omits field 1 (example.account_no) from the display and swaps the order of fields 3 (example.first_name) and 4 (example.last_name).
 +
 
 +
<pre>2,4,3,5,6,7,8,9,10,11</pre>
  
 
The '''Columns''' attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportColumns]].
 
The '''Columns''' attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportColumns]].
Line 82: Line 106:
 
===Column headings===
 
===Column headings===
 
The '''Column headings''' attribute specifies the text to be used as the report column headings.  This should be a comma separated list of text strings.
 
The '''Column headings''' attribute specifies the text to be used as the report column headings.  This should be a comma separated list of text strings.
 +
 +
If '''Column headings''' is left blank, the descriptions from the fields in the table are used.  Unless '''Fields''' is '''*''', the '''Column headings''' should be entered to match the chosen field selection and order.
 +
 +
e.g. if '''Fields''' is:
 +
 +
<pre>account_no, upper(concat(title," ",first_name,last_name)),limit</pre>
 +
 +
then '''Column headings''' is:
 +
 +
<pre>Account,Fullname,Credit Limit</pre>
  
 
The '''Column headings''' attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportColumnHeadings]] or [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportHeadings]].
 
The '''Column headings''' attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportColumnHeadings]] or [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportHeadings]].
Line 88: Line 122:
  
 
===Subtotals===
 
===Subtotals===
The '''Subtotals''' attribute specifies the columns in the report to be sub-totalled.  This should be a comma separated list of numeric column positions.
+
The '''Subtotals''' attribute specifies the columns in the report to be sub-totalled.  This should be a comma separated list of numeric column positions of numeric fields.
 +
 
 +
e.g.
 +
 
 +
<pre>9,10,11</pre>
  
 
The '''Subtotals''' attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportSubTotals]].
 
The '''Subtotals''' attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportSubTotals]].
Line 96: Line 134:
 
===Group by===
 
===Group by===
 
The '''Group by''' attribute specifies the name of the field or the expression that the report data will be grouped by for sub-totalling.
 
The '''Group by''' attribute specifies the name of the field or the expression that the report data will be grouped by for sub-totalling.
 +
 +
e.g.
 +
 +
<pre>state</pre>
  
 
The '''Group by''' attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportGroupBy]].
 
The '''Group by''' attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportGroupBy]].
Line 117: Line 159:
 
===Pagination===
 
===Pagination===
 
The '''Pagination''' attribute specifies whether the rows displayed should be paginated (True &#124; False).
 
The '''Pagination''' attribute specifies whether the rows displayed should be paginated (True &#124; False).
 +
 +
Pagination is not currently implemented.
  
 
===Pagination size===
 
===Pagination size===
 
The '''Pagination size''' attribute specifies the number of rows to display per page.
 
The '''Pagination size''' attribute specifies the number of rows to display per page.
 +
 +
Pagination is not currently implemented.
  
 
===Other options===
 
===Other options===
Line 139: Line 185:
  
 
[[#Notes on Client Support|Notes on Client Support]]
 
[[#Notes on Client Support|Notes on Client Support]]
 +
 +
==Delegate Behavior==
 +
 +
===Delegate hyperlinks===
 +
Delegate hyperlinks in page to page and/or section (True &#124; False).
 +
 +
===Delegate page===
 +
Delegate page name to search (leave blank if current page).
 +
 +
===Delegate section===
 +
Delegate section name (leave blank if default searchkey section on page).
 +
 +
===Delegate script===
 +
Delegate script name (URL is passed as character string).
  
 
==Notes on Client Support==
 
==Notes on Client Support==
Line 164: Line 224:
 
|valign="top"|Hyperlinks||Lianja.getElementByID("page.section").reportHyperlink is exposed on the Desktop client only (Lianja/VFP).
 
|valign="top"|Hyperlinks||Lianja.getElementByID("page.section").reportHyperlink is exposed on the Desktop client only (Lianja/VFP).
 
|-
 
|-
|valign="top"|Show grid lines||Lianja.getElementByID("page.section").reportGridLines is exposed on the Desktop client only (Lianja/VFP).
+
|valign="top"|Show grid lines||Grid lines are currently always shown.<br>Lianja.getElementByID("page.section").reportGridLines is exposed on the Desktop client only (Lianja/VFP).
 
|-
 
|-
|valign="top"|Pagination||-
+
|valign="top"|Pagination||Pagination is not currently implemented.
 
|-
 
|-
|valign="top"|Pagination size||-
+
|valign="top"|Pagination size||Pagination is not currently implemented.
 
|-
 
|-
 
|valign="top"|Other options||Lianja.getElementByID("page.section").reportOtherOptions is exposed on the Desktop client only (Lianja/VFP).
 
|valign="top"|Other options||Lianja.getElementByID("page.section").reportOtherOptions is exposed on the Desktop client only (Lianja/VFP).
 +
|-
 +
|valign="top"|Delegate hyperlinks||
 +
|-
 +
|valign="top"|Delegate page||
 +
|-
 +
|valign="top"|Delegate section||
 +
|-
 +
|valign="top"|Delegate script||
 
|-
 
|-
 
|}
 
|}
Line 199: Line 267:
  
 
==Reporting Alternatives==
 
==Reporting Alternatives==
 +
The Lianja ODBC Driver, in conjunction with the Lianja SQL Server, can be used with third party report writers such as Crystal Reports or Microsoft Report Builder.
 +
 
[[Category:Attribute Categories]]
 
[[Category:Attribute Categories]]
 +
[[Category:Sections]]

Revision as of 08:50, 6 December 2019