Manual coverage: Operation · Configuration · Development · Maintenance
Choose by Goal
Choose a task to view its steps.
Connect devices and manage Tags
Walkthrough
Recommended feature
Device onboarding and Tag management
Why
Add a Device through Protocol → Connection → Verify and Create, then check application, connection and collection.
How
Open Admin → Devices. Viewing needs io:view; editing needs io:manage. Prepare the field protocol, address and Tag map.
Inspect realtime values and diagnose writes
Walkthrough
Recommended feature
Tag Test: monitoring, quality, and writes
Why
Add Tags to the monitor and inspect collected values, quality, time and write results.
How
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.
Publish screens and configure navigation
Walkthrough
Recommended feature
Screen files, runtime menus, and popup templates
Why
Upload HTML and assets, configure menus and popup templates, then check runtime data and access.
How
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.
Connect Sites and select capabilities
Walkthrough
Recommended feature
Sites and the four shared capabilities
Why
Connect Mingcedar servers, choose Screens, IO, Alarm and Trend sources, and set the Device scope.
How
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.
Build a custom runtime page
Walkthrough
Recommended feature
Page SDK: quick start
Why
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.
How
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.
Run Python and install dependencies
Walkthrough
Recommended feature
Python Projects and Packages
Why
Use CPython 3.13 to create projects, reuse functions, install dependencies, read Tags, configure events, and authorize writes.
How
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.
Connect a read-only external client
Walkthrough
Recommended feature
IO State API: authorization, exact reads, and streaming
Why
Create a Profile and Access Key, read SignalRefs, obtain a single-use Ticket, and subscribe through WebSocket.
How
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.
Save configuration and verify application
Walkthrough
Recommended feature
Device and Tag configuration: save, apply, and verify
Why
Device and Tag saves automatically start application. Check save, application, connection and Tag data in order.
How
Location: Configuration Center → Device Management or Tag Management. Edit the required object in the current local Site.
Query and export event records
Walkthrough
Recommended feature
Event records: query, trace, and export
Why
Trace operations by time, actor, subject and outcome. Query event records, alarm history and trends separately.
How
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.
Configure archival and data retention
Walkthrough
Recommended feature
Data retention: periods and execution
Why
Set event, alarm, raw-trend and rollup retention to project requirements, then check background execution.
How
Location: Configuration Center → Data Retention (retention:manage permission).
Before You Start
Start with First Configuration, or find a task in the directory for an existing deployment.
Runtime services
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.
Administration
Configure Devices, Tags, calculated Tags, screen files, menus, popups, sites, access, languages and integrations. Entries depend on account permissions and installed modules.
Runtime pages
Open project screens, alarms and trends through runtime menus. Reading, alarm acknowledgement and device writes follow their respective access and action permissions.
Settings
Manage display and operation, collection, Python, site connections and video. Preferences, alarm categories and collection policies save independently; other fields apply as indicated.
Initial configuration workflow
Check services and licensing, connect data, publish screens and configure access.
1. Confirm endpoints and services
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.
2. Create Devices and Tags
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.
3. Publish screens and configure access
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.
