1. Using Intrigue

Intrigue represents the most advanced search interface available with DDF. It provides metadata search and discovery, resource retrieval, and workspace management with a 3D or optional 2D map visualization.

Note
Contextual Help Feature

For more detail on any feature or button within Intrigue, click the ? icon in the upper right of the screen; then, hover over any item on the screen and a contextual tooltip will be displayed to define its purpose. To exit this mode, click the ? again or press escape.

1. Glossary of Terms
Advanced Query Builder

Search tool for building complex queries beyond basic searches.

Associations

User-defined relationships between different data products.

Attribute Editor

Tool used to edit metadata attributes on uploads.

Basic Search Tool

Search tool for building simple searches.

Inspector

Tool for viewing and editing metadata attributes.

Lists

User-defined collections of related results or products.

Map Tools Widget

Tool for customizing or navigating the map view.

Metadata Quality

A measure of the completeness or correctness of the metadata of a product.

Result Forms

Customizable templates of the attributes shown when viewing searches.

Search Forms

Customizable templates of the attributes used in creating searches.

Sources View

View the health and status of all configured data sources

Temporal Search

Basic search using time-based search terms.

Spatial Search

Basic search using location-based search terms.

Text Search

Basic search using the text of documents and/or metadata.

Visuals

Tools to view search results or the information about them.

Workspaces

User-defined collections of searches and search settings.

1.1. Accessing Intrigue

The default URL for Intrigue is https://{FQDN}:{PORT}/search/catalog

Note
Catalog UI Guest Users

If Guest access has been enabled, users not signed in to DDF (i.e. guest users) will have access to search functions, but all workspace configuration and settings will only exist locally and will not be available for sharing.

Intrigue defaults to the Search view. For other views, select the Navigation menu navigator icon in the upper-left corner of Intrigue and select the desired view.

1.2. Searching Intrigue

The Search pane has two tabs: Search and Lists.

search pane tabs
Figure 1. Search Pane Tabs

Search queries are grouped together into Workspaces. These searches can be saved, edited, and duplicated as the basis of further searches.

Creating a New Search Within the Current Workspace
  1. From the main Intrigue screen, select Search Intrigue.

    1. From the dialog that opens, select the edit icon to name the search if it will be reused or shared.

    2. Select the type of search to perform: Text, Basic, or Advanced.

  2. Results will be displayed in the Search Tab.

  3. If too many or too few results are returned, edit the search parameters by selecting the edit icon.

  4. Once the search is correct, select the Save icon next to the workspace name in the top bar.

Creating a New Search Into a New Workspace
  1. Select the navigation menu icon.

  2. Select Workspaces.

  3. Enter search terms into the Search box.

  4. A new workspace, by default called New Workspace, will be created containing only the new search.

  5. Rename the workspace, if desired.

  6. Select the Save icon next to the workspace name.

Search Types
  • Text: Perform a minimal textual search that is treated identically to a Basic search with only Text specified.

  • Basic: Define a Text, Temporal, Spatial, or Type Search.

    • Text Search Details: Searches across all textual data of the targeted data source. Text search capabilities include:

      • Search for an exact word, such as Text = apple : Returns items containing the word "apple" but not "apples". Matching occurs on word boundaries.

      • Search for the existence of items containing multiple words, such as Text = apple orange : Returns items containing both "apple" and "orange" words. Words can occur anywhere in an item’s metadata.

      • Search using wildcards, such as Text = foo* : Returns items containing words like "food", "fool", etc..

      • Wildcards should only be used for single word searches, not for phrases.

        Warning
        When searching with wildcards, do not include the punctuation at the beginning or the end of a word. For example, search for Text = ca* instead of Text = -ca* when searching for words like "cat", "-cat", etc.. and search for Text = *og instead of Text = *og. when searching for words like "dog", "dog.", etc..
      • Text searches are by default case insensitive, but case sensitive searches are an option.

    • Temporal Search Details: Search based on absolute time of the created, modified, or effective date.

      • Any: Search without any time restrictions (default).

      • After: Search records after a specified time.

      • Before: Search records before a specified time.

      • Between: Set a beginning and end time to search between.

      • Relative: Search records relative to the current time.

    • Spatial Search Details

      • Search by latitude/longitude (decimal degrees or degrees minutes seconds), USNG/MGRS, or UTM

      • Search by entering a Keyword for a region, country, or city in the Location section of the query builder.

      • To search using a line, polygon, point-radius, or bounding box, select the shape to draw, then select Draw.

        Note
        Intersecting Polygon Searchs

        If a self intersecting polygon is used to perform a geographic search, the polygon will be converted into a non-intersection one via a convex hull conversion. In the example below the blue line shows the original self intersecting search polygon and the red line shows the converted polygon that will be used for the search. The blue dot shows a search result that was not within the original polygon but was returned because it was within the converted polygon.

        convex hull transform example
        Figure 2. Self Intersecting Polygon Conversion Example
    • Type Search Details

      • Search for specific content types.

  • Advanced: Advanced Query Builder can be used to create more specific searches than can be done through the other methods.

    • Advanced Query Builder Details

      • Operator: If 'AND' is used, all the filters in the branch have to be true for this branch to be true. If 'OR' is used, only one of the filters in this branch has to be true for this branch to be true.

      • Property: Property to compare against.

      • Comparison: How to compare the value for this property against the provided value. Depending on the type of property selected, various comparison values will be available. See Types of Comparators

      • Search Terms: The value for the property to use during comparison.

      • Sorting: Sort results by relevance, distance, created time, modified time or effective time.

      • Sources: Perform an enterprise search (the local Catalog and all federated sources) or search specific sources.

    • Advanced Query Builder Comparators

      • Textual:

        • CONTAINS: Equivalent to Basic Text Search with Matchcase set to No.

        • MATCHCASE: Equivalent to Basic Text Search with Matchcase set to Yes.

        • =: Matches if an attribute is precisely equal to that search term.

        • NEAR: Performs a fuzzy proximity-based textual search. A NEAR query of "car street" within 3 will match a sample text of the blue car drove down the street with the red building because performing three word deletions in that phrase (drove, down, the) causes car and street to become adjacent.

        • EMPTY: Search records when the attribute itself does not exist or when the attribute value is null.

          More generally, a NEAR query of "A B" within N matches a text document if you can perform at most N insertions/deletions to your document and end up with A followed by B.

          It is worth noting that "street car" within 3 will not match the above sample text because it is not possible to match the phrase "street car" after only three insertions/deletions. "street car" within 5 will match, though, as you can perform three word deletions to get "car street", one deletion of one of the two words, and one insertion on the other side.

          If multiple terms are used in the phrase, then the within amount specifies the total number of edits that can be made to attempt to make the full phrase match. "car down street" within 2 will match the above text because it takes two word deletions (drove, the) to turn the phrase car drove down the street into car down street.

      • Temporal:

        • BEFORE: Search records before a specified time.

        • AFTER: Search records after a specified time.

        • RELATIVE Search records relative to the current time.

        • EMPTY: Search records when the attribute itself does not exist or when the attribute value is null.

      • Spatial:

        • INTERSECTS: Gives a component with the same functionality as Basic Spatial Search.

        • EMPTY: Search records when the attribute itself does not exist or when the attribute value is null.

      • Numeric:

        • >: Search records with field entries greater than the specified value.

        • >=: Search records with field entries greater than or equal to the specified value.

        • =: Search records with field entries equal to the specified value.

        • <=: Search records with field entries less than or equal to the specified value.

        • RANGE: Search records between the two specified values (inclusive).

        • <: Search records with field entries less than the specified value.

        • EMPTY: Search records when the attribute itself does not exist or when the attribute value is null.

1.2.2. Editing Searches

View and edit searches from the Search tab.

The available searches for a workspace can be viewed by clicking on the drop-down on the Search tab.

searches dropdown
Figure 3. Viewing available searches.
Search Menu Options

At the bottom of each search is a list of options for the search.

  • Run ▶: Trigger this search to begin immediately.

  • Edit ✐: Edit the search criteria.

  • Settings ⚙: Edit the search settings, such as sorting.

    • Sort: Set the sorting criteria for this search.

    • Sources: Limit the sources queried by this search.

    • Result Form: Choose a format for search results. See Result Forms

  • Notifications 🔕: Allows setting up search notifications.

  • Additional Options

    • Stop: Stop this search.

    • Delete: Remove this search.

    • Duplicate: Create a copy of this search as a starting point.

    • Search Archived: Execute this search, but specifically for archived results.

    • Search Historical: Execute this search, but specifically for historical results.

    • View Notes: View or add annotations to the record.

    • Export Selected: Select a record, or group of records, and download the metadata or resources for those records.

    • Export Selected (Compressed): Export selected records into a zip file.

Viewing Search Status

An existing search’s status can be viewed by selecting the search in the Search tab of a workspace and by clicking the Status icon. The Status view for a search displays information about the sources searched.

Repeating a Search

Schedule a standing search.

  1. Select the Notifications icon on the search.

  2. Select the Frequency for the search to repeat.

Note

Notifications for the search will persist until the user logs out or refreshes the page.

1.2.3. Viewing Search Results

The Search tab displays a list of all of the search results for the selected search.

Returned search results can be refined further, bookmarked, and/or downloaded from the Search tab. Result sets are color-coded by source as a visual aid. There is no semantic meaning to the colors assigned.

search results options
Figure 4. Search Results Options
  1. On the Search tab, select a search from the drop-down list.

  2. Perform any of these actions on the results list of the selected search:

    1. Filter the result set locally. This does not re-execute the search.

    2. Sort (Customize results sorting). The default sort is by title in ascending order.

    3. Toggle results view between List and Gallery(displays a thumbnail, if applicable).

1.2.3.1. Search Result Options
Options for each individual search result
  • Download: Downloads the result’s associated product directly to the local machine. This option is only available for results that have products.

  • Add to List +: Adds/removes the results to/from a list.

  • Hide from Future Searches: Adds to a list of results that will be hidden from future searches.

  • Expand Metacard View: Navigates to a view that only focuses on this particular result.

  • Export As: Export the metadata, associated resource, or both.

1.2.3.2. Adding Visuals

Visuals allow different views of search results.

  1. Click the Add Visual (add visual icon) icon in the bottom right corner of Intrigue.

  2. Select a visual to add.

    1. 2D Map: A 2 dimensional map view.

    2. 3D Map: A 3 dimensional map view.

    3. Histogram: A configurable histogram view for the results of a search.

    4. Table: A configurable table view for the results of a search.

    5. Inspector: In depth details and actions for the results of a search.

Inspector View Available Options
  • Summary: A customizable subset of the attributes of the result.

    • Filter: Search for specific attributes.

    • Actions: Add, Remove, Show, or Rearrange the visible attributes for this result.

  • Details: A detailed view of all attributes available for the result.

  • History: View revision history of this record.

  • Associations: View or edit the relationship(s) between this record and others in the catalog.

  • Quality: View the completeness and accuracy of the metadata for this record.

  • Actions: Export the metadata/resource to a specific format.

  • Archive: Remove the selected result from standard search results.

  • Overwrite: Overwrite a resource.

1.2.3.2.1. Editing Records

Results can be edited from the Summary or Details tabs in the Inspector visual.

1.2.3.2.2. Viewing Text Previews

If a preview for a result is available, an extra tab will appear in the Inspector visual that allows you to see a preview of the resource.

1.2.3.2.3. Editing Associations on a Record

Update relationships between records through Associations.

  1. Select the desired result from the Search tab.

  2. Select the Inspector visual.

  3. Select the Associations tab.

  4. Select Edit.

  5. For a new association, select Add Association. Only items in the current result set can be added as associations.

    1. Select the related result from either the Parent or Child drop-down.

    2. Select the type of relationship from the Relationship drop-down.

    3. Select Save.

  6. To edit an existing association, update the selections from the appropriate drop-downs and select Save.

View a graphical representation of the associations by selecting Graph icon from the Associations menu.

associations menu
Figure 5. Associations menu.
1.2.3.2.4. Viewing Revision History

View the complete revision history of a record.

  1. Select the desired result from the Search tab.

  2. Select the Inspector visual.

  3. Select the History tab.

    1. Select a previous version from the list.

    2. Select Revert to Selected Version to undo changes made after that revision.

1.2.3.2.5. Viewing Metadata Quality

View and fix issues with metadata quality in a record.

Note

Correcting metadata issues may require administrative permissions.

  1. Select the desired result from the Search tab.

  2. Select the Inspector visual.

  3. Select the Quality tab.

  4. A report is displayed showing any issues:

    1. Metacard Validation Issues.

    2. Attribute Validation Issues.

1.2.3.2.6. Exporting a Result

Export a result’s metadata and/or resource.

  1. Select the desired result from the Search tab.

  2. Select the Inspector visual.

  3. Select Actions tab.

  4. Select the desired export format.

  5. Export opens in a new browser tab. Save, if desired.

1.2.3.2.7. Archiving a Result

To remove a result from the active search results, archive it.

  1. Select the desired result from the Search tab.

  2. Select the Inspector visual.

  3. Select the Archive tab.

  4. Select Archive item(s).

  5. Select Archive.

1.2.3.2.8. Restoring Archived Results

Restore an archived result to return it to the active search results.

  1. Select the Search Archived option from the Search Results Options menu.

  2. Select the desired result from the Search tab.

  3. Select the Inspector visual.

  4. Select the Archive tab.

  5. Select Restore item(s).

  6. Select Restore.

Restore hidden results to the active search results.

  1. Select the Settings (settings) icon on navigation bar.

  2. Select Hidden.

  3. Click on the eye (eye icon) icon next to each result to be unhidden.

    1. Or select Unhide All to clear the list.

unhide blacklist
1.2.3.2.9. Overwriting a Resource

Replace a resource.

  1. Select the desired result from the Search tab.

  2. Select the Inspector visual.

  3. Select the Overwrite tab.

  4. Select Overwrite content.

  5. Select Overwrite

  6. Navigate to the new content via the navigation window.

1.2.4. Hiding Results

Redundant, irrelevant, or previously reviewed search results can be hidden from future searches.

  1. Perform a search.

  2. Select the result to be hidden from view.

  3. Select the Options menu for the result to hide.

  4. Select Hide from Future Searches.

  5. When you re-run the search, the selected result will not be in the result set.

1.2.4.1. Viewing and Restoring Hidden Results
  1. Select the Settings (⚙) menu.

  2. Select Hidden.

  3. Unhide any or all of the hidden results.

1.2.5. Using Lists

Lists organize results and enable performing actions on those sets of results. The Lists tab can be found on the Search pane.

The Lists tab defaults to the most recent list viewed. Select the dropdown to see other lists available.

  1. From the List tab, perform any of these actions on lists:

    1. Filter the result set locally (does not re-execute the search),

    2. Sort (Customize list sorting). (Default: Title in Ascending Order).

    3. Toggle results view between List and Gallery.

Note

Lists are not available to guest users.

1.2.5.1. Creating a List

A new list can be created by selecting the Lists tab and selecting the new list text.

1.2.5.2. Adding/Removing Results to a List

Results can be added to a list by selecting the add (+) icon on a result.