Aggregator Setup and Install

This page is for network administrators who are setting up the Aggregator

 

This documents describes setup and configuration of the 3YOURMIND Aggregator for Machine Connectivity in the Agile MES. Before reading this, make sure you have read https://3yourmind.atlassian.net/wiki/spaces/PD/pages/1077051450.

Aggregator On Windows

You will need to provide a Windows PC with the following System Requirements.

Make sure your Windows PC is in the same network as each machine you want to connect to.

Start by downloading the binary release. We will provide you with a link to a ZIP archive.

  • Unpack the contents of the ZIP archive in a directory on the Windows PC (for example: C:\aggregator\)

  • Create a configuration following the Create a Configuration guide and save it in a file called config.json.

  • Put the config.json in the same directory as the aggregator.exe.

Running the aggregator as an executable

  • Simply double click on the aggregator.exe file.

Running the aggregator as a service

This enables automatic start of the Aggregator service on system boot.

  • Run install-as-service.bat as Administrator.

  • To remove the service and stop the Aggregator run uninstall-service.bat as Administrator.

Optionally adjust the settings of the service:

  • Click on Windows Start, type Services and hit enter to open the service configuration panel.

  • Adjust the settings of the 3YOURMIND Aggregator service as desired. You can, for example, enable automatic restart of the service in case of an error.

Updating the Aggregator

  • Start by stopping/uninstalling the previous version:

    • Executable: Press ctrl+c.

    • Service: Run uninstall-service.bat as Administrator.

  • Unpack the new release into a new directory.

  • Copy config.json and any additional configuration files that you have created into the new directory.

  • Run the new Aggregator like before.

Troubleshooting

Configuration issues

The aggregator will stop immediately if your configuration file contains errors.

  1. Make sure your config.json is valid. You can use a JSON validator such as this one.

  2. Check the aggregator.log files.

Why am I unable to connect to the machine even though I am using the correct URL?

Try to enable network discovery on the Aggregator’s PC.

Log files

After starting the Aggregator, an aggregator.log should have been generated in the same directory. The file is a good starting point for troubleshooting machine connectivity issues. Open it in a text editor to identify potential bottlenecks.

Windows Event Log

For unexpected errors in the Aggregator you can check the event log:

  • Click on Windows Start, type Event Viewer and hit enter.

  • Open Windows Logs → Application and look for any errors related to the aggregator.exe.

Aggregator In Docker

Since version 22.7, our cloud and on-premise deployments come with a dockerized Aggregator. Its configuration takes place in the admin panel.

  • Log into the admin panel of your deployment by visiting https://[your-url]/admin/.

  • Navigate to B3_ORGANIZATION → Organizations.

  • Add a new organization called button3d and attach a newly created site called button3d.

  • Navigate to B3_MACHINE → Aggregator Configurations.

  • Click on ADD AGGREGATOR CONFIGURATION in the top right.

  • Select the site button3d and paste the configuration (Create a Configuration) into the content field.

  • Click on Save in the bottom right.

Wait for 20s and check for errors in the admin panel under B3_MACHINE -> Aggregator configuration errors. If the Error field is empty then the configuration is valid.

If you want to make changes to the configuration in the future then simply edit the content field and save.

At this point, the Aggregator should have already pulled the new configuration and started reading data from the machines.