Configuration

When you configure a Search component, you can use the Output tab to enable one or more views, each of which has a variety of options that determine how search results are displayed. Depending on the selected view, the available options are grouped into some or all of the following categories:

  • Template

  • Image

  • Icon and color

  • Main click area

  • Fields

  • Operations

  • Indicators

Note

To display the selected views on the page, turn on the Show view selector switch on the Search component Functionality tab.

Template

A template is used to display search results. Each view has a number of templates that alter the layout of text, images, and other content within search results. The following sections list the templates associated with each view and, if a template includes image renditions, which renditions are used. To use a template other than the default one, select it.

Image

To set an image on the search results, from the Image list, select one of the following options:

  • Thumbnail - displays a thumbnail of the entity if it is available.

  • Icon - displays icons instead of thumbnails, as configured in Icon and color.

Icon and color

To configure the style and color of an icon, from the Icon and color list, select one of the following options:

  • None - uses the default style color (default).

  • From entity - uses the style and color defined for the entity.

  • From taxonomy relation - uses the style and color defined for a specific taxonomy. Select the taxonomy relation from the Relation list.

Note

You can further customize the display using the entity visualization options in Search components based on taxonomy definitions.

Main click area

To add an entity operations component in the main click area, click Add operation.

Fields

You can decide which fields to display in the search results.

To define a field to display:

  1. In the Fields section, click Add add icon.

  2. Configure the following fields.

    Field

    Description

    Type

    The field type (for example, Property or Relation).

    Field

    The field to display in search results (for example, Title).

    Display format

    How the field type is indicated (for example, text or icon).

    Limit number of items

    Switch to limit the number of items in search results. Applies only to relations.

    Number of items to show

    The maximum number of search results to display. Applies only to relations.

    Color

    Color of the text or icon used for the display format.

    Show help text

    Type and style of the help text displayed on the search result tile (for example, Inline or Tooltip).

    Note

    For the list view, the Advanced option is only available if you select the Card template.

  3. Configure the additional settings required for the selected fields.

  4. Click Save.

Operations

You can configure which operations to make available on the search results. Operations are internal or external actions involving the entity in question.

The following table lists the available entity operations of the Search component.

Operation

Description

Add to saved selection

Adds the entity to a saved selection.

Approve

Approves the entity in review.

Archive

Archives the entity.

Check in

Checks in the entity from external systems (such as Adobe Photoshop, InDesign, Illustrator, and so on). This operation persists the modifications applied to the entity in the external systems.

Check out

Checks out the entity to external systems (such as Adobe Photoshop, InDesign, Illustrator, and so on). This operation locks the entity.

Delete

Deletes the entity.

Direct-publish

Directly publishes the entity, making it available with the other approved entities while skipping the reviewing process.

Discard checkout

Discards the checkout of the entity and ignores any modifications applied to the entity in the external systems.

Download

Downloads the entity.

Generate PDF

Generates a PDF from the entity. This operation requires a preconfigured Print entity generation action.

Go to fixed path

Lets you enter a relative path to the details page as a text string. This improves performance when a user navigates from a search page to a details page. You must update this fixed path when you move a page.

Inline preview

Previews the entity using the inline preview display. This operation is only available for the Grid, Table, List, and Calendar output views. You need to enable the Inline preview output view for the operation to work correctly.

OneDrive checkout

Checks out the entity to a preconfigured OneDrive account. This operation adds the entity to the Checkouts page.

OneDrive download

Uploads a copy of the entity to a preconfigured OneDrive account. This operation uploads a copy of the entity, so the entity itself is not added to the Checkouts page.

Place

Places the image as a layer using Sitecore Connect for Creative Cloud (this operation is not meant to be used within Content Hub).

Preview

Opens a preview rendition of the asset.

Quick edit

Opens a window with a preconfigured entity details page to edit the entity.

Reject

Rejects the entity in review.

Remove from collection

Removes the entity from a collection it belongs to.

Remove from saved selection

Removes the entity from a saved selection it belongs to.

Restore

Restores the entity from the archive to its previous repository.

Select public link

Opens a window where you can create or select a public link to the entity.

Set as master

Sets the file as master file for an entity. For example, set as the master version of an asset.

Submit

Submits the entity for approval.

Toggle switch

Sets a Boolean property of the entity to true or false. You need to provide a Boolean field for this operation (for example, M.Script.Enabled).

Unlock

Unlocks the locked entity. Entities are locked when they are checked out to external systems.

Use direct link

Provides a direct link to the entity. This operation opens the provided link in a new window.

View ancestor details

Provides the ancestor details of the entity. You need to specify an ancestor relation and a redirection page.

View detail page

Redirects you to the detail page of the entity.

View details

Opens a configurable window showing the details of the entity. This operation provides various window types. The drawer type allows you to open multiple detail windows at once.

External action

Executes one or more preconfigured actions. This operation allows you to set visibility conditions and permissions.

To add an operation:

  1. In the Operations section, click Add operation.

  2. Select the desired operation.

  3. Configure the display and operation settings.

  4. Click Save.

  5. To make the operation available in the More options menu instead of the Main menu, drag and drop the created operation from the MAIN OPERATIONS zone to the MORE OPTIONS MENU zone.

Indicators

Indicators are flag-like properties (icons or labels) that provide additional information about an entity. To add an indicator, click Add indicator and configure the indicator settings. The following table lists available indicators.

Indicator

Description

Asset media type

The asset media type of the entity.

Created

The entity is in Created status.

Draft

The entity is a draft.

Duplicates exist

The entity has duplicates.

Has public link

The entity as a public link.

In review

The entity is in In review status.

Lock

The entity is locked.

Rejected

The entity was rejected.

SystemOwned

The entity is system-owned.

There is a new version of this linked asset

The file of the child linked asset is more recent than the file of its parent asset. Restricted to M.Asset entities. Applies only to Adobe InDesign files.

Custom indicator

A custom indicator, which can be configured based on a string, integer, or boolean value so that it only appears when a specific condition is met.

Do you have some feedback for us?

If you have suggestions for improving this article,