This section describes the public JSON formats of keyword redirects.

Public format for redirects

Properties in the JSON file:

Example:

{ "ecr:createDate": "2015-08-11T14:57:34.708Z",
"ecr:type": "redirects" }

Public format for keyword redirect groups

Properties in the JSON file:

Attribute

Value

ecr:type

redirect-group

ecr:createDate

yyyy-MM-dd'T'HH:mm:ss.SSSX. Optional. Date and time that this item was created. Defaults to creation date of the JCR.

displayName

The name for the redirect group that appears in the Keywords Redirects and User Management pages in Workbench

enableStemming

Determines whether stemming is enabled for keyword redirects. It must be a boolean value (true or false). The default value is true.

redirects

One or more redirect entries. Each redirects entry has the following attributes:

Attribute

Type

Required

Description

matchmode

string

yes

The type of match between the specified searchTerms value and the search term that the user enters. Must be one of: MATCHEXACT, MATCHPHRASE, or MATCHALL. For information about these values, see the Oracle Commerce Workbench User's Guide.

url

string

yes

The URL to which users are redirected when they enter the search terms specified by searchTerms.

searchTerms

string

yes

The search term entered by the user that triggers the redirect to the specified url.

searchTerm Expansions

string

See Description.

Specifies the token or tokens that represent each search term and the stem or stems that each token has been reduced to. The entry for each token is uniquely identified by an index value. This property is used by the Assembler to determine which content-items and keyword redirects should trigger for a given search term. The property is generated by tokenizing a search term, and reducing each token to a representative stem. The representative stem is determined by using the Authoring Dgraph's stemming configuration. This property is for internal use only. Oracle recommends that this property not be edited manually. To update the property, run the update_search_term_expansions script. For information about when to run the script, refer to Appendix D Deployment Template Script Reference. For information about tokenization and stemming, refer to the Oracle Commerce Guided Search MDEX Engine Developer's Guide.

Examples:

 { "ecr:type": "redirect-group",
   "ecr:createDate": "2015-08-11T14:57:34.950Z", 
   "redirects": [

   { "matchmode": "MATCHEXACT",
     "url": "/browse/Canon/_/N-1z141ya",
     "searchTerms": "canon"
   },

   { "matchmode": "MATCHPHRASE",
     "url": "/browse/bags-cases/_/N-25xw",
     "searchTerms": "camera bags",
     "searchTermExpansions": {
         "0": {"camera": ["camera"]},
         "1": {"bags": ["bag"]}
      }
   }
  ]
} 

Copyright © Legal Notices