New Features

This section contains the significant new features or changes in Stroom. For a full list of changes see Change Log.

User Interface

Jobs Screen

• Rows are now greyed out if one of the following is true:

  • The parent job is disabled.

  • The job is disabled on a specific node.

  • The node itself is disabled.

• The column Next Scheduled has been added to the detail pane to show the time that the job will next run.

• The details pane now has an Actions menu ( ) where it is possible to do the follow actions to a job on a specific node.

  • Edit the schedule for job on the selected node.

  • Run the job on the selected node now. This will run the job within 10s or so once clicked. Monitor the Last Executed column to see when it has run.

  • Show in Server Tasks (selected node). This will open the Server Tasks screen with the quick filter set to the selected job and node.

  • Show in Server Tasks (all nodes). This will open the Server Tasks screen with the quick filter set to the selected job.

  It is now possible to link directly to the Nodes screen by clicking the Open hover button next to the node name.

Nodes Screen

• A jobs detail pane has been added to show the jobs on that node. This shows all jobs and allows jobs to be enabled/disabled on a node. It also shows the state of the parent job and the node. The button can be used to show only the enabled jobs on that node.

  An auto-refresh button has also been added to keep refreshing the jobs detail pane so the Last Executed and Next Scheduled columns are updated.

  It is also possible to link directly to the Jobs screen by clicking the Open hover button next to the job name.

• Nodes rows are now greyed out if the node is disabled.

• Job rows are not greyed out if one of the following is true:

  • The node is disabled.
  • The parent job is disabled.
  • The job is disabled on a specific node.

• The column Build Version has been added to show the version of Stroom that the node is running. This is to highlight any nodes running the wrong version.

• The column Up Date have been added to the Nodes screen to show the time that Stroom was last booted on that node.

• The Ping column screen has been changed so an enabled node with no ping stands out while a disabled node does not.

New Look and Feel

The Login, Change Password and Manage Accounts screens have been changed to bring their look and feel in line with the rest of the application. The screens may look a little different but are functionally the same.

Dictionaries

The Dictionary screen has been changed to make it easier to manage the import of other Dictionaries.

The Import sub-tab has been changed to include a detail pane that shows the effective word list for each imported Dictionary. This will show all words in the imported dictionary along with any from Dictionaries that it imports from.

A Effective Words sub-tab has been added to show the effective list of words in the Dictionary, i.e. combining all words from the dictionary, its imports and any dictionaries imported by those imports.

Authentication Error Screen

If there is an authentication error during user login, e.g. the account is disabled or locked, the user will now be redirected to a configurable error screen rather than back to the login screen.

The content of the lower part of the dialog is configurable via the property stroom.ui.authErrorMessage. This property accepts HTML content. This the message to contain details of how to contact the appropriate Stroom admin team.

Queries

Editor Code Completion

The code completion in the Query editor has been changed to make the code completion suggestions context aware. For example if you have just typed in dictionary and then hit Ctrl ^ + Space ␣ it will suggest the names of Dictionary documents that are visible to the user.

Dictionaries and Visualisations have also been added to the list of Query Help items (in the left hand pane) and to the available code completions.

Table Download

You can now download the results of a Query using the icon.

Functions in select

Functions, e.g. count() can now be used within the select clause of a StroomQL query.

Dashboards

Sorting

Now when you change an existing table sort on a dashboard it does not require the query to be executed again. The table data will change to reflect the new sort settings. This is particularly useful on complex queries or those operating on large amounts of data.

Dictionary List Input

When using a List Input pane on a Dashboard that is configured with a Dictionary , the drop-down now shows the source of each Dictionary word.

Other UI Changes

• The explorer tree now shows the name of the item in the hover tooltip. This is useful if the name extends beyond the limit of the explorer tree pane.

• Issue #4339 : Allow user selection of analytic duplicate columns.

• Issue #3989 : Improve pause behaviour in dashboards and general presentation of busy state throughout UI.

• The way dialogs can be moved or resized has been improved so that they can be resized on any edge or corner. The area for clicking and dragging to move a dialog has been increased to include all of the title section.

Permissions

• Document deletion will now also delete all associated document permissions granted to user/groups. This previously did not happen on document delete so orphaned document permissions would build up in the database.

  The DB migration V07_04_00_005__Orphaned_Doc_Perms which will delete all document permissions (in table doc_permission) for docs that are not a folder, not the System doc, are not a valid doc (i.e. in the doc table) and are not a pipeline filter. Deleted document permission records will first be copied to a backup table doc_permission_backup_V07_04_00_005.

• Document Copy and Move has been changed to check that the user has Owner permission (or admin) on the document being copied/moved if the permissions mode is None, Destination or Combined. This is because those modes will change the permissions which is something only an Owner/admin can do.

Content Search

The Find in Content screen added in v7.3 has been changed to add Lucene indexing to speed up content searches. The Lucene index will be created when a user first uses the content search. The user may see an error message on first use telling them to wait for the index to be built.

The index is located in <stroom.path.temp>/doc-index, which unless explicitly configured will likely be /tmp/doc-index.

Volumes

• The tables on the Data Volumes and Index Volumes screens have been changed to low-light CLOSED/INACTIVE volumes.

• Tooltips have been added to the Path and Last Updated columns.

• The Use% column has been changed to a percentage bar.

• Red/green colouring has been added to the to the Full column values to make it clearer which volumes are full.

Dependency Documents

Missing Dependencies

Various screens include document pickers to select a dependency document, e.g. selecting an extraction Pipeline in the Dashboard table settings. The document picker will now show a icon to indicate the previously selected document is not longer visible to the user or has been deleted.

Tagged Documents

Various screens require the selection of an extraction, or reference loader Pipeline, i.e.:

• View - Extraction pipeline
• Index - Default extraction pipeline
• Dashboard - Extraction Pipeline
• Pipeline - Reference loader pipeline

To distinguish processing pipelines from extraction or reference loading pipelines, the Pipeline documents can be tagged with pre-configured tags such as extraction and reference-loader. This means the Pipeline picker screen can be pre-filtered on the appropriate tag to make finding the right document easier.

It is recommended to tag all such pipelines using these tags to make document selection easier for other users.

This system defined tagging is configured using the following properties

• stroom.explorer.suggestedTags
• stroom.ui.query.dashboardPipelineSelectorIncludedTags
• stroom.ui.query.indexPipelineSelectorIncludedTags
• stroom.ui.query.viewPipelineSelectorIncludedTags
• stroom.ui.referencePipelineSelectorIncludedTags

API Keys

The API keys screen has changed to allow selection of the hashing algorithm used to store a hash of the API key.

Processing

S3 Appender

A new S3 pipeline element S3Appender has been added to enable the streaming of data to an S3 bucket.

The S3 Appender requires the creation of an S3 Config document to provide the credentials and role details for connecting to the S3 bucket. The content of the S3 Config document is JSON and the JSON Schema describing its structure can be found here .

Stepping

The stepper has been changed to allow termination of the step. This is useful when stepping large streams or when using filtered steps.

The fact that the step is in progress is indicated by a label above the pipeline elements.

Other Changes

• Issue #4444 : Change the hash() expression function to allow the algorithm and salt arguments to be the result of functions rather than just static values, e.g. hash(${field1}, concat('SHA-', ${algoLen}), ${salt}).