Industries Common Resources Developer Guide
jOmniIntegrationProcedure
Represents an Omnistudio Integration Procedure for the
Discovery Framework. It enables declarative, server-side processing to perform multiple
actions in a single server call, supporting sales, service, and other business
workflows. For Discovery Framework, the customization type is
discoveryframework.
Parent Type
This type extends the Metadata metadata type and inherits its fullName field.
File Suffix and Directory Location
OmniIntegrationProcedure components have the suffix .omniIntegrationProcedure and are stored in the omnistudio/<Namespace>/omniIntegrationProcedures folder.
Version
OmniIntegrationProcedure components are available in API version 56.0 and later.
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 |
|---|---|
| customHtmlTemplates |
|
| customJavaScript |
|
| description |
|
| designerCustomizationType |
|
| elementTypeComponentMapping |
|
| integrationProcedureInput |
|
| integrationProcedureOutput |
|
| isActive |
|
| isIntegProcdSignatureAvl |
|
| isIntegrationProcedure |
|
| isManagedUsingStdDesigner |
|
| isMetadataCacheDisabled |
|
| isOmniScriptEmbeddable |
|
| isTestProcedure |
|
| isWebCompEnabled |
|
| language |
|
| lastPreviewPage |
|
| name |
|
| nameSpace |
|
| omniProcessElements |
|
| omniProcessKey |
|
| omniProcessType | |
| overrideKey |
|
| propertySetConfig |
|
| requiredPermission |
|
| responseCacheType |
|
| subType |
|
| type |
|
| uniqueName |
|
| versionNumber |
|
| webComponentKey |
|
OmniProcessElement
Represents the Omnistudio Process Element associated with the Omnistudio Integration Procedure.
| Field Name | Description |
|---|---|
| childElements |
|
| description |
|
| designerCustomizationType |
|
| discoveryFrameworkUsageType |
|
| embeddedOmniScriptKey |
|
| isActive |
|
| isOmniScriptEmbeddable |
|
| level |
|
| name |
|
| omniProcessVersionNumber |
|
| parentElementName |
|
| parentElementType |
|
| propertySetConfig |
|
| sequenceNumber |
|
| type |
|
| uniqueIndex |
|
Declarative Metadata Sample Definition
The following is an example of an OmniIntegrationProcedure component.
1<?xml version="1.0" encoding="UTF-8"?>
2<OmniIntegrationProcedure xmlns="http://soap.sforce.com/2006/04/metadata">
3 <customJavaScript>{"salary":332}</customJavaScript>
4 <elementTypeComponentMapping>{"ElementTypeToHTMLTemplateList":[]}</elementTypeComponentMapping>
5 <integrationProcedureInput>{
6 "properties": {
7 "salary": {
8 "type": "integer"
9 }
10 },
11 "type": "object",
12 "title": "Data",
13 "$schema": "https://json-schema.org/draft/2020-12/schema"
14}</integrationProcedureInput>
15 <integrationProcedureOutput>{
16 "properties": {
17 "tax": {
18 "type": "double"
19 }
20 },
21 "type": "object",
22 "title": "Data",
23 "$schema": "https://json-schema.org/draft/2020-12/schema"
24}</integrationProcedureOutput>
25 <isActive>true</isActive>
26 <isIntegProcdSignatureAvl>true</isIntegProcdSignatureAvl>
27 <isIntegrationProcedure>true</isIntegrationProcedure>
28 <isManagedUsingStdDesigner>false</isManagedUsingStdDesigner>
29 <isMetadataCacheDisabled>false</isMetadataCacheDisabled>
30 <isOmniScriptEmbeddable>false</isOmniScriptEmbeddable>
31 <isTestProcedure>false</isTestProcedure>
32 <isWebCompEnabled>false</isWebCompEnabled>
33 <language>English</language>
34 <name>Calc</name>
35 <omniProcessElements>
36 <description>Response Action</description>
37 <isActive>true</isActive>
38 <isOmniScriptEmbeddable>false</isOmniScriptEmbeddable>
39 <level>0.0</level>
40 <name>Response</name>
41 <omniProcessVersionNumber>0.0</omniProcessVersionNumber>
42 <propertySetConfig>{
43 "responseJSONPath" : "",
44 "responseJSONNode" : "",
45 "executionConditionalFormula" : "",
46 "returnFullDataJSON" : false,
47 "additionalOutput" : {
48 "tax" : "=%salary%*0.3"
49 },
50 "returnOnlyAdditionalOutput" : false,
51 "sendJSONPath" : "",
52 "responseFormat" : "",
53 "id" : "",
54 "isActive" : true,
55 "restOptions" : { },
56 "sendJSONNode" : ""
57}</propertySetConfig>
58 <sequenceNumber>1.0</sequenceNumber>
59 <type>Response Action</type>
60 </omniProcessElements>
61 <omniProcessKey>calc_calc</omniProcessKey>
62 <omniProcessType>Integration Procedure</omniProcessType>
63 <propertySetConfig>{
64 "transientValues" : {
65 "deactivateConsent" : false
66 }
67}</propertySetConfig>
68 <subType>calc</subType>
69 <type>calc</type>
70 <uniqueName>calc_calc_English_1</uniqueName>
71 <versionNumber>1.0</versionNumber>
72</OmniIntegrationProcedure>The following is an example package.xml that references the previous definition.
1<?xml version="1.0" encoding="UTF-8"?>
2<Package
3 xmlns="http://soap.sforce.com/2006/04/metadata">
4 <types>
5 <members>*</members>
6 <name>OmniIntegrationProcedure</name>
7 </types>
8 <version>66.0</version>
9</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.
Usage Type
Before you retrieve or deploy Discovery Framework OmniScripts, we recommend that you review this consideration.
- When deploying the OmniIntegrationProcedure of type Discovery Framework, enable Discovery Framework Metadata Enabled setting.