Omniscript Custom Label Reference (Managed Package)

For the managed package runtime, this page contains tables listing the Omniscript element properties for which you must define custom labels and translations for multi-language Omniscripts, such as Omnistudio Data Mapper actions. To use a default translation, clear the property.

Managed Package app icon This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.

Note

If you are converting an Omniscript from single- to multi-language, specify valid custom label names or clear all translatable properties. If there is literal text in the property and no custom label exists, a Missing label error is displayed when you attempt to preview the script.

Required Translations for LWC Omniscripts

The following table lists the properties for which Vlocity provides custom labels with default translations.

Element	Properties
All elements	label
Calculation Action	errorMessage.custom[n].message, errorMessage.default, failureNextLabel, failureGoBackLabel, inProgressMessage
Checkbox	checkLabel
Data Mapper Extract Action	errorMessage.custom[n].message, errorMessage.default, failureNextLabel, failureGoBackLabel, inProgressMessage
Data Mapper Post Action	errorMessage.custom[n].message, errorMessage.default, failureNextLabel, failureGoBackLabel, inProgressMessage
Data Mapper Transform Action	errorMessage.custom[n].message, errorMessage.default, failureNextLabel, failureGoBackLabel, inProgressMessage
Disclosure	checkLabel
DocuSign Envelope Action	errorMessage.custom[n].message, errorMessage.default, failureNextLabel, failureGoBackLabel, inProgressMessage
DocuSign Signature Action	errorMessage.custom[n].message, errorMessage.default, failureNextLabel, failureGoBackLabel, inProgressMessage
Edit Block	newLabel, editLabel, deleteLabel
Email Action	errorMessage.custom[n].message, errorMessage.default, failureNextLabel, failureGoBackLabel, inProgressMessage
Integration Procedure Action	errorMessage.custom[n].message, errorMessage.default, failureNextLabel, failureGoBackLabel, inProgressMessage
Matrix Action	errorMessage.custom[n].message, errorMessage.default, failureNextLabel, failureGoBackLabel, inProgressMessage
Multi-Select	options[i].value
PDF Action	errorMessage.custom[n].message, errorMessage.default, failureNextLabel, failureGoBackLabel, inProgressMessage
Radio	options[i].value
Remote Action	errorMessage.custom[n].message, errorMessage.default, failureNextLabel, failureGoBackLabel, inProgressMessage
Rest Action	errorMessage.custom[n].message, errorMessage.default, failureNextLabel, failureGoBackLabel, inProgressMessage
Script Header	consoleTabLabel
Select	options[i].value
Step	cancelLabel, nextLabel, previousLabel, saveLabel, cancelMessage, saveMessage
Type Ahead Block	newItemLabel
Validation	messages[i].text

Property	Default Custom Label
cancelLabel	OmnicancelLabel
cancelMessage	OmnicancelMessage
consoleTabLabel	OmniconsoleTabLabel
editLabel	OmnieditLabel
failureGoBackLabel	OmnifailureGoBackLabel
failureNextLabel	OmnifailureNextLabel
inProgressMessage	OmniinProgressMessage
newItemLabel	OmninewItemLabel
newLabel	OmninewLabel
nextLabel	OmninextLabel
omniRequired	OmniRequired
postMessage	OmnipostMessage
previousLabel	OmnipreviousLabel
remoteConfirmMsg	OmniremoteConfirmMsg
saveLabel	OmnisaveLabel
saveMessage	OmnisaveMessage

Required Translations for Angular Omniscripts

The following table lists the properties for which Vlocity provides custom labels with default translations.

Element	Properties
All elements	label
Calculation Action	failureNextLabel, failureAbortLabel, redirectNextLabel, redirectPreviousLabel, inProgressMessage, failureAbortMessage, postMessage
Checkbox	checkLabel
Data Mapper Extract Action	failureNextLabel, failureAbortLabel, redirectNextLabel, redirectPreviousLabel, inProgressMessage, failureAbortMessage, postMessage
Data Mapper Post Action	failureNextLabel, failureAbortLabel, redirectNextLabel, redirectPreviousLabel, inProgressMessage, failureAbortMessage, postMessage
Data Mapper Transform Action	failureNextLabel, failureAbortLabel, redirectNextLabel, redirectPreviousLabel, inProgressMessage, failureAbortMessage, postMessage
Delete Action	failureNextLabel, failureAbortLabel, redirectNextLabel, redirectPreviousLabel, inProgressMessage, failureAbortMessage, postMessage
Disclosure	checkLabel
DocuSign Envelope Action	failureNextLabel, failureAbortLabel, redirectNextLabel, redirectPreviousLabel, inProgressMessage, failureAbortMessage, postMessage
DocuSign Signature Action	failureNextLabel, failureAbortLabel, inProgressMessage, failureAbortMessage, postMessage
Done Action	consoleTabLabel
Edit Block	newLabel, editLabel, deleteLabel, configProdModalCancel, configProdModalOk
Email Action	failureNextLabel, failureAbortLabel, redirectNextLabel, redirectPreviousLabel, inProgressMessage, failureAbortMessage, postMessage
Filter Block	buttonLabel
Integration Procedure Action	failureNextLabel, failureAbortLabel, redirectNextLabel, redirectPreviousLabel, inProgressMessage, failureAbortMessage, postMessage
Matrix Action	failureNextLabel, failureAbortLabel, redirectNextLabel, redirectPreviousLabel, inProgressMessage, failureAbortMessage, postMessage
PDF Action	failureNextLabel, failureAbortLabel, redirectNextLabel, redirectPreviousLabel, inProgressMessage, failureAbortMessage, postMessage
Post to Object Action	failureNextLabel, failureAbortLabel, redirectNextLabel, redirectPreviousLabel, inProgressMessage, failureAbortMessage, postMessage
Remote Action	failureNextLabel, failureAbortLabel, redirectNextLabel, redirectPreviousLabel, inProgressMessage, failureAbortMessage, postMessage
Rest Action	failureNextLabel, failureAbortLabel, redirectNextLabel, redirectPreviousLabel, inProgressMessage, failureAbortMessage, postMessage
Review Action	nextLabel, previousLabel
Script header	consoleTabLabel
Script header	Array of persistent components. Set the label property: persistentComponent[i].label
Step	previousLabel, nextLabel, cancelLabel, saveLabel, completeLabel, cancelMessage, saveMessage, completeMessage
Submit	summaryLabel, submitLabel, reviseLabel
Type Ahead Block	newItemLabel
Validation (array of objects that have a text property)	messages[i].text

Property	Default Custom Label
cancelLabel	OmnicancelLabel
cancelMessage	OmnicancelMessage
completeLabel	OmnicompleteLabel
completeMessage	OmnicompleteMessage
configProdModalCancel	OmniconfigProdModalCancel
configProdModalOk	OmniconfigProdModalOk
consoleTabLabel	OmniconsoleTabLabel
editLabel	OmnieditLabel
failureAbortLabel	OmnifailureAbortLabel
failureAbortMessage	OmnifailureAbortMessage
failureNextLabel	OmnifailureNextLabel
inProgressMessage	OmniinProgressMessage
newItemLabel	OmninewItemLabel
newLabel	OmninewLabel
nextLabel	OmninextLabel
postMessage	OmnipostMessage
previousLabel	OmnipreviousLabel
redirectNextLabel	OmniredirectNextLabel
redirectPreviousLabel	OmniredirectPreviousLabel
reviseLabel	OmnireviseLabel
saveLabel	OmnisaveLabel
saveMessage	OmnisaveMessage
submitLabel	OmnisubmitLabel
summaryLabel	OmnisummaryLabel