This widget belongs to the EasyVista category in the widget library. Connected to one or more data sources linked to
, it enables you to filter data using a dynamic search field linked to one or more columns in the data source.
- The search is run on
menu items, in discussions and in the knowledge base. - The widget applies the search criteria to the different data sources simultaneously.
- You can define an app page specifically for displaying search results.
Notes
See General remarks on widgets.
- The widget can point to the following data sources:
- You can select up to five search fields in each data source linked to the widget. The list of columns in the data source that can be used as search criteria is defined by
. You cannot modify it. - In execute mode, the search will apply to all widgets in the app using the same EasyVista data sources as the those defined for the Search Filter widget, e.g. Dashboards widget or Data Viewer widget.
Best practice
- You should use the Search Filter widget to enable users to filter
data using a dynamic search field and a Filter List widget to enable users to consult the data using a list of dynamic filters. You can combine these two widgets when they are both linked to the same EasyVista data source. - You can modify the graphic properties of the different widget elements, e.g. font, size, alignment, or color, using the Theme section and the Theme > Search section for the overall configuration.
Examples
- Run a search in the employee directory using several search criteria, e.g. login, email, function and department.

- Run a search using several data sources.
- (1) Bar Chart and Data Viewer widgets pointing to an EasyVista data source called All Problems.
- (2) Data Viewer widget pointing to an EasyVista data source called All Incidents.
|
Search using the Open filter for all records from both data sources.
|
Example2
- Run a search combining a Search Filter widget and a Filter List widget pointing to the same EasyVista data source.
Enter the keyword, failure, to search for incidents using the Search Filter widget (1). The Bar Chart widget and Data Viewer widget pointing to the same EasyVista data source will automatically be refreshed. |
Select the Open filter in the list of incidents to display only those that are open using the Filter List widget (2). Both widgets will automatically be refreshed. |
 |
 |
Example2_End
List of properties
Content
Device Native Style: If the app is designed for use on a smartphone (Android or iPhone), this indicates if the widget should be displayed according to the style guide of the smartphone browser (box is checked) or according to the standard
style (box is not checked).
Box is checked (smartphone mode: Android or iPhone) |
Box is not checked (standard mode) |

|

|
Failed to execute the [include] macro
org.xwiki.rendering.macro.MacroExecutionException: Cannot find section [HSearchPlaceholder] in document [wiki:Documentation.Apps - Common Properties Widgets]
at org.xwiki.rendering.internal.macro.include.IncludeMacro.execute(IncludeMacro.java:197)
at org.xwiki.rendering.internal.macro.include.IncludeMacro.execute(IncludeMacro.java:55)
at org.xwiki.rendering.internal.transformation.macro.MacroTransformation.transform(MacroTransformation.java:251)
at org.xwiki.rendering.internal.transformation.DefaultRenderingContext.transformInContext(DefaultRenderingContext.java:183)
at org.xwiki.rendering.internal.transformation.DefaultTransformationManager.performTransformations(DefaultTransformationManager.java:94)
at org.xwiki.display.internal.DocumentContentDisplayer.display(DocumentContentDisplayer.java:252)
at org.xwiki.display.internal.DocumentContentDisplayer.display(DocumentContentDisplayer.java:125)
at org.xwiki.display.internal.DocumentContentDisplayer.display(DocumentContentDisplayer.java:55)
at org.xwiki.display.internal.DefaultDocumentDisplayer.display(DefaultDocumentDisplayer.java:96)
at org.xwiki.display.internal.DefaultDocumentDisplayer.display(DefaultDocumentDisplayer.java:39)
at org.xwiki.sheet.internal.SheetDocumentDisplayer.display(SheetDocumentDisplayer.java:113)
at org.xwiki.sheet.internal.SheetDocumentDisplayer.display(SheetDocumentDisplayer.java:50)
at org.xwiki.display.internal.ConfiguredDocumentDisplayer.display(ConfiguredDocumentDisplayer.java:67)
at org.xwiki.display.internal.ConfiguredDocumentDisplayer.display(ConfiguredDocumentDisplayer.java:41)
at com.xpn.xwiki.doc.XWikiDocument.getRenderedContent(XWikiDocument.java:1100)
at com.xpn.xwiki.doc.XWikiDocument.getRenderedContent(XWikiDocument.java:1078)
at com.xpn.xwiki.doc.XWikiDocument.getRenderedContent(XWikiDocument.java:1110)
at com.xpn.xwiki.api.Document.getRenderedContent(Document.java:618)
at sun.reflect.GeneratedMethodAccessor383.invoke(Unknown Source)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
at java.lang.reflect.Method.invoke(Method.java:606)
at org.apache.velocity.util.introspection.UberspectImpl$VelMethodImpl.doInvoke(UberspectImpl.java:395)
at org.apache.velocity.util.introspection.UberspectImpl$VelMethodImpl.invoke(UberspectImpl.java:384)
at org.apache.velocity.runtime.parser.node.ASTMethod.execute(ASTMethod.java:173)
at org.apache.velocity.runtime.parser.node.ASTReference.execute(ASTReference.java:280)
at org.apache.velocity.runtime.parser.node.ASTReference.value(ASTReference.java:567)
at org.apache.velocity.runtime.parser.node.ASTExpression.value(ASTExpression.java:71)
at org.apache.velocity.runtime.parser.node.ASTSetDirective.render(ASTSetDirective.java:142)
at org.apache.velocity.runtime.parser.node.ASTBlock.render(ASTBlock.java:72)
at org.apache.velocity.runtime.parser.node.SimpleNode.render(SimpleNode.java:342)
at org.apache.velocity.runtime.parser.node.ASTIfStatement.render(ASTIfStatement.java:106)
at org.apache.velocity.runtime.parser.node.SimpleNode.render(SimpleNode.java:342)
at org.xwiki.velocity.internal.DefaultVelocityEngine.evaluate(DefaultVelocityEngine.java:238)
at org.xwiki.velocity.internal.DefaultVelocityEngine.evaluate(DefaultVelocityEngine.java:193)
at com.xpn.xwiki.render.XWikiVelocityRenderer.evaluate(XWikiVelocityRenderer.java:131)
at com.xpn.xwiki.XWiki.parseTemplate(XWiki.java:1666)
at com.xpn.xwiki.XWiki.evaluateTemplate(XWiki.java:1593)
at com.xpn.xwiki.XWiki.parseTemplate(XWiki.java:1570)
at com.xpn.xwiki.api.XWiki.parseTemplate(XWiki.java:801)
at sun.reflect.GeneratedMethodAccessor179.invoke(Unknown Source)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
at java.lang.reflect.Method.invoke(Method.java:606)
at org.apache.velocity.util.introspection.UberspectImpl$VelMethodImpl.doInvoke(UberspectImpl.java:395)
at org.apache.velocity.util.introspection.UberspectImpl$VelMethodImpl.invoke(UberspectImpl.java:384)
at org.apache.velocity.runtime.parser.node.ASTMethod.execute(ASTMethod.java:173)
at org.apache.velocity.runtime.parser.node.ASTReference.execute(ASTReference.java:280)
at org.apache.velocity.runtime.parser.node.ASTReference.render(ASTReference.java:369)
at org.apache.velocity.runtime.parser.node.ASTBlock.render(ASTBlock.java:72)
at org.apache.velocity.runtime.directive.VelocimacroProxy.render(VelocimacroProxy.java:216)
at org.apache.velocity.runtime.directive.RuntimeMacro.render(RuntimeMacro.java:311)
at org.apache.velocity.runtime.directive.RuntimeMacro.render(RuntimeMacro.java:230)
at org.apache.velocity.runtime.parser.node.ASTDirective.render(ASTDirective.java:207)
at org.apache.velocity.runtime.parser.node.ASTBlock.render(ASTBlock.java:72)
at org.apache.velocity.runtime.parser.node.ASTIfStatement.render(ASTIfStatement.java:87)
at org.apache.velocity.runtime.parser.node.ASTBlock.render(ASTBlock.java:72)
at org.apache.velocity.runtime.parser.node.SimpleNode.render(SimpleNode.java:342)
at org.apache.velocity.runtime.parser.node.ASTIfStatement.render(ASTIfStatement.java:106)
at org.apache.velocity.runtime.parser.node.SimpleNode.render(SimpleNode.java:342)
at org.xwiki.velocity.internal.DefaultVelocityEngine.evaluate(DefaultVelocityEngine.java:238)
at org.xwiki.velocity.internal.DefaultVelocityEngine.evaluate(DefaultVelocityEngine.java:193)
at com.xpn.xwiki.render.XWikiVelocityRenderer.evaluate(XWikiVelocityRenderer.java:131)
at com.xpn.xwiki.XWiki.parseTemplate(XWiki.java:1686)
at com.xpn.xwiki.XWiki.evaluateTemplate(XWiki.java:1602)
at com.xpn.xwiki.web.Utils.parseTemplate(Utils.java:179)
at com.xpn.xwiki.web.XWikiAction.execute(XWikiAction.java:358)
at com.xpn.xwiki.web.XWikiAction.execute(XWikiAction.java:149)
at org.apache.struts.action.RequestProcessor.processActionPerform(RequestProcessor.java:425)
at org.apache.struts.action.RequestProcessor.process(RequestProcessor.java:228)
at org.apache.struts.action.ActionServlet.process(ActionServlet.java:1913)
at org.apache.struts.action.ActionServlet.doGet(ActionServlet.java:449)
at javax.servlet.http.HttpServlet.service(HttpServlet.java:617)
at javax.servlet.http.HttpServlet.service(HttpServlet.java:717)
at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:290)
at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:206)
at com.xpn.xwiki.web.ActionFilter.doFilter(ActionFilter.java:115)
at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:235)
at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:206)
at org.xwiki.wysiwyg.server.filter.ConversionFilter.doFilter(ConversionFilter.java:126)
at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:235)
at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:206)
at org.xwiki.container.servlet.filters.internal.SetHTTPHeaderFilter.doFilter(SetHTTPHeaderFilter.java:63)
at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:235)
at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:206)
at com.xpn.xwiki.plugin.webdav.XWikiDavFilter.doFilter(XWikiDavFilter.java:66)
at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:235)
at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:206)
at org.xwiki.container.servlet.filters.internal.SavedRequestRestorerFilter.doFilter(SavedRequestRestorerFilter.java:208)
at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:235)
at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:206)
at org.xwiki.container.servlet.filters.internal.SetCharacterEncodingFilter.doFilter(SetCharacterEncodingFilter.java:111)
at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:235)
at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:206)
at net.bull.javamelody.MonitoringFilter.doFilter(MonitoringFilter.java:198)
at net.bull.javamelody.MonitoringFilter.doFilter(MonitoringFilter.java:176)
at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:235)
at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:206)
at org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:233)
at org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:191)
at org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:127)
at org.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:103)
at org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:109)
at org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:293)
at org.apache.jk.server.JkCoyoteHandler.invoke(JkCoyoteHandler.java:190)
at org.apache.jk.common.HandlerRequest.invoke(HandlerRequest.java:311)
at org.apache.jk.common.ChannelSocket.invoke(ChannelSocket.java:776)
at org.apache.jk.common.ChannelSocket.processConnection(ChannelSocket.java:705)
at org.apache.jk.common.ChannelSocket$SocketConnection.runIt(ChannelSocket.java:898)
at org.apache.tomcat.util.threads.ThreadPool$ControlRunnable.run(ThreadPool.java:690)
at java.lang.Thread.run(Thread.java:745)
Caused by: java.lang.RuntimeException: Cannot find section [HSearchPlaceholder] in document [wiki:Documentation.Apps - Common Properties Widgets]
at org.xwiki.display.internal.DocumentContentDisplayer.getContent(DocumentContentDisplayer.java:282)
at org.xwiki.display.internal.DocumentContentDisplayer.display(DocumentContentDisplayer.java:237)
at org.xwiki.display.internal.DocumentContentDisplayer.display(DocumentContentDisplayer.java:125)
at org.xwiki.display.internal.DocumentContentDisplayer.display(DocumentContentDisplayer.java:55)
at org.xwiki.display.internal.DefaultDocumentDisplayer.display(DefaultDocumentDisplayer.java:96)
at org.xwiki.display.internal.DefaultDocumentDisplayer.display(DefaultDocumentDisplayer.java:39)
at org.xwiki.sheet.internal.SheetDocumentDisplayer.display(SheetDocumentDisplayer.java:113)
at org.xwiki.sheet.internal.SheetDocumentDisplayer.display(SheetDocumentDisplayer.java:50)
at org.xwiki.display.internal.ConfiguredDocumentDisplayer.display(ConfiguredDocumentDisplayer.java:67)
at org.xwiki.display.internal.ConfiguredDocumentDisplayer.display(ConfiguredDocumentDisplayer.java:41)
at org.xwiki.rendering.internal.macro.include.IncludeMacro.execute(IncludeMacro.java:195)
... 108 more
Clear Search Input: Used to indicate (box is checked) or not (box is not checked).
Target Page: Page defined specifically for displaying search results.
- Click
to open the page in the Design pane. - Click
to cancel the page selection.
Data Source And Fields: List of data sources and fields where the search will be run.

- To add a data source, click [ ADD ITEM ].
: Used to modify or view the contents of the data source.
: Used to remove the data source. All previously selected fields will be cleared from the search criteria.
: Used to modify the order of data sources when running the search.
- Search Fields: List of data source columns in which records are searched.
- Click
to delete one of the selected columns.
Theme
See the description of properties.
1. In the drop-down list found below the Data Source And Fields property, select the EasyVista data source from which you want to select the widget's search criteria.
2. Click Search Fields and select each data source field to be used as a search criterion. Click
next to the name to delete one of them.
3. If you want to run a search on data from another data source, click [ ADD ITEM ] and select the relevant data source and its fields.
4. Define the graphic properties of the widget by selecting the required elements in the Theme section.
5. Define the widgets for displaying the search results. If you want to insert them in a different page, select the page from the Target Page list.
6. Switch to execute mode and check the workability of the widget.