LWEB 900 User Manual
LWEB 900 User Manual
User Manual
Version 2.2
Document № 88081507
Contents
1 Introduction .................................................................................................. 9
1.1 Overview .............................................................................................................. 9
1.2 Operating and Monitoring ............................................................................... 10
1.3 Device Configuration ........................................................................................ 11
1.4 Global Connections ........................................................................................... 11
1.5 Parameter View ................................................................................................. 11
1.6 Alarming ............................................................................................................ 11
1.7 Scheduling .......................................................................................................... 11
1.8 Trending ............................................................................................................. 12
1.9 Reporting ........................................................................................................... 12
1.10 Multiuser System ............................................................................................... 12
1.11 Event Log ........................................................................................................... 13
1.12 Licensing ............................................................................................................ 13
1.13 Supported Devices ............................................................................................. 13
1.14 Scope................................................................................................................... 16
2 What’s New in LWEB-900 ........................................................................ 17
2.1 New in LWEB-900 2.2.0.................................................................................... 17
2.2 New in LWEB-900 2.1.0.................................................................................... 18
2.3 New in LWEB-900 2.0.0.................................................................................... 22
2.4 New in LWEB-900 1.3.0.................................................................................... 28
3 Installation .................................................................................................. 32
3.1 Software Installation ......................................................................................... 32
3.2 Product Activation ............................................................................................ 32
3.3 Firewall Configuration ..................................................................................... 35
4 System Tray Icon ........................................................................................ 36
5 LWEB-900 Server ...................................................................................... 37
5.1 Manage Projects ................................................................................................ 37
5.2 Password Protection.......................................................................................... 39
5.3 Network Settings ............................................................................................... 39
5.4 Certificate Management ................................................................................... 40
5.5 Proxy Settings .................................................................................................... 42
5.6 Backup/Restore ................................................................................................. 42
5.6.1 Manual Backup ........................................................................................ 42
5.6.2 Scheduled Backup .................................................................................... 43
5.6.3 Restore ..................................................................................................... 44
Abbreviations
1 Introduction
1.1 Overview
LWEB-900 is an innovative and comprehensive solution for building management. The
software covers the whole sequence of activities, from installation of the building
management system through configuring the devices, all the way to daily operation of the
facilities. Thus, a common user interface is available at all phases of the project.
The central component is the LWEB-900 Server, which stores all configuration data in a
database and communicates with the devices of the building management system in real
time. The LWEB-900 Client is the user interface of the building management system. When
a user starts the client, he has to log on to the server before receiving access. Client and
server exchange data using web services only. Due to this system architecture, remote
access is easily possible through firewalls and NAT routers. In addition, differences
between the various field bus technologies (CEA-709, BACnet, DALI, MBus, Modbus,
KNX, etc.) are compensated and the user is presented with a consolidated view of the
separate systems.
To operate and monitor the building technical equipment a standard web browser can be
used. In this way it is possible to quickly check the status of the building automation system
while travelling. It makes no difference, whether a smart phone, tablet, or PC is used.
Compared to the LWEB-900 Client, the functionality of the web application is limited to
the daily operation of the building and does not include the functionality to install and
configure the system.
The configuration software to design the graphical representation of the installation is built
directly into LWEB-900. It allows users to easily create dynamic graphics without requiring
any programming knowledge.
1.6 Alarming
With LWEB-900, alarms from different sources can be visualized and managed in a
uniform manner. For example, an L-DALI device can generate alarms in case of a ballast
failure or if the emergency light test fails. On the other hand, a L-INX device controls the
air handling unit and triggers an alarm if the V-belt is torn or if the air filter is dirty. In
LWEB-900, these alarms are presented in a common view and the user can acknowledge or
disable them.
When an alarm occurs, one or multiple receivers can be notified via e-mail. A scheduler can
be used to control who is notified about alarms at a specific date and time. If the alarm is
not acknowledged within a configurable amount of time, an alternative action can be
triggered.
1.7 Scheduling
Schedules can be either executed in LOYTEC devices or directly in the LWEB-900 Server.
To optimize the reliability of the system, create schedulers at the same location as the
corresponding control logic. For example, an occupancy scheduler should be executed by
the L-INX automation controller which primarily uses this information, whereas a scheduler
determining which people are notified about alarms should be executed by the LWEB-900
Server.
After the schedule hierarchy has been defined, LWEB-900 calculates the resulting
configurations. If a scheduler is executed by in a LOYTEC device, LWEB-900 downloads
the configuration.
1.8 Trending
LOYTEC devices can record the value of data points over time. However, the memory
available on a device is limited. LWEB-900 overcomes this restriction by reading out the
trend data from the devices periodically and storing everything in the database.
A user can also create ad-hoc trend logs directly in LWEB-900. This is the fastest way to
create a trend log. One simply selects a data point and activates trending using the context
menu. LWEB-900 periodically polls the data point value from the device and stores the
value in the database.
Trend logs can be viewed either as tables or as charts. Especially for trend charts, a large
number of customization options are available.
1.9 Reporting
LWEB-900 can create reports based on trend logs. Reports can be used, for example, to
document the energy consumption in a building. The generation of a report can be trigger in
one of the following ways:
Reports can be generated in PDF, Excel, or Word format. They can be automatically
distributed via e-mail.
LWEB-900 uses access control lists to define which operations a user can perform on a
certain object (e.g. folder, data point, graphical view, parameter view, trend chart). To
speed up the access right configuration, access control lists can be inherited from parent to
child objects.
1.12 Licensing
The license limits the number of devices which can be managed by LWEB-900. Different
license options are available starting with 10 devices up to an unlimited number of devices.
The license also restricts the maximum number of concurrent LWEB-900 Clients and
LWEB-802/803 Clients (access for end user via web browser or Windows application). The
standard license includes 5 LWEB-900 Clients and 20 LWEB-802/803 Clients.
1.14 Scope
This document covers the LWEB-900 software. The LOYTEC devices and their
configuration software are beyond the scope of this manual. Please refer to the device
specific user manuals for additional information.
Parameter View
In the previous version of LWEB-900 the parameter view could contain only data points of
LOYTEC devices which were marked as parameters in the device configuration software.
The new parameter view in LWEB-900 version 2.2.0 can contain any data point of
LOYTEC devices or BACnet properties of third party devices.
The workflow to create and edit multiple parameter views from templates was improved:
You can select multiple parameter view templates and drag them to a folder in the
navigation view to instantiate them. It is also possible to select multiple parameter view
instances and edit their properties together.
It is now possible to configure which columns are displayed in the device list.
The device backup schedules have been moved from the master device manager to
the folder "System/Backup Schedules".
Firmware ZIP archives which support multiple firmware files are supported.
Object Properties
Instead of displaying properties of objects (e.g. properties of chart views) in modal dialogs,
they are now displayed in separate views. This allows opening multiple properties views
side-by-side and copying values between them.
The object list view is no longer split into multiple pages. Instead the object list view is an
endless list and objects are loaded only when needed.
Filter
Several views (e.g. alarm view, event view, master device manager view) support custom
filters. It is now possible to save and edit multiple custom filters.
Project management
The upgrade procedure for old LWEB-900 versions has been improved. Because the
upgrade can take a long time for large data bases, detailed progress information has been
added. Before the upgrade is performed, a backup is performed automatically.
Trending
A possibility to add corrections for trend log values has been implemented. This feature is
useful when trending energy consumption and the energy meter needs to be replaced. The
new energy meter will start with a counter value which is different from the last value of the
replaced meter. To correct the value, right click on the first value of the new energy counter
in the trend log view and add a log correction. In the trend log view, you can display both
the raw values of the energy counter and the corrected values. Chart views, graphical views,
and reports use the corrected values.
The custom filter for trend log views has been improved. It is now possible to filter by log
item.
Chart view templates are useful if you need to create multiple chart views with identical
settings but which display different trend logs. They can be created in the folder
“Library/Chart View Templates”. The concept is similar to graphical view templates.
File objects
LWEB-900 allows you to store files on the server and to link them to other objects or to
alarms. File objects can be added below the folder “Library/Files”. Files can be organized in
user defined folders. Refer to Section 6.21 for details.
LWEB-900 can now connect to an Active Directory server which performs the user
authentication. Refer to Section 6.27 for details.
The BACnet standard defines standard objects and their properties. However, many
BACnet vendors extend those standard objects with custom properties. Other vendors
define new object types with a complete new set of properties. When LWEB-900 scans a
BACnet device and its objects, it gathers all available information and creates a new object
type definition if it does not yet exist. All object types can be modified using the Types &
Properties editor. To access the object type definitions, select Properties from the context
menu of the project node in the navigation view, switch to the BACnet tab, and select
Types & Properties.
Favorites
Each user has his own Favorites folder in the navigation view. You can drag and drop any
view into the Favorites folder to speed up access to frequently used views. The Favorites
folder can be organized using sub-folders.
Figure 5: Favorites
The alarm notifier can now be configured to display a pop-up message when an alarm
occurs. Figure 6 shows an example. Refer to Section 6.14.3 for details.
The parameter view can now check if parameter values are different on the device and in
LWEB-900. It highlights these differences and allows resolving the conflicts.
A parameter view can be based on a template. Use parameter view templates to create
multiple parameter views with the same parameter names but different paths. The parameter
view template defines the parameter view columns and specifies a search pattern for each
column. Refer to Section 6.12.3 for more details.
Several improvements have been implemented for the chart view. The chart view does no
longer require a size configuration in pixels. Instead it automatically adjusts to the available
view size. A new option to scale the range of the y-axis automatically depending on the
displayed values is available.
Reporting improvements
It is now possible to configure the colors used in the report for the trend logs.
A new build-in report template has been added. The generic report template
contains one data group. It allows specifying what charts and tables are used to
display data.
New parameters have been added to existing templates to make them even more
flexible. It is now possible to decide which part of the reports should be visible and
which should be hidden. It is also possible to add a company logo to the reports.
The dialog to select a report template has been improved. It now displays a
preview of the report templates.
The device communication profile (see Section 6.24) has a new configuration option to
limit the maximum number of parallel file transfers. Files need to be transferred to/from a
device for firmware upgrades, backup, restore, parameter download/upload, global
connections download/upload, etc. The new WLAN device communication profile has been
added. The number of concurrent file transfers has been set to 1 for this profile to limit the
traffic on wireless networks.
Communication statistics
OPC Server: To provide data updates to clients, the LWEB-900 Server acts as
OPC XML-DA server. This tab displays the statistics for the communication
between LWEB-900 Server and clients.
OPC Client: To get data updates from the devices, the LWEB-900 Server acts as
OPC XML-DA client. This tab displays the statistics for the communication
between LWEB-900 Server and devices.
Connected Clients: This tab displays the clients which are currently connected to
the LWEB-900 Server.
Certificate management
The certification management for secure communication has been improved and has moved
to a separate tab in the LWEB-900 Server UI preferences. LWEB-900 now supports the
SHA-2 hash algorithm.
Licensing
The licensing now also takes the number of connected clients into account. The license
restricts the maximum number of concurrent LWEB-900 Clients and LWEB-802/803
Clients (access for end user via web browser or Windows application). The standard license
includes 5 LWEB-900 Clients and 20 LWEB-802/803 Clients.
Device management
The following new LOYTEC devices are now supported: LDALI-3E102-U, LDALI-3E104-
U, LDALI-ME204-U, LDALI-ME201-U, LDALI-3E101-U, LROC-101, LROC-400,
LROC-401, LROC-402, LIOB-AIR2, LIOB-AIR13, LIOB-586
The master device manager can now import .zip archives containing the firmware for
multiple devices.
BACnet
Monitor and modify the value of all BACnet object types, including all required
and optional properties.
Configure BACnet scheduler and calendar objects using the master schedule
configurator.
The toolbar of the different LWEB-900 views allows printing the current content.
Kiosk mode
The LWEB-900 Client now supports a kiosk mode with the following properties:
Default user
LWEB-900 allows defining a default user which has no password and no auto-logout. If no
username and password is specified in the login-in dialog, the LWEB-900 Client logs in the
default user. If a standard user logs out (auto-logout or manual logout), the default user is
automatically logged in.
Using the LWEB-900 Client command line options it is now possible to start the LWEB-
900 Client automatically (see Section 6.1.3).
Navigation view
The navigation view now displays all objects. For example, data points which were
previously visible only in an object list view are now displayed also in the navigation view.
A single click on an object in the navigation view no longer switches the context of the
active view in the document area. Use the bread crumb navigation bar instead. It is also
possible to drag a folder from the navigation view to the bread crumb navigation bar.
LWEB-900 can now display the values of all data points. Only OPC data points and
BACnet properties are refreshed automatically. Use the refresh button to update the values
of other data points.
Objects in the object list view and watch view can be reordered using drag-and-drop.
Search
The search dialog has been improved. It allows now to search for all object types. In
addition it is possible to combine search parameters using AND, OR, and NOT operators.
Refer to Section 6.9 for details.
Identification key
The identification key can be assigned based on data point names or descriptions (see
Section 6.8). The identification key can be displayed as a column in the event view (see
Section 6.19).
Graphical views
Using a Show page action, it is possible to create buttons in a graphical view which link to
other views. Figure 10 shows how to drag a view and drop it on the action object in the tree
view of the L-VIS Configurator.
Note The Show page action works inside the LWEB-900 Client. When using a web browser to
display a graphical view, only links to other graphical views or chart views are supported.
Alarming
The project settings contain a new Alarming tab which allows configuring that users have
to enter a comment when acknowledging alarms with a priority higher than a certain value.
The subject of alarm notification e-mails is now freely configurable. Two new timing
parameters have been added to the alarm notifier object:
Aggregation time: This parameter defines the time period in which LWEB-900
collects alarm notifications before it sends an e-mail. All alarm notifications
occurring during this time are included in the e-mail. Use this setting to receive
related alarm notifications in a single e-mail.
Min. send time: This parameter defines the minimum time that elapses between
two e-mail notifications. If alarm notifications occur more often, they are
postponed and sent after the minimum send time. Use this setting to limit the e-
mail transmission rate.
Master scheduler
The configuration of the default preset has been changed. The master schedule configurator
now uses the new features of the current LOYTEC device firmware to set a default preset
instead of using a default event with low priority.
Trending
The properties of chart views allow configuring a scale factor for data records. The data
records are multiplied with this factor before displaying them. Example: To convert Wh into
kWh enter, configure the scale factor 0.001.
A server trend log can be temporarily disabled using the Disable Trend Log option in the
context menu. When the trend log is disabled, the LWEB-900 Server does not record the
attached data points. A disabled trend log can be enabled with the Enable Trend Log menu
entry.
To search for specific records in the trend log view, click on the Filter Log Data button in
the toolbar. The filter dialog allows you to combine multiple conditions with AND and OR
operators. The example in Figure 12 finds all data records of the data point
“nvoHCroomTemp” with a value less than 20.
Reporting
The new energy signature report template gives a quick overview of the energy performance
of a building. It shows the correlation between energy consumption and heating degree
days. Heating degree days (HDD) are calculated from the outside temperature and are a
measure of how much the outside air temperature was below a certain base temperature.
The stacked column chart report template has been updated to include a pie chart.
L-Studio support
Localization
The LWEB-900 user interface was localized in French and Chinese. It now supports the
following languages:
English
German
French
Chinese (Traditional)
Most LWEB-900 views have a toolbar and bread crumbs navigation. You can hide those
bars using the context menu of the tab.
Web access
The LWEB-900 web access can now display chart views in addition to graphical views. The
dialog to select the view was improved to shows the tree structure of the LWEB-900
project.
Reporting
LWEB-900 can now create reports based on trend logs. Reports can be used, for example,
to document the energy consumption in a building. Figure 17 shows an example report.
Refer to Section 6.17 for details.
It is now possible to create schedulers which are executed by the LWEB-900 Server. They
should be used to schedule LWEB-900 Server user registers which trigger a report or enable
an alarm receiver. Refer to Section 6.15 for details.
Alarming
It is now possible to specify an enable data point for alarm receivers. By using a
user register which is controlled by a scheduler it is possible to configure different
receivers based on a time table.
A column for the identification key of the data point which triggered the alarm has
been added to the alarm view. The identification key can also be added as a place
holder in an alarm notification template.
It is now possible to simply copy an LWEB-900 graphical view to an L-VIS device. Refer
to Section 6.11.4 for details.
You can now use the percent sign (%) as a wild card character in the search string. It
matches zero or more characters. For example, the search string “nvi%Fb” finds all data
points which have names starting with “nvi” and ending with “Fb”.
The new option Show objects on which the user has no read access has been added to the
user configuration dialog. If this checkbox is enabled, the user sees objects (e.g. folders) to
which he has no read access. They are displayed with a lock icon. If this option is disabled,
those objects are not visible in the navigation and object list view.
It is now possible to export the identification key schema from one LWEB-900 project and
import it in a different LWEB-900 project.
A double-click on a data point displays detailed information about the data point (see Figure
18). The Links section shows where the data point is used. Click on a link to open the
corresponding view.
Improve trend zooming: If cursor is active, zoom relative to current cursor position
else relative to center.
Support limit lines: It is now possible to display limit lines in the trend graph. A
horizontal line with the configured color and value is drawn across the entire
graph.
A new dialog was added to the master device manager which displays all files imported or
uploaded from LOYTEC devices. This dialog allows removing unused files quickly. Refer
to Section 6.22.8 for details.
3 Installation
1. Start the LWEB-900 Server user interface by selecting Windows Start Programs
LOYTEC LWEB-900 LWEB-900 Server.
2. Select Help Register… to open the registration dialog (see Figure 20).
3. Select the required license from the Select feature drop-down list. The following kinds
of licenses are available for the LWEB-900 Sever:
4. If you have already purchased the license, enter your serial number (shipped with the
LWEB-900 product). If you have not yet purchased the license, click on the Not
purchased yet button. No serial number is required for the demo license.
5. Click on Request activation file by e-mail to request the activation file. Alternatively,
write an e-mail to [email protected] with both the Target ID and the Serial Number
in the subject.
6. You will receive a LOYTEC activation file, which you import by clicking on Add
activation file....
The activation files determine the maximum number of LOYTEC devices which can be
added in LWEB-900. Exceptions are the following devices which do not add to the total
count:
L-IP devices
The LWEB-900 Server user interface displays the limit determined by the activation files
and how many devices are currently used for each project (see Figure 21). Only projects
which have the status Running count for the total limit.
Protocol: TCP
Port: Specify the port configured in the LWEB-900 Server preferences (File
Preferences, Network tab). If you have enabled secure connection, configure the
HTTPS port (default 8443) else configure the HTTP port (default 8080).
The exact procedure how to add the rule depends on the firewall you are using. If you are
using the Windows 7 firewall, execute the following procedure:
1. Open Windows Firewall by opening the Windows Control Panel and clicking
Windows Firewall.
2. In the left pane, click Advanced settings. If you are prompted for an administrator
password or confirmation, type the password or provide confirmation.
3. In the Windows Firewall with Advanced Security dialog box, in the left pane, click
Inbound Rules. In the right pane, click New Rule.
The status of the LWEB-900 Server is indicated by a system tray icon (see Figure 22). The
systray icon is not present, if only the LWEB-900 Client is installed on the PC.
The color of the systray icon reflects the status of the LWEB-900 Server (refer to Table 2).
Moving the mouse pointer over the systray icon displays detailed information in a tooltip.
Color Condition
The context menu of the systray icon allows starting the LWEB-900 Server user interface
and the LWEB-900 Client. A double-click on the systray icon opens the LWEB-900 Client.
5 LWEB-900 Server
The LWEB-900 Server runs as a service which is started automatically when the PC boots.
The user interface for the service is shown in Figure 23. It can be started from the Windows
start menu (Start Programs LOYTEC LWEB-900 LWEB-900 Server) or from
the context menu of the LWEB-900 system tray icon.
Project name: The project name has to be specified when connecting with the
LWEB-900 Client.
Startup mode: The startup mode determines if the project is started automatically
when the PC boots:
The LWEB-900 Server can manage multiple independent projects. A new project can be
added by clicking on the Add project… button. Projects can be removed by selecting
Remove project… from the context menu. A double-click on the project starts the
LWEB-900 Client.
Each project can be in the state running or stopped. After a reboot of the PC, the project
state is determined by startup mode. The project state can be changed using the context
menu of the project. To be able to connect with the LWEB-900 Client, the project has to be
running. A running project can be in online or offline mode. In offline mode, the
LWEB-900 Server does not communicate with the LOYTEC devices (see Figure 25).
Note Do not confuse the server login with the client login. The LWEB-900 Server user interface
can be started on the server PC only and is used to manage multiple projects. The
LWEB-900 Client can be started on a remote PC and connects to a specific project. The
user name and password specified in the client login is part of the project.
Enable HTTP: Allow a client to connect to the LWEB-900 server using HTTP.
HTTP port: Server port used for HTTP communication between client and server.
Enable HTTPS: Allow a client to connect to the LWEB-900 server using HTTPS.
In order to enable HTTPS a certificate is required (see Section 5.4)
HTTPS port: Port used for SSL (Secure Sockets Layer) communication.
1. Start the LWEB-900 Server UI and select the Network tab of the File Preferences
menu.
3. Select the Certificate management tab and click on the button Create Self-Signed
Certificate.
4. Switch to the Network tab and activate the Enable HTTPS checkbox.
When you connect with the LWEB-900 Client to the LWEB-900 Server for the first time, a
warning will be displayed because the certificate was not issued by a trusted certification
authority (see Figure 29). If you set the checkbox Do not show this warning again, the
certificate will be accepted without warning in the future.
1. Start the LWEB-900 Server UI and select the Network tab of the File Preferences
menu.
3. Select the Certificate management tab and click on the button Create new
Certificate Request.
Common Name: The name through which LWEB-900 Server will be accessed
(usually the fully-qualified domain name).
Bit Length: In the drop-down box, select a bit length for the RSA encryption
algorithm.
5. Specify the path where the certification request should be set or use the browser button
(…) and press OK.
After you received a response from the public certification authority, perform the following
actions to install the certificate:
1. Start the LWEB-900 Server UI and select the Certificate management tab of the File
Preferences menu.
3. Select the certificate signed by your certification authority and click on Install
Certificate.
5.6 Backup/Restore
5.6.1 Manual Backup
To create a system backup including the LWEB-900 Server configuration and all
LWEB-900 projects, select File System backup.
Backup type: This drop-down field specifies the contents of the backup. A Full
system backup contains all data. A Configuration system backup contains
configuration data, but no historic data other than the event log (no alarm logs and
no trend logs). Therefore the file size of this type of backup will be much smaller.
It is also possible to backup only a specific project. This is useful to e.g. transfer a project
from one LWEB-900 Server to another. To execute a project backup, right click on the
project and select Backup project… from the context menu. Refer to Table 3 for a
description of the different backup types.
Backup type: This drop-down field specifies the contents of the backup (refer to
Table 3).
Interval: Definition of the backup schedule. Note, that the times of the last and the
next scheduled backup are displayed in the project list (see Figure 33).
Projects: This section defines which projects will be included in the backup.
System backups contain all projects and this section is therefore disabled. For
project backups, move one or more projects from the list Available projects to the
list Projects to backup.
5.6.3 Restore
The LWEB-900 Server offers different ways to restore a backup:
Restore Project: To restore a single project without affecting other projects on the
server, right click on the project and select Restore project… from the context
menu. A project can be restored from a system backup or from a project backup.
Import Project: To create a new LWEB-900 project from a backup, click on the
button Import project above the project list. A project can be imported from a
system backup or from a project backup.
Figure 34 shows the dialog to restore the LWEB-900 system. The dialogs to restore or
import a single project are similar.
Restore from file: Select this option to restore a backup created by a different
LWEB-900 Server.
Restore from existing system backup: All system backups performed by the
LWEB-900 Server are displayed in the list. Select one of the available backups.
Delete backup: To free up space on the hard drive, select one of the available
backups and click on the Delete backup button.
System backup content: The projects contained in the selected backup are listed.
Type of system restore: Use the radio button to define which part of the backup
to restore.
SQLite
MySQL
When creating a new project, the database engine is selected. Per default SQLite is selected
as shown in Figure 35. SQLite is a light-weight database implementation which is included
in LWEB-900.
If you want to use a Microsoft SQL or MySQL server (not included in LWEB-900), you
can select the appropriate database type in the New Project dialog and configure the
connection parameters shown in Figure 36.
User: Name of the user that will be created to access the database.
Admin user: Admin user for database server (e.g. “sa” for Microsoft SQL Server
or “root” for MySQL server); necessary to create the database.
Admin Password: Password for admin user; necessary to create the database.
OPC Server: To provide data updates to clients, the LWEB-900 Server acts as
OPC XML-DA server. This tab displays the statistics for the communication
between LWEB-900 Server and clients.
OPC Client: To get data updates from the devices, the LWEB-900 Server acts as
OPC XML-DA client. This tab displays the statistics for the communication
between LWEB-900 Server and devices.
Connected Clients: This tab displays the clients which are currently connected to
the LWEB-900 Server.
6 LWEB-900 Client
The LWEB-900 Client is the primary user interface for the server. It can be started on the
same PC as the server or on a remote PC. Multiple clients can access the server
concurrently.
6.1 Login
When the LWEB-900 Client is started, the login dialog is displayed (see Figure 38).
The Connection drop-down list allows to choose between different LWEB-900 projects.
To open the Manage Project Connections dialog, click on the Edit button (see Figure 39).
Connection name: The name entered in this text field, will appear in the
connection drop-down list of the login dialog.
Project name: Name of the project. To obtain a list of projects, press on the
button “…”. If the server is protected by a password (see Section 5.2), the server
user name and password are requested.
Each LWEB-900 project has its own set of users and access rights (see Sections 6.27 and
6.28). A new project has an administrator user with the following default credentials:
Username: admin
Password: loytec4u
If user name and password is left empty in the login dialog, the LWEB-900 client
logs in the default user.
If the current user logs out (auto-logout or manual logout), the default user is
automatically logged in.
Option Description
A pane displays one or multiple views. If a pane contains multiple views, they are displayed
as tabs. To move the entire pane, grab the caption bar and drag it. To move only a single
view from a pane, grab the tab and drag it.
While dragging a pane, docking indicators are displayed to make it easy to choose the
destination. You can drop the pane over a docking indicator (see Figure 41) or leave it
floating in a separate window above the application window. Floating windows are very
useful if you have a secondary monitor.
Another very useful feature that allows conserving space on your monitor is auto-hiding of
panes. To control this feature there is a pinup button in the upper right corner of each pane.
If you unpin it, the pane will automatically hide when it loses focus.
Most LWEB-900 views have a toolbar and bread crumbs navigation. You can hide those
bars using the context menu of the tab.
Favorites: Each user has his own Favorites folder. You can drag and drop any
view into the Favorites folder to speed up access to frequently used views. The
Favorites folder can be organized using sub-folders.
Home: This folder contains a sub-folder for each user. When adding a new user
(refer to Section 6.27), a corresponding user folder is created automatically.
Library: This folder can contain templates for graphical views (refer to Section
6.11, parameter views (refer to Section 6.12), and reports (refer to Section 6.17).
Those templates can be instantiated multiple times. It also contains file objects
which can be linked to other objects or alarms (refer to Section 6.21).
o Alarming: This folder contains the LWEB-900 alarm server and alarm
log. LWEB-900 monitors all devices and creates an alarm if a device is
not responding (refer to Section 6.14).
o System Registers: This folder contains data points which describe the
status of the LWEB-900 Server. Refer to Section 6.25 for details.
Network: This folder contains items related to the building automation network.
o Devices: This folder contains all LOYTEC devices. Refer to Section 6.5
for details.
To open a new object list view, double click on a folder in the navigation view or select
Open Open in new object list view from the context menu. Use the breadcrumb
navigation bar as shown in Figure 45 to navigate in the object list view. You can also drag
folders from the navigation view and drop them on the bread crumb navigation bar.
Configure Columns
The columns of the object list view can be customized. Per default the Name, Type, and
Description columns are displayed. To add columns or to change the column order, click
on the Configure columns toolbar button.
The column configuration is stored for each folder separately. To change the column
configuration for the current folder only, deactivate the Apply to all ‘Datapoints folder’
objects checkbox and click the Apply button. To save the configuration for all data point
folders, activate the checkbox and press the Apply button.
Column Description
Note If the Value column is displayed, LWEB-900 does not refresh the values automatically.
Click on the Refresh values toolbar button to update the object list view. If you want to see
periodic updates, drag the data point into a watch view.
Sorting
If no sort order is defined, object in the object list view can be reordered using drag and
drop.
You can sort the list of objects by clicking one of the column headings - Name or Type, for
example. The first click sorts the objects in ascending order, the second click in descending
order, and the third click removes the sort order.
To sort by a second column, hold down the [Shift] key and click the column heading that
represents the secondary sort group.
Search
To find objects, type the name or part of the name in the search box (see Figure 47). The
search includes the folder and all its subfolders. To access additional search options, click
on the Advanced search button. Refer to Section 6.9 for details.
Objects can be related to each other. In the example shown in Figure 48, the selected data
point is linked with the following views:
Graphical view: The data point is member of the data point interface of the
graphical view.
Trend Chart View: The data point is recorded by a trend log displayed in the chart
view.
Click on the link in the context menu to open the related view.
A double-click on a data point displays detailed information about the data point (see Figure
49). The Links section shows where the data point is used. Click on a link to open the
corresponding view.
Use the print button in the toolbar to print the object list view. The print dialog allows
adjusting the page margins and the font size.
Monitor and modify the value of all BACnet object types, including all required
and optional properties.
Configure BACnet scheduler and calendar objects using the master schedule
configurator.
1. Select Properties from the context menu of the project node in the navigation view and
switch to the BACnet tab.
3. Select the Network Adaptor which the BACnet stack will use.
4. Configure the BACnet/IP address and BACnet/IP port. If the BACnet/IP network
uses a non-default UDP port number other than 47808/0xBAC0, enter this port in the
BACnet/IP port field. Press the Default button for switching back to the default setting.
5. The BACnet Instance Number corresponds to the instance number of the BACnet
device object for the LWEB-900 project. It must be a unique ID on the BACnet
internetwork.
APDU timeout: Time the LWEB-900 Server waits for an answer before
retrying or giving up on a request.
APDU retries: The number of times the LWEB-900 Server will try to re-send
a packet before giving up on a request.
7. Configure the default value for write priority. LWEB-900 allows writing
commandable properties using one of the following methods (see Figure 52):
Use default priority: Directly set the value of the commandable property.
The LWEB-900 Server can register with an existing BBMD in the BACnet/IP network as a
foreign device. This functionality is used if the LWEB-900 Server is located as a single
BACnet/IP device on a remote IP subnet or behind a NAT router. If operated as a foreign
device behind a NAT router, port forwarding to the BACnet/IP port must be setup in the
NAT router.
Time syn. interval: This value specifies the time interval in which periodic
time synchronization events are created. If set to zero, no periodic time
synchronization events are generated.
Align time sync. interval to the top of the hour: The checkbox determines
whether or not periodic time synchronization events shall be anchored at the
start of a day or hour.
Offset by: This value determines the point of time within this time
synchronization interval at which the time synchronization event is actually
triggered. The default value of this property is 0.
3. Add BACnet devices which should receive UTC time to the UTC time sync.
recipients list and devices which should receive local time to the Time sync.
recipients list. LWEB-900 allows to add the following types of recipients:
Local broadcast
Foreign broadcast
Global broadcast
The BACnet standard defines standard objects and their properties. However, many
BACnet vendors extend those standard objects with custom properties. Other vendors
define new object types with a complete new set of properties. When LWEB-900 scans a
BACnet device and its objects, it gathers all available information and creates a new object
type definition if it does not yet exist. All object types can be modified using the Types &
Properties editor.
TCP/IP: This communication mode should be used for devices with old firmware
versions which do not yet support web services for device management. It requires
that LWEB-900 can access the device using web services for real time data and
FTP/Telnet (or SCP/ SSH) to manage the device.
E-Mail: Most LOYTEC devices can send an e-mail with a trend or alarm log in
CSV format in the attachment when a configurable fill level is reached. The
LWEB-900 Server can fetch these e-mails from a mail box and process the
contained data. This communication mode is a good option, if the device is behind
a firewall and cannot be accessed directly. Only history data (trend and alarm logs)
can be received from the device.
LWEB-900 allows adding devices from other manufacturers if they support BACnet
communication.
1. Select the folder Network/Devices or a subfolder and choose New New device
from the context menu.
2. In the New Device dialog (see Figure 54) enter the following data:
Family: Select the LOYTEC device family from the drop-down list.
Type: Select the LOYTEC device type from the drop-down list.
BACnet: This checkbox is available only if the LOYTEC device supports BACnet
communication. If this option is enabled, LWEB-900 will display the native
BACnet objects of the device.
Operator password: Enter the operator password which has been configured via
the Web UI of the device. The default password is “operator”.
Admin password: Enter the admin password which has been configured via the
Web UI of the device. The default password is “loytec4u”.
3. Press the button Test connection to verify that LWEB-900 can communicate with the
device correctly.
Start the configurator: Open the device configuration view. Refer to Section 6.7
for details.
Cancel: Perform none of the above actions. You can execute any of the actions
later from the context menu of the device.
5. The new device is displayed in the navigation view. If you have uploaded the device
configuration or assigned a configuration, you now have access to all data points of the
device (see Figure 55).
If a device does not support the Web Service communication mode, use TCP/IP instead.
The following additional parameters need to be configured:
FTP port and Telnet port: Those ports are fixed and cannot be changed.
1. Before mails can be received, the incoming mail server has to be configured. Select
Properties from the context menu of the project node in the navigation view and select
the Incoming mails tab.
Check incoming mail period: The LWEB-900 Server checks the mail box
periodically for new mail. This value defines how often the mail box will be
checked.
Keep mails on server after reading: The LWEB-900 Server can either remove
the processed e-mails from the server or leave them on the server.
Store attached files locally: If this option is selected, the attached CSV log files
from the processed e-mails will be stored on the hard disk in the directory <project
directory>\MailInputBox\AttachedFiles.
2. Select the folder Network/Devices or a subfolder and choose New New device
from the context menu.
3. In the New Device dialog (see Figure 57) enter the following data:
Family: Select the LOYTEC device family from the drop-down list.
Type: Select the LOYTEC device type from the drop-down list.
Serial number: Serial number of the LOYTEC device. The serial number is part
of the CSV log files which are transmitted by LOYTEC devices.
4. The new device is displayed in the navigation view. After the first data has been
received via e-mail, the trend logs and alarm logs will be displayed in the
corresponding folders (see Figure 58).
rd
Add 3 party BACnet devices using network scan
LWEB-900 Server supports an online network scan on the BACnet network. In this scan the
LWEB-900 server searches for other devices on the BACnet network and pulls in the
BACnet object information of these devices.
1. Select the folder Network/Devices or a subfolder and choose Scan BACnet Network
from the context menu. This opens the BACnet network scan dialog as shown in Figure
59.
2. Click on the Scan Network button to start a network scan. The results are put in the
device list below.
3. Select one or multiple devices in the device list and click the Add Selected Devices…
button.
4. The new devices are displayed in the navigation view. You have access to all BACnet
objects and their properties (see Figure 60).
rd
Add a 3 party BACnet device offline
1. Select the folder Network/Devices or a subfolder and choose New New device
from the context menu.
2. In the New Device dialog (see Figure 61) enter the following data:
Type: BACnet/IP.
BACnet address: The BACnet address consists of BACnet network number and
BACnet MAC address. For a BACnet/IP device the BACnet MAC address is
defined by its IP address and UDP port.
3. Press the button Test connection to verify that LWEB-900 can communicate with the
device correctly.
Upload device configuration: Choose this option if the BACnet device is online.
LWEB-900 will upload the BACnet object information of the device.
Import device configuration: Choose this option if the device is offline. You can
either import an EDE file and the corresponding state text file or assign the
configuration of a different device (see Figure 62). The latter option is useful if
you have multiple devices with identical configuration.
Cancel: Perform none of the above actions. You can execute any of the actions
later from the context menu of the device.
5. The new device is displayed in the navigation view. If you have uploaded the device
configuration or imported a configuration, you now have access to all BACnet objects
of the device (see Figure 60).
Organize devices
LOYTEC devices can be configured very comfortably because the required software can be
started directly in LWEB-900. The L-VIS, L-INX, and L-DALI Configurators are separate
software packages which can be downloaded from the LOYTEC homepage. When the
LWEB-900 Client is started, it checks which Configurators are installed on your PC and
displays any missing components (see Figure 63).
The configuration software of the different LOYTEC devices is outside the scope of this
document. It is described in the corresponding product manuals instead (see Table 6).
Figure 65 shows the part of the device configuration toolbar which is independent of the
product type.
upload the entire configuration from the device, including data points, NVs,
registers, client mappings, schedules, etc.
L-VIS L-VIS devices are configured with the L-VIS Configurator. Refer
to the L-VIS User Manual [1] for details.
L-INX, L-GATE L-INX and L-GATE devices are configured with the L-INX
Configurator. Refer to the L-INX/L-GATE User Manual [2] for
details.
L-IOB L-IOB devices are configured with the L-INX Configurator. Refer
to the L-IOB User Manual [3] for details.
L-DALI LDALI-3E10x devices are configured with the L-DALI
Configurator. LDALI-ME20x devices are configured using the
web interface and do not need a separate configuration software.
Refer to the L-DALI User Manual [5] for details.
Table 6: Device Configuration Software
Note: If you are using a network management tool based on LNS, do NOT configure the devices
in LWEB-900, but start the device configuration software from the network management
tool in plug-in mode.
Note: The device configuration software accesses the device directly and does not go through the
LWEB-900 Server.
The web UI of a LOYTEC device can be accessed easily by selecting Open device web UI
from the context menu. There is no need to remember the password of each device.
Depending on your access rights (see Sections 6.17.4 and 6.28) to the device, you will be
automatically logged in as admin user or as operator user.
1. Select Properties from the context menu of the project node in the navigation view and
select the Identification key tab (see Figure 67).
2. An identification key consists of a number of fields which have fixed length. To add a
new field, click on the Add field button.
4. Each field can have a number of predefined values. Define the values and optionally
add a description.
1. In the object list view, click on the toolbar button Configure columns and add the
Identification Key (IK) column.
2. Click on the identification key which you want to change. The identification key is split
into its fields as shown in Figure 68. For each field you can select one of the predefined
values or enter a new value.
1. In the object list view, click on the toolbar button Configure columns and add the
identification key fields which you want to change.
3. Click on the identification key field of the first data point and change it (see Figure 69).
The identification key of all selected data points is changed.
The name or description of a data point can be used as part of the identification key.
1. In the navigation, click with the right mouse button on a device or a device folder and
select Identification Keys Assign Identification Keys… from the context menu.
2. The Assign Identification Keys dialog allows the definition of a Constant Part which
is assigned to the identification keys of all data points in the folder and a Dynamic
Part which is derived either from the data point name or description. In the example
shown in Figure 70, the first two fields of the identification key will be set to the
constant value “VIE BG35” for all data points in the folder. The rest of the
identification key, starting with the field “Level” and ending with the field “Data Point
Idx”, will be set to the name of the data points.
If you need to change the length of an identification key field or add a new field, all existing
identification keys will be affected. LWEB-900 can give you a preview of the effect of the
change.
1. Select Properties from the context menu of the project node in the navigation view and
select the Identification key tab
3. Click on the button Select datapoint for preview to see the effects of your change.
4. If you do not set the checkbox Change existing identification keys, the existing
identification key strings will be left unchanged. In the example shown in Figure 71, the
length of the field “Location” has been increased from three to four characters. Because
the field boundaries change, the values of all fields change. If you activate the
checkbox, the configuration key strings will be modified as shown in Figure 72. Note,
that the configured Fill character is used to bring the length of the field “Location”
from 3 characters up to 4 characters.
1. Right click on a data point folder in the navigation view and select Identification Keys
Export Identification keys to CSV file from the context menu.
1. Right click on a data point folder in the navigation view and select Identification Keys
Import Identification keys from CSV file from the context menu.
1. Select Properties from the context menu of the project node in the navigation view and
select the Identification key tab.
1. Select Properties from the context menu of the project node in the navigation view and
select the Identification key tab.
To access additional search options in the object list view, click on the Advanced search
button. The following search parameters can be configured:
Search options: Select whether you want to search in the identification key, name,
description, or path.
Search string: An object satisfies the search condition if its identification key,
name, description, or path contains the specified search string.
Note: To search for a specific field of a structured data point or BACnet property, use the “.”
separator in the data point name (e.g. nviSBstateFb.pos).
You can use the asterisk (*) and question mark (?) as a wild card characters in the search
string. The asterisk matches zero or more characters, the question mark matches any single
character. For example, the search string “nvi*Fb” finds all data points which have names
starting with “nvi” and ending with “Fb”.
Object type: This drop-down box allows limiting the search to certain object
types.
The Advanced tab allows you to combine multiple conditions with AND and OR
operators.
If you regularly search for a certain type of objects, it might be useful to save your search. If
you click on the Save Search View button, a new search view with the current search
parameters is created in your home directory. The next time you want to execute the search,
just double click it, and you will see the current objects that match the original search. To
modify the search parameters, click on the Properties button in the search view toolbar.
To create a search view in another folder than your home directory, right click on the folder
and select New New search view from the context menu.
1. Right click on a folder in the navigation view and select New New Watch View
from the context menu. A watch view can be created in root folder (the project node),
in the home folder of the user, or in any user defined folder.
2. Enter a name and a description for the watch view and click on OK.
3. The new watch view is created and displayed in the navigation view. Double click the
watch view to open it. A new watch view does not contain any data points.
1. Select the data points you want to monitor in the object list view and drag them to the
watch view as shown in Figure 78.
2. Save your changes to the watch view by clicking on the Save button in the toolbar.
Note: OPC data points and BACnet properties are refreshed automatically in the watch view.
They are marked with a small “O” in the top right corner of the data point symbol. To
expose a data point via OPC, the corresponding checkbox has to be activated in the
LOYTEC device configuration software. Other data points of LOYTEC devices can also be
added to the watch view. Their values are refreshed when clicking the refresh button in the
toolbar.
1. Click on the value of a data point. Depending on the data point type, a drop down list, a
number input, or a text input box is displayed (see Figure 79).
Column Configuration
The columns of the watch view can be customized. Per default the Polled, Name, and
Value columns are displayed. To add columns or to change the column order, click on the
Configure columns toolbar button.
The column configuration is stored for each watch view separately. To change the column
configuration for the current watch view only, deactivate the Apply to all ‘Watch view’
objects checkbox and click the Apply button. To save the configuration for all watch views,
activate the checkbox and press the Apply button.
Column Description
Polled If this checkbox is set, the data point value is updated periodically.
Name Name of data point
Value Current value of the data point
Timestamp Timestamp of last value change
Type Data point type
Description Data point description
Referenced Referenced data point including the path
Identification Key (IK) Refer to Section 6.8
IK.<field name> The identification key consists of user defined fields. Each field
can be displayed as a separate column.
Table 7: Watch View Columns
Sorting
If no sort order is defined, data points in the watch view can be reordered using drag and
drop.
You can sort the watch view by clicking one of the column headings. The first click sorts
the data points in ascending order, the second click in descending order, and the third click
removes the sort order.
Use the print button in the toolbar to print the watch view. The print dialog allows adjusting
the page margins and the font size.
When you move the mouse pointer over an element of the schematics which allows user
interaction, the form of the pointer changes from arrow to hand. Depending on the nature of
the element, clicking the element with your left mouse button will trigger an action (e.g.
switch to another page, hide or show parts of the schematic) or allow to change the value of
an underlying data point.
You can easily access information about data points visualized in the graphical view. Click
with your right mouse button on the value of a data point to open a context menu. Select the
name of the data point for which you want to inspect the properties as shown in Figure 83
and Figure 84.
Error handling
If LWEB-900 cannot read the value of a data point from a LOYTEC device, the
corresponding visualization element is grayed out. The OPC error message will be
displayed when hovering over the control as shown in Figure 85.
Navigation menu
The navigation menu can be opened by a click with the right mouse button on an empty area
in the schematics. If the right-click is executed over a control, a context menu is displayed
which allow to either open the navigation menu or to inspect the data point properties.
Zoom levels
The zoom level can be configured in the tool bar of the graphical view. If the zoom level is
set to Auto-scale, the schematics will be scaled to fit completely into the pane.
Use the print button in the toolbar to print the graphical view. The print dialog allows
adjusting the page margins and the scale factor.
1. Right click on a folder in the navigation view and select New New Graphical View
from the context menu. A graphical view can be created in the root folder (the project
node), in the home folder of a user, or in any user defined folder.
2. Enter a name and description for the graphical view and click on OK.
3. The new graphical view is created and displayed in the navigation view. Note, that a
data point interface folder is created below the graphical view.
The data point interface folder contains all data points which can be used in the graphical
view. After creating a new project, the data point interface is empty. You can add data point
in one of the following ways:
Pull data points from an object list view into the interface. A link to the original
data point is created.
Drag a complete folder into the interface. In this case, a link to the folder is
created. If the contents of the original folder change (e.g. data point configuration
of a device is modified), the interface changes accordingly.
Press the [CTRL] key while dragging a folder into the interface. The folder
including all its sub-folders is created in the interface and populated with data
point links.
You can create folders to organize data point and folder links by selecting New New
Folder from the context menu.
Note Only OPC data points can be added to the interface of a graphical view. They are marked
with a small “O” in the top right corner of the data point symbol. To expose a data point
via OPC, the corresponding checkbox has to be activated in the device configuration
software.
Design graphics
To design the graphics, click with the right mouse button on the graphical view icon and
select Configure Graphical View from the context menu. The graphical design tool is
outside the scope of this document. It is described in the L-VIS User Manual [1].
Note If you dock an object list view showing the data point interface to the graphical design tool,
you can quickly attach data points to controls using drag-and-drop (see Figure 88).
Broken Links
A data point link breaks if the referenced data point is removed (e.g. data point
configuration of the device is modified). If a graphical view contains a broken link, it is
marked with an asterisk in the navigation view to warn you. In the object list view, broken
links are marked with a special icon (see Figure 89). They can be easily fixed by dragging a
new data point on the broken link.
Using a Show page action, it is possible to create buttons in a graphical view which link to
other views. Figure 90 shows how to drag a view and drop it on the action object in the tree
view of the L-VIS Configurator.
Note The Show page action works inside the LWEB-900 Client. When using a web browser to
display a graphical view, only links to other graphical views or chart views are supported.
1. Right click on a folder in the navigation view and select New New Graphical View
from the context menu.
2. Activate the checkbox Initialize from file and select the LWEB-800/802 project file.
3. The graphical view is created and displayed in the navigation view. The data point
interface contains a link to the device in the imported project (see Figure 92). If a
matching device with the same IP address exists in the LWEB-900 project, the link is
resolved automatically, else a broken link is displayed. To fix the broken link, simply
drag a device from the Devices folder and drop it on the broken link.
1. Right click the folder Library in the navigation view and select New New
Graphical View Template from the context menu.
2. Enter a name and description for the graphical view template and click on OK.
3. Create the data point interface and the graphics in the same way as for a normal
graphical view (see Section 6.11.2).
Instantiate Template
1. Right click on a folder in the navigation view and select New New Graphical View
from the context menu.
3. Select the option Initialize from template and press the browser button to choose the
template. Click on OK.
4. Replace folder/data point links: Drag a folder/data point from a device in the Network
folder onto the folder/data point link in the data point interface for the template
instance.
Note Wherever possible, use folder links instead of data point links. A folder which contains
multiple data points can be relinked much faster than multiple separate data point links.
Graphical view in LWEB-900 Server: Graphical views of this type can be located
in any user folder in the navigation view. In order to display real-time data, the
graphical view communicates with the LWEB-900 Server using OPC XML-DA.
The LWEB-900 Server in turn communicates with LOYTEC devices using OPC
XML-DA. This approach has the advantage that it relieves the communication load
of the LOYTEC devices. For the LOYTEC devices it makes no difference whether
a graphical view is displayed only on one PC or on multiple PCs. The server
fetches the data only once from the LOYTEC devices and distributes it to multiple
graphical views (see Figure 94).
Graphical view in LOYTEC device: These views are located in the Graphical
Views folder below a LOYTEC device (see Figure 93). In order to display real-
time data, the graphical view communicates directly with the LOYTEC devices
using OPC XML-DA. This approach has the advantage that it offers faster
response times. However, value changes cannot be logged by the server, because
the communication bypasses the LWEB-900 Server.
1. Right click on the LWEB-900 Server graphical view in the navigation view and select
Copy from the context menu.
2. Select the Graphical Views subfolder of the device to which you want to move the
graphical view and select Paste from the context menu.
3. If the new graphical view is working properly, remove the original LWEB-900 Server
graphical view.
1. Right click on the device graphical view in the Graphical Views folder of the device
view and select Copy from the context menu.
2. Select the user folder to which you want to move the graphical view and select Paste
from the context menu.
3. If the new graphical view is working properly, remove the original device graphical
view.
1. Right click on the LWEB-900 Server graphical view in the navigation view and select
Copy from the context menu.
2. Use the right mouse button to click on the target L-VIS device in the navigation view
and select Paste from the context menu.
3. The L-VIS Configurator is opened and automatically converts the graphical view to an
L-VIS project.
Edit parameters
Edit single parameters: Click on the corresponding value field and enter a new
value.
Edit multiple parameters: Select multiple parameters and select Edit from the
context menu (see Figure 97) and enter a new value.
2. Parameters which have been modified in the parameter view but have not yet been
saved yet are highlighted in green.
3. Press the Download Parameters button in the toolbar. A dialog showing the progress
is displayed.
Upload Parameters
To upload the currently configured parameters from the device(s) and save them in the
database, click on the Upload Parameters button in the toolbar.
1. Press the Upload Parameter and Merge… button in the toolbar. All parameters which
are different on the device and in the parameter view are highlighted in orange. Hover
the mouse over the value to see the different values.
2. Using the toolbar buttons you can choose between displaying the device values or the
view values.
3. To resolve the conflict for a single parameter, right click on the value and choose
between Resolve conflicts of selected parameters with view values and Resolve
conflicts of selected parameters with device values.
4. To resolve the conflict for all parameters in the same way, use the toolbar buttons
Resolve all conflicts with view values and Resolve all conflicts with device values.
5. Press the Download Parameters button in the toolbar. A dialog showing the progress
is displayed.
Use the print button in the toolbar to print the parameter view. The print dialog allows
adjusting the page margins and the font size.
Button Description
1. Right click on a folder in the navigation view and select New New Parameter View
from the context menu. A parameter view can be created in the root folder (the project
node), in the home folder of a user, or in any user defined folder.
2. Enter a name and description for the parameter view and click on OK.
Add parameters
Parameters can be added to the view by pulling them from an object list view to the
parameter list. You can also perform a search operation and then select the results and drop
them on the parameter list. The advanced search dialog, offers the possibility to filter for
objects of type Parameter (see Figure 100 and Figure 101).
Note Only parameters can be added to a parameter view. They are marked with a small gear
wheel in the top left corner of the data point symbol. To expose a data point as parameter,
the corresponding checkbox has to be activated in the device configuration software.
When adding a new parameter, it is automatically assigned to a default row and column:
The parameter name determines the column and the path determines the row. To change the
default row, select one or multiple parameter and choose Change row of selected
parameters from the context menu. The default column can be changed by selecting the
option Change column of selected parameters.
The upper part of the parameter view displays a preview of the parameter matrix. To change
the column order, grab a column header and drag it to the desired new position. Rows can
be reordered in the same way.
3. Add a new column by pressing on the plus icon for columns. Configure the following
properties:
Property Description
4. Add parameters to the column by pressing on the plus icon for parameters. Configure
the following properties:
Property Description
Search pattern The search pattern specifies the path and name of the parameter(s)
which are displayed in the column. Up to 9 wild card characters (*
and ?) can be used to define the search pattern.
Row name This property defines in which row(s) the parameter(s) defined by
the search pattern should be displayed. The following placeholders
can be used:
\1, \2, … \9: replaced by content matched by first, second, … ninth
wildcard character
\d: replaced by name of the device
Table 10: Parameter Properties in Parameter View Template
Note Instead of configuring the properties from scratch it is often easier to use the search icon
and select a single parameter. The search pattern and row name can then be modified to
include wildcard characters.
5. Define the default search order of the rows in the parameter view. This step is optional.
1. Right click on a folder in the navigation view and select New New Parameter View
from the context menu.
3. Select the option Initialize from template and press the browser button to choose the
template.
4. Select one or multiple base objects. The base object is the starting point for searching
parameters which match the search patterns of the template. Examples for base objects
are the whole Network/Device folder, a specific device, or a data point folder.
1. Right click on a folder in the navigation view and select New New Web View from
the context menu. A web view can be created in the root folder (the project node), in
the home folder of a user, or in any user defined folder.
2. Enter a name, description, and an URL for the web view and click on OK.
3. The new web view is created and displayed in the navigation view.
6.14 Alarming
In the bottom right corner of the LWEB-900 client window, the status bar displays an icon
reflecting the current alarm state. To see the alarm details, double click on the icon and the
alarm view is opened.
Icon Description
Alarm path
LWEB-900 receives alarms from a number of different sources which are called alarm
servers. Each LOYTEC device can have one or multiple alarm servers. System alarms
originate from the LWEB-900 alarm server in the folder System/Alarming (see Section
6.14.2). The alarm view displays only alarms from alarm servers which are inside the path
set in the breadcrumb navigation bar. To see all alarms, select the top folder. To see alarms
of a single device only, select the corresponding device folder. To see system alarms only,
select the System folder.
Alarm filter
The alarm filter lets you drill down to the specific alarms you want to see. The alarm view
offers a number of predefined filters described in Table 12 or you can use the powerful
custom filter.
Column Description
All Enabled Alarms Display alarms which are not disabled and have one of the
following states:
Active, not acknowledged
Active, acknowledged
Inactive, not acknowledged
Not Acknowledged Alarms Display alarms which are not disabled and have one of the
following states:
Active, not acknowledged
Inactive, not acknowledged
Active Alarms Display alarms which are not disabled and have one of the
following states:
Active, not acknowledged
Active, acknowledged
Disabled Alarms Display all disabled alarms.
Table 12: Predefined Alarm Filters
Figure 106 shows an example of a custom filter definition. As you can see, the custom filter
allows to combine multiple conditions with AND and OR operators.
Acknowledge alarms
To acknowledge alarms, select one or multiple alarms and choose Acknowledge selected
alarms from the context menu. Or alternative, you can use the corresponding toolbar
button.
In the project settings, you can configure that users have to enter a comment when
acknowledging alarms with a priority higher than a certain value (see Figure 107).
Disable alarms
To disable alarms, select one or multiple alarms and select Disable selected alarms from
the context menu. When you disable an alarm, you can enter a comment explaining the
reason why you disabled the alarm. The disabled alarms disappear from the current alarm
view. To see the disabled alarms, select Disabled Alarms from the alarm filter drop-down
box. Disabled alarms can be enabled again, by selecting Enable selected alarms from the
context menu.
If the same alarm is triggered multiple times, only the last alarm entry is displayed. This
alarm entry can be expanded to see the previous occurrences of the alarm (see Figure 108).
Column Configuration
The columns of the alarm view can be customized. To add columns or to change the column
order, click on the Configure columns toolbar button.
The column configuration is stored for each alarm view separately. To change the column
configuration for the current alarm view only, deactivate the Apply to all ‘Alarm view’
objects checkbox and click the Apply button. To save the configuration for all alarm views,
activate the checkbox and press the Apply button.
Column Description
Id Unique alarm ID
Alarm Time Date and time when the alarm occurred.
Clear Time Date and time when the alarm condition was cleared. If the alarm
is still active, this field is empty.
Ack. Time Data and time when the alarm was acknowledged. If the alarm has
not yet been acknowledged, this field is empty.
Ack. Source Name of the user who acknowledged the alarm. If the alarm has
not yet been acknowledged, this field is empty.
State An alarm undergoes a number of state changes during its life-
cycle. When the alarm occurs, it is Active, not acknowledged.
The alarm can be acknowledged by a user. Then it becomes
Active, acknowledged. Alarms can also become inactive, but an
acknowledgement is still required. Then they become Inactive,
not acknowledged. When an alarm is inactive and was
acknowledged it disappears from the alarm view.
Type An alarm can be of different alarm types. The alarm type specifies
the class of the alarm. The following alarm types exist:
Off-Normal: This alarm type is a generic alarm class. It
indicates that the alarmed data point is on an off-normal
operating condition that triggered the alarm. An alarm value
is supplied, if the technology supports it.
High/Low Limit: This alarm type is typical for analog alarm
conditions. It applies when the alarmed value is over or under
the defined alarm limits. An alarm value is supplied, if the
technology supports it.
Fault: This alarm type is indicating that the monitored data
point or device is in a fault state.
Value Value of the data point at the time the alarm occurred.
Description Description of the alarm condition. The description is configured
in the device configuration software.
Priority Priority of the alarm.
Source Device: The alarm was generated by a LOYTEC device.
Server: The alarm was generated by the LWEB-900 Server.
Device Name of the device which was the source of the alarm.
Alarm Server Name of the alarm server which was the source of the alarm
Alarm Server Path Path to alarm server.
Source Name Name of the data point which was the source of the alarm.
Identification Key (IK) Identification key of the data point which was the source of the
alarm. Section 6.8 describes how to assign identification keys to
data points.
Disable Source Name of the user who disabled the alarm. If the alarm is not
disabled, this field is empty.
Comment This text is entered by the user when he disables an alarm and
specifies the reason. If the alarm is not disabled, this field is
empty.
XAID On a LOYTEC device, each alarm is uniquely identified by the
XAID. The XAID is used in the acknowledgement to identify the
alarm.
Table 13: Alarm View Columns
If you regularly need to filter for certain alarms, it might be useful to save your alarm view.
A new alarm view with the current path and filter settings is created in your home directory.
The next time you want access the alarm view, just double click it, and you will see the most
current alarms matching your path and filter.
Use the print button in the toolbar to print the alarm view. You can print all alarms or only
alarms which occurred during a configurable time interval. The print dialog allows adjusting
the page margins and the font size.
1. Right click on the LWEB-900 Alarm Server and select Properties from the context
menu.
2. Select the priority for system alarms. The highest priority is 0, the lowest priority is
255.
The alarm notifier determines which alarms are notified to which alarm receivers. It also
defines the format of the notification.
1. Right click on a folder in the navigation view and select New New Alarm Notifier
from the context menu. An alarm notifier can be created in the root folder (the project
node), in the home folder of a user, or in any user defined folder.
Notify alarm state changes: If this checkbox is active, the alarm receivers will be
notified when the state of an alarm changes (e.g. alarm condition cleared, alarm
acknowledged).
Aggregation time: This parameter defines the time period in which LWEB-900
collects alarm notifications before it sends an e-mail. All alarm notifications
occurring during this time are included in the e-mail. Use this setting to receive
related alarm notifications in a single e-mail.
Min. send time: This parameter defines the minimum time that elapses between
two e-mail notifications. If alarm notifications occur more often, they are
postponed and sent after the minimum send time. Use this setting to limit the e-
mail transmission rate.
4. Define one or more notification templates. In case of an e-mail receiver, the template is
used for the subject and message body. If the alarm is logged to a text file, the template
specifies the format of the log entry. You can easily add any column of the alarm view
(see Table 13) to the template body using the context menu.
5. Switch to the Alarm Servers tab and specify a folder as the Base object. The base
object serves the same function as the path in the alarm view: the alarm notifier applies
only to alarms from alarm servers which are inside the base folder.
6. Enable custom filter: If you enable this checkbox, only alarms will be notified which
pass through the configured filter. This filter has the same functionality as the custom
filter for the alarm view.
7. Switch to the Alarm Receivers tab to define who should be notified of the alarm. The
primary alarm receivers are notified as soon as the alarm occurs. Secondary alarm
receivers are notified only if the alarm is not acknowledged in time. To add an alarm
receiver, click on the corresponding plus icon.
8. Enter a name for the alarm receiver and select the type. LWEB-900 supports the
following alarm receiver types:
E-Mail Alarm Receiver: This alarm receiver sends an e-mail notification to one
or multiple e-mail addresses.
File Alarm Receiver: This alarm receiver logs alarms in a text file.
9. Configure the properties of the alarm receiver as described in the following tables.
Property Description
Alarm Template This template is used for the e-mail body when an alarm occurs.
Alarm State Changes This template is used for the e-mail body when the alarm changes
Template its state. You have to assign this template only if you have selected
the option Notify alarm state changes.
Enable Per default this parameter is set to Always. When you click on this
parameter, you can select an enable data point and specify the
enable condition. Use an LWEB-900 Server scheduler to control
the enable data point (see Section 6.15)
E-Mail addresses Select the e-mail addresses which should be notified about the
alarm. The list of available e-mail addresses contains all users for
which an e-mail address has been specified (see Section 6.27). If
you want to send alarm notification to an e-mail address which
does not belong to an LWEB-900 user, you can add this e-mail
address in the project properties: Select Properties from the
context menu of the project node in the navigation view and
switch to the Outgoing mails tab.
Table 14: E-Mail Alarm Receiver Properties
Property Description
Alarm Template This template defines the format of a log entry in the text file when
an alarm occurs.
Alarm State Changes This template defines the format of a log entry in the text file when
Template the alarm changes its state. You have to assign this template only if
you have selected the option Notify alarm state changes.
Enable Per default this parameter is set to Always. When you click on this
parameter, you can select an enable data point and specify the
enable condition. Use an LWEB-900 Server scheduler to control
the enable data point (see Section 6.15)
File name Specify the name of the log file. The file is stored on the server in
the directory <project directory>\AlarmReceiverFiles\
Table 15: File Alarm Receiver Properties
Property Description
Alarm Template This template is used to display alarm information in the popup
message when an alarm occurs.
Alarm State Changes This template is used to display alarm information in the popup
Template message when the alarm changes its state. You have to assign this
template only if you have selected the option Notify alarm state
changes.
Enable Per default this parameter is set to Always. When you click on this
parameter, you can select an enable data point and specify the
enable condition. Use an LWEB-900 Server scheduler to control
the enable data point (see Section 6.15)
Users & Groups Select the users and groups which should be notified.
Popup Message Enter a text which will be displayed as part of the popup window.
Sound Select a sound which is played for notification. This property is
optional.
View The popup message can contain links to views (e.g. graphical
view, alarm view). This property is optional
Table 16: Client Notification Alarm Receiver Properties
LOYTEC devices can have their independent alarm logs. Those device alarm logs are part
of the device configuration and displayed in the Alarm logs sub folder of the device.
An alarm log can be viewed by double clicking on the alarm log icon in the navigation or
object list view.
The contents of the alarm log can be exported as a comma separated value list (CSV
export). The alarm log window can be refreshed by hitting the [F5] function key or pressing
the Refresh value toolbar button. If the log contains a large number of entries, the log is
split into multiple pages and the buttons at the bottom can be used to navigate through the
pages. Alternatively, the Go to date button can be used to jump to a specific date and time.
Note Alarms are a special kind of events. Therefore, you can also use the event view (see Section
6.17.4) to investigate alarm transitions. The event view is often more convenient, because
its filters let you drill down to the specific alarm transitions you want to see.
To search for specific records in the alarm log, click on the Filter Log Data button in the
toolbar. The filter dialog allows you to combine multiple conditions with AND and OR
operators. The example in Figure 146 finds all alarm log records with priority higher than
128 and the state “Active, not acknowledged”.
Use the print button in the toolbar to print the alarm log. You can print all alarm log records
or only alarm events which occurred during a configurable time interval. The print dialog
allows adjusting the page margins and the font size.
6.15 Scheduling
Schedulers are objects that schedule values of data points on a timely basis. LWEB-900
distinguishes between two kinds of schedulers:
Both scheduler types can be configured using the master schedule configuration view in
LWEB-900.
type Binary. Those user registers are located in the folder System/User Registers. If
necessary, additional user registers and schedulers can be created.
1. Right click on the folder System/User Registers and select New New Register…
from the context menu. This opens the register creation dialog as shown in Figure 117.
3. Select the Type of the register. The following types are available:
Binary: A binary data point contains a Boolean value. The State text defines
human-readable labels for the two Boolean states. Select one of the existing state
texts from the drop-down list or create a new one by clicking on the plus icon.
Multistate: A multi-state data point represents a discrete set of states. The State
map defines the possible states and the human-readable labels. Select one of the
existing state maps from the drop-down list or create a new one by clicking on the
plus icon.
5. If you want to use the register in a Parameter view, select the Parameter checkbox.
6. Click OK.
1. Right click on the folder System/Schedulers and select New New Scheduler… in
the context menu.
4. Click the Add… button. This opens a data point selector window.
5. Select the LWEB-900 Server user register to attach and click OK. For each of the
attached data points, one line appears in the list below the Add… button.
8. Click OK.
Button Description
Display the schedule for a complete week from Monday to Sunday. The week is
selected in the calendar on the left.
Display the schedule details of a single day. The day is selected in the calendar on
the left.
Display all events in a list.
Display the calendar configuration.
Table 17: View Selection Buttons
Week view
Week view gives a quick overview of the scheduled events for one week. The week can be
selected in the calendar on the left. All events which are defined on the current hierarchy
level are displayed and can be modified. Events which are defined on higher hierarchy
levels are also displayed, but are greyed out and cannot be edited. Figure 121 shows an
example schedule for a specific meeting room. Figure 122 shows the same schedule for a
higher hierarchy level which applies to all meeting rooms.
The color of the timeline bar depends on the level of hierarchy on which the event is
defined. The color of the timeline bar corresponds with the color of the icons in the
navigation view (see Table 18).
If an event is overridden by events defined on lower hierarchy levels, the corresponding part on
the timeline is hatched. You can right click on the hatched part and select Show overriding
events… to see the list of events which override the event at that time (see Figure 122).
If you have defined a default value for the schedule, it is displayed at the top of the week
view.
Day view
The left side of the day view shows a preview similar to the week view. The right part shows the
details of all defined events. Lower priority events are displayed to the left and higher priority
events are displayed further to the right and partly cover the lower priority events (see Figure
123).
Events with higher priority override events with lower priority. There are three priority
levels:
Low
Normal
Override
If two events have the same priority, the event on the lower hierarchy level overrides the
event on the higher hierarchy level.
Event List
The event list displays the events defined in the master schedule (see Figure 124). Events of the
current hierarchy level can be edited. Events which are defined on higher hierarchy level are
greyed out and cannot be edited. To see events defined on lower hierarchy levels, activate
the checkbox Show events defined at lower hierarchy levels.
Calendar
Events can reference a calendar pattern which defines on which days the event will be
active. Each calendar pattern is a collection of date entries (see Figure 125). Calendar
patterns can be defined on any hierarchy level. If you define a calendar patterns at the level
of the master schedule folder, it will apply to all master schedules.
Calendar patterns of the current hierarchy level can be edited. Calendar patterns which are
defined on higher hierarchy levels are greyed out and cannot be edited. To see calendar
pattern defined on lower hierarchy levels, activate the checkbox Show calendar patterns
defined at lower hierarchy levels.
If you select a calendar pattern or a date entry, the corresponding days are highlighted in the
calendar pane on the left.
Configure presets
Presets define the set of values which can be scheduled. Each master schedule has its own
presets.
3. Click on the Create button to add a new presets (see Figure 126).
Color: The color is used to display the preset in week view and day view.
Value
5. To set a default preset, right-click on the input field and select a preset from the context
menu. The default preset will be scheduled when no event is active.
Note The buttons Rename and Delete become active if the name of a preset is selected in the
table header.
Add events
2. Right click anywhere in the week view, day view, or event list and select Add event…
from the context menu.
3. Figure 127 shows an example for the event definition dialog. The following parameters
can be configured:
Priority: If two events are scheduled at the same time, the priority defines which
event takes precedence. The following priority levels are supported:
o Normal
If two events have the same priority, the event defined on the lower hierarchy level
takes precedence.
Start, End, Duration: Define start and end time of an event. At the end of an
event, the value is withdrawn. This means that the event with the next highest
priority can take over and set a different value. If there is no lower priority event,
the default preset will be sent out. If no default preset is defined, no value update
will be sent out.
Event Type: The event type defines on which days an event will be active. The
following event types are supported:
o Daily: The event is executed daily, starting at a specific date and ending
on another date or never.
1. Double click on a schedule hierarchy level in the navigation view. If you want to add a
calendar pattern which applies to all schedulers, select the master schedule folder.
2. Switch to the calendar view by clicking the corresponding button on the tool bar.
3. Right click anywhere in the calendar view and select Add calendar pattern… from the
context menu.
4. Specify a name for the new calendar pattern and click OK.
5. Right click on the new calendar pattern and select Add date entry… from the context
menu.
6. The dialog is very similar to the lower part of the event definition dialog. You can
define One-time, Daily, Weekly, Monthly, Yearly, or Special date entries.
7. To add additional date entries to the same calendar pattern, repeat Step 5 and 6.
Note Calendar patterns can be defined on any hierarchy level. A calendar pattern will be visible
only at the hierarchy level it was defined and in lower hierarchy levels.
It is possible to add date entries on different hierarchy levels. Date entries are visible only
in the hierarchy on which they were defined and below. In this way, a calendar pattern can
be composed of different date entries in different hierarchy levels.
After you have configured the schedules in LWEB-900, you have to download them to the
LOYTEC devices. The schedules are executed decentralized in the devices to increases
reliability of the system.
1. The download to the LOYTEC devices is triggered by pressing one of the buttons
shown in Table 19.
Button Description
2. The download dialog is shown in Figure 130. If the checkbox Process only modified
items is selected, only the schedulers which have been modified since the last
download will be downloaded. This is useful to speed up the download if you have a
large number of schedulers. If this checkbox is not active, all schedulers displayed in
the list below will be downloaded. This is useful to override any potential changes of
the schedulers on the devices.
Note Events which are in the past and unused calendar patterns will not be downloaded to the
LOYTEC device to save resources.
LWEB-900 can upload local schedule changes only if they do not affect other schedulers.
This means that e.g. a change to the start or end time of an event, which was defined on the
scheduler level, can be uploaded. However, if an event is changed, which is defined on a
higher hierarchy level, it will not be uploaded because it might affect other schedulers.
1. The upload of schedules is trigged by pressing one of the buttons shown in Table 20.
Button Description
2. The upload dialog is shown in Figure 131. If the checkbox Process only modified
items is selected, only the schedulers which have been detected as modified will be
uploaded. This option is useful to speed up the process if you have a large number of
schedulers. However, if schedulers have been changed since the last poll cycle of
LWEB-900, these changes will not be taken into account. If the checkbox is not active,
all schedulers displayed in the list below will be uploaded. Use this option to get the
most current scheduler configuration from the devices.
3. If the changes cannot be uploaded into the master schedule configuration, an error will
be displayed as shown in Figure 132. In this example the preset values were changed
using the Web UI. Because the presets affect all other schedulers under the same master
schedule node, the modified presets will not be uploaded to the master schedule
configuration.
4. To find out more about why the upload did not work, double click on the scheduler in
the upload dialog. The pop-up window shows on the left side the scheduler as
configured in LWEB-900 and on the right side the changes made on the device (see
Figure 133).
Note If you have a master schedule which contains only a single scheduler, define the events on
the scheduler level. This gives you the possibility to upload any local changes.
Use the print button in the toolbar to print the currently displayed view of the master
scheduler. The print dialog allows adjusting the page margins and the scale factor.
1. Right click on the master schedule folder and select New New Master Schedule
from the context menu. If no master schedule folder exists yet, right click on the project
node instead. The master schedule folder is created automatically when creating the
first master schedule.
2. Enter a name and description for the new master schedule and click on OK.
3. The new master schedule is displayed in the navigation view. Double click the master
schedule to open the master schedule view.
1. To add a hierarchy level select New hierarchical folder from the context menu. Each
hierarchy level can contain further hierarchy levels. Up to three nested hierarchy levels
can be created under the master schedule node. All events defined on a specific
hierarchy level affect all schedulers attached to the same or lower hierarchy levels.
2. To add schedulers to a hierarchy level select Add scheduler… from the context menu.
Device schedulers as well as LWEB-900 Server schedulers can be added. All
schedulers which are added under a master schedule node must be compatible. This
means that the number and type of the scheduled data points must be identical.
Note LWEB-900 takes over the presets from the first scheduler which is added to a master
schedule node. Presets can be edited any time.
Per default a new scheduler is displayed using the name of the scheduler data point. This
can be a problem if multiple schedulers have identical names. You can either rename the
scheduler in LWEB-900 or define a new naming rule which can include the path
information. To define a naming rule right click on a node in the master scheduler and select
Define Schedules Naming Rules from the context menu. Scheduler naming rules are
inherited from a node to all lower hierarchy levels. Figure 136 shows an example naming
rule. Right click in the Schedule name format field to add placeholders as defined in Table
21.
Placeholder Description
Each LOYTEC device has only a limited amount of resources. LWEB-900 knows about
these limitations and checks every time a preset, event, or calendar pattern is added whether
there are enough resources available. Figure 137 shows an example error message which is
caused by adding too many presets.
For CEA-709 devices, the number of available daily schedule, calendar patterns, etc. can be
configured in the configuration software. Open the menu Settings Project Settings …
and select the CEA709 AST tab as shown in Figure 138.
For the master schedule view, the following settings are relevant:
Total number of date entries: This parameter specifies the total number of date
entries for all calendar patterns on a device.
Entries in Time/Value table: Also limits the maximum number of events. Each
event consists of 2 time/value pairs.
Note: Every change of the CEA709 AST settings changes the static network interface of the
device.
6.16 Trending
Trending refers to the ability to log values of data points over time. LWEB-900
distinguishes between two kinds of trend logs:
Device trend log: The data points are logged by a LOYTEC device. The
LWEB-900 Server reads out the stored data periodically (e.g. once a day). This
approach has the advantage, that data points are logged even if the LWEB-900
server is offline. Moreover, the traffic between LWEB-900 server and LOYTEC
devices is kept to a minimum.
LWEB-900 Server trend log: The data points are logged directly by the
LWEB-900 server. This approach has the advantage that you do not need to
change the configuration of the LOYTEC device. However, the LWEB-900 Server
has to access the device much more frequently. Therefore, the LWEB-900 Server
trend log is recommended only for temporary trends.
Trend logs can be visualized using a chart view. One chart view can reference multiple
trend logs.
1. Select Properties from the context menu of the project node in the navigation view and
switch to the Database Log Limitations tab.
2. The trend and alarm log size is limited by the following parameters (see Figure 139):
Size limit: Trend and alarm logs are organized as ring buffers. As soon as the
maximum number of log items has been reached, new log entries will overwrite the
oldest entries.
Duration limit: This parameter defines the maximum time span for which old data
is kept before deleting it from the database.
New trend logs are assigned the configured default values. These initial values can be
changed any time by editing the properties of an individual trend log.
LWEB-900 automatically detects new records in trend logs of LOYTEC devices. Before the
trend log buffer on the device can overrun, LWEB-900 reads out the trend log data and
stores it in the LWEB-900 database on the PC. The trend log poll cycle is configured as part
of the communication profile (see Section 6.24). Thus, memory limitations on the devices
can be overcome.
All trend logs of a device are stored in the folder Trend logs below the device (see Figure
140). Double click on the trend log to open it.
1. Right-click on a device trend log and select Properties from the context menu.
2. The properties dialog is opened (see Figure 141). You can only modify the Database
Log Limits (refer to Section 6.16.1) parameters. The other parameters are defined by
the device configuration and cannot be edited.
Note: It is possible to select multiple trend logs and select Properties from the context menu to
change the size limits. To find specific trend logs, select the object type Trend Log in the
advanced search (see Section 6.9).
Interval Mode: In this mode a snapshot of all trended data points is logged
periodically.
COV Mode: In this mode, each of the trended data points is logged separately if
and only if its value changes. For analog data points, a specific COV increment can
be configured.
Trigger Mode: In this mode a snapshot of all trended data points is logged each
time a trigger condition fires. The trigger condition is applied to a trigger data
point.
1. Right click on the folder System/Trending in the navigation view and select New
New Trend Log from the context menu.
4. If necessary, change the Log size and Log duration parameters (refer to Section
6.16.1).
6. Select Starting date and time. For trend logs of type Interval, LWEB-900 aligns the
log interval to this time.
7. The trending can be enabled/disabled by attaching an enable data point. This data point
should be of type binary. If the value of that enable data point is TRUE, the trend logs
data as defined by the trend mode. If the value of the enable is FALSE, trending is
disabled. If no enable data point is configured, the trend log is always enabled. Click
the … button to select a data point.
9. Click OK to store the basic configuration of the trend. The new trend log appears in the
navigation view.
When an LWEB-900 Server trend log has been created, it needs to be configured, which
data points it shall log. This is done by attaching data points to the trend log. Only simple
data points can be attached for trending, i.e. analog, binary, or multi-state.
1. Right click on the LWEB-900 Server trend log and select Properties from the context
menu. The same dialog which appears when a new trend object is created is shown and
allows configuring the trend.
Note Of course, this step can also be done directly when the object is created.
3. Add data points to be trended. Click on Add… to open a data point selector window.
4. Select the data points and click OK. For each of the attached data points, a line appears
in the list below the add button.
Note: Data points can also be attached to a trend by selecting a data point in the object list view
and dragging it onto a trend log.
Only OPC data points can be added to LWEB-900 Server trend logs. They are marked with
a small “O” in the top right corner of the data point symbol. To expose a data point via
OPC, the corresponding checkbox has to be activated in the device configuration software.
6. If COV mode was selected, the COV increment is displayed in the COV Delta column.
This value can be increased to generate less trend data.
7. If the trended value of the data point shall be aggregated over the log interval, select the
desired aggregation in the Type column. Available options are Min, Max, Avg.
Note To create multiple curves with min, average, and maximum values, add the same data point
three times and select the different aggregation types.
8. When done with the data point setup, click OK to leave the dialog.
In trigger mode, one or more trigger data points cause the generation of a snapshot
containing the values of the trended data points at the time instant the trigger is activated.
For a trend log, one or more trigger conditions can be defined.
1. Right-click on the LWEB-900 Server trend log and select Properties from the context
menu.
Note Of course, this step can also be done directly when the object is created.
6. In the Manage Trigger Conditions you can refine the trigger condition depending on
the trigger data point class.
7. When done with the data point setup, click OK to leave the dialog.
A server trend log can be temporarily disabled using the Disable Trend Log option in the
context menu. When the trend log is disabled, the LWEB-9S00 Server does not record the
attached data points. A disabled trend log can be enabled with the Enable Trend Log menu
entry.
The contents of the trend log can be exported as a comma separated value list (CSV export).
The trend log view can be refreshed by hitting the [F5] function key or pressing the Refresh
value toolbar button. If the log contains a large number of entries, the log is split into
multiple pages and the buttons at the bottom can be used to navigate through the pages.
Alternatively, the Go to date button can be used to jump to a specific date and time.
Column Configuration
The columns of the trend log view can be customized. To add columns or to change the
column order, click on the Configure columns toolbar button.
The column configuration is stored for each trend log view separately. To change the
column configuration for the current trend log view only, deactivate the Apply to all ‘Log’
objects checkbox and click the Apply button. To save the configuration for all trend log
views, activate the checkbox and press the Apply button.
Column Description
To search for specific records in the trend log view, click on the Filter Log Data button in
the toolbar. The filter dialog allows you to combine multiple conditions with AND and OR
operators. The example in Figure 146 finds all data records of the data point
“nvoHCroomTemp” with a value less than 20.
2. To clear all data, activate the checkbox Remove all data, else specify a date.
Note In case of a device trend log, only data in the LWEB-900 database is cleared. Data logged
by the LOYTEC device is left unchanged. You can clear the trend log data on the device
using its web UI.
1. Select one or multiple trend log records and open the context menu
2. The context menu allows to remove the selected records or to change the recorded
value.
Use the print button in the toolbar to print the trend log. You can print all trend log records
or only data logged during a configurable time interval. The print dialog allows adjusting
the page margins and the font size.
1. Right click on a folder in the navigation view and select New New Chart View
from the context menu. A trend chart can be created in the root folder (the project
node), in the home folder of a user, or in any user defined folder.
3. Line Width: Sets the line width for all curves drawn in this trend control.
4. Draw grid: This option enables a grid which allows easier readout of the displayed
data. The checkbox defines the initial state of the grid when you open the chart view.
You can enable/disable the grid any time using the corresponding toolbar button.
5. Display description in the view: If this option is enabled, the description of the chart
view is displayed as title of the chart.
Time Span: Select a suitable time span which is displayed initially when you open
the chart view. You can zoom in and zoom out any time using the corresponding
toolbar buttons of the char view.
Date Format: Format string used to display date labels on the time axis. Date
labels are shown at midnight of each day which has a label drawn. If the user
zooms out further, date labels will be shown only for every other day, every start of
the week, or every month, as space allows.
Time Format: Format string used to display time labels on the time axis. Time
labels are displayed only when there is more than one label for one day. Otherwise,
time labels will not be used.
Tick marks: Enables drawing of tick marks for the time axis.
Range: Value range for the primary value axis drawn on the left end of the trend
graph. This is the default range for the standard zoom setting and may be changed
during runtime when the option Y-Scaling is enabled.
Range 2: Value range for the secondary value axis. If enabled, the secondary scale
is drawn on the right end of the graph.
Tick Marks: Enables drawing of tick marks for the value axis.
Scale Labels: Enables drawing of scale labels. Note that scale labels should
always be enabled for controls which have the Y-Scaling option set.
Y-Autoscale: The range of the Y-axis automatically scales to the displayed values.
Labels Labels of the value scale (x-axis) and the time scale (y-axis).
Horizontal Grid Horizontal grid lines (if the grid is enabled).
Vertical Grid Vertical primary grid lines (if the grid is enabled).
Second. Grid Vertical secondary grid lines (if the grid is enabled).
Axis Tick marks and axis for value and time.
Container Background of the graph area, which is the rectangular area
spawned by the value and time axis.
Background Color of the background outside the graph.
Table 23: Colors of Trend Chart View
9. Click OK to store the basic configuration of the chart view. The new chart view
appears in the navigation view.
When a chart view has been created, it needs to be configured, which trend logs it shall
display. This is done by attaching trend logs to the chart view. Device trend logs as well as
LWEB-900 Server trend logs can be attached.
1. Right-click on the chart view and select Properties from the context menu. The same
dialog which appears when a new char view is created is shown and allows configuring
the chart view.
Note Of course, this step can also be done directly when the object is created.
3. Click on Add… to add a trend log to the chart view. A trend log selector window is
opened.
4. Select the trend log and click OK. The trend log and the logged data point(s) appear in
the list below the add button.
5. Trend logs can be removed from the chart view by clicking Remove.
6. For each logged data point the following parameters can be configured:
Name: Name displayed in the chart view legend. If you leave this field empty,
the data point name will be displayed per default.
Y-Axis: Select First to display the data point on the primary y-axis or Second
to display the data point on the secondary y-axis.
Scale Factor: The data records are multiplied with this factor before
displaying them. Example: To convert Wh into kWh enter the value 0.001.
7. When done with the data point setup, click OK to leave the dialog.
A limit line draws a value as a horizontal line across the entire graph. The value can either
be constant or fetched from a data point.
1. Right-click on the chart view and select Properties from the context menu. The same
dialog which appears when a new char view is created is shown and allows configuring
the chart view.
Note Of course, this step can also be done directly when the object is created.
3. To add a constant value limit line, click on the Add a Constant Value… button. The
limit line appears in the list.
4. To add a limit line based on a data point value, click on the Add Datapoint button. A
data point selector window is opened. Select the data point and click OK. The limit line
appears in the list.
5. Limit lines can be removed from the chart view by clicking Remove.
Y-Axis: Select First to display the limit line on the primary y-axis or Second
to display the limit line on the secondary y-axis.
7. When done with the data point setup, click OK to leave the dialog.
A shortcut to creating a LWEB-900 Server trend log and a corresponding chart view is to
select a data point in the object list view, right click on it and choose Show the Datapoint
in a new Chart View (see Figure 155) . The trend log is created with default settings in the
folder System/Trending and the chart view is placed in the home directory of the user (see
Figure 156).
Figure 156: LWEB-900 Trend Log and Chart View Created in Home Directory
Use the print button in the toolbar to print the trend chart. The print dialog allows adjusting
the page margins and the scale factor.
6.17 Reporting
LWEB-900 can create reports based on trend logs. Reports can be used, for example, to
document the energy consumption in a building. Figure 157 shows an example report.
Right click on a folder in the navigation view and select New New Report from the
context menu. A report can be created in the root folder (the project node), in the home
folder of the user, or in any user defined folder.
When creating a new report, the report properties dialog (see Figure 159) is opened. To
change the properties of an existing report, right click on the report and select Properties
from the context menu.
2. Select a report template from the drop-down list. The report template defines how the
data from the trend logs is presented. Refer to section 6.17.4 for details.
3. Configure the report schedule: The report schedule defines when LWEB-900 generates
a report. LWEB-900 offers the following options:
Periodic report: The report is generated automatically each day, week, month, or
year.
Triggered report by datapoint: The report is generated if the attached data point
changes to a value other than zero. This feature is useful to e.g. generate a report
when an alarm occurs.
Manual report: The report is generated only when the user triggers it manually.
4. Configure how the generated report will be distributed. The report can be generated in
PDF, Excel, or Word format. If the E-mail report checkbox is active, the report will be
distributed via e-mail. A prerequisite to sending e-mails is the configuration of the
outgoing e-mail server as described in Section 6.18. The following parameters need to
be specified for e-mail distribution:
E-mail to: Select the e-mail addresses which should receive the generated reports.
Note The list of available e-mail adresses contains all users for which an e-mail address has
been specified (see Section 6.27). If you want to send a report to an e-mail address which
does not belong to an LWEB-900 user, you can add this e-mail address in the project
properties: Select Properties from the context menu of the project node in the navigation
view and switch to the Outgoing mails tab.
E-mail subject: The e-mail subject can contain the place holders described in
Table 24. To add a place holder, use the right mouse button and select the place
holder from the context menu.
E-mail body: The body can contain the same place holders as the e-mail subject.
5. Configure the folder and file name for the generated report:
Report folder: Subfolder for generated report files. The report folder can contain
the place holders described in Table 25. To add a place holder, use the right mouse
button and select the place holder from the context menu.
Report filename: The report filename can contain the place holders described in
Table 24. To add a place holder, use the right mouse button and select the place
holder from the context menu.
Date & time format: The date and time format can contain the format specifier
described in Table 26. To add a format specifier, use the right mouse button and
select the format specifier from the context menu.
Max. reports: If a value different from 0 is specified, the LWEB-900 Server will
delete the oldest report when this number is exceeded.
Store for a period of: If a value different from 0 is specified, the LWEB-900
Server deletes reports which have been generated before the specified period.
%Y Year
%m Month
%d Day
%H Hour
%M Minute
%S Second
Table 26: Format Specifiers for Date and Time
Figure 160 shows the Datalogs tab of the report properties dialog. This dialog allows you to
configure the data source for your report. Depending on the report template, you can have
one or multiple data groups. The template “Stacked Column Chart“, for example, has the
following two data groups:
Group 1: All trend logs in group 1 are displayed on the primary y-axis as stacked
column chart. Typically trend logs which represent energy meters are added to
group 1.
Group 2: All trend logs in group 2 are displayed on the secondary y-axis as line
chart. Group 2 can be used to display data which influences the energy
consumption reported by group 1 (e.g. outside temperature, solar irradiation).
1. Define the time period: All data records with a timestamp inside the time period will be
selected for the report. You have to specify a start date (From) and an end date (To).
Both can be absolute or relative:
Absolute: An absolute date and time is independent of the time when the report is
generated.
Example: 1.1.2014 at 12:00 AM
Relative: If you want to create a periodic report or a triggered report, the time
period should be relative to the time when the report is generated.
Example: Relative to start of current month, 1 month ago at 12:00 AM
If the report template has multiple data groups, you can link the time periods of the
different groups by using the Identical to option. For example, after you have defined
the time period for group 1, you can select Identical to Group 1 for the time period of
group 2.
2. Define step interval: The step interval defines the resolution of the report. All data
during the step interval will be aggregated. The aggregation algorithm can be
configured for each data point separately (see Table 27).
Example: To report the daily energy consumption, set the step interval to 1 day and the
aggregation mode to “Delta”.
3. Click on Add… to attach a trend log to the chart view. A trend log selector window is
opened.
4. Select the trend log and click OK. The trend log and the logged data point(s) appear in
the list below the add button.
5. Trend logs can be removed from the chart view by clicking Remove.
6. For each logged data point the following parameters can be configured:
Report legend: Name displayed in the report. If you leave this field empty, the
data point name will be displayed per default.
Color: Color used to display the logged data point in the report.
Aggregation Mode: The aggregation mode defines how a value for the step
interval is calculated (see Table 27).
Scale Factor: Each calculated value is multiplied with the scale factor.
Example: To convert Wh to kWh, enter a scale factor of 0.001.
Figure 161 shows the Parameters tab of the report properties dialog. This dialog allows
configuring report template specific parameters. Each report template can be customized
using parameters. The parameters for the different built-in report templates are described in
Section 6.17.4.
The following sections describe the standard report templates provided by LOYTEC. For
information on how to create your own custom user report templates refer to Section 8.5.
The stacked column chart template contains two data groups. If the second data group is
used, the time period and the step interval for group 2 should be set identical to group 1.
Header: The report header displays the report name, description, the time period
for group 1, the date and time when the report was created, and the page number.
Column Chart: All trend logs in group 1 are displayed on the primary y-axis as
stacked column chart. All trend logs in group 2 are displayed on the secondary y-
axis as line chart.
Pie Chart: The pie chart is displayed only if more than one trend logs are added to
group 1. It displays the sum of values for each trend log.
Step table: The step table contains the same information as the line chart in tabular
form. Each row contains the aggregated data for the corresponding step interval.
The minimum and maximum values are highlighted in bold.
Statistics table: The statistics table provides a summary of the report data.
The following parameters can be configured for the stacked column chart template:
Parameter Description
Line Chart
Header: The report header displays the report name, description, the time period,
the date and time when the report was created, and the page number.
Line Charts: Depending on the time period, the data of the attached trend logs is
displayed in one or multiple line charts. The following screenshot shows an
example of the electric power for the time period of one month. Each line chart
shows one complete week starting with Monday. Therefore, data from
corresponding weekdays is displayed above each other.
Step table: The step table displays the same information as the line chart in tabular
form. Each row contains the aggregated data for the corresponding step interval.
The minimum and maximum values are highlighted in bold.
Statistics table: The statistics table provides a summary of the report data.
The following parameters can be configured for the line chart template:
Parameter Description
Compare
This report template is intended to compare two groups of trend logs during different time
periods. It can be used to e.g. compare the energy consumption in the current time period
with a baseline. It is possible to add multiple trend logs to each data group. The report
template compares the total of group 1 will the total of group 2. Additionally, each pair of
trend logs is compared separately.
Header: The report header displays the report name, description, the time periods
for group 1 and for group 2, the date and time when the report was created, and the
page number.
Gauge: The gauge displays the difference between the sum of all data in group 1
and group 2 in percent.
Summary table: This table compares each pair of trend logs (trend log n in group 1
and trend log n in group 2). For each pair of trend logs the following information is
displayed: sum of values for trend log in group 1, sum of values for trend log in
group 2, absolute delta, and delta in percent.
Line chart: This chart displays a pair of trend logs (trend log n in group 1 and trend
log n in group 2) over time. The x-axis labels display the timestamp of group 1.
Data from group 2 is displayed with a time offset so that both data lines start at the
same x-axis position.
Step table: The step table displays the same information as the line chart in tabular
form. Each row contains the aggregated data for the corresponding step interval.
Parameter Description
Energy Signature
The energy signature report gives a quick overview of the energy performance of a building.
It shows the correlation between energy consumption and heating degree days. Heating
degree days (HDD) are calculated from the outside temperature and are a measure of how
much the outside air temperature was below a certain base temperature.
The heating degree days are calculated using the following formula:
The values TIndoor and TOutdoor are parameters for the calculation, the values TOutdoor
are the measured values.
The energy signature report performs a simple linear regression and shows the following
parameters:
b: Slope
The energy signature report template contains two data groups. Group 1 contains the energy
meter data. Figure 170 shows an example configuration. If multiple energy meter trend logs
are added, a separate chart is displayed for each energy meter. Group 2 contains the trend
log for the outside temperature (see Figure 171). The step interval for Group 2 has to be set
to 1 day for calculation of the heating degree days.
The following parameters can be configured for the energy signature template:
Parameter Description
Generic
The generic report template contains one data group. It allows specifying what charts and
tables are used to display data. The following parameters can be configured for the generic
report template:
Parameter Description
E-mail address: Enter the e-mail address of the LWEB-900 server’s e-mail
account.
Port number: Typically, the SMTP server port can be left at 25.
E-Mail addresses: The list automatically contains all users for which an e-mail
address has been specified (see Section 6.27). If you want to add e-mail addresses
which do not belong to LWEB-900 users, you can add them explicitly to the list by
pressing the plus icon.
Event path
Each event is associated with an LWEB-900 object. LWEB-900 objects are organized
hierarchically and can be explored using the navigation view and the object list view. The
event view displays only events related to objects which are inside the path set in the
breadcrumb navigation bar. To see all events, select the top folder. Select a specific folder
to see only events which are associated with objects inside this folder.
Event filter
The event filter lets you drill down to the specific events you want to see. The event view
offers a number of predefined filters described in Table 33 or you can use the powerful
custom filter.
Column Description
Figure 174 shows an example of a custom filter definition. As you can see, the custom filter
allows to combine multiple conditions with AND and OR operators.
Column Configuration
The columns of the event view can be customized. To add columns or to change the column
order, click on the Configure columns toolbar button.
The column configuration is stored for each event view separately. To change the column
configuration for the current event view only, deactivate the Apply to all ‘Event view’
objects checkbox and click the Apply button. To save the configuration for all event views,
activate the checkbox and press the Apply button.
Column Description
If you regularly need to filter for certain events, it might be useful to save your event view:
click the Save event view button, enter the view name and its optional description. A new
event view with the current path and filter settings is created in your home directory. The
next time you want access the event view, just double click it, and you will see the most
current events matching your path and filter.
Use the print button in the toolbar to print the event view. You can print all event records or
only events logged during a configurable time interval. The print dialog allows adjusting the
page margins and the font size.
Even on a server with a large hard drive, the disk space is limited. Therefore, you need to
configure for how long the LWEB-900 Server keeps old events.
1. Select Properties from the context menu of the project node in the navigation view and
switch to the Database Log Limitations tab.
Size limit: The event log is organized as a ring buffer. As soon as the maximum
number of log items has been reached, new log entries will overwrite the oldest
entries.
Duration limit: This parameter defines the maximum time span for which old data
is kept before deleting it from the database.
1. Use your right mouse button to click on the Global connections folder in the
navigation view and select New New Global Connection from the context menu.
Note You can organize global connections in sub folders. To create a sub folder, right click on
the Global connections folder and select New New Folder from the context menu.
2. Define a name and description for the global connection. The name is required to be
unique.
Max Send Time: This timing parameter of the global connection specifies a
time in seconds, in which a value update is transmitted into the connection,
even if the value has not changed. This is typically used for heartbeat
functions.
Min Send Time: This timing parameter of the global connection specifies a
time in seconds, for which transmissions will be delayed after sending out a
value into the connection. This setting can be used to limit the transmission
rate to the connection.
5. Add data points to the global connection. Click on Add… to open a data point selector
window.
6. Select the data points and click OK. For each of the attached data points, a line appears
in the list below the add button.
7. Data points can be removed from the global connection by clicking Remove.
8. As a default, output data points will be added with the direcction Send, input data
points with the direction Receive. Change the direction by modifying Send or Receive.
9. When done with the global connection setup, click OK to leave the dialog. The global
connection is displayed in the navigation view. All datapoints which are member of the
connection are displayed in the object list view.
After the connections have been created in LWEB-900, the LOYTEC devices need to be
configured accordingly. This is done by downloading the connection information to the
devices.
1. Use your right mouse button to click on the Global connections folder in the
navigation view and select Download Global Connections from the context menu.
2. Select the devices to which the global connection information should be downloaded.
Per default only devices for which the global connnection configruation changed since
the last download are selected. You can change the selection by activating/deactivating
the checkboxes beside the devices (see Figure 181).
If global connections have been configured using a different tool (e.g. device configuration
software), those existing global connections can be uploaded into LWEB-900:
1. Use your right mouse button to click on the Global connections folder in the
navigation view and select Upload Global Connections from the context menu.
2. The existing global connections of all devices are checked and the current status is
displayed. You can select from which devices you want to upload the global
connections and import them into LWEB-900.
Direct link: The file object can be linked directly to any other object in the
navigation view. The file object appears as related object in the context menu of
the linked object.
Object filter: The file object can be linked to multiple other objects in the
navigation view by specifying an object filter condition. The file object appears as
related object in the context menu of any object which passes the filter condition.
Alarm filter: The file object can be linked to alarms by specifying an alarm filter
condition. The file object appears as related object in the context menu of any
alarm in the alarm view which passes the filter condition.
1. Right click on a folder in the navigation view and select New New File from the
context menu. A file object can be created in Library/Files folder or any user defined
subfolder.
2. Enter a name, description, and select a file by clicking on the browse button.
3. After clicking the OK button, the new file object is created and displayed in the
navigation view.
1. Right click on the file object and select Properties from the context menu.
3. Give the link a name, select the Link Type “Direct Link to Object” and press on the
Browse button to select the object to which you want to link.
Note An alternative way to create a direct link is to drag the file object and drop it on the object
to which you want to link it.
1. Right click on the file object and select Properties from the context menu.
3. Give the link a Name, select the Link Type “Link Filter to Object” and define a filter
condition. You can combine multiple parameters using AND, OR, and NOT operators.
1. Right click on the file object and select Properties from the context menu.
3. Give the link a Name, select the Link Type “Link Filter to Alarm” and define a filter
condition. You can combine multiple parameters using AND, OR, and NOT operators.
1. Right click on the file object and select Download for editing from the context menu.
3. Right click on the file object and select Upload new version from the context menu.
Using the device management view, the configuration and parameterization of LOYTEC
devices can be managed. In a typical installation multiple devices have the same data point
configuration but are parameterized differently. LWEB-900 can assign configuration and
parameter files to devices and download them in parallel. Furthermore, LWEB-900 can
manage program (logi.CAD) files.
The backup feature allows defining regular backup schedules for LOYTEC devices. It is
also possible to backup selected devices on request.
To open the device management view, right click on the Network/Devices folder in the
navigation view and select Open in Device Management View (see Figure 186).
The device management view is linked to the navigation view. The selected folder in the
navigation view determines which devices are displayed. If you select the Network/Devices
folder, you see all devices in the project. If you select a sub-folder all devices in or below
this folder are displayed.
Device list:
The device list displays all devices which are in or below the currently selected folder in the
navigation view. Each line in the device list describes one device. If a line is displayed in
red, the LWEB-900 Server cannot communicate with the device.
The first three columns in the device list always show the device name, IP address, and
device type. The remaining columns are depending on the selected tab. By clicking on the
column header, the list can be sorted. It is possible to filter the list to display only a certain
device type by right-clicking on the Type column header as shown in Figure 187.
One or multiple devices can be selected in the list view. The buttons above the device list
(e.g. Download all files, Upload all files) execute actions on all selected devices.
Additional actions are available in the context menu of the selected devices.
Property view
The property view displays the properties of the device(s) selected in the device list. Which
properties are displayed depends on the selected tab.
Tab selection
Each tab provides different information about the devices. The following tabs are available:
Overview: On the overview tab you can see the complete status of the devices at
one glance. It combines the most important information of the Firmware file,
Configuration file, and Program file tabs.
Firmware file: This tab allows upgrading the firmware of LOYTEC devices
including L-IOB devices attached to programmable controllers. A detailed
description is given in Section 6.22.2.
Configuration file: This tab allows managing configuration and parameter files.
Refer to Section 6.22.3 for a detailed description.
Program file: This tab is used to manage logi.CAD files for programmable
controllers. See Section 6.22.4 for more information.
The columns of the device list are described in Table 35. The property view contains
detailed information about the selected device(s). This information is described in the
following sections (see Table 36).
Column Description
The columns of the device list are described in Table 37. The status of the firmware (up-to-
date, new on web, etc.) is visualized in the column FW status. If L-IOB devices are
attached to the base device, the column L-IOB FW status displays the summary status of
the connected L-IOB devices. The status of device firmware and L-IOB firmware is
visualized using the symbols described in Table 38.
Column Description
The property view contains detailed information about the selected device(s). Table 39
describes the information displayed in the Firmware file section of the property view. A
new firmware can be assigned to the selected device(s) by clicking on the button Select new
firmware file.
Line Description
Type List of device types which are supported by the firmware file.
Latest version in database Version and timestamp of the newest firmware file in the
database which fits the selected device.
Version in database for Version and timestamp of the firmware file which is assigned to
this device the device.
Version on device Version and timestamp of the firmware installed on the device.
Table 39: Device Firmware Properties
If the device supports L-IOB devices, the property view contains a L-IOB firmware
section. This section displays a list of all connected L-IOB devices. For each L-IOB device,
the information described in Table 40 is displayed.
A new L-IOB firmware can be assigned by clicking on the button Select new L-IOB
firmware files. The same L-IOB firmware file will be assigned to all connected L-IOB
devices which are compatible with this firmware. Before downloading a new L-IOB
firmware, it is recommended to click on the button Check for new L-IOB devices. This
ensures that all L-IOB devices (even devices which are not yet configured) are detected.
Line Description
Bus x, Device y This line displays the firmware status symbol for the individual
L-IOB device (refer to Table 38) and live status of the device
(e.g. online, offline, not detected, etc.). The last contact
timestamp informs the user when this information has been
updated by LWEB-900.
Name Name of the L-IOB bus and of the L-IOB device in the format
<L-IOB bus name>, <L-IOB device name>.
Latest version in database Version and timestamp of the newest L-IOB firmware file in the
database.
Version in database for Version and timestamp of the L-IOB firmware file which is
this device assigned to the device.
Version on device Version and timestamp of the firmware installed on the L-IOB
device.
Table 40: L-IOB Firmware Properties
Upgrading the device firmware is done in two steps: First a new firmware has to be assigned
to the devices. Different device types require different firmware files. This means that you
need to assign a different firmware file to e.g. an LVIS-3E100 device or a LINX-100
device. In a second step the firmware is downloaded to the devices. This can be done in
parallel for all devices independent of the device type.
1. In the device list, select one or more devices which you want to upgrade. All selected
devices have to belong to the same product family. To select all devices of a product
family, right click on a device and choose Select devices with compatible firmware
from the context menu.
2. Click on the Select new firmware file button in the property view.
Note: An alternative method is to choose Select firmware file from the context menu in the list
view.
3. The Select Firmware dialog opens as shown in Figure 190. The dialog displays a list
of compatible firmware files available in the LWEB-900 database. If the desired
firmware version is already available in the list, select it and press OK. You can either
import a new firmware file from the hard disk or check if a new firmware is available
on the LOYTEC web site:
Hard disk: If you have the firmware file available on your hard disk, click on the
Import new file… button, which opens a file selection dialog.
LOYTEC web-site: You can download the newest released firmware directly
from the LOYTEC web-site by clicking on the Check for new version on
LOYTEC web-site… button. If a new firmware version is available, LWEB-900
downloads it from the web-site and displays the Readme file.
4. Repeat the previous steps for other devices which require a different firmware file.
1. In the device list, select all devices. Press the button Download device firmware on
the top of the Firmware file tab.
Note: An alternative method is to choose Download device firmware from the context menu in
the list view.
2. The Download firmware file dialog opens as shown in Figure 191. This dialog
displays a list of devices and the firmware files which will be downloaded. To start the
download, press the Start download button.
3. During the download, the Status column is updated with current information.
LWEB-900 first checks if the firmware in the devices is already up-to-date. If this is the
case, the status “Up-to-date” is displayed and the firmware will not be downloaded.
1. In the device list, select one or more L-INX devices with attached L-IOB devices.
2. Click on the button Check for new L-IOB devices. This ensures that all L-IOB
devices (even devices which are not yet configured) are detected.
3. Click on the Select new L-IOB firmware files button in the property view.
Note: An alternative method is to choose Select L-IOB firmware files from the context menu in
the list view.
4. The Select Firmware dialog opens as shown in Figure 192. The dialog displays a list
of available L-IOB firmware files. The list is split into separate sections for L-IOB
devices which require different firmware files. If the desired L-IOB firmware version is
already available in the list, select it and press OK. You can either import a new L-IOB
firmware file from the hard disk or check if a new firmware is available on the
LOYTEC web site:
Hard disk: If you have the L-IOB firmware file available on your hard disk, click
on the Import new file… button, which opens a file selection dialog.
LOYTEC web-site: You can download the newest released firmware directly
from the LOYTEC web-site by clicking on the Check for new version on
LOYTEC web-site… button. If a new L-IOB firmware version is available,
LWEB-900 downloads it from the web-site and displays the Readme file.
The selected firmware is assigned to all L-IOB devices which are attached to the
selected L-INX device(s).
1. In the device list, select all devices. Press the button Download L-IOB firmware files
on the top of the Firmware file tab.
Note: An alternative method is to choose Download L-IOB firmware files from the context menu
in the list view.
2. The Download L-IOB firmware files dialog opens as shown in Figure 193. This
dialog displays a list of L-INX devices and the L-IOB firmware files which will be
downloaded. To start the download press the Start download button.
3. During the download, the Status column is updated with current information.
LWEB-900 downloads the L-IOB firmware to the L-INX device and then tells the
L-INX device to upgrade the attached L-IOB devices with this firmware.
Configuration file: The configuration file defines the data points on the device
(e.g. user registers, CEA-709 network variables, BACnet server objects and client
mappings, M-Bus registers, Modbus registers, etc.). The configuration file is
created by the configuration software of the device.
Parameter file: In the configuration file some data points are marked as
parameters. The parameter file defines the values of these parameters. Not all
LOYTEC devices have a parameter file.
The columns of the device list are described in Table 41. The status of the configuration file
(up-to-date, download, etc.) is visualized in the column Config. status. If the device
supports a parameter file, the column Parameter file status displays the status of the
parameter file. The status of configuration and parameter file is visualized using the
symbols described in Table 42.
Column Description
The property view contains detailed information about the selected device(s). Table 43
describes the information displayed in the Configuration file and Parameter file sections
of the property view. A new configuration can be assigned to the selected device(s) by
clicking on the button Select new configuration file. A new parameter file is assigned by
clicking on the button Select new parameter file.
Line Description
1. In the device list, select one or more devices for which you want to upload the
configuration file.
2. Press the button Upload configuration on the top of the Configuration file tab.
Note: An alternative method is to choose Upload configuration from the context menu in the list
view.
3. The Upload configuration file dialog opens as shown in Figure 195. This dialog
displays a list of devices and the configuration files which will be uploaded. To start
the upload, press the Start upload button.
4. During the upload, the Status column is updated with current information. The
uploaded configuration files get default names. Default names for configuration files
have the following format:
[<device name>_<date>_<time>]_config.zml
The configuration file name can be changed in the Select Configuration File dialog
(see Section 6.22.7).
1. In the device list, select one or more devices to which you want to assign the same
configuration. To select all devices which have identical configuration assigned, right-
click on a device and choose Select devices with identical configuration from the
context menu.
2. Click on the Select new configuration file button in the property view.
Note: An alternative method is to choose Select configuration file from the context menu in the
list view.
3. The Select configuration dialog opens as shown in Figure 196. The dialog displays a
list of compatible configuration files available in the LWEB-900 database. If the
desired configuration file is already available in the list, select it and press OK.
Note: Uploading a configuration file from one device and then assigning this configuration to
multiple other devices is a quick way to copy the configuration of a device to other devices.
If you have the configuration file available on your hard disk, click on the Import
new file… button which opens a file selection dialog.
Note: Configuration files can be exported from the device configuration software.
1. In the device list, select the devices to which you want to download the assigned
configuration. Press the button Download configuration on the top of the
Configuration file tab.
Note: An alternative method is to choose Download Configuration from the context menu in the
list view.
2. The Download configuration file dialog opens. This dialog displays a list of devices
and the configuration files which will be downloaded. To start the download, press the
Start download button.
The columns of the device list are described in Table 44. The status of the program file (up-
to-date, download, etc.) is displayed in the column Status. The status of the program file is
visualized using the symbols described in Table 45.
Column Description
The property view contains detailed information about the selected device(s). Table 46
describes the information displayed in the Program file sections of the property view. A
new program file can be assigned to the selected device(s) by clicking on the button Select
new program file.
Line Description
1. In the device list, select one or more devices for which you want to upload the program
file.
2. Press the button Upload program file on the top of the Program file tab.
Note: An alternative method is to choose Upload program file from the context menu in the list
view.
3. The Upload program file dialog opens as shown in Figure 198. This dialog displays a
list of devices and the program files which will be uploaded. To start the upload, press
the Start upload button.
4. During the upload, the Status column is updated with current information. The
uploaded program files get default names. Default names for program files have the
following format:
[<device name>_<date>_<time>]_program.so
The program file name can be changed in the Select Program File dialog (see Section
6.22.7).
1. In the device list, select one or more devices to which you want to assign the same
program file. To select all devices which have identical program files assigned, right-
click on a device and choose Select devices with identical program from the context
menu.
2. Click on the Select new program file button in the property view.
Note: An alternative method is to choose Select program file from the context menu in the list
view.
3. The Select program dialog opens as shown in Figure 199. The dialog displays a list of
program files available in the LWEB-900 database. If the desired program file is
already available in the list, select it and press OK.
Note: Uploading a program file from one device and then assigning this program to multiple
other devices is a quick way to copy the program of a device to other devices.
If you have the program file available on your hard disk, click on the Import new
file… button, which opens a file selection dialog.
Note: The program file can be exported from the L-INX Configurator by pressing the Restore to
Disk button on the LogiCAD Files tab.
1. In the device list, select the devices to which you want to download the assigned
program. Press the button Download program file on the top of the Program file tab.
Note: An alternative method is to choose Download program file from the context menu in the
list view.
2. The Download program file dialog opens. This dialog displays a list of devices and
the program files which will be downloaded. To start the download, press the Start
download button.
The status of the LWEB-800/802 projects is visualized in the column L-Web project using
the symbols described in Table 47. Note that multiple projects can be stored on a single
device.
The property view contains detailed information about the selected device(s). Table 48
describes the information displayed in the LWEB-800 projects section of the property
view. New LWEB-800/802 projects can be assigned to the selected device(s) by clicking on
the button Select new LWEB-800 project files.
Line Description
1. In the device list, select one or more devices for which you want to upload the
LWEB-800/802 project files.
2. Choose Upload LWEB-800 projects from the context menu in the list view of the
Overview tab.
3. The Upload LWEB-800 projects dialog opens as shown in Figure 200. This dialog
displays a list of devices and the LWEB-800/802 projects which will be uploaded. To
start the upload, press the Start upload button.
4. During the upload the Status column is updated with current information. Uploaded
LWEB-800/802 files get a prefix containing the name of the device and the upload
timestamp:
The LWEB-800/802 file name can be changed in the Select L-Web projects dialog
(see Section 6.22.7).
1. In the device list, select one or more devices to which you want to assign the same
LWEB-800/802 project files. Usually you will assign a certain LWEB-800/802 project
only to a single device.
2. Click on the Select new LWEB-800 project files button in the property view.
Note: An alternative method is to choose Select LWEB-800 project files from the context menu in
the list view.
3. The Select L-Web projects dialog opens as shown in Figure 201. The dialog displays
a list of LWEB-800/802 projects available in LWEB-900. Use the checkboxes to
assign LWEB-800/802 projects to the device(s) and press OK.
If you have the LWEB-800/802 project file (extension .lweb or .lweb2) available
on your hard disk, click on the Import new file… button, which opens a file
selection dialog.
Note: The LWEB-800/802 project file can be exported from the L-INX Configurator by pressing
the Export… button on the L-Web Projects tab.
1. In the device list, select the devices to which you want to download the assigned
LWEB-800/802 projects. Select Download LWEB-800 projects from the context
menu in the list view of the Overview tab.
2. The Download LWEB-800 projects dialog opens. This dialog displays a list of
devices and the LWEB-800/802 project files which will be downloaded. To start the
download press the Start download button.
1. In the device list select the devices which you want to backup.
3. Enter a backup description and press Continue. The description helps you later to
identify a certain backup.
4. The Backup devices dialog opens (see Figure 203). To start the process, press the
Start backup button. During the backup the Status column is updated with current
information.
Column Description
1. In the navigation view select a folder. The device list displays all devices below the
selected hierarchy level. These devices will be included in the backup schedule.
Because the backup schedule references a hierarchy level (folder) and not individual
devices, devices which are added later below this level will be included in the backup
automatically.
3. Configure the name in the Edit backup schedule dialog (see Figure 205) and select
when the backup will be executed.
2. Right click and select Edit selected backup schedule from the context menu, or
double click on the selected backup schedule.
3. Change the schedule settings in the Edit backup schedule dialog (see Figure 205)
2. Right click and select Delete selected backup schedule from the context menu.
6.22.6.3 Restore
Perform the following steps to restore one or more devices from a backup:
3. The Restore devices dialog (see Figure 206 and Table 50) allows selecting the backups
which will be restored. Per default the latest backup is selected for each device. You
can select a different backup using one of the following methods:
Select specific backup: Select a single device and right-click on the date column.
A context menu appears which allows you to select one of the available backups
for the selected device.
Select backup before a certain date: Select multiple devices, right-click on the date
column and select Backup before date…. The following dialog allows you to
specify a date.
Select latest backup: Select multiple devices, right-click on the date column, and
select Latest backup.
5. The Restore backup files dialog opens (see Figure 207). To start the restore process,
press the Start download button. During the restore operation, the Status column is
updated with current information.
Column Description
File name
Original path: Files are uploaded from an LWEB-900 client to the LWEB-900
server. The original path shows where the file was originally stored:
[localhost]<path>
The file was stored on the same PC where the LWEB-900 server is running in the
specified path.
<device name>
File was uploaded from the specified device.
www.loytec.com
File was downloaded from the LOYTEC homepage (for firmware files only).
Use: This number indicates how many devices the file is assigned to. A file can be
deleted only if the use count is 0.
Import new file: Import a new file from the hard disk. If a file with the same name
already exists in the database, you have the option to overwrite or to rename the
existing file.
Remove file: A file can be removed only if it is not assigned to any device (use
count must be zero).
Rename file: Existing files can be renamed. The new name must be unique.
Check for new version on LOYTEC web-site: This action applies only to
firmware files. LWEB-900 checks if a new firmware version has been published on
the LOYTEC web site. If this is the case, LWEB-900 can download the new
firmware and assign it to the selected device.
The list of files can be filtered using the checkboxes on the top (see Figure 210).
Import new file: Import a new file from the hard disk. If a file with the same name
already exists in the database, you have the option to overwrite or to rename the
existing file.
Remove file: A file can be removed only if it is not assigned to any device (use
count must be zero).
Remove unused file: Only files which appear in the list above (filter is applied)
and which have a use count of 0 are removed.
Rename file: Existing files can be renamed. The new name must be unique.
6.23 Perspectives
Views are organized in the application window in an arrangement called a perspective. You
can create and customize your own perspectives by arranging views in the layout that best
suits your working style for specific tasks.
1. Open the relevant views and arrange them on your screen in the way it suits you best.
From current perspective: The new perspective is based on your current view
arrangement. This is the default.
5. Click OK to save the perspective. The perspective is created in your home directory. It
is now available in the perspective selection drop-down list.
After you have created a new perspective, you will open new views and change the
arrangement of existing views. Your current layout is automatically saved when you log out.
Therefore, when you start the LWEB-900 client, you will find it in the same state as when
you left it. To return to the initial layout of your perspective, click on the Reset Perspective
toolbar button. To override the initial layout with your current layout, click on the Save
Perspective toolbar button.
When you create a new perspective, it is stored in the Perspectives folder of your home
directory. Objects in your home directory cannot be accessed by other users. To make a
perspective available to other users, drag it to the System/Perspectives folder (see Figure
213). Per default all user have access to this folder and its contents. You can change the
access rights as described in Section 6.28. The perspective selection drop-down box shows
all perspectives to which you have at least Read access. To save a perspective, you need to
have Configure access.
3. Define the maximum number of parallel file transfers: Files need to be transferred
to/from a device for firmware upgrades, backup, restore, parameter download/upload,
global connections download/upload, etc. To limit the traffic on the network the
number of concurrent file transfer can be limited by this setting.
4. Define OPC communication parameters: The LWEB-900 Server uses the OPC
XML-DA communication standard to access data points on LOYTEC devices. The
standard defines two data access modes:
Polling: The data points are polled periodically using the interval defined by Poll
cycle.
6. Define status polling properties: The LWEB-900 Server monitors all LOYTEC devices
to detect if a device is not responding or if the configuration has changed. A web
service is used to check LOYTEC devices and a BACnet service is used for devices of
other manufacturers. The Polling status properties define how often the device is
checked.
7. Define trend and alarm log polling properties: These settings specify how often device
trend and alarm logs are read from the device. This poll cycle has to be configured so
that LWEB-900 reads out the data before the device runs out of memory and overwrites
old data. Usually the devices have enough memory to store log data for several days.
Therefore, it is sufficient to read out log data once a day. A web service is used to
access LOYTEC devices and a BACnet service is used for devices of other
manufacturers.
Note: Using the Starting date and time parameter, you can define at what times a poll cycle is
started.
Name Description
Name Description
In offline mode all functionalities which require communication with the device are
disabled (upload/download device configuration and parameters, refresh data point values,
device backup, firmware update, etc.).
2. The LWEB-900 client status bar indicates the project is now in offline mode.
2. The LWEB-900 client status bar indicates the project is now in online mode.
LWEB-900 Authentication: The user name and password are stored in the LWEB-
900 data base. The LWEB-900 Server performs the authentication.
Access level: This drop-down box defines the default access rights of the user. It is
used to define a role for a user. The following access levels are defined:
o Read: The user can start the LWEB-900 client, but he is not allowed to
modify anything. He can monitor data points in watch views, graphical
views, etc., but he is not allowed to change the values of the data points.
He can see the current parameter values in a parameter view, but he is not
allowed to set the parameters. The user is notified about alarms, but he
does not have the right to acknowledge them. Master schedules can be
viewed but not modified. The user is allowed to open chart and trend log
views, but he cannot edit trend log records.
o Read/Write: The user is allowed to change data point values using e.g.
watch views and graphical views. He can modify and download
parameters using parameter views. The events and calendars of a master
schedule can be configured. The user is allowed to acknowledge and
disable alarms. He can edit trend log records.
E-Mail address: Optional input field for user e-mail address. If an e-mail address
is specified, an alarm receiver is created automatically for the user (see also
Section 6.14.3).
Auto logout time: If the user performs no activity for the specified amount of
time, he is automatically logged out. Set this value to zero to disable the auto
logout function.
Show objects on which the user has no read access: If this checkbox is enabled,
the user sees objects (e.g. folders) to which he has no read access. They are
displayed with a lock icon. If this option is disabled, those objects are not visible in
the navigation and object list view.
Can switch between normal and kiosk mode: If this checkbox is enabled, the
user can switch between normal and kiosk mode using the keyboard combination
Ctrl+Enter or the File menu.
Is the default user: The default user has no password and no auto-logout. If no
username and password is specified in the login-in dialog, the LWEB-900 client
logs in the default user. If a standard user logs out (auto-logout or manual logout),
the default user is automatically logged in. Only the admin user can define/remove
the default user.
Note: The admin user is a special user with the following properties:
The user name of the admin user cannot be changed .
The admin user has access level Full Control and this cannot be changed.
The admin user cannot be assigned to groups.
Access rights do not apply to the admin user.
The admin user cannot be the default user.
4. Click on the Browse icon beside the Usename. The following dialog allows you to
search for users and groups in the Active Directory.
Note: LWEB-900 allows adding a whole Windows group as a Windows authenticated user. This
way it is possible to define the access rights for members of the Windows group in
LWEB-900 and manage the user in Active Directory.
1. Click on the User Management toolbar button and switch to the User Groups tab.
4. Define the group members: The list on the left side of the dialog displays the available
users; the list on the right displays the group members. To add a user to the group,
select the user in the left list and click on the -> button. To remove a user from the
group, select the user on the right side and press the <- button.
Each user can change his full name, description, e-mail address, and password by clicking
on the Edit personal information toolbar button.
LWEB-900 uses access control lists (ACL) to define which operations a user can perform
on a certain object (e.g. folders, data points, visualization view, parameter view, trend
charts). Figure 221 shows the default access control list for objects outside the user’s home
directory.
The access control contains only a single entry: Allow full control to everyone. This ACL
entry is inherited from the parent object. Because full control is the highest access level, the
effective access level for a specific user is determined by the access level settings in the user
management dialog.
1. Right-click on an object (e.g. folder) in the navigation or object list view and select
Access rights from the context menu.
2. Per default an object inherits the access rights from its parent. To remove the inherited
permissions, clear the checkbox Inherit permissions from parent.
3. To add a new ACL entry, click on the button New permission entry. Because the
permission entry is created specifically for this object, this type of entry is called an
explicit permission entry.
4. Select the Group/User for which the permission entry applies. Everyone is a special
group which contains all users.
5. Specify the Access Level (see Table 52). Deny permissions take precedence over allow
permissions.
6. To remove an ACL entry, select it and click Delete. Inherited permission entries cannot
be deleted. Disable the Inherit permissions from parent checkbox instead.
7. To edit an ACL entry, select it and click Edit. Inherited permission entries cannot be
edited.
8. If you want to apply the access level settings to all child objects, click on the button
Replace all child explicit permissions by inherited permissions.
Allow Read The user is allowed to see the value of the object (e.g. data point
value, parameter value).
Allow Write In addition to the permissions granted by Allow Read, the user is
allowed to change the value of the object (e.g. data point value,
parameter value).
Allow Configure In addition to the permissions granted by Allow Read, the user is
allowed to change the configuration of the object (e.g. change
graphical view, add object in folder).
Allow Full Control In addition to the permissions granted by Allow Configure, the
user is allowed to edit the access rights of the object.
Deny Full Control The user is denied to change the access rights of the object.
Deny Configure In addition to the permissions denied by Deny Full Control, the
user is denied to change the configuration of the object (e.g.
change graphical view, add object in folder).
Deny Write In addition to the permissions denied by Deny Configure, the
user is denied to change the value of the object (e.g. data point
value, parameter value).
Deny Read In addition to the permissions denied by Deny Write, the user is
denied to see the value of the object (e.g. data point value,
parameter value).
Table 52: Access Levels
1. If the action is not allowed due to the access level set in the user management dialog
(see Section 6.27), the algorithm stops and the action is denied.
2. If the ACL of the object contains an explicit Deny entry for the requested action, the
algorithm stops and the action is denied.
3. If the ACL of the object contains an explicit Allow entry for the requested action, the
algorithm stops and the action is allowed.
4. If the ACL of the object contains a Deny entry inherited from the parent object, the
algorithm stops and the action is denied.
5. If the ACL of the object contains an Allow entry inherited from the parent object, the
algorithm stops and the action is allowed.
6. Step 4 and 5 are repeated for entries inherited from the next higher hierarchy level until
the top level is reached.
7. If the evaluation has made it to the top of the tree and the action does not have an
Allow or Deny permission, the action is denied.
Note: It is possible to deny a user read access to a folder but allow him access to lower-down
objects. For example, you can setup the access rights to allow Write access to the folder
Network/Devices, but deny access to the folder Network. In this case, the user cannot use
the navigation and object list view to browse the data points on the devices. However, the
user can use a graphical view to modify the referenced data points.
LOYTEC devices and their data point configuration: Because the devices are
engineered using L-Studio, LWEB-900 does not allow modifying them with the
device configuration software.
Graphical views: Graphical views can be imported to a user folder. For graphical
views imported from L-Studio, no data point interface is displayed and they cannot
be modified in LWEB-900.
1. Build the project in L-Studio. The compilation generates the configuration files of the
devices and the graphical views.
3. In the New L-Studio Project dialog (see Figure 224) enter the following data:
Name: User defined name which will be displayed in the navigation view.
L-Studio project file: Select the solution file (.sln) of the L-Studio project.
Global graphical views: Select the destination folder for global graphical views.
Global graphical views can display information from multiple devices. If this field
is left empty, global graphical views are not imported as server graphical views.
Device graphical views: Select the destination folder for device graphical views.
Device graphical views are created in L-Studio for each device instance from the
device CAT (Composite Automation Type). If this field is left empty, device
graphical views are not imported as server graphical views.
4. The imported devices are displayed in the navigation view and you have access to all
data points.
If you have changed your L-Studio project and compiled it, then the project needs to be
updated in LWEB-900.
1. In LWEB-900, select the L-Studio project and choose Update L-Studio Project from
the context menu.
Note The Update L-Studio project context menu item is displayed only if LWEB-900 finds the L-
Studio solution file. If the menu item is missing, select Properties from the context menu
and check the file path.
2. The L-Studio Project Update View displays the changes in the L-Studio project.
Select Update project to import the new files.
7 WEB Access
The graphical views defined in an LWEB-900 project can be accessed with a standard web
browser. In this way it is possible to quickly check the status of the building automation
system while travelling. It makes no difference, whether a smart phone, tablet, or PC is
used.
Note: The port is configured in the network settings of the LWEB-900 server (see Section 5.3).
The default port is 8080.
2. Specify the name of the LWEB-900 project. If the LWEB-900 Server is password
protected, you have to enter the name in a text field, else you are presented with a drop-
down list of the available projects.
4. The web browser displays a list of all graphical views and chart views of the
LWEB-900 project to which you have at least Read access.
2. Android 4.x: Tap on the app panel (six squares) in the upper right of the home screen.
Switch to Widgets and long press on Bookmark.
Older Android versions: Long press on the home screen. From Add to Home Screen,
select Shortcuts and then select Bookmark.
When the graphical view is displayed, just hit + and select Add to Home Screen.
Left click and hold: The left click and hold operation opens the navigation menu
after the time configured in the L-VIS/L-WEB Configurator. Please note that for
correct operation, the left click and hold action should be executed on a free spot
on the display. If the area of an input control is clicked, the control enters input
mode and all further input is processed by the control.
Right click: A right click has the same effect than a left click and hold operation. It
is not available on touch displays.
The navigation menu displays the menu items which were defined in the L-VIS/L-WEB
Configurator and and the “System” entry to open the menu shown in Figure 230.
The Global settings dialog as shown in Figure 231 contains the following settings:
Show error tooltips: If this checkbox is set, a tooltip is displayed showing the
OPC error when hovering over a grayed-out control.
Update control: This setting defines how often data point values are updated. The
default setting is use project settings.
Language: This drop down box allows changing the display language. The new
setting takes effect after reloading the application (CTRL+r).
Default page: If the graphical view contains multiple pages, the default page
which is displayed when opening the view can be selected from this drop-down
list.
Lock project settings: If this checkbox is enabled, a PIN code will be required
before opening the project settings dialog. In addition, no menu entries will be
displayed in the navigation menu. This feature can be used for example to setup a
project with multiple pages where each page controls an office room. The default
page for each user is set to the room in which he is located and then the menu is
disabled. This way each user can control only the own room.
The PIN codes can be configured in the L-VIS/L-WEB Configurator using the
menu File Project Settings. Press the Button Setup Pin Codes… to open the
Access Codes Dialog and set the PIN code for Level 15.
Context menu for data points: If this checkbox is enabled, you can click with
your right mouse button on a control to view data point details. A context menu is
displayed listing the attached data points (see Figure 233). Select the name of the
data point for which you want to inspect the properties as shown in Figure 234.
Mute sound: This option allows disabling sound output for the project.
Autoscale: This option is only available in LWEB-802. The user can always
change the zoom level manually using pinch-zoom or CTRL + mouse wheel. The
autoscale operation is performed for each project load, orientation change, or
resize event. The drop down box contains the following settings:
o Fit in Window: The graphical view is scaled to completely fit into the
browser window.
o Cover Window: The graphical view is scaled to fit either the width or the
height of the browser window so that the whole browser window is
covered.
o Fit Width: The graphical view is scaled to fit the width of the browser
window.
o Fit Height: The graphical view is scaled to fit the height of the browser
window.
7.5 Statistics
The Statistics dialog displays the connection status with the LWEB-900 Server (see
Figure 236).
8 Interfaces
The log_info line specifies the ID and name of the trend log object. The line log_create has
two fields specifying the date and time when this CSV log was generated. The line
log_capacity has two fields: the current number of log entries in the file and the log
capacity.
Following are one or more lines of log_item. Each line specifies a trended data point. The
first field is the index, the second the ID of the logged data point, the third the data point
name. The data point name can be augmented by engineering units in square brackets. Log
entries in the CSV refer to the item index to identify the data point, for which the entry was
logged.
#log_csv_ver,2
#log_device;LOYTEC;Product Code;Firmware Version;Device ID String
#log_info;Log-ID;Log Name
#log_create;YYY-MM-DD;HH:MM:SS
#log_capacity;filled;capacity
#log_item;index;UID;data point name [units]
After those lines any number of comment lines starting with a hash character ‘#’ are
allowed. One line contains the column headings. Lines that are not comments specify one
log record per line, using the column information as described below. The columns are
separated by commas ‘,’ or semi-colons ‘;’. If commas are used as a separator, the decimal
point must be a point ‘.’. If semi-colons are used, the decimal point must be a comma ‘,’.
There are as many value columns as value sources specified in the header. If at a given
date/time more values are logged, all of them appear in the same line. If at that given time
some sources did not log values, those columns are left empty. The “Source” column in a
multi-value CSV refers to the first data source that supplied a value in a given line.
A Path Path of the object relative to the folder from which the file was exported
B Name Name of object
C IK Identification key assigned to the object
D Type Object type
E Description Object description
Table 54: Columns of the Identification Key CSV File.
RecordType int16 The record type: LOGSTATE (0), BOOL (1), REAL
(2), ENUM (3), UNSIGNED (4), SIGNED (5), NULL
(7), ERROR (8), TIMECHANGE (9)
LogId int64 Identifier of the log this data log record belongs to
ItemIndex int16 Index of the item of the log
SeqNum int64 Sequence number assigned to this record when logged
on the server
Value Nvarchar(1024) Logged value, depending on the record type:
Data record (BOOL, REAL, ENUM,
UNSIGNED, SIGMNED): value of the item
Log state record (LOGSTEATE): 1 (log enabled)
or 0 (log disabled)
Error record (ERROR): error code
Time change record (TIME CHANGE): Number
of seconds to clock was put forward or backward
Other: 0
Timestamp int64 Date and time when the record was logged in seconds
since 1.1.1970
Table 58: TrendLog Table
LogId int32 Identifier of the log this alarm log record is attached to
ItemIndex Int16 0
RecordType int16 The record type: LOGSTATE (0), BOOL (1), REAL (2),
ENUM (3), UNSIGNED (4), SIGNED (5), NULL (7),
ERROR (8), TIMECHANGE (9)
Timestamp int32 Date and time the record was logged in seconds since
1.1.1970
SeqNum int64 Sequence number assigned to this record when logged on
the server
XAID Varchar(30) Extended alarm identifier; this identifier is used to
acknowledge the alarm on its source
State Int16 State of the alarm in case the event is an alarm event:
1: active, not acknowledged
2: acknowledged, but still active
3: inactive, but not acknowledged
4: acknowledged and inactive
5: inactive, no acknowledgement required
AlarmType Int16 Type of the alarm:
0: normal
1: off-normal
2: low-limit
3: high-limit
4: fault
5: buffer
Priority Int16 Priority of the alarm
AlarmTime Int64 Date and time in seconds since 1.1.1970 when the alarm
occurred
ClearTime Int64 Date and time in seconds since 1.1.1970 when the alarm
condition was cleared
AckTime Int64 Date and time in seconds since 1.1.1970 when the alarm
was acknowledged
AckSource text Name of the user who acknowledged the alarm
DisableSource text Name of the user who disabled the alarm
AckRequired Boolean True when acknowledgement is required for the alarm,
else False
Description text Textual description associated to the alarm
ValueType int16 Type of the value column:
double (0)
integer (1)
boolean (2)
Value text Value of the data point when the alarm condition was
triggered
PointName text Name of the data point which triggered the alarm
condition
UserId int64 Internal ID of the user who acknowledged or disabled the
alarm.
Comment Text Comment entered by the user when he disables an alarm
Table 59: AlarmLog Table
A user report template is a Zip archive with the (*.rep) file extension. The archive contains
the following files:
To create or modify the RDLC file you need the software Microsoft Report Builder. This
software is an Add-on for Microsoft Visual Studio.
https://www.microsoft.com/en-us/download/details.aspx?id=34673
To get Microsoft Report Builder you can either download the Microsoft SQL Server
Express 2012 with Advanced Services here:
https://www.microsoft.com/en-us/download/details.aspx?id=43351
https://www.microsoft.com/en-us/download/details.aspx?id=35576
1. Select the build-in report template which is most similar to the report template which
you want to create. Right click on the build-in report template and select Export report
template from the context menu.
2. Change the extension of the exported file from .rep to .zip and unzip it.
5. Click with the right mouse button on the folder Library/Report Templates/User
Report Templates and select Import report template from the context menu.
Figure 238: Example of report template XML file with two data groups
TemplateDesc: This xml tag contains the description of the report template
DataSet: Each report template operates on a data set. A data set can contain one or
two groups. This section defines also the parameters which apply to a specific
group.
Common Params
Common parameters are displayed in the report properties on the Parameters tab as shown
in the following screenshot.
paramName: Name of the parameter. This name has to match the name of the
parameter in the .rdlc file.
paramLabel: Label displayed in the Parameters tab of the report properties. If this
attribute is not specified, the parameter is not displayed.
paramType: Parameters can have the special types shown in Table 60. If this
attribute is not specified, the parameter is a generic parameter.
paramType Description
ReportDesc Parameter contains the description of the report as defined in the report
properties
ExecutionTime Parameter contains the date and time when the report was created
Image Parameter to select an image which should be displayed in the report
Generic Any other parameters
Table 60: Attribute paramType for common report template parameters
Data Set
The DataSet element contains one or two DataSetParam elements. The DataSetParam
elements correspond to the groups on the Datalogs tab as shown in Figure 240. The
groupName attribute define the display name for a group.
maxItems: Maximum number of trend log items in this group. If the value is set to
0, an unlimited number of trend log items can be attached.
The ValueMethod element allows defining the default aggregation mode. The following
values are allowed:
periodValueMethod Description
The ReportParam elements define parameters which apply to a specific data group. They
can have the following type:
paramType Description
PeriodFrom Parameter contains the start of the time period for which the report was
created.
PeriodTo Parameter contains the end of the time period for which the report was
created.
StepInterval Parameter contains the step interval of the report.
Color This parameter contains the colors configured for each trend log item in the
data group. A default color palette can be provided in the paramValue
attribute. The colors are encoded in hexadecimal in a RGB color space
(value between: #000000 – black and #FFFFFF - white) and separated by
commas. There should be no space between any characters and the latest
color shall not be followed by a comma.
Table 63: Attribute paramType for data group parameters
Note RDLC files are encoded using XML. However, we do not recommend modifying the file
using a text editor as you could easily break the report file.
You can create an RDLC file from scratch or export a build-in report template as starting
point.
RDLC parameters
Each of the parameters defined in the Report Template XML file has to correspond to a
parameter in the RDLC file.
You can add new parameters in Microsoft Report Builder using the Report Data view
(CTRL + ALT +D when you have a RDLC file open). Name and Data type of RDLC
parameters have to match with the attributes paramName and paramDataType in your
Report Template XML file.
Figure 243: Example of report template with and without (Compare v2) image file
9 Troubleshooting
e-mail : [email protected]
Web : http://www.loytec.com
tel : +43/1/4020805-100
fax : +43/1/4020805-99
or
email: [email protected]
web: http://www.loytec-americas.com
tel: +1 (512) 402-5319
fax: +1 (262) 408 5238
or
email: [email protected]
tel: +886 (2) 8913 7838
fax: +886 (2) 8913 7830
Before you report a bug, make sure your software is up to date. A good bug report includes
the following items:
Description how to reproduce the problem. This is the most important part of the
bug report. The developer has to be able to reproduce the bug on his or her own
computer. Include screenshots to document the steps to reproduce the problem.
System Log: The system log can give useful information about what was
happening at the time when the problem occurred.
2. Right click on the project and select Backup project from the context menu.
3. To minimize the size of the project, select the option Configuration project backup.
10 Specifications
The LWEB-900 Server requires a Windows PC with the following minimum requirements:
2 GHz 32-bit or 64-bit processor
4 GB main memory
50 GB free hard disk space (for program installation and database)
Ethernet access
Operating System:
o Windows 7
o Windows 8
o Windows 10
o Windows Server 2008
o Windows Server 2012
The LWEB-900 Client requires a Windows PC with the following minimum requirements:
2 GHz 32-bit or 64-bit processor
2 GB main memory
1 GB free hard disk space
Ethernet access
Operating System:
o Windows 7
o Windows 8
o Windows 10
o Windows Server 2008
o Windows Server 2012
Minimum display resolution: 1280x720
For the LWEB-900 web access one of the following browsers is required:
Google Chrome (recommended)
Firefox
Internet Explorer 10-11, Microsoft Edge
Android web browser 4.x and later
iOS web browser
11 References
12 Revision History