Search Tagging and Alerting

Search Tagging and Alerting#

Search tagging is an enrichment, used to add tags to incoming items. This way items can for example be assigned a certain product name based on a Smart Filter match or a company name based on a full text search result.

Using Search Tagging#

Search tagging is fully configurable in the user interface. The following sections describe the process to set up search tagging. Search tagging is especially useful in dashboards, where it can be used in the charts to display distribution of results.

Preparation#

On the Search screen or in a dashboard construct the query that will serve as a basis for your tagging. This can include Smart Filters, filter drill-down options, full text search terms, etc.

image1

Once you are happy with the result, copy the query from the search field.

Setup#

Then in the Setup space, navigate to AI Studio and open Search Tagging.

Create a new tagging rule by pressing the orange plus sign at the top right.

In the resulting form fill out the fields as follows:

  1. Enter a descriptive name, such as Acquisitions.

  2. Paste or formulate the query.

  3. Enter the keyword to be assigned to each item that matches the query. This is a keyword and value separated by a colon. Multiple such combinations can be entered by pressing the Enter key between each entry.

image2

Enable in Pipeline#

Search tagging and alert rules by users are only executed for any items if the corresponding step is present in the relevant pipeline.

This only needs to be done once, independent of how many search tagging rules are created.

To ensure search tagging is run proceed as follows:

  1. Open the Pipeline Editor.

  2. In the Steps Library find the Search Tagging and Alerting step.

  3. Drag the step to the pipeline, placing it as the last step (after Indexing)

image3

Once saved, all new items passing through this workflow will be tagged with the given keyword(s). Add the Search Tagging and Alerting step to additional workflows if you require.

Caveats#

Asynchronous Processing#

Search tagging, especially when used with Smart Filters, can be a resource-intensive process. For that reason, this step is run asynchronously in the Data Processing Pipeline. As a result, items that are searchable and displayed may not yet have their search tags applied.

Historical Tagging#

From the moment a search tagging has been set up it applies to all new items. All items that are already in the index are not processed at that time. Contact Squirro Support if you need to tag existing items.

Recursion and Ordering#

Ordering of search tagging rules in a project is not guaranteed. But it is still possible to chain search tagging rules as the tags are processed twice.

Assume as an example the following search tagging definitions:

Name

Query

Keywords

1

Personnel Change Catalyst

smartfilter:personnel_changes:0.5

catalyst:Personnel

2

Generic Catalyst

catalyst:Personnel OR catalyst:Financial

catalyst:Company

When an item is processed it now runs through this list of search tagging rules in phases.

In the first phase, the first search tagging rule for personnel changes matches and the value “Personnel” is added to the “catalyst” keyword. However the second rule will not yet match, because the original item doesn’t match the query.

Because the item changed as a result of a search tagging, it is now processed a second time. In this second phase the second rule will also match. As a result the “Company” value is also added to the “catalyst” keyword and the item will now contain both values.

The process stops after the second stage to avoid infinite loops - so further chaining is not possible.

Contents