How can we help?

My Cases

Device Monitor Admin Override
Last Updated: Nov 15, 2018 10:53AM EST

This article applies to:  Echo360 Admins

Device Monitor 1.9.4+ includes an admin override feature that supersedes any local settings and uses configuration values from a supplied XML file. This allows for mass deployment of the application without the need to configure each individual instance.

When an admin override XML is used, Device Monitor will parse it, use the supplied settings and prevent any configuration changes through the user interface. This includes graying-out the appropriate fields in the Echo360 Configuration window and preventing access to the Device Monitor Configuration window.

Applying admin override settings

Once you apply the adminOverride.xml file, you will need to restart the Device Monitor application to apply the settings.

In addition, if your override file configures the device login as well as the device URL, the password you use in the file must be encrypted. The Device Monitor software provides an encryption mechanism for you. See encryption instructions below.

To configure the Device Monitor via XML file:

  1. Generate an adminOverride.xml file using the example shown below.
  2. Replace the values with your configuration settings. If you are using username/password values in the file, see the password encryption instructions immediately below.
  3. Save the file to the following directory (the directory is created on Device Monitor installation, so you must have installed the DM software first):
    C:\Program Files (x86)\Echo360\Echo360 Device Monitor\
  4. Stop and restart the Device Monitor application (select Close Device Monitor from the System Tray menu, then manually launch Device Monitor from the Start menu.

To encrypt the password:

  1. Open the bundled encryption utility called EchoCryptHelper located in the following directory:
    C:\Program Files (x86)\Echo360\Echo360 Device Monitor
  2. Enter the password you wish to encrypt and click Encrypt.
  3. Copy the resulting value from the Encrypted Output field and paste it as the EchoEncryptedPassword value in the adminOverride.xml file.
  4. When finished, click Close.

Example adminOverride.xml file

An example adminOverride.xml which outlines the required structure is as follows:

<AdminOverride xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<!-- these can be set or not regardless of the OverrideDelcomSettings flag -->
<EchoServerURI>https://10.3.6.164:8443</EchoServerURI>
<EchoUsername>instructor</EchoUsername>
<EchoEncryptedPassword>166125033209225163193094161087240006163200008085</EchoEncryptedPassword>

<!-- set to true to enable all of the settings below -->
<OverrideDelcomSettings>true</OverrideDelcomSettings>

<!--disable all delcom light gestures -->
<DisableDelcomGestures>false</DisableDelcomGestures>

<!-- disable individual gestures, if DisableDelcomGestures is true all will be disabled regardless of these settings -->
<DisableDelcomGestureStart>false</DisableDelcomGestureStart>
<DisableDelcomGestureStop>false</DisableDelcomGestureStop>  <DisableDelcomGesturePause>false</DisableDelcomGesturePause>
<DisableDelcomGestureResume>false</DisableDelcomGestureResume>

<!-- set led sequence and level for each device state -->
<LEDStateIdle>2</LEDStateIdle>
<LEDStateIdlePowerLevel>50</LEDStateIdlePowerLevel>
<LEDStateWaiting>6</LEDStateWaiting> <LEDStateWaitingPowerLevel>50</LEDStateWaitingPowerLevel>
<LEDStateCapturing>4</LEDStateCapturing> <LEDStateCapturingPowerLevel>50</LEDStateCapturingPowerLevel>
<LEDStatePaused>7</LEDStatePaused>
<LEDStatePausedPowerLevel>50</LEDStatePausedPowerLevel>
<LEDStateCompleting>3</LEDStateCompleting>
<LEDStateCompletingPowerLevel>50</LEDStateCompletingPowerLevel>
<LEDStateError>5</LEDStateError>
<LEDStateErrorPowerLevel>50</LEDStateErrorPowerLevel>

<!-- allow warning signal when audio is not detected for the delay time -->
<AudioWarningEnabled>false</AudioWarningEnabled>
<AudioWarningDelay>2</AudioWarningDelay>
<AudioWarningLEDState>13</AudioWarningLEDState>
<AudioWarningPowerLevel>50</AudioWarningPowerLevel>

<!-- allow warning signal when capture is about to end within delay time -->
<CaptureWarningEnabled>false</CaptureWarningEnabled> <CaptureWarningDelay>5</CaptureWarningDelay>
<CaptureWarningLEDState>8</CaptureWarningLEDState>
<CaptureWarningPowerLevel>50</CaptureWarningPowerLevel>
</AdminOverride>
 

The two primary tags that dictate the level of override are the EchoServerURI and OverrideDelcomSettings tags:

  • The EchoServerURI tag is populated with the URL (IP address) of the capture appliance you want the Device Monitor to connect to. In addition, you can identify the default login information for the Device Monitor to use for any ad hoc captures initiated using the light.
    • With this tag present and ONLY the device URL identified, the Device Url field in the Echo360 Configuration window will not be editable. However, the Username and Password fields will still be available.
      Device Configuration modal with tag set as described
    • With this tag present and populated with the URL, Username, and Password, none of the fields in the Echo360 Configuration window are editable and the option will be grayed out in the System Tray menu.
  • Setting the OverrideDelcomSettings tag to true forces the application to use the Delcom light configuration settings/values directly from the XML file, and disables the configuration option from the interface (system tray menu, as shown below).
    sys tray menu with options locked as described

Both of these tags can be defined, but at least one must be present for the application to correctly parse the XML file.

Additionally, the Delcom light settings in the override XML directly reflect the settings available in the interface and use an integer to map the light configuration. This mapping is shown in the table below:

Integer Light Configuration
1 Lights Off
2 Green Light
3 Green Light Flashing
4 Red Light
5 Red Light Flashing
6 Yellow Light
7 Yellow Light Flashing
8 Green Solid/Yellow Light Flashing
9 Green Solid/Red Light Flashing
10 Yellow Solid/Green Light Flashing
11 Yellow Solid/Red Light Flashing
12 Red Solid/Green Light Flashing
13 Red Solid/Yellow Light Flashing
14 Green Solid/Yellow Solid
15 Green Solid/Red Solid
16 Yellow Solid/Red Solid
17 Green Solid/Yellow Solid/Red Solid
c9f5f1d87ac29bd0c146e9565da3c739@echo360.desk-mail.com
https://cdn.desk.com/
false
desk
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/en/portal/articles/autocomplete?b_id=16609