Builds an SQL query for Faceted Search.

Syntax

Smartsite SXML	Copy Code
<se:facetedsearchquerybuilder> <se:parameters> <se:parameter name="configurationxml"> </se:parameter> </se:parameters> </se:facetedsearchquerybuilder>

Parameters

Name	Data Type	Properties	Description
ChannelCodes	String	-	Sets the channel codes.
ConfigurationXml	XML	IsRequired	Sets the configuration XML.
Connection	String	Trim	Sets the connection used for the Sql query.
Facet	String	-	Sets the facet.
FacetValues	Collection	-	Sets the facet values.
Fulltextoverideset	Boolean	-	Sets the fulltext.
Mode	Enum	-	Sets the (query) mode. Enum values: SearchQuery Search Query FacetQuery Facet Query CountQuery Count Query
OrderBy	String	-	Sets the order by clause.
OutputBufferName	String	-	Sets the name of the output buffer for storing the datatable (which should be passed to the sqlquery macro).
SearchBaseName	String	-	Sets the name of the search base.
SearchGroup	String	-	Sets the search group.
SearchProfile	String	-	Sets the search profile.
Sources	Collection	-	Sets the sources.
TableOrView	String	-	Sets the (main) table or view for the search query.

Shared Parameters

Name	Data Type	Properties	Description
Access	String	-	Friendly name of the minimum access type level required by the site visitor to execute this macro.
AccessDenied	String	RawData	Sets the value that is returned when the site visitor has insufficient access.
AIM	Enum	-	Sets the AIM scanning mode of the macro. Enum values: NotSet Not set. Off No AIM scanning. External Output XML scanning. Internal Internal scanning, implemented by AIM-aware macros. Autonomous Relations are to be linked to the current source item, instead of the rendered page. SoftLink Should generate soft links (in combination with External flag). InternalAutonomous Internal scanning, combined with the Autonomous setting. ExternalAutonomous External scanning, combined with the Autonomous setting. ExternalAutonomousSoftLink External scanning, combined with the Autonomous and softLink settings. ExternalSoftLink External scanning, combined with the Softlink setting.
Condition	String	MustBeAttribute ExpressionSyntax XmlDecode	Sets the Viper expression to evaluate before actually executing the macro. If the expression returns false, the execution of the module and its child modules is skipped.
Default	String	RawData	Sets the default value that will be returned when the execution would otherwise return an empty string.
Error	String	RawData	Sets the value to return in case on error occurs during execution. The Viper expressions this.error(), this.error(full) and this.error(type) are available in this context.
Id	String	MustBeAttribute Trim	Sets the Id of the macro. Macros with Ids set can be accessed using Viper by referring to page.[id].[methodname()].
LocalId	String	MustBeAttribute Trim	Sets the local id of the macro in the current buffer scope.
Rem	String	RawData NoCache Trim	Sets the remarks. Remarks have no effect on the actual execution of the module. They only improve the readability of the code.
ResultFormat	String	RawData	Sets the resultformat.
ResultType	Enum	-	Sets the type of the result. Enum values: Undefined Not set None No result String Default type Object Generic object Binary Binary data Boolean Boolean DataTable DataTable DateTime Date/time Float Floating point numeric data Integer Integer Locator Extended Uri Xml Xml Data
Save	Collection	-	Sets the buffer names.
Status	Enum	-	Gets a value indicating the ModuleStatus of this module. Enum values: Unknown Unknown BeginInitialize Initializing the module EndInitialize Module has fully initialized BeginSetProperties Properties are about to be set EndSetProperties Properties have been set BeginExecute Execution starts BeginFormatData Starting data formatting. EndFormatData Ended data formatting. BeginFormatResult Before formating result. EndFormatResult After formatting result EndExecute Execution is ending StartLoseScope Execution has completed EndLoseScope Module is about to unload Error Module is in an error state
Timeout	Float	-	Sets the timeout in seconds. In the overriden Execute() method, you can call CheckTimeout() to check whether execution has timed out.
Trim	Enum	MustBeAttribute	Gets a value indicating how the whitespace is trimmed.
Whitespace	Enum	MustBeAttribute	Gets a value indicating whether to preserve whitespace. Enum values: Inherit Inherit from parent. Preserve Keep all whitespace. Remove Remove all whitespace. Normalize Convert all whitespace to single spaces. SimpleFormat Convert all whitespace to single spaces, but keep single line breaks.

Local Viper Methods

Viper	Extension	Description
This.ClearForcedResult		Sets the result of the macro. used to override the normal handling of the result creation.
This.ContentTypeWeight		Gets the content type weight.
This.Facet		Gets the facet.
This.FacetSelectFields		Gets the facet select fields.
This.FacetWhereClause		Gets the facet-specific where clause.
This.FieldName		Gets the name of the field.
This.FieldWeight		Gets the field weight.
This.GetForcedResult		Gets the forced result of the macro, set by overriding the normal rendering using SetForcedResult().
This.IsBaseQuery		Gets a value indicating whether this instance is a base (search) query.
This.JoinClause		Gets the join clause.
This.Mode		Gets the (query) mode.
This.OrderBy		Gets the order by clause.
This.PopularityWeight		Gets the popularity weight.
This.RankingFields		Gets the ranking fields.
This.RankingStatement		Gets the ranking statement for the specified (native) source.
This.RenderTime	✓	Returns the render time of the macro in milliseconds.
This.ResultChannelCode		Gets the result channel code.
This.ResultChannelJoins		Gets the result channel joins.
This.SearchCondition		Gets the (native) search condition for the specified source.
This.SearchGroupViewName		Gets the viewname for the search group that has been configured.
This.SearchQuery		Gets the search query.
This.SelectFields		Gets the select fields.
This.SeoPriority		Gets the SEO priority.
This.SetForcedResult		Sets the result of the macro. used to override the normal handling of the result creation.
This.TableOrView		Gets the (main) table or view for the search query.
This.WhereClause		Gets the where clause.

Shared Local Viper Methods

Viper	Extension	Description
This.AIM.Relations	✓	Gets a list of all outgoing AIM relations created by the macro.
This.Buffer.Exists		Checks whether a local buffer exists.
This.Buffer.Get		Gets a local buffer.
This.Buffer.Set		Sets a local buffer.
This.Error.InnerException.Message		Returns the text message of the inner exception of the exception that has occurred.
This.Error.InnerException.SmartsiteCode		Returns Smartsite error code of the inner exception of the exception that has occurred.
This.Error.InnerException.Throw		Makes Smartsite throw the inner exception.
This.Error.InnerException.ToString		Returns the full information of the inner exception of the exception that has occurred, including the stack trace.
This.Error.InnerException.Type		Returns the full Type name of the inner exception of the exception that has occurred.
This.Error.Message		Returns the text message of the exception that has occurred.
This.Error.SmartsiteCode		Returns the Smartsite Error code of the exception that has occurred.
This.Error.Throw		Makes Smartsite throw the current exception.
This.Error.ToString		Returns the full information of the exception that has occurred, including the stack trace.
This.Error.Type		Returns the full Type name of the exception that has occurred.
This.FindExtension		Finds an extension macro.
This.GetParameter	✓	Gets the value of the given parameter/property.
This.ParameterExists	✓	Checks whether the given parameter/property is set.
This.Result		Returns the result of the macro. Typically used in the ResultFormat property, to format, convert or encode the result.
This.SXMLPath		Gets the path to the macro in the current execution stack.

Remarks

Example

Faceted Search QueryBuilder Example

Below you see an example of how the facetedsearchquerybuilder macro is called within the sml_FacetedSearch smartlet.

The mode parameter is used to specify what type of query the querybuilder macro should construct: countquery, searchquery or facetquery.

The sources parameter indicates which sources, as defined within the configuration/query xml, must be used when constructing the specified type of query.

The (optional) searchprofile parameter can be used to specify a (within the configuration xml) pre-configured search profile, e.g. search in titles only.

The configurationxml parameter is a required paramter and should be supplied with the configuration xml (type Xml, so you need to use convert.toxml() on the item's xml field).

The tableorview parameter is used to specify which view must be used to join the results with, so only results from that (e.g. channel) view are displayed. This parameter in itself doesn't do anything, the specified value is just used in resolving the local instance viper this.tableorview(), which should be used in the configuration xml (a.k.a. Query xml).

Through the facetvalues parameter, the macro receives the selected filter settings (if any).

The facetedsearchquerybuilder macro will output the constructed query as result, however the macro also creates an sxml datatable which can be directly used on a subsequent sqlquery macro call as inputdata. The parameter outputbuffername is used to specify a buffer name for this sxml datatable.

Smartsite SXML	Copy Code
<se:facetedsearchquerybuilder mode="searchquery" save="search_query" sources="{smartlet.get(sources)}" outputbuffername="sqlparams" searchprofile="{smartlet.get(searchprofile)}"> <se:parameters> <se:parameter name="configurationxml">{buffer.get(xml)}</se:parameter> <se:parameter name="tableorview">{channel.view()}</se:parameter> <se:parameter name="facetvalues"> <se:collection inputdata="inputdata" /> </se:parameter> </se:parameters> </se:facetedsearchquerybuilder>

Smartsite SXML

Copy Code

<se:facetedsearchquerybuilder mode="searchquery" save="search_query" 
  sources="{smartlet.get(sources)}" outputbuffername="sqlparams" 
  searchprofile="{smartlet.get(searchprofile)}">
 <se:parameters>
  <se:parameter name="configurationxml">{buffer.get(xml)}</se:parameter>
  <se:parameter name="tableorview">{channel.view()}</se:parameter>
  <se:parameter name="facetvalues">
   <se:collection inputdata="inputdata" />
  </se:parameter>
 </se:parameters>
</se:facetedsearchquerybuilder>