Add a Type Ahead Block in an Omniscript

In edit blocks, suggest possible entries as a user types in a field, as an autosuggest or autocomplete.

1. Add the Type Ahead Block element to the Omniscript canvas.
   

   Note

   If a Type Ahead Block exists in a Block element, only one Block element is permitted. Adding multiple nested Blocks results in errors.

2. Add an Action element into the Type Ahead Block to retrieve data or seed the Type Ahead Block with data.

   Type Ahead Blocks only support using a single action.

   Supported Data Sources	Description
   Data JSON	Accesses an array of data present in the Omniscript's data JSON.
   Omnistudio Data Mapper Extract Action	Retrieves internal or external Salesforce data.
   Google Maps Auto Complete	Calls a Google Maps API to retrieve google maps data.
   HTTP Action	Retrieves external data.
   Remote Action	Retrieves data from an Apex class.

3. Add input elements into the Type Ahead Block to map response data.

   To hide an element, such as an Id, from the user, prefill it with data from the TypeAhead using these steps:

   1. From the element properties panel, click Edit as JSON. The JSON definition of the element is displayed.

   2. Set the hide property's value to true.

   3. Check the box labeled Available for Prefill When Hidden.

4. Configure additional properties in the Edit Block to set a user's data access.
5. Add custom styling and behavior by overriding LWC Type Ahead Block components.

   The LWC Component Override field only overrides the Type Ahead Component.

   Type Ahead Block LWCs	Description
   omniscriptTypeahead	Overrides the Type Ahead component that lists the data results.
   omniscriptTypeaheadBlock	Overrides the Type Ahead Block component that embeds the Type Ahead component.
   progressBar	LWC Type Ahead Blocks display a progress-bar when retrieving data results. For information on customizing the progress-bar, see Base Omnistudio LWC ReadMe Reference.

• Use a Type Ahead Block with an Omnistudio Data Mapper
  Retrieve an object record using a Type Ahead Block with a Data Mapper. For example, type a few letters of an account name in the Type Ahead Block. The Data Mapper finds account records with names containing those letters.
• Use Type Ahead Block With Data JSON
  A Type Ahead Block can use a JSON node as its source instead of an Omnistudio Data Mapper, API, HTTP, or Remote action. This JSON node can store data from any action that outputs a list. The response from a Type Ahead Block that uses a JSON node is made client-side, eliminating the need to make server calls.
• Use Google Maps Autocomplete in Omniscripts
  Retrieve Google Maps data and display a location in the Type Ahead Block by using the Google Maps API.
• Make an HTTP Call from a Type Ahead Block
  Retrieve data from a URL in your Type Ahead Block using an HTTP Action.

Use a Type Ahead Block with an Omnistudio Data Mapper

Retrieve an object record using a Type Ahead Block with a Data Mapper. For example, type a few letters of an account name in the Type Ahead Block. The Data Mapper finds account records with names containing those letters.

Note To prevent users’ type-ahead selections from propagating to other fields, make sure to map type-ahead data to individual elements. Create one Data Mapper for each Type Ahead Block, or put one Data Mapper inside a Block or Edit Block element and select Copy elements (Enable Repeat in the designer for a managed package).

Type Ahead Blocks usually use Name but can use another field. The following task steps use Name.

1. Create a Data Mapper Turbo Extract or a Data Mapper Extract with a filter of Name LIKE Key. If needed, add other filters.
2. Add a Step component to your Omniscript, or use the first Step.
3. Add a Type Ahead Block to the Step in your Omniscript.
4. In the Type Ahead Block Properties, set the Typeahead Key to Name.
5. Drag a Omnistudio Data Mapper Turbo or Omnistudio Data Mapper Extract element into the structure of the Type Ahead Block.
6. In the Data Mapper Action Properties, set the Data Mapper Interface to the name of the Data Mapper Turbo Extract or Extract you created.
7. To pass the Type Ahead Block input to the Data Mapper, in the Data Mapper Extract Action Properties, go to Input Parameters. Set one Data Source to the Name of the Type Ahead Block, for example TypeAhead1. Set the corresponding Filter Value to Key.
8. Set any other Input Parameters that the Data Mapper Extract requires for other filters.
9. For a Data Mapper Turbo Extract, make sure the Response JSON Path in the Omniscript’s Data Mapper Turbo Action matches the Data Mapper Turbo Extract's Extract Output Path.
10. If needed, add fields to the Type Ahead Block.

    To populate the fields, set the element names to match the Data Mapper Turbo Extract or Extract’s Output JSON Path fields.

    For more information on populating elements, see Load Salesforce Data into an Omniscript Using an Omnistudio Data Mapper.

11. To populate subsequent Omniscript elements with data from the Type Ahead Block’s Data Mapper, use %StepName:TypeAheadName-Block:DROutputField%, for example %Step1:TypeAhead1-Block:AnnualRevenue%.