Syntax for Text, Graph, Screen and Import definition files

Reports can be text, graph, screen, or used in import.

Create and edit export definitions (.RPT) with FileMenu/Export , sites screen definitions (.SPT) with FileMenu/Sites/Edit?? , import definitions (.IPT) with FileMenu/Import

Graph definition files needs to be edited with MS.Notepad, or some other text editor - use ProbeMenu/SystemOptions report tab

Text reports (RPT)

Use FileMenu/Export

Reports can be output to...

• paper
• pdf
• web - in .htm and .png format
• csv files - comma-delimited for Excel, etc.

Reports to paper or pdf have different sections - report header, page header, group header, details, etc

Each line in the RPT file specifies an item, and in which section it will print. Only items in the detail (each site) section will be exported. An item can be...

• A label (eg print = Site Report)
• A text box with data (eg print = Top Paddock)
• A line

In addition, a column can be specified.

A column will be printed in 2 parts...

1. The title as a label
2. The data as a text box.

The column titles can be printed either...

• in the group header
• or once on each page, in the page header.

Items are added and editied on tab: items

Web output is configured on tab: web

Gauge on tab: Gauges

Each item that is to be output has a specification line with format...

SectionCode~TypeCode~Source~Left~Top~Right~Bottom~Font~Size~Bold~Format~Align~Units~Colour

Section Codes

Section codes specify in which section of the report the item is to be printed.

Type Codes

Type codes specify the type of data that is to be output.

TypeCode	Description
SECTIONHEIGHT	Height of section in cm
TEXT	Text box e.g. Source = NAME will print Top Paddock
LABEL	Label displaying fixed text e.g. Site Report but can include text variables... eg Sites report for %OWNER1% will output the item set on FileMenu/Register. Or include numeric formulas... eg Gain this week %CRNTAMT-PREVAMT;AMT;1% will output: Gain = -3.6 mm Note: separate the formula, format and units with ';'
FORMULA	Text box will display numeric data or formula eg Source = FULL or COTTON.DWU*1.2
INDIRECTFORMULA	Value of a formula eg Source = LOWER will evaluate the LOWER formula
LINE	Draws a line from Left, Top to Right, Bottom size = line width in points (0 = hairline)
GAUGE
BUCKET
PROFILE

Source or Formulas

The source specifies where the data is coming from. It can be the name of a field in the database, or a formula.
See Formulas and Variables

Position

• All positions (left, right, top, bottom) are specified in cm.
• Horizontal positions (left, right) are relative to the left margin.
• Vertical positions (top, bottom) are relative to the top of the current section.

For example...

RIGHT=8 is a point 8 cm from the left margin. If the left margin = 2.5 cm, the item will print at 10.5 cm from left edge of paper.

TOP=1.2 is a point 1.2 cm below the top of the current section.

Size, units, format, font

If a font or font size is not specified, the report default font is used.

Units and format are only applicable for numeric formulas.

Line sizes are specified in points. (1 pt = 1/1440 inches; 0 = hairline, the thinnest line possible on the printer).

Colours

Colours can be specified by name (eg: RED), or in hex (same as web css)

Examples of Report/Export Specifications

Export specifications (.rpt file) can be created and edited on FileMenu/Export

The column header section height should be specified - this section can also have lines drawn like any of the other sections.

Column Specifications

Each column to be output needs a column specification, with the type code Cn, with format...

ColNum,Source,Width,Format,Units,Align,Title,TypeCode 'comments

Each column will be printed in to two parts, the title going to a LABEL (in either the page header or group header) and the source to a FORMULA in the detail section. The horizontal position of the items will be calculated based on the column width.

The actual output will be suppressed if width=0. This can be used to calculate intermediate results.

The character | will force a new line in a column title.

Examples of Column Specifications

       Site
       Name
-----------
Top Paddock
    Site 33

       Probe
         Dwu
      mm/day
-------------
  2.3 mm/day
  1.1 mm/day

      Amount
------------
       12 Ml

Graph report definitions (GPT)

To customise graph reports use ProbeMenu/SystemOptions and edit the file GITEMS.TXT or a .GPT file.

Each line in the GPT file has the format...

Notes:

1. If a formula is used that contains commas (e.g.=IF(criteria,Value1,Value2)) , use '~' as the delimiter between items.
2. A line has been upgraded to v3 if item 8 (options) is more that 10 characters eg HGGGGGGGGG
3. If a GraphStyleID is entered, the Y values on the right axis for positioning text, lines, arrows etc see details

Commands

Available commands...

id	Command	Purpose	Source	Position Units
1	ReportTitle	Begin a Report eg 1,1,ReportTitle,DripBlock	Title
9	GraphType	Select the current graph type	source = 0 = Depth Graph 1 = Time Graph eg 1,1,GraphType=1 'plot time graph
10	GraphPosition	Set current graph position eg 1, 1, GraphPosition,source,alias,format,align,options,orientation,size,colour,10,10,50,45 'position graph in % screen		%
11	GraphTickSize	Set axis tick size	size	graph
12	GraphLegendPosition	Change current graph legend position eg 1, 1, GraphLegendPosition,,,,,,,,,90,10,, 'set bottom, left of legend		%
13	GraphSymbolSize	Set symbol size	size	graph
14	GraphScale	Set current graph scale eg 1, 1, GraphScale,source,alias,format,align,GGGGGGGGG,orientation,size,colour,1/11/2004,450,CRNTDATE+10,0 'set time graph scale 1, 1, GraphScale,source,alias,format,align,GGGGGGGGG,orientation,size,colour,10,0,50,120 'set depth graph scale		data
56	PlotGraph	Plot selected graph 1, 1, PlotGraph 'plot selected graph
57	PlotAxes	Plot just axes	why ?
20	Text	Plot text from a data field		data
21	Label	Plot a label may contain text variables eg Ranch %FARMNAME% or numeric eg Daily water use = %ScheduleDWU:DWU:1%		data
22	Formula	Output result of a numeric formula		data
25	IndirectFormula	Outputs the evaluation of text that is a formula eg 1, 1, IndirectFormula, LOWER,,,,,,,,90,10,95,12 'LOWER contains a formula for lower limit	Field name	data
58	Border	Sets border colour and width (pts) for all following Label, Text, Formula and IndirectFormula Notes: by default border = Black, 1px Border line style (solid, dot, dot-dash etc) is set on each Label, Text, Formula with options(5) The Fill Colour is set with a command FillColour (default = YELLOW)
24	Picture	Plot image. .BMP, .JPG or .WMF format	source = file name (no path) files must be in Prwin\Reports\ File names can use eg %CropName%.jpg File name will be output if file does not exist	data
30	Line	Draw line from Left,Top - Right,Bottom Size sets the line width in points StyleID after Y2 (also applies to box and arrows)		data
31	Box	Draw box from Left,Top - Right,Bottom	Size sets the line width in points [6] sets line style. [7] sets fill style. Colour sets line colour.	data
32	Arrow	Draw arrow from Left,Top -> Right,Bottom		data
33	DoubleArrow	Draw double arrow from Left,Top <-> Right,Bottom		data
34	Symbol	Plot symbol at X,Y source=symboltype		data
36	Gauge	Fuel Gauge showing current RZ1 relative to Full (100%) and Refill|Stress|PWP (0%) eg 1, 1, GAUGE, RZ1, RZTEXT1, AMT, 0,GGGGGGGGG,0,80,Black,60,20,62,35 Source: RZ1 Alias heading shown above gauge - RZ1TEXT -> 0-110cm Font 80% of standard size Positioned at horizontal = 60-62%, vertical = 20-35% Colours, labels set with FileMenu/Export		paper
52	Bucket	Plot Bucket showing water allocation usage during the season. eg 1, 1, BUCKET, K5, Allocation (Kl/Ha),AMT,0,GGGGGGGGGG,0,80,0,70,20,72,35 Total water use calculated from meter readings entered in keydata row 1 (K1) Formula @CUM(k2) in keydata row 5 (K5) calculates total delivered water during the season Allocated amount (maximum allowed) entered in keydata row 5 FULL column. Enter the first meter reading in Refill column to calculate volume used in season. Top caption = Allocation (Kl/Ha) Font 80% of standard size Positioned at horizontal = 70-72%, vertical = 20-35% Colours, labels set with FileMenu/Export
41	ProfileGauge	A diagram showing the changes down the profile, in both VSW% and mm, between that last 2 readings. Customised here FileMenu/Export, but gauge size set in .gpt line eg 6, 1, ProfileGauge, , Changes, VSW, 0, GGGGGGGGGG,0,80,Black,85,20,95,40
54	PlotExtra	Plot values from a .dwu,.fac,.size file see example 8,13,PLOTEXTRA,example.siz,alias,0.0,align,GGGGGGIGGGGGGGGGGGG,orientation,1,PALEBLUE,,,,,89 'minimum size in 1pt, dot, pale blue, styleid=89 8,15,PLOTEXTRA,example.siz:2,alias,0.0,align,GGGGGIGGGGGGGGGGG,orientation,1,PALEGREEN,,,,,89 'maximum in pale green
	Formatting	Various options are controlled by characters in the options string eg Character(1) plots a border Character(2) sets bold (1) Border H = text (2) Bold H = bold text (3) Units H - units after values eg 3.2mm/day (4) Negative H = output negative values in red: -23.0 mm (5) Fill Style G=transparent, H=solid, I=horizontal, J=vertical , K=diagonal up, L=diagonal down, M=cross, N=cross diagonal (6) Line Style G=solid, H=dash, I=dot, J=dash-dot , K=dash-dot-dot, L=transparent, M=inside?
60	Colour	Set colour for all following items	details
61	BackColour	Clear and set background colour (but not for physical printer)	details
62	DrawWidth	Set width in points for all following lines	Width	Points
63	DrawStyle	Set line style for all following lines	0 = solid 1 = dotted
63	SetSymbol	Set symbol size for all following symbols	??
67	Font	Font name = Source, Font Size = Size	e.g. 1, 1,Font,Arial,alias,format,align,GGGGGGGGGGG,orientation,12 'change font to Arial 12 pt
28	Include	Include another graph report e.g. 1, 1, Include, DripBlock 'output report with name = 'DripBlock'
16	GraphRows	Set which rows to plot on time graph. eg 1, 1, GraphRows, 2, RZ1 'plot field list RZ1	0 = plot all 1 = plot selected 2 = plot list; Alias = Field list name
17	GraphColumns	Set which columns to plot on depth graph. eg 1, 1, GraphColumns, 2, 3 'plot last 3 readings	0 = All 1 = Selected 2 = Latest. Alias = NumberOfLatest
Version
2	BeginIf	Start of an IF block	eg 1, 1, BeginIf, MethodID=2 'if continuous	examples
3	BeginElseIf	Start of an ELSE IF block	condition
4	Else	Start of an ELSE block
5	EndIf	End of an IF block
	example 1 ,1, BEGINIF, CROPNUM=20 'if site crop number = 20 do the following commands 1 ,1, BEGINIF, MethodID=2 'if site is 'continuous' do the following commands 1 ,1, BEGINIF, Option(49) 'if site is a 'text import' do the following commands 1 ,1 ,BEGINELSEIF, FARM = 4 'if farm number = 4 do the following commands 1 ,1 ,ELSE 'otherwise do the following commands see option codes
6	Select	Start of Select/Case block	Variable name
7	Case	if any value is true then then following lines are output	value(s) eg 1,3
4	Else	following lines are output if no output from other CASE
8	EndSelect	end of select block
	example 1,1,SELECT, CROPNUM 1,1,CASE, 1 'if crop number=1 do the following... 1~1~CASE~ 2,3 'if crop number=2 or 3 do the following... 1,1,ELSE 'for any other crop number do the following... 1,1,EndSelect
41	ProfileGauge	Diagram showing changes in soil moisture down profile
29	RestoreSettings	what is this ? Restore all grahic attribute - colour, line style, etc - to user settings
35	NewPage	Start printing on a new page
37	Orientation	Set paper orientation eg 1,1,Orientation,2 'switch to landscape	1 = Portrait; 2 = Landscape

Labels, text and formulas

Text can be positioned in two different ways...

1. If Right, Bottom are entered then...

   • Text is plotted inside a box given by Left, Top, Right, Bottom
   • Align = Left | Right | Centre inside box see align codes
   • If Orientiation = 1 a line is plotted around the box.

   e.g.

   3,3,LABEL,Full:,,,R,,1,100,1,88,10,92,12

   prints 'Full:' right aligned in a box from 88-92% horizontal, 10-12% vertical.

2. If Right, Bottom are not entered then...

   • The text is positioned relative to a point
   • Left and Top are the coordinates of the point
   • Orientation sets position relative to the point.
   • Align - not used

   e.g.

   3,3,LABEL,CRNTAMT,,AMT,1,0,-8,100,0,CRNTDATE,CRNTAMT,,

   The value of RZ1 is printed just above the last probe reading...

Position Units

The position of a graph and the legend are in percent of paper (or screen) - top left of paper is 0%, 0%; centre of paper is 50%, 50%; bottom right of paper is 100%, 100%

The position of all other items (text, labels, lines, arrows, scales) are in either...

(1) Percent paper units

or

(2) Data units

Can be specified as either a value or a formula.

If the first character is numeric (e.g. 50, or 10+(CRNTAMT+PREVAMT)/2) it is assumed to be percent % paper units.
(use +10+(CRNTAMT+PREVAMT)/2 instead)

If alpha or a formula (e.g. FULL+20 or +250 ) it is assumed to be in 'real-world' data units (e.g. mm of water). The value is then converted to percent paper to position the item.

Text alignment

Text can be aligned inside a box

Text orientation

Text can be output relative to a point

Text and formula options

Prwin2 saves extra options for text and formulas as characters. G = 0 (OFF); H = 1 (ON); I = 2, etc

e.g. GHHGGGGGG will show text without no border, in bold, and numeric values with units

Numeric codes for Site options

Numeric codes used with Option() to get (or over-ride) a site option.

The actual value will be local or global (Option(12)) or Option(33)

Other options - always site-specific

Graph Styles

TODO GraphStyle
StyleID after Y2
(also applies to box and arrows)

Wildcards

TODO Wildcards stuff cnm be included in LABEL source, Alias text - will be shown as 'hover help text

Examples of graph report definition lines

Also see Example GPT Reports

Ticks and symbols

The size of ticks and symbol are in units of percent of graph size.

Ticks=2 will give 'standard' ticks with a length of 2% of the size of the graph; ticks=100 will give a grid across the graph.

Format codes

Format codes are used to set the display format. The value displayed (e.g. mm or ins, and decimal places) will also depend on ProbeMenu/DisplayUnits

Other Microsoft format codes (as used in Excel) can also be used.

Screen definitions (SPT)

Different screen layouts can be customised. Each layout is given a name, and can be chosen on SitesMenu/Layout.

To customise screen layouts use SitesMenu/Layout/Edit

Each column on the screen can have a value or a gauge

Values below zero can be highlighted in red, and values can also be edited

Gauge are configured on FileMenu/Export tab: Gauges

Each line in the SPT file has the format...

LayoutNumber, Column, Type, Source, Width, Format, Align, Units, Title 'Comment

Examples of screen column definitions...

   |Site   |
   |Num    |
   |       |
   |    123|
   |    124|

   |Refill  |
   |      mm|
   |        |
   |     230|
   |     242|

   |Deficit   |
   |        mm|
   |          |
   |     230mm|
   |     242mm|

Import definitions (IPT)

The lines at the top of the file are set by various options on SitesMenu/Import

These options allow the data to be filtered, only importing a reading every 6 hours, for example

If the data is from continuous logging systems, an irrigation can be automatically posted if there is an increase in soil moisture

There are two types of lines...

• A line to specify each imported column in the incoming data file.
• A line to specify the destination - where the data will go.

Note: ver2 has a different format, but it also has an IPT editor.

Imported columns

The line has the format...

Cn, Format, Start, Width, Row 'Comment

Examples of column definitions...

Destination of imported data

The line has the format...

On,Source,Destination,Calculated 'Comment

Examples...

Top | Prwin home | RSNE home | Back