Skip to content

Result Filtering

Scott Behrens edited this page Oct 17, 2016 · 1 revision

Table of Contents

##Overview Result filtering allows you to narrow down and focus your efforts on the results you care about.

Basic Filtering

For all text boxes, Scumblr will perform a like match (so you don't need to provide an absolute value). The only exception is Metadata, which we will discuss later.

For drop down boxes that have multi-select, the search filter will use an AND operator when performing the search.

For reference, navigate to your Scumblr's Results page. Let's walk through what all the different filter options mean:

URL

Will match for a Result's URL.

URL Does Not Contain

Will remove any results that match this URL.

Title

Will match for a Result's Title.

Title Does Not Contain

Will remove any results that match this Title.

Tags

Multi-Select dropdown of Tags you can use to filter results.

Tags can be used to do logical grouping of your results. Many tasks allow you to Tag a result when it is identified. You can manually add Tags to results in the Result view page. You can also assign multiple results to the same Tag by using the Actions dropdown when selecting results.

Assignee

Multi-Select dropdown of Assignees you can use to filter results.

You can assign a user to a particular result in the Result view page. You can also assign multiple results to the same Assignee by using the Actions dropdown when selecting results.

Status

Multi-Select dropdown of preconfigured statues you can use to filter results.

The Status filter only works if you have already set up statues for your Scumblr.

Task (Search)

Multi-Select dropdown of tasks you can use to filter on results that were created by the task.

This filter does not work on results updated by a task.

Event Filter

Multi-Select dropdown of event filters you can use to filter on results.

Metadata

multi-input text box to allow advanced searching of metadata. More on this later.

Workflow Flag

Multi-Select dropdown of workflow flags you can use to filter on results. This requires you to have configured Workflowable and defined a number of Workflow flags.

Workflow Stage

Multi-Select dropdown of workflow stages you can use to filter on results. This requires you to have configured Workflowable and defined a number of Workflow flags.

Include closed?

Toggle to include results that have a status which includes the closed field.

Advanced Filtering with Metadata

Scumblr tasks can store additional metadata within a Result. The metadata object in results in a hash that is stored within a jsonb column which allows for flexible searching.

What Metadata is Available?

If You are unsure on how to use the metadata object for your search, it is helpful to observe the metadata for a particular result. You can retrieve a Result's metadata by simply appending /get_metadata.json to the end of your Result ID (see example below):

https://www.your_scumblr.com/Result/12234/get_metadata.json

Here's a screenshot of our Result we used during the Getting Started guide:

Metadata Quick Reference

To search for if a metadata key is present, you can just search for the key name

vulnerabilities

To search for a key within a nested hash, you can use the : delimiter

key_1:nested_key_1

To search for a numerical value you can use the >=, >, <=, < == != booleans

vulnerability_count:open>=1

You can also search for the absence of a key such as:

!vulnerabilities

To search for an element in an array nested in a nested hash, you can use the jsonb operator @>

top_key:nested_key@>["element1"]

More examples coming soon.

Real World Metadata Examples

Show Me Results With A "vulnerabilities" key

vulnerabilities

Show Me Results With High Risk Vulnerabilities

vulnerability_count:high>0

Show Me Results With Vulnerabilities Created Or Updated By Task 3

vulnerability_count:task_id:3

Show Me Results That Do Not Contain Vulnerabilities (No "vulnerabilities" key)

!vulnerabilities

Clone this wiki locally