logo
logo

Configuration

When you configure how the Search component displays the output of a search, you need to define additional settings on the Output tab depending on the output display. These settings include:

  1. Template
  2. Image
  3. Icon and color
  4. Main click area
  5. Fields
  6. Operations
  7. Indicators

Template

For some display types, there are multiple templates available in the Template section.

  • To define a specific display template, in the Template section, select the template you want to use.

Image

To set an image on the search results:

  • On the Output tab, from the Image drop-down list, select one of the following options:

    • Thumbnail: displays the thumbnail (master image) 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:

  • On the Output tab, in the Icon and color section, from the Icon and color drop-down 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 drop-down list.
Note

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

Main click area

You can add an entity operation in the main click area.

To add an operation:

  1. On the Output tab, in the Main click area section, click Add operation.
  2. Select the desired operation from the drop-down list.
  3. As required, define additional operation settings and click Save.

Fields

You can decide which fields to display on the search results. To define a field to display:

  1. On the Output tab, in the Fields section, click Add .
  2. Configure the following fields.
FieldTypeDescriptionValueMandatory/Optional
TypeRadio buttonsSets the field type.Property/RelationMandatory
FieldDrop-down listSelects the field to add.List of available fields.Mandatory
StyleDrop-down listSelects the style to apply.Regular, Bold, Light, Light smallMandatory, only for Type Property.
Limit number of itemsToggle switchLimits the number of items returned.Enable/DisableOptional, only for Type Relation.
Number of items to showNumerical valueSets the limit of items to return.Numerical valueOptional, only for Type Relation.
Show help textDrop-down listSets whether to show the help text and how.Don't show / Inline / TooltipMandatory
Note

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

  1. Configure the additional settings required for the selected fields.
  2. 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.

To add an operation:

  1. On the Output tab, 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.

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

OperationDescription
Add to saved selectionAdds the entity to a saved selection.
ApproveApproves the entity in review.
ArchiveArchives the entity.
Check inChecks 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 outChecks out the entity to external systems (such as Adobe Photoshop, InDesign, Illustrator, and so on). This operation locks the entity.
DeleteDeletes the entity.
Direct-publishDirectly publishes the entity, making it available with the other approved entities while skipping the reviewing process.
Discard checkoutDiscards the checkout of the entity and ignores any modifications applied to the entity in the external systems.
DownloadDownloads the entity.
Generate PDFGenerates a PDF from the entity. This operation requires a preconfigured Print entity generation action.
Go to fixed pathLets 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 previewPreviews 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 checkoutChecks out the entity to a preconfigured OneDrive account. This operation adds the entity to the Checkouts page.
OneDrive downloadUploads 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.
PlacePlaces the image as a layer using Sitecore Connect for Creative Cloud (this operation is not meant to be used within Content Hub).
PreviewOpens a preview rendition of the asset.
Quick editOpens a window with a preconfigured entity details page to edit the entity.
RejectRejects the entity in review.
Remove from collectionRemoves the entity from a collection it belongs to.
Remove from saved selectionRemoves the entity from a saved selection it belongs to.
RestoreRestores the entity from the archive to its previous repository.
Select public linkOpens a window where you can create or select a public link to the entity.
Set as masterSets the file as master file for an entity. For example, set as the master version of an asset.
SubmitSubmits the entity for approval.
Toggle switchSets 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).
UnlockUnlocks the locked entity. Entities are locked when they are checked out to external systems.
Use direct linkProvides a direct link to the entity. This operation opens the provided link in a new window.
View ancestor detailsProvides the ancestor details of the entity. You need to specify an ancestor relation and a redirection page.
View detail pageRedirects you to the detail page of the entity.
View detailsOpens 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 actionExecutes one or more preconfigured actions. This operation allows you to set visibility conditions and permissions.

Indicators

You can configure which indicators to display with the search results. Indicators are flag-like properties (icons or labels), providing additional information about the entity in question.

To add an indicator:

  1. On the Output tab, in the Indicators section, click Add indicator.
  2. Select an indicator under Indicators, or select Custom indicator under Custom.
  3. Configure the required settings.
  4. Click Save.

The following table lists all the available indicators in the Search component.

IndicatorDescription
Asset media typeIndicates the asset media type of the entity.
CreatedIndicates if the entity is in Created status.
DraftIndicates if the entity is a draft.
Duplicates existIndicates if the entity has duplicates.
Has public linkIndicates if the entity as a public link.
In reviewIndicates if the entity is in In review status.
LockIndicates if the entity is locked.
RejectedIndicates if the entity is in Rejected status.
SystemOwnedIndicates if the entity is system-owned.
Custom indicatorA custom indicator is displayed if preconfigured conditions are met.

Can we improve this article ? Provide feedback