Ataccama ONE Agentic Cloud Portal ONE Desktop ONE DQ&C ONE MDM ONE RDM ONE Runtime Server
User Community Service Desk Downloads

Configure Search

This article describes how to add custom entities to full-text search, adjust existing configurations, and perform maintenance tasks such as reindexing or recovering the search index.

About search configurations

Search configurations control which entities are included in full-text search in Ataccama ONE and how they behave in global and entity-specific search results. ONE includes ready-to-use configurations for standard entities.

To view and manage full-text search configurations, go to Global settings > Search configurations.

Search configurations
Search configurations rely on the metadata model behind the catalog. In this context, assets and asset types are referred to as entities.

Prerequisites

How full-text search works

Full-text search in ONE operates at two levels:

  • Global search: Searches across all entities that have global search enabled. Results are grouped into tabs, one per entity type.

  • Local (entity-specific) search: Searches within a single entity type on its listing page.

Each entity type needs its own search configuration. Configuring search on a parent entity does not automatically enable it on child entity pages. In other words, each entity (including subtypes) requires its own search configuration.

Full-text search is only available when viewing Published assets. When viewing Unpublished or All assets, a fallback search is used instead, which searches through asset names. For a more advanced alternative to full-text search, use AQL Query Syntax.

For hierarchical entities, full-text search is only available on Flat listing views.

When full-text search is not available or configured, fallback search treats multiple words as a single phrase (for example, customer data searches for that exact phrase).

If you need to search with OR logic, use AQL Query Syntax instead.

Indexed nodes and properties

Search configurations use indexed nodes and indexed properties to control what is searchable and how the search engine reaches the data. These serve two distinct purposes:

Searchable properties

The values users can find through search. These are properties marked as Searchable or Sortable in the configuration.

Path properties

Properties that define how the search engine traverses from the root entity to nested or related entities. These are not searchable themselves but indicate how to reach the data.

To index a property on a nested or related entity, you need to configure the full traversal path from the root entity. Every step in the path requires its own indexed node and indexed property. If any step is missing, the search engine cannot reach the target property.

The traversal path follows the structure of the metadata model. Each hop corresponds to a relationship: either an embedded property or a reference.

To check whether a property is embedded or reference, see the entity definition in Global settings > Metadata model.

You can also index system properties, which are not part of the metadata model. These properties contain additional metadata and are available for most entity types. They are prefixed with a dollar sign ($), such as $displayName.

Example: Index attribute names on a catalog item

To make attribute names searchable on catalog items:

  1. On the catalogItem indexed node, add attributes as an indexed property. This tells the search engine how to get from the catalog item to its attributes (in the metadata model, attributes is an array embedded property on catalogItem).

  2. Add attribute as a separate indexed node with name as a searchable indexed property.

Example: Index term names assigned to catalog item attributes

This is a deeper chain that requires configuring every hop:

  1. On the catalogItem indexed node, add attributes as an indexed property (array embedded).

  2. Add attribute as an indexed node with termInstances as an indexed property (array embedded).

  3. Add termInstance as an indexed node with target as an indexed property (reference to term).

  4. Add term as an indexed node with name as a searchable indexed property.

Only name in step 4 is the actual search target. Steps 1–3 define the traversal path.

Ancestor auto-indexing

Ancestor entities (such as parents and grandparents) are an exception to the traversal path rule. If an indexed node exists for an ancestor entity type, all ancestors of that type are indexed automatically and you don’t need to specify the traversal path manually.

For example, if a location indexed node exists in the catalog item search configuration, all locations above a given catalog item in the hierarchy are indexed automatically.

Create a search configuration

Create a search configuration to include an entity in full-text search.

Step 1: Create the configuration

  1. Go to Global settings > Search configurations and select Create.

  2. In Name, select the entity that should be searchable (for example, <yourCustomEntity>).

  3. Enable the relevant search types:

    • For local search: Enables full-text search for the entity.

    • For global search: Includes the entity in global search.

  4. If you enabled global search, configure:

    • Global search order: Where the entity tab appears on the global search results page. Lower numbers appear first.

      If entities share the same number, they are ordered alphabetically. Skipped numbers are ignored.

      If left empty, the tab is placed first.

    • Global search entity name: Display name for the entity’s tab on the global search results page (for example, "DQ Firewall" instead of dqFirewall).

  5. In Indexed nodes, select Add Indexed node and select the same entity as in Name.

  6. Select Save. This saves the configuration as a draft and makes the indexed nodes and property settings available.

Continue with Step 2: Add indexed properties to refine how search works.

Create search configuration

Step 2: Add indexed properties

Index the properties that should be searchable, sortable, or used as traversal paths.

  1. In your saved configuration, open your indexed node.

  2. Select Add Indexed property and configure the following:

    Create search configuration

    • Name: Select the entity property to index (for example, name, $created, description).

    • Searchable: Select to enable search by this property’s values.

    • Sortable: Select to sort search results by this property.

      You can enable both for the same property. For example, making name both searchable and sortable allows you to find entities by name and organize results alphabetically.

  3. Select Save.

  4. Repeat as needed until you have added all properties you want to use.

To index properties on nested or related entities, you also need to add properties that define the traversal path from the root entity. See Indexed nodes and properties for details and examples.

Step 3: Add search filters (optional)

Search filters let you narrow down results by specific property values. They appear on both the global search results page and entity listing pages.

You can use only indexed properties as filters. If a property you want to use is not available, make sure it’s indexed first.

  1. In the entity search configuration, select Add Property search filter.

  2. Configure:

    • Name: A user-friendly display name for the filter.

    • Order: Where the filter is located in the filter list.

    • Property: The indexed property to filter by.

  3. Select Save.

  4. Repeat as needed until you have configured all filters.

Step 4: Publish and verify

  1. Publish your changes.

  2. Wait for the search index to rebuild. Indexing can take up to several hours for large datasets.

  3. Verify the configuration by searching on the entity page or using global search. If you enabled global search, your new tab is now available in the global search results.

    Tab added to global search

Search reindexing and recovery are maintenance operations that help resolve some common search issues:

Reindexing

Refreshes the search index for all existing entities without changing the index settings. The index rebuilds automatically after you save and publish configuration changes.

Use only if automatic indexing did not complete successfully or results appear incomplete.

Recovery

A troubleshooting step for when there are inconsistencies between primary storage and search storage, such as outdated or deleted data appearing in search results. This can happen when reindexing fails or after an upgrade.

Recovery deletes all indexed items, clears the change queue, and reindexes from scratch.

Search is unavailable while these tasks are in progress, although you can continue searching for items that have been reindexed. Note that both processes can take up to several hours for large datasets.

To reindex or run search recovery:

  1. Go to Global settings > Search configurations.

  2. In the three-dot menu, select Reindex or Recovery as needed.

Search not returning expected results

Verify that the relevant properties are marked as Searchable in the indexed properties and that the entity has local and/or global search enabled as needed.

Configuration changes not taking effect

Wait for the search index to rebuild, then refresh your browser.

If changes still don’t appear, verify that all changes were saved before you navigated away from the configuration page.

Full-text search not working due to 'Socket closed' error

If full-text search shows a "Full-text search is experiencing problems" error, or a "Socket closed" error after refreshing, the issue is likely that your proxy is removing headers from server responses, preventing WebSocket communication between the browser and ONE.

To confirm, open browser developer tools and look for: "Error during WebSocket handshake: 'Connection' header is missing."

To resolve this, your network administrator must allowlist the Connection header for the platform domain.

See also

Was this page useful?