Installation Guide elproMONITOR 3.2.0

Installation Guide elproMONITOR 3.2.0

Information

Important information and warnings

DELETE

Windows function, e.g. Delete

<xxxxxxxx>

Syntax for placeholders.
Placeholders are written between < > characters.

>>

Reference to a further chapter or document.

Path (e.g. Control > Panel > System > Remote).

Italic

Windows window text

underlined

Input during installation

The representation refers only to a part of the user interface.

In the interest of our customers, we reserve the right to make changes based on technical advances. Therefore, schematics, descriptions and scope of delivery may be changed without prior notice. This manual is valid as of version 2017.

Liability

  • ELPRO-BUCHS AG does not accept any liability for direct, indirect, special, incidentally occurring, randomly occurring or subsequent damage or losses including lost profit or data resulting from the use of their data loggers, sensors, accessories, software products or information from the documentation.

  • ELPRO-BUCHS AG does not bear any responsibility for the installation of the software products.

  • ELPRO-BUCHS AG does not provide any guarantees, either explicit or implicit, regarding the usability or suitability of their products for a specific purpose.

  • In the interest of our customers we reserve the right to make changes and discontinue the product on the basis of technical advancement. For this reason, functionalities, charts, descriptions, and scopes of supply can be modified without prior notification.

  • As individual countries or states do not permit the concept of an implicit warranty or a liability disclaimer for incidental or subsequent damage, the restrictions and disclaimers may not apply to all customers. If one of the provisions of this warranty is declared by a competent court to be invalid or not enforceable, this does not affect the validity or enforceability of the remaining provisions.

  • ELPRO-BUCHS AG does not accept any liability for transport damage.

  • In general the statutory regulations of Switzerland apply. The place of jurisdiction is the district court of Werdenberg-Sarganserland.

Guarantee

  • The guarantee obligations of ELPRO-BUCHS AG are limited to reworking, reimbursement of the purchasing price, repair free of charge or the replacement of a faulty product that is returned within the guarantee period to ELPRO-BUCHS AG or an approved reseller of ELPROBUCHS AG.

  • There is no obligation to provide on-site customer support by an employee of ELPRO-BUCHS AG.

  • The guarantee is only applicable to the original purchaser or end user and customer of an approved reseller of ELPRO-BUCHS AG.

  • Resellers approved by ELPRO-BUCHS AG are not authorized to enter into any extended or different guarantee obligations in the name of ELPRO-BUCHS AG.

  • ELPRO-BUCHS AG provides a guarantee of 24 months on the following new products:

    • Data loggers

    • Holders

    • Accessories except probes and third party products

  • This guarantee is valid for material faults or production faults.

  • ELPRO-BUCHS AG provides a guarantee of 6 months for the following products and services:

    • All service work and repair

    • Temperature sensor

    • Humidity sensor

  • ELPRO-BUCHS AG provides a 90 day guarantee that the medium on which the software product is supplied is free from material and processing faults under normal conditions. All main items of the software product comply with the operating instructions and the information in the help file.

  • The guarantee does not apply to consumables, disposable batteries or any other product that ELPRO-BUCHS AG deems to be:

    • Misused

    • Modified

    • Replaced by an incorrect product

    • Or damaged by accident or operating or handling conditions that are not compliant with specifications.

  • Wear, cable breakage and corrosion are not covered by the guarantee.

  • ELPRO-BUCHS AG provides the guarantee period of the manufacturer for third party products.

  • ELPRO-BUCHS AG only provides a guarantee and customer support for discontinued products for a limited period.

  • Repair work covered by the guarantee is solely carried out at the works (ELPRO-BUCHS AG) or by an agent approved by the works.

  • ELPRO-BUCHS AG does not offer any guarantee for the standard or SCS calibration of the data loggers and probes. The stated data correspond to the situation during the calibration process.

Software

  • The software products of ELPRO-BUCHS AG are subject to internal quality requirements and are validated regularly at the works. In the event of program errors, circumvention of the error is regarded as constituting its elimination.

  • Software manuals do not contain either instructions on basic operation of a computer or the basic functions of the Windows® operating system.

  • For information on the operation of the computer or the operating system please refer to the applicable computer manuals.

  • 21 CFR 11 compliance see: 20140815 Impact of CRF 21 Part 11 on elproMONITOR. This document is obtainable from ELPRO-BUCHS AG

Data loggers, sensors and accessories

  • ELPRO-BUCHS AG applies the highest quality standards during production of the data loggers and their accessories as well as a certified quality management system in compliance with ISO 9001.

  • For information on operation of the data loggers and their accessories please refer to the respective product documentation.

  • During the installation of data loggers, probes and accessories, compliance with the locally valid installation regulations is mandatory.

  • When used in potentially explosive atmospheres, the zone category and the application and safety instructions of ELPRO-BUCHS AG must be complied with.

  • In the event of a guarantee claim, customers receive a repair cost estimate from ELPRO-BUCHS AG to obtain the corresponding consent before starting work.

  • The customer will bear the transport costs incurred for any repairs carried out by ELPRO-BUCHS AG. The DAP (value added tax) is borne by ELPRO-BUCHS AG.

  • ELPRO-BUCHS AG reserves the right to invoice the customer for costs incurred for repair/part replacement.

  • After repair work the product is returned to the purchaser, who will be charged with the return shipping costs (FOB shipping point).

Trademarks

  • All stated company and product names and their trademarks are the protected property of the respective owner.

CHANGES OR MODIFICATIONS TO THIS PRODUCT WILL VOID THE ETSI / FCC APPROVAL TO OPERATE THIS PRODUCT. THIS PRODUCT COMPLIES WITH PART 15 OF THE FCC REGULATIONS AND RSS-210 INDUSTRY CANADA. OPERATION IS SUBJECT TO THE FOLLOWING TWO CONDITIONS: (1) THE PROUDUCT MUST NOT CAUSE HARMFUL INTERFERENCE. (2) THE PROUDUCT MUST ACCEPT ANY INTERFERENCE RECEIVED, INCLUDING INTERFERENCE THAT MAY CAUSE UNDESIRED OPERATION.

  • This product is subject to CE marking.

  • The manufacturer guarantees the conformity of this product to the corresponding directives: EN 61000-6-2 : 2001 and EN 61000-6-4 : 2001

  • FCC ID: Z45-E11645398

  • IC: 9954A-E11645398

  • This product must be disposed of in accordance with WEEE (Waste electrical and electronic equipment, 2002/ 96/EC)!


image-20251112-141712.png

 

1. System Requirements

This manual is based on Windows Server 2019 (ENU) and SQL Server 2019 (ENU). If you use other Windows versions, some details may vary from the instructions in this manual.

For Windows Server and client oprating systems like Windows 10/11 only English and German are supported!

It is important to copy the customised settings from the Appsetting.json before starting the update. After the update, these settings must be inserted again.

SQL Server compatibility level 130 and above is required

Before running the installation, check the server compatibility with this script: …Setup Files\database\check_sql_server_compatibility.sql

Increase the database's compatibility level to at least SQL Server 2016 (130) if it is incompatible

Risk of data loss when updating to elproMONITOR 3.2.x

MeasureRawValue

  • Removed as it is. It is a temporary table for measurements that are accepted from the device, but still unprocessed by elproMONITOR

  • The substitute for this table is called MeasurementRawMessageQueue, which contains the measurement messages, as they are, without any unnecessary conversion.


It must be checked that table MeasureRawValue is empty before the service is stopped and the update is started.

Recommendation: Stop the service at approx. 00:30s, then all values in the table should be processed.
Nevertheless, you must check whether the table is empty before updating.

Digital Ouput Incompatible database entries

In the elproMONITOR version for 2.1.1 and below, the DO entries in the database were saved in the wrong format. This leads to an error when updating to elproMONITOR 3.2.x

The following steps must be carried out before the installation.

  1. Execute the following script to check the entries: …Setup Files\database\detect_malformed_4do_modules.sql

    1. If no entries are found, the installation can be started

    2. If entries are found, carry out step 2

  2. run the following script to correct the format of the entries: …Setup Files\database\fix_malformed_4do_modules.sql

  3. run the following script again: …Setup Files\database\detect_malformed_4do_modules.sql

    1. If no entries are found, the installation can be started

    2. If entries are still found, please contact support

WebAccess with PHP 8.4

layout.php - with configured RBR. The logger ID must be placed in double inverted commas and single inverted commas!

image-20250220-133224.png
image-20250220-133340.png

1.1. Supplied Program Packets

The list below contains the software packets supplied.

SW Module

Description

Directory

 

SW Module

Description

Directory

 

elproMONITOR Service

Service which reads the measuring values out of the loggers and writes them to the database.

elproMonitor_<version>.zip/elproMONITOR

 

elproMONITOR SQL Script

SQL script which is needed to create the schema for the elproMONITOR database.

elproMonitor_<version>.zip/Setup Files/database/…

 

Management Tool

The Management Tool is needed to create the configuration XMLs and to enter and activate the license key.

elproMonitor_<version>.zip/Setup Files/tools/elproMONITOR Management Tool

 

MSVC Redistributables

Redistributables which are needed to execute elproMONITOR.

elproMonitor_<version>.zip/Prerequisites/…

 

elproEVENT Application

The elproEVENT application.

elproEvent_<version>.zip/elproEvent

 

elproEVENT SQL Script

SQL script which is needed to create the schema for the elproEVENT database.

elproMonitor_<version>.zip/Setup Files/databas/EventSchema.sql

 

elproUSER Service

Service that uses rights and user management.

elproUser_<version>.zip/Program Files/elproUSER<Versionsnumber>/UserService

 

elproUSER SQL Script

SQL script which is needed to create the schema for the elproUSER database.

elproMonitor_<version>.zip/Setup Files/databas/UserSchema.sqll

 

RabbitMQ Service

Service, which communicates with the ECOLOG-PRO Radio Module via MQTT protocol.

elproMonitor_<version>.zip/prerequisites/RabbitMQ
See >> 4.6. RabbitMQ Installation

 

ProModuleConfigurator

Configuration tool for editing the ECOLOGPRO modules

elproMonitor_<version>.zip/support-tools/shared/ProModuleConfigurator

 

RBRConfigurator (BridgeConfigurator)

Configuration tool for set-up and editing the ECOLOG-PRO RBR and ECOLOG-PRO NBR Modules

elproMonitor_<version>.zip/Setup Files//EcologPRO Radio configurator

 

3. Definition of Target System

Before you start the installation, define how the target system should look like.

3.1. Default Proposal to Create New Users

User

Access Rights

User

Access Rights

elproMonitorDBUser

Dedicated user for the elproMONITOR application database. Has read/write rights to this database.

elproEventDBUser

Dedicated user for the elproEVENT application database. Has read/write rights to this database.

elproUserDBUser

Dedicated user for the elproUSER application database. Has read/write rights to this database.

 In addition, read-only rights must be granted for the following tables in the elproMONITOR and elproEVENT application databases.

  • Applications

  • FunctionNames

  • Functions

  • Languages

  • Resources

elproUser

Optionally, you can create a Windows user.

Is the executing user of the elproMONITOR Service, elproEVENT, and elproUSER.

3.2. Default Proposal to Create New Databases

Database

Description

Database

Description

elproMONITOR

Database for the elproMONITOR application.

elproEVENT

Database for the elproEVENT application.

elproUSER

Database for the elproUSER application.

3.3. Default Proposal to Create Directories

Name

Description

Default Path Proposal

Name

Description

Default Path Proposal

Program Directory

Programs are installed in the default program directory.

C:\Program Files\ELPRO

Configuration Directory

Stores database access configurations

C:\ProgramData\ELPRO\License

Web Application Directory

For safety reasons, we urgently advise you to install the web client application in the official web publication directory.

It is possible to install the web application together with IIS on a separate computer. The installation directory relates to this computer

C:\ProgramData\ELPRO\Websites

4. Installing the Basic System

4.1 Server

4.1.1. Server Setup

  • Standard server installation

  • Configure server name

    Control Panel → System → Change Settings → Computer Name → Change

    • Enter new name:
      e.g. MONITOR

4.1.2. Firewall Configuration

4.1.2.1. Activate Remote Desktop Service

  • Remote Desktop
    Control Panel → System → Change settings → Remote → Remote Desktop

    • Allow
      Allow remote connection on this computer only from computers running Remote Desktop with Network Level Authentication.

  • Firewall Rules
    Control Panel → Windows Firewall → Advanced Settings → Inbound Rules

    • Allow
      Remote Desktop - User Mode (TCP-In) Profile Public

4.1.2.2. Allow Ping

  • Firewall Rules
    Control Panel → Windows Firewall → Advanced Settings → Inbound Rules

    • Allow
      File and Printer Sharing (Echo Request - ICMPv4-In)

4.1.2.3. Firewall ports and protocol overview

No

Protocol

Port

Description

No

Protocol

Port

Description

1

TCP

502

Configuring and pulling measurements and status information from ecologPro devices

2

TCP

1883

Pushing measurements and status information to RabbitMQ broker

UDP

1883

RBR time synchronization service

3

TCP

502

Configuring and pulling measurements and status information from Apex Particle Counter devices

4

TCP

2101

Configuring and pulling measurements and status information from ecologNET devices

5

TCP

Default: 10001

elproMONITOR configuration
Sending SMS notifications

6

TCP

1433

Application SQL database connection

7

TCP

80/443/81

Client access to elproMONITOR, elproUSER and webAccess applications

8

TCP

443

Sending e-mail notifications via Office 365’s Graph Api

9

TCP

587

Sending e-mail notifications via a configured SMTP server

10

TCP

22123

Initial configuration for RBR devices

11

UDP

30718

Initial configuration for LBR devices

12

TCP

1883

Pushing measurements and status information to RabbitMQ broker

UDP

1883

NBR time synchronization service

4.1.2.4. Firewall Rules

Application Server

Dedicated webserver is not supported therefore Port 8000 should be closed as opposed to previous versions

Requires tcp port 443 to be open (https), optionally port 80 (http) and 81 (WebAccess).

Requires tcp port 1883 (MQTT) for RBR devices to be able to push messages to RabbitQq, this port is configurable in RabbitMQ configuration and ElproMonitor database.

Requires udp port 1883 for RBR devices to synchronize time with the Application server. This port follows the previous one, just uses udp protocol.

Optionally tcp port 15672 could be opened to give access to RabbieMQ’s web management interface.

EcologPro LBR

EcologPro LBR devices are accessed through the default modbus tcp port 502.

EcologPro RBR

EcologPro RBR devices are initially configured with the Radio Configurator tool via tcp port 22123.

Apex Particle Counter

Apex Particle Counters are accessed through the default modbus tcp port 502.

EcologNet

EcologNet devices are accessed through tcp port 2101.

SMS modem

The tcp connection parameters for the SMS modem are configured inside ElproMonitor’s Settings/SMS page.

SQL Database

For the SQL database connection the default tcp port 1433 is used, it is configured inside a connection string under ElproMONITOR’s install folder, appsettings.json file.

ElproMonitor Management Tool’s Test Connection function also uses tcp port 1433 to check the connection via the provided configuration.

Graph Api

ElproMonitor (Application server) needs access to the world wide web in case e-mail notifications are configured to use Microsoft’s Office 365 Graph Api under Settings/E-Mail page.

SMTP server

When SMTP E-mail notification is configured in ElproMonitor Settings/E-Mail page, ElproMonitor needs access to the SMTP server configured on the page.

4.2 IIS Installation

IIS must be installed on the computer on which the web application is to run.

  • Start Server Manager.

  • Right-click Roles → Add Roles in order to start the Add Roles Wizard.

    • Depending on the version of the Windows Server, select Installation Type Rolebased or feature based installation