Squirro 2.6.4 - Release Notes

We're excited to announce Squirro 2.6.4, released on April, 23rd 2019.

Known upgrade limitations:

  • If you are using custom widgets based on the horizontal result widget or the card widget in one of your projects, do only update to 2.6.4 if you are sure that your custom widgets are changed to the new widget types or work with the new widget class. Please contact support in case of questions to clarify required steps.

Contents -What's in the release?


New Features

Dashboard Permissions:

  • Every dashboard in a project can be restricted on a per-user/per-group basis.
  • View-only and view-and-edit rights are available.
  • The default state of the dashboard is un-restricted, i.e. project admins & members have view-and-edit, while project readers have view-only permissions.
  • Simple restricting of a dashboard will make it view-and-edit for admins and project members, but blocked for readers.
  • Dashboard access can be granted via group membership.
  • Explicit user permission has precedence over group permissions.

Data Sources

  • Data Source Overview Page:
    • Includes now information of how many items are indexed or are still in queue.
  • New Feed Data Loader Plugin
    • Support for RSS and Atom feeds
    • Unified experience conforming with other data loader plugins
  • Rearrangement of data source categories: Squirro Data Sources

Entities

  • With 2.6.4 the use of entities is significantly improved throughout Squirro, particularly on the frontend.
  • Entities are now visible in a side-pane for each item.
  • Entity Highlighting: Jump to entity extract within the item view when selecting respective entity.

PDF Preview Generation

  • PDF Preview generation can now be enabled in the "Thumbnail Extraction" step.
  • PDF Previews can be displayed in the Cards widget and the Result List Widget.

Project List Search

  • There is now an option to search through all projects in Squirro.

Group Management Page

  • We added a new group management page, that shows all members of a group and enables the addition and deletion of group members.
  • The Group Management Page can be found under Server management → Groups → Edit a Group.

Widgets & Dashboard

New Widgets

  • User Preferences Widget

    • We created a User Preferences widget that can be used to set user-specific parameters. In the setup, a facet can be selected and the facet values will be available for type-ahead and be stored as user-specific parameters.
    • These user-specific parameters can then be used to set up user-specific dashboards.


Widget Improvements and Changes

  • Card Widget:

    • Reworked the card widget to enable document preview and facet display on cards.
    • Many customisation options. Detailed description can be found here.


  • Result List Widget
    • Complete refactoring of result list widget.
    • Addition of third pane in the middle that hosts Query Matches, Smartfilters, Duplicates and Entities:
      • Query Matches: Jumps to query matching extracts within item.
      • Smartfilters: can select smartfilters and show matching passages in item
      • Duplicates: If duplicates exists, this allows you to switch between duplicates
      • Entities: Shows all entities and allows filtering by entity category. Clicking on an entity will jump to entity within item.

Dashboard & Layer

  • New Layer Resizing Options:
    • "No-Autosizing":
      • will not resize the layer/dashboard
    • "Autosize widgets to fit frame":
      • can be used on layers to grow AND SHRINK a layer to fit the available space
        (The shrinking can cause undesired dashboard looks and widgets being very small.)
    • "Preserve minimum widget size":
      • This is a new option that allows for a layer to grow but widgets cannot shrink.
      • This option can be used to plan minimum widget size. A dashboard designer will need to set the minimum size of a widget on the layer, then activate this option and the layer will grow to use most space.
        When shrinking the browser window the minimum height will be preserved and the dashboard will introduce a shrinking if the available space is below the minimum size.


Improvements

Major Code Cleanup

  • Removal of significant amount of legacy code (Explore Page, etc.)
  • Removal of deprecated assets.

Other Improvements

  • Update of several libraries to the latest versions

Bug Fixes & Improvements

 Click here to see most relevant Bug Fixes & Improvements
  • SQ-50DocumentUploader uses document creation date even if invalid, if no "created_at" value is passed
  • SQ-51Improvement - Make the Project name the page title of the page
  • SQ-65Layer autosize to fit frame: Layer configured so has bottom of the widgets cut off
  • SQ-76Not supported browser message not displayed for IE 10
  • SQ-101In Item body, Smart Filter section header should be called 'Smart Filter Matches'
  • SQ-144Annoying Tab widget Bug
  • SQ-145Layers - Visibility Condition breaks on complex dashboard
  • SQ-149Missing Widget Padding for new Word Cloud Widget
  • SQ-202spaces not removed from email during user creation
  • SQ-207When result list / facet table displays item in side panel, the item count should be on top right of the list.
  • SQ-238Confusing Next Run date display due to delayed job execution
  • SQ-239Cannot filter facets by 'weighted' type
  • SQ-250Scheduling options are not rendered in FE for data sources in edit mode
  • SQ-253Map Widget: Refine region map config. phrasing
  • SQ-254'Legend Position' config. not in proper case for all widgets
  • SQ-265Item Detail widget: The Item heading should be center-aligned with the star icon
  • SQ-270Mobile dashboards with charts has bottom-most widget cut off
  • SQ-279Can't drop in PDF to create Smart Filter
  • SQ-292Entity: When filtering for entities the entity type is returned but the content is missing
  • SQ-298REC Input Widget: Duplication of Text over 2 lines in

Added on April 30, 2019 (build 181, patch 1)

  • Fix html encoding issues in item abstract and item title view.
  • Security improvements for dashboard permissions.
  • New categories and logos for the data sources supported by Squirro on the Load tab.

Added on May 15, 2019 (build 183, patch 2)

  • Fix facet table resize
  • Fix packaging of language detection module
  • Fix typeahead highlighting for rare cases where special characters are part of the suggested values

Added on May 21, 2019 (build 185, patch 4)

  • Fix broken query for typeahead suggestions with parentheses.
  • Sort typeahead facet name suggestions alphabetically
  • Custom time not set if hour is not specified
  • Only print item detail when clicking on print icon

Added on May 31, 2019 (build 186, patch 5)

  • Fix for unsupported browser screen not working for compatibility mode.
  • Fix for this.user undefined in getItemTemplateParams

Added on June 14, 2019 (build 189, patch 7)

  • Fix for a critical vulnerability where facets from other projects can be requested in the scope of the current project.
  • Fix for this.user undefined in getItemTemplateParams.
  • Ensure only one time_increment is used if more than one time_increment are specified.
  • Allow to use _score in scripted es_sort clauses.
  • Add option to select/deselect pipeline workflows in project import/export
  • Usability improvements to ML studio plugins.

    • Display ML workflow name instead of id
    • Picker for ML workflows when creating a new ML job

Added on June 26, 2019 (build 192, patch 9)

  • Fix for the reset API of items in the Ingester for a particular source.
  • Rerun enrichments cli (and studio plugin) now uses the scan API instead of query API
  • Improve loading performance of user list
  • Add a debugger step to the machine learning service pipeline for logging
  • Allow for facet field search with special syntax: $keywords.<facet_name>.indexed:<query>

Added on July 4, 2019 (build 193, patch 10)

  • Fix for Twitter card resizing bug.
  • Support for multi-value selection on the table widget.
  • Support for export/import of Squirro items with export/import of Squirro Project.
    • Support for export/import of binary documents is not supported.

Added on July 11, 2019 (build 194, patch 11)

  • Fix for Twitter cards 

Added on July 19, 2019 (build 195, patch 12)

  • Fix for width of pdf items preview too small
  • Added Copy Link to Clipboard feature
  • Custom ItemDetail Toolbar API

Added on July 26, 2019 (build 198, patch 13)

  • Show item link in result list
  • Reordering API for custom detail toolbar
  • Fix for: Facets Table does not respect creation date format setting
  • Fix timeline widget parametrisation
  • Fix for Word Cloud: Legend shows facet names and not facet display names
  • Fix for Facets table Widget: Table not using full widget height when "Hide table header" activated
  • Enable thumbnail-related fields to be passed on through the dataloader (webshot_url, height and width)

Added on July 26, 2019 (build 200, patch 14)

  • Fix word cloud sizing
  • Line chart with single point is now visible
  • Fix for item details view icons overlapping with pdf view
  • Result List Widget Header is visible when no results returned.

Added on July 30, 2019 (build 201, patch 15)

  • Unify chart behaviors, on click hide other series
  • Make new source copy link always visible
  • Return breadcrumb shortening pattern

Added on August 9, 2019 (build 202, patch 16)

  • Line chart improvements and fixes

Added on August 26, 2019 (build 203, patch 17)

  • Line Chart Labels are now persisted
  • Adding option to configure the item metadata source
  • Date format configuration configures both the result list and the detail view
  • pipelet-rerun: fixed type of batch-size argument

  • Time breadcrumb/chip is shown also if no other query is done

Added on August 29, 2019 (build 207, patch 18)

  • Feed parser dataloader: allow adding custom date fields & formats
  • Add search bar to 'Project Members' page
  • Add pagination to Users List page
  • Add search to users page
  • Build onboarding component support
  • Fix user fetching on splash screen
  • Fix custom time filter can't be removed

Added on September 3, 2019 (build 211, patch 19)

  • Fix facet table, pdf open on matching page 
  • Fix matching pages panel opening
  • Fix pdf sizing after previous or next

Added on September 16, 2019 (build 215, patch 22)

  • Fix double progress bars in setup space

Installation & Upgrade

Fresh Installation Instructions

Please follow the regular installation steps

Upgrade Instructions

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

 1. Upgrade Storage Nodes and Cluster Nodes collocated on the same machine/VM
RHEL6 / CentOS6 / RHEL7 / CentOS7
yum update jre
yum update squirro-storage-node-users
yum update squirro-storage-node
yum update squirro-cluster-node-users
yum update squirro-*
 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 update jre
yum update squirro-storage-node-users
yum update squirro-storage-node

Upgrade the cluster node by running:

RHEL6 / CentOS6 / RHEL7 / CentOS7
yum update jre
yum update squirro-cluster-node-users
yum update squirro-*
 3. Upgrade multi-node clusters (multiple Storage Nodes and/or multiple Cluster Nodes)

Upgrade every storage nodes by running:

RHEL6 / CentOS6 / RHEL7 / CentOS7
yum update jre
yum update squirro-storage-node-users
yum update squirro-storage-node

Upgrade each cluster nodes by running:

RHEL6 / CentOS6 / RHEL7 / CentOS7
yum update jre
yum update squirro-cluster-node-users
yum update squirro-*