Squirro 3.0.0 - Release Notes


We're excited to announce Squirro 3.0.0, released on 10th of March 2020.

Contents - What's in the release?

New Features

Python 3

  • A big change in this release is actually not visible from the outside, but changes everything under the hood: We updated the Python version from 2.7 to 3.6. 

    Bildergebnis für python 3.6 logo
  • Currently Squirro is still shipped with both, Python 2 and 3. The reason for that is compatibility with all existing python plugin code that is out there, be it in form of pipelets, dataloaders or studio plugins. All services that run external code are configured to still run in Python 2. You find more information about that in Python 2 to Python 3 migration documentation.

Dashboard Sections

  • We added a new layer of flexibility when designing awesome dashboards: sections.
  • Sections come in five flavours: center, left, right, top and bottom and are the main element when structuring a single dashboard. Within a section you can add layers and widgets the same way you are used to do on a dashboard level.

  • Existing dashboards will occupy the center section and have all other sections disabled.

Basic functionalities

  • On the dashboard level, you can select which sections you want to use:
  • The scrolling of the individual sections can be chosen to be independent between the sections or connected.
  • Top and Bottom sections can be set to expand or to be pinned to the dashboard.
  • The width of the Left, Center and Right section can be changed in the dashboard setup space.

Dashboard Theming

  • Squirro 3.0.0 exposes enhanced dashboard styling and theming in the Frontend.
  • In the SETUP space under VISUALIZE you have access to all available themes and can create your own ones.
  • Here you can specify any custom CSS styling  and directly see a preview with the respective style applied to any available dashboard in the project.

Custom Widgets Editor

  • Squirro 3.0.0 ships with a custom widget editor on the Frontend with a Github integration.
  • In the SETUP space you find all Custom Widgets in the VISUALIZE tab where you can create, edit and delete them.


  • All custom widget files are exposed and can be edited directly in the frontend without the need of a separate editor.
  • The editor also supports syntax highlighting.
  • Furthermore, you can integrate into Github and import your custom widgets from Github or export your custom widget as a zip file to your disk.
  • The GitHub integration is enabled with a GitHub token under the user account space:

Compact Navigation Bar

  • Squirro 3.0.0 comes with the option to use a Compact Navigation Bar and Compact Icons:
  • The new feature can be enable under VISUALIZE → App & Nav Bar in the Setup space

Entities Feedback Functionality

  • Squirro 3.0.0 comes with a new feedback functionality that enables enhanced user feedback to improve the classification models:
    .    


Improvements

  • Unification of the way we display dates and times in the various date/time pickers.
  • Improved Squirro Widget SDK documentation: https://docs.squirro.com/en/latest/#

  • The dashboard grid size was change to a row height of 8 px and allows now a minimum width of 1 px.
  • Removal of many legacy tools and migration scripts


Bug Fixes

 Click here to see most relevant Bug Fixes & Improvements
  • SB-136 - Rich text formatting issues
  • SB-313 - Can't type 's' on RTE widget when having an item detail widget
  • SB-349 - Small language change for email validation
  • SB-370 - Support array on userPref
  • SB-395 - RTE widget content is not scrollable
  • SB-396 - Breadcrumb widget action chips always visible
  • SB-413 - Users page number of results dropdown doesn't always work
  • SB-414 - Request demo url is wrong
  • SB-415 - Catalyst mapping in incorrect classification feedback popup is not working correctly!
  • SB-416 - Selection tagging is removing consecutive spaces from sentence
  • SQ-10748 - Force sending empty array when all tags are removed from the single facet
  • SQ-10751 - Cards Widget: Padding on CTA is wrong
  • SQ-10880 - Entities highlights not working on result widget with only entities enabled
  • SQ-10886 - implement-multi-value-selection-for-facets-list
  • SQ-11172 - Replacing long URLS with only the domain name or source name in case of PDF
  • SQ-11219 - Users List filter dropdown doesn't always work
  • SQ-11261 - Facets List Widget: Facet List Order config does not work
  • SQ-11265 - Tag Cloud widget: Legend is always empty
  • SQ-11266 - Trend Widget: Y axis label is in the wrong side
  • SQ-11277 - Direct access to search tagging edit url fails
  • SQ-11283 - Sort loaders alphabetically
  • SQ-11311 - Line height for share item is wrong
  • SQ-11319 - Link widget delete icon issues
  • SQ-11370 - Do not limit Link widget to 4 columns
  • SQ-11376 - Smartfilter widget does not render in edit mode
  • SQ-11410 - Topic cluster filtering is not working
  • SQ-11571 - Prevent fetching recommendation catalysts on item detail if not needed
  • Only allow master dashboard promotion and demotion for admins


Added on March 17, 2020 (build 49 - Patch 1)

  • Fix deprecation warnings in the logs.
  • Fix plain text internal status endpoint
  • Add label of POS type X
  • Show dashboard properties  as default on edit
  • Fix sections outline leaking out of container in ie-11
  • Scroll widgets and views back to top on click of the same dashboard tab
  • Changing style of keyword editing on 'Search Tagging'
  • Improve breadcrumb flow on adding / editing new data
  • Small padding issue on the bottom of form config properties
  • Nav chips does not have exact same config as it's base, removed 'all tab config
  • Transparent BG in edit mode
  • Dataloader CSV string vs. newstr issue
  • Project configuration template file read error
  • SB 423 - Line Chart not working if no timebound is specified 
  • Make dropdown appear out of it's container on sub panel
  • Compact nav improvement for restricted users
  • SQ-11677 - CSV walkthrough is not alright
  • Project list: Facet dropdown appears on top of the list
  • Fix section caching
  • Fix throw when using items factory
  • Fix missized widgets
  • Fix horizontal scroll on mobile
  • Properly pad dashboard list rows
  • SQ-11690 - Result list widget is not showing entity info anymore
  • SQ-11708 - Widget editor fails when custom widget has no files
  • Fix widgets caching
  • Update sphinx version
  • Provider API depends on lib.source
  • Fix duplication of dashboards

Added on March 20, 2020 (build 50 - Patch 2)

  • SQ-11722 - cant scroll on mobile
  • SQ-11608 - Compact navbar issue with the dashboard edit button
  • SQ-11675 - IE11 - Widget dashed border is popping out of the dashboard container

Added on March 24, 2020 (build 52 - Patch 3)

  • SQ-11525 - Remove extra step in Pipeline workflow navbar
  • SQ-11731 - On a real device you can not scroll the modal window
  • Facet Table - Allow Wide Modal to exist on mobile

Added on March 25, 2020 (build 53 - Patch 4)

  • Fix for parsing of encrypted config using external commands.
  • More robust healthcheck studio plugin.

Added on [TBC], 2020 (build [TBC] - Patch 5)

  • Set after_id to None explicitly if not set
  • allow `after_step_id` to be None to move to the first position
  • SQ-11696 fix creation of trend detections
  • SQ-11478 - Facet display frontend bug and issues editing in the data loader UI
  • SQ-11268 - Fixing dashboard saved changes when no changes have been made
  • SQ-11749 - Allow space on the modal for the toolbar and toolbar icons
  • Documentation was wrong for how Mock factories work
  • Fixing unit test issues for emailsender service
  • SQ-11402 - Have case-insensitive sorting for facets in the facets list widget
  • Small typo in navbar
  • SQ-11774 - Issue with list overflow
  • SQ-11765 - Timestamp as a datetime value in the dataloader
  • Support multiple facets in Table widget
  • Hide single dashboard in compact navbar
  • Fix broken store reference (rare throw)
  • SQ-7947 - Fix shadows everywhere
  • Show selected values in facet list dropdowns

Added on [TBC], 2020 (build 56 - Patch 6)

  • Adjust clickable area of the table widget

Added on April 24, 2020 (build 57 - Patch 7)

  • SQ-11804 - Clicking on the dashboard tab should reset the page
  • Fix pie charts not rendering
  • SB-421 - Fix keyword editing and saving on data loading step 4

Added on April 25, 2020 (build 57 - patch 8)

  • Switch from Oracle JRE to latest iteration of openjdk-1.8 (242).
    • Please refer to the updated ugrade instructions below.
  • Update python2 to version 2.7.17.
  • Update python3 to version 3.6.9.

Added on April 29, 2020 (build 58 - patch 9)

  • SQ-11196 - Item detail widget: 'Filter dashboard by tags' option doesn't work
  • SQ-11775 - Issues with layers and chevrons being displayed in Time Widget
  • SQ-11037 - Fixing word cloud legend display names
  • SB-89 - Facets Widget Dropdown display issues
  • SQ-11792 - Facet dropdown: In multi-select, pin the buttons to the bottom of the dropdown
  • lib/nlp fixes for tutorial on /wiki/spaces/TRAIN/pages/1475444765

Added on May 4, 2020 (build 59 - patch 10)

  • Add support for ES 2020.
  • Fix bug where query matches on PDF files were being cached.

Added on May 5, 2020 (build 60 - patch 11)

  • SQ-11864 - Creating new sources lack a 'name' field on data load and prevent loading data in the UI.

Added on May 14, 2020 (build 61 - patch 12)

  • Added a new built-in dashboard reducer, $getDate

Added on May 26, 2020 (build 62 - patch 13)

  • SQ-11892 - Bar Chart: Legend shows facet names and not facet display names
  • SB-432 - breadcrumb widget doesnt work
  • SQ-11887 - Fix autosize issues
  • SQ-11934 - Facet List widget with Multi selection enabled doesn't correctly show the selections

Added on May 28, 2020 (build 63 - patch 14)

  • Optimised widget query performance

Added on May 29, 2020 (build 64 - patch 15)

  • SQ-11954 - SavedSearch.getFacets() fails
  • SB-446 - IE scroll bars

Added on June 9, 2020 (build 65 - patch 16)

  • SQ-11958 - Issue with quoted search
  • SB-441-entity-issues - REC Input not displaying when on layer
  • Performance: Reuse custom widget asset calls

Added on June 16, 2020 (build 66 - patch 17)

  • Add feature flag to disable css variables ponyfill on IE11

Added on June 18, 2020 (build 69 - patch 18)

  • SB-454 - Result List doesn't update when switching tabs - (cache-busting issue)

Added on July 17, 2020 (build 71 - patch 19)

  • SQ-12066 - Twitter widget stopped working
  • SQ-11776 - Reset button completely missing
  • SB-419 - Facets widget does not show the display names of the facets
  • Fixed _getOtherSearchQueries() in Search Bar Widget

Installation & Upgrade

Fresh Installation Instructions

Please follow the regular installation steps

Upgrade Instructions

Please ensure that your current version is 2.6.5. If you are on a version older than 2.6.5, please contact support.

 1. Upgrade Storage Nodes and Cluster Nodes collocated on the same machine/VM
RHEL6 / CentOS6 / RHEL7 / CentOS7
yum install java-1.8.0-openjdk (If not already installed)
yum update java-1.8.0-openjdk
yum update squirro-storage-node-users
yum update squirro-storage-node
yum update squirro-cluster-node-users
yum update squirro-*
yum erase jre

Resolve all the .rpmnew files in /etc/squirro/ and finally restart the services with changed .ini files (or just use squirro_restart to restart all services).

 2. Upgrade Storage and Cluster Nodes when they are on different servers (and there is only one storage node and one cluster node)

Upgrade the storage node by running:

RHEL6 / CentOS6 / RHEL7 / CentOS7
yum install java-1.8.0-openjdk (If not already installed)
yum update java-1.8.0-openjdk
yum update squirro-storage-node-users
yum update squirro-storage-node
yum erase jre

Upgrade the cluster node by running:

RHEL6 / CentOS6 / RHEL7 / CentOS7
yum install java-1.8.0-openjdk (If not already installed)
yum update java-1.8.0-openjdk
yum update squirro-cluster-node-users
yum update squirro-*
yum erase jre

Resolve all the .rpmnew files in /etc/squirro/ and finally restart the services with changed .ini files (or just use squirro_restart to restart all services).

 3. Upgrade multi-node clusters (multiple Storage Nodes and/or multiple Cluster Nodes)

Upgrade every storage nodes by running:

RHEL6 / CentOS6 / RHEL7 / CentOS7
yum install java-1.8.0-openjdk (If not already installed)
yum update java-1.8.0-openjdk
yum update squirro-storage-node-users
yum update squirro-storage-node
yum erase jre

Upgrade each cluster nodes by running:

RHEL6 / CentOS6 / RHEL7 / CentOS7
yum install java-1.8.0-openjdk (If not already installed)
yum update java-1.8.0-openjdk
yum update squirro-cluster-node-users
yum update squirro-*
yum erase jre

Resolve all the .rpmnew files in /etc/squirro/ and finally restart the services with changed .ini files (or just use squirro_restart to restart all services).