Release Notes - Jazz - Version 2.12
(2024-11-25)

Bug Fixes

• ATEC Jazz Issue #9 - Automatic image generation for WebPortal
  The <Image> generation does not work on the ATEC epgdas1 server.
   - 
  Fixed long-standing bug whereby the URL Connection for loading remote colorscales was using the default URL read, which does not set a timeout. On epgdas1, the firewall prevents outgoing connections without throwing an error, so Jazz would hang, waiting for a connection. All of the URL connections have now been updated to configure a URL Connection timeout and read timeout of 5 secs prior to attempting a read. This now produces the proper error in the cron-driven Image generation on the ATEC server.

Improvements

• Added support for WMS sublayers
  This allows users to selectively turn "Layers" sublayers on or off from within Jazz. The sublayers can be given user-friendly names for Jazz menus. Jazz WMS Layers still have the ability to be turned on/off completely. By default, no sublayers are requested, so if users do not specify sublayers in the Jazz config, all of the WMS Layer's sublayers are displayed.
  Note: sublayers may not be visible at all zoom levels, despite being turned on in Jazz, if the server-side map configuration has MINSCALE or MAXSCALE attributes set.
   - 
  To configure WMS sublayers, specify the new <Layer type="WMS" .../> attributes:

  subLayers

  optional comma-separated list of sublayers to display. See getCapabilities for full list.
  The sublayer visibility will be selectable in the "Maps" menu. Defaults to all.

  subLayerNames

  optional comma-separated list of sublayer names display in the menu. See getCapabilities for full list.
  The number of names in the list must match the number of layers in the subLayers attribute exactly.

  The "subLayers" names must exactly match those advertised in the GetCapabilities of the WMS service. The "subLayerNames" list must have the same number of items as the "subLayers" list. Each "subLayerName" item will be used in the place of the "subLayers" item name for all menus in Jazz. The "Maps," "Configure," and "Layer List" tool will all have an entry for the "layerName" followed by a dropdown menu for the "layerName sublayers:" containing each of the sublayers to turn on/off or configure. See "ATEC Jazz Issue #14" below for an example of how to specify subLayers and subLayerNames.

• ATEC Jazz Issue #6 - Add ability to set the transparency of WMS Layers
   - 
  Added handling of the "opacity" attribute in CIDDMAP, SHAPEFILE, and WMS Layer configurations. This can also be set from the session Config menu, and can be saved with views.

• ATEC Jazz Issue #14 - Change map projection to flat with Mapserver
  Web Mercator projection is now available, which is compatible with EPSG:3857. This combination allows Jazz to overlay data with properly-registered WMS layers in a "flat" projection. EPSG:3857 is also known as the "Google Maps" projection, and was formerly listed as EPSG:600613
   - 
  To set up Jazz with this configuration, specify 'WebMercator' in the <View> element:

  <View projection="WebMercator" originLon="0.0" originLat="0.0" zoomStyle="click"/>

  
  Then, specify EPSG:3857 using the srs attribute in all "WMS" Layer types:
  

  <Layer vis="on" type="WMS" name="Basemap" location="http://atec-dataops4.rap.ucar.edu/cgi-bin/mapserv"
  mapType="/data/mapserv/maps/atecMrrdBaseMultiSRS.map" version="1.3.0" imageFormat="image/png"
  srs="EPSG:3857" viewSpaceUnit="km" requestBBoxUnit="m" serviceAttributes=""
  subLayers="ocean,country-lg,country-sm,gmted-colorelev,gmted-relief,state-cover-highres,srtm30-colorelev,srtm-relief,lakes-lg,lakes-sm"
  subLayerNames="Ocean,Country,Country-sm,Int'l Color Elev,Int'l Relief,State,CONUS Color Elev,CONUS Relief,Lakes-lg,Lakes sm"
  menuGroup="mapserver" />

• ATEC Jazz Issue #24 - Defer WMS GetCapabilities so doesn't hang the app
  Defer WMS GetCapabilities to first map request on background thread, so that if the server is down, it doesn't hang up the constructor initialization waiting for timeout.
   - 
  Updated WMS GetCapabilities call to happen on a separate thread, and to revalidate the ValueObject once it is complete, so that the WMS Layer will be loaded. This fixes the long "hang" on startup when the server is unavailable, and refreshes automatically once it is available. Users may notice the map data appearing after other data, if the WMS server is slow.

• Added "click" zoom controls as an alternative to the existing "rubberband" zoom controls
  The new click zoom style is an option; The old rubberband zoom style is still the default. When "click" zoom is selected, the following behaviors are enabled:
  • double-click zooms into the map by a factor of 2, centered on the click location
  • right-click zooms out the map by a factor of 2, centered on the click location
  • click-drag pans the map without zooming
  When click zooming is configured, the toolbar does not have the zoom, zoom forward, or pan buttons. The only toolbar button for zooming is the "zoom back" button, used to revert to the previous zoom area. Additionally, when the click zoom style is selected, the mousewheel can be used to zoom in or out. The amount of zoom is determined by the "mouseStep" attribute, but defaults to 0.25 for every 10 wheel clicks. Zooming in or out is not centered on the mouse location, but maintains the existing centerpoint of the map.
   - 
  To enable click zooming, set the <View> attributes below:

  zoomStyle

  the zoom and pan style to use, either 'rubberband' or 'click' (Optional, defaults to 'rubberband').

  mouseStep

  the zoom factor between 0 and 1 to apply with 10 clicks of the mousewheel (Optional, defaults to 0.25x/10clicks)

• Shapefile reference, configuration, and rendering improvements
  <SHAPEFILE> Layers are now configured by pointing to the *.shp file with the "location" attribute. The required *.dbf file (which contains the attributes) is automatically expected to exist within the same directory as the main Shapefile, with the same name up to the extension.
  <SHAPEFILE> Layers now support configuration attributes for specifying the line width and color for line and polyline features, the symbol image or size for point features, and the color and size of the font used to render the label(s) of the selected Shapefile attribute(s).
  All of these configuration options are available in the Jazz config file, real-time in the "Customize" menu, and are preserved when saving views.
   - 
  The new attributes for Shapefile Layers are:

  location

  the required location of the Shapefile (*.shp) as a filepath or a Java location, such as "file:", "http:", or "ftp:".
  The associated "*.dbf" file is expected to have the same filename prefix in the same directory.

  width

  the optional width of the line, polyline, or feature icon to be rendered, in pixels. (Defaults to 1.0)

  symbol

  the optional location of the image to render for feature datasets, as a filename or URL. (Defaults to a simple circle)

  color

  the optional color of the line, polyline, or default feature. (Defaults to java.awt.Color[r=0,g=0,b=0])

  labelAttributes

  the optional feature attribute to use for the labels, as a comma-separated list. If empty, no labels are rendered.

  labelSize

  the optional point size of the labels. (Defaults to 10)

  labelColor

  the optional color of the labels. (Defaults to java.awt.Color[r=255,g=255,b=0])

• Improve diagnostics for Out Of Memory Errors
  The large red error box that informs users that the application has run out of memory doesn't provide any information other than the suggestion to restart Jazz.
   - 
  Added the JVM arg "-XX:+HeapDumpOnOutOfMemoryError" to dump the heap state to a file when an Out of Memory Error occurs. The file will be written to the local directory as a java_pid.hprof file which can be loaded into a memory profiler. Also stubbed in the explicit writing of the heap state from the exception trapping, but access to the MBean is not available with the current Java version. Add in the final behavior when this is resolved in a future version.