Pop Search and Select V2

OVERVIEW:

• The 'Pop Search and Select' activity allows you to show the results grid in a custom popup inside Oracle Service Cloud and perform search & select operations. In the PopFlow Studio, you can configure the 'Pop Search and Select' activity.

• After opening 'Pop Search and select' activity, you will get the below configuration panel.

Default Configuration Parameters:

• Title: The title to be shown in the popup window.
• Allow Multi Selection: Select multiple rows in the popup window./ User Double Click on Grid: Select the single data and closes the popup.
• Data Source: The data to be displayed in the popup search results grid.
• Save Results In: Selected row will be stored in this.

Add Button allows you to add buttons to the popup. When the button is clicked, the activities defined in the button definition will be executed.

Add Searches allows you to add searches to the popup. When the search type is selected, and the search button is clicked the activities defined in the search selection definition will be executed.

HOW IT WORKS:

A Simple Example to configure the 'Pop Search and Select V2' activity in PopFlow Studio.

• Select the 'Pop Search and select' activity from 'Activity Sidebar'.
• Click on 'Pop Search and select' activity to open and configure the 'Set Interaction Data' activity.
• Once the Activity is opened now fill the Defaults required fields i.e. 'Title', 'Data Source' and 'Save Results In'.

• To select the 'Data Source' value we need to have either 'HTTPS' or 'GET DATA' activity result.
• In this example, we will be using 'HTTPS' activity to fetch the data from the API and show the result in 'Pop Search and Select'. To configure the 'HTTPS' activity please refer to the 'HTTPS' activity documents.
• After configuration of 'HTTPS' activity adds a 'Pop Search and Select' activity on the 'SUCCESS' button of 'HTTPS' activity as shown below.

• Now configure the Default fields 'Pop Search and Select' activity as shown below.

Searches:

• You can add the multiple searches in the selected 'Data Source' to search the data from the list and also you can select which column you want to show for selected 'Data Source'.
• After selecting the 'Data Source'. You can add multiple 'Search Options' by clicking on the 'Search Options' button.

• After clicking on the 'Search Option' you will get a search panel to configure the search. Enter the search name inside the 'Search Name' field.
• Select the search button "Filter in data Data Source" if you want the search result faster. This will search in selected 'Data Source'. 
• Select the search button "Filter in new Data Source".This will make a search in the 'Database' if some new value is updated then it will also return that value also. To achieve this search you need to add the same activity with the same configuration on the Search Button whose 'Data Source' you are using for the search. 

     - For example, suppose you are using the 'HTTPS' activity result inside the 'Pop Search and Select' activity as a Data Source. 

      Steps to configure the "Search in new data Source":-

          Step 1: - Select the 'HTTPS' activity 'Save Result In' variable from the option as Data Source inside the 'Pop Search and Select' as shown below.

          Step 2:- Now create the search for the selected Data Source by clicking on the 'Search Options' button. Select the "Search in new data Source" option to achieve the server-side searching.

          Step 3: - Enter the 'Property' values inside the 'Enter Property' field. Property values should be the same as a Column Name.

           For example:- Suppose we have an object as shown below:-
          {
             "id": 1,
             "name": "Leanne Graham",
             "username": "Bret",
             "email": "Sincere@april.biz",
             "address": {
                 "street": "Kulas Light",
                 "suite": "Apt. 556",
                 "city": "Gwenborough",
                  "zipcode": "92998-3874",
                  "geo": {
                     "lat": "-37.3159",
                      "lng": "81.1496"
                       }
                             },
        }
          You can select any values from the above Object. For example we can select "id" , "name" , "username" , "address.city".
        Note: If you select Property values which are not present in the 'Object' then it will not return the search result.

         step 4: After creating the search you will notice there is a button created with the same name as 'Search Name' (For this example 'Customer Search' is the 'Search Name') on the designer page under the 'Pop Search and Select' activity.

        Step 5:-- Now add the 'HTTPS' activity on the 'CUSTOMER SEARCH' button to achieve the server-side searching. The 'HTTPS' activity should have the same configuration as whose result is selected as a 'Data Source' for the 'CUSTOMER SEARCH' Search inside the 'Pop Search and Select'.

       Steps 6:- 'Save Results In' variable name of 'HTTPS' activity should be the same as Parent HTTP activity.

• You can add multiple search fields by clicking on the 'Add Search Fields' text as shown below. After clicking on it, It will add a panel with 'Search by' and 'Display Name (Optional)' fields.

• Enter the column name inside the 'Search by' fields on which you want to make a search. The 'Display Name' field is used to show the search name if this field is empty then it will take 'Search by' field value as a display name. 

Columns To Show

• You can display all the columns of the Data Source or You can define the columns that will be displayed in the search grid. To define the columns click on the 'Columns To Show' button to create the fields. After clicking on button it will create a panel with 'Column Path' and 'Column Name' fields. In the 'Column Path' field enter the column path value and inside the 'Column Name' you can enter any friendly name for the title, 'Column Name' field is optional you can either enter the value or left it blank. If the 'Column Name' field is empty it will show the 'Column Path' Value as a Column Name.

Adding Buttons: 

• To add the Custom button you need to click on the 'Button' icon to create the buttons. After clicking on the button, you will see a field name as 'Name' and a checkbox name as 'Close Popup'. Enter the Button name inside the field and click on the checkbox if you want to close the pop-up after clicking on the button in the Oracle service cloud. You can create multiple buttons. Once the buttons are created you will notice on the designer page has changed under the 'Pop Search and Select'  same button is created which you created inside the 'Pop Search and Select' activity. You can add multiple activities on that button to perform the several tasks on a button click.

After executing the workflow below pop-up will be shown in the Oracle service cloud.

• After executing the workflow it will pop up a 'Pop Search and Select' screen with the result, Searches and Custom buttons as shown below.

1. The title of the popup.
2. The Data Sources which we selected while configuring the 'Pop Search and Select'.
3. The search field: Enter the correct value and make a search.
4. The search button:
    a. The activities in the definition (i.e. HTTPS in this example) will be executed when the search button is clicked.
5. Multiple buttons can be configured. When the button is clicked then the activities define for that button will be executed.
6. The Searches which we created while configuring the 'Pop Search and Select'.
7. You can select multiple rows by clicking on the checkbox.
8. The Column Name of the Popup.

• Result After the Search.

• You can either search by only 'name' or both 'name' and 'address.street'.