In today’s installment of the OmniStudio Best Practices we will discover a very quick yet super effective way of stepping up our Integration Procedure and OmniScripts performance. While frequently overlooked, this simple configuration slashes seconds off the IP and OmniScript Steps execution time and only takes seconds to implement.
When “Return Full Data JSON” box is checked on your IP’s Response Action, the entire JSON is being sent over, including the nodes you may never end up using.
Now there’s no database or an API call involved so this may not be such a big deal. How big of a deal that is?
Let’s find out.
I’ve created a “test_SampleIP” simple Integration procedure that contains 3 DataRaptors. Two of them – DR_ExtractTestObjects and DR_ExtractSampleObjects return 500 records each. Then DR_extractAccount DataRaptor returns a single account with one related contact. Let’s say, we only need that Account in our OmniScript step.
This IP is then called from an OmniScript:
In our first test we’re sticking with default configuration, returning Full Data JSON.
This takes 1,321 milliseconds to complete on the IP side:
And 1,576 milliseconds when measured by the OmniScript:
Now if we only get the node that we really need…
Will be getting the response in 734 milliseconds – nearly half the time on the IP side:
And less then half the time or 768 milliseconds on the OmniScript side:
So, even though we’re not saving any database or API calls, keeping the IP response to just the data you really need may result in a significant speed boost for your IP and your OmniScript performance, while only take seconds to implement.
This gives you a great way to improve performance quickly, so I’m sure you will be on a lookout for opportunities to apply it.
Now what if the most of your Integration Procedures are not following the best practices? Or if you are frustrated by complexity created by preceding initiatives, using a mix of code and declarative tools, security, and external system integrations? Drop me a line to see if we may be able help you cut through the complexity and clear the technical debt using our pragmatic approach and combined decades of OmniStudio experience.
Lastly, if you think this information may benefit your project or your career, be sure to subscribe to my low-traffic notification list in the box in the right column. These OmniStudio best practices and performance tips take time to verify, so they are not released often. And you don’t want to miss them as they may easily take you to the next level just at the right time. Also, we never share your email with anyone, and you can always unsubscribe with one click.