Supreme Report

P-CIM Supreme Report
User Guide
Afcon Software and Electronics Ltd
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
P-CIM Supreme Report User Guide
23/7/07
Report Settings - Macros Tab...................................................................... 43

Report Settings - User Authorization Tab ...................................................... 45
Static Objects ....................................................................................... 47
Designer Studio - Background Settings ............................................ 47
Designer Studio - Text Object ..................................................................... 48
Adding a New Text Object .............................................................. 48
Editing an existing text .................................................................. 48
Text Object Manipulation................................................................ 48
Designer Studio - Static Objects.................................................................. 49
Designer Studio - Adding an image.............................................................. 50
Designer Studio - Single Data Object ........................................................... 50
Adding a single data object............................................................. 50
Result Representation Tab.......................................................................... 56
Advanced SQL Condition Tab ...................................................................... 58
Designer Studio - Advanced Visualization ..................................................... 60
Designer Studio - Item Table ...................................................................... 62
Creating an item table ................................................................... 62
Adding item to the display list ......................................................... 64
The Appearance Tab ...................................................................... 64
Advanced SQL Condition Tab .......................................................... 65
Designer Studio - Alarm Table .................................................................... 66
Setting up an Alarm Table ............................................................. 66
Designer Studio - Batch Definition ............................................................... 68
Setting a new Batch Definition ....................................................... 68
What is a Batch Phase? ................................................................. 69
Designer Studio - Time Period Definition ...................................................... 71
Designer Studio - Alarm Filter Manager ........................................................ 73
Setting an alarm filter.................................................................... 73
Designer Studio - SQL Query Table.............................................................. 75
Configuring the SQL Query Table..................................................... 75
Designer Studio - Step Table ...................................................................... 77
Creating a new Step Table.............................................................. 77
Designer Studio - Free Table ...................................................................... 82
Designing a Free Table................................................................... 82
Designer Studio - Pie Graph ....................................................................... 84
Creating a Pie Graph...................................................................... 84
23/7/07
II

Designer Studio - Bar Graph ....................................................................... 89
Creating a Bar Graph ..................................................................... 89
Designer Studio - Chart ............................................................................. 94
Designing a new Chart .................................................................. 94
Designer Studio - Date and Time Objects ..................................................... 97
Adding a Date and Time Object ....................................................... 97
Designer Studio - Page Number Object ........................................................ 99
Adding a page number to the report ................................................ 99
Designer Studio - Project Name Object ...................................................... 100
Report Templates.................................................................................... 101
Saving a new report template ....................................................... 101
Runtime Engine ...................................................................................... 102
Supreme Report Runtime Engine........................................................... 102
Launching the Runtime Engine ...................................................... 102
Runtime Engine Setting ........................................................................... 104
Dynamic Report Generator ....................................................................... 105
Using the Dynamic Report Generator module .................................. 105
Command line arguments............................................................. 105
User Interface Mode .................................................................... 106
Working in ActiveX mode ............................................................. 107
Supreme Report Web portal.......................................................... 107
Supreme Report Web Portal ..................................................................... 107
Setting up the Supreme Report Web Portal ..................................... 108
Generating a report from the Web portal ....................................... 109
Generating a Standard Report....................................................... 109
Generating a Dynamic Report ....................................................... 110
Web Portal Toolbar ..................................................................... 111
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
Communication Drivers Setup

To connect to the P-CIM database and retrieve real-time data, alarms or collect historical records,
the communication settings must first be configured.
Communication drivers are set in the Driver Configuration window, accessed from Logger
Studio menu.
The following driver configuration dialog box is opens:
A demonstration of how to setup the communication driver can be seen in the following link: Show
Me!
Source
Definition
Source Name - type in a name for the data source

Data Driver - used for collecting real-time data values from the OPC
server. Select the P-CIM Native Driver option from the menu.
Alarm Driver - used for collecting alarms from the OPC server. Select the
P-CIM Native Driver option from the menu.
History Driver - used for collecting historical records from the OPC server.
Select the P-CIM Native Driver option from the menu.
Connection
Parameters
Displays the OPC server the driver is connecting with.
23/7/07
Add definition
Click to add the driver parameters to the list.
Modify
definition
Highlight and click this button to modify an existing entry
Delete definition
Highlight and click this button to delete an entry from the list
23/7/07
Project Settings - General Tab

From the Supreme Report Studio click on the Project Settings tab and select the General
Setting option.
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
Project Settings - Database Configuration

Tab
The Database Configuration tab is where you define the database type to use to log alarms,
historical records and more.
Records are logged by default into the Supreme Report proprietary database and may be stored in
to any ODBC complaint database.
This tab contains the following options:
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
Use SQL Server
Check to log records to set SQL server as the default database

instead of MS Access database.
ODBC Database
Source
Check to use an ODBC compliant database (MS SQL Server, MS

Access and more). For records to be stored on an ODBC database,
you must first configure a DSN (Data Source Name) connection.
Either select a DSN from the pull-down menu or click the Add button
to launch the Wizard to instruct you on setting up a new DSN
connection.
Whether required, type in a login (user name) and password to
access the database.
Enable Database
Limit Control
Check to enable this option. It is recommended to enforce database

limitations when using size-limited databases such as MS Access or
MSDE.
Check the limit database by size option to enforce size limitation on
the database. You can change the size by typing in a new size limit
or by using the scrolling buttons.
Check the limit database by period option to enforce time limitation
periods on the database. This rule ensures that historical records in
the database will be purged when the time limit is reached. You can
change the time limit by typing in a new period (in days) limit or by
using the scrolling buttons.
Create new history

table for each day
Checked by default. Every 24 hours a new table is created for

logging historical records. A new table is also created for each driver.
23/7/07
Project Settings - Web Configuration Tab

To use the Supreme Report Web portal, you should first configure the internet server's setting. This
is done from the Web Configuration tab.
This tab has the following options:
Alias name...server
Shows the alias name of the local Web server. This name is
automatically assigned to the project's virtual directory
Remote Station Definition
Station name: type in the logical name of the Supreme Report

station
URL: web address of Supreme Report Web portal
List of remote stations
Holds details of remote stations of Supreme Report Web

portals
23/7/07
23/7/07
Project Settings - Project Paths Tab

From this tab you control the project's folders' paths. It is possible to change the default settings of
the project's folders from this tab.
By default all folders are pointed to the following directory:
<installation directory>\Projects\<Project name>
Project Configuration Files
Displays the project's root directory. You may not change this
setting
Log File
Stores the project's log files. Click the Browse button to

change path
Default Database
Stores project's default database files (if applicable)
Report destination Folder
Stores project's reports in .PDF format
Web Fiels
Stores project's web files
23/7/07
10
23/7/07
11
Project Settings - Log File Settings Tab

The Supreme Report program has a built-in logging service to log errors and information, a useful
option for debugging or auditing a project. Log files are stored in .CSV format, readable by Microsoft
Excel spread sheet program.
Log file settings are done from this tab, which has the following options:
Use On-line Log

File
Check to enable logging or uncheck to disable
Set file name
Displays the log file's name. You may change the name by typing in a
new one
Limit size...file
Check to enforce size limitation of the log files
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
Use multi session

log file
Check to instruct Supreme Report to log records into a single file

whenever the program is started. Uuncheck to move to single-session
mode, which instruct Supreme Report to log each session into a
separate log file
23/7/07
13
Project Settings - Language Selection Tab

In the Language tab you can set the Supreme Report Studio interface language. Language
settings may be changed at any time without restarting the program.
Select language
select the language to use from the pull-down menu
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
Project Settings - User Management Tab

The User Management tab contains the following options:
Login, Password,
Confirm Password
To create a new user, type in a unique user name, assign a

password to the user account and confirm the password. The
minimum password length is one character
Account is disabled
Check to disable the user account. The user will not be able to login
until this check box in unchecked
User Access Rights
Access to designer studio - when checked grants the user access to

the Supreme Report Studio for creating, editing and deleting
reports.
Access to data configuration - when checked grants the user access

to drivers' configuration menu.
Access to runtime engine - when checked grants the user access to
Supreme Report Runtime module to execute reports
Access to web portal - when checked grants the user access to the
Supreme Report Web portal over the Internet\Intranet
Access to user definition - when checked grants the user access to

users management console. The user may add, modify, disable or
delete user accounts
User Authorization
Select Language - you may assign a language to the user account.

Each user can have a customized user interface according to the
selected language
Account expires on - click to set the account's expiration date. Select
the destination date from the menu
User related
comments
Type in general information about the user
Add, modify, delete
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
Supreme Report Studio

Logger Studio - Overview
The Logger Studio
Use the Logger studio to setup the alarms, data and logging settings. The Logger Studio is vertically
split into two sections: the upper section holds all communication relevant data and logging
definition while the bottom section holds the alarm communication and logging definitions.
To collect real-time values in the logger studio, the P-CIM communication driver must be
configured. Detailed explanation are found in the Communication Driver Definition page.
At the top left corner of the window is a list containing the data items groups. Detailed information
about the data item groups definition can be found in the Data Item Group page.
The list displays all items found in a selected source or group. You can choose which list of items
you wish to view, using the combo boxes above this list control.
Select the Item List by Source - the list is populated with every available data source, defined for
the project.
Select the Item List by Group - the list is filled with item groups defined in the project. Selecting a
group, the items' list is filled with items defined in the selected group.
The lower left part of the window contains a list of the alarm logging groups. Detailed information
about the data alarm group definitions is found in the Alarm Group Definition page.
Right-clicking the item list header opens a menu from which you can select the columns to see.
If you select the Remove Column option, the selected column will be removed from the list.
Selecting the Add Column opens a dialog box from where you can select which columns to view.
23/7/07
17
Item Group Definition

Adding items group
To create a new item group open the Logger Studio, right-click the left section of the window and
select the Add Group option from the menu.
To edit the settings of an existing group, select the Modify option.
To delete an item select the Delete option.
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
Assign a unique name to each group of items
Group description
Add a description to the group
Group source
displays a list of pre-defined communication driver. Select a driver from

the list
Add data source
Click to add a new driver.
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
Item Group Definition - Logging Schedule

Tab
Use the Record Rate tab to setup rate in which data is collected and the rules which regulate when
data is logged.
Record mode
Values are retrieved and logged based upon the following selection
On Update - logging is done based on every update of item's value

On Change - logging is done based on every change in item's value and
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.
Every - logging is done on a periodical basis regardless of the fact

whether the value change or not.
On item value change - logging is done based on item's value change.

Logging is done once for every item in the group. Only items showing
real-time values can be assigned with this option.
On absolute time - logging is done on specified time. You may add more
than one logging time.
Record period
Used for setting up a logging schedule
Record time schedule - when unchecked, data is continuously logged to

file. When checked, you may define more than one logging period. Only
in this period will records are logged to file. Select the start and end time
periods and week days when logging is done.
23/7/07
19
Item Group Definition - Record Conditions

tab
Use the Record Conditions tab to set conditions for logging records and conversion settings.
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.
Log values in range
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
Use this option to convert original values to engineering values
Simple conversion - Simple conversion "/1000" will divide each

received value by 1000 and log the result.
Liniar Conversion - type in values 1 and 2 for raw measurement
and value 1 and 2 of the result and each result value will be
calculated in linear function according to entered data.
Inhibit group logging
Check to disable group logging.
23/7/07
20
Alarm Group Definition

Use the Group Definition tab to assign alarms to groups based on their source, priority and define
separate logging conditions for each of the alarms group.
To create a new alarm group, move to the Logger Studio tab, right-click an alarm and select the
Add Group option. To edit an existing group select the Modify option. To delete an existing group,
select the Delete option.
When selecting the Add Group option, the alarm group definition dialog box opens.
This dialog box has three tabs:
- Group Definition
- Logging Schedule
- Log on Condition
Group Definition - General.

This page defines general properties of group, as follows:
Group name
Type in a unique name for the group
Group description
Type in a description detailing the group content
Alarm driver
Select the data source to use from the pull-down menu
Priority rang
Filter specifies priority range of alarms which will fit the entire group
definition.
23/7/07
21
Alarm Group Definition - Record Rate Tab

Use the Record Rate tab to define scheduled logging of alarms for the entire group of items.
Record time schedule
Check to enable scheduled alarms logging
From - select the schedule starting time period

To - select the schedule end time period
Days settings
Check or uncheck the relevant days of the week the logging

schedule will run.
Add, Modify, Remove
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
Alarm Group Definition - Log Alarm on

Event Tab
Use the Log Alarm on Event tab to set logging rules. Alarms are logged according to these rules
Enable Record on
Condition
When checked, alarms are logged only if pre-defined conditions

are meat. Whether the Group Logging Scheduler is active,
records are logged only during the active period.
Data source
Either type in the name of the data source or browse to choose

from the list
Item name
Either type in the item's name or browse to add the items from
the list. Select the condition sign and value
Inhibit group logging
Check to disable group logging
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
Table 1: File Menu

New
New Project - click to start a new Supreme Report project.

New Report - click to design a new report within the report
Open project
Open an existing project
Apply Report
Template
Select to apply the current report as Supreme Report template. For

this link for additional information on reports templates
Apply Page Template
Select to apply the current page as Supreme Report page template.

Follow this link for additional information on page templates
Save Project
Select to save the current project
Save Project As
Select to save project under a different name
Delete Report
Select to delete the current report. All pages in the report are
deleted
Print
Select to print current report's page
Print Preview
Select to set the printer settings
Exit
Select to close the Supreme Report program
Table 2: View Menu

Toolsbars
Check to display various toolbars in the Supreme Report interface.

Uncheck to hide the toolbars from the window
Logger
Select to switch to the Logger Studio tab
Report Designer
Select to switch to the Report Designer tab
Full Screen
Select to switch to full screen mode
23/7/07
24
Table 3: Project Settings Menu

General
Select to open the Project Settings General tab
Database
Definition
Select to open the Project Settings Database Definition tab
Web Configuration
Select to open the Project Settings Web configuration tab
Set Paths
Select to open the Project Settings Set Paths tab
Log file
Select to open the Project Settings Log file tab
Select Language
Select to open the Project Settings Language tab
Table 4: Logger Menu

Driver
Configuration
Select to open the Driver Configuration window
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
Select to open the Batch Definition window
Table 5: Designer Menu

Edit
Contains common editing commands: Undo, Redo Group,

Regroup, Ungroup, Copy Object, Copy Object Properties, Paste
Object and Paste Object Properties
Align to
Select one of the following option to align an object to :Left,

Right, Top, Bottom, Horizontal Center and Vertical Center
Rotate
Select this option to rotate an object in the following ways: Free

Rotation, 90o clock wise, 90o counter-clock wise and 180o
Grid
Show Grid, Snap to Grid and Grid Settings
Other
Contains the following options: Bring to Front, Send to Back,

Bring Forward and Send Backwards
Graphic Elements
Contains tools used for drawing lines and controlling lines

settings. Line, Line Style, Line Width and Text Box
Item Objects
Select to add the following objects to the report: Single Object,

Compound Object and Expression Object
Tables
Select to add a table item to the report: Item table, Alarm table,
SQL Query table, Step table and Draw table
Graphical Object
Select to add the following graphical objects to the report: Chart,

Pie Graph and Bar Graph
23/7/07
25
Table 5: Designer Menu (Continued)

System Objects
Select to add the following system objects to the reports: Date

and Time, Page Number, Report Name and Project Name
Insert Picture
Select to insert a picture in the display
Background
Select to insert a background picture in the display
Insert New Page
Select to insert a new page to the report
Table 6: Runtime Menu

Run Project
Select to launch the Supreme Report Runtime Engine and run the
project's reports
Table 7: User Management Menu (not implemented)

Login with different
user
Select to login to the Supreme Report Studio with a different

user account
Edit project users
Select to open users accounts
Table 8: Help Menu

Help
Select to open the Supreme Report help files
Contents
Select to display the Supreme Report files' contents
Register
Select to register your copy of the Supreme Report
Activate
Select to activate your copy of Supreme Report
About Supreme
Report
Select to view information about the Supreme Report
23/7/07
26
Designer Studio - Rulers and Grid

You can customize the Designer Studio's canvas to fit it to your needs. The studio workspace
settings are done from the Rules and Grid menu.
Access the menu by right-clicking anywhere on the workspace and selecting the Grid settings
option.
Alternatively, go to the Designer menu and select the Grid settings option from the Grid menu.
This menu has the following options:
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
Grid spacing - (horizontal and vertical) sets the distance, in millimeters,

between the dots on the workspace. Choose between Fine (1mm tick), Normal
(5mm tick),Coarse (1cm tick) and Fixed.
Fixed spacing is determined by the value you enter in the Minimum Spacing
field.
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
Designer Studio - Deigning your report

See a short introduction movie about the Supreme Report Designer Studio
Use the Report Designer Studio as a canvas upon which to place the objects you wish to include
in the report. Each object on the canvas either represents a value or a group of values and can be
shaped according to your needs. Use tables, graphs and charts to visualize the data you wish to
show in the report including alarms, historical records or even SQL queries.
Creating a new report

To create a new report, right-click on the report tree in the Designer Studio and select the New
Report option from the menu.
To help you get started quickly, use an existing page template to design the static page design
(header, footer, background etc.).
1. Choose from a collection of report templates to add statistical objects to your report.
2. To add a new page to your report, click on the "Add New Page" icon in the toolbar:
3. Alternatively, right-click on a page and select the "Insert new page" from the menu.
4. To delete a page from report, right-click anywhere on that page and select the "Delete current
page" from the menu:
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
Only alphanumeric characters and spaces can be used as report's name.

The name is limited to a maximum of 64 characters
23/7/07
31
Description
Type in a free-text description of the report. Description is limited to 256

characters
Report
Storage
Storing and organization setting of reports
Copy report files to report folder - check to copy reports to a specific

location. Type in the destination folder in the text box. This setting is
specific for each report
Create yearly subfolder - check to automatically create a subfolder for
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
Create monthly subfolder - check to automatically create a separate

subfolder for every month. Every report created within a month period is
stored in a single folder. This setting is specific for each report
Limit
report files
storage
When checked, enforces limitations policy on reports
Limit number of stored files - maximum number of copies of the same

report will be stored. Copies exceeding this number will be deleted.
Store files for period of - maximum number of days for keeping reports.
23/7/07
32
Report Settings - Report Name Format

Tab
Defining the report's name format is done in the Report Name Format tab. Name rules are
applied to both PDF and Excel report files.
The report filename mask can be any combination of three types of components. Components
defined in a filename mask must be separated by "+". The maximum number of characters
supported is 256.
The available file name components types are listed below:
Static text. type in any number of text strings in any part of a mask. Each text should be included in
double quotations "XX" (e.g. "text"+"my report name").
Date/time in various formats. Select a date/time format from the "Add Date/Time" pull-down menu
x and click the "Add" button.
On report generation this component will be replaced by the date and time when the report was
actually generated.
Current value of any tag during report generation can be added as well. Select the data source and
tag and click the "Add" button.
During report generation this component will be replaced by current value of selected tag.
You can mix any number of components in your report filename mask however, the mask length
must not exceed 256 characters.
23/7/07
33
Report Settings - Report Time Definition

Tab
You may choose to produce reports on a regular basis, for example, weekly, monthly or yearly
reports. Controlling automatic reports generation is done from the Report Time Definition tab. You
may choose from two generation schemes; on schedule or periodical. This tab has the following
options:
Monthly or yearly
report
Select this option if you wish to generate reports on a monthly or

yearly basis
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
Select time - you may choose a specific time at which to generate

the reports
Daily or weekly
report
Select this option if you wish to generate reports on a daily or

weekly basis. Reports can be produced every day at a specific
time or daily
Set time - select specific time of day to generate report

Add, Modify, Remove - click the Add button to add a new time
definition, highlight an entry and click the Modify button to edit an
entry, highlight and click the Remove button to delete an entry
from the list
Execute On
Reports are generated according to selected days. Either check or

un-check the check box next to each day of the week in order to
select the days of the week.
Execute report
each
Selecting this option will generate reports on a periodical basis.

Select the exact time at which to generate reports. Reports are
generated every specified time.
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
Report Settings - Generate Report on

Event Tab
Use the Generate Report on Event tab to set rules upon which reports are generated. When an
event occurs matching the pre-defined rule(s), the Supreme Report Studio automatically generates
the reports.
Enable Generate on
Event
Check to enable report generating on event
Data Source
Either type in the data source name or click on the browse

button to select a data source from the list. Whether non exist,
check the data source settings in the Driver Configuration option
Item name
Select the item from the list.
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
Report Settings - Report File Format Tab

In the Report File Format tab you control the report file's format. According to your selection,
each report is generated and handled according to your selection.
PDF (Adobe
Acrobat)
Default option. Check to generate reports in PDF file format.
Email
Check to e-mail the generated report. Click the Settings button to

setup the mail message format and settings. Refer to the E-mail
Manager section for more details.
Printer
Check to automatically print the generated report. Click the Settings

button to select assign a default printer. Refer to the Printer Selection
section for more details.
23/7/07
36
Excel
Check to automatically export the generated reports to Microsoft Excel

spread sheet program. Click the Settings button to set up the spread
sheet's layout and format. Refer to the Excel Format page for
additional details.
Page Format
Page Size - Select the page format from the pull-down menu. Reports
Orientation
Select to print the generated report in either Portrait or Landscape

format
are generated and printed according to this selection
23/7/07
37
Report Settings - Excel Format

To export a report to a Microsoft Excel spread sheet, you must first setup the sheet's layout. Note
that only the report's data will appear in the spread sheet.
The following non-graphic data objects are exported:

- Single data objects
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.
Export table titles
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
Check to enable. Choosing this option instruct Supreme Report to

export the report's values to an existing Excel file rather than
creating a new file. This option is useful whether you wish to add
values to an existing report under the same name.
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
Report Settings - E-mail Manager

In the E-mail Manager window, accessed from the Report File Format tab, click the Settings
button to setup the e-mail settings used for delivering reports to e-mail accounts and setup the
message format.
The Supreme Report mailing engine delivers message using a SMTP (Simple Mail Transfer Protocol)
compliant server.
SMTP Server
Type in the SMTP server's address. Contact you Internet provider or

network administrator for details
User name
Type in the account's user name
Password
Type in the account's 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
Type in the message subject to appear as the message subject
E-mail text
Type in the message body. This text contains the message text.
23/7/07
40
Alias, E-mail
Address
Displays the message recipients list.
Check all
Click to check all recipients' check boxes. Message will be delivered

to all recipients.
Uncheck all
Click to clear previous selection.
Add
Click to add an e-mail recipient details. Type in the recipient's alias

and e-mail address. The entry is added to the list with a check box
next to it.
Delete
Highlight and click to remove an entry from the list
Import
Click to import a pre-defined recipients list from e-mail program.
23/7/07
41
Report Settings - Printer Selection

You can print the report as soon as it is generated. From the Report File Format tab, check the
Printer check box and click the Settings button. The printer selection window opens. You may
select more than one printer to use. Reports are printed according to this selection.
Paper size and orientation (portrait or landscape) will be taken from the Report File Format option
23/7/07
42
Report Settings - Macros Tab

Use the Macro tab to setup and attach a list of macro commands to each individual report to be
executed while the report is generated
Supreme Report supports two macro commands schemes: SQL and command line macro
commands
Macro name
Type in a name for the macro command
SQL Macro/
Shell
Command
Select to use SQL macro or Shell commands by clicking on the

appropriate button.
23/7/07
43
Enter macro to
execute
Whether you are setting up a Shell command macro, type in the

command. Whether you are setting up a SQL macro command, type in
the name of the stored procedure, for example:
DSN_Name:Macro_Name
If the DSN is password protected, the syntax should look like this
example:
DSN_Name;UID=login;PWD=password:Macro_Name
Execution
Mode
On event - specify the macro execution condition. Refer to the

Generate Report on Event page for details.
Before report generation - the macro command is executed prior
to generating the report.
After report generation - the macro command is executed after the
report is generated
Add
Click to add a new macro command to the list
Modify
Highlight an entry and click this button to modify an existing entry
Delete
highlight an entry and click this button to remove an entry from the list
23/7/07
44
Report Settings - User Authorization Tab

In the User Authorization tab you create and modify user accounts, assign access levels and
enforce account limitations and restrictions.
When enforcing users access control, it is necessary to specify in each report which users are
authorized to have access to the report.
User may view only those reports that they were granted access to. The security policy is enforced
when logging into the Supreme Report web portal as well.
For complete set of instructions on enforcing security policies, follow the following link User
Management.
Deleting a user from the project's users list, automatically removes the user account from the
available users list in the "User Authorization" section.
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
The menu has the following options:
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
Either type in the path or browse for the location of the

background picture
Only for current

page
Check to limit background color or image to the current page

only. Otherwise the background settings will apply to all pages of
the report
23/7/07
47
Designer Studio - Text Object

Adding a New Text Object
1. From the toolbar or from a menu select a text object and draw a rectangle where you wish to
place the text box area by holding down the mouse button.
2. At the top-right corner of the rectangle a flashing cursor will appear.
3. When finished, press the ENTER button or click on a workspace outside of the rectangle - text
will be accepted.
Editing an existing text

1. To edit an existing text object click once on the text insert, rendering the text box ready for
changing the text properties.
2. To edit the text double-click the text and text box will be opened, available for editing.
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.
Text Object Manipulation
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
Designer Studio - Static Objects

Use the Designer Studio to draw most of the basic shapes in order to add custom graphics to the
report.
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
Follow the same procedure as described in the previous paragraph.
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
Designer Studio - Adding an image

1. To add a picture in a .BMP (Bitmap) format to the report, click on the Add Image button in the
Edit toolbar as shown below:
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.
Designer Studio - Single Data Object

The Single Data Object is a dynamic object used for performing statistical calculations with a
textual output result.
Adding a single data object

1. To add a single data object click on the top button on the Elements toolbar:
2. Next, draw a rectangle where you to pace the object in the report.
The following dialog box is displayed with the following options
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
Type in a description of no more than 256 characters
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.
Data Source - select the database to retrieve items from

Item Name - select the item to use from the available items' list
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
Timestamp of minimum - displays a time stamp of a minimum value of selected
Timestamp of maximum - displays a time stamp of a maximum value of selected
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.
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.
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.
Counter of logged alarms - calculates how many alarms occurred during a

specified time period and which properties apply to selected alarm filter.
If the Counter of logged alarms options is selected, click on the Filter button and
select an alarm filter from the dialog window "Alarm Filter Manager", described
in the Alarm Filter section:
Free SQL Query - run a predefined SQL query in the database
If the SQL Query function is selected click on the "Define SQL Query"button. In
this case the result will represent only the result of the query - i.e. history,
source, item and time period definition will be not relevant. The following dialog
is opened:
You can specify a separate DSN for any database for each SQL query in a Single
Data Object you wish want to use. If a DSN is not defined the Add button will
open the standard DSN wizard.
Any standard SQL query can be specified. The query may return only a single
value as a result. If an SQL Query will return more than a single value - it will
display only one value. Value type can be of any type. If received value type is
not numeric, it will be displayed as a string.
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
Result Representation Tab

From the Result Representation tab you control the result's format (decimal precision, added
unit etc.) of both textual statistical and analytical objects.
Enable object visible

in report
When checked indicates that the results will be published in the

report. When unchecked indicates that the results will remain
hidden. This options is useful whether the object is created for
internal calculations and is not intended to be published in the
report.
Select unit to add to

result
Either select or enter a string that will be added to the result.

This options can be used to display measurement units for
better report readability.
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
Write results back to

data item
Select whether to write the result back to the original item.

Select the data source and item to use. The result is written
when the report is generated or when the object's value is
calculated
Advanced options
Opens the Advanced Visualization definition window, which is

described in details in Advanced Visualization section.
23/7/07
57
Advanced SQL Condition Tab

Use the Advanced SQL Condition tab to configure additional data filtering rules.
Advanced SQL condition is set in the format of a WHERE SQL command and added to the main
conditions, defined in the data object, for example: time period, source, item name etc.
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:
[i#<Item Name>]. Afterwards, it is automatically converted into a valid SQL expression.

You can build a condition which will not contain a constant condition value, but a statistical field and
the value will be calculated during report generation. You may select any existing data object,
defined in the entire report from the drop down menu, just below the SQL condition edit box, and
click the Add button.
The selected field will be added to SQL condition in the format of [f#<Field Name>].
If the SQC condition contains a field name the object value will be calculated as following: first,
values of all objects are calculated, including the SQC string. Next the SQC string is compiled using
the actual object's values. Last, the value of the entire object is calculated.
If you use the name of the entire object in the SQC, it may lead to unexpected results and therefore
is not supported.
If you create two objects which contains a SQC with identical names, it may lead to unexpected
results and therefore is not supported.
23/7/07
59
Designer Studio - Advanced Visualization

Use the Advanced Visualization tab to enhance the visualization of the statistical results in the
report.
You may specify a list of value ranges of data item, specified in that object, and a text which will be
displayed in the report instead of the result value.
Together with the displayed text you can specify the visual text properties: font size, style, colour
and background colour.
The same text can be used for multiple value ranges (e.g. if you want to display the same text with
different colour and font).
If no text is specified for a value range, the original result will be specified in the report. However,
result representation will use the font and text background properties which are defined for that
value range.
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.
This window has the following options:
Enabled advanced
visualization
Check to enable the advanced visualization option
From, To, Display Text
In case when a value is found the defined range, the text in

the Display Text field will be shown in the report in stead of
the actual value
Display Style
Select the font, size, presentation, font color and background

color
Add, Modify, Delete
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
Designer Studio - Item Table

Use the Item Table object to display an array of values from one or mote data items, within a
specified value range logged during a pre-configured time period.
Creating an item table

1. Click on the "Item Table" button on the Supreme Report Element toolbar.
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
According to the database used in this project, select to retrieve records

from either the Supreme Report History or External History Server options
Selected
list
According to the selected database, the list is populated with existing

items. Click the Edit List button to add or remove items from the list.
23/7/07
63
Value
range
Logged Value - data is extracted from the historical records and displayed
exactly as is.
Moving Average - each records is automatically recalculated into a moving

average array. Each array element is an average of every array member
that came before including itself. When using this option, the value filter
is ignored.
Minimum Value and Maximum Value - specify the range of values to
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.
Adding item to the display list

Clicking on the Edit button opens a new dialog window from which you may select the data source
and items to be displayed in a table. One or multiple items from or different data sources can be
selected.
Data source combo box contains existing data sources with data driver enabled, defined in a
project.
When you select a data source the "Available Data Items" list box will be filled with a list of data
available items from selected source.
User can select different items from different sources. When item selection is completed, click on
OK to confirm your selection.
The Appearance Tab

To adjust the settings of the table move to the Appearance tab which contains the following
options:
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
Select to sort the values either by Ascending or Descending order.
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
Advanced SQL Condition Tab
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
Designer Studio - Alarm Table

Use the Alarm Table dynamic object to display a list of alarms according to specified time period,
selected alarm filter and in defined appearance.
Setting up an Alarm Table

1. Click on the"Alarm Table" button on the Supreme Report Element toolbar.
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
Displays a list of alarms which apply to one or more of the selected

alarms filters To edit the alarm filer, click on the Edit List button
Alarm Filter Manager - refer to the Alarm Filter page in this help of
detailed information
Define Time
Period
Sets the calculation period of statistical data. Refer to the Time

Definition page in this help for detailed information.
Batch definition is described in the Batch Definition page of this help
The Appearance Tab

Move to the Appearance tab to control the table's appearance, columns, fonts, colors and more.
23/7/07
68
23/7/07
69
Designer Studio - Batch Definition

Use the "Batch Definition window to set a rule that dynamically calculates the time period between
each report production periods.
Setting a new Batch Definition

Open this window from the Logger menu, Batch Definition option.
To add a new batch definition, click on the New button and new batch definition will be added to
the list.
Defined
batches
Displays a list of existing batches (if previously configured)
Name
Type in the batch name (it will update batch name in batch list
automatically).
Description
Type in a description in the text box on the right.
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
Whether the batch ID is taken from a external database. Select a DSN

from the pull-down menu were the batch information is stored. If one
does not exist, create a new DSN and continue with the batch
definition.
Whether a DSN is protected by a user name and password type in the
appropriate User name and Password . Select the "Connect" button
and Batch Manager will connect to your database.
Select Data
Location
Specify the location of the data components, necessary for processing

the batch information:
in the section "Select Data Location" you have to:
In Select Table combo box: select a table, containing batch information
(batch ID, start time and end time)
In Field with Batch ID combo box: select a table column containing the
batch IDs
In the Field with Batch Start Time and Field with Batch End Time
combo boxes ,select the table columns containing the batch start time
and end time.
If your batch information table contains one field where both batch
start and end time are stored - select the same table in both combo
boxes.
What is a Batch Phase?

Some batch processes may contain sub-batch process, or Batch Phases, e.g. in a complete
production line for fish smoking there are 4 ovens. So there is a complete batch for full production
between a time when raw fish was loaded and ready fish came out. But this complete batch has 4
phases, when fish is treated in each of 4 ovens. So, time when fish is in each oven is called a
"phase" of a complete batch.
It is possible to organize all batches definitions in a tree structure: defining batches, phases, subphases etc. That way, each definition will have exactly the same functional meaning in the project.
Each batch process is marked by a unique ID and this ID is used later to recognize and differ
between batches (process loops). To track batches you have to define where the batch IDs can be
picked up and were they are stored.
Supreme Report batch definition allows tracking batch IDs by a tag from any real-time data source
or from an external database.
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
Designer Studio - Time Period Definition

Use the Time Period window to define the report's time frame. It is possible to generate reports
using one of the three following options:start and end of time period ,fixed time periods or object
period, based on a batch definition (for batch process reporting).
To use the Fixed Period, you must select a fixed time period, which can be either:
Last - means "previous", i.e. if current time is 14:32, then:

Last hour will be 13:00 - 14:00
Current - means "which is not ended at this moment, in progress".

If current time is 14:32, then: Current hour will be 14:00 - 14:32.
Manually combining a mode (Last/Current), unit and number of units allows you to compile any
needed time period (i.e. Last 3 year, Current 6 months etc.).
If you select Absolute/Relative Period in the Define Time Period combo box, specify the start and
end time of the period.
Start and End of time period can be defined using 4 options:
Absolute date/time
Relative date/time
Absolute date/Relative time
Relative date/Absolute time
Absolute Date/
Time
Choose a fixed date and time from the calendar
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
Select a batch definition used to calculate period for your object.

The Batch menu automatically contains a list of previously defined
batch definitions.
If you need to edit the list, click on the browse button ("...") and the
batch definition window opens, allowing you to edit the existing
batch definitions list.
Batch definition is described in details in Batch Definition page.
After selecting the needed batch definition, select a mode (Last/
Current) and batch count.
Last batch means a presently completed batch ID, i.e. for the
moment of report generation it has valid start time and end time.
Current batch means a batch ID, which is presently being processed,
i.e. for the moment of report generation it has valid start time and
has no end time yet.
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
Designer Studio - Alarm Filter Manager

Use the Alarm Filter Manager to limit the alarm range for processing and calculation for a specific
object within a user defined properties range.
The Supreme Report project uses one global list of alarm filters, accessible from any object within
every report in the project.
The purpose of this window is to define an alarm filter and select a previously defined filters for
specific objects.
Setting an alarm filter

List of defined
alarm filters
Name - Type in a unique name not exceeding 64 characters in length
Priority
Set the alarms' priority range using the From and To fields
Description -Type in a description of no more than 256 characters
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.
Alarm filter list
Detailing existing alarm filter list
23/7/07
76
Designer Studio - SQL Query Table

Use the SQL Query Table to connect to an ODBC compliant database and to extract the data using
a standard SQL Query.
Use this table to specify any query and visualize the results in a table with predefined outlook
parameters.
Configuring the SQL Query Table

1. Select the "SQL Query" Table from the Supreme Report Element menu.
2. Draw a rectangle at the position you wish to place the table.
Object
description
Type in a description of no more than 256 alphanumeric characters
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>].
The Appearance Tab

Move to the Appearance tab to define the visual properties of the table. Follow this link for a
detailed explanation.
Example:
You need to extract from a Batch Access database the following parameters:
Tank level values for the batch number 4 and when Motor 1 is On (1)
23/7/07
77
You should create a DSN entry for the this database and add it to the Driver definition.
Then you will get the following result:
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
Designer Studio - Step Table

Use the Step Table to automatically create a table according to predefined time periods
For example: Creating a table for a single day with a single line for each hour of the day.
Creating a new Step Table

1. Click on the "Step Table" button on the Supreme Report Element toolbar.
2. Draw a rectangle at the position where you wish to place the table.
The Step Table definition dialog window opens:
23/7/07
79
Object
Description
Type a free text description of the object
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
The Appearance Tab

The Appearance tab has the following options:
Table name
Type in a name of no more than 64 characters
Display table
name
Check to include the table's name in the report. Uncheck to exclude

the 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 start time

Select this menu to insert start time of each step period for each line
of the table.
For example: if you define a table from 12:00 until 15:00 with 1 hour
for each step (line), then Step start time will display 12:00, 13:00,
14:00 for 3 lines of the output table.
Step end time
Select this menu to insert end time of each step period for each line
of the table.
For example: if you define a table from 12:00 until 15:00 with 1 hour
for each step (line), then Step end time will display 13:00, 14:00,
15:00 for 3 lines of the output table.
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
Designer Studio - Free Table

Use the Free Table object to create static, dynamic ,statistical or textual objects in a table with
predefined size and cell split.
Designing a Free Table

1. Click the "Free Table" icon in the Supreme Report Element toolbar.
2. Draw a rectangle at the position where you wish to place the table.
The following window opens with the following options:
Rows and Columns

Definition
Use this window to set the number of rows and columns of

the table
Number of columns - select the number of columns per

table. Maximum number of columns is set 50 columns.
Number of Rows - select the number of rows per table.

Maximum number of rows is set to 50 rows.
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
Designer Studio - Pie Graph

Use the Pie Graph object to present data in a form of a pie chart. Pie chart can present values,
logged values counter of or alarms counter.
Creating a Pie Graph

1. To add a "Pie Graph" to a report select the pie graph button on the Supreme Report Elements
toolbar
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:
Value - presents data in raw or statistical values.

Counter of Logged Values - presents the number of times the selected
data was logged in the database and the corresponding value range
Alarm Counter - presents total number of alarms occurring during a
specified interval and it's attributes match the selected alarm filters
Get data
from
According to the database selected in the project, select to retrieve

records for either the Supreme Report History or from an External
History Server.
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
When checked, enables manually entering a static numeric value that

will stay fixed for the duration of the report generation process. This
option allows you to create a pie graph which combines both statistical
values and static reference values.
Check the Manual Data Entry check box and enter the number in the
edit box below.
Process
value
Use of the following options when specifying a fixed time period:

Last logged value - last raw value from the database
Current- current value
Average - average value for this data item, calculated for time period
defined for the pie
Minimum - minimum value for this data item, calculated for time period
defined for the pie
Maximum - maximum value for this data item, calculated for time
period defined for the pie
Note: when the Manual Data Entry check box is checked, all data
definition controls, for example: time definition., will be disabled. To
enable those controls again, uncheck the message box.
Define time
period
Time Definition, which defines period for calculation of statistical data

for this 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.
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.
The Appearance Tab

Move to the Appearance tab to set the graph's visual settings.
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
Designer Studio - Bar Graph

Use the Bar Graph object to represent data in a form of a bar diagram. Use the bar graph to
present values, counter of logged values or counter of logged alarms.
Creating a Bar Graph

1. To add a"Bar Graph" to the report, click on the corresponding button at the Supreme Report Elements toolbar
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
Minimum - minimum value for this data item, calculated for the time
Maximum - maximum value for this data item, calculated for the time
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
The Appearance Tab

Move to the Appearance section containing visual display options of that bar object. This window
has the following options:
Bar
Graph
Name
Type in the graph's name to be displayed in the report
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
Described in details in the Advanced SQL Condition section.
23/7/07
95
Designer Studio - Chart

Use the Chart object to present data in a form of a bar chart. You can use either raw data values or
moving average, calculated from data values which is logged during the chart period.
Designing a new Chart

1. To create a new Chart object, click on the corresponding button on the Supreme Report Elements toolbar (as shown in the picture below).
2. Draw a rectangle in the workspace at the position where you wish to place the chart.
23/7/07
96
Get Data
Source
According to the database used in this project, select to retrieve

records from either the Supreme Report History or External History
Server options.
Select the data source and items, line colour, width and style, specify
the line legend if necessary and click the Add Line button. The line
definitions are added to the chart.
23/7/07
97
Manual Data
Entry
When checked, enables manually entering a static numeric value that

will stay fixed for the duration of the report generation process. This
option allows you to create a pie graph which combines both statistical
values and static reference values.
Check the Manual Data Entry check box and enter the number in the
edit box below. This option allows you to create a graph, combining
statistical data and static reference data.
To add manual data, check the Manual Data Entry check box, type in
the number in the edit box below, select the colour for the
corresponding bar, enter a legend if needed and click Add Line button.
Start of report
period \ End
of report
period
Time Definition, which defines period for calculation of statistical

data for this object is described in details in Time Definition section of
this manual.
Time period, defined for this object can be not only time-based but
also Batch-based. This is described in details in section Batch Definition
Line Style
Choose to either use line with marks, line only or marks only
23/7/07
98
Designer Studio - Date and Time Objects

Use the Date and Time object to display the current date and/or time with pre-defined offset.
During report generation process, this field will contain date and/or time of the moment the report
was generated, minus a pre-defined time offset (if defined).
Adding a Date and Time Object

1. To add the"Date and Time" object to the report, click on the Date/Time button in the Elements
toolbar:
2. Draw a rectangle in the workspace where you wish to display the date and time when the report
was created.
23/7/07
99
Date/Time
Appearance
Select the date and time format to used in the report. The options
are:
Date - displays specified date

Time - displays specified time
Date and Time - displays both date and time
Week Number - displays the number of the week
Day of the week - displays the day of the week
Day of the week number - displays the day of the week number
Month - displays the month
Month Number - displays the month number
Year only - displays the year
Hour only - displays the hour of creating the report
Minute only - displays the minutes only
24 hour, AM/PM
Check to present hours in a 24 hours format and whether to

differentiate between AM and PM time of day
Time definition
If the Relative Date/Time option is selected - you can define how

many days, hours and minutes back from the moment of the report
generation will be displayed in report.
For example: one day and 00:00:00 means the report will contain 1
day back from current date and exactly the same time.
If the Absolute Date/Time option is selected - you can specify an
exact date and time which will be displayed in report regardless the
moment of report generation.
23/7/07
100
Designer Studio - Page Number Object

Use the Page Number object to display a number of current page in the report.
Adding a page number to the report

1. Click the "Page Number" button in the Elements tool bar :
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
Designer Studio - Project Name Object

Use the Project Name object to display the name of the current project in report.
1. To add the"Report Name" object to report, click the Project Name button on the Elements tool
bar
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
Saving a new report template

To save current report as a template:
1. select the File - Save as report template option. The report template file will be created with
*.tdr extension.
By default report template files are saved in Templates folder in the Supreme Report installation
directory.
2. To apply report template select the File - Apply report template option. Choose a report
template to apply to current report.
Every template element will be available for editing as independent objects

Apply a report template to an existing report will add the template's elements to the report page
and overwrite the entire report content.
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.
Launching the Runtime Engine

Either double-click the Supreme Report Runtime desktop icon, double-click a *.drt file in the project
folder, which you would like to run, double-click the Supreme Report Runtime icon from the P-CIM
Runtime icons group or select the Run project option from the Run-time menu in Supreme Report
studio to launch the Supreme Report Runtime Engine.
Change
Click to browse for another project to run
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
Displays a list of currently running reports. These reports are included in

the project.
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
Click to manually generate a report. Generating a report on-demand does

not negate a scheduled reports production
Project
Settings
Language - select this option to change the language settings
23/7/07
105
Runtime Engine Setting

The Runtime Engine settings are accessed from the Options window.
Open the window from the Project Settings - Options . This window has the following options:
Run on startup
Check to launch the runtime engine on Windows start-up. The

currently running project is set to default.
Show icon in
system tray
When checked, an icon appears in the Windows tray whenever the

runtime engine is activated
Save last run

mode
Check to save the last runtime engine activation mode (Stop or

Start) and use it the next time the runtime engine is launched
Windows options
Maximized Windows - check to set the runtime engine window to
maximum
Hide Window - when checked, the runtime engine is not visible

when launched and during runtime
23/7/07
106
Dynamic Report Generator

Use the Dynamic Report Generator (DRG) module to generate reports on demand.
The Dynamic Report Generator is implemented as a standard Windows module (generate.exe) and
as ActiveX component (AXC_ODS_Generate).
Using the Dynamic Report Generator module

The Dynamic Report Generator generates reports from the currently running project, changing the
report definition properties, such as time period, item and data source dynamic replacement.
Properties dynamic modifications apply only to the specific report generation and are not saved in
the report's layout. Meaning, if you have a running project which contains a daily report and you
generate this report using the Dynamic Report Generator, applying a new period of one hour will
generate an hourly report file from it and the original report will continue to run and generate daily
reports as before.
The Dynamic Report Generator has two work modes: silent and user interface.
Executing the generate.exe with command line parameters, The Dynamic Report Generator will not
open the user interface and will run in silent mode
Command line arguments

generate.exe <report name> -f <period>
Or:
generate.exe <report name> [-a, -r] <start of period> <end of period>
Other formats and commands (for batch support and others) can be added .
List of accepted parameters:
<report>
name of report to be generated
-f
fixed period for report generation
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
absolute mode of date and time in period definition
<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.
Where dd-hh:mm:ss is a number of days-hours:minutes:seconds back

from the current moment of generation.
User Interface Mode
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.
Select Report
Select the report you wish to generate from the pull-down

menu
Use original time

period
Check to generate the report with the original, rather than

current, time
Define time period
Select the time period format from the pull-down menu.

Follow this link for detailed information Time Period Definition
23/7/07
109
Change report
generation time
Check to generate a report with the original time period and in

the mean time maintaining the time difference between the
current and original time. To use this option, check the "Use
original time period" first and than check this option.
For example: If you have a weekly report and you are
generating report on the 27.01, then originally your report will
display data from 20-27 of January. Then if you set Change
report generation option to 17.01, then it will display data
from 10-17 of January.
Dynamic Data
Replacement
Working in ActiveX mode

The Dynamic Report Generator can be inserted into a page an external application, which is an
ActiveX container (such as MS Word, MS Excel, MS Power Point, Visual Basic office products or
PCVue, WinCC, InTouch SCADA software and more.
To insert the Dynamic Report Generator to another application,as a ActiveX container, you should
select the "Insert object" option in the application and you will be prompted to select needed
control.
Choose "AXC_ODS_Generate" from the list and it will insert DRG into your ActiveX application.
Supreme Report Web portal

Next to the Generate hyperlink, the web portal has a new link called Dynamic generation, which will
open a new web page with the same interface and he same functionality
Supreme Report Web Portal

Use the Supreme Report Web portal to browse the list of reports of the currently running project,
visualize existing reports and generate reports in real-time.
Setting up the Supreme Report Web Portal

To setup the Web portal, The Internet Information Services (IIS) must be installed.
Note: During the installation of the Supreme Report program, all files necessary for accessing the
Web portal are installed. In case the IIS server is installed at a later stage, the Supreme Report
must be re-installed.
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
The Supreme Report Portal Welcome window
Generating a report from the Web portal

To generate a new report, the project folders must be shared and the Everyone user account
assigned with full access rights. The program automatically sets this property to newly created
reports. However, it may be necessary to assign the account manually for each projects.
You can create reports using either the original time definition or use the dynamic generation
method. The two ways are available either from the main page for each report or from the detail
page of each report.
From the main report page, either click on the standard generation button or the dynamic report
generation button.
Generating a Standard Report

To generate a new standard report, select an existing report from the displayed list or click on the
Standard Report button
generated report.
. The following window opens displaying the most recently
Select the New Report button to generate a new report.
23/7/07
112
Generating a Dynamic Report

To generate a dynamic report, from the welcome window, select a report from the list and either
click the Dynamic Report button
button.
or, from the report page, select the Dynamic Report
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.
Web Portal Toolbar

Use the toolbar to navigate your way through the Supreme Report web portal.
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.
The back button send you back to the main page.

The refresh button refreshes the current report page to check if any report was created.
The logout button will be displayed only if the User Management mechanism is activated.
23/7/07
115

Supreme Report

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Supreme Report

Uploaded by

Copyright:

Available Formats

P-CIM Supreme Report

Afcon Software and Electronics Ltd

P-CIM Supreme Report User Guide

Afcon Software and Electronics Ltd

Report Settings - Macros Tab...................................................................... 43

P-CIM Supreme Report User Guide

Afcon Software and Electronics Ltd

The Appearance Tab ...................................................................... 86

P-CIM Supreme Report User Guide

Afcon Software and Electronics Ltd

P-CIM Supreme Report User Guide

Afcon Software and Electronics Ltd

Communication Drivers Setup

Source Name - type in a name for the data source

Displays the OPC server the driver is connecting with.

P-CIM Supreme Report User Guide

Afcon Software and Electronics Ltd

Click to add the driver parameters to the list.

Highlight and click this button to modify an existing entry

P-CIM Supreme Report User Guide

Afcon Software and Electronics Ltd

Project Settings - General Tab

P-CIM Supreme Report User Guide

Afcon Software and Electronics Ltd

P-CIM Supreme Report User Guide

Afcon Software and Electronics Ltd

Project Settings - Database Configuration

This tab contains the following options:

P-CIM Supreme Report User Guide

Afcon Software and Electronics Ltd

Use SQL Server

Check to log records to set SQL server as the default database

Check to use an ODBC compliant database (MS SQL Server, MS

Check to enable this option. It is recommended to enforce database

Create new history

Checked by default. Every 24 hours a new table is created for

P-CIM Supreme Report User Guide

Afcon Software and Electronics Ltd

Project Settings - Web Configuration Tab

This tab has the following options:

Remote Station Definition

Station name: type in the logical name of the Supreme Report

List of remote stations

Holds details of remote stations of Supreme Report Web

P-CIM Supreme Report User Guide

Afcon Software and Electronics Ltd

P-CIM Supreme Report User Guide

Afcon Software and Electronics Ltd

Project Settings - Project Paths Tab

<installation directory>\Projects\<Project name>

This tab has the following options:

Project Configuration Files

Stores the project's log files. Click the Browse button to

Stores project's default database files (if applicable)

Report destination Folder

Stores project's reports in .PDF format

Stores project's web files

P-CIM Supreme Report User Guide

Afcon Software and Electronics Ltd

P-CIM Supreme Report User Guide

Afcon Software and Electronics Ltd

Project Settings - Log File Settings Tab

Use On-line Log

Check to enable logging or uncheck to disable