https://wiki.socialstack.dev/api.php?action=feedcontributions&feedformat=atom&user=46.16.211.253SocialStack - User contributions [en-gb]2026-10-16T05:42:38ZUser contributionsMediaWiki 1.36.2https://wiki.socialstack.dev/index.php?title=Filters&diff=625Filters2024-01-29T16:50:51Z<p>46.16.211.253: /* Sorting */</p>
<hr />
<div>Filters are a query-like mechanism for filtering out results from a list endpoint. At their core, they are textual and support a set of arguments.<br />
<br />
= Filter examples =<br />
<br />
A textual filter with arguments is like so:<br />
<br />
<syntaxhighlight lang="sql"><br />
(UserId=? or UserId=?) and CreatedUtc>?<br />
</syntaxhighlight><br />
<br />
It is not case sensitive. Filters in the permission system do not support these ? arguments (as it wouldn't know where to bind the value from).<br />
<br />
Typically you'll see this textual form of filter inside a Where() call in the C# API:<br />
<br />
<syntaxhighlight lang="csharp"><br />
uint userId = 14;<br />
<br />
var listOfThingsByThisUser = await Where("UserId=?").Bind(userId).ListAll(context);<br />
</syntaxhighlight><br />
<br />
.Bind() is used to bind the actual value of an argument. Values are bound in this way such that the filter string is a constant and can benefit from being precompiled. Indeed, the whole filter system is built to be entirely non-allocating, as the Bind calls internally set your provided value onto an compiled object field, with that object originating from a pool for the given cached filter.<br />
<br />
= JS filter notation =<br />
<br />
Filters can also be constructed by the frontend, most often by [[Loop]]. In this scenario, a convenience filter notation is also available - it'll take the object notation you provide, and then convert it into the textual format with arguments. Here's some examples:<br />
<br />
<syntaxhighlight lang="js"><br />
<br />
<Loop over="page" filter={<br />
{<br />
where: {<br />
userId: 14<br />
}<br />
}<br />
}><br />
{page => { return <p>{page.url}</p>; }}<br />
</Loop><br />
<br />
</syntaxhighlight><br />
<br />
<br />
<syntaxhighlight lang="js"><br />
<br />
import webRequest from 'UI/Functions/WebRequest';<br />
<br />
webRequest("page/list", {<br />
where: {<br />
userId: 14<br />
}<br />
}).then(response => {<br />
// response.json contains the set of pages made by user #14<br />
})<br />
<br />
</syntaxhighlight><br />
<br />
The filter object itself:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
where: {<br />
userId: 14<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
[[#Operators]] can be used by passing an object:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
where: {<br />
userId: {<br />
greaterThan: 14<br />
}<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
Or statements are represented with an array:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
where: [{<br />
userId: 14<br />
},<br />
{<br />
userId: 16<br />
}]<br />
}<br />
</syntaxhighlight><br />
<br />
And statements are performed by providing multiple field values:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
where: {<br />
userId: 14,<br />
createdUtc: {<br />
greaterThan: yesterday /* yesterday is a JS Date */<br />
}<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
If you need more expressive power, you can also directly specify the query and args:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
query: "UserId=?",<br />
args: [14]<br />
}<br />
</syntaxhighlight><br />
<br />
Query/args being passed in to webRequest and Loop:<br />
<br />
<syntaxhighlight lang="js"><br />
<br />
import webRequest from 'UI/Functions/WebRequest';<br />
<br />
webRequest("page/list", {<br />
query: "UserId=?",<br />
args: [14]<br />
}).then(response => {<br />
// response.json contains the set of pages made by user #14<br />
})<br />
<br />
<br />
<Loop over='page' filter={{query: "UserId=?",<br />
args: [14]}}> ... <br />
</Loop><br />
<br />
</syntaxhighlight><br />
<br />
= Operators =<br />
<br />
Filters support a variety of operators for comparisons:<br />
<br />
* Greater than<br />
* Field>? (query notation)<br />
* {greaterThan: x} (JS notation)<br />
<br />
* Less than<br />
* Field<? (query notation)<br />
* {lessThan: x} (JS notation)<br />
<br />
* Greater than or equal<br />
* Field>=? (query notation)<br />
* {greaterThanOrEqual: x} (JS notation)<br />
* {geq: x} (JS notation)<br />
<br />
* Less than or equal<br />
* Field<=? (query notation)<br />
* {lessThanOrEqual: x} (JS notation)<br />
* {leq: x} (JS notation)<br />
<br />
* Equals<br />
* Field=? (query notation)<br />
* x (JS notation)<br />
* {equals: x} (JS notation)<br />
<br />
* Not<br />
* Field!=? (query notation)<br />
* !( .... ) (query notation)<br />
* {not: x} (JS notation)<br />
<br />
* Starts with (textual values only)<br />
* Field startsWith ? (query notation)<br />
* {startsWith: x} (JS notation)<br />
<br />
* Ends with (textual values only)<br />
* Field endsWith ? (query notation)<br />
* {endsWith: x} (JS notation)<br />
<br />
* Contains (textual values only)<br />
* Field contains ? (query notation)<br />
* {contains: x} (JS notation)<br />
<br />
= Arrays =<br />
<br />
If you provide an array of values you must tell the query system that you are doing so by surrounding your ? arg with square brackets, like this:<br />
<br />
<syntaxhighlight lang="bash"><br />
Name=[?]<br />
</syntaxhighlight><br />
<br />
This syntax exists such that the precompiled filter is ready to receive a set of values rather than just one.<br />
<br />
If you're doing this in C# you can then bind any IEnumerable like so, provided its data type matches that of the target field:<br />
<br />
<syntaxhighlight lang="csharp"><br />
<br />
var nameList = new List<string>() { "Dave", "Steve" };<br />
<br />
var resultsWithEitherName = await Where("Name=[?]").Bind(nameList).ListAll(context);<br />
<br />
</syntaxhighlight><br />
<br />
From javascript you can just pass an array inside your args like so:<br />
<br />
<syntaxhighlight lang="js"><br />
<br />
{<br />
"query": "Name=[?]",<br />
"args": [<br />
["Dave", "Steve"]<br />
]<br />
}<br />
<br />
</syntaxhighlight><br />
<br />
= Virtual Fields =<br />
<br />
Virtual Fields can be used inside filter query strings as well just by simply using their name. The value is always the uint IDs. So for example if we want to get all pages tagged with "hello", first we need to get the ID of the tag "hello" (which we'll say is tag #4) and then from there can use it as either an array or a number as-is:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
query: "Tags contains ?", // Results must have tag #4 on them, but can have any other tags too<br />
args: [<br />
4<br />
]<br />
}<br />
<br />
{<br />
query: "Tags=?", // Results must have exactly 1 tag and it must be tag #4<br />
args: [<br />
4<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
You can query with an array as well, and like above there are two variants:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
query: "Tags contains [?]", // Results must have tag #4 and tag #5 on them but can have any other tags too<br />
args: [<br />
[4, 5]<br />
]<br />
}<br />
<br />
{<br />
query: "Tags=[?]", // Results must have exactly tags #4 and #5 and no others<br />
args: [<br />
[4, 5]<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
= Sorting =<br />
<br />
You can create a filter which sorts using "sort" like so:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
//query+args or where here,<br />
<br />
"sort":{<br />
"field": "name",<br />
"direction": "desc" // or asc<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
= Filter functions =<br />
<br />
Most often seen in the permission system. These are functions used within a query filter. Filter functions are generic and can also be custom defined by installable modules if you need another. Example code which adds a filter function can be seen on the [[API_Context|context extensions page]]. Variations of UserPermits ("CompanyPermits" etc) are quite common.<br />
<br />
* IsSelf()<br />
* HasUserPermit()<br />
* HasRolePermits()<br />
* IsIncluded()<br />
* On(...)<br />
<br />
Todo: describing the above, particularly On and IsIncluded</div>46.16.211.253https://wiki.socialstack.dev/index.php?title=Filters&diff=624Filters2024-01-29T16:49:47Z<p>46.16.211.253: /* Sorting */</p>
<hr />
<div>Filters are a query-like mechanism for filtering out results from a list endpoint. At their core, they are textual and support a set of arguments.<br />
<br />
= Filter examples =<br />
<br />
A textual filter with arguments is like so:<br />
<br />
<syntaxhighlight lang="sql"><br />
(UserId=? or UserId=?) and CreatedUtc>?<br />
</syntaxhighlight><br />
<br />
It is not case sensitive. Filters in the permission system do not support these ? arguments (as it wouldn't know where to bind the value from).<br />
<br />
Typically you'll see this textual form of filter inside a Where() call in the C# API:<br />
<br />
<syntaxhighlight lang="csharp"><br />
uint userId = 14;<br />
<br />
var listOfThingsByThisUser = await Where("UserId=?").Bind(userId).ListAll(context);<br />
</syntaxhighlight><br />
<br />
.Bind() is used to bind the actual value of an argument. Values are bound in this way such that the filter string is a constant and can benefit from being precompiled. Indeed, the whole filter system is built to be entirely non-allocating, as the Bind calls internally set your provided value onto an compiled object field, with that object originating from a pool for the given cached filter.<br />
<br />
= JS filter notation =<br />
<br />
Filters can also be constructed by the frontend, most often by [[Loop]]. In this scenario, a convenience filter notation is also available - it'll take the object notation you provide, and then convert it into the textual format with arguments. Here's some examples:<br />
<br />
<syntaxhighlight lang="js"><br />
<br />
<Loop over="page" filter={<br />
{<br />
where: {<br />
userId: 14<br />
}<br />
}<br />
}><br />
{page => { return <p>{page.url}</p>; }}<br />
</Loop><br />
<br />
</syntaxhighlight><br />
<br />
<br />
<syntaxhighlight lang="js"><br />
<br />
import webRequest from 'UI/Functions/WebRequest';<br />
<br />
webRequest("page/list", {<br />
where: {<br />
userId: 14<br />
}<br />
}).then(response => {<br />
// response.json contains the set of pages made by user #14<br />
})<br />
<br />
</syntaxhighlight><br />
<br />
The filter object itself:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
where: {<br />
userId: 14<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
[[#Operators]] can be used by passing an object:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
where: {<br />
userId: {<br />
greaterThan: 14<br />
}<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
Or statements are represented with an array:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
where: [{<br />
userId: 14<br />
},<br />
{<br />
userId: 16<br />
}]<br />
}<br />
</syntaxhighlight><br />
<br />
And statements are performed by providing multiple field values:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
where: {<br />
userId: 14,<br />
createdUtc: {<br />
greaterThan: yesterday /* yesterday is a JS Date */<br />
}<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
If you need more expressive power, you can also directly specify the query and args:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
query: "UserId=?",<br />
args: [14]<br />
}<br />
</syntaxhighlight><br />
<br />
Query/args being passed in to webRequest and Loop:<br />
<br />
<syntaxhighlight lang="js"><br />
<br />
import webRequest from 'UI/Functions/WebRequest';<br />
<br />
webRequest("page/list", {<br />
query: "UserId=?",<br />
args: [14]<br />
}).then(response => {<br />
// response.json contains the set of pages made by user #14<br />
})<br />
<br />
<br />
<Loop over='page' filter={{query: "UserId=?",<br />
args: [14]}}> ... <br />
</Loop><br />
<br />
</syntaxhighlight><br />
<br />
= Operators =<br />
<br />
Filters support a variety of operators for comparisons:<br />
<br />
* Greater than<br />
* Field>? (query notation)<br />
* {greaterThan: x} (JS notation)<br />
<br />
* Less than<br />
* Field<? (query notation)<br />
* {lessThan: x} (JS notation)<br />
<br />
* Greater than or equal<br />
* Field>=? (query notation)<br />
* {greaterThanOrEqual: x} (JS notation)<br />
* {geq: x} (JS notation)<br />
<br />
* Less than or equal<br />
* Field<=? (query notation)<br />
* {lessThanOrEqual: x} (JS notation)<br />
* {leq: x} (JS notation)<br />
<br />
* Equals<br />
* Field=? (query notation)<br />
* x (JS notation)<br />
* {equals: x} (JS notation)<br />
<br />
* Not<br />
* Field!=? (query notation)<br />
* !( .... ) (query notation)<br />
* {not: x} (JS notation)<br />
<br />
* Starts with (textual values only)<br />
* Field startsWith ? (query notation)<br />
* {startsWith: x} (JS notation)<br />
<br />
* Ends with (textual values only)<br />
* Field endsWith ? (query notation)<br />
* {endsWith: x} (JS notation)<br />
<br />
* Contains (textual values only)<br />
* Field contains ? (query notation)<br />
* {contains: x} (JS notation)<br />
<br />
= Arrays =<br />
<br />
If you provide an array of values you must tell the query system that you are doing so by surrounding your ? arg with square brackets, like this:<br />
<br />
<syntaxhighlight lang="bash"><br />
Name=[?]<br />
</syntaxhighlight><br />
<br />
This syntax exists such that the precompiled filter is ready to receive a set of values rather than just one.<br />
<br />
If you're doing this in C# you can then bind any IEnumerable like so, provided its data type matches that of the target field:<br />
<br />
<syntaxhighlight lang="csharp"><br />
<br />
var nameList = new List<string>() { "Dave", "Steve" };<br />
<br />
var resultsWithEitherName = await Where("Name=[?]").Bind(nameList).ListAll(context);<br />
<br />
</syntaxhighlight><br />
<br />
From javascript you can just pass an array inside your args like so:<br />
<br />
<syntaxhighlight lang="js"><br />
<br />
{<br />
"query": "Name=[?]",<br />
"args": [<br />
["Dave", "Steve"]<br />
]<br />
}<br />
<br />
</syntaxhighlight><br />
<br />
= Virtual Fields =<br />
<br />
Virtual Fields can be used inside filter query strings as well just by simply using their name. The value is always the uint IDs. So for example if we want to get all pages tagged with "hello", first we need to get the ID of the tag "hello" (which we'll say is tag #4) and then from there can use it as either an array or a number as-is:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
query: "Tags contains ?", // Results must have tag #4 on them, but can have any other tags too<br />
args: [<br />
4<br />
]<br />
}<br />
<br />
{<br />
query: "Tags=?", // Results must have exactly 1 tag and it must be tag #4<br />
args: [<br />
4<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
You can query with an array as well, and like above there are two variants:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
query: "Tags contains [?]", // Results must have tag #4 and tag #5 on them but can have any other tags too<br />
args: [<br />
[4, 5]<br />
]<br />
}<br />
<br />
{<br />
query: "Tags=[?]", // Results must have exactly tags #4 and #5 and no others<br />
args: [<br />
[4, 5]<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
= Sorting =<br />
<br />
You can create a filter which sorts using "sort" like so:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
"sort":{<br />
"field": "name",<br />
"direction": "desc" // or asc<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
= Filter functions =<br />
<br />
Most often seen in the permission system. These are functions used within a query filter. Filter functions are generic and can also be custom defined by installable modules if you need another. Example code which adds a filter function can be seen on the [[API_Context|context extensions page]]. Variations of UserPermits ("CompanyPermits" etc) are quite common.<br />
<br />
* IsSelf()<br />
* HasUserPermit()<br />
* HasRolePermits()<br />
* IsIncluded()<br />
* On(...)<br />
<br />
Todo: describing the above, particularly On and IsIncluded</div>46.16.211.253https://wiki.socialstack.dev/index.php?title=Filters&diff=623Filters2024-01-29T16:48:14Z<p>46.16.211.253: /* Sorting */</p>
<hr />
<div>Filters are a query-like mechanism for filtering out results from a list endpoint. At their core, they are textual and support a set of arguments.<br />
<br />
= Filter examples =<br />
<br />
A textual filter with arguments is like so:<br />
<br />
<syntaxhighlight lang="sql"><br />
(UserId=? or UserId=?) and CreatedUtc>?<br />
</syntaxhighlight><br />
<br />
It is not case sensitive. Filters in the permission system do not support these ? arguments (as it wouldn't know where to bind the value from).<br />
<br />
Typically you'll see this textual form of filter inside a Where() call in the C# API:<br />
<br />
<syntaxhighlight lang="csharp"><br />
uint userId = 14;<br />
<br />
var listOfThingsByThisUser = await Where("UserId=?").Bind(userId).ListAll(context);<br />
</syntaxhighlight><br />
<br />
.Bind() is used to bind the actual value of an argument. Values are bound in this way such that the filter string is a constant and can benefit from being precompiled. Indeed, the whole filter system is built to be entirely non-allocating, as the Bind calls internally set your provided value onto an compiled object field, with that object originating from a pool for the given cached filter.<br />
<br />
= JS filter notation =<br />
<br />
Filters can also be constructed by the frontend, most often by [[Loop]]. In this scenario, a convenience filter notation is also available - it'll take the object notation you provide, and then convert it into the textual format with arguments. Here's some examples:<br />
<br />
<syntaxhighlight lang="js"><br />
<br />
<Loop over="page" filter={<br />
{<br />
where: {<br />
userId: 14<br />
}<br />
}<br />
}><br />
{page => { return <p>{page.url}</p>; }}<br />
</Loop><br />
<br />
</syntaxhighlight><br />
<br />
<br />
<syntaxhighlight lang="js"><br />
<br />
import webRequest from 'UI/Functions/WebRequest';<br />
<br />
webRequest("page/list", {<br />
where: {<br />
userId: 14<br />
}<br />
}).then(response => {<br />
// response.json contains the set of pages made by user #14<br />
})<br />
<br />
</syntaxhighlight><br />
<br />
The filter object itself:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
where: {<br />
userId: 14<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
[[#Operators]] can be used by passing an object:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
where: {<br />
userId: {<br />
greaterThan: 14<br />
}<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
Or statements are represented with an array:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
where: [{<br />
userId: 14<br />
},<br />
{<br />
userId: 16<br />
}]<br />
}<br />
</syntaxhighlight><br />
<br />
And statements are performed by providing multiple field values:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
where: {<br />
userId: 14,<br />
createdUtc: {<br />
greaterThan: yesterday /* yesterday is a JS Date */<br />
}<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
If you need more expressive power, you can also directly specify the query and args:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
query: "UserId=?",<br />
args: [14]<br />
}<br />
</syntaxhighlight><br />
<br />
Query/args being passed in to webRequest and Loop:<br />
<br />
<syntaxhighlight lang="js"><br />
<br />
import webRequest from 'UI/Functions/WebRequest';<br />
<br />
webRequest("page/list", {<br />
query: "UserId=?",<br />
args: [14]<br />
}).then(response => {<br />
// response.json contains the set of pages made by user #14<br />
})<br />
<br />
<br />
<Loop over='page' filter={{query: "UserId=?",<br />
args: [14]}}> ... <br />
</Loop><br />
<br />
</syntaxhighlight><br />
<br />
= Operators =<br />
<br />
Filters support a variety of operators for comparisons:<br />
<br />
* Greater than<br />
* Field>? (query notation)<br />
* {greaterThan: x} (JS notation)<br />
<br />
* Less than<br />
* Field<? (query notation)<br />
* {lessThan: x} (JS notation)<br />
<br />
* Greater than or equal<br />
* Field>=? (query notation)<br />
* {greaterThanOrEqual: x} (JS notation)<br />
* {geq: x} (JS notation)<br />
<br />
* Less than or equal<br />
* Field<=? (query notation)<br />
* {lessThanOrEqual: x} (JS notation)<br />
* {leq: x} (JS notation)<br />
<br />
* Equals<br />
* Field=? (query notation)<br />
* x (JS notation)<br />
* {equals: x} (JS notation)<br />
<br />
* Not<br />
* Field!=? (query notation)<br />
* !( .... ) (query notation)<br />
* {not: x} (JS notation)<br />
<br />
* Starts with (textual values only)<br />
* Field startsWith ? (query notation)<br />
* {startsWith: x} (JS notation)<br />
<br />
* Ends with (textual values only)<br />
* Field endsWith ? (query notation)<br />
* {endsWith: x} (JS notation)<br />
<br />
* Contains (textual values only)<br />
* Field contains ? (query notation)<br />
* {contains: x} (JS notation)<br />
<br />
= Arrays =<br />
<br />
If you provide an array of values you must tell the query system that you are doing so by surrounding your ? arg with square brackets, like this:<br />
<br />
<syntaxhighlight lang="bash"><br />
Name=[?]<br />
</syntaxhighlight><br />
<br />
This syntax exists such that the precompiled filter is ready to receive a set of values rather than just one.<br />
<br />
If you're doing this in C# you can then bind any IEnumerable like so, provided its data type matches that of the target field:<br />
<br />
<syntaxhighlight lang="csharp"><br />
<br />
var nameList = new List<string>() { "Dave", "Steve" };<br />
<br />
var resultsWithEitherName = await Where("Name=[?]").Bind(nameList).ListAll(context);<br />
<br />
</syntaxhighlight><br />
<br />
From javascript you can just pass an array inside your args like so:<br />
<br />
<syntaxhighlight lang="js"><br />
<br />
{<br />
"query": "Name=[?]",<br />
"args": [<br />
["Dave", "Steve"]<br />
]<br />
}<br />
<br />
</syntaxhighlight><br />
<br />
= Virtual Fields =<br />
<br />
Virtual Fields can be used inside filter query strings as well just by simply using their name. The value is always the uint IDs. So for example if we want to get all pages tagged with "hello", first we need to get the ID of the tag "hello" (which we'll say is tag #4) and then from there can use it as either an array or a number as-is:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
query: "Tags contains ?", // Results must have tag #4 on them, but can have any other tags too<br />
args: [<br />
4<br />
]<br />
}<br />
<br />
{<br />
query: "Tags=?", // Results must have exactly 1 tag and it must be tag #4<br />
args: [<br />
4<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
You can query with an array as well, and like above there are two variants:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
query: "Tags contains [?]", // Results must have tag #4 and tag #5 on them but can have any other tags too<br />
args: [<br />
[4, 5]<br />
]<br />
}<br />
<br />
{<br />
query: "Tags=[?]", // Results must have exactly tags #4 and #5 and no others<br />
args: [<br />
[4, 5]<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
= Sorting =<br />
<br />
You can create a filter which sorts using "sort" like so:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
"sort":{<br />
"field": "name",<br />
"dir": "desc" // or asc<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
= Filter functions =<br />
<br />
Most often seen in the permission system. These are functions used within a query filter. Filter functions are generic and can also be custom defined by installable modules if you need another. Example code which adds a filter function can be seen on the [[API_Context|context extensions page]]. Variations of UserPermits ("CompanyPermits" etc) are quite common.<br />
<br />
* IsSelf()<br />
* HasUserPermit()<br />
* HasRolePermits()<br />
* IsIncluded()<br />
* On(...)<br />
<br />
Todo: describing the above, particularly On and IsIncluded</div>46.16.211.253https://wiki.socialstack.dev/index.php?title=Filters&diff=622Filters2024-01-29T16:47:42Z<p>46.16.211.253: /* Sorting */</p>
<hr />
<div>Filters are a query-like mechanism for filtering out results from a list endpoint. At their core, they are textual and support a set of arguments.<br />
<br />
= Filter examples =<br />
<br />
A textual filter with arguments is like so:<br />
<br />
<syntaxhighlight lang="sql"><br />
(UserId=? or UserId=?) and CreatedUtc>?<br />
</syntaxhighlight><br />
<br />
It is not case sensitive. Filters in the permission system do not support these ? arguments (as it wouldn't know where to bind the value from).<br />
<br />
Typically you'll see this textual form of filter inside a Where() call in the C# API:<br />
<br />
<syntaxhighlight lang="csharp"><br />
uint userId = 14;<br />
<br />
var listOfThingsByThisUser = await Where("UserId=?").Bind(userId).ListAll(context);<br />
</syntaxhighlight><br />
<br />
.Bind() is used to bind the actual value of an argument. Values are bound in this way such that the filter string is a constant and can benefit from being precompiled. Indeed, the whole filter system is built to be entirely non-allocating, as the Bind calls internally set your provided value onto an compiled object field, with that object originating from a pool for the given cached filter.<br />
<br />
= JS filter notation =<br />
<br />
Filters can also be constructed by the frontend, most often by [[Loop]]. In this scenario, a convenience filter notation is also available - it'll take the object notation you provide, and then convert it into the textual format with arguments. Here's some examples:<br />
<br />
<syntaxhighlight lang="js"><br />
<br />
<Loop over="page" filter={<br />
{<br />
where: {<br />
userId: 14<br />
}<br />
}<br />
}><br />
{page => { return <p>{page.url}</p>; }}<br />
</Loop><br />
<br />
</syntaxhighlight><br />
<br />
<br />
<syntaxhighlight lang="js"><br />
<br />
import webRequest from 'UI/Functions/WebRequest';<br />
<br />
webRequest("page/list", {<br />
where: {<br />
userId: 14<br />
}<br />
}).then(response => {<br />
// response.json contains the set of pages made by user #14<br />
})<br />
<br />
</syntaxhighlight><br />
<br />
The filter object itself:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
where: {<br />
userId: 14<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
[[#Operators]] can be used by passing an object:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
where: {<br />
userId: {<br />
greaterThan: 14<br />
}<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
Or statements are represented with an array:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
where: [{<br />
userId: 14<br />
},<br />
{<br />
userId: 16<br />
}]<br />
}<br />
</syntaxhighlight><br />
<br />
And statements are performed by providing multiple field values:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
where: {<br />
userId: 14,<br />
createdUtc: {<br />
greaterThan: yesterday /* yesterday is a JS Date */<br />
}<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
If you need more expressive power, you can also directly specify the query and args:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
query: "UserId=?",<br />
args: [14]<br />
}<br />
</syntaxhighlight><br />
<br />
Query/args being passed in to webRequest and Loop:<br />
<br />
<syntaxhighlight lang="js"><br />
<br />
import webRequest from 'UI/Functions/WebRequest';<br />
<br />
webRequest("page/list", {<br />
query: "UserId=?",<br />
args: [14]<br />
}).then(response => {<br />
// response.json contains the set of pages made by user #14<br />
})<br />
<br />
<br />
<Loop over='page' filter={{query: "UserId=?",<br />
args: [14]}}> ... <br />
</Loop><br />
<br />
</syntaxhighlight><br />
<br />
= Operators =<br />
<br />
Filters support a variety of operators for comparisons:<br />
<br />
* Greater than<br />
* Field>? (query notation)<br />
* {greaterThan: x} (JS notation)<br />
<br />
* Less than<br />
* Field<? (query notation)<br />
* {lessThan: x} (JS notation)<br />
<br />
* Greater than or equal<br />
* Field>=? (query notation)<br />
* {greaterThanOrEqual: x} (JS notation)<br />
* {geq: x} (JS notation)<br />
<br />
* Less than or equal<br />
* Field<=? (query notation)<br />
* {lessThanOrEqual: x} (JS notation)<br />
* {leq: x} (JS notation)<br />
<br />
* Equals<br />
* Field=? (query notation)<br />
* x (JS notation)<br />
* {equals: x} (JS notation)<br />
<br />
* Not<br />
* Field!=? (query notation)<br />
* !( .... ) (query notation)<br />
* {not: x} (JS notation)<br />
<br />
* Starts with (textual values only)<br />
* Field startsWith ? (query notation)<br />
* {startsWith: x} (JS notation)<br />
<br />
* Ends with (textual values only)<br />
* Field endsWith ? (query notation)<br />
* {endsWith: x} (JS notation)<br />
<br />
* Contains (textual values only)<br />
* Field contains ? (query notation)<br />
* {contains: x} (JS notation)<br />
<br />
= Arrays =<br />
<br />
If you provide an array of values you must tell the query system that you are doing so by surrounding your ? arg with square brackets, like this:<br />
<br />
<syntaxhighlight lang="bash"><br />
Name=[?]<br />
</syntaxhighlight><br />
<br />
This syntax exists such that the precompiled filter is ready to receive a set of values rather than just one.<br />
<br />
If you're doing this in C# you can then bind any IEnumerable like so, provided its data type matches that of the target field:<br />
<br />
<syntaxhighlight lang="csharp"><br />
<br />
var nameList = new List<string>() { "Dave", "Steve" };<br />
<br />
var resultsWithEitherName = await Where("Name=[?]").Bind(nameList).ListAll(context);<br />
<br />
</syntaxhighlight><br />
<br />
From javascript you can just pass an array inside your args like so:<br />
<br />
<syntaxhighlight lang="js"><br />
<br />
{<br />
"query": "Name=[?]",<br />
"args": [<br />
["Dave", "Steve"]<br />
]<br />
}<br />
<br />
</syntaxhighlight><br />
<br />
= Virtual Fields =<br />
<br />
Virtual Fields can be used inside filter query strings as well just by simply using their name. The value is always the uint IDs. So for example if we want to get all pages tagged with "hello", first we need to get the ID of the tag "hello" (which we'll say is tag #4) and then from there can use it as either an array or a number as-is:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
query: "Tags contains ?", // Results must have tag #4 on them, but can have any other tags too<br />
args: [<br />
4<br />
]<br />
}<br />
<br />
{<br />
query: "Tags=?", // Results must have exactly 1 tag and it must be tag #4<br />
args: [<br />
4<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
You can query with an array as well, and like above there are two variants:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
query: "Tags contains [?]", // Results must have tag #4 and tag #5 on them but can have any other tags too<br />
args: [<br />
[4, 5]<br />
]<br />
}<br />
<br />
{<br />
query: "Tags=[?]", // Results must have exactly tags #4 and #5 and no others<br />
args: [<br />
[4, 5]<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
= Sorting =<br />
<br />
You can create a filter which sorts using "sort" like so:<br />
<br />
<syntaxhiglight lang="js"><br />
{<br />
"sort":{<br />
"field": "name",<br />
"dir": "desc" // or asc<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
= Filter functions =<br />
<br />
Most often seen in the permission system. These are functions used within a query filter. Filter functions are generic and can also be custom defined by installable modules if you need another. Example code which adds a filter function can be seen on the [[API_Context|context extensions page]]. Variations of UserPermits ("CompanyPermits" etc) are quite common.<br />
<br />
* IsSelf()<br />
* HasUserPermit()<br />
* HasRolePermits()<br />
* IsIncluded()<br />
* On(...)<br />
<br />
Todo: describing the above, particularly On and IsIncluded</div>46.16.211.253https://wiki.socialstack.dev/index.php?title=Filters&diff=621Filters2024-01-29T16:47:07Z<p>46.16.211.253: </p>
<hr />
<div>Filters are a query-like mechanism for filtering out results from a list endpoint. At their core, they are textual and support a set of arguments.<br />
<br />
= Filter examples =<br />
<br />
A textual filter with arguments is like so:<br />
<br />
<syntaxhighlight lang="sql"><br />
(UserId=? or UserId=?) and CreatedUtc>?<br />
</syntaxhighlight><br />
<br />
It is not case sensitive. Filters in the permission system do not support these ? arguments (as it wouldn't know where to bind the value from).<br />
<br />
Typically you'll see this textual form of filter inside a Where() call in the C# API:<br />
<br />
<syntaxhighlight lang="csharp"><br />
uint userId = 14;<br />
<br />
var listOfThingsByThisUser = await Where("UserId=?").Bind(userId).ListAll(context);<br />
</syntaxhighlight><br />
<br />
.Bind() is used to bind the actual value of an argument. Values are bound in this way such that the filter string is a constant and can benefit from being precompiled. Indeed, the whole filter system is built to be entirely non-allocating, as the Bind calls internally set your provided value onto an compiled object field, with that object originating from a pool for the given cached filter.<br />
<br />
= JS filter notation =<br />
<br />
Filters can also be constructed by the frontend, most often by [[Loop]]. In this scenario, a convenience filter notation is also available - it'll take the object notation you provide, and then convert it into the textual format with arguments. Here's some examples:<br />
<br />
<syntaxhighlight lang="js"><br />
<br />
<Loop over="page" filter={<br />
{<br />
where: {<br />
userId: 14<br />
}<br />
}<br />
}><br />
{page => { return <p>{page.url}</p>; }}<br />
</Loop><br />
<br />
</syntaxhighlight><br />
<br />
<br />
<syntaxhighlight lang="js"><br />
<br />
import webRequest from 'UI/Functions/WebRequest';<br />
<br />
webRequest("page/list", {<br />
where: {<br />
userId: 14<br />
}<br />
}).then(response => {<br />
// response.json contains the set of pages made by user #14<br />
})<br />
<br />
</syntaxhighlight><br />
<br />
The filter object itself:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
where: {<br />
userId: 14<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
[[#Operators]] can be used by passing an object:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
where: {<br />
userId: {<br />
greaterThan: 14<br />
}<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
Or statements are represented with an array:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
where: [{<br />
userId: 14<br />
},<br />
{<br />
userId: 16<br />
}]<br />
}<br />
</syntaxhighlight><br />
<br />
And statements are performed by providing multiple field values:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
where: {<br />
userId: 14,<br />
createdUtc: {<br />
greaterThan: yesterday /* yesterday is a JS Date */<br />
}<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
If you need more expressive power, you can also directly specify the query and args:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
query: "UserId=?",<br />
args: [14]<br />
}<br />
</syntaxhighlight><br />
<br />
Query/args being passed in to webRequest and Loop:<br />
<br />
<syntaxhighlight lang="js"><br />
<br />
import webRequest from 'UI/Functions/WebRequest';<br />
<br />
webRequest("page/list", {<br />
query: "UserId=?",<br />
args: [14]<br />
}).then(response => {<br />
// response.json contains the set of pages made by user #14<br />
})<br />
<br />
<br />
<Loop over='page' filter={{query: "UserId=?",<br />
args: [14]}}> ... <br />
</Loop><br />
<br />
</syntaxhighlight><br />
<br />
= Operators =<br />
<br />
Filters support a variety of operators for comparisons:<br />
<br />
* Greater than<br />
* Field>? (query notation)<br />
* {greaterThan: x} (JS notation)<br />
<br />
* Less than<br />
* Field<? (query notation)<br />
* {lessThan: x} (JS notation)<br />
<br />
* Greater than or equal<br />
* Field>=? (query notation)<br />
* {greaterThanOrEqual: x} (JS notation)<br />
* {geq: x} (JS notation)<br />
<br />
* Less than or equal<br />
* Field<=? (query notation)<br />
* {lessThanOrEqual: x} (JS notation)<br />
* {leq: x} (JS notation)<br />
<br />
* Equals<br />
* Field=? (query notation)<br />
* x (JS notation)<br />
* {equals: x} (JS notation)<br />
<br />
* Not<br />
* Field!=? (query notation)<br />
* !( .... ) (query notation)<br />
* {not: x} (JS notation)<br />
<br />
* Starts with (textual values only)<br />
* Field startsWith ? (query notation)<br />
* {startsWith: x} (JS notation)<br />
<br />
* Ends with (textual values only)<br />
* Field endsWith ? (query notation)<br />
* {endsWith: x} (JS notation)<br />
<br />
* Contains (textual values only)<br />
* Field contains ? (query notation)<br />
* {contains: x} (JS notation)<br />
<br />
= Arrays =<br />
<br />
If you provide an array of values you must tell the query system that you are doing so by surrounding your ? arg with square brackets, like this:<br />
<br />
<syntaxhighlight lang="bash"><br />
Name=[?]<br />
</syntaxhighlight><br />
<br />
This syntax exists such that the precompiled filter is ready to receive a set of values rather than just one.<br />
<br />
If you're doing this in C# you can then bind any IEnumerable like so, provided its data type matches that of the target field:<br />
<br />
<syntaxhighlight lang="csharp"><br />
<br />
var nameList = new List<string>() { "Dave", "Steve" };<br />
<br />
var resultsWithEitherName = await Where("Name=[?]").Bind(nameList).ListAll(context);<br />
<br />
</syntaxhighlight><br />
<br />
From javascript you can just pass an array inside your args like so:<br />
<br />
<syntaxhighlight lang="js"><br />
<br />
{<br />
"query": "Name=[?]",<br />
"args": [<br />
["Dave", "Steve"]<br />
]<br />
}<br />
<br />
</syntaxhighlight><br />
<br />
= Virtual Fields =<br />
<br />
Virtual Fields can be used inside filter query strings as well just by simply using their name. The value is always the uint IDs. So for example if we want to get all pages tagged with "hello", first we need to get the ID of the tag "hello" (which we'll say is tag #4) and then from there can use it as either an array or a number as-is:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
query: "Tags contains ?", // Results must have tag #4 on them, but can have any other tags too<br />
args: [<br />
4<br />
]<br />
}<br />
<br />
{<br />
query: "Tags=?", // Results must have exactly 1 tag and it must be tag #4<br />
args: [<br />
4<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
You can query with an array as well, and like above there are two variants:<br />
<br />
<syntaxhighlight lang="js"><br />
{<br />
query: "Tags contains [?]", // Results must have tag #4 and tag #5 on them but can have any other tags too<br />
args: [<br />
[4, 5]<br />
]<br />
}<br />
<br />
{<br />
query: "Tags=[?]", // Results must have exactly tags #4 and #5 and no others<br />
args: [<br />
[4, 5]<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
= Sorting =<br />
<br />
You can create a filter which sorts using "sort" like so:<br />
<br />
{<br />
"sort":{<br />
"field": "name",<br />
"dir": "desc" // or asc<br />
}<br />
}<br />
<br />
= Filter functions =<br />
<br />
Most often seen in the permission system. These are functions used within a query filter. Filter functions are generic and can also be custom defined by installable modules if you need another. Example code which adds a filter function can be seen on the [[API_Context|context extensions page]]. Variations of UserPermits ("CompanyPermits" etc) are quite common.<br />
<br />
* IsSelf()<br />
* HasUserPermit()<br />
* HasRolePermits()<br />
* IsIncluded()<br />
* On(...)<br />
<br />
Todo: describing the above, particularly On and IsIncluded</div>46.16.211.253https://wiki.socialstack.dev/index.php?title=Search_Elastic&diff=521Search Elastic2023-03-28T16:25:09Z<p>46.16.211.253: /* Search taxonomy and filters/facets */</p>
<hr />
<div>The elastic search module works alongside the [[Search Crawler]] to extract pages from the site into an elastic search instance to enable site wide search<br />
<br />
The module registers itself to listen for the search crawler events and creates locale based indexes in the elastic repo for any pages it receives<br />
<br />
When indexing the pages, if there is a primary data type then this will also be indexed against the page in '''primaryObject''', this can then be used in query values as explained below<br />
<br />
The indexing process is controlled by execution of the search crawler via the site automations<br />
<br />
The module contains a Readme.txt file which gives help for the initial setup of elastic but the creation of the indexes/content are all automated.<br />
<br />
== Installation ==<br />
<br />
The basic setup steps are <br />
<br />
#Install the following socialstack modules<br />
#*Api/SearchCrawler<br />
#*Api/SearchElastic<br />
#*UI/SiteSearch<br />
#Mark any pages not to be indexed<br />
#Install Elastic Search (see '''Readme.txt''' in the repo for help and guidance)<br />
#Configure the sizing/scale in the '''elasticsearch.yml''' file (mainly vm memory usage)<br />
#Start Elastic Search for the first time and get the master password and certificate fingerprint<br />
#Add the url, credentials and fingerprint values to the module configuration via the ss admin panel<br />
#Run the automation to index the site, the indexing progress is shown via the console<br />
<br />
The module also contains a postman collection which can be used to quick debug/verify the indexed content<br />
<br />
Once indexed there is a UI/SiteSearch module which can be used as the basis of the site search<br />
<br />
== Endpoints ==<br />
<br />
=== GET /v1/sitesearch/reset ===<br />
<br />
This removes any indexes from elastic to allow a clean start<br />
<br />
=== POST /v1/sitesearch/query ===<br />
<br />
This is the core search endpoint which currently accepts the following values <br />
<br />
;queryString<br />
:The query value entered by the user and/or the '''UI/SiteSearch''' and '''UI/ContentSearch''' components, elastic search uses the Lucene query language so you can build complex queries <br />
:https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html<br />
:e.g.<br />
:<code>Africa AND primaryObject.name:Botswana</code><br />
:<code>primaryObject.price:(>=1000 AND <5000)</code><br />
:<code>((quick AND fox) OR (brown AND fox) OR fox) AND NOT dog</code><br />
<br />
;tags<br />
: This expects a list of comma separated tags, if any are supplied the query will only return results which contain all the passed tag values<br />
<br />
;contentTypes<br />
: This expects a list of comma separated content types, if any are supplied the query will only return results which contain all the passed content types, these are normally the primary data object for the page<br />
<br />
;pageSize<br />
: This expects the page size and will default to 10 if not populated<br />
<br />
;pageIndex<br />
: This expects the starting page number and will default to 1<br />
<br />
;aggregationFields<br />
: This expects a list of comma separated field names, if any are supplied then aggregations/facets are returned for the fields, a good example of this can be be found in '''UI/ContentSearch''' component<br />
<br />
== Search taxonomy and filters/facets ==<br />
You can filter or define facets(aggregations in ElasticSerach terminology) on any field exposed to Elastic from the social stack application, but they work best on metadata type fields such as tags, price etc <br />
<br />
A basic example would be the '''tags''' field.<br />
<br />
But a better solution is to setup contextual tags using the '''Api/Categories''' component and tags.<br />
<br />
This allows you to give some context to a tag, so for example you could create an '''Animals''' category, then when adding a new tag for '''Cow''' or '''Horse''' you would set their category to be '''Animals'''<br />
<br />
Any tags linked to a category can be referenced as '''taxonomy.xxxxx''' so in this example '''taxonomy.animals'''<br />
<br />
These can then be referenced to show a contextual filter in the UI, the example below will pass back an aggregation of any '''animals''' tags in the result set, '''UI/ContentSearch''' then uses these render an auto generated filter.<br />
e.g.<br />
<br />
<syntaxhighlight lang="json"><br />
{<br />
"c": [<br />
{<br />
"t": "UI/ContentSearch",<br />
"d": {<br />
"aggregationFields": "taxonomy.animals",<br />
"contentTypes": "ItineraryPageDataType"<br />
} <br />
} <br />
]<br />
}<br />
<br />
</syntaxhighlight><br />
<br />
When tags are assigned to category and indexed, you will expose the core tag values and also some auto generated taxonomy fields.<br />
<br />
An example of the indexed data in Elastic looks something like the example below where '''Africa''' and '''Botswana''' are plain tags but '''Horse''' has been linked to the '''Animals''' category<br />
<br />
The '''Horse''' value is still exposed in the '''tags''' element as that is used for free text search ranking. <br />
<br />
<syntaxhighlight lang="json"><br />
{<br />
"tags": [<br />
"Africa",<br />
"Botswana",<br />
"Horse"<br />
],<br />
"taxonomy": {<br />
"animals": [<br />
"Horse"<br />
]<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
== UI Components ==<br />
;UI/ContentSearch<br />
<br />
This provides a good example with filtering and paging<br />
<br />
The component will also allow you to override the default values/titles for any aggregation using the aggregationOverrides property, this can be useful to add grouping to values such as regions/countries etc<br />
<br />
An example is shown below<br />
<br />
<syntaxhighlight lang="json"><br />
{<br />
"c": [<br />
{<br />
"t": "UI/ContentSearch",<br />
"d": {<br />
"aggregationFields": "taxonomy.price,taxonomy.destination,taxonomy.wildlife",<br />
"contentTypes": "ItineraryPageDataType",<br />
"aggregationOverrides": [<br />
{<br />
"name": "taxonomy.price",<br />
"label": "Price",<br />
"buckets": [<br />
{<br />
"label": "&pound;3500",<br />
"key": "3500"<br />
},<br />
{<br />
"label": "&pound;5000",<br />
"key": "5000"<br />
},<br />
{<br />
"label": "&pound;7500",<br />
"key": "7500"<br />
}<br />
]<br />
},<br />
{<br />
"name": "taxonomy.destination",<br />
"label": "Destination",<br />
"columns": 3,<br />
"groups": [<br />
{<br />
"name": "Africa and the Indian Ocean",<br />
"buckets": [<br />
{<br />
"label": "Botswana",<br />
"key": "Botswana"<br />
},<br />
{<br />
"label": "Central African Republic",<br />
"key": "Central African Republic"<br />
},<br />
{<br />
"label": "Chad",<br />
"key": "Chad"<br />
},<br />
{<br />
"label": "Congo",<br />
"key": "Congo"<br />
},<br />
{<br />
"label": "Djibouti",<br />
"key": "Djibouti"<br />
},<br />
{<br />
"label": "Gabon",<br />
"key": "Gabon"<br />
},<br />
{<br />
"label": "Indian Ocean",<br />
"key": "Indian Ocean"<br />
},<br />
{<br />
"label": "Kenya",<br />
"key": "Kenya"<br />
},<br />
{<br />
"label": "Madagascar",<br />
"key": "Madagascar"<br />
},<br />
{<br />
"label": "Mozambique",<br />
"key": "Mozambique"<br />
},<br />
{<br />
"label": "Namibia",<br />
"key": "Namibia"<br />
},<br />
{<br />
"label": "Rwanda",<br />
"key": "Rwanda"<br />
},<br />
{<br />
"label": "South Africa",<br />
"key": "South Africa"<br />
},<br />
{<br />
"label": "Tanzania",<br />
"key": "Tanzania"<br />
},<br />
{<br />
"label": "Uganda",<br />
"key": "Uganda"<br />
},<br />
{<br />
"label": "Zambia",<br />
"key": "Zambia"<br />
},<br />
{<br />
"label": "Zimbabwe",<br />
"key": "Zimbabwe"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Asia",<br />
"buckets": [<br />
{<br />
"label": "Borneo",<br />
"key": "Borneo"<br />
},<br />
{<br />
"label": "India",<br />
"key": "India"<br />
},<br />
{<br />
"label": "Russia",<br />
"key": "Russia"<br />
},<br />
{<br />
"label": "Sri Lanka",<br />
"key": "Sri Lanka"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Latin America",<br />
"buckets": [<br />
{<br />
"label": "Argentina",<br />
"key": "Argentina"<br />
},<br />
{<br />
"label": "Belize",<br />
"key": "Belize"<br />
},<br />
{<br />
"label": "Brazil",<br />
"key": "Brazil"<br />
},<br />
{<br />
"label": "Chile",<br />
"key": "Chile"<br />
},<br />
{<br />
"label": "Colombia",<br />
"key": "Colombia"<br />
},<br />
{<br />
"label": "Costa Rica",<br />
"key": "Costa Rica"<br />
},<br />
{<br />
"label": "Ecuador",<br />
"key": "Ecuador"<br />
},<br />
{<br />
"label": "Galapagos",<br />
"key": "Galapagos"<br />
},<br />
{<br />
"label": "Peru",<br />
"key": "Peru"<br />
}<br />
]<br />
},<br />
{<br />
"name": "North America",<br />
"buckets": [<br />
{<br />
"label": "Alaska",<br />
"key": "Alaska"<br />
},<br />
{<br />
"label": "Canada",<br />
"key": "Canada"<br />
},<br />
{<br />
"label": "Dominica",<br />
"key": "Dominica"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Polar Regions",<br />
"buckets": [<br />
{<br />
"label": "Antarctica",<br />
"key": "Antarctica"<br />
},<br />
{<br />
"label": "Arctic Canada",<br />
"key": "Arctic Canada"<br />
},<br />
{<br />
"label": "Greenland",<br />
"key": "Greenland"<br />
},<br />
{<br />
"label": "Norway",<br />
"key": "Norway"<br />
},<br />
{<br />
"label": "Svalbard",<br />
"key": "Svalbard"<br />
},<br />
{<br />
"label": "Arctic Russia",<br />
"key": "Arctic Russia"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Australasia",<br />
"buckets": [<br />
{<br />
"label": "Australia",<br />
"key": "Australia"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Europe",<br />
"buckets": [<br />
{<br />
"label": "Scotland",<br />
"groupName": "Europe",<br />
"key": "Scotland"<br />
}<br />
]<br />
}<br />
]<br />
},<br />
{<br />
"name": "taxonomy.wildlife",<br />
"label": "Wildlife",<br />
"columns": 4,<br />
"groups": [<br />
{<br />
"name": "Bears",<br />
"buckets": [<br />
{<br />
"label": "Grizzly Bears",<br />
"key": "Grizzly Bears"<br />
},<br />
{<br />
"label": "Polar Bear",<br />
"key": "Polar Bear"<br />
},<br />
{<br />
"label": "Spirit Bear",<br />
"key": "Spirit Bear"<br />
},<br />
{<br />
"label": "Sun Bear",<br />
"key": "Sun Bear"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Big Cats",<br />
"buckets": [<br />
{<br />
"label": "African Leopard",<br />
"key": "African Leopard"<br />
},<br />
{<br />
"label": "African Lion",<br />
"key": "African Lion"<br />
},<br />
{<br />
"label": "Asiatic Leopard",<br />
"key": "Asiatic Leopard"<br />
},<br />
{<br />
"label": "Bengal Tiger",<br />
"key": "Bengal Tiger"<br />
},<br />
{<br />
"label": "Cheetah",<br />
"key": "Cheetah"<br />
},<br />
{<br />
"label": "Jaguar",<br />
"key": "Jaguar"<br />
},<br />
{<br />
"label": "Puma",<br />
"key": "Puma"<br />
},<br />
{<br />
"label": "Siberian Tiger",<br />
"key": "Siberian Tiger"<br />
},<br />
{<br />
"label": "Snow Leopard",<br />
"key": "Snow Leopard"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Big Five",<br />
"buckets": [<br />
{<br />
"label": "African Elephant",<br />
"key": "African Elephant"<br />
},<br />
{<br />
"label": "Black Rhinoceros",<br />
"key": "Black Rhinoceros"<br />
},<br />
{<br />
"label": "Cape Buffalo",<br />
"key": "Cape Buffalo"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Primates",<br />
"buckets": [<br />
{<br />
"label": "Chimpanzee",<br />
"key": "Chimpanzee"<br />
},<br />
{<br />
"label": "Lemurs",<br />
"key": "Lemurs"<br />
},<br />
{<br />
"label": "Mountain Gorilla",<br />
"key": "Mountain Gorilla"<br />
},<br />
{<br />
"label": "Orangutan",<br />
"key": "Orangutan"<br />
},<br />
{<br />
"label": "Western Lowland Gorilla",<br />
"key": "Western Lowland Gorilla"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Whales",<br />
"buckets": [<br />
{<br />
"label": "Beluga Whale",<br />
"key": "Beluga Whale"<br />
},<br />
{<br />
"label": "Blue Whale",<br />
"key": "Blue Whale"<br />
},<br />
{<br />
"label": "Killer Whale",<br />
"key": "Killer Whale"<br />
},<br />
{<br />
"label": "Narwhal",<br />
"key": "Narwhal"<br />
},<br />
{<br />
"label": "Sperm Whales",<br />
"key": "Sperm Whales"<br />
},<br />
{<br />
"label": "Whale Shark",<br />
"key": "Whale Shark"<br />
}<br />
]<br />
}<br />
]<br />
}<br />
]<br />
},<br />
"i": 4<br />
},<br />
{<br />
"t": "p",<br />
"c": "",<br />
"d": {},<br />
"i": 2<br />
}<br />
],<br />
"i": 3<br />
}<br />
<br />
</syntaxhighlight></div>46.16.211.253https://wiki.socialstack.dev/index.php?title=Search_Elastic&diff=520Search Elastic2023-03-28T16:22:46Z<p>46.16.211.253: /* Search taxonomy and filters/facets */</p>
<hr />
<div>The elastic search module works alongside the [[Search Crawler]] to extract pages from the site into an elastic search instance to enable site wide search<br />
<br />
The module registers itself to listen for the search crawler events and creates locale based indexes in the elastic repo for any pages it receives<br />
<br />
When indexing the pages, if there is a primary data type then this will also be indexed against the page in '''primaryObject''', this can then be used in query values as explained below<br />
<br />
The indexing process is controlled by execution of the search crawler via the site automations<br />
<br />
The module contains a Readme.txt file which gives help for the initial setup of elastic but the creation of the indexes/content are all automated.<br />
<br />
== Installation ==<br />
<br />
The basic setup steps are <br />
<br />
#Install the following socialstack modules<br />
#*Api/SearchCrawler<br />
#*Api/SearchElastic<br />
#*UI/SiteSearch<br />
#Mark any pages not to be indexed<br />
#Install Elastic Search (see '''Readme.txt''' in the repo for help and guidance)<br />
#Configure the sizing/scale in the '''elasticsearch.yml''' file (mainly vm memory usage)<br />
#Start Elastic Search for the first time and get the master password and certificate fingerprint<br />
#Add the url, credentials and fingerprint values to the module configuration via the ss admin panel<br />
#Run the automation to index the site, the indexing progress is shown via the console<br />
<br />
The module also contains a postman collection which can be used to quick debug/verify the indexed content<br />
<br />
Once indexed there is a UI/SiteSearch module which can be used as the basis of the site search<br />
<br />
== Endpoints ==<br />
<br />
=== GET /v1/sitesearch/reset ===<br />
<br />
This removes any indexes from elastic to allow a clean start<br />
<br />
=== POST /v1/sitesearch/query ===<br />
<br />
This is the core search endpoint which currently accepts the following values <br />
<br />
;queryString<br />
:The query value entered by the user and/or the '''UI/SiteSearch''' and '''UI/ContentSearch''' components, elastic search uses the Lucene query language so you can build complex queries <br />
:https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html<br />
:e.g.<br />
:<code>Africa AND primaryObject.name:Botswana</code><br />
:<code>primaryObject.price:(>=1000 AND <5000)</code><br />
:<code>((quick AND fox) OR (brown AND fox) OR fox) AND NOT dog</code><br />
<br />
;tags<br />
: This expects a list of comma separated tags, if any are supplied the query will only return results which contain all the passed tag values<br />
<br />
;contentTypes<br />
: This expects a list of comma separated content types, if any are supplied the query will only return results which contain all the passed content types, these are normally the primary data object for the page<br />
<br />
;pageSize<br />
: This expects the page size and will default to 10 if not populated<br />
<br />
;pageIndex<br />
: This expects the starting page number and will default to 1<br />
<br />
;aggregationFields<br />
: This expects a list of comma separated field names, if any are supplied then aggregations/facets are returned for the fields, a good example of this can be be found in '''UI/ContentSearch''' component<br />
<br />
== Search taxonomy and filters/facets ==<br />
You can filter or define facets(aggregations in ElasticSerach terminology) on any field exposed to Elastic from the social stack application, but they work best on metadata type fields such as tags, price etc <br />
<br />
A basic example would be the '''tags''' field.<br />
<br />
But a better solution is to setup contextual tags using the '''Api/Categories''' component and tags.<br />
<br />
This allows you to give some context to a tag, so for example you could create an '''Animals''' category, then when adding a new tag for '''Cow''' or '''Horse''' you would set their category to be '''Animals'''<br />
<br />
Any tags linked to a category can be referenced as '''taxonomy.xxxxx''' so in this example '''taxonomy.animals'''<br />
<br />
These can then be referenced to show a contextual filter in the UI, the example below will pass back an aggregation of any '''animals''' tags in the result set, '''UI/ContentSearch''' then uses these render an auto generated filter.<br />
e.g.<br />
<br />
<syntaxhighlight lang="json"><br />
{<br />
"c": [<br />
{<br />
"t": "UI/ContentSearch",<br />
"d": {<br />
"aggregationFields": "taxonomy.animals",<br />
"contentTypes": "ItineraryPageDataType"<br />
} <br />
} <br />
]<br />
}<br />
<br />
</syntaxhighlight><br />
<br />
When tags are assigned to category and indexed, you will expose the core tag values and also some auto generated taxonomy fields.<br />
<br />
An example of the indexed data in Elastic looks something like the example below where '''Africa''' and '''Botswana''' are plain tags but '''Horse''' has been linked to the '''Animals''' category<br />
<br />
<syntaxhighlight lang="json"><br />
{<br />
"tags": [<br />
"Africa",<br />
"Botswana",<br />
"Horse"<br />
],<br />
"taxonomy": {<br />
"animals": [<br />
"Horse"<br />
]<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
== UI Components ==<br />
;UI/ContentSearch<br />
<br />
This provides a good example with filtering and paging<br />
<br />
The component will also allow you to override the default values/titles for any aggregation using the aggregationOverrides property, this can be useful to add grouping to values such as regions/countries etc<br />
<br />
An example is shown below<br />
<br />
<syntaxhighlight lang="json"><br />
{<br />
"c": [<br />
{<br />
"t": "UI/ContentSearch",<br />
"d": {<br />
"aggregationFields": "taxonomy.price,taxonomy.destination,taxonomy.wildlife",<br />
"contentTypes": "ItineraryPageDataType",<br />
"aggregationOverrides": [<br />
{<br />
"name": "taxonomy.price",<br />
"label": "Price",<br />
"buckets": [<br />
{<br />
"label": "&pound;3500",<br />
"key": "3500"<br />
},<br />
{<br />
"label": "&pound;5000",<br />
"key": "5000"<br />
},<br />
{<br />
"label": "&pound;7500",<br />
"key": "7500"<br />
}<br />
]<br />
},<br />
{<br />
"name": "taxonomy.destination",<br />
"label": "Destination",<br />
"columns": 3,<br />
"groups": [<br />
{<br />
"name": "Africa and the Indian Ocean",<br />
"buckets": [<br />
{<br />
"label": "Botswana",<br />
"key": "Botswana"<br />
},<br />
{<br />
"label": "Central African Republic",<br />
"key": "Central African Republic"<br />
},<br />
{<br />
"label": "Chad",<br />
"key": "Chad"<br />
},<br />
{<br />
"label": "Congo",<br />
"key": "Congo"<br />
},<br />
{<br />
"label": "Djibouti",<br />
"key": "Djibouti"<br />
},<br />
{<br />
"label": "Gabon",<br />
"key": "Gabon"<br />
},<br />
{<br />
"label": "Indian Ocean",<br />
"key": "Indian Ocean"<br />
},<br />
{<br />
"label": "Kenya",<br />
"key": "Kenya"<br />
},<br />
{<br />
"label": "Madagascar",<br />
"key": "Madagascar"<br />
},<br />
{<br />
"label": "Mozambique",<br />
"key": "Mozambique"<br />
},<br />
{<br />
"label": "Namibia",<br />
"key": "Namibia"<br />
},<br />
{<br />
"label": "Rwanda",<br />
"key": "Rwanda"<br />
},<br />
{<br />
"label": "South Africa",<br />
"key": "South Africa"<br />
},<br />
{<br />
"label": "Tanzania",<br />
"key": "Tanzania"<br />
},<br />
{<br />
"label": "Uganda",<br />
"key": "Uganda"<br />
},<br />
{<br />
"label": "Zambia",<br />
"key": "Zambia"<br />
},<br />
{<br />
"label": "Zimbabwe",<br />
"key": "Zimbabwe"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Asia",<br />
"buckets": [<br />
{<br />
"label": "Borneo",<br />
"key": "Borneo"<br />
},<br />
{<br />
"label": "India",<br />
"key": "India"<br />
},<br />
{<br />
"label": "Russia",<br />
"key": "Russia"<br />
},<br />
{<br />
"label": "Sri Lanka",<br />
"key": "Sri Lanka"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Latin America",<br />
"buckets": [<br />
{<br />
"label": "Argentina",<br />
"key": "Argentina"<br />
},<br />
{<br />
"label": "Belize",<br />
"key": "Belize"<br />
},<br />
{<br />
"label": "Brazil",<br />
"key": "Brazil"<br />
},<br />
{<br />
"label": "Chile",<br />
"key": "Chile"<br />
},<br />
{<br />
"label": "Colombia",<br />
"key": "Colombia"<br />
},<br />
{<br />
"label": "Costa Rica",<br />
"key": "Costa Rica"<br />
},<br />
{<br />
"label": "Ecuador",<br />
"key": "Ecuador"<br />
},<br />
{<br />
"label": "Galapagos",<br />
"key": "Galapagos"<br />
},<br />
{<br />
"label": "Peru",<br />
"key": "Peru"<br />
}<br />
]<br />
},<br />
{<br />
"name": "North America",<br />
"buckets": [<br />
{<br />
"label": "Alaska",<br />
"key": "Alaska"<br />
},<br />
{<br />
"label": "Canada",<br />
"key": "Canada"<br />
},<br />
{<br />
"label": "Dominica",<br />
"key": "Dominica"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Polar Regions",<br />
"buckets": [<br />
{<br />
"label": "Antarctica",<br />
"key": "Antarctica"<br />
},<br />
{<br />
"label": "Arctic Canada",<br />
"key": "Arctic Canada"<br />
},<br />
{<br />
"label": "Greenland",<br />
"key": "Greenland"<br />
},<br />
{<br />
"label": "Norway",<br />
"key": "Norway"<br />
},<br />
{<br />
"label": "Svalbard",<br />
"key": "Svalbard"<br />
},<br />
{<br />
"label": "Arctic Russia",<br />
"key": "Arctic Russia"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Australasia",<br />
"buckets": [<br />
{<br />
"label": "Australia",<br />
"key": "Australia"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Europe",<br />
"buckets": [<br />
{<br />
"label": "Scotland",<br />
"groupName": "Europe",<br />
"key": "Scotland"<br />
}<br />
]<br />
}<br />
]<br />
},<br />
{<br />
"name": "taxonomy.wildlife",<br />
"label": "Wildlife",<br />
"columns": 4,<br />
"groups": [<br />
{<br />
"name": "Bears",<br />
"buckets": [<br />
{<br />
"label": "Grizzly Bears",<br />
"key": "Grizzly Bears"<br />
},<br />
{<br />
"label": "Polar Bear",<br />
"key": "Polar Bear"<br />
},<br />
{<br />
"label": "Spirit Bear",<br />
"key": "Spirit Bear"<br />
},<br />
{<br />
"label": "Sun Bear",<br />
"key": "Sun Bear"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Big Cats",<br />
"buckets": [<br />
{<br />
"label": "African Leopard",<br />
"key": "African Leopard"<br />
},<br />
{<br />
"label": "African Lion",<br />
"key": "African Lion"<br />
},<br />
{<br />
"label": "Asiatic Leopard",<br />
"key": "Asiatic Leopard"<br />
},<br />
{<br />
"label": "Bengal Tiger",<br />
"key": "Bengal Tiger"<br />
},<br />
{<br />
"label": "Cheetah",<br />
"key": "Cheetah"<br />
},<br />
{<br />
"label": "Jaguar",<br />
"key": "Jaguar"<br />
},<br />
{<br />
"label": "Puma",<br />
"key": "Puma"<br />
},<br />
{<br />
"label": "Siberian Tiger",<br />
"key": "Siberian Tiger"<br />
},<br />
{<br />
"label": "Snow Leopard",<br />
"key": "Snow Leopard"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Big Five",<br />
"buckets": [<br />
{<br />
"label": "African Elephant",<br />
"key": "African Elephant"<br />
},<br />
{<br />
"label": "Black Rhinoceros",<br />
"key": "Black Rhinoceros"<br />
},<br />
{<br />
"label": "Cape Buffalo",<br />
"key": "Cape Buffalo"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Primates",<br />
"buckets": [<br />
{<br />
"label": "Chimpanzee",<br />
"key": "Chimpanzee"<br />
},<br />
{<br />
"label": "Lemurs",<br />
"key": "Lemurs"<br />
},<br />
{<br />
"label": "Mountain Gorilla",<br />
"key": "Mountain Gorilla"<br />
},<br />
{<br />
"label": "Orangutan",<br />
"key": "Orangutan"<br />
},<br />
{<br />
"label": "Western Lowland Gorilla",<br />
"key": "Western Lowland Gorilla"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Whales",<br />
"buckets": [<br />
{<br />
"label": "Beluga Whale",<br />
"key": "Beluga Whale"<br />
},<br />
{<br />
"label": "Blue Whale",<br />
"key": "Blue Whale"<br />
},<br />
{<br />
"label": "Killer Whale",<br />
"key": "Killer Whale"<br />
},<br />
{<br />
"label": "Narwhal",<br />
"key": "Narwhal"<br />
},<br />
{<br />
"label": "Sperm Whales",<br />
"key": "Sperm Whales"<br />
},<br />
{<br />
"label": "Whale Shark",<br />
"key": "Whale Shark"<br />
}<br />
]<br />
}<br />
]<br />
}<br />
]<br />
},<br />
"i": 4<br />
},<br />
{<br />
"t": "p",<br />
"c": "",<br />
"d": {},<br />
"i": 2<br />
}<br />
],<br />
"i": 3<br />
}<br />
<br />
</syntaxhighlight></div>46.16.211.253https://wiki.socialstack.dev/index.php?title=Search_Elastic&diff=519Search Elastic2023-03-28T16:16:06Z<p>46.16.211.253: /* Search taxonomy and filters/facets */</p>
<hr />
<div>The elastic search module works alongside the [[Search Crawler]] to extract pages from the site into an elastic search instance to enable site wide search<br />
<br />
The module registers itself to listen for the search crawler events and creates locale based indexes in the elastic repo for any pages it receives<br />
<br />
When indexing the pages, if there is a primary data type then this will also be indexed against the page in '''primaryObject''', this can then be used in query values as explained below<br />
<br />
The indexing process is controlled by execution of the search crawler via the site automations<br />
<br />
The module contains a Readme.txt file which gives help for the initial setup of elastic but the creation of the indexes/content are all automated.<br />
<br />
== Installation ==<br />
<br />
The basic setup steps are <br />
<br />
#Install the following socialstack modules<br />
#*Api/SearchCrawler<br />
#*Api/SearchElastic<br />
#*UI/SiteSearch<br />
#Mark any pages not to be indexed<br />
#Install Elastic Search (see '''Readme.txt''' in the repo for help and guidance)<br />
#Configure the sizing/scale in the '''elasticsearch.yml''' file (mainly vm memory usage)<br />
#Start Elastic Search for the first time and get the master password and certificate fingerprint<br />
#Add the url, credentials and fingerprint values to the module configuration via the ss admin panel<br />
#Run the automation to index the site, the indexing progress is shown via the console<br />
<br />
The module also contains a postman collection which can be used to quick debug/verify the indexed content<br />
<br />
Once indexed there is a UI/SiteSearch module which can be used as the basis of the site search<br />
<br />
== Endpoints ==<br />
<br />
=== GET /v1/sitesearch/reset ===<br />
<br />
This removes any indexes from elastic to allow a clean start<br />
<br />
=== POST /v1/sitesearch/query ===<br />
<br />
This is the core search endpoint which currently accepts the following values <br />
<br />
;queryString<br />
:The query value entered by the user and/or the '''UI/SiteSearch''' and '''UI/ContentSearch''' components, elastic search uses the Lucene query language so you can build complex queries <br />
:https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html<br />
:e.g.<br />
:<code>Africa AND primaryObject.name:Botswana</code><br />
:<code>primaryObject.price:(>=1000 AND <5000)</code><br />
:<code>((quick AND fox) OR (brown AND fox) OR fox) AND NOT dog</code><br />
<br />
;tags<br />
: This expects a list of comma separated tags, if any are supplied the query will only return results which contain all the passed tag values<br />
<br />
;contentTypes<br />
: This expects a list of comma separated content types, if any are supplied the query will only return results which contain all the passed content types, these are normally the primary data object for the page<br />
<br />
;pageSize<br />
: This expects the page size and will default to 10 if not populated<br />
<br />
;pageIndex<br />
: This expects the starting page number and will default to 1<br />
<br />
;aggregationFields<br />
: This expects a list of comma separated field names, if any are supplied then aggregations/facets are returned for the fields, a good example of this can be be found in '''UI/ContentSearch''' component<br />
<br />
== Search taxonomy and filters/facets ==<br />
You can filter or define facets(aggregations in ElasticSerach terminology) on any field exposed to Elastic from the social stack application, but they obviously work best on metadata types fields<br />
<br />
A basic example would be the '''tags''' field.<br />
<br />
But a better solution is to setup contextual tags using the '''Api/Categories''' component and tags.<br />
<br />
This allows you to give some context to a tag, so for example you could create an '''Animals''' category, then when adding a new tag for '''Cow''' or '''Horse''' you would set their category to be '''Animals'''<br />
<br />
Any tags linked to a category can be referenced as '''taxonomy.xxxxx''' so in this example '''taxonomy.animals'''<br />
<br />
These can then be referenced to show a contextual filter in the UI, the example below will pass back an aggregation of any '''animals''' tags in the result set, '''UI/ContentSearch''' then uses these render an auto generated filter.<br />
e.g.<br />
<br />
<syntaxhighlight lang="json"><br />
{<br />
"c": [<br />
{<br />
"t": "UI/ContentSearch",<br />
"d": {<br />
"aggregationFields": "taxonomy.animals",<br />
"contentTypes": "ItineraryPageDataType"<br />
} <br />
} <br />
]<br />
}<br />
<br />
</syntaxhighlight><br />
<br />
When tags are assigned to category and indexed, you will expose the core tag values and also some auto generated taxonomy fields.<br />
<br />
An example of the indexed data in Elastic looks something like the example below where '''Africa''' and '''Botswana''' are plain tags but '''Horse''' has been linked to the '''Animals''' category<br />
<br />
<syntaxhighlight lang="json"><br />
{<br />
"tags": [<br />
"Africa",<br />
"Botswana",<br />
"Horse"<br />
],<br />
"taxonomy": {<br />
"animals": [<br />
"Horse"<br />
]<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
== UI Components ==<br />
;UI/ContentSearch<br />
<br />
This provides a good example with filtering and paging<br />
<br />
The component will also allow you to override the default values/titles for any aggregation using the aggregationOverrides property, this can be useful to add grouping to values such as regions/countries etc<br />
<br />
An example is shown below<br />
<br />
<syntaxhighlight lang="json"><br />
{<br />
"c": [<br />
{<br />
"t": "UI/ContentSearch",<br />
"d": {<br />
"aggregationFields": "taxonomy.price,taxonomy.destination,taxonomy.wildlife",<br />
"contentTypes": "ItineraryPageDataType",<br />
"aggregationOverrides": [<br />
{<br />
"name": "taxonomy.price",<br />
"label": "Price",<br />
"buckets": [<br />
{<br />
"label": "&pound;3500",<br />
"key": "3500"<br />
},<br />
{<br />
"label": "&pound;5000",<br />
"key": "5000"<br />
},<br />
{<br />
"label": "&pound;7500",<br />
"key": "7500"<br />
}<br />
]<br />
},<br />
{<br />
"name": "taxonomy.destination",<br />
"label": "Destination",<br />
"columns": 3,<br />
"groups": [<br />
{<br />
"name": "Africa and the Indian Ocean",<br />
"buckets": [<br />
{<br />
"label": "Botswana",<br />
"key": "Botswana"<br />
},<br />
{<br />
"label": "Central African Republic",<br />
"key": "Central African Republic"<br />
},<br />
{<br />
"label": "Chad",<br />
"key": "Chad"<br />
},<br />
{<br />
"label": "Congo",<br />
"key": "Congo"<br />
},<br />
{<br />
"label": "Djibouti",<br />
"key": "Djibouti"<br />
},<br />
{<br />
"label": "Gabon",<br />
"key": "Gabon"<br />
},<br />
{<br />
"label": "Indian Ocean",<br />
"key": "Indian Ocean"<br />
},<br />
{<br />
"label": "Kenya",<br />
"key": "Kenya"<br />
},<br />
{<br />
"label": "Madagascar",<br />
"key": "Madagascar"<br />
},<br />
{<br />
"label": "Mozambique",<br />
"key": "Mozambique"<br />
},<br />
{<br />
"label": "Namibia",<br />
"key": "Namibia"<br />
},<br />
{<br />
"label": "Rwanda",<br />
"key": "Rwanda"<br />
},<br />
{<br />
"label": "South Africa",<br />
"key": "South Africa"<br />
},<br />
{<br />
"label": "Tanzania",<br />
"key": "Tanzania"<br />
},<br />
{<br />
"label": "Uganda",<br />
"key": "Uganda"<br />
},<br />
{<br />
"label": "Zambia",<br />
"key": "Zambia"<br />
},<br />
{<br />
"label": "Zimbabwe",<br />
"key": "Zimbabwe"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Asia",<br />
"buckets": [<br />
{<br />
"label": "Borneo",<br />
"key": "Borneo"<br />
},<br />
{<br />
"label": "India",<br />
"key": "India"<br />
},<br />
{<br />
"label": "Russia",<br />
"key": "Russia"<br />
},<br />
{<br />
"label": "Sri Lanka",<br />
"key": "Sri Lanka"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Latin America",<br />
"buckets": [<br />
{<br />
"label": "Argentina",<br />
"key": "Argentina"<br />
},<br />
{<br />
"label": "Belize",<br />
"key": "Belize"<br />
},<br />
{<br />
"label": "Brazil",<br />
"key": "Brazil"<br />
},<br />
{<br />
"label": "Chile",<br />
"key": "Chile"<br />
},<br />
{<br />
"label": "Colombia",<br />
"key": "Colombia"<br />
},<br />
{<br />
"label": "Costa Rica",<br />
"key": "Costa Rica"<br />
},<br />
{<br />
"label": "Ecuador",<br />
"key": "Ecuador"<br />
},<br />
{<br />
"label": "Galapagos",<br />
"key": "Galapagos"<br />
},<br />
{<br />
"label": "Peru",<br />
"key": "Peru"<br />
}<br />
]<br />
},<br />
{<br />
"name": "North America",<br />
"buckets": [<br />
{<br />
"label": "Alaska",<br />
"key": "Alaska"<br />
},<br />
{<br />
"label": "Canada",<br />
"key": "Canada"<br />
},<br />
{<br />
"label": "Dominica",<br />
"key": "Dominica"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Polar Regions",<br />
"buckets": [<br />
{<br />
"label": "Antarctica",<br />
"key": "Antarctica"<br />
},<br />
{<br />
"label": "Arctic Canada",<br />
"key": "Arctic Canada"<br />
},<br />
{<br />
"label": "Greenland",<br />
"key": "Greenland"<br />
},<br />
{<br />
"label": "Norway",<br />
"key": "Norway"<br />
},<br />
{<br />
"label": "Svalbard",<br />
"key": "Svalbard"<br />
},<br />
{<br />
"label": "Arctic Russia",<br />
"key": "Arctic Russia"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Australasia",<br />
"buckets": [<br />
{<br />
"label": "Australia",<br />
"key": "Australia"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Europe",<br />
"buckets": [<br />
{<br />
"label": "Scotland",<br />
"groupName": "Europe",<br />
"key": "Scotland"<br />
}<br />
]<br />
}<br />
]<br />
},<br />
{<br />
"name": "taxonomy.wildlife",<br />
"label": "Wildlife",<br />
"columns": 4,<br />
"groups": [<br />
{<br />
"name": "Bears",<br />
"buckets": [<br />
{<br />
"label": "Grizzly Bears",<br />
"key": "Grizzly Bears"<br />
},<br />
{<br />
"label": "Polar Bear",<br />
"key": "Polar Bear"<br />
},<br />
{<br />
"label": "Spirit Bear",<br />
"key": "Spirit Bear"<br />
},<br />
{<br />
"label": "Sun Bear",<br />
"key": "Sun Bear"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Big Cats",<br />
"buckets": [<br />
{<br />
"label": "African Leopard",<br />
"key": "African Leopard"<br />
},<br />
{<br />
"label": "African Lion",<br />
"key": "African Lion"<br />
},<br />
{<br />
"label": "Asiatic Leopard",<br />
"key": "Asiatic Leopard"<br />
},<br />
{<br />
"label": "Bengal Tiger",<br />
"key": "Bengal Tiger"<br />
},<br />
{<br />
"label": "Cheetah",<br />
"key": "Cheetah"<br />
},<br />
{<br />
"label": "Jaguar",<br />
"key": "Jaguar"<br />
},<br />
{<br />
"label": "Puma",<br />
"key": "Puma"<br />
},<br />
{<br />
"label": "Siberian Tiger",<br />
"key": "Siberian Tiger"<br />
},<br />
{<br />
"label": "Snow Leopard",<br />
"key": "Snow Leopard"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Big Five",<br />
"buckets": [<br />
{<br />
"label": "African Elephant",<br />
"key": "African Elephant"<br />
},<br />
{<br />
"label": "Black Rhinoceros",<br />
"key": "Black Rhinoceros"<br />
},<br />
{<br />
"label": "Cape Buffalo",<br />
"key": "Cape Buffalo"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Primates",<br />
"buckets": [<br />
{<br />
"label": "Chimpanzee",<br />
"key": "Chimpanzee"<br />
},<br />
{<br />
"label": "Lemurs",<br />
"key": "Lemurs"<br />
},<br />
{<br />
"label": "Mountain Gorilla",<br />
"key": "Mountain Gorilla"<br />
},<br />
{<br />
"label": "Orangutan",<br />
"key": "Orangutan"<br />
},<br />
{<br />
"label": "Western Lowland Gorilla",<br />
"key": "Western Lowland Gorilla"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Whales",<br />
"buckets": [<br />
{<br />
"label": "Beluga Whale",<br />
"key": "Beluga Whale"<br />
},<br />
{<br />
"label": "Blue Whale",<br />
"key": "Blue Whale"<br />
},<br />
{<br />
"label": "Killer Whale",<br />
"key": "Killer Whale"<br />
},<br />
{<br />
"label": "Narwhal",<br />
"key": "Narwhal"<br />
},<br />
{<br />
"label": "Sperm Whales",<br />
"key": "Sperm Whales"<br />
},<br />
{<br />
"label": "Whale Shark",<br />
"key": "Whale Shark"<br />
}<br />
]<br />
}<br />
]<br />
}<br />
]<br />
},<br />
"i": 4<br />
},<br />
{<br />
"t": "p",<br />
"c": "",<br />
"d": {},<br />
"i": 2<br />
}<br />
],<br />
"i": 3<br />
}<br />
<br />
</syntaxhighlight></div>46.16.211.253https://wiki.socialstack.dev/index.php?title=Search_Elastic&diff=518Search Elastic2023-03-28T16:15:00Z<p>46.16.211.253: /* Search taxonomy and filters/facets */</p>
<hr />
<div>The elastic search module works alongside the [[Search Crawler]] to extract pages from the site into an elastic search instance to enable site wide search<br />
<br />
The module registers itself to listen for the search crawler events and creates locale based indexes in the elastic repo for any pages it receives<br />
<br />
When indexing the pages, if there is a primary data type then this will also be indexed against the page in '''primaryObject''', this can then be used in query values as explained below<br />
<br />
The indexing process is controlled by execution of the search crawler via the site automations<br />
<br />
The module contains a Readme.txt file which gives help for the initial setup of elastic but the creation of the indexes/content are all automated.<br />
<br />
== Installation ==<br />
<br />
The basic setup steps are <br />
<br />
#Install the following socialstack modules<br />
#*Api/SearchCrawler<br />
#*Api/SearchElastic<br />
#*UI/SiteSearch<br />
#Mark any pages not to be indexed<br />
#Install Elastic Search (see '''Readme.txt''' in the repo for help and guidance)<br />
#Configure the sizing/scale in the '''elasticsearch.yml''' file (mainly vm memory usage)<br />
#Start Elastic Search for the first time and get the master password and certificate fingerprint<br />
#Add the url, credentials and fingerprint values to the module configuration via the ss admin panel<br />
#Run the automation to index the site, the indexing progress is shown via the console<br />
<br />
The module also contains a postman collection which can be used to quick debug/verify the indexed content<br />
<br />
Once indexed there is a UI/SiteSearch module which can be used as the basis of the site search<br />
<br />
== Endpoints ==<br />
<br />
=== GET /v1/sitesearch/reset ===<br />
<br />
This removes any indexes from elastic to allow a clean start<br />
<br />
=== POST /v1/sitesearch/query ===<br />
<br />
This is the core search endpoint which currently accepts the following values <br />
<br />
;queryString<br />
:The query value entered by the user and/or the '''UI/SiteSearch''' and '''UI/ContentSearch''' components, elastic search uses the Lucene query language so you can build complex queries <br />
:https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html<br />
:e.g.<br />
:<code>Africa AND primaryObject.name:Botswana</code><br />
:<code>primaryObject.price:(>=1000 AND <5000)</code><br />
:<code>((quick AND fox) OR (brown AND fox) OR fox) AND NOT dog</code><br />
<br />
;tags<br />
: This expects a list of comma separated tags, if any are supplied the query will only return results which contain all the passed tag values<br />
<br />
;contentTypes<br />
: This expects a list of comma separated content types, if any are supplied the query will only return results which contain all the passed content types, these are normally the primary data object for the page<br />
<br />
;pageSize<br />
: This expects the page size and will default to 10 if not populated<br />
<br />
;pageIndex<br />
: This expects the starting page number and will default to 1<br />
<br />
;aggregationFields<br />
: This expects a list of comma separated field names, if any are supplied then aggregations/facets are returned for the fields, a good example of this can be be found in '''UI/ContentSearch''' component<br />
<br />
== Search taxonomy and filters/facets ==<br />
You can filter or define facets(aggregations in ElasticSerach terminology) on any field exposed to Elastic from the social stack application, but they obviously work best on metadata types fields<br />
<br />
A basic example would be the '''tags''' field.<br />
<br />
But a better solution is to setup contextual tags using the '''Api/Categories''' component and tags.<br />
<br />
This allows you to give some context to a tag, so for example you could create an '''Animals''' category, then when adding a new tag for '''Cow''' or '''Horse''' you would set their category to be '''Animals'''<br />
<br />
Any tags linked to a category can be referenced as '''taxonomy.xxxxx''' so in this example '''taxonomy.animals'''<br />
<br />
These can then be referenced to show a contextual filter in the UI, the example below will pass back an aggregation of any '''animals''' tags in the result set, '''UI/ContentSearch''' then uses these render an auto generated filter.<br />
e.g.<br />
<br />
<syntaxhighlight lang="json"><br />
{<br />
"c": [<br />
{<br />
"t": "UI/ContentSearch",<br />
"d": {<br />
"aggregationFields": "taxonomy.animals",<br />
"contentTypes": "ItineraryPageDataType"<br />
} <br />
} <br />
]<br />
}<br />
<br />
</syntaxhighlight><br />
<br />
When tags are assigned to category and indexed, you will expose the core tag values and also some auto generated taxonomy fields.<br />
<br />
An example of the indexed data in Elastic looks something like the example below where '''Africa''' and '''Botswana''' are plain tags but '''Horse'' has been linked to the '''Animals''' category<br />
<br />
<syntaxhighlight lang="json"><br />
{<br />
"tags": [<br />
"Africa",<br />
"Botswana",<br />
"Horse"<br />
],<br />
"taxonomy": {<br />
"animals": [<br />
"Horse"<br />
]<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
== UI Components ==<br />
;UI/ContentSearch<br />
<br />
This provides a good example with filtering and paging<br />
<br />
The component will also allow you to override the default values/titles for any aggregation using the aggregationOverrides property, this can be useful to add grouping to values such as regions/countries etc<br />
<br />
An example is shown below<br />
<br />
<syntaxhighlight lang="json"><br />
{<br />
"c": [<br />
{<br />
"t": "UI/ContentSearch",<br />
"d": {<br />
"aggregationFields": "taxonomy.price,taxonomy.destination,taxonomy.wildlife",<br />
"contentTypes": "ItineraryPageDataType",<br />
"aggregationOverrides": [<br />
{<br />
"name": "taxonomy.price",<br />
"label": "Price",<br />
"buckets": [<br />
{<br />
"label": "&pound;3500",<br />
"key": "3500"<br />
},<br />
{<br />
"label": "&pound;5000",<br />
"key": "5000"<br />
},<br />
{<br />
"label": "&pound;7500",<br />
"key": "7500"<br />
}<br />
]<br />
},<br />
{<br />
"name": "taxonomy.destination",<br />
"label": "Destination",<br />
"columns": 3,<br />
"groups": [<br />
{<br />
"name": "Africa and the Indian Ocean",<br />
"buckets": [<br />
{<br />
"label": "Botswana",<br />
"key": "Botswana"<br />
},<br />
{<br />
"label": "Central African Republic",<br />
"key": "Central African Republic"<br />
},<br />
{<br />
"label": "Chad",<br />
"key": "Chad"<br />
},<br />
{<br />
"label": "Congo",<br />
"key": "Congo"<br />
},<br />
{<br />
"label": "Djibouti",<br />
"key": "Djibouti"<br />
},<br />
{<br />
"label": "Gabon",<br />
"key": "Gabon"<br />
},<br />
{<br />
"label": "Indian Ocean",<br />
"key": "Indian Ocean"<br />
},<br />
{<br />
"label": "Kenya",<br />
"key": "Kenya"<br />
},<br />
{<br />
"label": "Madagascar",<br />
"key": "Madagascar"<br />
},<br />
{<br />
"label": "Mozambique",<br />
"key": "Mozambique"<br />
},<br />
{<br />
"label": "Namibia",<br />
"key": "Namibia"<br />
},<br />
{<br />
"label": "Rwanda",<br />
"key": "Rwanda"<br />
},<br />
{<br />
"label": "South Africa",<br />
"key": "South Africa"<br />
},<br />
{<br />
"label": "Tanzania",<br />
"key": "Tanzania"<br />
},<br />
{<br />
"label": "Uganda",<br />
"key": "Uganda"<br />
},<br />
{<br />
"label": "Zambia",<br />
"key": "Zambia"<br />
},<br />
{<br />
"label": "Zimbabwe",<br />
"key": "Zimbabwe"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Asia",<br />
"buckets": [<br />
{<br />
"label": "Borneo",<br />
"key": "Borneo"<br />
},<br />
{<br />
"label": "India",<br />
"key": "India"<br />
},<br />
{<br />
"label": "Russia",<br />
"key": "Russia"<br />
},<br />
{<br />
"label": "Sri Lanka",<br />
"key": "Sri Lanka"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Latin America",<br />
"buckets": [<br />
{<br />
"label": "Argentina",<br />
"key": "Argentina"<br />
},<br />
{<br />
"label": "Belize",<br />
"key": "Belize"<br />
},<br />
{<br />
"label": "Brazil",<br />
"key": "Brazil"<br />
},<br />
{<br />
"label": "Chile",<br />
"key": "Chile"<br />
},<br />
{<br />
"label": "Colombia",<br />
"key": "Colombia"<br />
},<br />
{<br />
"label": "Costa Rica",<br />
"key": "Costa Rica"<br />
},<br />
{<br />
"label": "Ecuador",<br />
"key": "Ecuador"<br />
},<br />
{<br />
"label": "Galapagos",<br />
"key": "Galapagos"<br />
},<br />
{<br />
"label": "Peru",<br />
"key": "Peru"<br />
}<br />
]<br />
},<br />
{<br />
"name": "North America",<br />
"buckets": [<br />
{<br />
"label": "Alaska",<br />
"key": "Alaska"<br />
},<br />
{<br />
"label": "Canada",<br />
"key": "Canada"<br />
},<br />
{<br />
"label": "Dominica",<br />
"key": "Dominica"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Polar Regions",<br />
"buckets": [<br />
{<br />
"label": "Antarctica",<br />
"key": "Antarctica"<br />
},<br />
{<br />
"label": "Arctic Canada",<br />
"key": "Arctic Canada"<br />
},<br />
{<br />
"label": "Greenland",<br />
"key": "Greenland"<br />
},<br />
{<br />
"label": "Norway",<br />
"key": "Norway"<br />
},<br />
{<br />
"label": "Svalbard",<br />
"key": "Svalbard"<br />
},<br />
{<br />
"label": "Arctic Russia",<br />
"key": "Arctic Russia"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Australasia",<br />
"buckets": [<br />
{<br />
"label": "Australia",<br />
"key": "Australia"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Europe",<br />
"buckets": [<br />
{<br />
"label": "Scotland",<br />
"groupName": "Europe",<br />
"key": "Scotland"<br />
}<br />
]<br />
}<br />
]<br />
},<br />
{<br />
"name": "taxonomy.wildlife",<br />
"label": "Wildlife",<br />
"columns": 4,<br />
"groups": [<br />
{<br />
"name": "Bears",<br />
"buckets": [<br />
{<br />
"label": "Grizzly Bears",<br />
"key": "Grizzly Bears"<br />
},<br />
{<br />
"label": "Polar Bear",<br />
"key": "Polar Bear"<br />
},<br />
{<br />
"label": "Spirit Bear",<br />
"key": "Spirit Bear"<br />
},<br />
{<br />
"label": "Sun Bear",<br />
"key": "Sun Bear"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Big Cats",<br />
"buckets": [<br />
{<br />
"label": "African Leopard",<br />
"key": "African Leopard"<br />
},<br />
{<br />
"label": "African Lion",<br />
"key": "African Lion"<br />
},<br />
{<br />
"label": "Asiatic Leopard",<br />
"key": "Asiatic Leopard"<br />
},<br />
{<br />
"label": "Bengal Tiger",<br />
"key": "Bengal Tiger"<br />
},<br />
{<br />
"label": "Cheetah",<br />
"key": "Cheetah"<br />
},<br />
{<br />
"label": "Jaguar",<br />
"key": "Jaguar"<br />
},<br />
{<br />
"label": "Puma",<br />
"key": "Puma"<br />
},<br />
{<br />
"label": "Siberian Tiger",<br />
"key": "Siberian Tiger"<br />
},<br />
{<br />
"label": "Snow Leopard",<br />
"key": "Snow Leopard"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Big Five",<br />
"buckets": [<br />
{<br />
"label": "African Elephant",<br />
"key": "African Elephant"<br />
},<br />
{<br />
"label": "Black Rhinoceros",<br />
"key": "Black Rhinoceros"<br />
},<br />
{<br />
"label": "Cape Buffalo",<br />
"key": "Cape Buffalo"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Primates",<br />
"buckets": [<br />
{<br />
"label": "Chimpanzee",<br />
"key": "Chimpanzee"<br />
},<br />
{<br />
"label": "Lemurs",<br />
"key": "Lemurs"<br />
},<br />
{<br />
"label": "Mountain Gorilla",<br />
"key": "Mountain Gorilla"<br />
},<br />
{<br />
"label": "Orangutan",<br />
"key": "Orangutan"<br />
},<br />
{<br />
"label": "Western Lowland Gorilla",<br />
"key": "Western Lowland Gorilla"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Whales",<br />
"buckets": [<br />
{<br />
"label": "Beluga Whale",<br />
"key": "Beluga Whale"<br />
},<br />
{<br />
"label": "Blue Whale",<br />
"key": "Blue Whale"<br />
},<br />
{<br />
"label": "Killer Whale",<br />
"key": "Killer Whale"<br />
},<br />
{<br />
"label": "Narwhal",<br />
"key": "Narwhal"<br />
},<br />
{<br />
"label": "Sperm Whales",<br />
"key": "Sperm Whales"<br />
},<br />
{<br />
"label": "Whale Shark",<br />
"key": "Whale Shark"<br />
}<br />
]<br />
}<br />
]<br />
}<br />
]<br />
},<br />
"i": 4<br />
},<br />
{<br />
"t": "p",<br />
"c": "",<br />
"d": {},<br />
"i": 2<br />
}<br />
],<br />
"i": 3<br />
}<br />
<br />
</syntaxhighlight></div>46.16.211.253https://wiki.socialstack.dev/index.php?title=Search_Elastic&diff=517Search Elastic2023-03-28T15:42:02Z<p>46.16.211.253: /* Search taxonomy and filters/facets */</p>
<hr />
<div>The elastic search module works alongside the [[Search Crawler]] to extract pages from the site into an elastic search instance to enable site wide search<br />
<br />
The module registers itself to listen for the search crawler events and creates locale based indexes in the elastic repo for any pages it receives<br />
<br />
When indexing the pages, if there is a primary data type then this will also be indexed against the page in '''primaryObject''', this can then be used in query values as explained below<br />
<br />
The indexing process is controlled by execution of the search crawler via the site automations<br />
<br />
The module contains a Readme.txt file which gives help for the initial setup of elastic but the creation of the indexes/content are all automated.<br />
<br />
== Installation ==<br />
<br />
The basic setup steps are <br />
<br />
#Install the following socialstack modules<br />
#*Api/SearchCrawler<br />
#*Api/SearchElastic<br />
#*UI/SiteSearch<br />
#Mark any pages not to be indexed<br />
#Install Elastic Search (see '''Readme.txt''' in the repo for help and guidance)<br />
#Configure the sizing/scale in the '''elasticsearch.yml''' file (mainly vm memory usage)<br />
#Start Elastic Search for the first time and get the master password and certificate fingerprint<br />
#Add the url, credentials and fingerprint values to the module configuration via the ss admin panel<br />
#Run the automation to index the site, the indexing progress is shown via the console<br />
<br />
The module also contains a postman collection which can be used to quick debug/verify the indexed content<br />
<br />
Once indexed there is a UI/SiteSearch module which can be used as the basis of the site search<br />
<br />
== Endpoints ==<br />
<br />
=== GET /v1/sitesearch/reset ===<br />
<br />
This removes any indexes from elastic to allow a clean start<br />
<br />
=== POST /v1/sitesearch/query ===<br />
<br />
This is the core search endpoint which currently accepts the following values <br />
<br />
;queryString<br />
:The query value entered by the user and/or the '''UI/SiteSearch''' and '''UI/ContentSearch''' components, elastic search uses the Lucene query language so you can build complex queries <br />
:https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html<br />
:e.g.<br />
:<code>Africa AND primaryObject.name:Botswana</code><br />
:<code>primaryObject.price:(>=1000 AND <5000)</code><br />
:<code>((quick AND fox) OR (brown AND fox) OR fox) AND NOT dog</code><br />
<br />
;tags<br />
: This expects a list of comma separated tags, if any are supplied the query will only return results which contain all the passed tag values<br />
<br />
;contentTypes<br />
: This expects a list of comma separated content types, if any are supplied the query will only return results which contain all the passed content types, these are normally the primary data object for the page<br />
<br />
;pageSize<br />
: This expects the page size and will default to 10 if not populated<br />
<br />
;pageIndex<br />
: This expects the starting page number and will default to 1<br />
<br />
;aggregationFields<br />
: This expects a list of comma separated field names, if any are supplied then aggregations/facets are returned for the fields, a good example of this can be be found in '''UI/ContentSearch''' component<br />
<br />
== Search taxonomy and filters/facets ==<br />
You can filter or define facets(aggregations in ElasticSerach terminology) on any field exposed to Elastic from the social stack application, but they obviously work best on metadata types fields<br />
<br />
A good example would be the ootb '''tags''' field.<br />
<br />
But a better solution is to setup contextual tags using the '''Api/Categories''' component<br />
<br />
This allows you to give some context to a tag, so for example you could create an '''Animals''' category, then when adding a new tag for '''Cow''' or '''Horse''' you would set their category to be '''Animals'''<br />
<br />
If these tags are then assigned to content and indexed, you will expose the core tag values and also some auto generated taxonomy fields. <br />
<br />
These can then be referenced to show a contextual filter in the UI<br />
e.g.<br />
<br />
<syntaxhighlight lang="json"><br />
{<br />
"c": [<br />
{<br />
"t": "UI/ContentSearch",<br />
"d": {<br />
"aggregationFields": "taxonomy.animals",<br />
"contentTypes": "ItineraryPageDataType"<br />
} <br />
} <br />
]<br />
}<br />
<br />
</syntaxhighlight><br />
<br />
An example of the indexed data in Elastic looks something like the example below where '''Africa''' and '''Botswana''' are plain tags but '''Horse'' has been linked to the '''Animals''' category<br />
<br />
<syntaxhighlight lang="json"><br />
{<br />
"tags": [<br />
"Africa",<br />
"Botswana",<br />
"Horse"<br />
],<br />
"taxonomy": {<br />
"animals": [<br />
"Horse"<br />
]<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
== UI Components ==<br />
;UI/ContentSearch<br />
<br />
This provides a good example with filtering and paging<br />
<br />
The component will also allow you to override the default values/titles for any aggregation using the aggregationOverrides property, this can be useful to add grouping to values such as regions/countries etc<br />
<br />
An example is shown below<br />
<br />
<syntaxhighlight lang="json"><br />
{<br />
"c": [<br />
{<br />
"t": "UI/ContentSearch",<br />
"d": {<br />
"aggregationFields": "taxonomy.price,taxonomy.destination,taxonomy.wildlife",<br />
"contentTypes": "ItineraryPageDataType",<br />
"aggregationOverrides": [<br />
{<br />
"name": "taxonomy.price",<br />
"label": "Price",<br />
"buckets": [<br />
{<br />
"label": "&pound;3500",<br />
"key": "3500"<br />
},<br />
{<br />
"label": "&pound;5000",<br />
"key": "5000"<br />
},<br />
{<br />
"label": "&pound;7500",<br />
"key": "7500"<br />
}<br />
]<br />
},<br />
{<br />
"name": "taxonomy.destination",<br />
"label": "Destination",<br />
"columns": 3,<br />
"groups": [<br />
{<br />
"name": "Africa and the Indian Ocean",<br />
"buckets": [<br />
{<br />
"label": "Botswana",<br />
"key": "Botswana"<br />
},<br />
{<br />
"label": "Central African Republic",<br />
"key": "Central African Republic"<br />
},<br />
{<br />
"label": "Chad",<br />
"key": "Chad"<br />
},<br />
{<br />
"label": "Congo",<br />
"key": "Congo"<br />
},<br />
{<br />
"label": "Djibouti",<br />
"key": "Djibouti"<br />
},<br />
{<br />
"label": "Gabon",<br />
"key": "Gabon"<br />
},<br />
{<br />
"label": "Indian Ocean",<br />
"key": "Indian Ocean"<br />
},<br />
{<br />
"label": "Kenya",<br />
"key": "Kenya"<br />
},<br />
{<br />
"label": "Madagascar",<br />
"key": "Madagascar"<br />
},<br />
{<br />
"label": "Mozambique",<br />
"key": "Mozambique"<br />
},<br />
{<br />
"label": "Namibia",<br />
"key": "Namibia"<br />
},<br />
{<br />
"label": "Rwanda",<br />
"key": "Rwanda"<br />
},<br />
{<br />
"label": "South Africa",<br />
"key": "South Africa"<br />
},<br />
{<br />
"label": "Tanzania",<br />
"key": "Tanzania"<br />
},<br />
{<br />
"label": "Uganda",<br />
"key": "Uganda"<br />
},<br />
{<br />
"label": "Zambia",<br />
"key": "Zambia"<br />
},<br />
{<br />
"label": "Zimbabwe",<br />
"key": "Zimbabwe"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Asia",<br />
"buckets": [<br />
{<br />
"label": "Borneo",<br />
"key": "Borneo"<br />
},<br />
{<br />
"label": "India",<br />
"key": "India"<br />
},<br />
{<br />
"label": "Russia",<br />
"key": "Russia"<br />
},<br />
{<br />
"label": "Sri Lanka",<br />
"key": "Sri Lanka"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Latin America",<br />
"buckets": [<br />
{<br />
"label": "Argentina",<br />
"key": "Argentina"<br />
},<br />
{<br />
"label": "Belize",<br />
"key": "Belize"<br />
},<br />
{<br />
"label": "Brazil",<br />
"key": "Brazil"<br />
},<br />
{<br />
"label": "Chile",<br />
"key": "Chile"<br />
},<br />
{<br />
"label": "Colombia",<br />
"key": "Colombia"<br />
},<br />
{<br />
"label": "Costa Rica",<br />
"key": "Costa Rica"<br />
},<br />
{<br />
"label": "Ecuador",<br />
"key": "Ecuador"<br />
},<br />
{<br />
"label": "Galapagos",<br />
"key": "Galapagos"<br />
},<br />
{<br />
"label": "Peru",<br />
"key": "Peru"<br />
}<br />
]<br />
},<br />
{<br />
"name": "North America",<br />
"buckets": [<br />
{<br />
"label": "Alaska",<br />
"key": "Alaska"<br />
},<br />
{<br />
"label": "Canada",<br />
"key": "Canada"<br />
},<br />
{<br />
"label": "Dominica",<br />
"key": "Dominica"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Polar Regions",<br />
"buckets": [<br />
{<br />
"label": "Antarctica",<br />
"key": "Antarctica"<br />
},<br />
{<br />
"label": "Arctic Canada",<br />
"key": "Arctic Canada"<br />
},<br />
{<br />
"label": "Greenland",<br />
"key": "Greenland"<br />
},<br />
{<br />
"label": "Norway",<br />
"key": "Norway"<br />
},<br />
{<br />
"label": "Svalbard",<br />
"key": "Svalbard"<br />
},<br />
{<br />
"label": "Arctic Russia",<br />
"key": "Arctic Russia"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Australasia",<br />
"buckets": [<br />
{<br />
"label": "Australia",<br />
"key": "Australia"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Europe",<br />
"buckets": [<br />
{<br />
"label": "Scotland",<br />
"groupName": "Europe",<br />
"key": "Scotland"<br />
}<br />
]<br />
}<br />
]<br />
},<br />
{<br />
"name": "taxonomy.wildlife",<br />
"label": "Wildlife",<br />
"columns": 4,<br />
"groups": [<br />
{<br />
"name": "Bears",<br />
"buckets": [<br />
{<br />
"label": "Grizzly Bears",<br />
"key": "Grizzly Bears"<br />
},<br />
{<br />
"label": "Polar Bear",<br />
"key": "Polar Bear"<br />
},<br />
{<br />
"label": "Spirit Bear",<br />
"key": "Spirit Bear"<br />
},<br />
{<br />
"label": "Sun Bear",<br />
"key": "Sun Bear"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Big Cats",<br />
"buckets": [<br />
{<br />
"label": "African Leopard",<br />
"key": "African Leopard"<br />
},<br />
{<br />
"label": "African Lion",<br />
"key": "African Lion"<br />
},<br />
{<br />
"label": "Asiatic Leopard",<br />
"key": "Asiatic Leopard"<br />
},<br />
{<br />
"label": "Bengal Tiger",<br />
"key": "Bengal Tiger"<br />
},<br />
{<br />
"label": "Cheetah",<br />
"key": "Cheetah"<br />
},<br />
{<br />
"label": "Jaguar",<br />
"key": "Jaguar"<br />
},<br />
{<br />
"label": "Puma",<br />
"key": "Puma"<br />
},<br />
{<br />
"label": "Siberian Tiger",<br />
"key": "Siberian Tiger"<br />
},<br />
{<br />
"label": "Snow Leopard",<br />
"key": "Snow Leopard"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Big Five",<br />
"buckets": [<br />
{<br />
"label": "African Elephant",<br />
"key": "African Elephant"<br />
},<br />
{<br />
"label": "Black Rhinoceros",<br />
"key": "Black Rhinoceros"<br />
},<br />
{<br />
"label": "Cape Buffalo",<br />
"key": "Cape Buffalo"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Primates",<br />
"buckets": [<br />
{<br />
"label": "Chimpanzee",<br />
"key": "Chimpanzee"<br />
},<br />
{<br />
"label": "Lemurs",<br />
"key": "Lemurs"<br />
},<br />
{<br />
"label": "Mountain Gorilla",<br />
"key": "Mountain Gorilla"<br />
},<br />
{<br />
"label": "Orangutan",<br />
"key": "Orangutan"<br />
},<br />
{<br />
"label": "Western Lowland Gorilla",<br />
"key": "Western Lowland Gorilla"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Whales",<br />
"buckets": [<br />
{<br />
"label": "Beluga Whale",<br />
"key": "Beluga Whale"<br />
},<br />
{<br />
"label": "Blue Whale",<br />
"key": "Blue Whale"<br />
},<br />
{<br />
"label": "Killer Whale",<br />
"key": "Killer Whale"<br />
},<br />
{<br />
"label": "Narwhal",<br />
"key": "Narwhal"<br />
},<br />
{<br />
"label": "Sperm Whales",<br />
"key": "Sperm Whales"<br />
},<br />
{<br />
"label": "Whale Shark",<br />
"key": "Whale Shark"<br />
}<br />
]<br />
}<br />
]<br />
}<br />
]<br />
},<br />
"i": 4<br />
},<br />
{<br />
"t": "p",<br />
"c": "",<br />
"d": {},<br />
"i": 2<br />
}<br />
],<br />
"i": 3<br />
}<br />
<br />
</syntaxhighlight></div>46.16.211.253https://wiki.socialstack.dev/index.php?title=Search_Elastic&diff=516Search Elastic2023-03-28T15:40:45Z<p>46.16.211.253: /* Search taxonomy and filters/facets */</p>
<hr />
<div>The elastic search module works alongside the [[Search Crawler]] to extract pages from the site into an elastic search instance to enable site wide search<br />
<br />
The module registers itself to listen for the search crawler events and creates locale based indexes in the elastic repo for any pages it receives<br />
<br />
When indexing the pages, if there is a primary data type then this will also be indexed against the page in '''primaryObject''', this can then be used in query values as explained below<br />
<br />
The indexing process is controlled by execution of the search crawler via the site automations<br />
<br />
The module contains a Readme.txt file which gives help for the initial setup of elastic but the creation of the indexes/content are all automated.<br />
<br />
== Installation ==<br />
<br />
The basic setup steps are <br />
<br />
#Install the following socialstack modules<br />
#*Api/SearchCrawler<br />
#*Api/SearchElastic<br />
#*UI/SiteSearch<br />
#Mark any pages not to be indexed<br />
#Install Elastic Search (see '''Readme.txt''' in the repo for help and guidance)<br />
#Configure the sizing/scale in the '''elasticsearch.yml''' file (mainly vm memory usage)<br />
#Start Elastic Search for the first time and get the master password and certificate fingerprint<br />
#Add the url, credentials and fingerprint values to the module configuration via the ss admin panel<br />
#Run the automation to index the site, the indexing progress is shown via the console<br />
<br />
The module also contains a postman collection which can be used to quick debug/verify the indexed content<br />
<br />
Once indexed there is a UI/SiteSearch module which can be used as the basis of the site search<br />
<br />
== Endpoints ==<br />
<br />
=== GET /v1/sitesearch/reset ===<br />
<br />
This removes any indexes from elastic to allow a clean start<br />
<br />
=== POST /v1/sitesearch/query ===<br />
<br />
This is the core search endpoint which currently accepts the following values <br />
<br />
;queryString<br />
:The query value entered by the user and/or the '''UI/SiteSearch''' and '''UI/ContentSearch''' components, elastic search uses the Lucene query language so you can build complex queries <br />
:https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html<br />
:e.g.<br />
:<code>Africa AND primaryObject.name:Botswana</code><br />
:<code>primaryObject.price:(>=1000 AND <5000)</code><br />
:<code>((quick AND fox) OR (brown AND fox) OR fox) AND NOT dog</code><br />
<br />
;tags<br />
: This expects a list of comma separated tags, if any are supplied the query will only return results which contain all the passed tag values<br />
<br />
;contentTypes<br />
: This expects a list of comma separated content types, if any are supplied the query will only return results which contain all the passed content types, these are normally the primary data object for the page<br />
<br />
;pageSize<br />
: This expects the page size and will default to 10 if not populated<br />
<br />
;pageIndex<br />
: This expects the starting page number and will default to 1<br />
<br />
;aggregationFields<br />
: This expects a list of comma separated field names, if any are supplied then aggregations/facets are returned for the fields, a good example of this can be be found in '''UI/ContentSearch''' component<br />
<br />
== Search taxonomy and filters/facets ==<br />
You can filter or define facets(aggregations in ElasticSerach terminology) on any field exposed to Elastic from the social stack application, but they obviously work best on metadata types fields<br />
<br />
A good example would be the ootb '''tags''' field.<br />
<br />
But a better solution is to setup contextual tags using the '''Api/Categories''' component<br />
<br />
This allows you to give some context to a tag, so for example you could create an '''Animals''' category, then when adding a new tag for '''Cow''' or '''Horse''' you would set their category to be '''Animals'''<br />
<br />
If these tags are then assigned to content and indexed, you will expose the core tag values and also some auto generated taxonomy fields. These can then be referenced to show an contextual filter in the UI<br />
<br />
e.g.<br />
<br />
<syntaxhighlight lang="json"><br />
{<br />
"c": [<br />
{<br />
"t": "UI/ContentSearch",<br />
"d": {<br />
"aggregationFields": "taxonomy.animals",<br />
"contentTypes": "ItineraryPageDataType"<br />
} <br />
} <br />
]<br />
}<br />
<br />
</syntaxhighlight><br />
<br />
An example of the indexed data in Elastic looks something like the example below where '''Africa''' and '''Botswana''' are plain tags but '''Horse'' has been linked to the '''Animals''' category<br />
<br />
<syntaxhighlight lang="json"><br />
{<br />
"tags": [<br />
"Africa",<br />
"Botswana",<br />
"Horse"<br />
],<br />
"taxonomy": {<br />
"animals": [<br />
"Horse"<br />
]<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
== UI Components ==<br />
;UI/ContentSearch<br />
<br />
This provides a good example with filtering and paging<br />
<br />
The component will also allow you to override the default values/titles for any aggregation using the aggregationOverrides property, this can be useful to add grouping to values such as regions/countries etc<br />
<br />
An example is shown below<br />
<br />
<syntaxhighlight lang="json"><br />
{<br />
"c": [<br />
{<br />
"t": "UI/ContentSearch",<br />
"d": {<br />
"aggregationFields": "taxonomy.price,taxonomy.destination,taxonomy.wildlife",<br />
"contentTypes": "ItineraryPageDataType",<br />
"aggregationOverrides": [<br />
{<br />
"name": "taxonomy.price",<br />
"label": "Price",<br />
"buckets": [<br />
{<br />
"label": "&pound;3500",<br />
"key": "3500"<br />
},<br />
{<br />
"label": "&pound;5000",<br />
"key": "5000"<br />
},<br />
{<br />
"label": "&pound;7500",<br />
"key": "7500"<br />
}<br />
]<br />
},<br />
{<br />
"name": "taxonomy.destination",<br />
"label": "Destination",<br />
"columns": 3,<br />
"groups": [<br />
{<br />
"name": "Africa and the Indian Ocean",<br />
"buckets": [<br />
{<br />
"label": "Botswana",<br />
"key": "Botswana"<br />
},<br />
{<br />
"label": "Central African Republic",<br />
"key": "Central African Republic"<br />
},<br />
{<br />
"label": "Chad",<br />
"key": "Chad"<br />
},<br />
{<br />
"label": "Congo",<br />
"key": "Congo"<br />
},<br />
{<br />
"label": "Djibouti",<br />
"key": "Djibouti"<br />
},<br />
{<br />
"label": "Gabon",<br />
"key": "Gabon"<br />
},<br />
{<br />
"label": "Indian Ocean",<br />
"key": "Indian Ocean"<br />
},<br />
{<br />
"label": "Kenya",<br />
"key": "Kenya"<br />
},<br />
{<br />
"label": "Madagascar",<br />
"key": "Madagascar"<br />
},<br />
{<br />
"label": "Mozambique",<br />
"key": "Mozambique"<br />
},<br />
{<br />
"label": "Namibia",<br />
"key": "Namibia"<br />
},<br />
{<br />
"label": "Rwanda",<br />
"key": "Rwanda"<br />
},<br />
{<br />
"label": "South Africa",<br />
"key": "South Africa"<br />
},<br />
{<br />
"label": "Tanzania",<br />
"key": "Tanzania"<br />
},<br />
{<br />
"label": "Uganda",<br />
"key": "Uganda"<br />
},<br />
{<br />
"label": "Zambia",<br />
"key": "Zambia"<br />
},<br />
{<br />
"label": "Zimbabwe",<br />
"key": "Zimbabwe"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Asia",<br />
"buckets": [<br />
{<br />
"label": "Borneo",<br />
"key": "Borneo"<br />
},<br />
{<br />
"label": "India",<br />
"key": "India"<br />
},<br />
{<br />
"label": "Russia",<br />
"key": "Russia"<br />
},<br />
{<br />
"label": "Sri Lanka",<br />
"key": "Sri Lanka"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Latin America",<br />
"buckets": [<br />
{<br />
"label": "Argentina",<br />
"key": "Argentina"<br />
},<br />
{<br />
"label": "Belize",<br />
"key": "Belize"<br />
},<br />
{<br />
"label": "Brazil",<br />
"key": "Brazil"<br />
},<br />
{<br />
"label": "Chile",<br />
"key": "Chile"<br />
},<br />
{<br />
"label": "Colombia",<br />
"key": "Colombia"<br />
},<br />
{<br />
"label": "Costa Rica",<br />
"key": "Costa Rica"<br />
},<br />
{<br />
"label": "Ecuador",<br />
"key": "Ecuador"<br />
},<br />
{<br />
"label": "Galapagos",<br />
"key": "Galapagos"<br />
},<br />
{<br />
"label": "Peru",<br />
"key": "Peru"<br />
}<br />
]<br />
},<br />
{<br />
"name": "North America",<br />
"buckets": [<br />
{<br />
"label": "Alaska",<br />
"key": "Alaska"<br />
},<br />
{<br />
"label": "Canada",<br />
"key": "Canada"<br />
},<br />
{<br />
"label": "Dominica",<br />
"key": "Dominica"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Polar Regions",<br />
"buckets": [<br />
{<br />
"label": "Antarctica",<br />
"key": "Antarctica"<br />
},<br />
{<br />
"label": "Arctic Canada",<br />
"key": "Arctic Canada"<br />
},<br />
{<br />
"label": "Greenland",<br />
"key": "Greenland"<br />
},<br />
{<br />
"label": "Norway",<br />
"key": "Norway"<br />
},<br />
{<br />
"label": "Svalbard",<br />
"key": "Svalbard"<br />
},<br />
{<br />
"label": "Arctic Russia",<br />
"key": "Arctic Russia"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Australasia",<br />
"buckets": [<br />
{<br />
"label": "Australia",<br />
"key": "Australia"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Europe",<br />
"buckets": [<br />
{<br />
"label": "Scotland",<br />
"groupName": "Europe",<br />
"key": "Scotland"<br />
}<br />
]<br />
}<br />
]<br />
},<br />
{<br />
"name": "taxonomy.wildlife",<br />
"label": "Wildlife",<br />
"columns": 4,<br />
"groups": [<br />
{<br />
"name": "Bears",<br />
"buckets": [<br />
{<br />
"label": "Grizzly Bears",<br />
"key": "Grizzly Bears"<br />
},<br />
{<br />
"label": "Polar Bear",<br />
"key": "Polar Bear"<br />
},<br />
{<br />
"label": "Spirit Bear",<br />
"key": "Spirit Bear"<br />
},<br />
{<br />
"label": "Sun Bear",<br />
"key": "Sun Bear"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Big Cats",<br />
"buckets": [<br />
{<br />
"label": "African Leopard",<br />
"key": "African Leopard"<br />
},<br />
{<br />
"label": "African Lion",<br />
"key": "African Lion"<br />
},<br />
{<br />
"label": "Asiatic Leopard",<br />
"key": "Asiatic Leopard"<br />
},<br />
{<br />
"label": "Bengal Tiger",<br />
"key": "Bengal Tiger"<br />
},<br />
{<br />
"label": "Cheetah",<br />
"key": "Cheetah"<br />
},<br />
{<br />
"label": "Jaguar",<br />
"key": "Jaguar"<br />
},<br />
{<br />
"label": "Puma",<br />
"key": "Puma"<br />
},<br />
{<br />
"label": "Siberian Tiger",<br />
"key": "Siberian Tiger"<br />
},<br />
{<br />
"label": "Snow Leopard",<br />
"key": "Snow Leopard"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Big Five",<br />
"buckets": [<br />
{<br />
"label": "African Elephant",<br />
"key": "African Elephant"<br />
},<br />
{<br />
"label": "Black Rhinoceros",<br />
"key": "Black Rhinoceros"<br />
},<br />
{<br />
"label": "Cape Buffalo",<br />
"key": "Cape Buffalo"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Primates",<br />
"buckets": [<br />
{<br />
"label": "Chimpanzee",<br />
"key": "Chimpanzee"<br />
},<br />
{<br />
"label": "Lemurs",<br />
"key": "Lemurs"<br />
},<br />
{<br />
"label": "Mountain Gorilla",<br />
"key": "Mountain Gorilla"<br />
},<br />
{<br />
"label": "Orangutan",<br />
"key": "Orangutan"<br />
},<br />
{<br />
"label": "Western Lowland Gorilla",<br />
"key": "Western Lowland Gorilla"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Whales",<br />
"buckets": [<br />
{<br />
"label": "Beluga Whale",<br />
"key": "Beluga Whale"<br />
},<br />
{<br />
"label": "Blue Whale",<br />
"key": "Blue Whale"<br />
},<br />
{<br />
"label": "Killer Whale",<br />
"key": "Killer Whale"<br />
},<br />
{<br />
"label": "Narwhal",<br />
"key": "Narwhal"<br />
},<br />
{<br />
"label": "Sperm Whales",<br />
"key": "Sperm Whales"<br />
},<br />
{<br />
"label": "Whale Shark",<br />
"key": "Whale Shark"<br />
}<br />
]<br />
}<br />
]<br />
}<br />
]<br />
},<br />
"i": 4<br />
},<br />
{<br />
"t": "p",<br />
"c": "",<br />
"d": {},<br />
"i": 2<br />
}<br />
],<br />
"i": 3<br />
}<br />
<br />
</syntaxhighlight></div>46.16.211.253https://wiki.socialstack.dev/index.php?title=Search_Elastic&diff=515Search Elastic2023-03-28T15:33:49Z<p>46.16.211.253: /* Search taxonomy and filters/facets */</p>
<hr />
<div>The elastic search module works alongside the [[Search Crawler]] to extract pages from the site into an elastic search instance to enable site wide search<br />
<br />
The module registers itself to listen for the search crawler events and creates locale based indexes in the elastic repo for any pages it receives<br />
<br />
When indexing the pages, if there is a primary data type then this will also be indexed against the page in '''primaryObject''', this can then be used in query values as explained below<br />
<br />
The indexing process is controlled by execution of the search crawler via the site automations<br />
<br />
The module contains a Readme.txt file which gives help for the initial setup of elastic but the creation of the indexes/content are all automated.<br />
<br />
== Installation ==<br />
<br />
The basic setup steps are <br />
<br />
#Install the following socialstack modules<br />
#*Api/SearchCrawler<br />
#*Api/SearchElastic<br />
#*UI/SiteSearch<br />
#Mark any pages not to be indexed<br />
#Install Elastic Search (see '''Readme.txt''' in the repo for help and guidance)<br />
#Configure the sizing/scale in the '''elasticsearch.yml''' file (mainly vm memory usage)<br />
#Start Elastic Search for the first time and get the master password and certificate fingerprint<br />
#Add the url, credentials and fingerprint values to the module configuration via the ss admin panel<br />
#Run the automation to index the site, the indexing progress is shown via the console<br />
<br />
The module also contains a postman collection which can be used to quick debug/verify the indexed content<br />
<br />
Once indexed there is a UI/SiteSearch module which can be used as the basis of the site search<br />
<br />
== Endpoints ==<br />
<br />
=== GET /v1/sitesearch/reset ===<br />
<br />
This removes any indexes from elastic to allow a clean start<br />
<br />
=== POST /v1/sitesearch/query ===<br />
<br />
This is the core search endpoint which currently accepts the following values <br />
<br />
;queryString<br />
:The query value entered by the user and/or the '''UI/SiteSearch''' and '''UI/ContentSearch''' components, elastic search uses the Lucene query language so you can build complex queries <br />
:https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html<br />
:e.g.<br />
:<code>Africa AND primaryObject.name:Botswana</code><br />
:<code>primaryObject.price:(>=1000 AND <5000)</code><br />
:<code>((quick AND fox) OR (brown AND fox) OR fox) AND NOT dog</code><br />
<br />
;tags<br />
: This expects a list of comma separated tags, if any are supplied the query will only return results which contain all the passed tag values<br />
<br />
;contentTypes<br />
: This expects a list of comma separated content types, if any are supplied the query will only return results which contain all the passed content types, these are normally the primary data object for the page<br />
<br />
;pageSize<br />
: This expects the page size and will default to 10 if not populated<br />
<br />
;pageIndex<br />
: This expects the starting page number and will default to 1<br />
<br />
;aggregationFields<br />
: This expects a list of comma separated field names, if any are supplied then aggregations/facets are returned for the fields, a good example of this can be be found in '''UI/ContentSearch''' component<br />
<br />
== Search taxonomy and filters/facets ==<br />
You can filter or define facets(aggregations in ElasticSerach terminology) on any field<br />
<br />
A good example would be the ootb '''tags''' field<br />
<br />
But a better solution is to setup contextual tags using the '''Api/Categories''' component<br />
<br />
This allows you to give some context to a tag, so for example you could create an "Animals" category, then when adding a new tag for '''Cow''' or '''Horse''' you would set their category to be '''Animals'''<br />
<br />
If these tags are assigned to content which is later indexed as well as getting the core tag values you will also get some auto generated taxonomy fields. These can then be referenced to show an contextual filter<br />
<br />
e.g.<br />
<br />
<syntaxhighlight lang="json"><br />
{<br />
"c": [<br />
{<br />
"t": "UI/ContentSearch",<br />
"d": {<br />
"aggregationFields": "taxonomy.animals",<br />
"contentTypes": "ItineraryPageDataType"<br />
}}<br />
]<br />
}<br />
<br />
</syntaxhighlight><br />
<br />
== UI Components ==<br />
;UI/ContentSearch<br />
<br />
This provides a good example with filtering and paging<br />
<br />
The component will also allow you to override the default values/titles for any aggregation using the aggregationOverrides property, this can be useful to add grouping to values such as regions/countries etc<br />
<br />
An example is shown below<br />
<br />
<syntaxhighlight lang="json"><br />
{<br />
"c": [<br />
{<br />
"t": "UI/ContentSearch",<br />
"d": {<br />
"aggregationFields": "taxonomy.price,taxonomy.destination,taxonomy.wildlife",<br />
"contentTypes": "ItineraryPageDataType",<br />
"aggregationOverrides": [<br />
{<br />
"name": "taxonomy.price",<br />
"label": "Price",<br />
"buckets": [<br />
{<br />
"label": "&pound;3500",<br />
"key": "3500"<br />
},<br />
{<br />
"label": "&pound;5000",<br />
"key": "5000"<br />
},<br />
{<br />
"label": "&pound;7500",<br />
"key": "7500"<br />
}<br />
]<br />
},<br />
{<br />
"name": "taxonomy.destination",<br />
"label": "Destination",<br />
"columns": 3,<br />
"groups": [<br />
{<br />
"name": "Africa and the Indian Ocean",<br />
"buckets": [<br />
{<br />
"label": "Botswana",<br />
"key": "Botswana"<br />
},<br />
{<br />
"label": "Central African Republic",<br />
"key": "Central African Republic"<br />
},<br />
{<br />
"label": "Chad",<br />
"key": "Chad"<br />
},<br />
{<br />
"label": "Congo",<br />
"key": "Congo"<br />
},<br />
{<br />
"label": "Djibouti",<br />
"key": "Djibouti"<br />
},<br />
{<br />
"label": "Gabon",<br />
"key": "Gabon"<br />
},<br />
{<br />
"label": "Indian Ocean",<br />
"key": "Indian Ocean"<br />
},<br />
{<br />
"label": "Kenya",<br />
"key": "Kenya"<br />
},<br />
{<br />
"label": "Madagascar",<br />
"key": "Madagascar"<br />
},<br />
{<br />
"label": "Mozambique",<br />
"key": "Mozambique"<br />
},<br />
{<br />
"label": "Namibia",<br />
"key": "Namibia"<br />
},<br />
{<br />
"label": "Rwanda",<br />
"key": "Rwanda"<br />
},<br />
{<br />
"label": "South Africa",<br />
"key": "South Africa"<br />
},<br />
{<br />
"label": "Tanzania",<br />
"key": "Tanzania"<br />
},<br />
{<br />
"label": "Uganda",<br />
"key": "Uganda"<br />
},<br />
{<br />
"label": "Zambia",<br />
"key": "Zambia"<br />
},<br />
{<br />
"label": "Zimbabwe",<br />
"key": "Zimbabwe"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Asia",<br />
"buckets": [<br />
{<br />
"label": "Borneo",<br />
"key": "Borneo"<br />
},<br />
{<br />
"label": "India",<br />
"key": "India"<br />
},<br />
{<br />
"label": "Russia",<br />
"key": "Russia"<br />
},<br />
{<br />
"label": "Sri Lanka",<br />
"key": "Sri Lanka"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Latin America",<br />
"buckets": [<br />
{<br />
"label": "Argentina",<br />
"key": "Argentina"<br />
},<br />
{<br />
"label": "Belize",<br />
"key": "Belize"<br />
},<br />
{<br />
"label": "Brazil",<br />
"key": "Brazil"<br />
},<br />
{<br />
"label": "Chile",<br />
"key": "Chile"<br />
},<br />
{<br />
"label": "Colombia",<br />
"key": "Colombia"<br />
},<br />
{<br />
"label": "Costa Rica",<br />
"key": "Costa Rica"<br />
},<br />
{<br />
"label": "Ecuador",<br />
"key": "Ecuador"<br />
},<br />
{<br />
"label": "Galapagos",<br />
"key": "Galapagos"<br />
},<br />
{<br />
"label": "Peru",<br />
"key": "Peru"<br />
}<br />
]<br />
},<br />
{<br />
"name": "North America",<br />
"buckets": [<br />
{<br />
"label": "Alaska",<br />
"key": "Alaska"<br />
},<br />
{<br />
"label": "Canada",<br />
"key": "Canada"<br />
},<br />
{<br />
"label": "Dominica",<br />
"key": "Dominica"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Polar Regions",<br />
"buckets": [<br />
{<br />
"label": "Antarctica",<br />
"key": "Antarctica"<br />
},<br />
{<br />
"label": "Arctic Canada",<br />
"key": "Arctic Canada"<br />
},<br />
{<br />
"label": "Greenland",<br />
"key": "Greenland"<br />
},<br />
{<br />
"label": "Norway",<br />
"key": "Norway"<br />
},<br />
{<br />
"label": "Svalbard",<br />
"key": "Svalbard"<br />
},<br />
{<br />
"label": "Arctic Russia",<br />
"key": "Arctic Russia"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Australasia",<br />
"buckets": [<br />
{<br />
"label": "Australia",<br />
"key": "Australia"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Europe",<br />
"buckets": [<br />
{<br />
"label": "Scotland",<br />
"groupName": "Europe",<br />
"key": "Scotland"<br />
}<br />
]<br />
}<br />
]<br />
},<br />
{<br />
"name": "taxonomy.wildlife",<br />
"label": "Wildlife",<br />
"columns": 4,<br />
"groups": [<br />
{<br />
"name": "Bears",<br />
"buckets": [<br />
{<br />
"label": "Grizzly Bears",<br />
"key": "Grizzly Bears"<br />
},<br />
{<br />
"label": "Polar Bear",<br />
"key": "Polar Bear"<br />
},<br />
{<br />
"label": "Spirit Bear",<br />
"key": "Spirit Bear"<br />
},<br />
{<br />
"label": "Sun Bear",<br />
"key": "Sun Bear"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Big Cats",<br />
"buckets": [<br />
{<br />
"label": "African Leopard",<br />
"key": "African Leopard"<br />
},<br />
{<br />
"label": "African Lion",<br />
"key": "African Lion"<br />
},<br />
{<br />
"label": "Asiatic Leopard",<br />
"key": "Asiatic Leopard"<br />
},<br />
{<br />
"label": "Bengal Tiger",<br />
"key": "Bengal Tiger"<br />
},<br />
{<br />
"label": "Cheetah",<br />
"key": "Cheetah"<br />
},<br />
{<br />
"label": "Jaguar",<br />
"key": "Jaguar"<br />
},<br />
{<br />
"label": "Puma",<br />
"key": "Puma"<br />
},<br />
{<br />
"label": "Siberian Tiger",<br />
"key": "Siberian Tiger"<br />
},<br />
{<br />
"label": "Snow Leopard",<br />
"key": "Snow Leopard"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Big Five",<br />
"buckets": [<br />
{<br />
"label": "African Elephant",<br />
"key": "African Elephant"<br />
},<br />
{<br />
"label": "Black Rhinoceros",<br />
"key": "Black Rhinoceros"<br />
},<br />
{<br />
"label": "Cape Buffalo",<br />
"key": "Cape Buffalo"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Primates",<br />
"buckets": [<br />
{<br />
"label": "Chimpanzee",<br />
"key": "Chimpanzee"<br />
},<br />
{<br />
"label": "Lemurs",<br />
"key": "Lemurs"<br />
},<br />
{<br />
"label": "Mountain Gorilla",<br />
"key": "Mountain Gorilla"<br />
},<br />
{<br />
"label": "Orangutan",<br />
"key": "Orangutan"<br />
},<br />
{<br />
"label": "Western Lowland Gorilla",<br />
"key": "Western Lowland Gorilla"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Whales",<br />
"buckets": [<br />
{<br />
"label": "Beluga Whale",<br />
"key": "Beluga Whale"<br />
},<br />
{<br />
"label": "Blue Whale",<br />
"key": "Blue Whale"<br />
},<br />
{<br />
"label": "Killer Whale",<br />
"key": "Killer Whale"<br />
},<br />
{<br />
"label": "Narwhal",<br />
"key": "Narwhal"<br />
},<br />
{<br />
"label": "Sperm Whales",<br />
"key": "Sperm Whales"<br />
},<br />
{<br />
"label": "Whale Shark",<br />
"key": "Whale Shark"<br />
}<br />
]<br />
}<br />
]<br />
}<br />
]<br />
},<br />
"i": 4<br />
},<br />
{<br />
"t": "p",<br />
"c": "",<br />
"d": {},<br />
"i": 2<br />
}<br />
],<br />
"i": 3<br />
}<br />
<br />
</syntaxhighlight></div>46.16.211.253https://wiki.socialstack.dev/index.php?title=Search_Elastic&diff=514Search Elastic2023-03-28T15:32:31Z<p>46.16.211.253: /* Search taxonomy and filters/facets */</p>
<hr />
<div>The elastic search module works alongside the [[Search Crawler]] to extract pages from the site into an elastic search instance to enable site wide search<br />
<br />
The module registers itself to listen for the search crawler events and creates locale based indexes in the elastic repo for any pages it receives<br />
<br />
When indexing the pages, if there is a primary data type then this will also be indexed against the page in '''primaryObject''', this can then be used in query values as explained below<br />
<br />
The indexing process is controlled by execution of the search crawler via the site automations<br />
<br />
The module contains a Readme.txt file which gives help for the initial setup of elastic but the creation of the indexes/content are all automated.<br />
<br />
== Installation ==<br />
<br />
The basic setup steps are <br />
<br />
#Install the following socialstack modules<br />
#*Api/SearchCrawler<br />
#*Api/SearchElastic<br />
#*UI/SiteSearch<br />
#Mark any pages not to be indexed<br />
#Install Elastic Search (see '''Readme.txt''' in the repo for help and guidance)<br />
#Configure the sizing/scale in the '''elasticsearch.yml''' file (mainly vm memory usage)<br />
#Start Elastic Search for the first time and get the master password and certificate fingerprint<br />
#Add the url, credentials and fingerprint values to the module configuration via the ss admin panel<br />
#Run the automation to index the site, the indexing progress is shown via the console<br />
<br />
The module also contains a postman collection which can be used to quick debug/verify the indexed content<br />
<br />
Once indexed there is a UI/SiteSearch module which can be used as the basis of the site search<br />
<br />
== Endpoints ==<br />
<br />
=== GET /v1/sitesearch/reset ===<br />
<br />
This removes any indexes from elastic to allow a clean start<br />
<br />
=== POST /v1/sitesearch/query ===<br />
<br />
This is the core search endpoint which currently accepts the following values <br />
<br />
;queryString<br />
:The query value entered by the user and/or the '''UI/SiteSearch''' and '''UI/ContentSearch''' components, elastic search uses the Lucene query language so you can build complex queries <br />
:https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html<br />
:e.g.<br />
:<code>Africa AND primaryObject.name:Botswana</code><br />
:<code>primaryObject.price:(>=1000 AND <5000)</code><br />
:<code>((quick AND fox) OR (brown AND fox) OR fox) AND NOT dog</code><br />
<br />
;tags<br />
: This expects a list of comma separated tags, if any are supplied the query will only return results which contain all the passed tag values<br />
<br />
;contentTypes<br />
: This expects a list of comma separated content types, if any are supplied the query will only return results which contain all the passed content types, these are normally the primary data object for the page<br />
<br />
;pageSize<br />
: This expects the page size and will default to 10 if not populated<br />
<br />
;pageIndex<br />
: This expects the starting page number and will default to 1<br />
<br />
;aggregationFields<br />
: This expects a list of comma separated field names, if any are supplied then aggregations/facets are returned for the fields, a good example of this can be be found in '''UI/ContentSearch''' component<br />
<br />
== Search taxonomy and filters/facets ==<br />
You can filter or define facets(aggregations in ElasticSerach terminology) on any field<br />
<br />
A good example would be the ootb '''tags''' field<br />
<br />
But a better solution is to setup contextual tags using the '''Api/Categories''' component<br />
<br />
This allows you to give some context to a tag, so for example you could create an "Animals" category, then when adding a new tag for '''Cow''' or '''Horse''' you would set their category to be '''Animals'''<br />
<br />
If these tags are assigned to content which is later indexed as well as getting the core tag values you will also get some auto generated taxonomy fields. These can then be referenced to show an contextual filter<br />
<br />
== UI Components ==<br />
;UI/ContentSearch<br />
<br />
This provides a good example with filtering and paging<br />
<br />
The component will also allow you to override the default values/titles for any aggregation using the aggregationOverrides property, this can be useful to add grouping to values such as regions/countries etc<br />
<br />
An example is shown below<br />
<br />
<syntaxhighlight lang="json"><br />
{<br />
"c": [<br />
{<br />
"t": "UI/ContentSearch",<br />
"d": {<br />
"aggregationFields": "taxonomy.price,taxonomy.destination,taxonomy.wildlife",<br />
"contentTypes": "ItineraryPageDataType",<br />
"aggregationOverrides": [<br />
{<br />
"name": "taxonomy.price",<br />
"label": "Price",<br />
"buckets": [<br />
{<br />
"label": "&pound;3500",<br />
"key": "3500"<br />
},<br />
{<br />
"label": "&pound;5000",<br />
"key": "5000"<br />
},<br />
{<br />
"label": "&pound;7500",<br />
"key": "7500"<br />
}<br />
]<br />
},<br />
{<br />
"name": "taxonomy.destination",<br />
"label": "Destination",<br />
"columns": 3,<br />
"groups": [<br />
{<br />
"name": "Africa and the Indian Ocean",<br />
"buckets": [<br />
{<br />
"label": "Botswana",<br />
"key": "Botswana"<br />
},<br />
{<br />
"label": "Central African Republic",<br />
"key": "Central African Republic"<br />
},<br />
{<br />
"label": "Chad",<br />
"key": "Chad"<br />
},<br />
{<br />
"label": "Congo",<br />
"key": "Congo"<br />
},<br />
{<br />
"label": "Djibouti",<br />
"key": "Djibouti"<br />
},<br />
{<br />
"label": "Gabon",<br />
"key": "Gabon"<br />
},<br />
{<br />
"label": "Indian Ocean",<br />
"key": "Indian Ocean"<br />
},<br />
{<br />
"label": "Kenya",<br />
"key": "Kenya"<br />
},<br />
{<br />
"label": "Madagascar",<br />
"key": "Madagascar"<br />
},<br />
{<br />
"label": "Mozambique",<br />
"key": "Mozambique"<br />
},<br />
{<br />
"label": "Namibia",<br />
"key": "Namibia"<br />
},<br />
{<br />
"label": "Rwanda",<br />
"key": "Rwanda"<br />
},<br />
{<br />
"label": "South Africa",<br />
"key": "South Africa"<br />
},<br />
{<br />
"label": "Tanzania",<br />
"key": "Tanzania"<br />
},<br />
{<br />
"label": "Uganda",<br />
"key": "Uganda"<br />
},<br />
{<br />
"label": "Zambia",<br />
"key": "Zambia"<br />
},<br />
{<br />
"label": "Zimbabwe",<br />
"key": "Zimbabwe"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Asia",<br />
"buckets": [<br />
{<br />
"label": "Borneo",<br />
"key": "Borneo"<br />
},<br />
{<br />
"label": "India",<br />
"key": "India"<br />
},<br />
{<br />
"label": "Russia",<br />
"key": "Russia"<br />
},<br />
{<br />
"label": "Sri Lanka",<br />
"key": "Sri Lanka"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Latin America",<br />
"buckets": [<br />
{<br />
"label": "Argentina",<br />
"key": "Argentina"<br />
},<br />
{<br />
"label": "Belize",<br />
"key": "Belize"<br />
},<br />
{<br />
"label": "Brazil",<br />
"key": "Brazil"<br />
},<br />
{<br />
"label": "Chile",<br />
"key": "Chile"<br />
},<br />
{<br />
"label": "Colombia",<br />
"key": "Colombia"<br />
},<br />
{<br />
"label": "Costa Rica",<br />
"key": "Costa Rica"<br />
},<br />
{<br />
"label": "Ecuador",<br />
"key": "Ecuador"<br />
},<br />
{<br />
"label": "Galapagos",<br />
"key": "Galapagos"<br />
},<br />
{<br />
"label": "Peru",<br />
"key": "Peru"<br />
}<br />
]<br />
},<br />
{<br />
"name": "North America",<br />
"buckets": [<br />
{<br />
"label": "Alaska",<br />
"key": "Alaska"<br />
},<br />
{<br />
"label": "Canada",<br />
"key": "Canada"<br />
},<br />
{<br />
"label": "Dominica",<br />
"key": "Dominica"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Polar Regions",<br />
"buckets": [<br />
{<br />
"label": "Antarctica",<br />
"key": "Antarctica"<br />
},<br />
{<br />
"label": "Arctic Canada",<br />
"key": "Arctic Canada"<br />
},<br />
{<br />
"label": "Greenland",<br />
"key": "Greenland"<br />
},<br />
{<br />
"label": "Norway",<br />
"key": "Norway"<br />
},<br />
{<br />
"label": "Svalbard",<br />
"key": "Svalbard"<br />
},<br />
{<br />
"label": "Arctic Russia",<br />
"key": "Arctic Russia"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Australasia",<br />
"buckets": [<br />
{<br />
"label": "Australia",<br />
"key": "Australia"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Europe",<br />
"buckets": [<br />
{<br />
"label": "Scotland",<br />
"groupName": "Europe",<br />
"key": "Scotland"<br />
}<br />
]<br />
}<br />
]<br />
},<br />
{<br />
"name": "taxonomy.wildlife",<br />
"label": "Wildlife",<br />
"columns": 4,<br />
"groups": [<br />
{<br />
"name": "Bears",<br />
"buckets": [<br />
{<br />
"label": "Grizzly Bears",<br />
"key": "Grizzly Bears"<br />
},<br />
{<br />
"label": "Polar Bear",<br />
"key": "Polar Bear"<br />
},<br />
{<br />
"label": "Spirit Bear",<br />
"key": "Spirit Bear"<br />
},<br />
{<br />
"label": "Sun Bear",<br />
"key": "Sun Bear"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Big Cats",<br />
"buckets": [<br />
{<br />
"label": "African Leopard",<br />
"key": "African Leopard"<br />
},<br />
{<br />
"label": "African Lion",<br />
"key": "African Lion"<br />
},<br />
{<br />
"label": "Asiatic Leopard",<br />
"key": "Asiatic Leopard"<br />
},<br />
{<br />
"label": "Bengal Tiger",<br />
"key": "Bengal Tiger"<br />
},<br />
{<br />
"label": "Cheetah",<br />
"key": "Cheetah"<br />
},<br />
{<br />
"label": "Jaguar",<br />
"key": "Jaguar"<br />
},<br />
{<br />
"label": "Puma",<br />
"key": "Puma"<br />
},<br />
{<br />
"label": "Siberian Tiger",<br />
"key": "Siberian Tiger"<br />
},<br />
{<br />
"label": "Snow Leopard",<br />
"key": "Snow Leopard"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Big Five",<br />
"buckets": [<br />
{<br />
"label": "African Elephant",<br />
"key": "African Elephant"<br />
},<br />
{<br />
"label": "Black Rhinoceros",<br />
"key": "Black Rhinoceros"<br />
},<br />
{<br />
"label": "Cape Buffalo",<br />
"key": "Cape Buffalo"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Primates",<br />
"buckets": [<br />
{<br />
"label": "Chimpanzee",<br />
"key": "Chimpanzee"<br />
},<br />
{<br />
"label": "Lemurs",<br />
"key": "Lemurs"<br />
},<br />
{<br />
"label": "Mountain Gorilla",<br />
"key": "Mountain Gorilla"<br />
},<br />
{<br />
"label": "Orangutan",<br />
"key": "Orangutan"<br />
},<br />
{<br />
"label": "Western Lowland Gorilla",<br />
"key": "Western Lowland Gorilla"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Whales",<br />
"buckets": [<br />
{<br />
"label": "Beluga Whale",<br />
"key": "Beluga Whale"<br />
},<br />
{<br />
"label": "Blue Whale",<br />
"key": "Blue Whale"<br />
},<br />
{<br />
"label": "Killer Whale",<br />
"key": "Killer Whale"<br />
},<br />
{<br />
"label": "Narwhal",<br />
"key": "Narwhal"<br />
},<br />
{<br />
"label": "Sperm Whales",<br />
"key": "Sperm Whales"<br />
},<br />
{<br />
"label": "Whale Shark",<br />
"key": "Whale Shark"<br />
}<br />
]<br />
}<br />
]<br />
}<br />
]<br />
},<br />
"i": 4<br />
},<br />
{<br />
"t": "p",<br />
"c": "",<br />
"d": {},<br />
"i": 2<br />
}<br />
],<br />
"i": 3<br />
}<br />
<br />
</syntaxhighlight></div>46.16.211.253https://wiki.socialstack.dev/index.php?title=Search_Elastic&diff=513Search Elastic2023-03-28T15:28:51Z<p>46.16.211.253: </p>
<hr />
<div>The elastic search module works alongside the [[Search Crawler]] to extract pages from the site into an elastic search instance to enable site wide search<br />
<br />
The module registers itself to listen for the search crawler events and creates locale based indexes in the elastic repo for any pages it receives<br />
<br />
When indexing the pages, if there is a primary data type then this will also be indexed against the page in '''primaryObject''', this can then be used in query values as explained below<br />
<br />
The indexing process is controlled by execution of the search crawler via the site automations<br />
<br />
The module contains a Readme.txt file which gives help for the initial setup of elastic but the creation of the indexes/content are all automated.<br />
<br />
== Installation ==<br />
<br />
The basic setup steps are <br />
<br />
#Install the following socialstack modules<br />
#*Api/SearchCrawler<br />
#*Api/SearchElastic<br />
#*UI/SiteSearch<br />
#Mark any pages not to be indexed<br />
#Install Elastic Search (see '''Readme.txt''' in the repo for help and guidance)<br />
#Configure the sizing/scale in the '''elasticsearch.yml''' file (mainly vm memory usage)<br />
#Start Elastic Search for the first time and get the master password and certificate fingerprint<br />
#Add the url, credentials and fingerprint values to the module configuration via the ss admin panel<br />
#Run the automation to index the site, the indexing progress is shown via the console<br />
<br />
The module also contains a postman collection which can be used to quick debug/verify the indexed content<br />
<br />
Once indexed there is a UI/SiteSearch module which can be used as the basis of the site search<br />
<br />
== Endpoints ==<br />
<br />
=== GET /v1/sitesearch/reset ===<br />
<br />
This removes any indexes from elastic to allow a clean start<br />
<br />
=== POST /v1/sitesearch/query ===<br />
<br />
This is the core search endpoint which currently accepts the following values <br />
<br />
;queryString<br />
:The query value entered by the user and/or the '''UI/SiteSearch''' and '''UI/ContentSearch''' components, elastic search uses the Lucene query language so you can build complex queries <br />
:https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html<br />
:e.g.<br />
:<code>Africa AND primaryObject.name:Botswana</code><br />
:<code>primaryObject.price:(>=1000 AND <5000)</code><br />
:<code>((quick AND fox) OR (brown AND fox) OR fox) AND NOT dog</code><br />
<br />
;tags<br />
: This expects a list of comma separated tags, if any are supplied the query will only return results which contain all the passed tag values<br />
<br />
;contentTypes<br />
: This expects a list of comma separated content types, if any are supplied the query will only return results which contain all the passed content types, these are normally the primary data object for the page<br />
<br />
;pageSize<br />
: This expects the page size and will default to 10 if not populated<br />
<br />
;pageIndex<br />
: This expects the starting page number and will default to 1<br />
<br />
;aggregationFields<br />
: This expects a list of comma separated field names, if any are supplied then aggregations/facets are returned for the fields, a good example of this can be be found in '''UI/ContentSearch''' component<br />
<br />
== Search taxonomy and filters/facets ==<br />
You can filter or define facets(aggregations in ElasticSerach terminology) on any field<br />
<br />
A good example would be the ootb tags field <br />
<br />
<br />
<br />
== UI Components ==<br />
;UI/ContentSearch<br />
<br />
This provides a good example with filtering and paging<br />
<br />
The component will also allow you to override the default values/titles for any aggregation using the aggregationOverrides property, this can be useful to add grouping to values such as regions/countries etc<br />
<br />
An example is shown below<br />
<br />
<syntaxhighlight lang="json"><br />
{<br />
"c": [<br />
{<br />
"t": "UI/ContentSearch",<br />
"d": {<br />
"aggregationFields": "taxonomy.price,taxonomy.destination,taxonomy.wildlife",<br />
"contentTypes": "ItineraryPageDataType",<br />
"aggregationOverrides": [<br />
{<br />
"name": "taxonomy.price",<br />
"label": "Price",<br />
"buckets": [<br />
{<br />
"label": "&pound;3500",<br />
"key": "3500"<br />
},<br />
{<br />
"label": "&pound;5000",<br />
"key": "5000"<br />
},<br />
{<br />
"label": "&pound;7500",<br />
"key": "7500"<br />
}<br />
]<br />
},<br />
{<br />
"name": "taxonomy.destination",<br />
"label": "Destination",<br />
"columns": 3,<br />
"groups": [<br />
{<br />
"name": "Africa and the Indian Ocean",<br />
"buckets": [<br />
{<br />
"label": "Botswana",<br />
"key": "Botswana"<br />
},<br />
{<br />
"label": "Central African Republic",<br />
"key": "Central African Republic"<br />
},<br />
{<br />
"label": "Chad",<br />
"key": "Chad"<br />
},<br />
{<br />
"label": "Congo",<br />
"key": "Congo"<br />
},<br />
{<br />
"label": "Djibouti",<br />
"key": "Djibouti"<br />
},<br />
{<br />
"label": "Gabon",<br />
"key": "Gabon"<br />
},<br />
{<br />
"label": "Indian Ocean",<br />
"key": "Indian Ocean"<br />
},<br />
{<br />
"label": "Kenya",<br />
"key": "Kenya"<br />
},<br />
{<br />
"label": "Madagascar",<br />
"key": "Madagascar"<br />
},<br />
{<br />
"label": "Mozambique",<br />
"key": "Mozambique"<br />
},<br />
{<br />
"label": "Namibia",<br />
"key": "Namibia"<br />
},<br />
{<br />
"label": "Rwanda",<br />
"key": "Rwanda"<br />
},<br />
{<br />
"label": "South Africa",<br />
"key": "South Africa"<br />
},<br />
{<br />
"label": "Tanzania",<br />
"key": "Tanzania"<br />
},<br />
{<br />
"label": "Uganda",<br />
"key": "Uganda"<br />
},<br />
{<br />
"label": "Zambia",<br />
"key": "Zambia"<br />
},<br />
{<br />
"label": "Zimbabwe",<br />
"key": "Zimbabwe"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Asia",<br />
"buckets": [<br />
{<br />
"label": "Borneo",<br />
"key": "Borneo"<br />
},<br />
{<br />
"label": "India",<br />
"key": "India"<br />
},<br />
{<br />
"label": "Russia",<br />
"key": "Russia"<br />
},<br />
{<br />
"label": "Sri Lanka",<br />
"key": "Sri Lanka"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Latin America",<br />
"buckets": [<br />
{<br />
"label": "Argentina",<br />
"key": "Argentina"<br />
},<br />
{<br />
"label": "Belize",<br />
"key": "Belize"<br />
},<br />
{<br />
"label": "Brazil",<br />
"key": "Brazil"<br />
},<br />
{<br />
"label": "Chile",<br />
"key": "Chile"<br />
},<br />
{<br />
"label": "Colombia",<br />
"key": "Colombia"<br />
},<br />
{<br />
"label": "Costa Rica",<br />
"key": "Costa Rica"<br />
},<br />
{<br />
"label": "Ecuador",<br />
"key": "Ecuador"<br />
},<br />
{<br />
"label": "Galapagos",<br />
"key": "Galapagos"<br />
},<br />
{<br />
"label": "Peru",<br />
"key": "Peru"<br />
}<br />
]<br />
},<br />
{<br />
"name": "North America",<br />
"buckets": [<br />
{<br />
"label": "Alaska",<br />
"key": "Alaska"<br />
},<br />
{<br />
"label": "Canada",<br />
"key": "Canada"<br />
},<br />
{<br />
"label": "Dominica",<br />
"key": "Dominica"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Polar Regions",<br />
"buckets": [<br />
{<br />
"label": "Antarctica",<br />
"key": "Antarctica"<br />
},<br />
{<br />
"label": "Arctic Canada",<br />
"key": "Arctic Canada"<br />
},<br />
{<br />
"label": "Greenland",<br />
"key": "Greenland"<br />
},<br />
{<br />
"label": "Norway",<br />
"key": "Norway"<br />
},<br />
{<br />
"label": "Svalbard",<br />
"key": "Svalbard"<br />
},<br />
{<br />
"label": "Arctic Russia",<br />
"key": "Arctic Russia"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Australasia",<br />
"buckets": [<br />
{<br />
"label": "Australia",<br />
"key": "Australia"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Europe",<br />
"buckets": [<br />
{<br />
"label": "Scotland",<br />
"groupName": "Europe",<br />
"key": "Scotland"<br />
}<br />
]<br />
}<br />
]<br />
},<br />
{<br />
"name": "taxonomy.wildlife",<br />
"label": "Wildlife",<br />
"columns": 4,<br />
"groups": [<br />
{<br />
"name": "Bears",<br />
"buckets": [<br />
{<br />
"label": "Grizzly Bears",<br />
"key": "Grizzly Bears"<br />
},<br />
{<br />
"label": "Polar Bear",<br />
"key": "Polar Bear"<br />
},<br />
{<br />
"label": "Spirit Bear",<br />
"key": "Spirit Bear"<br />
},<br />
{<br />
"label": "Sun Bear",<br />
"key": "Sun Bear"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Big Cats",<br />
"buckets": [<br />
{<br />
"label": "African Leopard",<br />
"key": "African Leopard"<br />
},<br />
{<br />
"label": "African Lion",<br />
"key": "African Lion"<br />
},<br />
{<br />
"label": "Asiatic Leopard",<br />
"key": "Asiatic Leopard"<br />
},<br />
{<br />
"label": "Bengal Tiger",<br />
"key": "Bengal Tiger"<br />
},<br />
{<br />
"label": "Cheetah",<br />
"key": "Cheetah"<br />
},<br />
{<br />
"label": "Jaguar",<br />
"key": "Jaguar"<br />
},<br />
{<br />
"label": "Puma",<br />
"key": "Puma"<br />
},<br />
{<br />
"label": "Siberian Tiger",<br />
"key": "Siberian Tiger"<br />
},<br />
{<br />
"label": "Snow Leopard",<br />
"key": "Snow Leopard"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Big Five",<br />
"buckets": [<br />
{<br />
"label": "African Elephant",<br />
"key": "African Elephant"<br />
},<br />
{<br />
"label": "Black Rhinoceros",<br />
"key": "Black Rhinoceros"<br />
},<br />
{<br />
"label": "Cape Buffalo",<br />
"key": "Cape Buffalo"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Primates",<br />
"buckets": [<br />
{<br />
"label": "Chimpanzee",<br />
"key": "Chimpanzee"<br />
},<br />
{<br />
"label": "Lemurs",<br />
"key": "Lemurs"<br />
},<br />
{<br />
"label": "Mountain Gorilla",<br />
"key": "Mountain Gorilla"<br />
},<br />
{<br />
"label": "Orangutan",<br />
"key": "Orangutan"<br />
},<br />
{<br />
"label": "Western Lowland Gorilla",<br />
"key": "Western Lowland Gorilla"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Whales",<br />
"buckets": [<br />
{<br />
"label": "Beluga Whale",<br />
"key": "Beluga Whale"<br />
},<br />
{<br />
"label": "Blue Whale",<br />
"key": "Blue Whale"<br />
},<br />
{<br />
"label": "Killer Whale",<br />
"key": "Killer Whale"<br />
},<br />
{<br />
"label": "Narwhal",<br />
"key": "Narwhal"<br />
},<br />
{<br />
"label": "Sperm Whales",<br />
"key": "Sperm Whales"<br />
},<br />
{<br />
"label": "Whale Shark",<br />
"key": "Whale Shark"<br />
}<br />
]<br />
}<br />
]<br />
}<br />
]<br />
},<br />
"i": 4<br />
},<br />
{<br />
"t": "p",<br />
"c": "",<br />
"d": {},<br />
"i": 2<br />
}<br />
],<br />
"i": 3<br />
}<br />
<br />
</syntaxhighlight></div>46.16.211.253https://wiki.socialstack.dev/index.php?title=Search_Elastic&diff=512Search Elastic2023-03-28T15:26:42Z<p>46.16.211.253: /* UI Components */</p>
<hr />
<div>The elastic search module works alongside the [[Search Crawler]] to extract pages from the site into an elastic search instance to enable site wide search<br />
<br />
The module registers itself to listen for the search crawler events and creates locale based indexes in the elastic repo for any pages it receives<br />
<br />
When indexing the pages, if there is a primary data type then this will also be indexed against the page in '''primaryObject''', this can then be used in query values as explained below<br />
<br />
The indexing process is controlled by execution of the search crawler via the site automations<br />
<br />
The module contains a Readme.txt file which gives help for the initial setup of elastic but the creation of the indexes/content are all automated.<br />
<br />
== Installation ==<br />
<br />
The basic setup steps are <br />
<br />
#Install the following socialstack modules<br />
#*Api/SearchCrawler<br />
#*Api/SearchElastic<br />
#*UI/SiteSearch<br />
#Mark any pages not to be indexed<br />
#Install Elastic Search (see '''Readme.txt''' in the repo for help and guidance)<br />
#Configure the sizing/scale in the '''elasticsearch.yml''' file (mainly vm memory usage)<br />
#Start Elastic Search for the first time and get the master password and certificate fingerprint<br />
#Add the url, credentials and fingerprint values to the module configuration via the ss admin panel<br />
#Run the automation to index the site, the indexing progress is shown via the console<br />
<br />
The module also contains a postman collection which can be used to quick debug/verify the indexed content<br />
<br />
Once indexed there is a UI/SiteSearch module which can be used as the basis of the site search<br />
<br />
== Endpoints ==<br />
<br />
=== GET /v1/sitesearch/reset ===<br />
<br />
This removes any indexes from elastic to allow a clean start<br />
<br />
=== POST /v1/sitesearch/query ===<br />
<br />
This is the core search endpoint which currently accepts the following values <br />
<br />
;queryString<br />
:The query value entered by the user and/or the '''UI/SiteSearch''' and '''UI/ContentSearch''' components, elastic search uses the Lucene query language so you can build complex queries <br />
:https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html<br />
:e.g.<br />
:<code>Africa AND primaryObject.name:Botswana</code><br />
:<code>primaryObject.price:(>=1000 AND <5000)</code><br />
:<code>((quick AND fox) OR (brown AND fox) OR fox) AND NOT dog</code><br />
<br />
;tags<br />
: This expects a list of comma separated tags, if any are supplied the query will only return results which contain all the passed tag values<br />
<br />
;contentTypes<br />
: This expects a list of comma separated content types, if any are supplied the query will only return results which contain all the passed content types, these are normally the primary data object for the page<br />
<br />
;pageSize<br />
: This expects the page size and will default to 10 if not populated<br />
<br />
;pageIndex<br />
: This expects the starting page number and will default to 1<br />
<br />
;aggregationFields<br />
: This expects a list of comma separated field names, if any are supplied then aggregations/facets are returned for the fields, a good example of this can be be found in '''UI/ContentSearch''' component<br />
<br />
== UI Components ==<br />
;UI/ContentSearch<br />
<br />
This provides a good example with filtering and paging<br />
<br />
The component will also allow you to override the default values/titles for any aggregation using the aggregationOverrides property, this can be useful to add grouping to values such as regions/countries etc<br />
<br />
An example is shown below<br />
<br />
<syntaxhighlight lang="json"><br />
{<br />
"c": [<br />
{<br />
"t": "UI/ContentSearch",<br />
"d": {<br />
"aggregationFields": "taxonomy.price,taxonomy.destination,taxonomy.wildlife",<br />
"contentTypes": "ItineraryPageDataType",<br />
"aggregationOverrides": [<br />
{<br />
"name": "taxonomy.price",<br />
"label": "Price",<br />
"buckets": [<br />
{<br />
"label": "&pound;3500",<br />
"key": "3500"<br />
},<br />
{<br />
"label": "&pound;5000",<br />
"key": "5000"<br />
},<br />
{<br />
"label": "&pound;7500",<br />
"key": "7500"<br />
}<br />
]<br />
},<br />
{<br />
"name": "taxonomy.destination",<br />
"label": "Destination",<br />
"columns": 3,<br />
"groups": [<br />
{<br />
"name": "Africa and the Indian Ocean",<br />
"buckets": [<br />
{<br />
"label": "Botswana",<br />
"key": "Botswana"<br />
},<br />
{<br />
"label": "Central African Republic",<br />
"key": "Central African Republic"<br />
},<br />
{<br />
"label": "Chad",<br />
"key": "Chad"<br />
},<br />
{<br />
"label": "Congo",<br />
"key": "Congo"<br />
},<br />
{<br />
"label": "Djibouti",<br />
"key": "Djibouti"<br />
},<br />
{<br />
"label": "Gabon",<br />
"key": "Gabon"<br />
},<br />
{<br />
"label": "Indian Ocean",<br />
"key": "Indian Ocean"<br />
},<br />
{<br />
"label": "Kenya",<br />
"key": "Kenya"<br />
},<br />
{<br />
"label": "Madagascar",<br />
"key": "Madagascar"<br />
},<br />
{<br />
"label": "Mozambique",<br />
"key": "Mozambique"<br />
},<br />
{<br />
"label": "Namibia",<br />
"key": "Namibia"<br />
},<br />
{<br />
"label": "Rwanda",<br />
"key": "Rwanda"<br />
},<br />
{<br />
"label": "South Africa",<br />
"key": "South Africa"<br />
},<br />
{<br />
"label": "Tanzania",<br />
"key": "Tanzania"<br />
},<br />
{<br />
"label": "Uganda",<br />
"key": "Uganda"<br />
},<br />
{<br />
"label": "Zambia",<br />
"key": "Zambia"<br />
},<br />
{<br />
"label": "Zimbabwe",<br />
"key": "Zimbabwe"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Asia",<br />
"buckets": [<br />
{<br />
"label": "Borneo",<br />
"key": "Borneo"<br />
},<br />
{<br />
"label": "India",<br />
"key": "India"<br />
},<br />
{<br />
"label": "Russia",<br />
"key": "Russia"<br />
},<br />
{<br />
"label": "Sri Lanka",<br />
"key": "Sri Lanka"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Latin America",<br />
"buckets": [<br />
{<br />
"label": "Argentina",<br />
"key": "Argentina"<br />
},<br />
{<br />
"label": "Belize",<br />
"key": "Belize"<br />
},<br />
{<br />
"label": "Brazil",<br />
"key": "Brazil"<br />
},<br />
{<br />
"label": "Chile",<br />
"key": "Chile"<br />
},<br />
{<br />
"label": "Colombia",<br />
"key": "Colombia"<br />
},<br />
{<br />
"label": "Costa Rica",<br />
"key": "Costa Rica"<br />
},<br />
{<br />
"label": "Ecuador",<br />
"key": "Ecuador"<br />
},<br />
{<br />
"label": "Galapagos",<br />
"key": "Galapagos"<br />
},<br />
{<br />
"label": "Peru",<br />
"key": "Peru"<br />
}<br />
]<br />
},<br />
{<br />
"name": "North America",<br />
"buckets": [<br />
{<br />
"label": "Alaska",<br />
"key": "Alaska"<br />
},<br />
{<br />
"label": "Canada",<br />
"key": "Canada"<br />
},<br />
{<br />
"label": "Dominica",<br />
"key": "Dominica"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Polar Regions",<br />
"buckets": [<br />
{<br />
"label": "Antarctica",<br />
"key": "Antarctica"<br />
},<br />
{<br />
"label": "Arctic Canada",<br />
"key": "Arctic Canada"<br />
},<br />
{<br />
"label": "Greenland",<br />
"key": "Greenland"<br />
},<br />
{<br />
"label": "Norway",<br />
"key": "Norway"<br />
},<br />
{<br />
"label": "Svalbard",<br />
"key": "Svalbard"<br />
},<br />
{<br />
"label": "Arctic Russia",<br />
"key": "Arctic Russia"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Australasia",<br />
"buckets": [<br />
{<br />
"label": "Australia",<br />
"key": "Australia"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Europe",<br />
"buckets": [<br />
{<br />
"label": "Scotland",<br />
"groupName": "Europe",<br />
"key": "Scotland"<br />
}<br />
]<br />
}<br />
]<br />
},<br />
{<br />
"name": "taxonomy.wildlife",<br />
"label": "Wildlife",<br />
"columns": 4,<br />
"groups": [<br />
{<br />
"name": "Bears",<br />
"buckets": [<br />
{<br />
"label": "Grizzly Bears",<br />
"key": "Grizzly Bears"<br />
},<br />
{<br />
"label": "Polar Bear",<br />
"key": "Polar Bear"<br />
},<br />
{<br />
"label": "Spirit Bear",<br />
"key": "Spirit Bear"<br />
},<br />
{<br />
"label": "Sun Bear",<br />
"key": "Sun Bear"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Big Cats",<br />
"buckets": [<br />
{<br />
"label": "African Leopard",<br />
"key": "African Leopard"<br />
},<br />
{<br />
"label": "African Lion",<br />
"key": "African Lion"<br />
},<br />
{<br />
"label": "Asiatic Leopard",<br />
"key": "Asiatic Leopard"<br />
},<br />
{<br />
"label": "Bengal Tiger",<br />
"key": "Bengal Tiger"<br />
},<br />
{<br />
"label": "Cheetah",<br />
"key": "Cheetah"<br />
},<br />
{<br />
"label": "Jaguar",<br />
"key": "Jaguar"<br />
},<br />
{<br />
"label": "Puma",<br />
"key": "Puma"<br />
},<br />
{<br />
"label": "Siberian Tiger",<br />
"key": "Siberian Tiger"<br />
},<br />
{<br />
"label": "Snow Leopard",<br />
"key": "Snow Leopard"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Big Five",<br />
"buckets": [<br />
{<br />
"label": "African Elephant",<br />
"key": "African Elephant"<br />
},<br />
{<br />
"label": "Black Rhinoceros",<br />
"key": "Black Rhinoceros"<br />
},<br />
{<br />
"label": "Cape Buffalo",<br />
"key": "Cape Buffalo"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Primates",<br />
"buckets": [<br />
{<br />
"label": "Chimpanzee",<br />
"key": "Chimpanzee"<br />
},<br />
{<br />
"label": "Lemurs",<br />
"key": "Lemurs"<br />
},<br />
{<br />
"label": "Mountain Gorilla",<br />
"key": "Mountain Gorilla"<br />
},<br />
{<br />
"label": "Orangutan",<br />
"key": "Orangutan"<br />
},<br />
{<br />
"label": "Western Lowland Gorilla",<br />
"key": "Western Lowland Gorilla"<br />
}<br />
]<br />
},<br />
{<br />
"name": "Whales",<br />
"buckets": [<br />
{<br />
"label": "Beluga Whale",<br />
"key": "Beluga Whale"<br />
},<br />
{<br />
"label": "Blue Whale",<br />
"key": "Blue Whale"<br />
},<br />
{<br />
"label": "Killer Whale",<br />
"key": "Killer Whale"<br />
},<br />
{<br />
"label": "Narwhal",<br />
"key": "Narwhal"<br />
},<br />
{<br />
"label": "Sperm Whales",<br />
"key": "Sperm Whales"<br />
},<br />
{<br />
"label": "Whale Shark",<br />
"key": "Whale Shark"<br />
}<br />
]<br />
}<br />
]<br />
}<br />
]<br />
},<br />
"i": 4<br />
},<br />
{<br />
"t": "p",<br />
"c": "",<br />
"d": {},<br />
"i": 2<br />
}<br />
],<br />
"i": 3<br />
}<br />
<br />
</syntaxhighlight></div>46.16.211.253