Introduction to the Edge Portal
Get familiar with the Edge Portal after signing in, navigate the header and sidebar, and see what each menu is used for.
After signing in to the Edge Portal, you arrive at the Overview page. This is the starting point for checking the gateway, opening configured instances, and navigating to the available configuration and diagnostic pages.
This guide introduces the main parts of the interface and explains what each menu is used for. Follow the links for detailed instructions.
Get familiar with the interface
The interface consists of a header, a sidebar, and the page currently open in the main workspace.
- Header - Shows the software version, system status, internet connection status, notifications, and user menu.
- Sidebar - Provides access to the Workspace, Configuration, Instances, Data Interfaces, and Tools menus.
- Main workspace - Displays the page selected from the sidebar.
Select the sidebar button in the header to collapse or expand the navigation. You can also expand or collapse each menu group independently.
Understand the header
The header remains available while you navigate the Edge Portal.
System version and status
Select the displayed system version to see installed component versions and the current system status.
Depending on the condition of the gateway, the status can indicate:
- Up to date
- Information
- Update available
- Attention needed
- Action required
Trial installations can also display the remaining trial time, cooldown period, or an option to restart the trial.
Internet connection status
The router indicator beside the system version shows whether SIA Connect can access the internet. Point to the indicator or focus it with the keyboard to see one of these messages:
- SIA Connect is connected to the internet - Internet access and hostname resolution are available.
- SIA Connect is connected but cannot resolve hostnames - The gateway has IP connectivity, but hostname resolution is unavailable.
- SIA Connect is offline, not connected to the internet - The gateway cannot reach the internet.
- Checking SIA Connect internet access... - The portal is retrieving the current connection state.
Notifications
Connection and system notifications appear below the header when attention is required.
If communication with the gateway is lost, the portal continues to show the last received data while attempting to reconnect.
Some notifications can include an action, such as opening the relevant configuration page or restarting the device. Dismissal and restart controls depend on your permissions.
User menu
Select your username in the upper-right corner to access:
- Theme - Use the system, light, or dark theme.
- Menu icons - Show icons only when the sidebar is collapsed or always show them.
- Refresh cache - Clear the portal cache and reload the interface.
- Log out - End your session and return to the sign-in page.
The menu also shows your username and role, such as Administrator, Operator, or Custom.
Workspace
Use Workspace to get an overview of the gateway and see how data moves between configured instances.
| Menu | What you can use it for |
|---|---|
| Overview | View gateway information, configured instances, resource usage, software and license status, and common system actions. |
| Data Flow (Experimental) | See how instances are connected by mappings and open their details. |
Configuration
Use Configuration to install communication components and manage the gateway.
| Menu | What you can use it for |
|---|---|
| Connectors | Find, install, update, configure, disable, or uninstall Connectors. |
| System | Manage system settings, time, updates, licensing, configuration backups, advanced settings, and logs. |
| Network | View and change the hostname and network-interface settings, and review network events. |
| Events | View, search and filter all notifications and lifecycle events on the device |
| Users | Create and manage local users, roles, permissions, and credentials. |
| Device Manager (Soon) | This planned page will provide remote management of SIA Connect installations. It is currently unavailable. |
Instances
Use Instances to view and manage the connections created from installed Connectors. The category menus filter the same instance list by connection type.
| Menu | What you can use it for |
|---|---|
| All instances | View, search, open, disable, or delete configured instances across all categories. |
| Industrial | Show instances for industrial devices, controllers, and other operational technology connections. |
| Cloud & APIs | Show instances for cloud services and API connections. |
| Databases | Show instances for database connections. |
After opening an instance, you can work with its configuration, items, files, and mappings. See Create and edit items and Create and edit mappings.
Data Interfaces
Use Data Interfaces to make SIA Connect data available through supported server interfaces.
| Menu | What you can use it for |
|---|---|
| OPC UA | Create and manage OPC UA servers, including their data, security, and certificate settings. |
| Modbus TCP (Soon) | This planned page will provide Modbus TCP server functionality. It is currently unavailable. |
Tools
Use Tools for network diagnostics, remote access, certificate enrollment, APIs, and container applications.
| Menu | What you can use it for |
|---|---|
| Ping | Test whether SIA Connect can reach an IP address or hostname. |
| Remote Access | Install, configure, start, stop, and review supported remote-access services. |
| DigiCert ONE IoT Trust | Configure DigiCert ONE IoT Trust and manage device-certificate enrollment. |
| Shadow API | Configure the MQTT connection, account settings, and certificates used by the Shadow API. |
| Containers | Check Docker availability and manage installed container applications. |
| Dashboards | Open the installed dashboard application. The Edge Portal can start its container when required. |
| App Hub | Open the container application manager to install and manage supported applications. |
The availability of container-based tools depends on the software edition, gateway installation, and installed applications.
Use the sidebar footer
The bottom of the sidebar provides additional navigation:
- Switch to Legacy Edge Portal - Opens the previous version of the portal.
- Support - Searches the SIA Connect documentation or opens the complete help center.
- sia-connect.com - Opens the SIA Connect website in a new browser tab.