Skip to main content

Usage Guide

Search configurations​

The seachbox plug-in utilizes the search configuration feature of Oracle APEX. In the shared components of your application, there is a section called "Search Configurations". In there you can manage search definitions on your data. These are the different types:

  • Standard: Define a searchable data source, which can be a table, SQL Query, or REST Data Source. Search is executed by a SQL Query using LIKE expressions.
  • Oracle Text: Define a searchable table or SQL Query, which already has an Oracle Text index created. Search is executed by using Oracle Text functionality, which provides linguistic and fuzzy search capabilities.
  • Oracle Ubiquitous Search: Search using an Oracle Ubiquitous Search index (requires Oracle Database 23ai or later). The index must be located in the parsing schema of the application.
  • List: Search within a selected List from Shared Components.

Create a new search configuration​

In most cases you want to use the "Standard" option. Choose a fitting name and click next. Now you have to enter a query on the data entitity you want to search.

Search Configuration Query

Next you have to map a primary key and title column.

Search Configuration Map Title and PK

Assign more placeholders​

After you have created a search configuration, you are on the detail page of the configuration. Here you can assign more placeholders to the search results. You can later use these placeholders in the searchbox template.

Search Configuration Map additional placeholder

You should also define a link for the search results. In the section link pass the PK value to a target page to see the details of the search result.

Search Configuration Map additional placeholder

Additional settings​

You might also want to take a look at these additional settings to optimize your user experience:

  • Authorization Scheme
  • Maximum Rows to Return
  • Searchable Column(s): which columns should be considered for the search
  • Search Query Prefix: useful if you have multiple search configurations and want users to specify the search configuration used

At last copy the Static ID of your search configuration, you will need it later in the searchbox settings.

You could add a searchbox to any page but we think a global searchbox on every page will offer the best user experience in most cases.

To add a global searchbox, go to page 0 and add a new page item of the type UC SearchBox Pro. Give it a fitting name like P0_SEARCH and the Slot in Layout to After Logo.

Next up we can configure which search configurations should be used in the searchbox. We can just add the Static IDs of search configurations seperated by a new line.

We can optimize the look and feel by setting following attributes:

  • Value Placeholder: Search...
  • Icon: fa-search
  • Template: Optional
  • Template Options → Size: Large
  • Template Options → Left Margin: Large

Now our searchbox is available on every (non-modal) page of our application and looks like this:

Take a look at the Customization section to see how you can customize the look and feel of the searchbar.