[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
gnue/reports INSTALL TODO doc/ReportingConcepts...
|
From: |
Jason Cater |
|
Subject: |
gnue/reports INSTALL TODO doc/ReportingConcepts... |
|
Date: |
Mon, 15 Apr 2002 18:05:05 -0400 |
CVSROOT: /cvsroot/gnue
Module name: gnue
Changes by: Jason Cater <address@hidden> 02/04/15 18:05:02
Modified files:
reports : INSTALL TODO
reports/doc : ReportingConcepts.lyx
Log message:
doc fixes
CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/gnue/gnue/reports/INSTALL.diff?tr1=1.7&tr2=1.8&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/gnue/gnue/reports/TODO.diff?tr1=1.4&tr2=1.5&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/gnue/gnue/reports/doc/ReportingConcepts.lyx.diff?tr1=1.3&tr2=1.4&r1=text&r2=text
Patches:
Index: gnue/reports/INSTALL
diff -c gnue/reports/INSTALL:1.7 gnue/reports/INSTALL:1.8
*** gnue/reports/INSTALL:1.7 Mon Apr 15 13:43:05 2002
--- gnue/reports/INSTALL Mon Apr 15 18:05:02 2002
***************
*** 67,73 ****
=============
Make sure that you have a valid /usr/local/gnue/etc/gnue.conf and
! a valid /usr/loca/gnue/etc/report-filters.conf. Sample versions of
these files are installed by gnue-common as sample.gnue.conf and
sample.report-filters.conf. These samples will be sufficient for
most sites. Simply copy the sample files to the needed files.
--- 67,73 ----
=============
Make sure that you have a valid /usr/local/gnue/etc/gnue.conf and
! a valid /usr/local/gnue/etc/report-filters.conf. Sample versions of
these files are installed by gnue-common as sample.gnue.conf and
sample.report-filters.conf. These samples will be sufficient for
most sites. Simply copy the sample files to the needed files.
Index: gnue/reports/TODO
diff -c gnue/reports/TODO:1.4 gnue/reports/TODO:1.5
*** gnue/reports/TODO:1.4 Sun Apr 14 01:19:37 2002
--- gnue/reports/TODO Mon Apr 15 18:05:02 2002
***************
*** 1,19 ****
! These tasks are not in any kind of order. Some take much greater priority
than others. Some are simple fixes while others are major subprojects. Do
! not read into anything according to the lists here other than these are not
! completed yet! :)
! * Add Common's "format mask" support to fields and params
! * Implement sortoption support in Data Sources
! * Implement "importing" from libraries
! (involves moving import code from Forms to Common)
! * Make into a "server"
! (many small tasks involved -- mainly waiting on
! Common's GServerApp and GComm to materialize.)
ROADMAP
--- 1,24 ----
! These tasks are not in any kind of order. Some take much greater priority
than others. Some are simple fixes while others are major subprojects. Do
! not read into anything according to the lists here -- other than these are
! not completed yet! :)
! * Add GNUe-Common's "format mask" support to fields and params
! * Implement sortoption support in Data Sources (this will mostly
! require changes in GNUe-Common)
! * Decide upon the needed triggers and add support for these.
! * Implement "formula" support.
+ * Implement "importing" from libraries (involves moving import
+ code from Forms to Common)
+
+ * Make into a "server" (many small tasks involved -- mainly
+ waiting on Common's GServerApp and GComm to materialize.)
+
+ * Decide on a "formal" output markup.
ROADMAP
Index: gnue/reports/doc/ReportingConcepts.lyx
diff -c gnue/reports/doc/ReportingConcepts.lyx:1.3
gnue/reports/doc/ReportingConcepts.lyx:1.4
*** gnue/reports/doc/ReportingConcepts.lyx:1.3 Sun Apr 14 01:19:37 2002
--- gnue/reports/doc/ReportingConcepts.lyx Mon Apr 15 18:05:02 2002
***************
*** 1,11 ****
#LyX 1.1 created this file. For more info see http://www.lyx.org/
\lyxformat 218
! \textclass linuxdoc
\language english
\inputencoding default
\fontscheme default
\graphics default
! \paperfontsize 10
\spacing single
\papersize Default
\paperpackage a4
--- 1,14 ----
#LyX 1.1 created this file. For more info see http://www.lyx.org/
\lyxformat 218
! \textclass docbook
! \begin_preamble
! <!entity header system "header.sgml">
! \end_preamble
\language english
\inputencoding default
\fontscheme default
\graphics default
! \paperfontsize default
\spacing single
\papersize Default
\paperpackage a4
***************
*** 23,29 ****
\paperpagestyle default
\layout Title
! \added_space_top vfill \added_space_bottom vfill
GNUe Reporting Concepts
\layout Author
--- 26,32 ----
\paperpagestyle default
\layout Title
!
GNUe Reporting Concepts
\layout Author
***************
*** 46,54 ****
--- 49,133 ----
\layout Section
Introduction
+ \layout Standard
+
+ GNUe Reports is the primary reporting agent of the GNU Enterprise project.
+ GNUe Reports is designed to extract data from diversified data sources
+ (including all major database vendors) and generate platform- and
output-indepe
+ ndent reports.
+
\layout Section
Reporting Overview
+ \layout Subsection
+
+ XML, XSL, and Output Formats
+ \layout Standard
+
+ GNUe Reports uses XML to define reports and as an intermediary format prior
+ to the final output.
+ In other words, GNUe Reports reads in an XML report definition, uses this
+ definition to extract data from a database backend, and generates an
XML-based
+ report output.
+ This output can then be transformed into text, HTML, Postscript, PDF, TeX,
+ word processor, Spreadsheet, or a wide variety of other formats.
+ (Currently, HTML and text outputs are directly supported without the use
+ of an intermediary converter.) For other formats, one of the natively
supported
+ formats can be piped through another utility (such as ghostscript) to
generate
+ a multitude of other formats.
+
+ \layout Standard
+
+ GNUe Reports currently uses XSL Transforms to go from the
+ \begin_inset Quotes eld
+ \end_inset
+
+ report
+ \begin_inset Quotes erd
+ \end_inset
+
+ xml output to the final formats,
+ \begin_inset Quotes eld
+ \end_inset
+
+ text
+ \begin_inset Quotes erd
+ \end_inset
+
+ and
+ \begin_inset Quotes eld
+ \end_inset
+
+ html
+ \begin_inset Quotes erd
+ \end_inset
+
+ .
+ It is not difficult to create new formats by creating a new XSL script.
+ It is also easy to create company-customized reports by modifying a few
+ lines of XSL.
+ In the future, we plan to support
+ \begin_inset Quotes eld
+ \end_inset
+
+ templated
+ \begin_inset Quotes erd
+ \end_inset
+
+ reports so site customizations can be more easily accomplished without
+ the need to know XSL.
+
+ \layout Subsection
+
+ Reporting Model
+ \layout Standard
+
+ The two primary components of a report definition are the datasources and
+ the layout directives.
+ The datasources tie the report to a database backend.
+ In a relational database environment, a datasource typically corresponds
+ to a table or a view.
+
\layout Section
Datasources
***************
*** 112,118 ****
\layout Section
Sorting Options
! \layout Subparagraph
Sorting Options are not fully supported in GNUe Reports.
This will be added in an upcoming release.
--- 191,197 ----
\layout Section
Sorting Options
! \layout Comment
Sorting Options are not fully supported in GNUe Reports.
This will be added in an upcoming release.
***************
*** 124,130 ****
\layout Section
Triggers
! \layout Subparagraph
Triggers are not currently supported in GNUe Reports.
This will be added in an upcoming release.
--- 203,209 ----
\layout Section
Triggers
! \layout Comment
Triggers are not currently supported in GNUe Reports.
This will be added in an upcoming release.
***************
*** 198,204 ****
\lang american
These triggers are not yet implemented.
Plans for these triggers may change prior to implementation.
! Use this section only as a tool to understand our conceptual plans.
\layout Standard
--- 277,283 ----
\lang american
These triggers are not yet implemented.
Plans for these triggers may change prior to implementation.
! Use this section only as a tool to understand our conceptual direction.
\layout Standard
***************
*** 269,279 ****
Post-Process
\series default
- Fires after selecting and processing all records ?????
- \layout Description
-
-
- \lang american
- On-newrecord Fires whenever a new record is created.
\layout Section
Standard Layout Elements
--- 348,353 ----
***************
*** 285,324 ****
Sections
\layout Standard
! Sections serve a dual purpose --
\layout Subsection
Fields
! \layout Code
!
! <field name=
! \begin_inset Quotes erd
! \end_inset
!
! blah
! \begin_inset Quotes erd
! \end_inset
! />
\layout Code
! <field name=
! \begin_inset Quotes erd
! \end_inset
!
! blah
! \begin_inset Quotes erd
! \end_inset
!
! section=
! \begin_inset Quotes erd
! \end_inset
! blah
! \begin_inset Quotes erd
! \end_inset
! />
\layout Subsection
Summaries
--- 359,381 ----
Sections
\layout Standard
! Sections serve a dual purpose -- to handle logical grouping of fields and
! ...
\layout Subsection
Fields
! \layout Standard
! To reference a field in the current section,
\layout Code
! <field name="blah" />
! \layout Standard
! To reference a field in a higher-level section,
! \layout Code
! <field name="blah" section="blah"/>
\layout Subsection
Summaries
***************
*** 330,510 ****
\layout Code
! <summ field=
! \begin_inset Quotes erd
! \end_inset
!
! fieldname
! \begin_inset Quotes erd
! \end_inset
!
! function=
! \begin_inset Quotes erd
! \end_inset
!
! sum
! \begin_inset Quotes erd
! \end_inset
!
! section=
! \begin_inset Quotes erd
! \end_inset
!
! uppersect
! \begin_inset Quotes erd
! \end_inset
!
! />
\layout Standard
\series bold
Functions:
! \layout Standard
!
!
! \begin_inset Tabular
! <lyxtabular version="2" rows="6" columns="2">
! <features rotate="false" islongtable="false" endhead="0" endfirsthead="0"
endfoot="0" endlastfoot="0">
! <column alignment="center" valignment="top" leftline="true" rightline="false"
width="" special="">
! <column alignment="center" valignment="top" leftline="true" rightline="false"
width="" special="">
! <row topline="true" bottomline="true" newpage="false">
! <cell multicolumn="0" alignment="center" valignment="top" topline="true"
bottomline="false" leftline="true" rightline="false" rotate="false"
usebox="none" width="" special="">
! \begin_inset Text
!
! \layout Standard
!
! Function
! \end_inset
! </cell>
! <cell multicolumn="0" alignment="center" valignment="top" topline="true"
bottomline="false" leftline="true" rightline="false" rotate="false"
usebox="none" width="" special="">
! \begin_inset Text
!
! \layout Standard
!
! Description
! \end_inset
! </cell>
! </row>
! <row topline="true" bottomline="false" newpage="false">
! <cell multicolumn="0" alignment="center" valignment="top" topline="true"
bottomline="false" leftline="true" rightline="false" rotate="false"
usebox="none" width="" special="">
! \begin_inset Text
!
! \layout Standard
!
! count
! \end_inset
! </cell>
! <cell multicolumn="0" alignment="center" valignment="top" topline="true"
bottomline="false" leftline="true" rightline="false" rotate="false"
usebox="none" width="" special="">
! \begin_inset Text
!
! \layout Standard
!
! Computes a
! \begin_inset Quotes eld
! \end_inset
!
! count
! \begin_inset Quotes eld
! \end_inset
!
! of the total number of non-empty instances of a field.
! \end_inset
! </cell>
! </row>
! <row topline="true" bottomline="false" newpage="false">
! <cell multicolumn="0" alignment="center" valignment="top" topline="true"
bottomline="false" leftline="true" rightline="false" rotate="false"
usebox="none" width="" special="">
! \begin_inset Text
!
! \layout Standard
!
! sum
! \end_inset
! </cell>
! <cell multicolumn="0" alignment="center" valignment="top" topline="true"
bottomline="false" leftline="true" rightline="false" rotate="false"
usebox="none" width="" special="">
! \begin_inset Text
!
! \layout Standard
!
! Computes a running total of the specified numeric field.
! \end_inset
! </cell>
! </row>
! <row topline="true" bottomline="false" newpage="false">
! <cell multicolumn="0" alignment="center" valignment="top" topline="true"
bottomline="false" leftline="true" rightline="false" rotate="false"
usebox="none" width="" special="">
! \begin_inset Text
!
! \layout Standard
!
! avg
! \end_inset
! </cell>
! <cell multicolumn="0" alignment="center" valignment="top" topline="true"
bottomline="false" leftline="true" rightline="false" rotate="false"
usebox="none" width="" special="">
! \begin_inset Text
!
! \layout Standard
!
! Computes the average of the specified numeric field.
! \end_inset
! </cell>
! </row>
! <row topline="true" bottomline="false" newpage="false">
! <cell multicolumn="0" alignment="center" valignment="top" topline="true"
bottomline="false" leftline="true" rightline="false" rotate="false"
usebox="none" width="" special="">
! \begin_inset Text
!
! \layout Standard
!
! min
! \end_inset
! </cell>
! <cell multicolumn="0" alignment="center" valignment="top" topline="true"
bottomline="false" leftline="true" rightline="false" rotate="false"
usebox="none" width="" special="">
! \begin_inset Text
!
! \layout Standard
!
! Remembers the
! \begin_inset Quotes eld
! \end_inset
!
! smallest
! \begin_inset Quotes eld
! \end_inset
!
! value of a field instance.
! \end_inset
! </cell>
! </row>
! <row topline="true" bottomline="true" newpage="false">
! <cell multicolumn="0" alignment="center" valignment="top" topline="true"
bottomline="false" leftline="true" rightline="false" rotate="false"
usebox="none" width="" special="">
! \begin_inset Text
!
! \layout Standard
!
! max
! \end_inset
! </cell>
! <cell multicolumn="0" alignment="center" valignment="top" topline="true"
bottomline="false" leftline="true" rightline="false" rotate="false"
usebox="none" width="" special="">
! \begin_inset Text
!
! \layout Standard
!
! Remembers the
! \begin_inset Quotes eld
! \end_inset
! largest
! \begin_inset Quotes eld
! \end_inset
! value in a field instance.
! \end_inset
! </cell>
! </row>
! </lyxtabular>
! \end_inset
\layout Subsection
Parameters
--- 387,415 ----
\layout Code
! <summ field="fieldname" function="sum" section="uppersect"/>
\layout Standard
\series bold
+ \emph on
Functions:
! \layout Description
! count Computes a "count" of the total number of non-empty instances of a
! field.
! \layout Description
! sum Computes a running total of the specified numeric field.
! \layout Description
! avg Computes the average of the specified numeric field.
! \layout Description
+ min Remembers the "smallest" value of a field instance.
+ \layout Description
+ max Remembers the "largest" value in a field instance.
\layout Subsection
Parameters
***************
*** 599,629 ****
\layout Subsection
Overview
\layout Subsection
GNUe Namespaces
\layout Code
! <section out:xmlns=
! \begin_inset Quotes erd
! \end_inset
! GNUe:Reports:SimpleTabulation
! \begin_inset Quotes erd
! \end_inset
! >
\layout Code
! <out:mytag myattr=
! \begin_inset Quotes erd
\end_inset
! attrval
\begin_inset Quotes erd
\end_inset
! >...</out:mytag>
\layout Section
Advanced Topics
--- 504,594 ----
\layout Subsection
Overview
+ \layout Standard
+
+ GNUe Reports, with its versative reporting engine, is not tied to any
particular
+ output XML format.
+ In essence, the reporting engine performs a Database-To-XML transformation,
+ with an arbitrary output XML format.
+
\layout Subsection
GNUe Namespaces
+ \layout Standard
+
+ For example, assume you have the following layout section:
\layout Code
! <layout out:xmlns="GNUe:Reports:SimpleTabulation">
! \layout Code
! <out:mygroup>
! \layout Code
! <section source="dts1">
\layout Code
! <out:mydata myattr="attrval"><field name="foo"/></out:mydata>
! \layout Code
!
! </section>
! \layout Code
!
! </out:mygroup>
! \layout Code
!
! </layout>
! \layout Standard
!
! Furthermore, assume the datasource
! \series bold
! \emph on
! dts1
! \series default
! \emph default
! has the following values for field
! \begin_inset Quotes eld
\end_inset
! foo
\begin_inset Quotes erd
\end_inset
! :
! \series bold
! \emph on
! Bob
! \series default
! \emph default
! ,
! \series bold
! \emph on
! Sam
! \series default
! \emph default
! , and
! \series bold
! \emph on
! Jane
! \series default
! \emph default
! .
! Then the resulting xml will be:
! \layout Code
!
! <mygroup xmlns="GNUe:Reports:SimpleTabulation">
! \layout Code
!
! <mydata myattr="attrval">Bob</mydata>
! \layout Code
!
! <mydata myattr="attrval">Sam</mydata>
! \layout Code
!
! <mydata myattr="attrval">Jane</mydata>
! \layout Code
!
! </mygroup>
\layout Section
Advanced Topics
***************
*** 654,723 ****
...
\layout Code
! <section source=
! \begin_inset Quotes erd
! \end_inset
!
! mydts
! \begin_inset Quotes erd
! \end_inset
!
! >
\layout Code
! <field name=
! \begin_inset Quotes erd
! \end_inset
!
! weight
! \begin_inset Quotes erd
! \end_inset
!
! />
\layout Code
! <field name=
! \begin_inset Quotes erd
! \end_inset
!
! val
! \begin_inset Quotes erd
! \end_inset
!
! />
\layout Code
! <formula name=
! \begin_inset Quotes erd
! \end_inset
!
! avgseed
! \begin_inset Quotes erd
! \end_inset
!
! >weight*val</formula>
\layout Code
</section>
\layout Code
! <summ field=
! \begin_inset Quotes erd
! \end_inset
!
! avgseed
! \begin_inset Quotes erd
! \end_inset
!
! function=
! \begin_inset Quotes erd
! \end_inset
!
! avg
! \begin_inset Quotes erd
! \end_inset
!
! />
\layout Code
...
--- 619,640 ----
...
\layout Code
! <section source="mydts">
\layout Code
! <field name="weight"/>
\layout Code
! <field name="val"/>
\layout Code
! <formula name="avgseed">weight*val</formula>
\layout Code
</section>
\layout Code
! <summ field="avgseed" function="avg"/>
\layout Code
...
***************
*** 730,735 ****
--- 647,655 ----
(GRD) File Format
\layout Subsection
+ General Markup
+ \layout Subsubsection
+
\lang american
<report>
***************
*** 740,748 ****
The <report> tag if the root tag.
It's only purpose is to enclose the report definition.
All other tags fall somewhere inside this tag.
! \layout Subsubsection
\lang american
Attributes
\layout Standard
--- 660,670 ----
The <report> tag if the root tag.
It's only purpose is to enclose the report definition.
All other tags fall somewhere inside this tag.
! \layout Standard
+ \series bold
+ \emph on
\lang american
Attributes
\layout Standard
***************
*** 936,981 ****
\end_inset
! \layout Subsubsection
\lang american
Example
\layout Code
\lang american
! <report title=
! \begin_inset Quotes erd
! \end_inset
!
! Accounting Month End Report
! \begin_inset Quotes erd
! \end_inset
!
! author=
! \begin_inset Quotes erd
! \end_inset
- GNU Enterprise
- \begin_inset Quotes erd
- \end_inset
! version=
! \begin_inset Quotes erd
! \end_inset
!
! 1.2.5
! \begin_inset Quotes erd
! \end_inset
!
! >
\layout Code
- \emph on
\lang american
! Rest of report logic goes here
\layout Code
--- 858,885 ----
\end_inset
! \layout Description
+ \series bold
+ \emph on
\lang american
Example
\layout Code
\lang american
! <report title="Accounting Month End Report"
! \layout Code
! \lang american
! author="GNU Enterprise" version="1.2.15">
\layout Code
\lang american
! <!-- Rest of report logic goes here -->
\layout Code
***************
*** 985,990 ****
--- 889,899 ----
\lang american
+ User-Supplied Parameters
+ \layout Subsubsection
+
+
+ \lang american
<parameters>
\layout Standard
***************
*** 993,1001 ****
The parameters tag encloses the parameter definition section.
It is a container for <parameter> tags.
! \layout Subsubsection
\lang american
Attributes
\layout Standard
--- 902,912 ----
The parameters tag encloses the parameter definition section.
It is a container for <parameter> tags.
! \layout Standard
+ \series bold
+ \emph on
\lang american
Attributes
\layout Standard
***************
*** 1004,1012 ****
\lang american
This tag simply serves as a container.
It has no attributes.
! \layout Subsubsection
\lang american
Example
\layout Code
--- 915,925 ----
\lang american
This tag simply serves as a container.
It has no attributes.
! \layout Standard
+ \series bold
+ \emph on
\lang american
Example
\layout Code
***************
*** 1017,1031 ****
\layout Code
- \emph on
\lang american
! parameter definitions go here
\layout Code
\lang american
</parameters>
! \layout Subsection
\lang american
--- 930,943 ----
\layout Code
\lang american
! <!-- parameter definitions go here -->
\layout Code
\lang american
</parameters>
! \layout Subsubsection
\lang american
***************
*** 1035,1043 ****
\lang american
A parameter tag defines a single user-settable parameter.
! \layout Subsubsection
\lang american
Attributes
\layout Standard
--- 947,957 ----
\lang american
A parameter tag defines a single user-settable parameter.
! \layout Standard
+ \series bold
+ \emph on
\lang american
Attributes
\layout Standard
***************
*** 1440,1448 ****
.
The engine will accept values for these attributes, but does not do any
processing of them.
! \layout Subsubsection
\lang american
Example
\layout Standard
--- 1354,1364 ----
.
The engine will accept values for these attributes, but does not do any
processing of them.
! \layout Standard
+ \series bold
+ \emph on
\lang american
Example
\layout Standard
***************
*** 1468,1533 ****
\lang american
! <parameter name=
! \begin_inset Quotes erd
! \end_inset
- beginDate
- \begin_inset Quotes erd
- \end_inset
! description=
! \begin_inset Quotes erd
! \end_inset
- First day of the period
- \begin_inset Quotes erd
- \end_inset
! type=
! \begin_inset Quotes erd
! \end_inset
- date
- \begin_inset Quotes erd
- \end_inset
! />
\layout Code
\lang american
! <parameter name=
! \begin_inset Quotes erd
! \end_inset
- endDate
- \begin_inset Quotes erd
- \end_inset
! description=
! \begin_inset Quotes erd
! \end_inset
- Last day of the period
- \begin_inset Quotes erd
- \end_inset
! type=
! \begin_inset Quotes erd
! \end_inset
- date
- \begin_inset Quotes erd
- \end_inset
! />
! \layout Code
\lang american
! </parameters>
! \layout Subsection
\lang american
--- 1384,1433 ----
\lang american
! <parameter name="beginDate"
! \layout Code
! \lang american
! description="First day of the period"
! \layout Code
! \lang american
! type="date"/>
! \layout Code
! \lang american
! <parameter name="endDate"
\layout Code
\lang american
! description="Last day of the period"
! \layout Code
! \lang american
! type="date"/>
! \layout Code
! \lang american
! </parameters>
! \layout Subsection
! \lang american
! Sorting Options
! \layout Standard
+ \series bold
\lang american
! NOTE: sortoptions are currently not implemented.
!
! \layout Subsubsection
\lang american
***************
*** 1539,1547 ****
The parameters tag encloses the parameter definition section.
It is a container for <parameter> tags.
! \layout Subsubsection
\lang american
Attributes
\layout Standard
--- 1439,1449 ----
The parameters tag encloses the parameter definition section.
It is a container for <parameter> tags.
! \layout Standard
+ \series bold
+ \emph on
\lang american
Attributes
\layout Standard
***************
*** 1550,1558 ****
\lang american
This tag simply serves as a container.
It has no attributes.
! \layout Subsubsection
\lang american
Example
\layout Code
--- 1452,1462 ----
\lang american
This tag simply serves as a container.
It has no attributes.
! \layout Standard
+ \series bold
+ \emph on
\lang american
Example
\layout Code
***************
*** 1563,1577 ****
\layout Code
- \emph on
\lang american
! sortoption definitions go here
\layout Code
\lang american
</sortoptions>
! \layout Subsection
\lang american
--- 1467,1480 ----
\layout Code
\lang american
! <!-- sortoption definitions go here -->
\layout Code
\lang american
</sortoptions>
! \layout Subsubsection
\lang american
***************
*** 1579,1598 ****
\layout Standard
- \series bold
- \lang american
- NOTE: sortoptions are currently not implemented.
-
- \layout Standard
-
-
\lang american
A sortoption tag defines a single user-selectable sortoption.
See the chapter on Sorting Options for more information on these.
! \layout Subsubsection
\lang american
Attributes
\layout Standard
--- 1482,1496 ----
\layout Standard
\lang american
A sortoption tag defines a single user-selectable sortoption.
See the chapter on Sorting Options for more information on these.
! \layout Standard
+ \series bold
+ \emph on
\lang american
Attributes
\layout Standard
***************
*** 1981,1989 ****
\end_inset
! \layout Subsubsection
\lang american
Example
\layout Code
--- 1879,1889 ----
\end_inset
! \layout Standard
+ \series bold
+ \emph on
\lang american
Example
\layout Code
***************
*** 1996,2008 ****
\emph on
\lang american
! Rest of report logic goes here
\layout Code
\lang american
</report>
! \layout Subsection
\lang american
--- 1896,1910 ----
\emph on
\lang american
!
! \emph default
! <!-- Rest of report logic goes here -->
\layout Code
\lang american
</report>
! \layout Subsubsection
\lang american
***************
*** 2014,2022 ****
\emph on
\lang american
TODO!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
! \layout Subsubsection
\lang american
Attributes
\layout Standard
--- 1916,1926 ----
\emph on
\lang american
TODO!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
! \layout Standard
+ \series bold
+ \emph on
\lang american
Attributes
\layout Standard
***************
*** 2398,2406 ****
\end_inset
! \layout Subsubsection
\lang american
Example
\layout Code
--- 2302,2312 ----
\end_inset
! \layout Standard
+ \series bold
+ \emph on
\lang american
Example
\layout Code
***************
*** 2411,2419 ****
\layout Code
- \emph on
\lang american
! Rest of report logic goes here
\layout Code
--- 2317,2324 ----
\layout Code
\lang american
! <!-- Rest of report logic goes here -->
\layout Code
***************
*** 2423,2428 ****
--- 2328,2338 ----
\lang american
+ Layout Elements
+ \layout Subsubsection
+
+
+ \lang american
<layout>
\layout Standard
***************
*** 2431,2439 ****
\emph on
\lang american
TODO!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
! \layout Subsubsection
\lang american
Attributes
\layout Standard
--- 2341,2351 ----
\emph on
\lang american
TODO!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
! \layout Standard
+ \series bold
+ \emph on
\lang american
Attributes
\layout Standard
***************
*** 2526,2534 ****
\end_inset
! \layout Subsubsection
\lang american
Example
\layout Standard
--- 2438,2448 ----
\end_inset
! \layout Standard
+ \series bold
+ \emph on
\lang american
Example
\layout Standard
***************
*** 2571,2577 ****
\lang american
</page>
! \layout Subsection
\lang american
--- 2485,2491 ----
\lang american
</page>
! \layout Subsubsection
\lang american
***************
*** 2583,2591 ****
\emph on
\lang american
TODO!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
! \layout Subsubsection
\lang american
Attributes
\layout Standard
--- 2497,2507 ----
\emph on
\lang american
TODO!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
! \layout Standard
+ \series bold
+ \emph on
\lang american
Attributes
\layout Standard
***************
*** 2921,2929 ****
\end_inset
! \layout Subsubsection
\lang american
Example
\layout Standard
--- 2837,2847 ----
\end_inset
! \layout Standard
+ \series bold
+ \emph on
\lang american
Example
\layout Standard
***************
*** 2957,2965 ****
\lang american
<layout>
! \layout Subsubsection
\lang american
Attributes
\layout Standard
--- 2875,2885 ----
\lang american
<layout>
! \layout Standard
+ \series bold
+ \emph on
\lang american
Attributes
\layout Standard
***************
*** 3295,3303 ****
\end_inset
! \layout Subsubsection
\lang american
Example
\layout Standard
--- 3215,3225 ----
\end_inset
! \layout Standard
+ \series bold
+ \emph on
\lang american
Example
\layout Standard
***************
*** 3326,3332 ****
It does this by monitoring the entry named st_code in the state block,
when that data changes it sets the entry within itself named state to match
the value stored in st_code as querying data from the datasource.
! \layout Subsection
\lang american
--- 3248,3254 ----
It does this by monitoring the entry named st_code in the state block,
when that data changes it sets the entry within itself named state to match
the value stored in st_code as querying data from the datasource.
! \layout Subsubsection
\lang american
***************
*** 3338,3346 ****
\emph on
\lang american
TODO!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
! \layout Subsubsection
\lang american
Attributes
\layout Standard
--- 3260,3270 ----
\emph on
\lang american
TODO!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
! \layout Standard
+ \series bold
+ \emph on
\lang american
Attributes
\layout Standard
***************
*** 3692,3703 ****
\end_inset
! \layout Subsubsection
\lang american
Example
! \layout Subsection
\lang american
--- 3616,3629 ----
\end_inset
! \layout Standard
+ \series bold
+ \emph on
\lang american
Example
! \layout Subsubsection
\lang american
***************
*** 3709,3717 ****
\emph on
\lang american
TODO!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
! \layout Subsubsection
\lang american
Attributes
\layout Standard
--- 3635,3645 ----
\emph on
\lang american
TODO!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
! \layout Standard
+ \series bold
+ \emph on
\lang american
Attributes
\layout Standard
***************
*** 4063,4074 ****
\end_inset
! \layout Subsubsection
\lang american
Example
! \layout Subsection
\lang american
--- 3991,4004 ----
\end_inset
! \layout Standard
+ \series bold
+ \emph on
\lang american
Example
! \layout Subsubsection
\lang american
***************
*** 4080,4088 ****
\emph on
\lang american
TODO!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
! \layout Subsubsection
\lang american
Attributes
\layout Standard
--- 4010,4020 ----
\emph on
\lang american
TODO!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
! \layout Standard
+ \series bold
+ \emph on
\lang american
Attributes
\layout Standard
***************
*** 4434,4445 ****
\end_inset
! \layout Subsubsection
\lang american
Example
! \layout Subsection
\lang american
--- 4366,4379 ----
\end_inset
! \layout Standard
+ \series bold
+ \emph on
\lang american
Example
! \layout Subsubsection
\lang american
***************
*** 4451,4472 ****
\emph on
\lang american
TODO!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
! \layout Subsubsection
\lang american
Attributes
\layout Standard
\lang american
! This tag no attributes.
! \layout Subsubsection
\lang american
Example
! \layout Subsection
\lang american
--- 4385,4410 ----
\emph on
\lang american
TODO!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
! \layout Standard
+ \series bold
+ \emph on
\lang american
Attributes
\layout Standard
\lang american
! This tag has no attributes.
! \layout Standard
+ \series bold
+ \emph on
\lang american
Example
! \layout Subsubsection
\lang american
***************
*** 4478,4499 ****
\emph on
\lang american
TODO!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
! \layout Subsubsection
\lang american
Attributes
\layout Standard
\lang american
! This tag no attributes.
! \layout Subsubsection
\lang american
Example
! \layout Subsection
\lang american
--- 4416,4441 ----
\emph on
\lang american
TODO!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
! \layout Standard
+ \series bold
+ \emph on
\lang american
Attributes
\layout Standard
\lang american
! This tag has no attributes.
! \layout Standard
+ \series bold
+ \emph on
\lang american
Example
! \layout Subsubsection
\lang american
***************
*** 4505,4526 ****
\emph on
\lang american
TODO!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
! \layout Subsubsection
\lang american
Attributes
\layout Standard
\lang american
! This tag no attributes.
! \layout Subsubsection
\lang american
Example
! \layout Subsection
\lang american
--- 4447,4472 ----
\emph on
\lang american
TODO!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
! \layout Standard
+ \series bold
+ \emph on
\lang american
Attributes
\layout Standard
\lang american
! This tag has no attributes.
! \layout Standard
+ \series bold
+ \emph on
\lang american
Example
! \layout Subsubsection
\lang american
***************
*** 4532,4553 ****
\emph on
\lang american
TODO!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
! \layout Subsubsection
\lang american
Attributes
\layout Standard
\lang american
! This tag no attributes.
! \layout Subsubsection
\lang american
Example
! \layout Subsection
\lang american
--- 4478,4504 ----
\emph on
\lang american
TODO!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
! \layout Standard
+ \series bold
+ \emph on
\lang american
Attributes
\layout Standard
\lang american
! This tag has\SpecialChar ~
! no attributes.
! \layout Standard
+ \series bold
+ \emph on
\lang american
Example
! \layout Subsubsection
\lang american
***************
*** 4559,4577 ****
\emph on
\lang american
TODO!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
! \layout Subsubsection
\lang american
Attributes
\layout Standard
\lang american
! This tag no attributes.
! \layout Subsubsection
\lang american
Example
\layout Section
--- 4510,4532 ----
\emph on
\lang american
TODO!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
! \layout Standard
+ \series bold
+ \emph on
\lang american
Attributes
\layout Standard
\lang american
! This tag has no attributes.
! \layout Standard
+ \series bold
+ \emph on
\lang american
Example
\layout Section
***************
*** 4583,4595 ****
grrun
\emph default
Command-line Client
! \layout Paragraph
\series medium
\lang american
The grrun utility is currently the only interface to the GNUe Reports engine.
! \layout Subsubsection
\lang american
--- 4538,4550 ----
grrun
\emph default
Command-line Client
! \layout Standard
\series medium
\lang american
The grrun utility is currently the only interface to the GNUe Reports engine.
! \layout Subsection
\lang american
***************
*** 4608,4648 ****
\end_inset
! \layout Subparagraph
\lang american
! --comment, -C
\series medium
Include structural comments in the XML output stream.
Useful for debugging .grd files.
! \layout Subparagraph
\lang american
! --connections <loc>
\series medium
Specifies the location of the connection definition file.
<loc> may specify a file name (/usr/local/gnue/etc/connections.conf), or
a URL location (http://localhost/connections.conf).
If this option is not specified, the environent variable GNUE_CONNECTIONS
is checked.
! \layout Subparagraph
\lang american
! --debug-file <file>
\series medium
Sends all debugging messages to a specified file (e.g., "--debug-file
trace.log"
sends all output to "trace.log")
\series default
\emph on
[for developer's use]
! \layout Subparagraph
\lang american
! --debug-level <level>
\series medium
Enables debugging messages.
Argument specifies the level of messages to display (e.g., "--debug-level
--- 4563,4623 ----
\end_inset
! \layout Standard
+ \series bold
+ \emph on
\lang american
! --comment, -C
! \series default
! \emph default
!
\series medium
Include structural comments in the XML output stream.
Useful for debugging .grd files.
! \layout Standard
+ \series bold
+ \emph on
\lang american
! --connections <loc>
! \series default
! \emph default
!
\series medium
Specifies the location of the connection definition file.
<loc> may specify a file name (/usr/local/gnue/etc/connections.conf), or
a URL location (http://localhost/connections.conf).
If this option is not specified, the environent variable GNUE_CONNECTIONS
is checked.
! \layout Standard
+ \series bold
+ \emph on
\lang american
! --debug-file <file>
! \series default
! \emph default
!
\series medium
Sends all debugging messages to a specified file (e.g., "--debug-file
trace.log"
sends all output to "trace.log")
\series default
\emph on
[for developer's use]
! \layout Standard
+ \series bold
+ \emph on
\lang american
! --debug-level <level>
! \series default
! \emph default
!
\series medium
Enables debugging messages.
Argument specifies the level of messages to display (e.g., "--debug-level
***************
*** 4650,4661 ****
\series default
\emph on
[for developer's use]
! \layout Subparagraph
\lang american
--destination <dest>, -d
\series medium
Where should the report be output to? The value of this depends on the
destination type (e.g., if sending to printer, then -d specifies the printer
name; if sending via email, then -d specifies the email address.) If <dest>
--- 4625,4639 ----
\series default
\emph on
[for developer's use]
! \layout Standard
+ \series bold
+ \emph on
\lang american
--destination <dest>, -d
\series medium
+ \emph default
Where should the report be output to? The value of this depends on the
destination type (e.g., if sending to printer, then -d specifies the printer
name; if sending via email, then -d specifies the email address.) If <dest>
***************
*** 4663,4682 ****
also use the -q [--quiet] option or you may get junk in your output stream.
NOTE: Currently the default value is "-" -- this may change once GNUe Reports
is formally released!
! \layout Subparagraph
\lang american
! --destination-options <opts>
\series medium
Options to pass to the destination process.
Available options are specific to the type of destination.
Example: '--destination-options "-o nobanner" '
! \layout Subparagraph
\lang american
! --destination-type <type>, -D
\series medium
This specifies how the report should be output.
The currently supported values for <type> are file [default], printer,
--- 4641,4670 ----
also use the -q [--quiet] option or you may get junk in your output stream.
NOTE: Currently the default value is "-" -- this may change once GNUe Reports
is formally released!
! \layout Standard
+ \series bold
+ \emph on
\lang american
! --destination-options <opts>
! \series default
! \emph default
!
\series medium
Options to pass to the destination process.
Available options are specific to the type of destination.
Example: '--destination-options "-o nobanner" '
! \layout Standard
+ \series bold
+ \emph on
\lang american
! --destination-type <type>, -D
! \series default
! \emph default
!
\series medium
This specifies how the report should be output.
The currently supported values for <type> are file [default], printer,
***************
*** 4684,4716 ****
Note that printer, email, and fax are sent via the server's machine, not
the client's machine.
To NOTE: Only file, printer, and email are currently implemented!
! \layout Subparagraph
\lang american
! --exclude-xml, -X
\series medium
Do not output GNUe Reports runtime XML markup information.
If specified, then the GRDs layout section will be processed and output
as-is; i.e., without any additional information added by GNUe Reports.
! \layout Subparagraph
\lang american
! --filter <filt>, -f
\series medium
Select the filter to be used to process report output.
<filt> is the name of the filtering process as defined on the Report Server
machine.
If not specified, the "raw" filter is used (i.e., no filtering takes place.)
! \layout Subparagraph
\lang american
! --filter-list
\series medium
List the available [predefined] filters available to GNUe Reports
! \layout Subparagraph
\lang american
--- 4672,4719 ----
Note that printer, email, and fax are sent via the server's machine, not
the client's machine.
To NOTE: Only file, printer, and email are currently implemented!
! \layout Standard
+ \series bold
+ \emph on
\lang american
! --exclude-xml, -X
! \series default
! \emph default
!
\series medium
Do not output GNUe Reports runtime XML markup information.
If specified, then the GRDs layout section will be processed and output
as-is; i.e., without any additional information added by GNUe Reports.
! \layout Standard
+ \series bold
+ \emph on
\lang american
! --filter <filt>, -f
! \series default
! \emph default
!
\series medium
Select the filter to be used to process report output.
<filt> is the name of the filtering process as defined on the Report Server
machine.
If not specified, the "raw" filter is used (i.e., no filtering takes place.)
! \layout Standard
+ \series bold
+ \emph on
\lang american
! --filter-list
! \series default
! \emph default
!
\series medium
List the available [predefined] filters available to GNUe Reports
! \layout Standard
\lang american
***************
*** 4720,4808 ****
Available options are specific to the filter.
--filter-list will list available filters and their options.
Example: '--filter-options "paper=letter margin=1,1,1,1" '
! \layout Subparagraph
\lang american
--help
\series medium
Displays this help screen.
! \layout Subparagraph
\lang american
! --interactive-debugger
\series medium
Run the app inside Python's built-in debugger
\series default
\emph on
[for developer's use]
! \layout Subparagraph
\lang american
! --pass <passwd>
\series medium
Password used to log into the database.
Note that if specified, this will be used for all databases.
If not supplied, the program will prompt for password.
NOTE: SUPPLYING A PASSWORD VIA THE COMMAND LINE MAY BE CONSIDERED A SECURITY
RISK.
! \layout Subparagraph
\lang american
! --profile
\series medium
Run Python's built-in profiler and display the resulting run statistics.
\series default
\emph on
[for developer's use]
! \layout Subparagraph
\lang american
! --quiet, -q
\series medium
Run GNUe Reports in quiet mode -- i.e., display no output.
NOTE: if --debug-level is specified, then suppressed text will be output
as debugging information (at debug level 1)
! \layout Subparagraph
\lang american
--sort <sort>, -s
\series medium
Select the "sort-option" used to sort the report.
! \layout Subparagraph
\lang american
! --standalone, -S
\series medium
Create a standalone, single-use server instance.
Use this option in a non-client/server environment or in a
debugging/developmen
t environment.
NOTE: Until the Reports Server is operational, this mode is implied
! \layout Subparagraph
\lang american
! --user <name>, -u
\series medium
Username used to log into the database.
Note that if specified, this will be used for all databases.
If not supplied, the program will prompt for username.
! \layout Subparagraph
\lang american
! --version
\series medium
Displays the version information for this program.
- \layout Verbatim
-
- \layout Verbatim
-
\the_end
--- 4723,4849 ----
Available options are specific to the filter.
--filter-list will list available filters and their options.
Example: '--filter-options "paper=letter margin=1,1,1,1" '
! \layout Standard
+ \series bold
+ \emph on
\lang american
--help
\series medium
+ \emph default
Displays this help screen.
! \layout Standard
\lang american
! -
! \series bold
! \emph on
! -interactive-debugger
! \series default
! \emph default
!
\series medium
Run the app inside Python's built-in debugger
\series default
\emph on
[for developer's use]
! \layout Standard
+ \series bold
+ \emph on
\lang american
! --pass <passwd>
! \series default
! \emph default
!
\series medium
Password used to log into the database.
Note that if specified, this will be used for all databases.
If not supplied, the program will prompt for password.
NOTE: SUPPLYING A PASSWORD VIA THE COMMAND LINE MAY BE CONSIDERED A SECURITY
RISK.
! \layout Standard
+ \series bold
+ \emph on
\lang american
! --profile
! \series default
! \emph default
!
\series medium
Run Python's built-in profiler and display the resulting run statistics.
\series default
\emph on
[for developer's use]
! \layout Standard
+ \series bold
+ \emph on
\lang american
! --quiet, -q
! \series default
! \emph default
!
\series medium
Run GNUe Reports in quiet mode -- i.e., display no output.
NOTE: if --debug-level is specified, then suppressed text will be output
as debugging information (at debug level 1)
! \layout Standard
+ \series bold
+ \emph on
\lang american
--sort <sort>, -s
\series medium
+ \emph default
Select the "sort-option" used to sort the report.
! \layout Standard
+ \series bold
+ \emph on
\lang american
! --standalone, -S
! \series default
! \emph default
!
\series medium
Create a standalone, single-use server instance.
Use this option in a non-client/server environment or in a
debugging/developmen
t environment.
NOTE: Until the Reports Server is operational, this mode is implied
! \layout Standard
+ \series bold
+ \emph on
\lang american
! --user <name>, -u
! \series default
! \emph default
!
\series medium
Username used to log into the database.
Note that if specified, this will be used for all databases.
If not supplied, the program will prompt for username.
! \layout Standard
+ \series bold
+ \emph on
\lang american
! --version
! \series default
! \emph default
!
\series medium
Displays the version information for this program.
\the_end
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- gnue/reports INSTALL TODO doc/ReportingConcepts...,
Jason Cater <=