Difference between revisions of "Search"

From AgileApps Support Wiki
imported>Aeric
Β 
(34 intermediate revisions by 2 users not shown)
Line 1: Line 1:
The search action finds all records in the platform that match specified keywords. Users can create simple keyword searches or build advanced search criteria to locate records in [[Objects]]. Β 
__TOC__
===About Search===
A search action finds all records in the platform that contain the characters or words you specify. If the specified characters appear in any field in a record, the record is displayed. Β 


;Considerations: Β 
;Considerations: Β 
:*Improve search speed and performance by configuring ''Search Fields'' to create an index for the object<br>''Learn more:'' [[Record Locator]]s
:*To search in specific fields, or to create more complex searches, you'll want to [[HowTo:Filter a View to Restrict the Records it Displays|Filter a View to Restrict the Records it Displays]].
:*It is possible to conduct a simple keyword search from any tab, but only certain tabs support [[#Advanced Search|Advanced Search]]
:*Improve search speed and performance by configuring ''Search Fields'' to create an index for the object<br>''Learn more:'' [[Record Locator]] Β 
:*The [[Calendar]] and [[Reports]] objects are excluded from Search
:*[[Data Access Permissions]] determine which records are visible to a given user
:*[[Available Permission Rights|Permission Rights]] associated with [[Role]]s determine whether a particular record is visible to the user
:* A specific syntax is required to search using a [[Multi Object Lookup]] field.<br>''Learn more:'' [[Multi Object Lookup#Considerations]]
:* A specific syntax is required to search using a [[Multi Object Lookup]] field.<br>''Learn more:'' [[Multi Object Lookup#Considerations]]
:* When searching for a keyword in Rich Text Area and the keyword is beyond 1024 characters (this includes the associated field configured in the search fields section in object's Record Locator), then the keyword is not considered by the search engine. The system has a limitation in the search fields on the Record Locator to 1024 characters.


==How to Search==
===Doing a Search===
Learn to search the platform effectively:
'''In the Old UI'''
# Enter a search term (an Account Name, Contact name, etc.) in the Search field:
#: [[File:SearchBar.png]]
# Click the down arrow at the end of the field to specify the objects in which you want to search the entered value.
# Click Search or click the Magnifier Glass icon [[File:MagnifierIcon.png]]
<noinclude>


*[[#Simple Keyword Search|Simple Keyword Search]]
'''In the New UI'''
*[[#Search within an Object|Search within an Object]]
# Enter a search term (an Account Name, Contact name, etc.) in the Search field:
*[[#Search in All Objects|Search in All Objects]]
#: <br>[[File:Search_Field_Empty.png|1000px]]<br>
#: '''Note:''' The side overlay pane appears with the object list once you click on the Search bar.
# You can perform the search in two different ways:
#:* Providing the Search Text on the Search bar with no changes in the object list displayed in the side overlay pane.
#: '''Note:''' Once you provide the search term in the Search field and hit Enter, the search engine performs the search in all the objects listed in the side overlay pane, by default.<br><br>[[File:Search_when_no_objects_are_selected_01.png|1000px]]<br><br>
#:* Updating the object list by checking the specific objects listed in the side overlay pane.<br><br>[[File:Searching_Text_in_Specific_Objects.png|1000px]]<br><br>You can update the object list by checking more items in the objects listed in the side panel of the results page.<br><br>[[File:Searching_Text_in_Specific_Objects_with_Results_01.png|1000px]]<br><br> OR <br><br> providing an object filter term in the '''Choose object(s) to search in:''' field in the side overlay pane.<br><br>[[File:Search_Object_Filtering_01.png|1000px]].<br><br>


*[[Advanced Search|Advanced Search]]
'''Known Issue''': The side panel on the results page is not in sync with the side overlay pane. When you select objects from the side overlay pane, they reflect in the side panel of the results page and vice-versa is not working as expected.


===Simple Keyword Search===
===Saved Search [[File:Icon_new.png|40px]]=== Β 
Enter a search term (can be Account Name, Contact, Tag, etc.) in the Search field and click [Go]. Β 
Saved Search will now allow the users to save their search results, including the search keywords and the objects being searched. This will ensure accessibility and visibility for the users while using the AgileApps platform. Β 
:[[Image:search.gif|none|thumb]]


===Search within an Object===
;How to use the Saved Search?
To search within an object:
#From the [[Navigating the User Interface|Side Bar]], note that the current object is selected as the default in the search
#Optionally, choose a different object
#Enter a Search term in the text box
#:This term defines the search criteria; For more information on building search criteria, see [[#Wildcard Search|Wildcard Search]]
#Click the [Go] button.
#:The records found in the search appear in a [[View]].
#Optionally, click the checkbox [[Image:checkboxicon.gif|link=]]icon to select records in the view and perform [[More Actions]]


===Use Alphabetic Search in a View===
:1. Type in the desired keyword in the '''Search''' field at the top right, and the list of search results appears.
:2. To save the search, click the star icon ([[File:Star_icon_enabled_saved_search.png|15px]]) next to the search result title at the top of the page. The search result will be saved to the Saved Search list.
[[File:Saved search result page.png|1000px|center]]


;To do an alphabetic search:
:{{Note| After you save the search, the shade of the star icon changes to black ([[File:Saved_search_.png|15px]]). The star icon will be disabled ([[File:Saved_search_disabled.png|15px]]) if no search results are found.}}
:3. To access your Saved Searches, click within the '''Search''' option at the top right and select the one you want.
[[File:Saved search list.png|1000px|center]]


# Click on the column heading to sort the data using that column
# Choose '''Alphabetic Search'''
# Click on the number or letter of the alphabet to search on.


:;Considerations:
::* An alphabetic search can be performed only on fields that contain characters.
::* It cannot be performed on Date, Number and Boolean fields.
::* An alphabetic search is always performed on the current sort-column.
::* System generated views (All Records and My Records) are sorted on Date Modified. While sorted on that column, there is no Alphabetic Search option. That option appears only when you select an column that allows alphabetic search.
::* The Tree Display type does not permit alphabetic search.<br>''Learn more:'' [[View Display Type]]s


===Search in All Objects===
;How to delete the Saved Search?
To search across all objects in the platform:
:*To delete the saved search, you can either click theβ€―Xβ€―(cross-mark) icon next to the Saved search list or unpin the star by manually visiting each of the records pages you pinned earlier.Β 
#From the [[Navigating the User Interface|Side Bar]], choose "All" objects from the menu
:*To delete all the Saved Searches, click '''Remove All'''. Β 
#Enter a Search term in the text box
#:This term defines the search criteria; For more information on building search criteria, see [[#Wildcard Search|Wildcard Search]]
#Click the [Go] button
#:The records found in the search appear in sections, one for each object. Within each section, the records can be selected for viewing.


==Wildcard Search==
{{:Wildcard Search}}


==Default and Custom Search Options==
By default, a search includes all objects in the [[Application]], including hidden objects.


To change this default and restrict the search to only a '''specific object''' or the currently '''specified object''', see [[Personalize#About Search Settings|Personalize]].
==Advanced Search==
{{:Advanced Search}}
<noinclude>


[[Category:Glossary]]
[[Category:Glossary]]
</noinclude>
</noinclude>

Latest revision as of 10:35, 10 July 2023

About Search

A search action finds all records in the platform that contain the characters or words you specify. If the specified characters appear in any field in a record, the record is displayed.

Considerations
  • To search in specific fields, or to create more complex searches, you'll want to Filter a View to Restrict the Records it Displays.
  • Improve search speed and performance by configuring Search Fields to create an index for the object
    Learn more: Record Locator
  • Data Access Permissions determine which records are visible to a given user
  • A specific syntax is required to search using a Multi Object Lookup field.
    Learn more: Multi Object Lookup#Considerations
  • When searching for a keyword in Rich Text Area and the keyword is beyond 1024 characters (this includes the associated field configured in the search fields section in object's Record Locator), then the keyword is not considered by the search engine. The system has a limitation in the search fields on the Record Locator to 1024 characters.

Doing a Search

In the Old UI

  1. Enter a search term (an Account Name, Contact name, etc.) in the Search field:
    SearchBar.png
  2. Click the down arrow at the end of the field to specify the objects in which you want to search the entered value.
  3. Click Search or click the Magnifier Glass icon MagnifierIcon.png


In the New UI

  1. Enter a search term (an Account Name, Contact name, etc.) in the Search field:

    Search Field Empty.png
    Note: The side overlay pane appears with the object list once you click on the Search bar.
  2. You can perform the search in two different ways:
    • Providing the Search Text on the Search bar with no changes in the object list displayed in the side overlay pane.
    Note: Once you provide the search term in the Search field and hit Enter, the search engine performs the search in all the objects listed in the side overlay pane, by default.

    Search when no objects are selected 01.png

    • Updating the object list by checking the specific objects listed in the side overlay pane.

      Searching Text in Specific Objects.png

      You can update the object list by checking more items in the objects listed in the side panel of the results page.

      Searching Text in Specific Objects with Results 01.png

      OR

      providing an object filter term in the Choose object(s) to search in: field in the side overlay pane.

      Search Object Filtering 01.png.

Known Issue: The side panel on the results page is not in sync with the side overlay pane. When you select objects from the side overlay pane, they reflect in the side panel of the results page and vice-versa is not working as expected.

Saved Search Icon new.png

Saved Search will now allow the users to save their search results, including the search keywords and the objects being searched. This will ensure accessibility and visibility for the users while using the AgileApps platform.

How to use the Saved Search?
1. Type in the desired keyword in the Search field at the top right, and the list of search results appears.
2. To save the search, click the star icon (Star icon enabled saved search.png) next to the search result title at the top of the page. The search result will be saved to the Saved Search list.
Saved search result page.png

Notepad.png

Note: After you save the search, the shade of the star icon changes to black (Saved search .png). The star icon will be disabled (Saved search disabled.png) if no search results are found.

3. To access your Saved Searches, click within the Search option at the top right and select the one you want.
Saved search list.png


How to delete the Saved Search?
  • To delete the saved search, you can either click theβ€―Xβ€―(cross-mark) icon next to the Saved search list or unpin the star by manually visiting each of the records pages you pinned earlier.
  • To delete all the Saved Searches, click Remove All.