Onboarding and Installing MindConnect Software Agent in Windows - Developer Documentation
Skip to content

Onboarding and installing MindConnect Software Agent in Windows

MindConnect Software Agent device is required to onboard using Asset Manager. For more information, see Asset Manager document.

Procedure to onboard

To onboard the device, you need to create an asset in the Asset Manager. To create an asset for your in Asset Manager, see Create Asset. Once the asset is created, open the UI plugin in Asset Manager to follow these steps:

  1. In Asset Manager, click the MindConnect Software Agent plugin.

    mindconnect-software-agent-plugin

    ① Connects and onboards the MindConnect Software Agent

  2. In MindConnect Software Agent plugin page:

    mindconnect-software-agent-plugin-page

    ① MindConnect Software Agent firmware installation details

    ② Configure the asset with the serial number

    ③ Start the configuration with the serial number

    • Download firmware: Click download and install the MindConnect Software Agent firmware.

  3. Install and run the MindConnect Software Agent firmware.

Installing MindConnect Software Agent

MindConnect Software Agent can be installed on Windows system and IPCs running a Windows 10 version that supports Hyper-V feature, for example Windows 10 Professional or Enterprise.

Note

HyperV has to be activated on the local host PC.

Procedure to install MindConnect Software Agent

To install MindConnect Software Agent, follow these steps:

  1. Double click "MindConnect Software Agent setup.exe".

    setup-launcher-unicode

  2. Click "Yes" and click "Next".

  3. Select the network interfaces for MindConnect Software Agent.

    network-interfaces

    ① Connects to Insights Hub

    ② Connects to the field devices like PLCs

Note

Ensure to use the correct adapter for each connection.

4.Select "Custom" setup type to install(recommended) and click "Next". 5.Configure the virtual machine settings and click "Next".

config-virtual-machine

Note

Maximum RAM must be higher than the minimum RAM specification. Recommended is 8GB as maximum RAM and 4GB as minimum RAM.

6.Change "Destination Folder", if required and click "Next". 7.Review the settings and click "Next". 8.Click "Install".

Installation completed

After installing MindConnect Software Agent firmware, follow these steps:

  1. Restart your PC.
  2. Open Hyper-V Manager.

  3. Click on virtual machine (MindConnect Software Agent) and click "Connect".

    In VM console, information will be displayed (IP Address and Serial Number).

    ip-address-serial-number-details

    In this sample, MindConnect Software Agent's web server URL is http://192.168.75.129/.

    For more information using Hyper-V Manager, see Using MindConnect Software Agent's Hyper-V VM.

Note

  • Currently, http protocol is supported.
  • At least one of the connected networks must provide DHCP support, so that the system will receive an IP address that can be used to open the local web UI in a browser.
  • If a connected network does not provide DHCP support, the values for IP address and subnet mask will be empty and the device has to be onboarded first.

Procedure to uninstall MindConnect Software Agent

MindConnect Software Agent can be uninstalled either by executing MindConnect Software Agent's setup.exe file again, or via Windows Control Panel.

Note

To uninstall MindConnect Software Agent using Windows Control Panel is available from the version MCSA V03.05.00.01 b004.

Procedure to access the web server URL and onboard the device

To access the web server URL and onboard the device, follow these steps:

  1. In browser, open new tab and enter web server URL.
  2. In MindConnect Software Agent overview page, copy the "Serial Number (UID)".
  3. In MindConnect Software Agent plugin page, paste the "Serial Number" and click "Save" and then click Settings to initiate the onboarding process.

  4. In Edit MindConnect page, check the settings and download the onboarding key file.

    download-onboarding-key-file

  5. In MindConnect Software Agent's overview page, click "Onboard your device".

  6. In MindConnect Software Agent onboarding page, follow the either step:

    onboard-the-device

    ① Uploads the downloaded onboarding key file

    ② Inserts the JSON content from the onboarding key file

    • Click "Select file" to upload the downloaded onboarding key file with the filename constructed form of serial number.

    or

    • Copy the text from the onboarding key file and click "Insert JSON content" to paste.

  7. Click "Start onboarding".

  8. In Edit MindConnect page, click "Save" after the device is onboarded.

  9. After the device is succesfully onboarded, you can add data sources and data point mapping.

    add-data-source

For more information on adding a data source and data points, see Adding a data source for MindConnect Software Agent.

To manage and maintain multiple virtual machines (VM's) in MindConnect Software Agent, see Managing or maintaining the virtual machines or instances in MindConnect Software Agent.

Serial number

The serial number section provides the serial number to copy and paste it to the serial number field during the asset configuration in asset manager.

Onboard with file

In “Onboarding” page, the exported configuration file from asset manager can be selected and click "Start onboarding" button to start onboarding.

Onboard with JSON content

It is also possible provide the configuration data directly as JSON input by clicking "Insert JSON input" and paste the JSON configuration data into the opened dialog. Thereafter, start the onboarding by clicking the "Start onboarding" button.

Configuration status

The status of the onboarding/configuration process will be shown in the "Configuration status" section.

Note

If the network settings are changed by the new configuration data like a new IP address is updated, then the MindConnect Software Agent's web browser must be opened again by using the new IP address of the system. In that case, it might be possible that the diagnosis messages will be displayed twice in the diagnosis messages section. To resolve the issue, restart the virtual machine.

Last update: June 15, 2023