Sunday, April 24, 2016

CAS Based Indexing : What is Index-config.json

The Index Configuration modifies index configuration stored in the Endeca Configuration Repository for an application. This utility is typic... thumbnail 1 summary
The Index Configuration modifies index configuration stored in the Endeca Configuration Repository for an application. This utility is typically used to modify data after it has been exported from a product catalog system and modify the search configuration settings for the data.

The following configuration can be done using index-config.json:

  • Endecaproperties,derived properties,and dimensions.
  • Precedence rules. These are specified under the precedenceRules node.
  • Search configuration. These are specified under the searchIndexConfig node.
This file can be find out under <<Endeca_App>>/config/index-config/index-config.json

Find out schema definition below 


endeca:property 
  • isEnabled
    • Optional. Indicates whether the property is processed by CAS when CAS writes MDEX-compatible output. A value of true includes the property during processing; false excludes the property. This setting is useful when troubleshooting data issues for specific attributes. If omitted, the default value is true.
  • isRecordFilterable
    • Optional. Indicates whether the property can be used to filter records. Record filtering presents a subset of the data to the end-user. If omitted, the default value is false.
  • isRecordSearchEnabled
    • Optional. Specifies whether or not record search should be enabled for this property. Record search finds all records in an Endeca application that are tagged with an Endeca property that matches a term the user provides. You must enable each property that you want available for the record search. If omitted, the default value is false.
  • isRollupKey
    • Optional. Indicates whether the property can be used as a rollup key. This allows aggregated records to be based on this Endeca property. If omitted, the default value is false
  • isWildcardEnabledInRecordSearch
    • Optional. Indicates whether wildcard search is enabled for this Endeca property
  • mergeAction - ADD, UPDATE
    • Optional. The mergeAction specifies how to merge the attribute into the index configuration
  • propertyDataTYpe - ALPHA, INTEGER, DOUBLE, GEOCODE, DATETIME, DURATION, TIME
    • If omitted, the default value of propertyDataType is ALPHA
  • sourcePropertyName (multi-valued)
endeca:derivedProperty
  • derivedPropertyFunction - MIN, MAX, SUM, AVG
  • derivedPropertySource
  • isEnabled
  • mergeAction
endeca:dimension
  • displayOrder 
  • isAutogen
  • isEnabled
  • isHierarchicalDimensionSearchEnabled
  • isHierarchicalRecordSearchEnabled
  • isRecordSearchEnabled
    • Optional. Specifies whether or not record search should be enabled for this dimension
  • isWildcardEnabledInRecordSearch
  • mergeAction
  • multiSelectType - NONE, OR, AND
    • Optional. The multiSelectType enumerates the valid values for specifying multi-select dimensions
  • rangeComparisonType - STRING, INTEGER, FLOAT
    • Optional. This is used to create a range dimension
  • sourcePropertyName



endeca:precedenceRules

  • isEnabled
  • isLeafTrigger 
  • mergeAction 
  • triggerDimension 
    • Required. Specifies the trigger dimension for a precedence rule.
  • triggerDimensionValueSpec
  • targetDimension
    • Required. Specifies the target dimension for a precedence rule
Precedence_Rules_Index-config.json


How to apply to Endeca Application

Updated json can be set into application using below command


<<Endeca_APP_PATH>>/control->./index_config_cmd.sh set-config -o system -f <<File_Path>>/index-config.json


From Author

Was this post resolve the solution you are looking for?Provide your comments

No comments

Post a Comment

Text Widget