Full Text Search

4 min

A full text search is a search that is accessible from any page and runs on all configured tables. The search results will be presented on a single page split into the respective tables the search found results in.

If configured, you can use full text search, by left clicking on the top right hand corner of your Servicely screen where you see a magnifying glass icon. Screenshot below:

Restricting Access

To use this functionality, you need to be on Version 1.10 or later.

To restrict access to the search functionality, you can create/update a string application property called system.search.role_required. If this is blank, all users will be able to access this feature. However, it will typically be a role as a value, such as platform_agent.

Configure table

To configure a table to be available for Full text search capability, navigate to:

Administration > Full text search > Full text search configuration

Create a new record and then populate the following fields:

Field	Description	Example value
Name	Name of the configuration entry, you should name it the same as the Target table	ITSMRequest
Target Table	The table full text search should search on	ITSMRequest
Order	The order the search result will appear in, in ascending order	100
Active		Yes
Template	HTML formatted template with reference to information returned by the processing script. This template defines how the search results will be presented visually for this table on the search result page. Example below.
Processing script	Script to retrieve required information from nominated fields. Example below.

Sample template

HTML and Angular knowledge is recommended

NOTE:

the variables in the enclosed {{ }} brackets are the parameters in the answer JSON variable on the sample processing script.
you may create a new CSS class (or more) on a Portal Style linked to the Portal Definition record for your Servicely environment (this would have been set-up as part of your environment’s branding, refer to BrandingBranding. That CSS class can then be used on the HTML Template here.

<div class="servicely-search-result-content">
    <h2><a href="{{data._link}}">{{Number}}</a></h2>
    <div class="servicely-demo-search-results"><span>Short description</span><b>{{ShortDescription}}</b></div>
    <div class="servicely-demo-search-results"><span>Priority</span><span><b>{{Priority}}</b></span></div>
    <div class="servicely-demo-search-results"><span>Requestor</span><span><b>{{Requestor}}</b></span></div>
    <div class="servicely-demo-search-results"><span>RequestedFor</span><span><b>{{RequestedFor}}</b></span></div>
</div>

Sample processing script

Javascript knowledge is recommended

NOTE: the variable current refers to the individual records returned by the full text search. So if the search is searching on ITSMRequest table, current refers to a ITSMRequest record. The syntax on accessing the available fields from the current object is the same as server side scripting outlined here Table API (Server)Table API (Server)

answer = {
    Number: current.Number(),
    Requestor: current.Requestor.displayValue(),
    RequestedFor: current.RequestedFor.displayValue(),
    Priority: current.Priority.displayValue(),
    ShortDescription: current.ShortDescription()
};