Product: Mingcedar CONTROL
Mingcedar Manual | Mingcedar industrial HMI / SCADA runtime
Start with First Configuration, or find a task in the directory for an existing deployment.
<div class="manual-doc-article"><h1 id="mingcedar-industrial-hmi--scada-runtime">Mingcedar industrial HMI / SCADA runtime</h1>
<p>Find installation, device setup and maintenance steps by task.</p>
<blockquote>
<p>Mingcedar manual: page workflows, Devices and Tags, screens, alarms and trends, sites, Python, SDK, access and maintenance.</p>
</blockquote>
<h2 id="manual-snapshot">Manual Snapshot</h2>
<ul>
<li>HMI / SCADA</li>
<li>Web/App · IO · Alarm · Trend · Script</li>
<li>Page workflows and configuration</li>
</ul>
<h2 id="key-facts">Key Facts</h2>
<ul>
<li><strong>Runtime services:</strong> Web/App · IO · Alarm · Trend · Script</li>
<li><strong>Data and extensions:</strong> Tag · Python · IO State API</li>
<li><strong>Manual coverage:</strong> Operation · Configuration · Development · Maintenance</li>
</ul>
<h2 id="choose-by-goal">Choose by Goal</h2>
<p>Choose a task to view its steps.</p>
<div class="doc-goal-grid">
<article class="doc-goal-card">
<span class="doc-goal-icon"><svg viewBox="0 0 24 24" aria-hidden="true" focusable="false"><path d="M12 5a7 7 0 1 0 7 7h-3a4 4 0 1 1-4-4V5Z"></path><path d="M12 2v10h10"></path></svg></span>
<h3>Connect devices and manage Tags</h3>
<span class="doc-goal-cat">Walkthrough</span>
<dl class="doc-goal-lines">
<div><dt>Recommended feature</dt><dd>Device onboarding and Tag management</dd></div>
<div><dt>Why</dt><dd>Add a Device through Protocol → Connection → Verify and Create, then check application, connection and collection.</dd></div>
<div><dt>How</dt><dd>Open Admin → Devices. Viewing needs io:view; editing needs io:manage. Prepare the field protocol, address and Tag map.</dd></div>
</dl>
</article>
<article class="doc-goal-card">
<span class="doc-goal-icon"><svg viewBox="0 0 24 24" aria-hidden="true" focusable="false"><path d="M4 7h16v10H4z"></path><path d="M8 7V4h8v3M8 20h8"></path></svg></span>
<h3>Inspect realtime values and diagnose writes</h3>
<span class="doc-goal-cat">Walkthrough</span>
<dl class="doc-goal-lines">
<div><dt>Recommended feature</dt><dd>Tag Test: monitoring, quality, and writes</dd></div>
<div><dt>Why</dt><dd>Add Tags to the monitor and inspect collected values, quality, time and write results.</dd></div>
<div><dt>How</dt><dd>Location: Configuration Center → Tag Test (io:diagnose permission). Select a Device on the left, browse Tags in the center, and monitor values or initiate writes on the right.</dd></div>
</dl>
</article>
<article class="doc-goal-card">
<span class="doc-goal-icon"><svg viewBox="0 0 24 24" aria-hidden="true" focusable="false"><path d="M5 18V7l7-4 7 4v11l-7 4-7-4Z"></path><path d="M9 12h6M12 9v6"></path></svg></span>
<h3>Publish screens and configure navigation</h3>
<span class="doc-goal-cat">Walkthrough</span>
<dl class="doc-goal-lines">
<div><dt>Recommended feature</dt><dd>Screen files, runtime menus, and popup templates</dd></div>
<div><dt>Why</dt><dd>Upload HTML and assets, configure menus and popup templates, then check runtime data and access.</dd></div>
<div><dt>How</dt><dd>Location: Configuration Center → Screen Files. Viewing requires screen:view; uploads and restores require screen:manage. Prepare a complete Mingcedar Studio export or custom HTML with its assets, preserving relative paths.</dd></div>
</dl>
</article>
<article class="doc-goal-card">
<span class="doc-goal-icon"><svg viewBox="0 0 24 24" aria-hidden="true" focusable="false"><path d="M4 17h16"></path><path d="m6 14 4-4 3 3 5-7"></path></svg></span>
<h3>Connect Sites and select capabilities</h3>
<span class="doc-goal-cat">Walkthrough</span>
<dl class="doc-goal-lines">
<div><dt>Recommended feature</dt><dd>Sites and the four shared capabilities</dd></div>
<div><dt>Why</dt><dd>Connect Mingcedar servers, choose Screens, IO, Alarm and Trend sources, and set the Device scope.</dd></div>
<div><dt>How</dt><dd>Open Configuration Center → Sites. Each Site contains services, Devices, Tags and configuration, and can join others to use their capabilities. In this example, configure A to read B.</dd></div>
</dl>
</article>
<article class="doc-goal-card">
<span class="doc-goal-icon"><svg viewBox="0 0 24 24" aria-hidden="true" focusable="false"><path d="M4 5h16v12H4z"></path><path d="M9 21h6M12 17v4"></path></svg></span>
<h3>Build a custom runtime page</h3>
<span class="doc-goal-cat">Walkthrough</span>
<dl class="doc-goal-lines">
<div><dt>Recommended feature</dt><dd>Page SDK: quick start</dd></div>
<div><dt>Why</dt><dd>Use the Page SDK to read Tags, write setpoints, and query alarms and trends. The HTML and Vue examples require project Tag codes and permission checks before publishing.</dd></div>
<div><dt>How</dt><dd>Upload HTML to Screen Files and open it from a runtime menu. Runtime loads the SDK; no npm package or extra script is needed. Call ready() once and reuse api.</dd></div>
</dl>
</article>
<article class="doc-goal-card">
<span class="doc-goal-icon"><svg viewBox="0 0 24 24" aria-hidden="true" focusable="false"><path d="M8 12h8M12 8v8"></path><path d="M4 12a4 4 0 0 1 4-4h1M20 12a4 4 0 0 1-4 4h-1"></path></svg></span>
<h3>Run Python and install dependencies</h3>
<span class="doc-goal-cat">Walkthrough</span>
<dl class="doc-goal-lines">
<div><dt>Recommended feature</dt><dd>Python Projects and Packages</dd></div>
<div><dt>Why</dt><dd>Use CPython 3.13 to create projects, reuse functions, install dependencies, read Tags, configure events, and authorize writes.</dd></div>
<div><dt>How</dt><dd>Confirm the Script service is available. Code management requires super-admin and integration:manage; Run Test also requires integration:execute. Python Packages requires system:view and system:manage. Follow the exercises for calculations, dependencies, events, and Tag access.</dd></div>
</dl>
</article>
<article class="doc-goal-card">
<span class="doc-goal-icon"><svg viewBox="0 0 24 24" aria-hidden="true" focusable="false"><path d="M6 5h12v14H6z"></path><path d="M9 9h6M9 13h4"></path><path d="m15 17 3 3 3-3"></path></svg></span>
<h3>Connect a read-only external client</h3>
<span class="doc-goal-cat">Walkthrough</span>
<dl class="doc-goal-lines">
<div><dt>Recommended feature</dt><dd>IO State API: authorization, exact reads, and streaming</dd></div>
<div><dt>Why</dt><dd>Create a Profile and Access Key, read SignalRefs, obtain a single-use Ticket, and subscribe through WebSocket.</dd></div>
<div><dt>How</dt><dd>Prepare an IO State-enabled HTTPS URL, healthy Tags, and an io:manage account. Clients read collected state; the API neither polls PLCs nor provides writes, alarms, or historical trends.</dd></div>
</dl>
</article>
<article class="doc-goal-card">
<span class="doc-goal-icon"><svg viewBox="0 0 24 24" aria-hidden="true" focusable="false"><path d="M12 5a7 7 0 1 0 7 7h-3a4 4 0 1 1-4-4V5Z"></path><path d="M12 2v10h10"></path></svg></span>
<h3>Save configuration and verify application</h3>
<span class="doc-goal-cat">Walkthrough</span>
<dl class="doc-goal-lines">
<div><dt>Recommended feature</dt><dd>Device and Tag configuration: save, apply, and verify</dd></div>
<div><dt>Why</dt><dd>Device and Tag saves automatically start application. Check save, application, connection and Tag data in order.</dd></div>
<div><dt>How</dt><dd>Location: Configuration Center → Device Management or Tag Management. Edit the required object in the current local Site.</dd></div>
</dl>
</article>
<article class="doc-goal-card">
<span class="doc-goal-icon"><svg viewBox="0 0 24 24" aria-hidden="true" focusable="false"><path d="M4 7h16v10H4z"></path><path d="M8 7V4h8v3M8 20h8"></path></svg></span>
<h3>Query and export event records</h3>
<span class="doc-goal-cat">Walkthrough</span>
<dl class="doc-goal-lines">
<div><dt>Recommended feature</dt><dd>Event records: query, trace, and export</dd></div>
<div><dt>Why</dt><dd>Trace operations by time, actor, subject and outcome. Query event records, alarm history and trends separately.</dd></div>
<div><dt>How</dt><dd>Location: Configuration Center → Event Records (event:view permission). The default scope is User operations and the initial period is the last 30 days. Search, outcome, and record-scope filters apply to loaded records.</dd></div>
</dl>
</article>
<article class="doc-goal-card">
<span class="doc-goal-icon"><svg viewBox="0 0 24 24" aria-hidden="true" focusable="false"><path d="M5 18V7l7-4 7 4v11l-7 4-7-4Z"></path><path d="M9 12h6M12 9v6"></path></svg></span>
<h3>Configure archival and data retention</h3>
<span class="doc-goal-cat">Walkthrough</span>
<dl class="doc-goal-lines">
<div><dt>Recommended feature</dt><dd>Data retention: periods and execution</dd></div>
<div><dt>Why</dt><dd>Set event, alarm, raw-trend and rollup retention to project requirements, then check background execution.</dd></div>
<div><dt>How</dt><dd>Location: Configuration Center → Data Retention (retention:manage permission).</dd></div>
</dl>
</article>
</div>
<h2 id="before-you-start">Before You Start</h2>
<p>Start with First Configuration, or find a task in the directory for an existing deployment.</p>
<div class="doc-card-list">
<article class="doc-card">
<h3 id="preface-item-1">Runtime services</h3>
<p>Web/App provides browser access; IO collects device data; Alarm, Trend and Script handle alarms, history and project logic. Check services and data infrastructure in System Status.</p>
</article>
<article class="doc-card">
<h3 id="preface-item-2">Administration</h3>
<p>Configure Devices, Tags, calculated Tags, screen files, menus, popups, sites, access, languages and integrations. Entries depend on account permissions and installed modules.</p>
</article>
<article class="doc-card">
<h3 id="preface-item-3">Runtime pages</h3>
<p>Open project screens, alarms and trends through runtime menus. Reading, alarm acknowledgement and device writes follow their respective access and action permissions.</p>
</article>
<article class="doc-card">
<h3 id="preface-item-4">Settings</h3>
<p>Manage display and operation, collection, Python, site connections and video. Preferences, alarm categories and collection policies save independently; other fields apply as indicated.</p>
</article>
</div>
<h2 id="tutorial">Initial configuration workflow</h2>
Check services and licensing, connect data, publish screens and configure access.
<div class="doc-card-list">
<article class="doc-card">
<h3>1. Confirm endpoints and services</h3>
<p>With a management account, open Admin → System Status and check the Site, version, five services, database and Redis, then the License page. Set language in the header; manage users and roles in Access Control.</p>
</article>
<article class="doc-card">
<h3>2. Create Devices and Tags</h3>
<p>Create a local protocol-specific Device and check application and connection. Add Tag codes, addresses and types; full codes use DeviceCode.TagCode. Verify value, quality and time in Tag Diagnostics before adding alarms, trends, calculations or scripts.</p>
</article>
<article class="doc-card">
<h3>3. Publish screens and configure access</h3>
<p>Upload and publish the complete screen directory with relative paths intact. Configure menu name, entry, order, login and required popups. Check screens, data and actions with an operator account. For remote capabilities, connect Sites and select scope.</p>
</article>
</div></div>