Quick Start

Serve your machines through the free Agent Hub, or collect their data too, and check that everything is connected.
MTConnect Server Docs Menu

The App's Quick Start page walks through setting up MTConnect Server, one step at a time. It checks off each step that's done, and opens at the first one that isn't, so you can leave and come back to it. Open it from Quick Start in the App's menu after installing.

Starting with the free Agent Hub? Choose only Serve through the AgentHub in step 1. The Destination and License steps are skipped, and no database or License is needed. When you're ready, come back to add Data Collection to the same Devices (see Add Data Collection).

Collection needs a License, but you can get a free 2-hour trial instantly in step 3, so no purchase is needed to try it.

PurposeCollect, serve, or both
DestinationA database or MQTT broker
LicenseOne seat per Device
DevicesFrom an Agent's address
FinishData is arriving
The Destination and License steps are only shown when MTConnect Server collects data.

1. Choose What MTConnect Server Does

Choose one or both. This only sets up the steps that follow, and each Device can be changed at any time.

  • Collect data - Store the data of Devices in a database, or publish it to an MQTT broker. Each Device uses one seat of a Collection License.
  • Serve through the Agent Hub - Serve every Device as its own MTConnect Agent from a single port. No database or License is needed.

2. Choose Where the Data Goes

Collected data is stored in a database, published to an MQTT broker, or both. One destination is enough to start. Click Add a Destination and choose its type:

TypeFieldsUse When
SQLiteDatabase File (optional, a full path on the server. Blank for the data folder in the install directory)A trial, or a few Devices. No setup needed
PostgreSQLServer, Port, Database (must already exist), User, and PasswordProduction
SQL ServerServer, Port, Database (must already exist), User, and PasswordProduction
MQTTHostname, Port, Use TLS, Username, and PasswordSending data to other applications as it's collected

Adding a destination creates its Service and a Profile that sends data to it. A destination that's set up but has no Profile is listed with Use This. More destinations can be added later under Collection > Configuration.

3. Add a Collection License

Each Device that's collected uses one seat of a License. License Codes are issued for this computer, so request one from here:

  1. Click Request a License. This opens licenses.trakhound.com with this computer's Device ID filled in. A 2-hour trial is issued instantly.
  2. Copy the License Code, paste it into License Code, optionally add a Description (ex. which order or site it's for), and click Add License Code.
  3. Click Use for New Devices so the Devices you add next are given a seat of this License.

Devices can be added without a License, but they aren't collected until they have one. See Collection Licenses and the Licensing Guide.

4. Add Devices

  1. Enter the Address and Port (default 5000) of an MTConnect Agent, and click Find Devices. Path is only needed when the Agent is served under a path.
  2. Choose the Devices to add from the ones the Agent reports (Select All chooses every one). Devices that were already added are marked.
  3. On Review, optionally enter a Group, and choose what the Devices do: Serve through the AgentHub, Collect data, or both. For collected Devices, choose the Profiles their data goes to.
  4. Click Add Device. Repeat for each Agent.

To read from an SHDR Adapter instead of an Agent, use Add an SHDR Device (see Devices).

5. Check That Data Is Arriving

The last step shows what's left to do, and then what MTConnect Server is doing now. It refreshes every few seconds:

The Quick Start's last step, once everything is set up
The Quick Start's last step, once everything is set up
  • Licenses - Every collected Device has a License. Devices without one aren't collected.
  • Profiles - Every collected Device has a Profile. A Device without one is read, but its data isn't stored or sent anywhere.
  • Connections - How many of the enabled Devices are connected.
  • Observations - How many Observations have been collected, or Waiting for the first observations.

Once data is arriving, see the collected data under Collection > Data > Devices, and the Connection Status under Collection > Connections (see Monitoring Collection). Served Devices are listed on AgentHub, with links to their MTConnect endpoints (see Agent Hub).

Next Steps

  • Store only the DataItems you need with a Filter, and limit how long Observations are kept with Data Retention.
  • Organize Devices into Groups, and give each Group its Profiles.
  • Read the collected data from your own applications with the REST API, MQTT, or the database.