Tools

Troubleshoot machine connections with Network checks, the Request Browser, Device Validation, the SHDR Browser, and the Definition Browser.
MTConnect Server Docs Menu

The App's Tools troubleshoot connections to machines and their Devices. They're free to use, with no License. Every check is made from the computer MTConnect Server is installed on, the same computer that connects to the Agents and Adapters, so results can differ from the computer your browser is on.

Network

Tools > Network has four tabs. The Hostname is shared by the tabs, so a host can be pinged and then have its ports checked.

Port Check identifying an MTConnect Agent and HTTP servers, with closed and blocked ports
Port Check identifying an MTConnect Agent and HTTP servers, with closed and blocked ports
TabDescription
PingSends a ping (ICMP Echo) once a second, 4, 10, or 50 times, or until stopped. Shows each reply's address, time, and TTL, the number sent, received, and lost, and the minimum, average, and maximum times. Many machines and firewalls block ping, so no reply doesn't always mean the host is down
Port CheckConnects to a TCP port and shows whether it's Open, Closed (refused, so the host is reachable but nothing is listening), or gives No Response (blocked by a firewall, or the host is down). It also identifies what answered: an MTConnect Agent (with its version, number of Devices, and sender), an SHDR Adapter (with its Heartbeat), or another HTTP Server. 5000 Agent and 7878 SHDR set the common ports
DNS LookupResolves a Hostname to its IP addresses with the server's DNS, or an IP address to its Hostname
Server NetworkThe server's Hostname and domain, and its network adapters: addresses, gateway, DNS servers, type, speed, DHCP or static, and MAC address
  • Use Port Check to test an MTConnect Agent or Adapter. It's more reliable than Ping, which is often blocked. An Agent it finds links to the Request Browser, and an Adapter to the SHDR Browser.
  • A Port Check connects for a moment. An Adapter that only accepts one client can briefly disconnect the MTConnect Agent reading from it.
  • Each check is a single host and port. The Tools don't scan ranges of addresses or ports.

Request Browser

Tools > Request Browser sends MTConnect requests to an Agent and shows what the Agent is serving now (Collection > Data shows what Collection has stored). Only GET requests are made, so nothing is changed on the Agent.

The Request Browser showing the latest Observations from a current request
The Request Browser showing the latest Observations from a current request

Enter the Agent's address (ex. localhost:5000), choose current, sample, or probe, and click Send. A Device (name or UUID) and a path (XPath) can be added to any request, from and count to a sample, and at to a current. Live keeps reading every 1, 2, or 5 seconds until Stop is clicked.

ViewDescription
CurrentThe latest value of each DataItem, with its Device, Component, type, category, timestamp, and sequence. In Live, changed values are highlighted
ObservationsThe Observations of a sample, newest first. Live starts with the 100 most recent, then reads only new Observations, and notes when Observations were missed (the Agent's buffer moved past them) or the Agent restarted
DevicesThe probe as a tree of Devices, Components, Compositions, and DataItems. Validate these Devices opens them in Device Validation
RawThe response document

Every response shows the status, time, size, and URL of the request, and the Agent's Header: instance ID, version, sender, buffer size, the range of sequences in the buffer, and the next sequence. A changed instance ID means the Agent restarted.

Device Validation

Tools > Device Validation checks MTConnect Devices against the MTConnect Standard, from either source:

Device Validation with the Schema and Model findings for a Device
Device Validation with the Schema and Model findings for a Device
  • Agent - The Agent's address (ex. localhost:5000, or localhost:5000/Mazak for one Device). The probe is read from the Agent.
  • Document - A Devices document pasted or opened from a file: an MTConnectDevices (probe) document, a Device element from an Agent's configuration, or an MTConnect or cppagent JSON document.

Validate against is the document's MTConnect version by default, or a selected version (ex. to check a 2.3 Device file before using it with a 1.8 Agent).

CheckDescription
SchemaXML is validated against the MTConnect Devices XSD schema of the version (1.0 to 2.7), with the line, position, and path of each finding. The schemas are included, so no internet access is needed
ModelXML and JSON are checked for Types that aren't in the Standard (extended types, ex. x:CUSTOM, are allowed), Types added after or deprecated before the version, categories that don't match the Type, SAMPLEs without units or with the wrong units (use nativeUnits for the units the machine reports), TIME_SERIES DataItems that aren't SAMPLEs, a compositionId that doesn't match a Composition, Devices without an AVAILABILITY DataItem, and duplicate Device UUIDs, names, and IDs

The result shows whether the Devices are Valid (no Errors), the number of Errors and Warnings, and each finding, filtered by severity (Errors, Warnings, Information) and by text.

SHDR Browser

Tools > SHDR Browser connects to an SHDR Adapter and shows what it's sending. Use it to check an Adapter before adding it to an Agent, or to see why a value isn't reaching the Agent. Enter the Adapter's Hostname and Port (usually 7878) and click Connect:

The SHDR Browser showing the latest Values and Lines from an Adapter
The SHDR Browser showing the latest Values and Lines from an Adapter
ShowsDescription
SummaryThe connection status, how long it's been connected, the Lines and bytes received, the number of Keys, and the Heartbeat when the Adapter answers PING with PONG
ValuesThe latest Value of each Key, with the Timestamp the Adapter sent, the number of updates, and when it was received. Conditions and Messages are labeled
LinesThe last 500 Lines exactly as they were sent, newest first. Pause holds the Lines (the Values keep updating) and Clear clears both
  • The connection is read only (it only sends the PING heartbeat), and is closed with Disconnect or when the page is closed. It's never reconnected automatically.
  • Values are read without a Device model, so a Line is read as Key / Value pairs unless it has the shape of a Condition or a Message.
Some Adapters only accept one client. Connecting to an Adapter that an MTConnect Agent is already reading from can disconnect the Agent, so check with a short connection first.

Definition Browser

Tools > Definition Browser browses and searches the MTConnect Standard's DataItem, Component, and Composition Types, with their descriptions and the MTConnect versions they're in (Minimum and Maximum Version). A DataItem Type also shows its Category, Representation, units, SubTypes, and, for EVENTs, its Values. Use it to find the right Type for a DataItem, or to look up what a value means.

The definitions are read from the database Collection stores them in (the mtconnect_definitions schema), so they're shown once Collection has written them to a Tables Service.