Beruflich Dokumente
Kultur Dokumente
Table of Contents
1. Introduction
2. Login
3. Template
3.1. Creating a new template
3.2. Opening a template
3.3. Editing a template
3.4. Saving a template
3.5. Settings
3.5.1. Filter settings
3.5.2. Display settings
4. Sequence
4.1. Generating a new sequence
4.2. Opening a sequence
4.3. Editing a sequence
4.4. Saving a sequence
5. Report
5.1. Simple report
5.2. Ad hoc report
5.3. Generating a new report
5.3.1. Selecting templates and sequences
5.4. Opening a report
5.5. Editing a report
5.6. Saving a report
5.7. Printing a report
6. Category (directory)
6.1. Selecting a category
7. Elements
7.1. Text
7.1.1. Properties
7.1.2. Selecting a database text
7.2. Images
7.2.1. Properties
7.2.2. Selecting a database image
7.3. Diagram
7.3.1. General properties
7.3.2. Display
7.3.3. Scaling
7.3.4. Filter
7.4. Table
7.4.1. General properties
7.4.2. Display
7.4.3. Font and Border
7.4.4. Filter
7.5. Alarm
7.5.1. Alarm test
7.5.2. General properties
7.5.3. Font and Border
7.5.4. Filter
7.6. Selecting a data source
8. Management
8.1. Report objects
8.2. Texts
8.2.1. Creating a new database text
8.2.2. Editing a database text
8.2.3. Database text properties
8.3. Images
8.3.1. Database image properties
8.4. User
8.4.1. Add new user
8.4.2. Editing a user
8.4.3. Setting privileges
8.5. Groups
8.5.1. Creating a group
8.5.2. Editing a group
8.6. Passwords
9. Options
9.1. Start mode
9.2. Global units
Chapter 1. Introduction
Welcome to the Help system of OMNITREND WebReport, the software for creating, printing and
saving reports based on templates and measurement data from the OMNITREND databases.
You can create individual templates using the Template Editor. You can use the Graphic Editor to
position, combine and parameterize different elements (text, image, diagram and table) arbitrarily on a
template page. You can then save templates, repeatedly edit them, and compile them into sequences. The
templates and sequences can be used to generate nonrecurring reports (without saving) or recurring
reports.
The reports can be edited, saved, exported (PDF) and permanently saved in the database. You can
automatically generate reports through the entire database, machine train or plant sections with a few
clicks of the mouse. You can also generate alarm reports.
OMNITREND-WebReport consists of two Java program parts, the Client and the Server. The Client is
loaded, updated and started via Java Web Start. The Client is the user interface for editing the templates,
sequences and reports. The Server sets up the connection to the OMNITREND database, procures the
data for the reports and applies the data for saving.
OMNITREND-WebReport is multi-user capable; several users (clients) can communicate with a single
server. Floating and user licenses for one or more users and departments are available.
The Server software may be installed separately from the Client software on another PC in the LAN or
on a Web server in the Internet and accessed by Web Services.
Each user may belong to a group. By means of the WebReport Administrator each group can be assigned
or denied individual access authorisation for editing and creating templates, sequences and reports.
Performance features of OMNITREND-WebReport
Real 32-bit Java client-server application for Windows operating systems (others on request)
Network-capable database system with Web Service interface
Updating and starting of the user interface (client) with Java Web Start
Password protection and individual user rights
Multi-user license system
Individual design of templates, sequences and reports through a graphic user interface
User-dependent saving of settings
Automatic generation of reports through the entire database, machine trains or plant sections
Permanent report saving exporting (PDF)
Installation of the server on a remote PC in the LAN or Internet
Chapter 2. Login
After starting from the OMNITREND Report menu and given a valid WebReport license for the user
currently logged into OMNITREND, you will be taken directly to the WebReport user interface.
Normally no login dialog box appears and you can immediately start editing reports with the database
that just opened.
There are other options for working with OMNITREND-WebReport, however:
After you start the program using the Web Start icon or the icon in the tray bar (usually on the bottom
right of the screen border; click with the right mouse button), a login dialog box requests input of the user
name and password and selection of the database. The validity of the user, the password and the license
is then checked.
The program first searches for a new software version of WebReport at the server, and then and starts it.
A security warning appears requesting your consent to start the program, referring to PRFTECHNIK's
certificate guaranteeing the authenticity of the software. All program data that are loaded bear the
PRFTECHNIK certificate and the program will not start if one of the files has been manipulated. The
software is executed only after the Start button is clicked. This consent request occurs only the first time
the program is started and is locally saved in the cache.
Figure 2.1. Java security warning
The initial login dialog appears, in which you can determine the start mode.
Figure 2.2. Login dialog
Case 3 both checkboxes activated: like case 2, but in the future this login dialog box will no longer
appear and the client immediately vanishes to the tray bar.
Chapter 3. Template
Table of Contents
3.1. Creating a new template
3.2. Opening a template
3.3. Editing a template
3.4. Saving a template
3.5. Settings
3.5.1. Filter settings
3.5.2. Display settings
A template is a page of the report and consists of one or more elements, such as text, image, diagram,
table and alarm table. Using the graphic Editor you can arbitrarily position, combine and parameterize the
different elements on a template page. You can then save templates, repeatedly edit them, and compile
them into sequences. The templates and sequences can be used to generate nonrecurring reports (without
saving) or recurring reports.
Figure 3.1. Template
The Tutorial (extra package, not included with this Help) for WebReport contains a film demonstrating
the creation, editing, saving and opening of a template.
The Template Editor opens with an empty template; on the right side appear the buttons with functions
for editing the template.
A dialog box is shown, containing the category tree on the left and a display of the templates on the right. The templates are
always shown from the selected directory. You can open any of these templates by double-clicking with the left mouse
button or by selecting and clicking "OK".
Figure 3.6. Selecting a template
Note: Only templates are displayed for which you are authorized. All other templates are hidden.
You can now use the mouse to position the selected element on the template by right-clicking an
arbitrary position (usually the upper left corner), keeping the mouse button pressed and dragging the
cursor in the desired direction (usually to the lower right); releasing the mouse button then determines the
size of the element. As soon as you begin dragging, a frame with the current size of the element is
displayed, which immediately adjusts itself to the new element size with each movement of the mouse.
After the mouse button is released, the element is activated with other items allowing further changing of
the size or displacement.
Figure 3.10. Selected element
Depending on the type of the element, an additional icon will appear inside, so that the element can be
immediately recognized. In the case of text and image elements at first an empty square is displayed, but
a text or image is displayed as soon as they are defined.
You can change the properties or content of an element by right-clicking inside the area of the element
and selecting Properties in the context menu. Depending on the type of element you can then enter a text
or image or define the parameter (see "Settings and Elements" below).
3.5. Settings
3.5.1. Filter settings
3.5.2. Display settings
There are filter and display settings that you can enter in different levels (user, template and element
levels). The input, application and validity of the settings differ for the two types of filters and displays.
in the template button bar or via the menu items "Edit -> Template filter settings". On the element level
they are accessed within the Properties dialog box.
The set data type filters are worked off hierarchically from top (template) to bottom (element). If, for
example, spectra in the template are bracketed out, no spectral data will get to the elements in a template,
even if spectra were included in an element beforehand.
The following are available on the template level:
The data filter types have extensive setting options, including the following:
in the template button bar or, in the menu, by going to "Edit -> Template display settings" and on the
element level within the Properties dialog box.
Settings entered on the element level when "Use default settings" is not set have priority over the
template and user settings and are exclusively used for generating reports. Conversely, if "Use default
settings" is set, the higher-level template or user settings are used. When the template default setting
button is set, the same applies with respect to the user settings.
The settings can be entered separately for each diagram type (spectrum, time, trend) and table. For the
diagrams there are three areas of control:
Display
Scaling
Time filter
Display
Font/border
Time filter
HP/TP filter
The following can be defined for the table, font and border:
Figure 3.20. Font dialog
For the table time filter the same can be defined as for the diagram time filter (see the illustration for
Diagram), and for the HP/TP filter the following can be defined:
Figure 3.22. Data filter dialog
Chapter 4. Sequence
Table of Contents
4.1. Generating a new sequence
4.2. Opening a sequence
4.3. Editing a sequence
4.4. Saving a sequence
A sequence is a chain of templates that are successively worked off when the report is generated. Since a
report seldom consists of only one page, you can compile a report from several pages and permanently
save this sequence in the database.
Figure 4.1. Sequence Editor
Use the Sequence Editor to add templates and indeed sequences to a given sequence. The program has
the usual editing features. The templates are consecutively numbered and displayed in a list with their
paths and names. When a sequence is entered, its templates are added.
The Tutorial (extra package, not included with this Help) for WebReport contains a film demonstrating
the creation, editing, saving and opening of a sequence.
The Sequence Editor opens with an empty sequence; on the right side appear the buttons with functions
for editing the sequence.
Further explanations of the dialogs taking you further -> see the section on "Opening a template".
Chapter 5. Report
Table of Contents
5.1. Simple report
5.2. Ad hoc report
5.3. Generating a new report
5.3.1. Selecting templates and sequences
5.4. Opening a report
5.5. Editing a report
5.6. Saving a report
5.7. Printing a report
The directories can be renamed, moved, deleted and also created. These operations can be executed in
the Report Object Management (menu item "Manage -> Report objects").
Figure 6.2. Managing report objects
Chapter 7. Elements
Table of Contents
7.1. Text
7.1.1. Properties
7.1.2. Selecting a database text
7.2. Images
7.2.1. Properties
7.2.2. Selecting a database image
7.3. Diagram
7.3.1. General properties
7.3.2. Display
7.3.3. Scaling
7.3.4. Filter
7.4. Table
7.4.1. General properties
7.4.2. Display
7.4.3. Font and Border
7.4.4. Filter
7.5. Alarm
7.5.1. Alarm test
7.5.2. General properties
7.5.3. Font and Border
7.5.4. Filter
7.6. Selecting a data source
7.1. Text
7.1.1. Properties
7.1.2. Selecting a database text
Use the text element to position a text, located in a box, at an arbitrary position within the template. You can assign
different properties to the single letters and numerals.
There are two kinds of texts:
Fixed text
Database text
The fixed text is manually entered and the DB text is a default text in the database, from where it is loaded and displayed.
If the text stored in the database changes, so do all texts in the newly created reports (not with PDF reports). If you
change the DB text in the text element, the text automatically becomes a fixed text and does not affect the text stored in
the database. The change accordingly affects only the element just edited.
There are also placeholders that are filled during the runtime (in report creation):
Figure 7.1. Text element placeholder
Proceeding from left to right, the placeholders have the following functions:
Page number: The report generator replaces the page number placeholder with a serially assigned page number
Data source: The path of the data source is inserted depending on the "Section change" setting.
Date: The current data replaces the date placeholder when the report is generated.
Time: The current time is entered.
User: The user generating the report is entered here.
You can delete the entire content of the text input box by clicking "Delete text".
The Tutorial (extra package, not included with this Help) on WebReport contains a film demonstrating how to enter texts,
load them from the database, edit them, change their attributes and replace them.
7.1.1. Properties
You can draw a frame about the text box and assign different attributes to the border, like line thickness, type and color.
Use the "Line break" button to fit the lines to the actual text box size automatically when generating the report.
You can align the text line by line on the left or right or center it by highlighting the lines and clicking the corresponding
buttons.
Selecting "on the following pages of report" causes the text element to be printed on each page of the report based on this
template. Selecting "just at first page of report" prints this text element once only; an empty field then occurs on the
subsequent pages.
You can assign the following properties to the single letters and numerals.
Font
Font size
Font color
Bold
Italics
Underline
The text elements are alphabetically ordered; for each text a description, the time of creation and the author are also
displayed. If no text has been entered or the text in the text element was deleted, the text is retained as a database text in
the text element and changes if the database text is changed. If a text already occurs in the text field, the loaded text from
the database is inserted in the existing text as of the cursor position.
7.2. Images
7.2.1. Properties
7.2.2. Selecting a database image
GIF and JPG images can be loaded to an image element from a disc drive or from existing database
images. There are two kinds of images:
Fixed image
Database image
The fixed image was loaded from an external source to the image element and is integrated as a copy.
The database image refers to an image in the database and is loaded from there and displayed. If the
image stored in the database changes, so does the image in the newly created reports (not with PDF
reports). The advantage of DB images lies in their reusability, quick access and memory space-saving
feature, since only the reference to the image is stored in the image element.
The Tutorial (extra package, not included with this Help) on WebReport contains a film demonstrating
how to load images from the database and a disc drive, edit them, change their sizes and replace them.
7.2.1. Properties
You can draw a frame around the image and assign different attributes to the border, like line thickness,
type and color.
Selecting "on the following pages of report" causes the image element to be printed on each page of the
report based on this template. This is a good idea, for example, for a logo that is to appear on each page.
Selecting "just at first page of report" prints this image element once only; an empty field then occurs at
this place on the subsequent pages.
Figure 7.4. Image properties
If the image is visible in the template, you can access a context menu with different zoom levels by rightclicking the image. Selecting one of these zoom levels scales the image and the size of the image element
is automatically adjusted.
Figure 7.5. Image context menu
Once the image is selected, the element is displayed activated with other items allowing further changing
of the size in arbitrary stages and displacement to another position.
The images are alphabetically ordered; for each image a description, the time of creation and the author
are also displayed. Selecting the image and clicking "OK" applies the image reference to the image
element or replaces the previous image. After the "Image properties" dialog box is closed, the image in
its original size is inserted in the template. Any previous scaling is then lost and you will have to adjust
the image to the desired size again.
7.3. Diagram
7.3.1. General properties
7.3.2. Display
7.3.3. Scaling
7.3.4. Filter
The diagram element is used to display measurement data in graph form after generating a report, and contains other functions for evaluating
and analyzing the data.
Figure 7.7. Diagram with harmonics
The automatically selects the display mode for the data based on the data type (spectrum, time recording, trend).
The preview shows a demonstration curve and not the actual data.
Instructions on selecting the data source are given in the section on "Selecting a data source".
7.3.2. Display
In the report the filtered measurement data from the database are displayed in the diagram in the form of a curve. Depending on the diagram
type spectrum, time recording, trend, cascade, etc. different evaluation and display functions are available:
You enlarge the diagram section by right-clicking an arbitrary position (usually the upper left corner), keeping the mouse button pressed and
dragging the cursor in the desired direction (usually to the lower right); releasing the mouse button then sets the size of the zoomed area. As
soon as you begin dragging, a frame with the current size of the section is displayed, which immediately adjusts itself to the new size with
each movement of the mouse. After you release the mouse button, the diagram is redrawn and scaled with the zoomed section.
You can undo the enlargement in stages by quickly pressing ( less than 1 seconds) the left mouse button. You can display the diagram in its
entirety again using the context menu (slow click, greater than 1 second, with the left mouse button) and selecting "Reset zoom".
The context menu contains the following other display functions:
The control box can be displayed by clicking the "i" at the top right of the diagram.
Figure 7.9. Control box
By clicking the respective tabs you can change between "Control" and "Display". In the "Control" tab you can switch on the "Main Cursor"
irrespective of the diagram type, change between the "long" and "short" cursor displays, with multiple curves change the active cursor to
another data channel and change between the Main and Delta Cursors. If a time is displayed in the diagram, you can also show or hide the
Delta Cursor, in order to calculate the time and frequency between two points in the "Display" tab.
Double-clicking with the right mouse button positions the cursor at the next data point on the active curve. You can also move the cursor to
the next data point with the right and left arrow keys. Additionally pressing the Ctrl key with the arrow key makes the cursor jump along the
data curve in larger steps.
Spectra allow you to execute the following analysis functions in the diagram and display the results:
Harmonics
Sub Harmonics
Side bands
Max. peaks
The Main Cursor serves as the middle frequency in the harmonics and Sub Harmonics. The Delta Cursor must be used for the side bands and
maximum peaks. To change the middle frequency or the band spacing, you can move the cursor left or right to the next data point using the
arrow keys; moving the cursor also immediately refreshes the display of the analyzed points. For all analytic functions, a numerical field is
also offered to the right of the text for changing the number of calculation points. The analyzed diagram can be printed with the current
analysis display or saved in the unchanged PDF report. Saving as a normal report loses the analysis data.
Note:
At the upper left in the diagram appears a small dot when the diagram is in focus. f you change to another input box or even to another
application, the focus passes to the latter. You can retrieve the focus by clicking once inside the diagram area. The cursor can only be moved
when the diagram is in focus!
7.3.3. Scaling
Scaling allows you to circumscribe the diagram with predefined ranges, to obtain comparable diagrams.
Figure 7.11. Scaling
You can access Scaling via "Diagram properties". The scaling you set is permanently saved with the template.
7.3.4. Filter
The dialog boxes following Display and Filter were already described in the section on Settings.
7.4. Table
7.4.1. General properties
7.4.2. Display
7.4.3. Font and Border
7.4.4. Filter
Use the table element to display measurement data with different filter criteria in a table.
Figure 7.12. Table
Based on the data type, the table automatically selects which columns are to be displayed. In the case of a
spectrum, for example, the frequencies are also outputted.
The preview shows a demonstration table and not the actual data.
Instructions on selecting the data source are given in the section on "Selecting a data source".
7.4.2. Display
A table can very easily take up several pages of a report. A spectrum with 4096 points, for example,
could output about 60 pages in a full-page table view. You can set the output to a maximum of number of
lines or even to "Display just on first page of report" in the Table view.
Figure 7.14. Table view dialog box
Instead of the automatically determined physical measurement variable, you can select the "1st heading
line with free text". The 2nd heading line is normally outputted with the physical unit, but this can also
be assigned "free text" or the 2nd heading line can be left out completely by unclicking the check mark
from "2nd heading line with".
You can also limit Columns to a certain number and hide the "Date / time" columns and, with spectra and
time recording, the "Frequency / time offset" column, if they are not to be outputted.
7.4.4. Filter
Use the data filter to define the frequency range in spectra and the time offset range in time recordings
that are to be outputted in the table.
The remaining filter settings were already described in the section on Settings.
7.5. Alarm
7.5.1. Alarm test
7.5.2. General properties
7.5.3. Font and Border
7.5.4. Filter
An alarm element allows output of a detailed alarm table with data
Figure 7.15. Alarm table
In contrast with all other elements, in selecting the data source you can select an arbitrary branch in the machine tree and permanently save it in a template.
Instructions on selecting the data source are given in the section on "Selecting a data source".
7.5.4. Filter
The filter settings were already described in the section on Settings.
Chapter 8. Management
Table of Contents
8.1. Report objects
8.2. Texts
8.2.1. Creating a new database text
8.2.2. Editing a database text
8.2.3. Database text properties
8.3. Images
8.3.1. Database image properties
8.4. User
8.4.1. Add new user
8.4.2. Editing a user
8.4.3. Setting privileges
8.5. Groups
8.5.1. Creating a group
8.5.2. Editing a group
8.6. Passwords
8.2. Texts
8.2.1. Creating a new database text
8.2.2. Editing a database text
8.2.3. Database text properties
In Management you can update text elements (database texts) in the database. These texts may be
repeatedly used in all templates. The text elements can also be changed in Management if the user has
the necessary rights.
Figure 8.2. Managing texts
Enter the texts using the Text Editor as for the text element (see section --> Text element). Here again
you can use placeholders for the page number, date, user, etc.
Other operations, like changing the properties, removal, renaming and copying, are also possible.
If a database text in the text element in a template is changed, that text is transformed to the fixed text in
the template and does not act on the original text in the database.
8.3. Images
8.3.1. Database image properties
In the Image Management image elements (database images) can be imported into the database. Possible
JPG and GIF images are saved in their original format. These images can be repeatedly used in all
templates and also be reduced or enlarged.
The database images can be changed in Management if the user has the necessary rights.
Other operations, like changing the properties, removal, renaming and viewing, are also possible.
8.4. User
8.4.1. Add new user
8.4.2. Editing a user
8.4.3. Setting privileges
Users can be managed in the Management by the WebReport Administrator or other users with
individual rights. There are four different user levels with predefined rights that are employed after
creation of the user and can be individually adapted. An exception is the Administrator, whose rights
cannot be changed.
In WebReport two Administrators are permitted for internal management. The two Administrators
"admin" and "admin2" exist by default without passwords. After installing WebReport be sure to change
the passwords for the two Administrators. The WebReport Administrator has only management rights for
the report objects template, sequence, report and directory. That is, the Administrator can change names
and rights, but may not edit any report object. This can be done only by other licensed users with the
necessary rights. The WebReport Administrator has the right to edit users, groups and registration. You
can change to the User Administrator by double-clicking the user icon in the right bottom corner in the
main window. Each Administrator can change that Administrator's own user name and the names of the
other Administrators; the other rights (except the password) cannot be changed for an Administrator.
Enter the new user name in the "Name" input box, then set the password, mandatory for creating a user,
define the "User rights" and add, if appropriate, "Groups" to which the new user is to belong. After "OK"
is clicked the new user will be created in the database. You can individually adapt the predefined rights
for the user using "Set privileges". The user now needs only a license to be assigned for logging in
(unless the user is working in the demo mode).
Administrator status cannot be assigned to a user and has exclusively management rights, as described
above. Customer and Technician have the right to trigger generation of a report. Supervisor and
Specialist also have the right to edit templates and sequences.
If a user has individual rights, then they apply. These rights are recognized in the user dialog boxes based
on the "Individual rights" level. You can specify via the rights management in the privileges tree that a
certain user has the right to create other users, for example, and/or to edit groups, etc.
Figure 8.4. Privileges tree
Once a user has been assigned individual rights, they apply irrespective of the level in OMNITREND,
even if the level in OMNITREND is changed. A change on a predefined level (Customer, Technician,
etc.) via WebReport annuls the individual rights and the new level then applies within OMNITREND.
8.5. Groups
8.5.1. Creating a group
8.5.2. Editing a group
Use Groups to make the report objects templates, sequences and reports accessible only to a certain
group of people. After groups are created in Group Management, they can be assigned or changed in the
properties of a report object by the creator and later by all those having the corresponding right.
8.6. Passwords
After installing WebReport, be sure to change the passwords for the two Administrators, since these
users have no passwords by default. Each new user must be assigned a password with at least 5
characters. After a user has successfully logged in, that user can change the password in Management.
Chapter 9. Options
Table of Contents
9.1. Start mode
9.2. Global units
9.3. Section change
9.4. Data settings
9.5. Page settings
9.6. Display settings
If WebReport is used without OMNITREND and immediate starting of the WebReport Client is desired,
the check boxes must be deactivated in the "WebReport Login" dialog box. The dialog box is expanded
with the selection list of the available databases. From this list select a database and enter a user name
and password. The window with the graphic user interface is opened and the machine tree from the
database outputted and displayed.
If only "Start WebReport Client in the background" has been set, the Client retreats to the background
and responds to commands from OMNITREND.
If "Always start WebReport Client in the background" is set, after starting no Login dialog box is
displayed and the Client enters the background without requesting confirmation.
This setting can be changed in the Client in the menu item "Options -> Start mode".
Tip: If you regularly work with OMNITREND and WebReports we recommend activating both options
and copying the Client to the Autostart folder. WebReport will then always be available. In this case the
WebReport Server should be installed as a service, so that the Client can communicate with it at any
time.
First select the quantity, highlight with the mouse the row containing the desired unit and then click
"Activate". The activated unit is marked by an asterisk in the first column. To change the number of
digits to the right of the decimal, click "Change" and enter the number of digits. All values of this
quantity will now be outputted in the reports with the newly selected unit and the selected number of
digits to the right of the decimal.