Industries Common Resources Developer Guide
jNote: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
OmniscriptDefinition
Represents the header configuration of an
Omniscript. Each row represents an Omniscript's header configurations, such as its type,
subtype, and name. An Omniscript helps build guided digital experiences. This object stores
primary information about an Omniscript to render it at runtime.
Parent Type
This type extends the Metadata metadata type and inherits its fullName field.
File Suffix and Directory Location
OmniscriptDefinition components have the suffix .omniscriptDefinition and are stored in the omniscriptDefinitions folder.
Special Access Rules
To use this metadata type, you must have an Omnistudio license and the Discovery Framework feature enabled in your Salesforce org.
Fields
| Field Name | Description |
|---|---|
| description |
|
| designerCustomizationType |
|
| isActive |
|
| isManagedUsingStdDesigner |
|
| isOmniscriptReusable |
|
| masterLabel |
|
| omniscriptDefinitionElement |
|
| omniscriptLanguage |
|
| omniscriptName |
|
| overrideKey |
|
| propertySetConfig |
|
| references |
|
| subType |
|
| type |
|
OmniscriptDefinitionElement
| Field Name | Description |
|---|---|
| description |
|
| designerCustomizationType |
|
| embeddedOmniscriptKey |
|
| isActive |
|
| isOmniscriptReusable |
|
| level |
|
| omniScriptDefElementName |
|
| parentElementName |
|
| parentElementType |
|
| propertySetConfig |
|
| sequenceNumber |
|
| type |
|
OmniScriptElementPropertySetConfig
| Field Name | Description |
|---|---|
| BStandalone |
|
| accessibleInFutureSteps |
|
| allOrNone |
|
| allowClear |
|
| allowDelete |
|
| allowEdit |
|
| allowNegative |
|
| allowNew |
|
| allowSaveChanges |
|
| allowSaveForLater |
|
| applyIfError |
|
| ariaLevel |
|
| attachmentList |
|
| attachmentName |
|
| attachmentParentId |
|
| autoSaveChanges |
|
| autoSaveLabel |
|
| bundle |
|
| businessCategory |
|
| businessEvent |
|
| callFrequency |
|
| cancelLabel |
|
| cancelMessage |
|
| chartLabel |
|
| checkLabel |
|
| clearValue |
|
| collapse |
|
| completeLabel |
|
| completeMessage |
|
| conditionType |
|
| configurationErrorMessage |
|
| confirm |
|
| confirmationOnDelete |
|
| contentParentId |
|
| contentVersionList |
|
| controlWidth |
|
| controllingField |
|
| customAttributes |
|
| dataJSON |
|
| dataJsonPath |
|
| dataProcessorFunction |
|
| dataRaptorInputParameters |
|
| dataSource |
|
| dataType |
|
| dateFormat |
|
| dateTimeFormat |
|
| dateType |
|
| debounceValue |
|
| defaultMatrixResult |
|
| defaultValue |
|
| deleteFailedMessage |
|
| deleteLabel |
|
| deleteSObject |
|
| disOnTplt |
|
| disableDataFilter |
|
| displayCurrencyCode |
|
| displayHeight |
|
| displayWidth |
|
| docList |
|
| docuSignReturnUrl |
|
| docuSignTemplatesGroup |
|
| docuSignTemplatesGroupSig |
|
| dynamicProperties |
|
| editLabel |
|
| editMode |
|
| elementErrorMap |
|
| elementName |
|
| elementValueMap |
|
| emailBody |
|
| emailInformation |
|
| emailSubject |
|
| emailTemplateInformation |
|
| enableActionMessage |
|
| enableCaption |
|
| enableDefaultAbort |
|
| enableGoogleMapsAutocomplete |
|
| enableLookup |
|
| entityIsDeletedMessage |
|
| errorMessage |
|
| expression |
|
| extraPayload |
|
| failureAbortLabel |
|
| failureAbortMessage |
|
| failureGoBackLabel |
|
| failureNextLabel |
|
| fileAttachments |
|
| googleAddressCountry |
|
| googleMapsAPIKey |
|
| googleTransformation |
|
| headingLevel |
|
| help |
|
| helpText |
|
| hide |
|
| hideEditButton |
|
| hideGroupSep |
|
| hideLabel |
|
| hideMap |
|
| horizontalMode |
|
| htmlTemplateId |
|
| iconName |
|
| iconPosition |
|
| iconVariant |
|
| ignoreCache |
|
| imageCountInRow |
|
| inProgressMessage |
|
| inputWidth |
|
| instruction |
|
| instructionKey |
|
| integrationProcedureKey |
|
| invalidIdMessage |
|
| invokeMode |
|
| knowledgeOptions |
|
| label |
|
| loginAction |
|
| lwcComponentOverride |
|
| lwcName |
|
| mask |
|
| matrixInputParameters |
|
| max |
|
| maxDate |
|
| maxDisplay |
|
| maxLength |
|
| maxTime |
|
| message |
|
| messages |
|
| min |
|
| minDate |
|
| minLength |
|
| minTime |
|
| mode |
|
| modelDateFormat |
|
| modelTimeFormat |
|
| multiple |
|
| namedCredential |
|
| newItemLabel |
|
| newLabel |
|
| nextLabel |
|
| nextWidth |
|
| objectAction |
|
| omniScriptRootConfig |
|
| optionHeight |
|
| optionSource |
|
| optionWidth |
|
| options |
|
| orgWideEmailAddress |
|
| padding |
|
| pattern |
|
| placeholder |
|
| postMessage |
|
| postTransformBundle |
|
| preTransformBundle |
|
| previousLabel |
|
| previousWidth |
|
| ptrnErrText |
|
| pubsub |
|
| radioLabels |
|
| radioLabelsWidth |
|
| rangeHigh |
|
| rangeLow |
|
| readOnly |
|
| recordAction |
|
| redirectNextLabel |
|
| redirectNextWidth |
|
| redirectPageName |
|
| redirectPreviousLabel |
|
| redirectPreviousWidth |
|
| redirectTemplateUrl |
|
| remoteClass |
|
| remoteConfirmMsg |
|
| remoteMethod |
|
| remoteOptions |
|
| remoteTimeout |
|
| repeat |
|
| repeatClone |
|
| repeatLimit |
|
| replace |
|
| required |
|
| responseJSONNode |
|
| responseJSONPath |
|
| restMethod |
|
| restOptions |
|
| restPath |
|
| restoreDefaultValuesOnCancel |
|
| sanitize |
|
| saveChangesLabel |
|
| saveLabel |
|
| saveMessage |
|
| selectCheckBox |
|
| selectMode |
|
| selectSobject |
|
| sendJSONNode |
|
| sendJSONPath |
|
| show |
|
| showInputWidth |
|
| showPersistentComponent |
|
| showPopup |
|
| signerInformation |
|
| sobjectMapping |
|
| ssm |
|
| staticDocList |
|
| step |
|
| subLabel |
|
| sumElement |
|
| svgIcon |
|
| svgSprite |
|
| targetFilter |
|
| targetId |
|
| targetLWCLayout |
|
| targetType |
|
| templateName |
|
| text |
|
| textKey |
|
| timeFormat |
|
| timeInterval |
|
| timeType |
|
| timezone |
|
| type |
|
| typeAheadKey |
|
| uploadContDoc |
|
| useContinuation |
|
| useDataJson |
|
| useTemplate |
|
| validateExpression |
|
| validationRequired |
|
| valueSvgMap |
|
| variant |
|
| wpm |
|
| xmlPostTransformBundle |
|
| xmlPreTransformBundle |
|
OmniScriptPropertySetConfig
| Field Name | Description |
|---|---|
| accessibilityToggle |
|
| allowCancel |
|
| allowSaveChanges |
|
| allowSaveForLater |
|
| autoFocus |
|
| autoSaveChanges |
|
| autoSaveOnStepNext |
|
| bulk |
|
| cancelRedirectPageName |
|
| cancelRedirectTemplateUrl |
|
| cancelSource |
|
| cancelType |
|
| consoleTabIcon |
|
| consoleTabLabel |
|
| consoleTabTitle |
|
| currencyCode |
|
| currentLanguage |
|
| disableUnloadWarn |
|
| dynamicProperties |
|
| elementTypeToHTMLTemplateMapping |
|
| enableKnowledge |
|
| errorMessage |
|
| hideStepChart |
|
| knowledgeArticleTypeQueryFieldsMap |
|
| lkObjName |
|
| mergeSavedData |
|
| message |
|
| persistentComponent |
|
| pubsub |
|
| rtpSeed |
|
| saveContentEncoded |
|
| saveExpireInDays |
|
| saveForLaterRedirectPageName |
|
| saveForLaterRedirectTemplateUrl |
|
| saveNameTemplate |
|
| saveObjectId |
|
| saveURLPatterns |
|
| scrollBehavior |
|
| seedDataJSON |
|
| showInputWidth |
|
| ssm |
|
| stepChartPlacement |
|
| stylesheet |
|
| timeTracking |
|
| trackingCustomData |
|
| visualforcePagesAvailableInPreview |
|
| wpm |
|
Declarative Metadata Sample Definition
The following is an example of the OmniscriptDefinition component.
1<?xml version="1.0" encoding="UTF-8"?>
2<OmniscriptDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
3 <isActive>true</isActive>
4 <isManagedUsingStdDesigner>true</isManagedUsingStdDesigner>
5 <isOmniscriptReusable>false</isOmniscriptReusable>
6 <masterLabel>Simple_Os_English Updated</masterLabel>
7 <omniscriptDefinitionElement>
8 <isActive>true</isActive>
9 <isOmniscriptReusable>false</isOmniscriptReusable>
10 <level>1.0</level>
11 <omniScriptDefElementName>TextBlock1</omniScriptDefElementName>
12 <sequenceNumber>0.0</sequenceNumber>
13 <type>Text Block</type>
14 </omniscriptDefinitionElement>
15 <omniscriptDefinitionElement>
16 <isActive>true</isActive>
17 <isOmniscriptReusable>false</isOmniscriptReusable>
18 <level>0.0</level>
19 <omniScriptDefElementName>Step1</omniScriptDefElementName>
20 <sequenceNumber>0.0</sequenceNumber>
21 <type>Step</type>
22 </omniscriptDefinitionElement>
23 <omniscriptLanguage>English</omniscriptLanguage>
24 <omniscriptName>SimpleOs</omniscriptName>
25 <references>[]</references>
26 <subType>Os</subType>
27 <type>Simple</type>
28</OmniscriptDefinition>The following is an example package.xml that references the previous definition.
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>*</members>
5 <name>OmniscriptDefinition</name>
6 </types>
7 <version>68.0</version>
8</Package>Wildcard Support in the Manifest File
This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.