Search Studio

Last modified on 2022/12/28 10:33

From : Service Manager versions later than 2016

     Open url.png See versions 2016 and earlier.

Definition

For each meta-object, e.g. Employee, CI or Equipment, you can use the Search Studio to configure the results displayed for predictive entry and the dedicated search results page displayed via Display popup icon.png Search in Grid mode.

  • Meta-objects are associated with a table and the fields of a parent query.
  • Entries in the Search Studio are accessible depending on authorized profiles.
EndDefinition

Possible configurations for each meta-object

Fields displayed by predictive entry

Predictive entry is used to display a list of values progressively as you enter the characters searched for. It is used in the search field in the top banner when you search for an object or when you call a quick access command.

You can configure the fields to be displayed in the list of values in the Search Studio. Each meta-object can have its own configuration.

example

  • Search for objects containing mic  ==>  Predictive entry will display the list of results based on the display setup of each meta-object.
    • Employee meta-object: Display the name, phone number, location, department or function.
    • CI meta-object: Display the name, type, model or status.
               Predictive entry - Example 1.png
       
  • Run the quick access command, Search for an employee /E  ==>  Predictive entry will display the list of results based on the display setup of the Employee meta-object.
             Predictive entry - Example 2.png

Fields displayed in the dedicated search results page (Grid mode)

You can use the Search Studio to configure the list of fields in the dedicated search results page displayed via Display popup icon.png Search based on the meta-object called.
Note: You open the page in Grid mode.
         Field search - Switch to grid mode.png

example  

  • Employee meta-object: Display the name, phone number, location, department or function.
  • CI meta-object: Display the name, type, model or status.

         Field search - Example.png

Notes

  • The list of meta-objects is provided by EasyVista. You cannot create a new one or delete an existing one.
  • By default, only active meta-objects will appear. Use the Filters drop-down list to display all meta-objects.
  • The limitations below are applied to the Search Studio to ensure optimal performance:
    • Maximum 12 concurrent active searches
    • Maximum eight fields displayed in List mode
    • Maximum six fields for predictive entry

Caution

  • Users can only view meta-objects in the menus they are authorized by their profile to access.

    example  

    • Users authorized by their profile to access the Employees menu
      • They can run the /E command to search for an employee.
      • They can use the /E mic command to display all employees whose name starts with mic in the search results.
    • Users not authorized by their profile to access the Employees menu
      • The /E command will not return any result.
      • The search results will not return any employee when they run a search using mic.
  • To ensure that they are available in the full text search, fields must be indexed in the Service Manager database.
  • Only fields from the main table associated with the meta-object to be configured can be indexed.

    example  Configuration of the Equipment meta-object associated with the main table, AM_ASSET

    • The Network Identifier field (AM_ASSET.NETWORK_IDENTIFIER) is in the meta-object and is part of the main table, AM_ASSET ==> This field can be indexed and users can run a search on the network ID.
    • The Manufacturer field (AM.MANUFACTURER.MANUFACTURER) is in the meta-object but is not part of the main table, AM_ASSET ==> This field cannot be indexed and users cannot run a search on the manufacturer.

Best Practice

  • Run the Disable wizard to hide a meta-object in the search results.
  • Run the Enable wizard to reuse a previously disabled meta-object.

Menu access

Administration > Studio > Search Studio

Screen description

         Search studio.png

Main Table: Main table associated with the meta-object to be configured.

    example    

  • Employee meta-object ==> AM_EMPLOYEE table
  • Equipment, CI, Licenses meta-objects ==> AM_ASSET table
     

Query Name: Parent query used for configuring the search.
    example    

  • Search for employees ==> Reporting_Employees query
     

Fields List pane: List of fields in the parent query.

  • Field Label: Name of the field in the database.
    • Click a field to make it available for configuring the search. It will automatically be highlighted in Selected field color.png and added to the Display Setup pane.
    • Click one of the rows highlighted in Selected field color.png to make it unavailable. It will automatically disappear from the Display Setup pane.
  • Field Name: Physical name of the field in the data model.
  • Indexed: The Index key icon.png icon shows that the field is indexed in the Service Manager database and can be used in the full text search.
    • You must select one or more indexed fields for configuring the search.
    • Only fields from the main table associated with the meta-object to be configured can be indexed.
  • Type: Type of field, e.g. string, integer, etc.
     

Display Setup pane: List of fields available for configuring the results displayed for predictive entry and the dedicated search results page. Open url.png See the description.

  • Indexed: The Index key icon.png icon shows that the field is indexed in the Service Manager database and can be used in the full text search.
  • Field Label: Name of the field in the database.
    • Click Delete red icon.png in the relevant row if you do not want to display this field in the search results. It will automatically be moved to the Fields List pane.
  • Display Label: Used to indicate if the field name should be displayed in the search results (box is checked) or not (box is not checked).
    • Note: This configuration applies only to the display of predictive entry results.

Procedure and Wizards

How to configure a meta-object

Step 1: Open the Search Studio.

1. Select Administration > Studio > Search Studio in the menu.

2. Select the meta-object you want.

Step 2: Select the fields for displaying the search results.

1. Select the main table and parent query used by the meta-object.
The Fields List pane will be refreshed.

2. Select the relevant fields in the parent query.
They will automatically appear in the Display Setup pane.

    Notes

  • You must select one or more indexed fields in the Fields List pane.
  • Only fields from the main table associated with the meta-object to be configured can be indexed.
     

Step 3: Configure the display of search results.

1. (Note: Only for predictive entry) Click Display Label if you want to display the field name in the search results.

2. Click and drag to move the fields up or down within the list to define the order in which they should be displayed.

3. Click Delete red icon.png to remove a field from the search results.
It will automatically be moved to the Fields List pane.

4. Click Save.

Step 4: Check that the display of the meta-object is correctly configured.

Predictive entry results
1. Search for a meta-object via Display popup icon.png Search in the top banner.
Predictive entry displays a list of results for each active meta-object.

2. Check that the meta-object information displayed in the results corresponds to your configuration.

Dedicated search results page
1. Switch to Grid mode.
The results are displayed for each active meta-object.

2. Check that the meta-object information displayed in the results corresponds to your configuration.

How to enable a meta-object again

1. Select the Disabled filter or All filter from the Filters drop-down list.
Disabled meta-objects will appear in the list.

2. Select the meta-object you want.

3. Run the Enable wizard.
The display configuration for the meta-object will once again be enabled.

Wizards

Enable
Disable

Examples on how to configure the display

Predictive entry results

Configuration Results
Configuration - Example 1.png Configuration predictive entry example 1 - Result.png
Configuration - Example 2.png Configuration predictive entry example 2 - Result.png

Dedicated search results page (Grid mode)

Configuration Results
Configuration - Example 1.png Configuration field search example 1 - Result.png
Configuration - Example 2.png Configuration field search example 2 - Result.png
Tags:
Powered by XWiki © EasyVista 2022