Vlocity Facts #13 | Angular OmniScript Debugging

When creating any interface or code, debugging and testing are crucial components. We can test from Vlocity's Omniscript Designer Preview mode to analyze the execution results.  But in some cases we need  OmniScript must occasionally be tested under same circumstances and using the same Users and Profiles as the intended users.

Angular OmniScript Debugging
A few methods for debugging Integration Procedures and Omniscripts for Angular while they are running and how to obtain the data that is kept in OmniScript JSON storage and the data that is exchanged with Salesforce.
Before starting we need to know what is scope, bpTree, response and baseCrtl.
  • "baseCtrl" - The "baseCrtl" angular controller defines its methods and variables.
  1. Scope -- definition of all available methods
    Path: baseCtrl.prototype.$scope
  2. bpTree --  the OmniScript structure definition and variables
    Path: baseCtrl.prototype.$scope.bpTree
  3. response -> the OmniScript JSON Data
    Path: baseCtrl.prototype.$scope.bpTree.response
We can use this example where we will get case records and update the case record in omniScript.
Debug the Omniscript JSON Data
  • While OmniScript is being executed right click anywhere on the OS and select “Inspect Element” to access the controller.

  • Go to console and type baseCtrl.prototype.$scope.bpTree.response. The data what you see in console is the same data what you will see in OmniScript designer Preview.

     
  • The values what you are seeing in console are not refreshed automatically. To check when JSON data when ever it is updated we need to use
    baseCtrl.prototype.$scope.bpTree.response 
  • When you need to check Omniscript field values for example to check the case number in console we can use this syntax to get the field value.
    baseCtrl.prototype.$scope.bpTree.response.StepCase.CaseNumber
Debug OmniScripts Actions.

All OmniScript Action components (Integration Procedure, Remote Actions, etc…) will trigger a request to the server. Server requests and responses can be monitored through the browser’s “Network” tab.
  1. To check these we  need to again click on Inspect element.
  2. Click on Network Tab and click Ctrl + R. After doing this you can check network activity on screen.
  3. Wait until the OmniScript action to debug is executed in the OmniScript flow.
  • There should be a "apexremote" entry in the Network tab. There could be numerous "apexremote" entries depending on the OmniScript. Per OS Action, there will be one entry. Use the "Record Network" feature to set a restriction on the number of submissions.
  1. Select the “apexremote” entry and go to the “Headers” tab > “Request Payload” > “Data”
    In the “Data” section, you’ll find the type of OmniScript action (0), the Unique name of the OmniScript: Type_Subtype (1), the payload (2) and the Action remote options (3).
  2. Select the “apexremote” entry and go to the “Preview” tab.
    The response from the server can be found under the "Preview" tab and under the "Response" tab.
===========================================================================
  • For more Details about DataRaptors and Types check this link DataRaptors
  • For OmniScripts elements refer this link OmniScript Elements -1
  • How to launch Omniscript in difference ways Launch Omniscript
  • Resources: Vlocity Resources
  • Best Practices of OmniScript, Integration Procedure, Data Raptors
  • How to Apply CSS Changes for Omniscript elements.
























    • Comments

    Post a Comment

    Popular posts from this blog

    Vlocity Facts #01 | OmniStudio DataRaptors

    DataRaptor is a mapping tool that  you can use to read, transform, and write Salesforce data. For Example. In each interaction with a digital customer  or business process, the system needs to extract the data in order to display it. If the user modifies this data or enters new data, they also need to be saved. This is where we use OmniStudio DataRaptors.  Where to use DataRaptors? Retrieving Data:   OmniScript calls  DataRaptor Extract (via the integration procedure) to read the data from Salesforce. For example, OmniScript editing an account should display data such as account name, phone number, website, and so on. Manipulating data: OmniScript captures modified and new data based on user input. For example, an agent changes the  phone number of an account. Save Data:   OmniScript calls DataRaptor Load (via the integration procedure) to write the data back to Salesforce. For example, the updated account phone number is saved back to the Account rec...
    Read more

    Vlocity Facts #34 || Getting the details from the URL in a FlexCard and an Omniscript

    Image
     1.The parameters in the URL must be in the format c__Node, followed by their values, in order to extract the parameters from the URL. For example: If you need to show different layout or different set of actions for community users and salesforces users you can pass different parameters in URL. For Community Portal Pass Community or any other reference value in ' c__Type '. https://salesforce.lightning.force.com/lightning/cmp/ omnistudio__vlocityLWCOmniWrapper?c__target=c%3ApHXTestFlexCard&c__tabIcon=custom%3Acustom18& c__Type =Community  For Salesforce Users Pass Salesforce or any other reference value in ' c__Type '. https://salesforce.lightning.force.com/lightning/cmp/ omnistudio__vlocityLWCOmniWrapper?c__target=c%3ApHXTestFlexCard&c__tabIcon=custom%3Acustom18& c__Type =Salesforce  2. We can get the value as {Params.c__Parameter} from the FlexCard and we can execute different actions based on the input. 3. From the omniscript,  we can retrieve ...
    Read more

    Vlocity Facts #44 || Communication between Omniscript and Flexcard [Pub/Sub]

    Image
    Flexcards have the ability to trigger and listen to two kinds of events: Custom and Pubsub events . Custom Events: Facilitate the transmission of information between a child and its parent. This can occur between a child Flexcard and its parent Flexcard, or between an element and the Flexcard to which it belongs. Pubsub Events: Allows communication between two separate components. This could occur between two separate Flexcards on the same Lightning page, known as sibling Flexcards, or between a Flexcard and an Omniscript.  In this post I will discuss about Pub/Sub event. Consider we have omniscript and flexcard individually on home page when an update happens we need to show those details in flexcard. To achieve this we can use pub/sub event. Step 1: Create a omniscript according to your requirement. I'm trying to create Contact record by using Step element and data raptor post action. Now to trigger the flexcard we need to configure the messaging frame work when an update happen...
    Read more