Академический Документы
Профессиональный Документы
Культура Документы
User Guide
Contents
Project Settings .......................................................................................... 1
Supreme Report - Overview ................................................................. 1
Software Requirements:................................................................... 1
Workflow ...................................................................................... 1
Communication Drivers Setup................................................................... 2
Project Settings - General Tab ...................................................................... 4
Project Settings - Database Configuration Tab................................................. 6
Project Settings - Web Configuration Tab ....................................................... 8
Project Settings - Project Paths Tab ............................................................. 10
Project Settings - Log File Settings Tab ........................................................ 12
Project Settings - Language Selection Tab .................................................... 14
Project Settings - User Management Tab ...................................................... 15
Supreme Report Studio.............................................................................. 17
Logger Studio - Overview ................................................................... 17
The Logger Studio ......................................................................... 17
Item Group Definition ................................................................................ 18
Adding items group ....................................................................... 18
Item Group Definition - Logging Schedule Tab .............................................. 19
Item Group Definition - Record Conditions tab .............................................. 20
Alarm Group Definition .............................................................................. 21
Alarm Group Definition - Record Rate Tab .................................................... 22
Alarm Group Definition - Log Alarm on Event Tab .......................................... 23
Designer Studio ........................................................................................ 24
Designer Workspace .............................................................................. 24
Designer Studio - Menus ................................................................ 24
Designer Studio - Rulers and Grid ............................................................... 27
Designer Studio - Deigning your report ........................................................ 29
Creating a new report .................................................................... 29
Report Settings......................................................................................... 31
Report Settings - General Tab................................................................. 31
Report Settings - Report Name Format Tab .................................................. 33
Report Settings - Report Time Definition Tab ................................................ 34
Report Settings - Generate Report on Event Tab ........................................... 35
Report Settings - Report File Format Tab...................................................... 36
Report Settings - Excel Format ................................................................... 38
Report Settings - E-mail Manager................................................................ 40
Report Settings - Printer Selection............................................................... 42
23/7/07
23/7/07
II
23/7/07
III
Project Settings
Supreme Report - Overview
Use the Supreme Report to quickly and easy design graphically rich reports in PDF or Excel format.
E-mail, print or view the reports from anywhere in the world by surfing to the Supreme Report Web
portal.
The Supreme Report program is an integral member of the P-CIM program, allowing for a seamless
integration with the P-CIM project and data retrieval directly from the projects database.
Software Requirements:
For viewing PDF files, install the Adobe Acrobat Reader (use Acrobat Reader 7.0 or higher)
To use the Supreme Report Web Portal - install the IIS (Internet Information Service) prior to
installing Supreme Report.
To learn more about configuring the data logging, refer to the Logger studio section
To learn more about the database configuration and maintenance, refer to the Database
Configuration page
To learn more about the graphical report design, refer to Designer Studio section
To learn more about configuring reports for automatic generation and distribution, refer to the
Report Settings page.
Workflow
1. Setup the communication settings
2. Configure the project settings
3. Configure the Supreme Report Studio settings (Logger and Designer)
4. Design your report (add static, statistical or analytical objects)
5. Generate the report.
23/7/07
A demonstration of how to setup the communication driver can be seen in the following link: Show
Me!
Source
Definition
History Driver - used for collecting historical records from the OPC server.
Select the P-CIM Native Driver option from the menu.
Connection
Parameters
23/7/07
Add definition
Modify
definition
Delete definition
Highlight and click this button to delete an entry from the list
23/7/07
In this tab you define the project's general setting and enable or disable the users authentication
option
Project Name
Displays the project's assigned name. You may change the name by
typing in a new one.
Project Author
Displays the project's assigned author. You may change the author's
name by typing in a new name.
Project
Description
User
Authentication
Displays a free-text description of the project. You may change the project's
description by typing in a new description.
Check to enable or uncheck to disable the users authentication option.
For more information regarding users management, refer to the users
management page.
23/7/07
Note: should the User Authentication option is enabled and the logged-in user does not have
access to the users management console, the "User Authentication" menu will be disabled.
Note: the Supreme Report project name must be identical to the P-CIM project's name
23/7/07
Default database
(MS Access)
The default database type (Ms Access). Choose this option if you
wish Supreme Report to manage the database. The project's
database will be automatically created in the project's database
folder.
23/7/07
ODBC Database
Source
Enable Database
Limit Control
23/7/07
Alias name...server
Shows the alias name of the local Web server. This name is
automatically assigned to the project's virtual directory
23/7/07
23/7/07
Displays the project's root directory. You may not change this
setting
Log File
Default Database
Web Fiels
23/7/07
10
23/7/07
11
Log file settings are done from this tab, which has the following options:
Displays the log file's name. You may change the name by typing in a
new one
Limit size...file
Limit file size by: Either use the default setting or type in a new file
size. When file' size is reached, new data will be ignored
23/7/07
12
Limit Option
Cut from end: records are purged according to most recent date
Cut from beginning:records are purged according to most ancient
date
23/7/07
13
Select language
Tip:
In order to add a new language, one needs only to add a new table to the database, by copying the
English table (English is a template language), open the table and replace the English strings by the
language you wish to add.
23/7/07
14
Login, Password,
Confirm Password
Account is disabled
Check to disable the user account. The user will not be able to login
until this check box in unchecked
Access to web portal - when checked grants the user access to the
Supreme Report Web portal over the Internet\Intranet
User related
comments
Click the add button to add a new user account, the modify to edit
the user account settings and the delete button to delete the user
account
23/7/07
15
When opening the Supreme Report Studio, the user is prompted to type in his user name and
password
Note: The Supreme Report Studio is automatically closed after three unsuccessful log-in attempts.
23/7/07
16
23/7/07
17
Add Items to Group menu option will open the Add Items dialog box, described below in detail.
Used to edit data item list of the entire group.
Selecting the Add Group option opens the group definition dialog box.
General.
This page defines the groups' general properties:
Group name
Group description
Group source
Add items
Shows a list of every available items you can add to the group, on the left
side of the window. Selected items are shown on the right side of the
window.
23/7/07
18
Record mode
Values are retrieved and logged based upon the following selection
only if the value is different than previously logged. You can use the
Tolerance option to define how many value units must change to log a
new value.
Record period
23/7/07
19
Enable record on
condition
When checked indicates that values are logged only if predefined conditions are meat. Whether logging scheduler is set
for the group, data is logged during the logging period only and
if the event meets the defined rules.
Data source - select the P-CIM Native Driver from the list
Item Name - select an item from the available items list. Set the
condition and value to meet. Data is logged only when the
defined value is retrieved.
Check the Log out of range - check box to set how values
exceeding the defined range in the From and To boxes will be
logged. When disabled, indicates that out-of-range values are
ignored. When checked, values exceeding range will be rounded
to the closest range limit and written to file.
Engineering conversion
23/7/07
20
Group name
Group description
Alarm driver
Priority rang
Filter specifies priority range of alarms which will fit the entire group
definition.
23/7/07
21
Click the Add button to add a new schedule to the list. Highlight
and click the Modify button to edit an existing entry. HIghlight and
click the Remove button to delete an entry.
23/7/07
22
Enable Record on
Condition
Data source
Item name
Either type in the item's name or browse to add the items from
the list. Select the condition sign and value
23/7/07
23
Designer Studio
Designer Workspace
Designer Studio - Menus
The following menus are located at the top of the Designer Studio window. Use the menus to
quickly access commonly used actions, design and generate the report, configure the project's
settings and enforce security policies on users accounts
Open project
Apply Report
Template
Save Project
Save Project As
Delete Report
Select to delete the current report. All pages in the report are
deleted
Print Preview
Exit
Logger
Report Designer
Full Screen
23/7/07
24
Database
Definition
Web Configuration
Set Paths
Log file
Select Language
Add Group
Add Item Group - select to add a new items group to the report
Add Alarm Group - select to add a new alarms group to the report
Batch Definition
Align to
Rotate
Grid
Other
Graphic Elements
Item Objects
Tables
Select to add a table item to the report: Item table, Alarm table,
SQL Query table, Step table and Draw table
Graphical Object
23/7/07
25
Insert Picture
Background
Select to launch the Supreme Report Runtime Engine and run the
project's reports
Contents
Register
Activate
About Supreme
Report
23/7/07
26
Rules
By customizing the positioning of the rules, you can pin-point the exact position
of the object on the report's workspace on a true scale.
Rulers are the vertical bar on the left side of the page and the horizontal bar on
the top side of the page workspace
Subduvisions - (horizontal and vertical) sets the space between the ticks on the
ruler. Options are: Fine (1mm tick), Normal (5mm tick) and Coarse (1cm tick)
Ruler zero - sets the offset between the ruler's 0 mark and the top left corner
of the workspace
23/7/07
27
Grid
A set of dots, drawn in vertical and horizontal lines across the workspace which
you can use to align objects on the page and with other objects
Minimum Spacing - sets the minimum allowed spacing between the dots on the
workspace. Grid spacing will change according to low zoom factors but not
lower than set.
Grid Origin - sets the offset position for the left most point on the grid. The
offset is counted in millimeters from the upper left corner of the page.
23/7/07
28
23/7/07
29
Note: the first page of every report cannot be deleted. Therefore the "Delete Current Page" option
is disabled.
23/7/07
30
Report Settings
Report Settings - General Tab
In the Report Settings window you setup and modify every aspect of the report. The window is
split into two sections, the right section holds a list of every existing report. To edit or modify the
report's settings, highlight it and browse through the different tabs.
To open the report's settings window, move to the Report Designer Studio tab, highlight and rightclick a report. From the right-click menu, select the Report Settings option.
When you open the report's settings window, the General tab is the first one to open. This tab has
the following options:
Report
Name
23/7/07
31
Description
Report
Storage
every year separately. Every report that was created in the same year is
stored in a single folder. This setting is specific for each report
Store files for period of - maximum number of days for keeping reports.
23/7/07
32
23/7/07
33
Monthly or yearly
report
Monthly / Yearly - select the time frame from the pull-down menu
Select day of month - monthly reports - reports are generated on
the same day of the month. Yearly reports - select the fixed day
of the year from the menu at which date the report is generated
Daily or weekly
report
Execute report
each
NOTE: you may assign both generation schemes to reports. Report setting can be configured to be
generated only according to a schedule or in periodical cycle.
23/7/07
34
Enable Generate on
Event
Data Source
Item name
Condition Value
Select the argument from the pull-down menu and type in the
condition value. The condition value sets the rule upon which
reports are generated. Range: 65535.00 to 65535.00. Use a dot
symbol "." as decimal point.
23/7/07
35
PDF (Adobe
Acrobat)
Printer
23/7/07
36
Excel
Page Format
Page Size - Select the page format from the pull-down menu. Reports
Orientation
23/7/07
37
Compound objects
Expression objects
Item tables
Alarm tables
Step tables and
SQL tables.
1. To add object to an Excel spreadsheet select a report from the report list, select needed an
object from a left-bottom part by clicking it and place the selected object in a cell in by rightclicking on the spread sheet.
2. To move an object within the spread sheet to another cell, select an object in a cell clicking it and
then right-click on a new cell. The object will be automatically placed there.
Table titles will show in the Excel spread sheet as plain text titles
Export Table
Headers
Table headers will show in the Excel spread sheet as plain text
header
Export to static
style
23/7/07
38
Tip: When creating a new Excel report file, Supreme Report will copy a template excel file from a
folder "Untitled" from the Project folder named - template.xls file.
23/7/07
39
SMTP Server
User name
Password
E-mail Sender
The name of the e-mail account. This name will appear as the email sender. Type in the account's user name.
E-mail Subject
E-mail text
Type in the message body. This text contains the message text.
23/7/07
40
Alias, E-mail
Address
Check all
Uncheck all
Add
Delete
Import
23/7/07
41
23/7/07
42
Macro name
SQL Macro/
Shell
Command
23/7/07
43
Enter macro to
execute
Execution
Mode
Add
Modify
Delete
highlight an entry and click this button to remove an entry from the list
23/7/07
44
23/7/07
45
Note: The Users Authorization window is accessed from the General tab by clicking on the Define
Users button.
23/7/07
46
Static Objects
Designer Studio - Background Settings
Customize the workspace background color to your needs, or set a picture as a background.
To do so, either right-click anywhere in the workspace and select the Background option from the
menu, or open the Designer menu and select the Background option.
You can also click on the background icon from the toolbar menu
Set background
color
Select the background color from the pull-down menu. You may
customize the background color by selecting the More Colors
option
Set background
picture
23/7/07
47
3. When finished, press the ENTER button or click on a workspace outside of the rectangle - text
will be accepted.
Font size can be increased or decreased by 1 size unit using the appropriate toolbar icons:
Text string can be aligned within the text box by right or left edge or by center, using the
appropriate buttons on the alignment toolbar.
You can choose to change the direction of the selected text, make automatic enumeration, outline
paragraphs by bullets or move sub-paragraphs in and out.
Default direction of the text is left-to-right, however you can change it right-to-left, using the text
direction toolbar buttons (selected button on the picture above).
23/7/07
48
Drawing static objects is done using the Drawing toolbar or through the Designer menu.
This menu has the following options:
Line
To draw a line, click the Line button, position the mouse pointer at the
beginning of the line, and while holding down the mouse key, drag the
mouse towards the end point of the line. Click on the line once to assign or
edit properties: colour, width or style.
Multi-line
Select the multi-line button, position the mouse at the starting point and
release the mouse button. Drag the pointer to the end point. In order to
finish, start new lines and to stop - right-click mouse button. Multi-line will
be drawn. In order to edit line properties, click on that line and select
needed property value. The following line properties can be edited : colour,
width, style.
Circle
Select the Circle button, position the pointer at the place where you wish to
draw the circle, draw the circle by dragging the mouse to while holding
down the mouse left key. To edit the object's properties, click on the circle.
The following line properties can be edited : colour, width, border line style
and background colour.
Ellipse
Line
width
Select an object, click on the arrow icon in the toolbar menu and select the
line width you wish to apply.
Line style
Select an object, click on the arrow icon next to Line Style button in the
toolbar menu and select the line style you wish to apply.
23/7/07
49
2. Click once at the position where you wish to place the picture. This position will correspond to
the top-left corner of a bitmap.
3. Next, the Open File dialog box opens, prompting you to select an image file. You may select any
of the following image formats: *.jpg, *.bmp or *.gif files.
4. Once the image is inserted into the report it is handled as a native object. It will be saved as part
of the report layout and will not use the original image picture file as a reference.
The image is available to most of object operations: copy/paste, resize, move etc.
2. Next, draw a rectangle where you to pace the object in the report.
23/7/07
50
Object name
Assign a unique name to the object. The maximum name's length must not
exceed 64 characters. You may use only alphanumeric characters.
Object
description
Select Data
Item
Select the database file and item to use as the source. According to the database
type you are using, select either Supreme Report History database or External
History Server.
23/7/07
51
Selected
statistical
function
Select the statistical function to assign the item from the pull-down menu. The
available options are:
First value - provides a first found value of selected item from a database within
a specified time period
Last value - provides a last found value of selected item from a database within
a specified time period
Minimum - retrieves minimum value of selected item within a specified time
period
Maximum - retrieves maximum value of selected item within a specified time
period
Timestamp of first value - displays a time stamp of a first found value of selected
item during specified time period. Displayed time stamp has tunable format of 3
options: Date/time or Date only or Time only.
Timestamp of last value - displays a time stamp of a last found value of selected
item during specified time period. Displayed time stamp has tunable format of 3
options: Date/time or Date only or Time only.
Timestamp of minimum - displays a time stamp of a minimum value of selected
item during specified time period. Displayed time stamp has tunable format of 3
options: Date/time or Date only or Time only.
Timestamp of maximum - displays a time stamp of a maximum value of selected
item during specified time period. Displayed time stamp has tunable format of 3
options: Date/time or Date only or Time only.
Average - calculates average value of selected item during specified time period
Weighted average - calculates weighted average of selected item during
specified time period. Weighted average has different calculation method than
average value, so those two statistical functions have not to be mixed.
Weighted average function accounts values as well as time duration of each
value. So it's an average, based also on time period of duration of each value.
Sum - calculates sum of all found values of selected data item during specified
time period.
Integral - calculates integral value of all found values of selected item during
specified time period.
Standard deviation - calculates standard deviation off all found values of selected
item during specified time period.
Selected
statistical
function
(cont.)
Duration in interval - calculates the total time period when the item's values
were within a specified value range and returns the result in a HH:MM:SS forma.
When this statistical function is selected, you have to enter filter value for a
range of values, considered for calculation. Negative and floating values are
accepted, however only numeric values can be entered. This filter doesn't work
with text or symbolic values.
For example: If we calculate Duration in interval between 12:00 and 14:00 with
value range 10-20, where between 12:00 and 13:00 item value was "12" and
between 13:00 and 14:00 item value was "22", then as item value was only 1
hour (12-13) within specified value range, the result will be 01:00:00
System availability - calculates and displays at which part of the total defined
period the system was available. The calculation is done as follows: calculating
the duration when the selected item had a non-zero value and afterwards the
time period is divided by the overall time period of the object and multiplied by
100%. The result is how many percents (%) of the overall period selected item
had non-zero value.
For example: If we calculate system availability between 12:00 and 14:00,
where between 12:00 and 13:00 item value was "1" and between 13:00 and
14:00 item value was zero, then time period were this item was non-zero is 1
hour (12-13) of 2 hours in total (12-14), so (2/4)*100% = 50%. So, the result of
this example will be 50%.
When System Availability statistical function is used, "%" is automatically added
as a unit, if no other unit is specified. In order to remove % as a unit, please,
define space as a unit " ".
Counter - statistical function mainly used to calculate consumption (water,
electricity consumption etc.). This function displays the difference between the
last and first value of the selected item during a specified period of time.
Example: If counter function is applied to item, which had values:
30,40,50,60,70,80,90 - then this statistical function will return 60, which is (9030).
If the counter values has it's maximum value, after which the counter starts to
count from the beginning, it can be configured as well. You have to specify the
maximum value, and the Start value, i.e. the value from which counter start to
count after reset (e.g. from 0 or from 1)
Example: If you define counter with maximum of 1000 and start of 1 and your
data item has values 800, 900, 100, 200, then the result will be 399, which is
(1000-800) + (200-1)
Counter of logged values - calculates how many times a value of specified data
item within a specified value range was logged in the database within a specified
period of time. If Logged Value Counter function is selected, define a range of
values (filter), considered for calculation. Values you enter in range are inclusive
and will be accounted in calculation. Negative and floating values are accepted,
however only numeric values can be entered. This filter doesn't work with text or
symbolic values.
If the value filter is empty and does not contain any value range a full value
range, i.e. all values will be considered for calculation.
23/7/07
53
Selected
statistical
function
(cont.)
ON Counter - calculates how many times during a specified time period, a value
of a selected data item has changed from zero to non-zero value.
Example: if during specified period the following values of a given item where
found: 1, 0, 0, 1, 0 ,1, 0 - then result of ON Counter for this value range will
return 2, because only 2 times value was changed from 0 to 1
OFF Counter - calculates how many times during a specified time period a value
of a selected data item was changed from non-zero value to zero.
Example: if during specified period the following values of a given item where
found: 1, 0, 0, 1, 0 ,1, 0 - then result of ON Counter for this value range will
return 3, because 3 times value was changed from 1 to 0
ON/OFF Counter - calculates how many times during a specified time period a
value of a selected data item was changed from zero to non-zero value and then
changed back to zero.
Example: if during specified period the following values of a given item where
found: 1, 0, 0, 1, 0 ,1, 0 - then result of ON Counter for this value range will
return 2, because 2 times value was changed from 0 to 1 and back to zero.
NOTE: the term "Found Values" stands for values which are presented in the
Supreme Report database or external history server in correct manner and
correct time stamp.
23/7/07
54
Define
time
period
Definition of time period for statistical calculation for that object, is described in
details in
Time Definition section of this manual.
Period, defined for this object can be not only time-based but also Batch-based.
This is described in details in section Batch Definition.
Result Representation section defines format of output result (decimal precision,
added unit etc.) is described in details in the appropriate section.
Advanced SQL Condition section enables you to define advanced filter for
processed values. Detailed information about it you find in the appropriate page.
Note: If you select to use "Supreme Report History", you will be prompted to select a data item
only from a list of data items, defined in one or more logging groups in the Supreme Report logger.
However, if your select to use statistical function is "Current Value", you will be prompted to select
a data item from a complete list of available data items from the selected data source.
If you select option to use "External History Server", then you will be prompted to select a data item
from list of all available items from selected history source.
IMPORTANT NOTES:
When using an MS Access database and the columns names or tables names are starting from "_"
or other non alphanumeric symbol, those columns or tables names must be closed by square
brackets (e.g. [_MyTable] or [_MyColoumn]). This is not required when working with an SQL Server
database.
23/7/07
55
Precision of results
after decimal point
Select how many digits will appear after the decimal point.
Select up to 6 digits.
23/7/07
56
Advanced options
23/7/07
57
1. Enter a valid SQL script-based condition using any field or column from the table, corresponding
to the source, which is defined in the main definition of the data object.
SQC may be applied only to Supreme Report history and cannot be used with an External History
Server data. SQC cannot contain conditions which relate to the data table other related to the data
source, defined in the data object.
23/7/07
58
2. Select the source, item name and click on Add button and the item will be added with the following format:
23/7/07
59
Example1: If you specify to display the word STOP if a value range is From 0 to 0 and the letter RUN
if a value range is 1-1, then during the report generation the result is 1, and instead of the value 1,
PDF report will show the work RUN
Example2: If no text is specified and red bold font for value range 0-10 and no text and green font
for value range 11-20, then if result value is 9 - you will see 9 in your report PDF file.
Note: If there is an overlap of values in the list of ranges (e.g. ranges 0-10 and 8-15) then the first
found suitable range will be considered.
Enabled advanced
visualization
Display Style
Click the Add button to add a new entry to the list, highlight
an entry and click the Modify button to edit it, highlight an
entry and click the Delete button to remove an entry
23/7/07
60
23/7/07
61
2. Draw a rectangle at the location where you wish to place the table in the report.
The Item Table definition dialog window opens with the following options:
23/7/07
62
Get data
from
Selected
list
23/7/07
63
Value
range
Logged Value - data is extracted from the historical records and displayed
exactly as is.
include in the items' table. You can use negative and floating values.
Define time
period
Select the time period to use from the pull-down menu .Time Definition
defines period for calculation of statistical data for this object is described
in details in Time Definition section of this manual.
Batch Period,is described in details in section Batch Definition.
Table name
Disabled by default. Check the Display Table Name check box to enable
presenting the table's name.
Display
Columns
Check the check boxes next to the field's names to include or exclude
columns from the table. According to your selection, the column's width,
in percentage, changes. Use the Move Up and Move Down buttons to
change the order of the columns in the table. Check the Sort By check
box next to one of the columns to selecting the key by which to sort the
table's columns.
Sort In
23/7/07
64
Font
Properties
Set a specific font settings for the table's title, header and data
List raws
from start/
From end
According to the option you select, the table's maximum number of rows
is counted either from the first or the last row. Either use the default
maximum rows number or type in a new one
23/7/07
65
Refer to the Advanced SQL Condition page for more information regarding the option and settings
in this tab.
23/7/07
66
2. Next, draw a rectangle at the position where you wish to place the table in the report workspace.
The Alarm Table definition dialog window opens with the following options:
23/7/07
67
Get Data
From
According to the database used in the project, select to use either the
Supreme Report History or External History Server options
Selected List
Alarm Filter Manager - refer to the Alarm Filter page in this help of
detailed information
Define Time
Period
23/7/07
68
23/7/07
69
Defined
batches
Name
Type in the batch name (it will update batch name in batch list
automatically).
Description
23/7/07
70
New Phase
Pressing on this button will create a new batch definition, which will
have the same functional meaning as a normal batch, but will be
visually placed as a tree node under a batch, which was selected
before clicking "New Phase" button.
Defined in
external
database
Select Data
Location
23/7/07
71
Whether the batch ID is taken from a tag value from a real-time driver and its value is logged into a
Supreme Report database, then choose the "Defined by data item" option.
If this option is selected, you have to click on a button to browse Supreme Report real-time tags,
select the data source and data item containing the batch IDs.
Once the Data Source and items are selected, the batch definition is completed.
Continue designing your project. During the report generation the Supreme Report connects to a
batch database, analyzes its data, retrieves the start and end time for needed batch IDs and apply
retrieved periods to all objects, which periods are defined on that batch definition.
If you will add a phase of a batch - it will have exactly the same definition and will act exactly the
same way as batch. As mentioned before, meaning of a phase is used in Supreme Report in order to
have visually more understandable project definition reading.
23/7/07
72
Absolute Date/
Time
23/7/07
73
Relative Date/
Time
Choose the time offset back from the time of the report's original
time and date. The current time-stamp is captured and used to
calculate the time and date offset accordingly.
Batch based
Example: Last three batches means the three last completed batches, not including the one, which
is in process now. Current 3 batches will mean 3 latest batches, including the one, which is in
process now.
23/7/07
74
List of defined
alarm filters
Priority
Set the alarms' priority range using the From and To fields
23/7/07
75
Source
Select the data source to use from the pull-down menu. If external
history server is used, the Source menu will be filled with history
access drivers, defined in the project.
One filter can be defined to one source. The combo box you select
source, whose alarms will apply to the alarm filter, which you are
defining.
23/7/07
76
Object
description
ODBC Data
Source
Either select an existing ODBC DSN or click on the Add DSN button to
launch the DSN wizard that will guide you through the steps
SQL Query
Any valid SQL command can be specified in the SQL Query edit box.
If you need to use dynamical values in your SQL condition, based on
your statistical calculations, you can add any valid object name using
the following format {f#<field name>], which can be either Single
data object, Compound object or Expression object.
In this case during the report generation the value will be calculated
and the result placed instead of the {f#<field name>].
23/7/07
77
You should create a DSN entry for the this database and add it to the Driver definition.
Note: When using MS Access database and column names or table names, starting with "_" or
other non alphanumeric symbols, those columns or tables names have to be closed by square
brackets (e.g. [_MyTable] or [_MyColoumn]). This is not required by SQL Server database.
23/7/07
78
2. Draw a rectangle at the position where you wish to place the table.
23/7/07
79
Object
Description
Number of
columns
Either use the default number or type in the number of columns that
will populate the table.
Defined Time
Period
Define a general time period for the table. Time period definition is
described in details in Time Period Definition section.
Table period, defined for this object can be not only time-based but
also Batch-based. This is described in details in section Batch
Definition.
Step period
If you define a time period of one day and a step period of one hour,
a 24 hours table is generated with 24 lines, each line representing a
single hour and contains statistical calculations
23/7/07
80
Table name
Display table
name
23/7/07
81
Display Columns
List available columns that you can include in the report, as well as
their order, size, width, caption and data sorting. Check to include a
column in the table, or uncheck to exclude it from the table.
The Caption column represents the caption of each column. To
change the caption, double-click the corresponding caption inside
the column.
The Sort By column defines which column is used for sorting the
table. Only one column can be used.
Column type is used to configure statistical data definitions. Click in
the column and click the browse "..." button. The following menu
opens:
Step data
Select this menu to define statistical calculation for selected column.
When you select this
menu, data definition dialog box will be opened:
This Data Definition dialog window is described in details in Single Data Object section.
The only difference between the Single Data object definition and the Step Table data definition
window is that you can not set the time period. Selected statistical functions will be calculated for
selected data items separately for each line for the time period, corresponding to that line.
Example: Defining a table from 12:00 until 15:00 with one hour for each step (line), the defined
statistical object is calculated three times for time periods: 12:00-13:00, 13:00-14:00, 14:0015:00 for three lines of the output table.
23/7/07
82
Also, in the Appearance section of the Step Table data definition the options: "Visible", "Write back"
are not available, because they have no sense in the context of using Single Data Object in step
table
23/7/07
83
2. Draw a rectangle at the position where you wish to place the table.
The following window opens with the following options:
23/7/07
84
When the free table is added to the project, you may fill it with the following possible data:
Static text
Date/Time
Single Item
Compound
Expression
3. Double-clicking a cell in a free table opens the text input of that cell. Right-clicking a cell opens a
pop-up menu. This menu enables you to define the content of the cell.
If the Item Field, Multiple or Compound options are selected, the appropriate dialog box opens,
enabling you to setup the object who will be attached to the selected cell.
4. To delete a free table: right-click on any cell in a table and select the Delete Table option.
Alternatively, you can select a table, click on the table's border so that no cell is selected and press
Delete key.
23/7/07
85
2. Draw a rectangle at the position where you wish to place your pie.
The following window opens:
23/7/07
86
Chart based
on
Indicates the type of data that will be presented in the pie graph.
Choose of the following options from the pull-down menu:
Select data
item
Select the data source and items to present in the graph. Click the
browse button to select a data source and items.
Manual Data
Entry
Process
value
Define time
period
Legend
(optional) Type in a legend for each slice and select the differentiating
color.
23/7/07
87
Min slice,
Maximum
Select the minimal size of each size in percents. Choose the maximum
number of slices per graph.
If you select a pie type, based on Counter of Logged Values, more edit boxes open to setup
additional filters, where you enter a range of values, which will be counted for the result.
If this pie function is selected, the program will retrieve the appropriate historical records and count
how many times the selected data item's values were logged into the database and display the
result number.
If you select a pie type, based on Counter of Logged Alarms, the following dialog box opens:
Click on the Select Alarm Filter button and the alarm filter selection dialog window opens, prompting
you to select one alarm filter, select the colour, enter the legend (if necessary) and add slice to the
pie definition.
Whether this pie function is selected the program will retrieve alarm historical records and count
how many alarms, with matching attributes to selected alarm filter and display the result number.
NOTE:
Pie definition cannot include different pie functions - one pie graph can include slices with the same
pie function only.
Pie definition does not include slices of different time periods - one pie graph uses one time period
for all slices.
23/7/07
88
Pie
Graph
Name
Displays the graph's name. Check the Display Name check box to include the
object's name in the report.
Display
Options
Check the boxes next to the following options to set what properties will
show in the graph:
Display Legend - displays a legend box. Can be placed on the right side or on
the bottom of the pie.
Display Border - displays a line between the slices and on the edges. That
border line has adjustable colour.
Display Value - displays a numeric value, represented by each slice. Value is
written inside each slice. Value font properties are adjustable. Decimal
precision and measure units are available as well
Display Percentage (%) - displays percentage of each slice within 100%,
represented by all slices. Percentage is displayed next to each slice
externally.
23/7/07
89
Display
Style
Check the boxes next to the following options to define the how text is
displayed in the pie:
Title - when this radio button is selected, specify the font type and size of
the pie title. You may select text alignment, font style, font colour and
background colour for a title text.
To set the title with transparent background open the background colour
palette and select the "No colour option".
Legend - when this radio button is selected, specify the font type and size of
the pie legend. You can select the legend positioning. Legend can be placed
at the bottom or on the right side of a pie object. You can specify the font's
style, font colour and background colour for a legend.
To make a legend with transparent background open the background colour
palette and select the "No colour" option.
Values - when this radio button is selected, specify font type and size for
slice values. You can select text alignment, font style, font colour and
background colour for a value text.
This option has sense only when "Display Value" check box is enabled.
Percentage - when this radio button is selected, specify the font type and
size for the slice percentages. You can select the text alignment, font style,
font colour and background colour for a percentage text.
This option has sense only when "Display Percentage (%)" check box is
enabled.
Select
unit to
add to
result
Define which measurement unit to display after the decimal point in the
slice's value. Use this option only when the Display Value check box is
selected.
Precision
of result
after
decimal
point
Define how many digits after the decimal point will be displayed in the value.
Use this option only when the Display Value check box is selected.
Advanced SQL Condition section is described in details in the Advanced SQL Condition page.
23/7/07
90
2. Draw a rectangle at the position where you would like to place the bar graph in the report.
23/7/07
91
23/7/07
92
Chart based
on
Select the mean to display the data in the bar graph. The following
options are available:
"Value" - represents data item raw or statistical value for a defined
period
"Counter of Recorded Values" - display the number of times a selected
data item was logged into the database and its value is matching
specified value range.
"Alarm Counter" - display number of alarms, occurring during a specified
time period, and its attributes are matching selected alarm filters.
Get data
from
Specify the type of source from which the historical records are retrieved
Select Data
Item
Select the data source and items to include in the graph. Click on the
browse button to locate the data source and items.
Process
Value
When displaying data item value for a specified period, you can display
either:
Last logged value - last raw value from the database
Average - average value for this data item, calculated for the time
period defined for the pie
Minimum - minimum value for this data item, calculated for the time
period defined for the pie
Maximum - maximum value for this data item, calculated for the time
period defined for the pie
Define time
period
Defines time period for calculating the statistical data for this object.
Refer to the Time Definition page for details
Period, defined for this object can be not only time-based but also Batchbased. This is described in details in section Batch Definition.
Bar Period
Sets the time period per bar group. The graph will draw a graph window
for a time period, defined in Time Definition section splitting the window
into sections with the length of each according to the Bar Period
definition.
All bar slices will be calculated and displayed separately for each period.
Legend
(optional) Type a legend for each bar and select the color
Manual data
entry
Click to enter static numeric values. These will stay fixed for the duration
of the report generation. This option allows you to create a bar graph
which combines both statistical and static data.
Note: when the Manual Data Entry check box is checked, all data
definition controls, the likes of data item selection, time definition etc.,
will be disabled. To enable those controls again, you have to uncheck
that message box again.
23/7/07
93
Selecting a bar type, based on Counter of Logged Alarms, the following dialog box will be opened:
1. Click the Select Alarm Filter button and the alarm filter selection dialog window opens, where
you have to select one alarm filter, enter the legend (if necessary) and add a slice to the pie definition.
If this pie function is selected, Supreme Report will go to alarm history and count how many
alarms, which attributes are matching to selected alarm filter and display the result number.
NOTE:
Bar definition cannot include different pie functions - one pie graph can include slices with the same
pie function only.
Bar definition doesn't include slices with different time period - one bar graph apply defined time
period for all slices, which it contains
Bar
Graph
Name
Display
Options
Check the boxes next to the following options to include or exclude the
bar's properties. The available options are:
Display Name - displays the title name.
Display Legend - displays a legend box. Can be displayed on the right side
or at the bottom of the bar.
Display Values on Y Axis - displays values on the Y axis. Axis line and values
will have the same colour as a bar colour.
Display Timestamp on X axis - displays times tamp on the X axis of the bar.
Timestamp may have different format which is defined in the Timestamp
Format combo box below the check boxes.
Display Value - displays a numeric value, represented by each bar. Value is
written inside each bar.
23/7/07
94
Display
Style
Title - when this radio button is selected, specify the font type and size for
the bar title. You can select to align the text, font style, font colour and
background colour for a title text. To make title with transparent
background open the background colour palette and select the "No colour"
option.
Use this option only when the "Display Name" check box is enabled.
Legend - when this radio button is selected, specify the font type and size
for bar legend. Select the legend positioning: either at the bottom or on the
right side of a bar object. Specify font style, font colour and background
colour for a legend.
To create a legend with transparent background open the background
colour palette and select the "No colour" option.
This option has sense only when "Display Legend" check box is enabled.
Advanced
SQL
Condition
23/7/07
95
2. Draw a rectangle in the workspace at the position where you wish to place the chart.
The following window opens:
23/7/07
96
Get Data
Source
23/7/07
97
Manual Data
Entry
Start of report
period \ End
of report
period
Line Style
Choose to either use line with marks, line only or marks only
23/7/07
98
2. Draw a rectangle in the workspace where you wish to display the date and time when the report
was created.
The following window opens:
23/7/07
99
Date/Time
Appearance
Select the date and time format to used in the report. The options
are:
Time definition
23/7/07
100
2. Draw a rectangle in the position where the report name will be displayed.
Text visual properties can be edited as properties of a usual text: font size, colour, style - in the font
toolbar
When copying and pasting this object to another page the new page number will de automatically
displayed.
When adding a page number to a page template and applying that page template to another multipage report, the page number object will automatically display the page number of each page.
23/7/07
101
2. Draw a rectangle where you wish to position the object in the report.
Text visual properties can be edited as properties of a usual text: font size, colour, style - in the font
toolbar
23/7/07
102
Report Templates
The Report Template mechanism in designed for creating reports' to be used as building block for
generating reports.
A report template includes static, dynamic statistic and analytic objects.
Save an existing report as a template, will apply the report's contents to the template
23/7/07
103
Runtime Engine
Supreme Report Runtime Engine
When you are satisfied with the report's structure, added items and configured the format to use,
run the Supreme Report Runtime Engine to collect items' real-time values, historical records
and alarms, generate the report and view, e-mail print or export if to Microsoft Excel spread sheet
program.
Change
Reload
Project
Whether the you have made any changes in the current project, click to
reload the project's file to bring the changes into effect
23/7/07
104
STOP/RUN
Click to run the selected project or stop the runtime engine from collecting
records
List if
reports in
process
Active
Check the boxes next to the names of the currently running reports to
either enable to disable automatic report generation. You can generate a
report by manually generating a report by selecting it and clicking on the
Generate button
Generate
Project
Settings
23/7/07
105
Run on startup
Show icon in
system tray
Windows options
maximum
23/7/07
106
<report>
-f
23/7/07
107
<period>
a period for report generation. Can have the following values: last
day, last n days, last hour, last n hours, last week, last n
weeks, last month and last n months, Current day, Current
hour, Current week, Current month, current quarter where n is a
number from 1 to 500.
-a
<start of
period>
hh:mm:ss, or dd/mm/yy-hh:mm:ss.
<end of
period>
hh:mm:ss, or dd/mm/yy-hh:mm:ss.
-r
<start of
period>
<end of
period>
defines date and time of the start of period. Its format is : dd.mm.yy-
defines date and time of the start of period. Its format is : dd.mm.yyrelative mode of date and time in period definition
defines date and time of the start of period. Its format is : ddhh:mm:ss. Where dd-hh:mm:ss is a number of dayshours:minutes:seconds back from the current moment of generation.
defines date and time of the start of period. The format is : dd-
hh:mm:ss.
23/7/07
108
Launching the Supreme Report Generator file, from the Tools icons group, without any command
line arguments opens a dialog window where you will be able to select the report name and define
the sets the time you wish to generate the report.
This window has the following options:
Select Report
23/7/07
109
Change report
generation time
Dynamic Data
Replacement
23/7/07
110
Supreme Report copies the project's file to the web server. Therefore, each time the runtime engine
is launched the server is automatically configured with the entire project.
To access the Web portal, open an internet browser and type in the following address:
http://localhost/Supremeweb/default.htm (or http://<IP address>/Supremeweb/default.htm)
This link will automatically take you to the welcome page. DRweb is a default alias name for
Supreme Report web portal, which is automatically created in web server.
To change the alias, create a custom alias name in the Web Configuration dialog box in Project
Settings tab.
If the current project is password protected, you will be prompted to enter the log-in information.
Only users defined in the User Management menu are allowed to access the portal.
Whether the User Management option is disabled the portal will not prompt for user authorization.
Only reports approved for the current user will be displayed.
In case more than one Supreme Report station exists, the user is able to choose which station he
wishes to log-on to.
The Web portal enables you to browse through the list of generated reports included in the
currently running project and to generate a new reports.
Each report is created in PDF format, which enables you to save the report, print or email it.
23/7/07
111
23/7/07
112
23/7/07
113
Select one of the following types of report generation from the pull-down menu:
Fixed - select the report's fixed time period. For example: last 1 day, week or month.
Relative - select the start and end of time period of the report. Type in the start date and time and
the end date and time.
Absolute - select the report's absolute start date and time and an absolute end date and time.
Original Time Period - use this option to generate the report with the original date and time.
Check the Change Report Time Generation box to generate the report with the a fixed date and
time periods.
Dynamic Data Replacement (relevant to all options) - check this option to replace source or
items in the report with alternative source or items.
Click the Generate button to generate the dynamic report using the report generation type you have
selected.
The home button is displayed only in a multi Supreme Report stations configuration.
23/7/07
114
The logout button (cross) will be displayed only if the User Management mechanism is activated.
Use the refresh button to update the reports information such as number of reports and last
generation time.
23/7/07
115