Skip to main content

TSearch Widget Library

A Widget Definition defines what the widget does, the type of widget it is and any custom fields required. When a Widget Instance is created from a Widget Definition, it then defines the values for the standard and custom fields of the Widget Definition. More Details

The following list will give users an overview of how each widget can be applied to their General TSearch Platform to control the look feel and functionality.

Add To View

Widget Overview

The Add to View Widget is a content action widget placed in the body of your template.

It will appear under Document Actions and Bulk Document Actions and allows the user to add one or multiple documents to a different view by copying the indexed metadata to that views source.

Using the Add to View Widget

For a single file:

  • Click the checkbox next to the file you want to add to another view.
  • Click the document action button.
  • Select Add to View from the dropdown menu.
  • In the popup window select the content view you want to add the file to.
  • Click the Add button.

For multiple files:

  • Check the boxes next to the files or check the Select all box to add all files in the search results
  • Click the Bulk Document Actions button in the Top Menu
  • Select Add to View from the dropdown.
  • In the popup window select the content view you want to add the files to.
  • Click the Add button.

A Render Viewer

Widget Overview

A content action widget that allows the user to seamlessly view and access content from any system or repository.

Tutorial: Setting up Preview with ARender

Using the ARender Widget

Click on Document Actions and select the label assigned to the widget (Preview). A window will pop up giving you a preview of the file.

From the popup window you can do any of the following actions

  • View file information
  • Download or print the file
  • Add and refresh annotations such as highlight areas or add text
  • Change the contrast and brightness
  • Zoom in and out
  • Search the text
  • Add and remove bookmarks to pages
note

After publishing, it may take a few minutes for this option to show up in your document actions depending on the number of files indexed.

Autocomplete

Widget Overview

The Autocomplete widget will allow you to perform autocomplete searches on facets.

Using the Autocomplete Search Widget

  • Begin typing the name of the file or parts of the filename
  • Autocomplete will return files that match the characters entered
  • Click on the file in the dropdown you are searching for
  • TSearch will filter your results to display the file selected
note

All the facet values are queried once and then stored in your browsers cache so is not ideal for facets that have more than a few hundred unique values. In that case the TSearchFacetSearchWidget is preferred. However, for facets that have less than a few hundreds unique values this is a good choice.

For Elasticsearch - Text fields are indexed two ways when outputting to Elasticsearch. In order to get untokenized fields (whole file names, etc.), the field in the search connector and on the widget instance requires appending ".raw". The simflofy_filename field will always have this applied as part facet queries to allow for file name searches to work.

Boolean Toggle

Widget Overview

The Boolean Toggle widget toggle's a true/false facet when added to the left sidebar of a template.

This widget requires its field be set to a single boolean (true or false) field.

It will create a sidebar panel with a single checkbox.

Using the Boolean Toggle Widget

When checked, only documents with that boolean field set to true will be shown in the search results.

Bulk Download

Widget Overview

The Bulk Download Widget is a top menu widget that allows users to download multiple files in a compressed (zip) file.

There is no limit to the number of files you can download as long as you have enough room in your storage.

Using the Bulk Download Widget

  • Select the checkbox next to the files you want to download. Use the select all checkbox to download all of the files in your search results
  • Click the Bulk Document Actions button in the top menu
  • Select Download Selected from the dropdown menu
  • The files will be bundled into a zip file, and will be available for download from the Exports page

Chart Facet

Widget Overview

The Chart Facet Widget is a content type widget that allows a user to build a chart based on the search results and filters tied to the field entered on the widget instance.

Changing your search using facet search widgets will update the chart as you drill down.

Chart types: Doughnut, Pie, and Bar
Chart sizes: Small (sm), Medium (md), and Large (lg)

Content View Builder

To use this widget the Dashboard widget must be added to the content view body section. Most content action widgets will not function with the dashboard widget.

Tutorial: Creating a Chart Driven Dashboard

Checkbox Or Facet

The Checkbox or Facet Widget adds a checkbox option that will allow the user to filter their search results based on if the checkboxes for a field's values are checked or not. Allowing users to filter on multiple options.

For example, when using it for simflofy_connectorid, this widget will allow you to select multiple repositories.

Check In File

The Check In File Widget allows you to revert a checkout, or check in a file, updating its content while optionally attaching a comment. This widget can be added to body section of your view and will call both the check-in method, and the update method of the content service connector that is referenced for your file.

Using the Widget

  • Undo Checkout: If checked, this will clear the other options from the widget. Once "Check"In is clicked, your file will be Checked In, with any changes discarded.
  • (Optional) Check In Comment: Add a comment here to go along with your check in. This is used when a file is selected to be the content update for your check in
  • Choose File: Choose the file that will be the updated content for your check in.

Checkout File

The Check-Out File widget allows you to call the check-out content service connector method on a file in your view.

The icon appears as a single blue checkmark. This widget can be added to the body section of your view. Documents that are checked out have the calendar-check symbol next to their names

Connector Report

The Connector Report Widget is a result set widget that gives the user a searchable report of the selected connectors. It shows a usage report for the configured search connection and includes the most commonly used terms and searches per day.

Result Widget Requirement

This widget can only be used with the Dashboard Widget

The Current Search widget is a facet search widget that adds any filters being applied to the result set to the top of the page. You can remove any applied filters using the delete button next to each condition.

You can also save the search results based on the added conditions allowing you to use the saved searches widget to rerun your search with the same conditions at a later time.

important

This widget is required for any content views based on the Simflofy Template.

Dashboard

The Dashboard Widget is a result set widget for a simple dashboard of charts used to view the count of files searched.

The charts are based on the conditions set in the Chart Facet widgets added to the content view.

Tutorial: Creating a Chart Driven Dashboard

Content View Builder

You cannot have any other result set widgets in the body of the content view while using this one.

Most content action widgets will not function with the dashboard widget.

Date Select

The Date Select Widget is a Search Type Widget that allows users to select a Date field and then perform range, before, after and same day searches on that field.

Common search fields are:

  • simflofy_last_modified
  • simflofy_created

Download

The Download Widget is a content action type widget that allows you to download an item from your search. This widget will call the getFileContent content services method. It passes the field provided into the 'id' parameter of the query.

By default, an instance of this widget called Content Download comes with TSearch. It will target the id field of the document to call the Content Service.

Drag And Drop

Add drag and drop file upload to the result body and upload modal. Adding this to your view will cover the result widget with a drop zone for folders and files. A window will pop up and ask you to select where the files are going and what type they are.

Indexing

Files uploaded with this widget are no automatically indexed. An Incremental Job to pick up new files in the source repository is recommended.

The Dropdown Select widget is a facet search type widget. It allows you to perform a facet search by using a dropdown box to filter your results based on the selected field.

By default, there are two instances of this widget included with TSearch.

  • The Content Type widget will filter on the simflofy_content_type metadata field.
  • The Document Type widget will filter on the documenttype metadata field.

Edit Form

The Edit Form widget is a content action type widget that allows you to edit the source metadata of your documents in a search, and update those properties in their repository. It internally uses the content service updateProperties method. This widget should only return fields that are editable in the source system.

An instance of this widget called Edit File Properties is included by default with TSearch.

A content action widget to open content inside the source repository.

This widget works with the External Links section of the Search Connection, with the exception that it adds a button to the document action menu with the configured label

Facet Double Column

The facet double column widget is a facet search widget that displays search results in two columns.

The Facet Search widget allows users to search on the configured field using a simple text box.

Using the Facet Search Widget

  • Enter the words you want to search on
  • TSearch will find all instances of the word in the field
  • Note: This widget search is case-sensitive

Facet Select

The Facet Select Widget is a Search Type Widget that allows users to select a field and then perform Equals, Contains, Starts With, Like and Not Null searches on that field.

Using the Facet Select Widget

Choose which field to search on Choose the search conditions: Contains, Equals, Starts With, or Is not Null Enter the values to search by. This search is case-sensitive.

Full Text

A facet search type widget for a full text search box. By default, this widget searches the content field, which is the default field for the Tika Extractor Task.

With this widget users can search through the content of the indexed files.

Using the Full Text Widget

  • Enter a word in the text box to search for the word in the field associated with the widget
  • Enter multiple words to search for any of the entered words
  • Use quotation marks to search for those exact words in that order

Google Doc Viewer

A content action type widget that will allow the user to open the content with the Google Docs Viewer.

HTML5 Player

A content action widget that will allow the user to open video content inside an HTML video player.

Inline

A content action type widget that allows the user to view a file in the browser.

A content action widget that opens image content for preview using LightBox.

Metadata Export

The Metadata Export Widget is a content action widget that will show you metadata information about a document returned from your search.

This is a top menu widget which allows for the export of document metadata for selected documents. It has a few options.

Comment: Will add a comment to the "message" section of the xml export

Download Files with XML: This option will batch the selected files with the metadata export as a zip file. If selected you will have two options Download selected documents: Download only the currently checked documents Download all searched documents: The current search will be executed again and all returned documents will be downloaded.

Use EDRM Format: The Electronic Discovery Reference Model (EDRM) is a framework that outlines standards for the recovery and discovery and of digital data.

Using the Metadata Export Widget

  • Select the files you want to export the metadata for using the checkboxes or use select all to export the metadata for all the files in your search results
  • In the top menu click bulk actions and select Metadata Export
  • Add a comment for the file. This will add a comment to the message section of an xml export file (optional)
  • Select whether you wish to download documents with the export
  • Select whether to use EDRM format
  • Click submit. A download link will be generated, or you can retrieve the file when it's ready from the Exports page.

Metadata View

The Metadata Widget is a content action widget added to the body of a content view that will display all metadata for the document that was returned with the search results.

Using the Metadata Widget

  • Click Document action
  • Select View Metadata

More Like This

A facet search type widget that produces more results like the ones selected.

Tutorial Example: Setting up Elasticsearch to use MLT Widget

MultiFacet OR Select

The MultiFacet Or Select widget is a facet search widget that allows the user to search on multiple vales in a selected field.

The "OR" in this case is a logical OR, meaning that it will allow you to select multiple options for the configured facet at once. For example, when using it for simflofy_content_type, this widget will allow you to select multiple types of content. This version of the widget uses buttons instead of checkboxes.

My Views

A top menu type widget that will add a dropdown with your views to the top menu.

New View

The New View widget is a top menu type widget to create a new view with the current search filters. This widget allows you to generate a completely new view based on current search results or selected documents.

If the Create new index from search box is not checked, the widget will simply create a new view and a Content Search Connector with its default search set to the current search value.

If there is no search value, the pages will be identical, as they are pulling from the same source with the same query.

Using the New View Widget

New View Display Name: The name that appears on the window, tab, or in the UI

New View Short Name: Used for most operations with the view, as well as part of the url used to retrieve it.

Add Security Marks to New View: Requires the Records Management Module and Security Officer Role. Add Security Marks to documents in the newly created view.

Create new index from search: A new search collection will be created based on your selection. You will be given the option to choose either the current search or the selected documents. In either case, the documents will be copied to this new search collection and no default search will be applied to the new view.

Pager

The Pager widget is a basic pagination type widget. This widget allows the user to navigate through the pages of the search results.

You can customize the previous and next labels in the edit widget instance page.

Public Download Widget

The Public Download Widget is a content action widget which uses the File Service to generate a public link for the selected file. This will allow anyone with the link to download the file until the link expires.

If you wish to expire the link early, you can do so in the Exports page, under the Links tab

Records Management Results

The Records Management Results widget is a result set widget that adds Records Management functionality to Simflofy's Federated Search template.

This will allow users to perform the following actions on indexed files:

  • Declare a file as a record
  • Apply holds to a record
  • View Events for a record
  • Add retention schedules
  • View a record's history
  • View a record's metadata

See the following link for details on how to use widgets to control the look and feel of the Records Management function of TSearch.
Adding Records Management Functionality To TSearch

Remove Document

The Remove Document widget is a content action widget that will allow you to remove one or multiple documents from a view, with an option to delete the source content. To add removed documents back simply reindex the content.

This option can be added to the bulk action menu to remove multiple files at the same time.

You can also choose to utilize the hard delete option which will delete the files from the source.

note

You still need the required permissions to delete a file through Content Services.

Using the Remove Document Widget

  • To remove individual files click document action and select Remove From View
  • To remove multiple files use the checkboxes to select the files of check select all to remove all files in the search results and from the top menu click bulk actions and select Remove From View
  • (Optional) Check the hard delete box
  • Select Remove

Result View

The Result Widget is a basic widget that displays all of the indexed files across your repositories. It adds the Document Action button to each file allowing users to perform actions set by any content action widgets added to the view.

Using the Result Widget

  • When building your content view this widget is added by default to the Simflofy Template
  • Click on the Document Action button to access the other widgets added to the body
note

Note that certain document actions only show up if the connector that the file is on supports those actions

Saved Searches

The Saved Search widget is a top menu widget that adds the ability to save the current search and retrieve it later. These are stored on a per-user basis.

Using the Saved Searches Widget

  • Filter your search results using the left sidebar widgets
  • Click the Save Current Search button in the filter section at the top of the page
  • Name your Saved Search and click Save New
  • Once saved you can rerun the search either from the top menu by selecting Saved Searches and clicking the Search button under the saved search
  • You can also view your saved searches on the Home Page of your TSearch Platform

Single Column Facet

The Single Column Facet Widget is a facet search type widget that displays a single column display of facet counts, with links to drill down. There is also a double column version.

Using the Single Column Facet Widget

  • Select one of the values listed to filter your search

Slider

The Slider Widget is a facet search type widget. It returns a faceted range search through use of a slider. This slider determines the minimum and maximum range for the search.

By default, an instance of this widget is included called Content Size Slider. It targets the simflofy_length field to return a range search on the content size of your files.

Fields

This widget will only work with fields that are stored as numerical values

Two Column Results

The Two Column Result Widget displays search results in two columns instead on one.

Using the Two Column Widget

  • Replace the default current search widget in the body of your content view with this one to see files listed in two columns instead of one.

    Configuring a Content View

Update File

This Update File widget is a content action widget that allows users to make changes to a file. It uses the Update Content end point of content services to change the content of the document.

Using the Update File Widget

  • Click the Document Action button
  • Select Update File
  • Chose the file you want to upload as an updated file to the current one
  • Click the Update button to replace the file

User Management

The User Management widget is a top menu widget that integrates with the user and admin lists in the Security tabs of a view. It will allow admins to alter these lists from inside the view.

Using the User Management Widget

  • You can search for and assign users or user groups as Users or Admins.
  • Once a view has a user list, only users on that list will be able to access the view.
  • Users abide by all document level permissions.
  • Admins bypass all document level permissions.

Version Info

If the content service connector of the document supports versioning, the Version Info Widget will allow users to view the version information for a document. A list of version information will be returned. Optionally, a download button can be added to retrieve the specific version.

Last updated on by rjosefsberg