Adding an Action to the Person and Premise Search

You can use VB Studio to add custom actions to the Action button on the Person and Premise Search screen, available in CX for Utilities Agent Service.

Figure 14-1 Person and Premise Search

You can add these types of actions:

• Open URL action

• Navigate to page action

This example shows how to add either an open URL action or a navigate to page action to the button.

This example assumes that the reader understands how to use VB Studio. For additional information, see:

• Using the Person and Premise Search in the Using CX for Utilities Agent Service Guide

• The Visual Builder Studio library in the Oracle Help Center

• Customizing Variables and Constants in the Extending Oracle Cloud Applications with Visual Builder Studio Guide

Example: Adding an Action Menu Item to the Person and Premise Search

1. Log into CX for Utilities Agent Service as an administrator, and select the Person and Premise Search page tab.

2. Click the menu at the top right of the page and select Edit Page in Visual Builder Studio.

3. Select your workspace and click Select. Note that you can also create a new workspace if needed.

4. In the App UIs panel, expand Customer Experience (CX), then expand Customer Experience For Utilities and then expand Fragments.

5. Select the e11y-user-action-template fragment.

6. Select the Variables sub-tab to display the constants and variables.

7. Click on the USER_ACTION_CONTEXT_LIST constant.

8. On the right side of the screen, enter the following sample code in the Default Value field, which will add an open url action:

   [
   
   {
   
   "id": "CUSTOM_ACTION_NAME",
   
   "label": "Custom Menu Label",
   
   "active": true,
   
   "context": {
   
   "type": "Url",
   
   "url": "https://custommenuname.html?component=${component}&demo=${demo}&testId=${testId}",
   
   "params": [
   
   {
   
   "name": "component",
   
   "value": "menu"
   
   },
   
   {
   
   "name": "demo",
   
   "value": "overview"
   
   },
   
   {
   
   "name": "testId",
   
   "scope": "ui"
   
   }
   
   ]
   
   }
   
   }
   
   ]

   You can also add a navigate to page action by replacing the above code sample with this code sample:

   [
   
   {
   
   "id": "CUSTOM_ACTION_NAME",
   
   ...
   
   },
   
   {
   
   "id": "NAVIGATE_ACTION_NAME",
   
   "label": "Navigate to digital-sales page",
   
   "active": true,
   
   "context": {
   
   "type": "InAppNavigation",
   
   "appName":  "digital-sales",
   
   "appPage": "es/p/mycustomers/contacts",
   
   "windowName": "_blank",
   
   "params": [
   
   {
   
   "name": "puid",
   
   "alias": "partyNumber"
   
   }
   
   }
   
   }
   
   ]

9. If there are extensions params that you want to use in action meta-data's context params, complete these steps:

   1. Return to the main-contacts-start tab and select the Variables sub-tab.

   2. Click on the USER_ACTION_PARAMS_HEADER_ACTIONS constant.

   3. In the Default Value field, enter the value mapping for extension params:

      [[
      
      [
      
      {
      
      "name": "testId",
      
      "value": $page.variables.testId
      
      }
      
      ]
      
      ]]

10. Click on the JSON sub-tab to display a view where you can easily edit this sample code, and update the code sample so it reflects your custom values.

11. Return to the main-contacts-start tab and select the Variables sub-tab.

12. Click on the USER_ACTION_UI_HEADER_ACTIONS constant.

13. In the Default Value field, enter the ID you used in your code sample above. For example, enter ["CUSTOM_ACTION_NAME"] in this field.

14. Preview your changes to verify that they look as you expected. This will launch a new tab with the Person and Premise Search. Validate that your new option is available, and that it navigates to the appropriate URL.

15. When your changes are ready for use, complete the steps to publish your changes to your production environment.