Decimator User Interface Help
Decimator User Interface Help
1. General Overview
The Decimator User Interface (Decimator UI) runs as a Java Applet in a browser
using JDK 1.6.0 release 10 or higher. It is used to monitor and control the software
running on the Decimator card, 8-Port Decimator or Portable Decimator. The
Applet is served off the card.
2. Terminology
Term Definition
Decimator UI Decimator User Interface
Frequency The horizontal component on the display.
Frequency Unit A unit of frequency in Hz, kHz, MHz or GHz.
Power A vertical component on the display in dB or dBm.
Trace Point A tuple consisting of (Frequency, Power)
Trace A series of Trace Points that can be the active trace or a memory
based trace.
Marker A visual indicator attached to a Trace Point.
Screen The main graphical area of the display.
Setting A parameter of the Decimator configuration.
State A collection of settings defining the state of the entire configuration
of the Decimator.
Menu Item A visual component used to control the behavior of the
Decimator. Optionally there may be desired and actual setting
values displayed.
Buttons A stack of high level buttons.
Menu List A list of menu items control by the buttons.
Analysis An operation done on a trace in carrier monitoring to yield a status.
Notification Event A trigger in the Carrier Monitoring system that results from a
measurement state change.
Measurement A named concept that contains a State, a trace result and a
notification event.
4. Decimator UI Startup
To start the Decimator UI, ensure you are connected from your computer with a
browser to the Decimator hardware. Obtain the IP Address for your
Decimator. Enter the following URL in your browser “192.168.10.1” assuming
your card has that IP Address. Substitute your IP Address. The Applet software
will be served to the browser and start up with default settings.
5. Layout
The Decimator User Interface consists of a single screen with 3 main areas:
Screen – the extreme left of the view.
Buttons – in a vertical stack on the far right of the view.
Menu List – in a vertical stack between the Screen and the Buttons.
5.1 Screen
The screen consists of 4 areas:
Plot Area – to the center.
North Settings Bar – to the top.
West Settings bar – to the left.
South Mouse Location Bar – to the bottom.
5.1.1 Plot Area
The plot area consists of a 10 by 10 grid with the active trace, and any memory
based traces, and marker symbols. It contains numerous overlays depending on
user action. The following overlays are
5.1.1.1 Edit Windows
Edit windows are overlaid in the north east section of the plot area. An example
would be the Center Frequency edit window. These windows are translucent to
allow the trace content to flow through.
5.1.1.2 Marker Legend
A marker legend is overlaid in the north area within the plot area when at least one
marker is enabled. It contains the following items:
# – The marker number.
Style – The graphic used to render the marker.
Type – Either Normal or Delta.
Frequency – For a Normal marker, this displays the Frequency coordinate of the
marker in Hz and for a Delta marker, this displays the Frequency difference between
the marker and the reference marker.
Power – For a Normal marker, this displays the Power coordinate of the marker
in dBm and for a Delta marker, this displays the Power difference between the
frequency marker and the reference frequency marker in dB.
Band Power – Only applicable for Delta markers, this displays the band power
between the markers in dBm.
5.1.1.3 Carrier Monitoring Details
When in Carrier Monitoring mode, the top left of the screen shows the historical
values of the analysis in a translucent overlay.
5.1.2 North Settings Bar
The North Settings Bar resides at the top of the Screen and contains the following
items:
Connection LED – At the left, this component is Red if the connection to the
Decimator is broken and Green if communications are established.
RBW – The actual resolution bandwidth value in the same Frequency Units as the
desired RBW.
Span – The actual span in the same Frequency Units as the desired Span.
# Averages – The actual number of averages.
Start Frequency – The actual start frequency in the same Frequency Units as the
desired Center Frequency.
Center Frequency – The actual center frequency in the same Frequency Units as the
desired Center Frequency.
Stop Frequency – The actual stop frequency in the same Frequency Units as the
desired Center Frequency.
Note: Clicking on the Connection LED, RBW, Span, # Averages, Start Frequency,
Center Frequency or Stop Frequency labels will place the Decimator UI in edit
mode for those settings.
5.2.1 Editing
Editing a setting is done using two primary mechanisms: Combo box style and Edit
Dialog style. Clicking the menu item enters into edit mode. Clicking a different
menu item, or the X automatically exits edit mode. Pressing <ESC>, also edits edit
mode.
6. CrossPol Mode
On multi-port Decimators, users can configure the Decimator to operate
in CrossPol mode. To achieve this, perform the following:
Connect the CoPol feed to one of the switch ports, for example Switch Port 1.
Connect the CrossPol feed to one of the switch ports, for example Switch Port 2.
Run the Decimator UI
Navigate to the System Menu
Configure the Switch Port to 1. This acts as the CoPol Switch Port. The CoPol trace
will be rendered as the Active Trace.
Configure the CrossPol Switch Port to 2.
Enable the CrossPol mode by setting the value to true.
The Decimator UI renders the CoPol data using the Active trace and the CrossPol data
using the CrossPol trace. CrossPol style markers are automatically added to the peak
of the Active trace and to the same frequency on the CrossPoltrace. The delta power
level in dB is shown in the marker legend.
7. Query String
The following query string parameters can be added to the end of the URL
separated by & and from the beginning of the URL portion by a ?. For example, to
set the center frequency and span, the query string is:
“192.168.10.1/index.html?frequency=1345.23&span=24.885”
Parameter Description Expecte Example Default Value
Name d Data
Type
frequency Sets the center Decimal, frequency=1345.23 Half of the
frequency MHz available
frequency
span Sets the span Decimal, span=24.885 The minimum
kHz span value
RBW Sets the Decimal, RBW=95 100
resolution Hz
bandwidth
averages Sets the number Decimal averages=12 10
of averages
autoyaxis Turns Y axis Boolean autoyaxis=false True (auto scaling
auto scaling (true=on on)
on/off )
yref The Y axis Decimal yref=-10 0
reference value (dB)
(value at the top
of the plot)
dbdiv The number of Decimal dbdiv=5 10
dB per vertical (dB)
division.
crosspolmode Turns CrossPol Boolean crosspolmode=true False
mode on/off (true=on (crosspolmode
) off)
switchport Selects the Decimal switchport=5 1
switched RF port (1 to 8)
crosspolswitch Selects the Decimal crosspolswitchport=3 2
port switched RF port (1 to 8)
for
thecrosspol feed
autoattenuation Toggles input Boolean autoattenuation=true True
attenuation (true=aut (automaticattentut
between auto o) ion)
and manual
attenuation Sets the Decimal attenuation=5 0
attenuation level
in dB
referenceselect Toggles the Enum: referenceselect=auto internal
clock reference external
between internal
internal/external auto
capturemode Sets the capture Enum: capturemode=continuous stopped
mode stopped
single
continuo
us
fftwindow Sets the FFT Enum: fftwindow=flattop blackman-harris
window rectangul
ar
flattop
blackma
n-harris
hammin
g
hanning
fftoverlap Sets the FFT Decimal fftoverlap=.4 0.5
overlap (0 to 1)
spectralinversi Sets the spectral Boolean spectralinversion=true false
on inversion (true=on
)
optimization Sets the Enum: optimization=speed spurious
optimization or spurious
dithering option speed
detector Sets the detector Enum: detector=peak normal
option peak
normal
hold Sets the hold Enum: hold=max hold normal
mode normal
max
hold
min hold
min max
active
colorscheme Sets the color Enum: colorscheme=print normal
scheme on the normal
plot print
profile Loads a project Local profile=C:/myProject.xml N/A
xml file (Similar file or
to using the Save web or
/ Open menu) at served
startup. If file profile=http://www.someUrl.com/
provided, all myProject.xml
other options
above are
ignored and the
ones in the
project file are
loaded in.
8.1 Add a Measurement
To add a measurement:
Click the Carrier Monitor button
Click the New Measurement menu item
On the New Measurement display:
o Enter a unique carrier name
o Specify the Analysis to perform
o Specify the threshold parameters by accepting the default ones or overriding
them
o Click OK
The measurement is added to the table in the Carrier Monitor toolbar
Alternatively click on the add button on the carrier monitor toolbar
8.2 Carrier Monitor Toolbar
The carrier monitor toolbar appears when there is at least one measurement
specified. Mousing over the toolbar, widens it to make the measurement name
visible.
Play – start the carrier monitoring system from the currently selected measurement or
from the top, if no measurement is selected.
Stop – stop the carrier monitoring system.
Add – add a measurement.
Delete – delete the selected measurement.
Edit – Edit the selected measurement
Recall State – Recall the state of the selected measurement
Capture State – Capture the state on the Decimator to the selected measurement
Move Measurement Down – Move the selected measurement down
Move Measurement Up – Move the selected measurement up
Scroll to Top – scroll to the top of the measurement table
Scroll Up – scroll up one view port if there is more than one
Measurement Table
o A two column table with
Measurement status (LED: gray is unknown, green is success, red is
failure)
Measurement name
Scroll Down – Scroll one view port down.
Scroll to Bottom – Scroll to the bottom of the measurement table
8.3 Play
To start playing in carrier monitor mode:
Click the play button
The current measurement state will be set, a trace acquired, analyses run,
measurement status evaluated and displayed, optional logging of results and any
notification event raised if necessary. A measurement overlay is added to the
screen in the upper left indicating the current measurement in progress. The
Measurement Table updates the selection. The overlay contains the last 24 hours of
historical data for each analysis configured. Each analysis is evaluated and its
status is rendered in the caption bar.
8.4 Stop
To stop playing in carrier monitor mode:
Click the stop button
8.5 Delete a Measurement
To delete a measurement:
Select the measurement.
Click delete.
8.6 Edit a Measurement
To edit a measurement:
Select the measurement
Click edit
Or
Mouse over the measurement in the Measurement Table
Then modify the Measurement’s Analyses, State or Notification Events. Users
may Recall the state when editing a measurement and adjust the State as if they
were normally modifying the settings of the Decimator and Capture the State.
8.7 Recall State
To recall the state of a measurement:
Select the measurement
Click Recall State
Or
Mouse over the measurement
Select State
Click Recall
8.8 Capture State
To capture state to the selected measurement:
Select the measurement
Click Capture State
Or
Mouse over the measurement
Select State
Click Capture
8.9 Notification Events
There are 2 types of notification events: Email and SNMP traps (SNMP version 2
only).
8.9.1 Email
Email notification events are raised if and only if:
the master email switch is on, and
the individual email notification is on within the measurement, and
there is a status change in the measurement.
8.9.2 SNMP
To view the specific SNMP trap raised, click the “Show MIB” button to save the
MIB file to disk. This can be loaded into an NMS.
SNMP traps are raised if and only if:
the master SNMP switch is on, and
the individual SNMP notification is on within the measurement
9. Carrier Monitor Command Line Task
After setting up the measurements for carrier monitoring in the previous section
and running and testing interactively, it may be beneficial to run the carrier
monitoring not from within the applet, but from a command line task.
To do this, perform the following:
Run the Decimator UI to create a project file with all the measurements in it. Test it
out running in the browser interactively. Include things like measurement delay, trace
analysis result logging, email notifications, SNMP configuration and all your
measurements. Save the project file to disk. (e.g. C:/myproject.xml)
Obtain the decimator.jar file by searching in your browser’s cache for the file
“decimator.jar”. (Consult your browser documentation to find the directory and/or
search your drive) Some browsers allow a “File | Save As…” option to save the
current page to disk, which will in turn save “decimator.jar” to the directory.
Shutdown the Decimator UI.
From the command line run:
o java -java.util.logging.config.file=''FullPathToJavaLoggingPropertiesFile'' -cp
decimator.jar com.sedsystems.decimator.CarrierMonitoring -IpAddress ''YourDecimatorCardI
pAddress'' -Port ''YourPort'' -ProjectFile ''FullPathToYourProjectFile''
As an example:
o java -Djava.util.logging.config.file=C:/decimator.properties -cp
decimator.jar com.sedsystems.decimator.CarrierMonitoring -IpAddress 192.168.10.1 -Port
9784 -ProjectFile C:/myproject.xml
When running through the proxy, add the extra –Proxy option, for example:
o java -Djava.util.logging.config.file=C:/decimator.properties -cp
decimator.jar com.sedsystems.decimator.CarrierMonitoring -IpAddress 192.168.10.1 -Port
9784 -ProjectFile C:/myproject.xml -Proxy
===== Sample Java Logging Properties File starts next line, (i.e. decimator.properties) =====
# Properties file which configures the operation of the JDK
# logging facility.
# The system will look for this config file, first using
# a System property specified at startup:
#
# >java -Djava.util.logging.config.file=C:/decimator.properties
#
# If this property is not specified, then the config file is
# retrieved from its default location at:
#
# JDK_HOME/jre/lib/logging.properties
# Global logging properties.
# ------------------------------------------
# The set of handlers to be loaded upon startup.
# Comma-separated list of class names.
# (? LogManager docs say no comma here, but JDK example has comma.)
handlers=java.util.logging.FileHandler, java.util.logging.ConsoleHandler
# Default global logging level.
# Loggers and Handlers may override this level
.level=INFO
# Loggers
# ------------------------------------------
# Loggers are usually attached to packages.
# Here, the level for each package is specified.
# The global level is used by default, so levels
# specified here simply act as an override.
#com.sedsystems.decimator.model.level=ALL
#com.sedsystems.decimator.view.level=CONFIG
#com.sedsystems.decimator.controller.level=SEVERE
# Handlers
# -----------------------------------------
# --- ConsoleHandler ---
# Override of global logging level
#java.util.logging.ConsoleHandler.level=SEVERE
java.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter
# --- FileHandler ---
# Override of global logging level
#java.util.logging.FileHandler.level=ALL
# Naming style for the output file:
# (The output file is placed in the directory
# defined by the "user.home" System property.)
java.util.logging.FileHandler.pattern=%h/DecimatorLogs/Decimator%u.txt
# Limiting size of output file in bytes:
java.util.logging.FileHandler.limit=50000000
# Number of output files to cycle through, by appending an
# integer to the base file name:
java.util.logging.FileHandler.count=20
# Style of output (Simple or XML):
java.util.logging.FileHandler.formatter=java.util.logging.SimpleFormatter
===== Sample Java Logging Properties File ends previous line, (i.e. decimator.properties) =====