MergenHub Envest
Home/Docs/User Manual (in-app, complete)

Overview

What Is MergenHub

Version 3.0

MergenHub is a software-based industrial OPC UA aggregation server. It reads data from many field protocols (Modbus, Siemens S7, OMRON, DNP3, IEC 60870-5-104, IEC 61850, MQTT…) and serves it to client applications through a single OPC UA address space and the REST Configuration API. A single interface and a plug-in architecture provide consistent access for both standard and non-standard clients.

It also includes embedded modules: the SCADA/HMI screen editor, Advanced Tags (derived tags / expression engine), Data Bridge, Historian, Alarms & Events and Aliases.

HierarchyChannel → Device → Tag
NorthboundOPC UA Server + REST API + Data Bridge
Southbound9 field drivers (TCP/serial)
Scale450,000+ tags verified
Note Application data (project, settings, logs) is stored by default under C:\ProgramData\MergenHub. Only the MergenHub services (SYSTEM account) and administrators need access to this folder; standard Windows users do not. To open the folder to administrators only, see Hardening the Server.

Architecture

Around a single core, MergenHub bridges northbound clients and southbound field devices:

NORTH — CLIENTS OPC UAClientsREST API /Web UIData Bridge MergenHub Core Scan Engine TagStore (live value) SOUTH — DEVICES (9 drivers) ModbusSiemens S7OMRONDNP3 / 104MQTT
Figure 1 — MergenHub data flow: reading from southbound devices, serving northbound clients.

The core and the modules run as separate Windows services:

MergenHubCore: scan engine + OPC UA Server + REST Configuration API + Web UI.
MergenHubDataBridgeData Bridge (separate process, fed by the core).
MergenHubHistorianHistorian — tag history recording (separate process).

Data flow: the driver reads from the device → the value is written to the TagStore → OPC UA subscribers, REST /runtime/v1/values, IoT/Logger/Alarm and SCADA share the same live value.

Tip Writing works in the opposite direction: OPC/REST/SCADA → write queue → the driver writes to the device → the value is reflected in the cache optimistically right away and verified from the device on the next scan.

Interface Tour

The main sections are reached from the left menu:

ConnectivityChannel/device/tag tree; add, edit, delete, live value/quality.
OPC UA ClientEmbedded QuickClient: discover, browse, read/write, subscribe.
Advanced Tags / Data Bridge / Logger / Alarms / AliasesModules.
SCADAScreen editor + run.
SettingsOPC UA server, security, certificate, REST API, email, firewall.

The Help button in each modal opens quick help for that screen; this Manual covers the whole system.

Branding (your own logo, name, login screen, e-mail template)

Settings → Appearance → Branding. You present the system under your own brand: the login screen, the side panel, the browser tab and every e-mail the system sends appear with your name, logo, colour and texts. The page is a four-step wizard: Identity, Login screen, E-mail template, Summary. Permission: Server settings.

MergenHub line When you enter a company name, a legal company name or a login screen heading, or upload a logo, a small Powered by MergenHub line appears on the login screen and at the bottom of the side panel. This line cannot be turned off; its colour and background are fixed (it stays readable whatever background you choose). The same line is also at the very bottom of e-mails; only the one in e-mails can be turned off with the option in the E-mail template step. While the branding is at its default (no name and no logo) the line is not shown separately.

Using the wizard

  1. Go straight to the step you want with the step buttons at the top (1 Identity, 2 Login screen, 3 E-mail template, 4 Summary); the Back and Next buttons at the bottom do the same. The order is not mandatory.
  2. The Live preview on the right refreshes as you type. The Identity step shows the Side panel and the Login screen, the Login screen step shows the login screen itself, and the E-mail template step shows the sample message of the selected type. In the login screen preview switch the view with the Desktop and Phone buttons.
  3. Text fields are plain text: HTML or style code cannot be entered; everything you type is shown as it is. Colours are in #rrggbb form; pick one from the colour box or type it into the box next to it.
  4. Images are saved the moment they are uploaded. All other fields are saved when you press Save in the Summary step; the number of unsaved changes is shown next to the 4 Summary button.
  5. To set a step up from scratch use the Reset this step to default button below that step (it asks for confirmation; the images of that step are deleted immediately, the other fields become permanent when you press Save).

Step 1: Identity

Company nameShown on the login screen, in the side panel and in the header of e-mails. If empty, MergenHub is written.
Subtitle / taglineShown below the heading on the login screen and below the company name in e-mails.
Site title (tab)The title of the browser tab. If empty, the company name or "MergenHub".
Logo (light background)The login form, the side panel in the light theme, and e-mails. PNG, JPG, WebP, SVG; at most 512 KB. Only PNG and JPG are shown in e-mails; if you upload SVG or WebP the e-mail header shows the company name.
Logo (dark background)The intro section of the login screen and the side panel in the dark theme. If not uploaded, the light background logo is used. PNG, JPG, WebP, SVG; at most 512 KB.
Tab iconThe small icon in the browser tab (a square image is recommended). PNG, ICO, SVG; at most 128 KB.
Accent colourThe colour of button backgrounds, icons and highlights; it is never used as a text colour. The text on top of it (white or dark) is chosen automatically. If the colour is hard to make out on a light or dark background a Warning appears below the box (at least 3:1 is recommended). Use the theme colour removes the selection.
Legal company nameThe official name written in the footer. If empty, the company name is used.
Support e-mail, Support phone, Web addressShown as clickable links in the footer of the login screen and of e-mails. The e-mail takes an address only; the phone takes digits, spaces and + ( ) - . /; the web address must start with http:// or https://.
Support contactA short support note (plain text). Shown below the login form and in the footer of e-mails.
Warning Images can be read without signing in, because the login screen shows them. Do not upload images that contain confidential information. If an SVG file contains a script or an external link the upload is rejected.

Step 2: Login screen

  1. Choose the Layout: Intro on the left, form on the right (default), Card in the centre (the login card only) or Full-screen background with a card (intro texts directly on the background, the form in a separate card).
  2. Choose the Background: Default, Solid colour (Background colour), Two-colour gradient (First colour and Second colour) or Photo (upload it from the Background photo row: PNG, JPG, WebP; at most 3 MB; SVG is not accepted). For a photo, set the density of the dark overlay on top of it with Darkening. In the split layout the background is the backdrop of the intro section on the left; in the other two layouts it covers the whole page.
  3. Logo and texts: Logo size (24 – 96 px), Heading (the large heading in the intro section; if empty, the company name), Welcome text (the heading above the form; if empty, "Welcome back"), Note under the form (a short note below the sign-in button; line breaks are kept).
  4. Card corner radius (0 – 32 px; 0 = sharp corners).
  5. Show the contact details in the footer: when on, the legal company name, support e-mail, support phone and web address are shown below the login form. When off, this information is not sent to the login screen at all.

When you pick a colour, the text on top of it (light or dark) is chosen automatically for readability. The Default button next to number fields returns the value to its default. The preview is the real login screen itself (same code, same style); the buttons inside it cannot be clicked.

The same design (layout, background, logo, footer and the MergenHub line) is also applied to the forgot password and change password screens; only the content of the card changes. The Note under the form is shown on the login screen only.

Step 3: E-mail template

Every e-mail the system sends goes out with this template: logo or company name at the top; greeting, intro text, message and signature in the middle; footer at the bottom. The logo is embedded in the message; the e-mail contains no external resources. For clients that do not display HTML the same content is also sent as plain text.

Header band colourIf empty (No band) the header is white with a thin stripe in the accent colour above it. If you pick a colour the header background takes that colour; the logo is shown inside a white box.
Logo positionLeft or Centre.
Show the logoWhen off, the header shows the company name.
Heading text colourThe colour of the company name in the header. If empty (Choose automatically) white or dark is chosen according to the background.
Body width480 – 720 px (default 600).
Button colour, Button corner radiusThe "Sign in" button in the user invitation e-mail. If the colour is empty (Use the accent colour) the accent colour is used; the text colour on top of it is chosen automatically. To see it in the preview set E-mail type to User invitation.
Greeting lineThe first line of the message (e.g. Hello {{kullanici}},). If the message already starts with a greeting it is not repeated.
Signature blockAppended to the end of the message (multiple lines).
E-mail typeSelect the type; the preview shows the sample message of that type. Types: Alarm notification, Password reset code, User invitation, Announcement (Communication Center), Backup notification, Security alert, Automation e-mail, Test e-mail.
Subject prefix, Intro textApplied to the selected type only. The subject prefix is added to the start of the subject (single line); the intro text is written after the greeting, before the message itself.
Address lines, Legal noteIn the footer, in this order: legal company name, address lines, support contact, support e-mail / phone / web address, legal note.
Show 'Powered by MergenHub' in the e-mail footerOn by default. If you turn it off, the line at the bottom of the e-mail is removed and, in the texts the system itself writes (ready-made subjects and sentences, header, footer), your company name is written instead of MergenHub (the legal company name if there is no company name, "System" if there is neither). The texts you wrote are not touched: if "MergenHub" occurs in an announcement, an automation e-mail, an alarm message or a template text, it stays as it is. It affects e-mail only; the line on the login screen and in the side panel cannot be turned off.
Send test e-mailType the address into the box in the Test e-mail row and press the button. The sample message of the selected type is sent with the saved branding; if you made changes, press Save in the Summary step first. The result is written below the button.

Placeholders. The Insert a placeholder: buttons below the greeting line, signature block, subject prefix and intro text fields insert the placeholder at the cursor. Only the ones that can really be filled are offered:

{{urun}}The company name (MergenHub if there is none).
{{kullanici}}The recipient's user name. It is filled only in messages that go to a single person (password reset, invitation, announcement); in the greeting and the signature it stays empty for the other types ("Hello {{kullanici}}," → "Hello,").
{{tarih}}, {{saat}}The sending date (dd.mm.yyyy) and time (hh:mm).
{{sunucu}}The computer name of the server.

The sender name is the From name field on the Email tab of Settings. If that field is empty or has never been changed ("MergenHub"), the company name is used.

Step 4: Summary

  1. In the Changed fields table review the step, the field and the Saved and New value of every change. Images are not in this list because they are saved the moment they are uploaded.
  2. Look at the Warnings section. Contrast warnings (below 4.5:1 between text and background, below 3:1 for the button and accent colour) do not block saving but reduce readability. Rows marked Must be fixed (an invalid colour or address, a placeholder that cannot be used in that type) must be corrected before saving is possible.
  3. Press Save. The change is visible to all users the next time a page is opened.

Resetting to default, migration and backup

Reset this step to defaultOnly the fields of the step you are on (and the images of that step) return to default. Asks for confirmation.
Reset everything to defaultIt is in the Summary step. The company name, texts, colours, login screen and e-mail design and all uploaded images are deleted; the system appears under the MergenHub brand again. Saved immediately; cannot be undone.
Project packageThe branding (settings, login screen and e-mail design, images) goes into the project package. If the importing system already has a branding or design defined, it is not overwritten and this is reported in the import summary; to use the branding in the package, import in "Replace" mode. If the branding settings in the package do not comply with the rules they are not taken and this is reported.
BackupThe branding settings and images go into the full system backup.
Upgrading from an older versionBranding done in 3.9 and earlier is kept as it is: the login screen stays in the split layout, the e-mail in its old shell. The appearance does not change until you use the new options.
PDF reportsIf the branding has been changed, the company name is written at the top of the PDF and the company name and Powered by MergenHub in its footer (the logo is not printed in the PDF).