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:
...
- 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' activityPop Search and select' 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.
SearchesData Sources:
- You can add the multiple searches in the selected 'Data Source' to search view the different data from the list lists and also you can select choose 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 OptionsSearches' button for every 'Data Source'.
- After clicking on the 'Search OptionSearches' you will get a search panel to configure the search as shown in the above picture. Enter the search name inside the 'Search Name' field.
- Select the search button type "Filter in data Data Source" if you want the search result faster. This will search in selected 'Data Source'.
- Select the search button type "Filter Search in new Data Source".This will make a search in the 'Database' if some new value is updated then it will also return that get the updated 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 'Save Result In' variable 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 options 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 OptionsSearches' button. Select the "Search in new data Source" option to achieve the server-side searching.
Step 3: - Enter the custom 'Search Name' or the 'Property' values (search property) 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 resultfields.
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 'Save Result In' variable 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.
Steps 7:- Click on the 'ADD QUERY CONDITION' to add the query parameters. After creating the query parameter you will get the two fields 'Property' and 'Enter Value'.In the Property field provide the correct 'column name' on which you want to apply the search and in 'Enter Value' enter a curly bracket' (" { ") to open the autocomplete list. Once the list is opened select the 'Search' option as shown below.
Note: You can add the values manually if the search option is not showing in the autocomplete list. ex- {search.customer_search.name}
Steps 8:- After selecting the search now enter a dot (" . ") to open the searches created in the Pop Search and Select activity as shown below.
Steps 9:-Select the correct search name from the list and again enter a dot (" . ") to open the search fields options created inside the search name as shown below.
Steps 10:- Select the correct search field name for the 'Property'. After selecting the search field enter a 'Closing curly bracket' (" } "). You can add multiple query options according to your searches.
- 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 byEnter Property' and 'Display Name (Optional)' fields.
...
- Enter the search field name(column name) inside the 'Search byEnter Property' fields field on which you want to make a search. The 'Display Name' field is used to show the search field name if this field is empty then it will take 'Search byEnter Property' field value as a display name.
...
- 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 two checkbox name as 'Close Popup' and 'Require Selection'. 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 also set a condition on the button if this button required an item to be selected from the grid then you can select the 'Require Selection' option. 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.
- Required Selection:
- The 'Required Selection' option will give you the feature to disable a button if a button requires an item to be selected from the 'Pop Search and Select' Grid in the Mediabar.
- Select the 'Require Selection' option as shown below if you want to force a user to select the data.
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.
- The title of the popup.
- The Data Sources which we selected while configuring the 'Pop Search and Select'.
- The search field: Enter the correct value and make a search.
- The search button:
a. The activities in the definition (i.e. HTTPS in this example) will be executed when the search button is clicked. - Multiple buttons can be configured. When the button is clicked then the activities define for that button will be executed.
- The Searches which we created while configuring the 'Pop Search and Select'.
- You can select multiple rows by clicking on the checkbox.
- The Column Name of the Popup.
...
Result After the Search.
...
You can
...
search by
...
'name' or
...
'name' and '
...
phone'.