DocumentationAEM 6.4Deploying Guide

Upgrading Custom Search Forms upgrading-custom-search-forms

Last update: Wed May 03 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
CAUTION
AEM 6.4 has reached the end of extended support and this documentation is no longer updated. For further details, see our technical support periods. Find the supported versions here.

In AEM 6.2, the location where Customized Search Forms are stored in the repository has changed. Upon upgrading, they are moved from their location in 6.1 at:

  • /apps/cq/gui/content/facets

to a new location under:

  • /conf/global/settings/cq/search/facets

Because of this, manual adjustments are required after an upgrade in order for the forms to continue to function.

This applies to new Search Forms as well as default Forms that have been customized.

For more information, see the documentation on Search Facets.

Changing the resourceType property changing-the-resourcetype-property

Unless stated otherwise, most of the adjustments that need to be done after the upgrade require changing the sling:resourceType property for the configured custom Search Forms. This is needed so that the property points to the correct location of the rendering script.

You can change the property by doing the following:

  1. Open CRXDE Lite by going to https://server:port/crx/de/index.jsp
  2. Browse to the location of the node that needs to be adjusted, as specified in the List of Custom Search Forms below.
  3. Click the node. In the right properties pane, click and modify the sling:resourceType property.
  4. Finally, save the changes by pressing the Save All button.

List of Custom Search Forms list-of-custom-search-forms

Below you will find a list of all cusom Search Forms and the modifications they require after the upgrade. They refer to the names in /conf/global/settings/cq/search/facets/sites/items.

Fulltext Predicate with node name “fulltext” fulltext-predicate-with-node-name-fulltext

Node/s in default Search Form in 6.1
fulltext
Resource type in 6.1
cq/gui/components/common/admin/customsearch/searchpredicates/fulltextpredicate
Resource type in 6.2
n/a

In AEM 6.1, the standard fulltext predicate was part of the search form. In 6.2, the fulltext field has been replaced by the OmniSearch. This predicate is skipped programmatically and can be removed.

Action: Remove the node entirely.

Other Fulltext Predicates other-fulltext-predicates

Node/s in default Search From in 6.1
n/a
Resource type in 6.1
cq/gui/components/common/admin/customsearch/searchpredicates/fulltextpredicate
Resource type in 6.2
cq/gui/components /coral/ common/admin/customsearch/searchpredicates/fulltextpredicate

Action: Adjust the resourceType property (add “/coral” like in the 6.2 location indicated above).

Path Browser Predicates path-browser-predicates

Node/s in default Search Form in 6.1
path
Resource type in 6.1
cq/gui/components/common/admin/customsearch/searchpredicates/pathpredicate
Resource type in 6.2
cq/gui/components /coral/ common/admin/customsearch/searchpredicates/pathpredicate

Action: Adjust the resourceType property (add “/coral” like in the 6.2 location indicated above).

Tags Predicates tags-predicates

Node/s in default Search Form in 6.1
tags
Resource type in 6.1
cq/gui/components/common/admin/customsearch/searchpredicates/tagspredicate
Resource type in 6.2
cq/gui/components /coral/ common/admin/customsearch/searchpredicates/tagspredicate

Action: Adjust the resourceType property (add “/coral” like in the 6.2 location indicated above).

Page Status Predicate page-status-predicate

Node/s in default Search Form in 6.1
pagestatuspredicate
Resource type in 6.1
cq/gui/components/siteadmin/admin/searchpanel/searchpredicates/pagestatuspredicate
Resource type in 6.2
n/a

The Page Status has been replaced by two Options Property Predicates, one for publish and one for LiveCopy status.

Actions:

  • Remove the pagestatuspredicate node

  • Copy node

    • /libs/settings/cq/search/facets/sites/jcr:content/items/publishstatuspredicate
    • to /conf/global/settings/cq/search/facets/sites/jcr:content/items

  • Copy node

    • /libs/settings/cq/search/facets/sites/jcr:content/items/livecopystatuspredicate
    • to /conf/global/settings/cq/search/facets/sites/jcr:content/items

  • Make sure you set listOrder property for the analyticspredicate node to “8”. This is needed in order to avoid conflicts.

Date Range Predicates date-range-predicates

Node/s in default Search Form in 6.1
daterangepredicate
Resource type in 6.1
cq/gui/components/common/admin/customsearch/searchpredicates/daterangepredicate
Resource type in 6.2
cq/gui/components /coral/ common/admin/customsearch/searchpredicates/daterangepredicate

Action: Adjust the resourceType property (add “/coral” like in the 6.2 location indicated above).

Hidden Filter hidden-filter

Node/s in default Search Form in 6.1
type
Resource type in 6.1
granite/ui/components/foundation/form/hidden
Resource type in 6.2
granite/ui/components/foundation/form/hidden

Action: Nothing to adjust.

Analytics Predicate analytics-predicate

Node/s in default Search Form in 6.1
analyticspredicate
Resource type in 6.1
cq/gui/components/siteadmin/admin/searchpanel/searchpredicates/analyticspredicate
Resource type in 6.2
cq/gui/components /coral/ siteadmin/admin/searchpanel/searchpredicates/analyticspredicate

Action: Adjust the resourceType property (add “/coral” like in the 6.2 location indicated above).

Range Predicate range-predicate

Node/s in default Search Form in 6.1
n/a
Resource type in 6.1
cq/gui/components/siteadmin/admin/searchpanel/searchpredicates/rangepredicate
Resource type in 6.2
cq/gui/components /coral/ siteadmin/admin/searchpanel/searchpredicates/rangepredicate

Action: Adjust the resourceType property (add “/coral” like in the 6.2 location indicated above).

NOTE
Note: In opposition to 6.1, the Range Predicate does no longer render a tag in the search bar.

Options Property Predicate options-property-predicate

Node/s in default Search Form in 6.1
n/a
Resource type in 6.1
cq/gui/components/siteadmin/admin/searchpanel/searchpredicates/optionspredicate
Resource type in 6.2
cq/gui/components /coral/ siteadmin/admin/searchpanel/searchpredicates/optionspredicate

Action: Adjust the resourceType property (add “/coral” like in the 6.2 location indicated above).

Slider Range Predicate slider-range-predicate

Node/s in default Search Form in 6.1
n/a
Resource type in 6.1
cq/gui/components/siteadmin/admin/searchpanel/searchpredicates/sliderrangepredicate
Resource type in 6.2
cq/gui/components /coral/ siteadmin/admin/searchpanel/searchpredicates/sliderrangepredicate

Action: Adjust the resourceType property (add “/coral” like in the 6.2 location indicated above).

Components Predicate components-predicate

Node/s in default Search Form in 6.1
n/a
Resource type in 6.1
cq/gui/components/siteadmin/admin/searchpanel/searchpredicates/componentspredicate
Resource type in 6.2
cq/gui/components /coral/ siteadmin/admin/searchpanel/searchpredicates/componentspredicate

Action: Adjust the resourceType property (add “/coral” like in the 6.2 location indicated above).

Author Predicate author-predicate

Node/s in default Search Form in 6.1
n/a
Resource type in 6.1
cq/gui/components/siteadmin/admin/searchpanel/searchpredicates/userpredicate
Resource type in 6.2
cq/gui/components /coral/ siteadmin/admin/searchpanel/searchpredicates/userpredicate

Action: Adjust the resourceType property (add “/coral” like in the 6.2 location indicated above).

Templates Predicate templates-predicate

Node/s in default Search Form in 6.1
n/a
Resource type in 6.1
cq/gui/components/siteadmin/admin/searchpanel/searchpredicates/templatespredicate
Resource type in 6.2
cq/gui/components /coral/ siteadmin/admin/searchpanel/searchpredicates/templatespredicate

Action: Adjust the resourceType property (add “/coral” like in the 6.2 location indicated above).

Assets Admin Search Rail assets-admin-search-rail

The nodes below refer to the names in /conf/global/settings/dam/search/facets/assets/items

Fulltext Predicate with node name “fulltext” fulltext-predicate-with-node-name-fulltext-1

Node/s in default Search Form in 6.1
fulltext
Resource type in 6.1
dam/gui/components/admin/customsearch/searchpredicates/fulltextpredicate
Resource type in 6.2
n/a

In 6.1 the standard fulltext predicate was part of the search form. In 6.2 the fulltext field has been replaced by OmniSearch. This predicate is skipped programmatically and can be removed.

Action: Remove the above mentioned node.

Path Browser Predicates path-browser-predicates-1

Node/s in default Search Form in 6.1
pathbrowser
Resource type in 6.1
dam/gui/components/admin/customsearch/searchpredicates/pathbrowserpredicate
Resource type in 6.2
dam/gui/coral/components/admin/customsearch/searchpredicates/pathbrowserpredicate

Action: Adjust the resourceType property (add “/coral” like in the 6.2 location indicated above).

Mime Type Predicates mime-type-predicates

Node/s in default Search Form in 6.1
mimetype
Resource type in 6.1
dam/gui/components/admin/customsearch/searchpredicates/optionspredicate
Resource type in 6.2
dam/gui/coral/components/admin/customsearch/searchpredicates/optionspredicate

Action: Adjust the resourceType property (add “/coral” like in the 6.2 location indicated above).

File Size Predicates file-size-predicates

Node/s in default Search Form in 6.1
filesize
Resource type in 6.1
dam/gui/components/admin/customsearch/searchpredicates/filesizepredicate
Resource type in 6.2
dam/gui/coral/components/admin/customsearch/searchpredicates/sliderangepredicate

Action: Adjust resourceType as shown in the 6.2 location above.

Asset Last Modified Predicates asset-last-modified-predicates

Node/s in default Search Form in 6.1
assetlastmodifiedpredicate
Resource type in 6.1
dam/gui/components/admin/customsearch/searchpredicates/assetlastmodifiedpredicate
Resource type in 6.2
dam/gui/coral/components/admin/customsearch/searchpredicates/assetlastmodifiedpredicate

Action: Adjust the resourceType property (add “/coral” like in the 6.2 location indicated above).

Publish Predicate publish-predicate

Node/s in default Search Form in 6.1
publish
Resource type in 6.1
dam/gui/components/admin/customsearch/searchpredicates/publishpredicate
Resource type in 6.2
dam/gui/coral/components/admin/customsearch/searchpredicates/publishpredicate

Actions:

  • Adjust the resourceType property (add “/coral” like in the 6.2 location indicated above)

  • Add an optionPaths (of type String) property with the value: /libs/dam/options/predicates/publish

  • Add singleSelect property with boolean value true.

Status Predicates status-predicates

Node/s in default Search Form in 6.1
status
Resource type in 6.1
dam/gui/components/admin/customsearch/searchpredicates/optionspredicate
Resource type in 6.2
dam/gui/coral/components/admin/customsearch/searchpredicates/optionspredicate

Action: Adjust the resourceType property (add “/coral” like in the 6.2 location indicated above)

Expiry Status Predicates expiry-status-predicates

Node/s in default Search Form in 6.1
expirystatus
Resource type in 6.1
dam/gui/components/admin/customsearch/searchpredicates/expiredassetpredicate
Resource type in 6.2
dam/gui/coral/components/admin/customsearch/searchpredicates/expiredassetpredicate

Action: Adjust the resourceType property (add “/coral” like in the 6.2 location indicated above)

Metadata Validity Predicates metadata-validity-predicates

Node/s in default Search Form in 6.1
metadatavalidity
Resource type in 6.1
dam/gui/components/admin/customsearch/searchpredicates/optionspredicate
Resource type in 6.2
dam/gui/coral/components/admin/customsearch/searchpredicates/optionspredicate

Action: Adjust the resourceType property (add “/coral” like in the 6.2 location indicated above)

Rating Predicates rating-predicates

Node/s in default Search Form in 6.1
rating
Resource type in 6.1
dam/gui/components/admin/customsearch/searchpredicates/ratingpredicate
Resource type in 6.2
dam/gui/coral/components/admin/customsearch/searchpredicates/sliderangepredicate

Action: Adjust the resourceType property (add “/coral” like in the 6.2 location indicated above)

Orientation Predicate orientation-predicate

Node/s in default Search Form in 6.1
orientation
Resource type in 6.1
dam/gui/components/admin/customsearch/searchpredicates/tagsfilterpredicate
Resource type in 6.2
cq/gui/components/coral/common/admin/customsearch/searchpredicates/tagspredicate

Actions:

  • Adjust the resourceType property (add “/coral” like in the 6.2 location indicated above)

  • Add a fieldLabel property with the same value as the text property on the same node.

  • Add an emptyText property with the value same as the text property on the same node.

  • Add a rootPath property with the same value same as the optionPaths property on the same node.

Style Predicate style-predicate

Node/s in default Search Form in 6.1
style
Resource type in 6.1
dam/gui/components/admin/customsearch/searchpredicates/tagsfilterpredicate
Resource type in 6.2
cq/gui/components/coral/common/admin/customsearch/searchpredicates/tagspredicate

Actions:

  • Adjust the resourceType property (add “/coral” like in the 6.2 location indicated above)

  • Add a fieldLabel property with the same value as the text property on the same node.

  • Add an emptyText property with the value same as the text property on the same node.

  • Add a rootPath property with the same value same as the optionPaths property on the same node.

Video Format Predicates video-format-predicates

Node/s in default Search Form in 6.1
videoFormat
Resource type in 6.1
dam/gui/components/admin/customsearch/searchpredicates/optionspredicate
Resource type in 6.2
dam/gui/coral/components/admin/customsearch/searchpredicates/optionspredicate

Action: Adjust the resourceType property (add “/coral” like in the 6.2 location indicated above)

Mainasset Predicate mainasset-predicate

Node/s in default Search Form in 6.1
mainasset
Resource type in 6.1
granite/ui/components/foundation/form/hidden
Resource type in 6.2
granite/ui/components/coral/foundation/form/hidden

Action: Adjust the resourceType property (add “/coral” like in the 6.2 location indicated above)

recommendation-more-help
6a71a83d-c2e0-4ce7-a6aa-899aa3885b56