Skip to main content

Involve adopting a standardized approach to development and management. Here are some best practices to consider:

Best Practices for OmniScript

To improve the functionality and usability of OmniScript, it’s recommended to follow these best practices:

  1. Provide a description of an element’s function in its Internal Notes attribute.
  2. Avoid changing the element names to maintain DataRaptors and Apex classes. If a name change is required, modify the name of the DataRaptor or Apex class instead of the element.
  3. Avoid assigning a ContextId to the OmniScript. The ContextId reserved key in OmniScript assigns a Record Id based on the URL.
  4. Create reusable OmniScripts and add them to the relevant parent OmniScripts when procedures can be repeated across numerous scripts.
  5. Implement global branding using the Newport Design System.
  6. Assign only one owner for each OmniScript.
  7. Create a skeleton of the entire OmniScript to identify reusable elements.
  8. Prefill forms with contextual data to reduce the number of fields the user must fill out.
  9. Divide processes into simpler steps with fewer components to avoid confusing the user.
  10. Provide contextual help text and logically order input fields to assist the user.
  11. Trim the Response JSON to speed up the application of responses.
  12. Eliminate spaces from element names to speed up the loading of OmniScript.
  13. Keep the element count low in the script. The recommended maximum number of items in one OmniScript is 200.

Best Practices for DataRaptors

To ensure that DataRaptors function correctly, it is recommended that you follow these best practices:

  1. Create DataRaptors that extract or load data for a single task only.
  2. Use relationship notation (queries) whenever possible when retrieving data from other SObjects.
  3. Use relationship notation in the Extract JSON Paths for parent sObject fields instead of adding a second sObject in the DataRaptor’s Extract tab. Only child-to-parent relationship queries are supported by DataRaptors.
  4. Limit the number of SObjects used in DataRaptors to three or less.
  5. Ensure that all filtering and sorting operations (ORDER BY) are performed on indexed fields. The Id and Name fields are always indexed.
  6. Consider using caching to store frequently accessed but infrequently updated data. When you call a DataRaptor from a caching Integration Procedure, the DataRaptor data is cached alongside the Integration Procedure data.

Best Practices for Integration Procedures

To maximize the effectiveness of Integration Procedures, it is recommended to follow best practices whenever possible.

  1. Use Integration Procedures for all data calls to Salesforce.
  2. Trim the data returned by using a Response Action in Integration Procedures to only return what is required.
  3. To allow early exit from an Integration Procedure under certain conditions, use multiple Response Actions with different Execution Conditional Formulas.
  4. Caching can be used to store frequently accessed but infrequently updated data.
  5. To run data operations asynchronously, call Integration Procedures with the following settings:
  6. Use Future: If completion time is not critical and the calling OmniScript or Integration Procedure does not require a response.
  7. Invoke Mode: Fire and Forget: If the calling OmniScript needs to immediately invoke the Integration Procedure, use this method instead of Use Future.
  8. Invoke Mode: Non-Blocking: Use this method to run the Integration Procedure immediately while continuing the user interaction of the calling OmniScript. A response is provided when the Integration Procedure is completed.

Best Practices for Flex cards

Use Flex cards sparingly: Flex cards should be used only when necessary, such as when there is a need to display data in a customizable way.

  1. Use appropriate Flexbox properties: Use Flexbox properties to control the layout of Flex cards, such as flex-direction, justify-content, align-items, and align-self.
  2. Limit the number of Flex items: Avoid having too many Flex items within a Flex container. This can make it difficult to manage the layout and may cause performance issues.
  3. Use responsive design: Ensure that the Flex cards are responsive by using media queries to adjust the layout based on the screen size.
  4. Use appropriate typography and color: Use appropriate typography and color to ensure that the Flex cards are easy to read and visually appealing.
  5. Use appropriate images: Use high-quality images that are optimized for the web and that are relevant to the content being displayed.
  6. Test on multiple devices: Test the Flex cards on multiple devices and screen sizes to ensure that they are displayed correctly and that the layout is consistent.
  7. Use consistent design: Ensure that the design of the Flex cards is consistent with the rest of the application to provide a cohesive user experience.

I hope this information is helpful for you.

Join the discussion 14 Comments

  • poker says:

    First off I want to say terrific blog! I
    had a quick question which I’d like to ask if you do not mind.
    I was curious to know how you center yourself and clear your thoughts before writing.
    I have had trouble clearing my thoughts in getting my
    ideas out. I truly do take pleasure in writing but it just seems like the
    first 10 to 15 minutes tend to be wasted simply just trying to figure out how to begin. Any recommendations or hints?
    Appreciate it!

  • Hey! This is my 1st comment here so I just wanted to give a
    quick shout out and say I truly enjoy reading through your blog posts.

    Can you recommend any other blogs/websites/forums that go over the same subjects?

    Thanks for your time!

  • I don’t even understand how I ended up here, however I assumed this submit was great.
    I do not recognize who you are but certainly you’re going to
    a famous blogger in case you are not already.

  • you are really a just right webmaster. The web
    site loading speed is amazing. It seems that you are doing any distinctive trick.
    Moreover, The contents are masterwork. you have performed a great task in this topic!

  • Zepte says:

    I’m amazed, I have to admit. Seldom do I encounter a blog
    that’s both educative and amusing, and let me tell you, you’ve hit the nail on the head.
    The problem is something that too few people are speaking intelligently
    about. Now i’m very happy that I came across this in my
    search for something regarding this.

  • I don’t even know how I finished up here, however I thought this post was
    once good. I don’t realize who you might be but certainly
    you are going to a famous blogger if you aren’t already.

  • says:

    Thanks for sharing your thoughts about скриншоты заверенные.

  • 레플리카 says:

    Wow, that’s what I was looking for, what a data! present here at this web site, thanks
    admin of this website.

  • I am genuinely thankful to the owner of this web page who has shared
    this enormous paragraph at here.

  • Its like you read my thoughts! You seem to grasp a
    lot about this, like you wrote the book in it or something.
    I think that you can do with a few percent to power the
    message house a little bit, however other than that,
    this is fantastic blog. A fantastic read. I will certainly
    be back.

  • USA VPS says:

    Informative article, totally what I needed.

  • Hello just wanted to give you a quick heads up.
    The words in your content seem to be running off the screen in Opera.
    I’m not sure if this is a formatting issue or something to do with internet browser compatibility but I thought
    I’d post to let you know. The design and style look
    great though! Hope you get the problem solved soon. Kudos

  • I’m still learning from you, while I’m making my way to the top as well. I certainly enjoy reading all that is posted on your website.Keep the tips coming. I loved it!

  • I was studying some of your articles on this internet site and I believe this site is very informative! Continue putting up.

Subscribe For More Updates


Join our mailing list to receive the latest news and updates from our team.

You have Successfully Subscribed!