No comments yet

Introduction to OmniScripts

OmniScript is a way for a application builder to design a business process by configuring interactions using declarative tools that are easy to use, and it implement complex functionality behind the scenes. It enables you to craft dynamic customer interactions without code. The ability to configure interactive, easy-to-use business processes with branching, which means different pages and groups of fields can be shown based on choices the user makes.

What is OmniScript ?

An OmniScript allow you to build a guided path for completing a business process and serves as a configurable way of creating a seamless customer experience. You can create OmniScripts using an intuitive drag-and-drop editor that enables you to group various elements such as actions (extract data, send email), functions (formulas), input fields, and branching logic.

You can enable the LWC on OmniScript to get an LWC component that you can deploy and launch from Communities, Object detail pages, and FlexCards.

When to use OmniScripts

Here are a some example when you can use OmniScripts.

  1. Provide a guided path to complete a business process.
  2. Step users through complex tasks
  3. Captures details for a service implementation.
  4. A customer steps through a selling process, such as choosing a new insurance plan.
  5. For self-service interaction such as troubleshooting.

OmniScript Designer

In OmniScript there are the different types of elements and how they can be used.

Element TypeUse
ActionsFor calling on other tools to perform various actions: getting or saving data, calculating, sending an email, and so on
DisplayFor displaying text and images on the screen to enhance the usability of the UI
FunctionsFor performing calculations within the OmniScript, showing conditional messages, and providing geolocation
GroupFor grouping elements together on the UI
InputsFor system or user input or selection
OmniScriptsReusable OmniScripts to insert and use

Reusable OmniScript

Reusable OmniScripts are intended to be embedded into another OmniScript so they have no Done Action.

OmniScript Naming Conventions.

An OmniScript’s Type, Subtype, and Language gives an OmniScript its unique identity. Only one active OmniScript may have the same Type, SubType, and Language at any time. An OmniScript’s Type must start with a lowercase letter.

Only one version of an OmniScript may be active at a time. If you need to make a change to an active OmniScript, create a new version. The version of the OmniScript already active and in production remains in place while you work on the new version.

Best Practices

  1. Use camelCase – prefix, Verb, Object and Detail
  2. Use an action verb and descriptive nouns
  3. Use abbreviations
  4. Example acctMgmt/verifyCallerteam

OmniScript Best Practices

  1. Identify reusable elements by building a skeleton of the entire OmniScript
  2. Document the purpose of an element in the element’s Internal Notes property
  3. Apply global branding by using the Newport Design System
  4. Avoid confusing the user by breaking processes up into shorter steps.
  5. Speed up the application of responses by trimming the Response JSON.
  6. A single OmniScript should not exceed 200 elements.
  7. Run logic on the server where possible.

OmniScript Performance Factors

A set of best practices exists for both Client-side performance and Server-side performance.

Client-side best practices include

  1. Reduce Conditional Views, Merge Fields, Formulas where possible.
  2. Speed up the application of responses by trimming the Response JSON. For more information.
  3. Remove spaces from element names to improve the OmniScript’s load time.
  4. Reduce the number of elements in the script. A single OmniScript should not exceed 200 elements.
  5. Run logic on the server where possible, including conditional logic in Integration Procedures and formulas in DataRaptors.
  6. Test performance by enabling time tracking. If time tracking is not used in production, disable the feature before deploying to production. For more information.

Server-side best practices include:

  1. Cut down the payload size of a request by trimming the JSON request. For more information.
  2. Reduce server roundtrips by using Integration Procedures whenever multiple actions run between steps. Run Integration Procedures asynchronously by enabling the fire and forget property.
  3. Remove unnecessary data by trimming the DataRaptor extract output.

Check this post to learn about OmniStudio.

Post a comment