Skip to content

Overview

Concepts and Principles

Development

Overview

IDEs

API Explorer

Releases

Release Notes

TORO Integrate

Coder Studio

Coder Cloud

Bug Reports

Search

Searching Tracker Documents

TORO Integrate provides a variety of ways to retrieve inbound and outbound data logged to the Tracker Search Index, all of which will be discussed in this page:

Via the User Interface

To view the details of a certain Tracker document in Coder Studio, open the Tracker search by clicking on the Tracker icon in the main menu bar (highlighted below), then enter your search query, and select the document you want to display by clicking on its entry (or row) from the list of documents. The details of the selected document will appear in the Properties view. You should be able to see more document data by shuffling through the tabs displayed beside it.

Viewing a Tracker document

Document state contents

You can preview the content of certain document state by left clicking on the document state's entry in the Properties view.

To download it, do a right-click instead and click on Download Content from the appearing context menu.

How to preview or download a document state's content

At times, you may find the number of documents overwhelming, in which it will be difficult to look for a certain entry. In cases like these, it is recommended to use filters. The following filters are supported in Coder Studio:

  • Simple string filter

    Using this filter, you can look for documents which contain field values that match a certain input string. Use this filter by typing the text to match in the Tracker search bar and hitting .

    Tracker UI, simple string search

  • Quick filter

    This is a filter that allows you to narrow down results using facets. Use this filter by clicking on the Quick Filter button and then selecting a facet from those displayed. As you may notice, next to each facet is a number. This number is the number of documents in the Tracker Search Index that match the facet.

    Tracker UI, search facets

  • Advanced filter

    This filter allows you to search documents by specifying field values that must be matched. Use this filter by clicking on the Advanced Filter button, filling-in fields in the form, and hitting OK once done. Matching results will be displayed.

    Tracker UI, advanced search by form

To view the details of a certain Tracker document in Coder Cloud, open the the Tracker (by clicking on the Tracker tab, highlighted below), then search for and select the document you want to display by clicking on its entry (or row) from the list of documents. A dialog will appear that will display the details of the document.

Viewing a Tracker document

To view the details of a certain Tracker document via the Server Admin UI, enter your search query in the Tracker search box at the top of the interface and select the document you want to display by clicking on the document's ID from the table displayed. A panel on the right side should appear and display the details of the document. For a full-screen view of the document, click on the view button highlighted in the screenshot below (situated at the top of the document preview):

Viewing a Tracker document

At times, you may find the number of documents overwhelming, in which it will be difficult to look for a certain entry. In cases like these, it is recommended to use filters. The following filters are supported in the Server Admin UI:

  • Simple string filter

    Using this filter, you can look for documents which contain field values that match a certain input string. Use this filter by typing the text to match in the static search bar above every page and then hitting . When using the search bar, ensure that Tracker is selected instead of Monitor.

    Tracker UI, simple string search

  • Quick filter

    This is a filter that allows you to narrow down results using facets; simply filter by facets by clicking on any of the facets displayed on top of the table. As you may notice, next to each facet is a number. This number is the number of documents in the Tracker Search Index that match the facet.

    Tracker UI, search facets

  • Advanced filter

    This filter allows you to search documents by specifying field values that must be matched. Use this filter by clicking on the button with an inverted triangle in the static search bar, filling-in fields in the form, and hitting OK once done. The page will be reloaded in order to show only matching documents.

    Tracker UI, advanced search by form

Query Auto-complete

The Server Admin UI's search bar for the Tracker Search Index features autocomplete (using a Solr Suggester). This means that as you type, you will be presented values and suggestions that match your query. However, this feature is disabled by default (as it may cause performance issues). To enable it, open the tracker Solr core's solrconfig.xml file and uncomment the following lines:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
<searchComponent class="solr.SpellCheckComponent" name="suggest_phrase">
    <lst name="spellchecker">
        <str name="name">suggest_phrase</str>
        <str name="classname">org.apache.solr.spelling.suggest.Suggester</str>
        <str name="lookupImpl">org.apache.solr.spelling.suggest.fst.FSTLookup</str>
        <str name="field">suggest_phrase</str>
        <str name="buildOnCommit">true</str>
    </lst>
</searchComponent>
<requestHandler class="org.apache.solr.handler.component.SearchHandler" name="/suggest_phrase">
    <lst name="defaults">
        <str name="spellcheck">true</str>
        <str name="spellcheck.dictionary">suggest_phrase</str>
        <str name="spellcheck.onlyMorePopular">true</str>
        <str name="spellcheck.count">10</str>
        <str name="spellcheck.collate">false</str>
    </lst>
    <arr name="components">
        <str>suggest_phrase</str>
    </arr>
</requestHandler>

You may have noticed that the XML has a configuration property called buildOnCommit, which rebuilds the autocomplete index every time a document is added to the index. If you feel that autocomplete is useful, but don't like the performance cost, you can change the value of buildOnCommit to false, and then manually have Solr rebuild it for you. In situations like this, the Scheduler Endpoint can be used. You can read more about the Suggester here.

Via RESTful Web Endpoints

There are multiple RESTful web endpoints exposed by TORO Integrate you can use to fetch Tracker documents. The tracker endpoints, for one, provide you a simple means to fetch all documents or a specific document using its ID. For more advanced searches, you may want to use TORO Integrate's Solr-inspired search API. All you need to remember is to substitue these path parameters:

Path Parameters

Parameter Name Value
package core
core tracker

Programmatically

You can look for Tracker documents in your code using TrackerMethods.searchTracker(...) methods.

In Gloop, you can do something like:

1
TrackerMethods.getTrackerDocument(internalId)

On the other hand, in Groovy, you can do something like:

1
2
SearchResult searchResult = TrackerMethods.searchTracker('hello')
List<Document> documents = searchResult.getResults()

One-Liners for Tracker

Since the TrackerMethods class is exposed as an Extension Module in Groovy, you can also do the following:

1
2
SearchResult searchResult = 'hello'.searchTracker()
List<Document> documents = searchResult.getResults()