Skip to main content
Skip table of contents

Adding your first filters to Shinydocs Search

Shinydocs Search allows administrators to create powerful filters that enable users to find data quickly with a variety of useful options and interfaces. When you first get started with Search, we pre-populate your Search setup with great filters that will help with your initial discovery phase, including:

image-20240404-141507.png

PII rules

image-20240404-141520.png

Redundant ROT rules

image-20240404-141445.png

Obsolete ROT rules

image-20240404-141537.png

Trivial ROT rules

Administrators can further customize these filters, remove them, or create brand new ones easily from the Shinydocs Search Admin panel.

image-20240404-142320.png

Click “Admin” in the user menu or go to https://<your_search>/admin

This tutorial will guide you through adding the following filters to an existing source:

  • File size range

  • Created date date-picker

Let’s get started!

📘 How to add, remove, or modify filters

Filters are configured in the Admin panel (Click “Admin” in the user menu or go to https://<your_search>/admin).

  1. Navigate to the Admin panel in search.

  2. Click Roles in the navigation menu.

  3. Click Edit on the role you want to edit the filters for, Default Role is the built-in default role and is the one we will be working with today.

  4. In the Default Role role configuration, click Filters configuration.

📘 File size range

This type of filter is great when you want to search for content which contains a numeric field to search on like file size which is a field called length. This filter will allow users to search for files with a minimum length (size) of X and a maximum length of Y.

  1. Once in the Default Role role - Edit filters page, click + Add filter.

    image-20240404-144525.png

  2. Scroll to the bottom of the page to find your new, blank, filter.

    image-20240404-144823.png

  3. Enter and select the following:

    1. Index field name: length

    2. Type: Range

    3. Leave Keep filter open by default checked if you want this filter to be open (expanded) by default

    4. Units: Enter Bytes

    5. Title: Enter File size

      image-20240404-145209.png

      Yours should look just like this

  4. Click Save changes.

Congratulations! You have successfully set up a range filter in Shinydocs Search!

image-20240404-145535.png

Users can now enter the minimum or maximum file size (in bytes) and Search will dynamically adjust the results to include only those that match these conditions.

📘 Created date filter

The ability to filter by dates can be invaluable when searching for historical or archived content. This filter will allow users to select a date range for the created date of results.

  1. Once in the Default Role role - Edit filters page, click + Add filter

    image-20240404-144525.png

  2. Scroll to the bottom of the page to find your new, blank, filter

    image-20240404-144823.png

  3. Enter and select the following:

    1. Index field name: creationTimeUtc

    2. Type: Date

    3. Leave Keep filter open by default checked if you want this filter to be open (expanded) by default

    4. Leave Show quick select option in date picker checked if you want to enable quick filters (Last 24 hours, Last 7 days, Last 30 days)

      image-20240404-150955.png

    5. Title: Enter Created date

image-20240404-152029.png

Yours should look just like this

  1. Click Save Changes.

Congratulations! You have successfully set up a date filter in Shinydocs Search!

image-20240404-151512.png

Users can now filter search results by the created date (creationTimeUtc) of content, you can easily add an additional filter for the modified date (lastWriteTimeUtc) following the same steps.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.