Endeca - Property and Property Description Records (PDRs)

About

PDR is s schema record.

PDR's define the format and behaviour of standard attributes and managed attributes.

A data (attribute|column) has a property key.

Articles Related

Property

General

• Key (The unique identifier of the attribute)
• Display Name and type
• Configuration parameters
  • IsUnique: See Endeca - Spec (Primary Key)
  • IsSingleAssign: See Endeca - Multi-assign attribute

Search

search Parameters:

• mdex-property_IsTextSearchable: enables the attribute for record searching.
• mdex-property_IsPropertyValueSearchable: enable value search (default true)
• mdex-property_TextSearchAllowsWildcards: see record searching with wildcard

Navigation

Navigability settings:

• system-navigation_ShowRecordCounts: show record counts for available refinements
• system-navigation_Select: enable or not multi-select by setting the value:
  • single,
  • multi-or
  • or multi-and.
• system-navigation_Sorting: how to sort refinements (possible value: lexical or record-count)

Eid

• system-eid_isDimension: Specifies whether the attribute is available to be used as a dimension to aggregate metric values (boolean)
• system-eid_available_aggregations
• system-eid_default_aggregation
• system-eid_description
• system-eid_formatSettings
• system-eid_approxCardinality: Specifies how Studio display and uses the attribute.

Management

Tools

Properties can be set:

• with the help of the “Attribute Settings” page of Studio.
• or with the web service with Integrator. The attributedata config file from quickstart is a good example. This file is loaded by running the load configuration graph in Integrator.

Record Definition

With the Configuration Web Service

<ns:configTransaction>
        <!-- Return the key of the PDRs for the standard attributes present in the schema of the Endeca data domain. -->
	<ns:listProperties/>
        <!-- Return all Property Description Records (PDRs) for the specified Endeca data domain. -->
	<ns:exportProperties/>
        <! -- Return PDRs for the specified attribute keys. Attribute keys are obtained from listProperties.  -->
	<ns:getProperties>
		<!--Zero or more repetitions:-->
		<mdex-property_Key>?</mdex-property_Key>
	</ns:getProperties>
        <! -- Add the PDRs (specified as an argument) to the schema of the Endeca data domain. If an attribute with the same key exists, it is replaced. -->
	<ns:putProperties>
		<!--Zero or more repetitions:-->
		<ns1:record>
			<mdex-property_DisplayName>?</mdex-property_DisplayName>
			<mdex-property_IsSingleAssign>?</mdex-property_IsSingleAssign>
			<mdex-property_IsTextSearchable>?</mdex-property_IsTextSearchable>
			<mdex-property_IsUnique>?</mdex-property_IsUnique>
			<mdex-property_IsPropertyValueSearchable>?</mdex-property_IsPropertyValueSearchable>
			<mdex-property_Key>?</mdex-property_Key>
			<mdex-property_TextSearchAllowsWildcards>?</mdex-property_TextSearchAllowsWildcards>
			<mdex-property_Type>?</mdex-property_Type>
			<mdex-property_Language>?</mdex-property_Language>
			<system-navigation_Select>?</system-navigation_Select>
			<system-navigation_ShowRecordCounts>?</system-navigation_ShowRecordCounts>
			<system-navigation_Sorting>?</system-navigation_Sorting>
			<!--You may enter ANY elements at this point-->
		</ns1:record>
	</ns:putProperties>
	<!--Optional:-->
	<ns:updateProperties>
		<!--Zero or more repetitions:-->
		<ns1:record>
			<!--Optional:-->
			<mdex-property_DisplayName>?</mdex-property_DisplayName>
			<!--Optional:-->
			<mdex-property_IsSingleAssign>?</mdex-property_IsSingleAssign>
			<!--Optional:-->
			<mdex-property_IsTextSearchable>?</mdex-property_IsTextSearchable>
			<!--Optional:-->
			<mdex-property_IsUnique>?</mdex-property_IsUnique>
			<!--Optional:-->
			<mdex-property_IsPropertyValueSearchable>?</mdex-property_IsPropertyValueSearchable>
			<!--Optional:-->
			<mdex-property_TextSearchAllowsWildcards>?</mdex-property_TextSearchAllowsWildcards>
			<!--Optional:-->
			<mdex-property_Type>?</mdex-property_Type>
			<!--Optional:-->
			<mdex-property_Language>?</mdex-property_Language>
			<!--Optional:-->
			<system-navigation_Select>?</system-navigation_Select>
			<!--Optional:-->
			<system-navigation_ShowRecordCounts>?</system-navigation_ShowRecordCounts>
			<!--Optional:-->
			<system-navigation_Sorting>?</system-navigation_Sorting>
			<mdex-property_Key>?</mdex-property_Key>
			<!--You may enter ANY elements at this point-->
		</ns1:record>
	</ns:updateProperties>
</ns:configTransaction>

Update

Documentation / Reference

• Configuration Web Service operations