Client

This section is about all the features of the Rimscout client: how to install, register and use it.

Install the client

To install a client go to https://www.rimscout.com/download/ and download the RimScout.zip file.

Warning

The Rimscout client is currently in a beta test phase. Please read the information on the download page carefully to be aware of the risks.

Unzip the downloaded file anywhere you like and double-click on the RimScout.exe file to start the application. After a short time the Rimscout icon should appear and shortly after the client status screen pops up. The general installation is therefore completed and the client now starts running the tests.

Installation requirements

• Windows 7 or higher
• 64-bit system architecture
• Clients need to be able to access the following domains using HTTPS (for updates and data synchronization)

Uploading connectivity data to the Rimscout backend:

iot-rimscout-clients.azure-devices.net

Important

There may not be any SSL inspection (e.g. by a firewall) for packets going to iot-rimscout-clients.azure-devices.net.

Registration and uploading system profile data:

portal.rimscout.com 

Automatically updating the client:

update.rimscout.com

Downloading the client configuration:

config.rimscout.com

Detecting the public IP address:

checkip.amazonaws.com/

Firewall notification

It might happen that shortly after the first start of Rimscout a firewall notificaton shows up. Simply click on cancel as it doesn't matter for Rimscout whether or not this firewall features are allowed.

Register the client

To report the collected client data to a portal the client has to register itself. The registration might happen automatically if your client belongs to an already known domain (see Domain SID tokens) or if a token was deployed to the registry (see Deploy a token to registry). Otherwise a notification appears telling you to register the client.

Click on register and enter a valid token (which your network admin should provide you) to register the client manually.

Start the client

At the first start of the client it copies the RimScout.exe file to the %localappdata%/Rimscout folder and creates an autostart entry. Therefore the client starts and runs whenever the user is logged in. To show the client simply click on the Rimscout icon in the tray bar.

Exit the client

When closing the clients main window, the application is not closed. It still runs in the background, executes the tests and can be reopend via a click on the tray icon. To exit Rimscout you need to right click the tray icon and select the menu entry Exit.

Client status

At the first screen of the client you can see the connection health graphic. The connection health graphic gives an overview of the current network status by displaying the results of the running connection and configuration tests. It consists of four stations represanting parts of your network connection: Your device, Your network, Public internet, Selected service. Underneath each station all tests are shown that didn't execute with the status Success at their last run. Click on the unsuccessful tests to get more information about the detected problem and its possible causes.

Station - Your device

As the title Your device device implies the first station consists of tests that check the general configuration and performance of your device. Therefore tests like the check for the existence of a local IP address or the measurement of the general CPU usage belong to this station.

Station - Your network

Your network involves tests that check the setup and performance of your local network infrastructure. Local means hereby that you (or your supporter) have the control over the tested network components, e.g. your default gateway.

Station - Public internet

In contrast to Your network, Public internet tests components and receivers outside your local network and therefore out of your direct control. These tests serve as indicators whether there is an internet connection and whether it performs as exspected.

Station - Selected services

This last station includes all tests that check the reachability, performance or reliability of selected (cloud) services. The tests might resolve a service domain or perform a HTTPS request to get insights in the service accessability from the users perspective.

Report a bug

In the top right corner of the client status page you can open a dialog to report abug. Input a subject and describe the problem to inform us about a problem or bug.

Info

This features is only available for registered clients

System profile

On the system profile page are system and network parameters listed that are useful to distinguish clients or to find misconfigurations. All the listed entries are also sent to the portal.

Info

This features is only available for registered clients. It is also only visible in the expert view mode.

Expert view

The client has two views: A basic view for all the unregistered clients and an expert view which is by default displayed for the registered clients. The expert view has the navigation on the left with the System profile entry which is not shown in the basic view.

A registered user can switch to the basic view by right-clicking the tray icon and selecting the Expert view entry.

About the client

If you want to find out your Rimscout version or your client's ID you can click on the three dots on the start page and open the About page. Here you find all the general information about your installed Rimscout application.

Uninstall the client

If you want to uninstall the client, you simply need to remove some folders and a registry entry. Below the corresponding Powershell commands are given as well.

Warning

Be aware that if you delete the profile.xml file in the ProgramData folder, you delete all information about this client instance. If you ever install Rimscout again, you will get a completly new client which is not linked to the old one.

• Stop the current Rimscout process: Therefore right-click the tray icon and click on 'Exit'.

Stop-Process -name rimscout

• Remove Rimscout from autorun by deleting the registry entry Computer\HKEY_CURRENT_USER\SOFTWARE\Microsoft\Windows\CurrentVersion\Run name: Rimscout

Remove-ItemProperty ` 
-path HKCU:\Software\Microsoft\Windows\CurrentVersion\Run\ ` 
-name RimScout 

• Remove the .exe by deleting the Rimscout folder in AppData %localappdata%\RimScout.

Remove-Item -Path "$($env:LOCALAPPDATA)\rimscout"-Force -Recurse

• Delete all configuration files. Therefore delete the RimScout folder in ProgramData %programdata%\RimScout.

Remove-Item -Path "$($env: ProgramData)\rimscout" -Force -Recurse

• Optionally remove any Rimscout related registry entries at Computer\HKEY_CURRENT_USER\SOFTWARE\Rimscout.

Remove-Item-path HKCU:\Software\Rimscout` -Recurse