Enable Custom Object Search in the Sales Dashboard

Perform the following setup to enable search of custom objects using the search bar in the Sales Dashboard. The search bar in Sales Dashboard provides the same function as the Global Search box in the Classic UI.

Note: This setup isn't required for standard sales objects, but you change which fields you want to display in the search results for each object, by copying its search card layout and editing the copy. For details, see How can I change which fields display in Sales Dashboard search results for standard objects?

Prerequisites

1. Create the custom object and fields in a sandbox using Application Composer.

   Note the following when creating fields:

   • Make sure the Include in Service Payload option is selected. This option enables the field for the REST API.
   • The Searchable option applies only to Classic Sales UI with CRM Search.
   • A checkbox field appears as a switch in the Redwood UI with a value of either on or off.
2. Publish the sandbox.
3. In the Setup and Maintenance work area, open the Configure Adaptive Search task:
   • Offering: Sales
   • Functional Area: Foundation
   • Task: Configure Adaptive Search
4. On the Configure Adaptive Search Setup > Quick tab, select the custom object to enable for search.
5. Click the Setup > Advanced tab.
6. Click the custom object in the left pane.
7. Select Enable for all of the fields you want to expose in the Redwood UI.
8. Select Include in Keyword Search option for fields you want to enable for search.
   Note: Only fields that display as text are searchable. For example, you can't search on date fields or check boxes.
   
9. From the Actions menu, select Partial Publish.
10. Select the custom object and click Proceed with Partial publish.
11. You can monitor the progress of the publish process on the Monitor tab.
12. After the process completes, create a sandbox with Application Composer and enter the sandbox.
13. In Application Composer, click CX Extension Generator.
14. Create the UI and smart actions for the object as described in the topic Create a New Application Using the CX Extension Generator. The CX Extension Generator automatically creates the search layout template for your search setup.
    Important: Unless this is your first time using the CX Extension Generator in this environment, you must import your configurations from Oracle Visual Builder Studio. Creating a new extension, can delete your previous work.
15. Export your changes from CX Extension Generator and import them into VB Studio.
16. Make sure that the user testing the global search has access to the Sales Dashboard. By default, the application includes sales dashboards for sales manager and sales representative job roles. The user must have one of those job roles to test the search.
17. Create some records that you can test the search with.

Set Up Global Search

1. Open the Configure Adaptive Search task in the Setup and Maintenance work area:

   • Offering: Sales

   • Functional Area: Sales Foundation

   • Task: Configure Adaptive Search

2. Click the Configure Global Search tab.
3. Click the custom object name.
4. Select the Display in UI option.
5. In the Configure Search Results section, click Edit for the Title field and select the object name.
   Note: The entries in the Configure Search Results section specify which fields display in Global Search for the Classic UI. They don't apply to the Redwood UI. However, entering a title is required.

6. Click Save and Close.

   
7. Open the Sales Dashboard in the Sales application.
8. Open Oracle Visual Builder Studio (Your initials > Settings and Actions > Edit Page in Visual Builder Studio).
9. In VB Studio, click the Layouts tab.

10. In the right pane Rule Sets subtab, click the Search Card Layout entry.

    

11. In the default Search Card Layout, click Edit.

    

12. In the Search Card Layout, move the fields you want to display in the search results from the list to the right-hand pane.

    Important: To allow users to drill down from search results into individual records, be sure to add the RecordName_hyperlink field instead of RecordName.
    
    Note: Don't move fields into the Icon field. You can't add icons on this page.

    In the runtime application, the search results are divided into 3 columns. The fields in Item 1 to Item 3 in the layout display in the first column, Item 4 and Item 5 in the second, and Item 6 and Item 7 in the third.

    Each row of search results also includes the object name and a list of actions (not part of the Search Card Layout).

    
13. Click the Sources tab.

14. Find and click catalog.json.

15. Click the JSON tab in the right-hand pane.

    
16. Add the following code after "serviceType": "adf-rest":

    ,
              "publicAccess": [
                "oracle_cx_salesUI"
              ]

    The resulting code looks like this:

    "backends": {},
      "services": {
        "cx-custom": {
          "openapi": "3.0.0",
          "info": {
            "x-vb": {
              "serviceType": "adf-rest",
              "publicAccess": [
                "oracle_cx_salesUI"
              ]
            }
          },

17. Click Layouts > <your custom object> > JSON.

    
18. In the JSON subtab, find SearchCardLaout.
19. Under displayProperties, following the "Id" entry, add the following:

    ,
                  "RecordName_hyperlink"

    The resulting code looks like this:

     "layout": {
                "displayProperties": [
                  "Id",
                  "RecordName_hyperlink"
                ],

20. In the "RecordName_hyperlink" row add :"hyperlinkTemplate".

    The row should look like this:

    "fieldTemplateMap": {
              "RecordName_hyperlink":"hyperlinkTemplate"
          }

21. Click Preview and test the search.