omnistudio-integration-procedure-generate

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

omnistudio-integration-procedure-generate: OmniStudio Integration Procedure Creation and Validation

omnistudio-integration-procedure-generate：OmniStudio Integration Procedure的创建与验证

Expert OmniStudio Integration Procedure (IP) builder with deep knowledge of server-side process orchestration. Create production-ready IPs that combine DataRaptor/Data Mapper actions, Apex Remote Actions, HTTP callouts, conditional logic, and nested procedure calls into declarative multi-step operations.

精通服务器端流程编排的OmniStudio Integration Procedure（简称IP）构建专家。可创建用于生产环境的IP，将DataRaptor/Data Mapper操作、Apex Remote Actions、HTTP调用、条件逻辑和嵌套流程调用整合为声明式多步骤操作。

Scope

适用范围

In scope: Creating well-structured Integration Procedures from requirements; selecting and wiring element types (DataRaptor, Remote Action, HTTP, Conditional Block, Loop, Set Values, nested IP); dependency validation; error handling patterns; 110-point scoring; deployment and activation
Out of scope: Building OmniScripts (use
```
omnistudio-omniscript-generate
```
), creating Data Mappers directly (use
```
omnistudio-datamapper-generate
```
), designing FlexCards (use
```
omnistudio-flexcard-generate
```
), mapping full dependency trees (use
```
omnistudio-dependencies-analyze
```
), deploying metadata to org (use
```
platform-metadata-deploy
```
)

适用范围：根据需求创建结构清晰的Integration Procedure；选择并连接各类元素（DataRaptor、Remote Action、HTTP、条件块、循环、设置值、嵌套IP）；依赖验证；错误处理模式；110分制评分；部署与激活
不适用范围：构建OmniScript（请使用
```
omnistudio-omniscript-generate
```
）、直接创建Data Mapper（请使用
```
omnistudio-datamapper-generate
```
）、设计FlexCard（请使用
```
omnistudio-flexcard-generate
```
）、绘制完整依赖树（请使用
```
omnistudio-dependencies-analyze
```
）、将元数据部署到组织（请使用
```
platform-metadata-deploy
```
）

Required Inputs

必填输入项

Purpose: What business process is this IP orchestrating? (e.g., "onboard a new account", "process an order")
Target objects / data sources: Which Salesforce objects, external APIs, or both?
Type / SubType naming: PascalCase pair that uniquely identifies the IP (e.g.,
```
Type=OrderProcessing
```
,
```
SubType=Standard
```
)
Target org alias: Authenticated org alias for deployment (e.g.,
```
myDevOrg
```
)

用途：此IP编排的业务流程是什么？（例如：“新客户开户”、“订单处理”）
目标对象/数据源：涉及哪些Salesforce对象、外部API，或两者皆有？
Type/SubType命名：采用PascalCase格式的唯一标识IP的名称对（例如：
```
Type=OrderProcessing
```
,
```
SubType=Standard
```
）
目标组织别名：用于部署的已认证组织别名（例如：
```
myDevOrg
```
）

Quick Reference

快速参考

Scoring: 110 points across 6 categories. Thresholds: ✅ 90+ (Deploy) | ⚠️ 67-89 (Review) | ❌ <67 (Block - fix required)

评分体系：6个类别共110分。阈值标准：✅ 90分及以上（可部署） | ⚠️ 67-89分（需审核） | ❌ 低于67分（需修复，禁止部署）

Core Responsibilities

核心职责

IP Generation: Create well-structured Integration Procedures from requirements, selecting correct element types and wiring inputs/outputs
Element Composition: Assemble DataRaptor actions, Remote Actions, HTTP callouts, conditional blocks, loops, and nested IP calls into coherent orchestrations
Dependency Analysis: Validate that referenced DataRaptors, Apex classes, and nested IPs exist and are active before deployment
Error Handling: Enforce try/catch patterns, conditional rollback, and response validation across all data-modifying steps (DML — Data Manipulation Language)

IP生成：根据需求创建结构清晰的Integration Procedure，选择正确的元素类型并配置输入/输出映射
元素组合：将DataRaptor操作、Remote Action、HTTP调用、条件块、循环和嵌套IP调用整合为连贯的编排流程
依赖分析：在部署前验证引用的DataRaptor、Apex类和嵌套IP是否存在且处于激活状态
错误处理：在所有数据修改步骤（DML——数据操作语言）中强制实施try/catch模式、条件回滚和响应验证

CRITICAL: Orchestration Order

重要说明：编排顺序

omnistudio-dependencies-analyze -> omnistudio-datamapper-generate -> omnistudio-integration-procedure-generate -> omnistudio-omniscript-generate -> omnistudio-flexcard-generate (you are here: omnistudio-integration-procedure-generate)

Data Mappers referenced by the IP must exist FIRST. Build and deploy DataRaptors/Data Mappers before the IP that calls them. The IP must be active before any OmniScript or FlexCard can invoke it.

omnistudio-dependencies-analyze -> omnistudio-datamapper-generate -> omnistudio-integration-procedure-generate -> omnistudio-omniscript-generate -> omnistudio-flexcard-generate（当前处于：omnistudio-integration-procedure-generate）

IP引用的Data Mapper必须先存在。在构建并调用IP之前，需先部署DataRaptor/Data Mapper。IP必须处于激活状态，才能被OmniScript或FlexCard调用。

Key Insights

关键要点

Insight	Details
Chaining	IPs call other IPs via Integration Procedure Action elements. Output of one step feeds input of the next via response mapping. Design data flow linearly where possible.
Response Mapping	Each element's output is namespaced under its element name in the response JSON. Use `%elementName:keyPath%` syntax to reference upstream outputs in downstream inputs.
Caching	IPs support platform cache for read-heavy orchestrations. Set `cacheType` and `cacheTTL` in the procedure's PropertySet. Avoid caching procedures that perform DML.
Versioning	Type/SubType pairs uniquely identify an IP. Use SubType for versioning (e.g., `Type=AccountOnboarding` , `SubType=v2` ). Only one version can be active at a time per Type/SubType.

Core Namespace Discriminator: OmniStudio Core stores both Integration Procedures and OmniScripts in the

OmniProcess

table. Use

IsIntegrationProcedure = true

OmniProcessType = 'Integration Procedure'

to filter IPs. Without a filter, queries return mixed results.

CRITICAL — Creating IPs via Data API: When creating OmniProcess records, set
IsIntegrationProcedure = true
to make the record an Integration Procedure. The
OmniProcessType
picklist is computed from this boolean and cannot be set directly. Also,
Name
is a required field on
OmniProcess
(not documented in standard OmniStudio docs). Use
sf api request rest --method POST --body @file.json
for creation — the
sf data create record --values
flag cannot handle JSON textarea fields like
PropertySetConfig
.

要点	详情
流程链式调用	IP通过Integration Procedure Action元素调用其他IP。上一步的输出通过响应映射传入下一步的输入。尽可能设计线性数据流。
响应映射	每个元素的输出在响应JSON中以元素名称为命名空间。使用 `%elementName:keyPath%` 语法在下游输入中引用上游输出。
缓存	IP支持平台缓存，适用于读取密集型编排流程。在流程的PropertySet中设置 `cacheType` 和 `cacheTTL` 。避免对执行DML操作的流程启用缓存。
版本控制	Type/SubType对唯一标识一个IP。使用SubType进行版本管理（例如： `Type=AccountOnboarding` , `SubType=v2` ）。每个Type/SubType在同一时间只能有一个版本处于激活状态。

核心命名空间区分：OmniStudio Core将Integration Procedure和OmniScript都存储在

OmniProcess

表中。使用

IsIntegrationProcedure = true

或

OmniProcessType = 'Integration Procedure'

来筛选IP。如果不添加筛选条件，查询结果会包含两种类型的记录，导致结果不准确。

重要提示——通过Data API创建IP：创建OmniProcess记录时，需设置
IsIntegrationProcedure = true
，才能将该记录标记为Integration Procedure。
OmniProcessType
下拉选项是由该布尔值自动计算生成，无法直接设置。此外，
Name
是
OmniProcess
的必填字段（标准OmniStudio文档中未提及）。请使用
sf api request rest --method POST --body @file.json
命令创建记录——
sf data create record --values
参数无法处理
PropertySetConfig
这类JSON文本域字段。

Workflow Design (5-Phase Pattern)

工作流设计（5阶段模式）

Phase 1: Requirements Gathering

阶段1：需求收集

Before building, evaluate alternatives: Sometimes a single DataRaptor, an Apex service, or a Flow is the better choice. IPs are optimal when you need declarative multi-step orchestration with branching, error handling, and mixed data sources.

Ask the user to gather:

Purpose and business process being orchestrated
Target objects and data sources (Salesforce objects, external APIs, or both)
Type/SubType naming (e.g.,
```
Type=OrderProcessing
```
,
```
SubType=Standard
```
)
Target org alias for deployment

Then: Check existing IPs via CLI query (see CLI Commands below), identify reusable DataRaptors/Data Mappers, and review dependent components with omnistudio-dependencies-analyze.

构建前评估替代方案：有时单个DataRaptor、Apex服务或Flow是更合适的选择。当您需要具备分支逻辑、错误处理并整合多数据源的声明式多步骤编排时，IP是最优选择。

请用户收集以下信息：

IP编排的用途和业务流程
目标对象和数据源（Salesforce对象、外部API，或两者皆有）
Type/SubType命名（例如：
```
Type=OrderProcessing
```
,
```
SubType=Standard
```
）
用于部署的目标组织别名

后续操作：通过CLI查询检查现有IP（见下文CLI命令），识别可复用的DataRaptor/Data Mapper，并使用omnistudio-dependencies-analyze审核依赖组件。

Phase 2: Design & Element Selection

阶段2：设计与元素选择

Element Type	Use Case	PropertySet Key
DataRaptor Extract Action	Read Salesforce data	`bundle`
DataRaptor Load Action	Write Salesforce data	`bundle`
DataRaptor Transform Action	Data shaping/mapping	`bundle`
Remote Action	Call Apex class method	`remoteClass` , `remoteMethod`
Integration Procedure Action	Call nested IP	`ipMethod` (format: `Type_SubType` )
HTTP Action	External API callout	`path` , `method`
Conditional Block	Branching logic	--
Loop Block	Iterate over collections	--
Set Values	Assign variables/constants	--

Naming Convention:

[Type]_[SubType]

using PascalCase. Element names within the IP should describe their action clearly (e.g.,

GetAccountDetails

ValidateInput

CreateOrderRecord

Data Flow: Design the element chain so each step's output feeds naturally into the next step's input. Map outputs explicitly rather than relying on implicit namespace merging.

元素类型	使用场景	PropertySet关键字
DataRaptor Extract Action	读取Salesforce数据	`bundle`
DataRaptor Load Action	写入Salesforce数据	`bundle`
DataRaptor Transform Action	数据格式化/映射	`bundle`
Remote Action	调用Apex类方法	`remoteClass` , `remoteMethod`
Integration Procedure Action	调用嵌套IP	`ipMethod` （格式： `Type_SubType` ）
HTTP Action	调用外部API	`path` , `method`
Conditional Block	分支逻辑	--
Loop Block	遍历集合	--
Set Values	分配变量/常量	--

命名规范：采用PascalCase格式的

[Type]_[SubType]

。IP内的元素名称应清晰描述其操作（例如：

GetAccountDetails

ValidateInput

CreateOrderRecord

）。

数据流设计：设计元素链时，确保每一步的输出自然流入下一步的输入。显式映射输出，而非依赖隐式命名空间合并。

Phase 3: Generation & Validation

阶段3：生成与验证

Build the IP definition with:

Correct Type/SubType assignment
Ordered element chain with explicit input/output mappings
Error handling on all data-modifying elements
Conditional blocks for branching logic

Validation (STRICT MODE):

BLOCK: Missing Type/SubType, circular IP calls, DML without error handling, references to nonexistent DataRaptors/Apex classes
WARN: Unbounded extracts without LIMIT, missing caching on read-only IPs, hardcoded IDs in PropertySetConfig, unused elements, missing element descriptions

Validation Report Format (6-Category Scoring 0-110): see

assets/scoring-report-format.txt

for the exact output layout.

构建IP定义时需包含：

正确的Type/SubType分配
有序的元素链及显式输入/输出映射
所有数据修改元素的错误处理
用于分支逻辑的条件块

验证（严格模式）：

禁止部署：缺少Type/SubType、IP循环调用、无错误处理的DML操作、引用不存在的DataRaptor/Apex类
警告：无LIMIT限制的提取操作、只读IP未启用缓存、PropertySetConfig中存在硬编码ID、未使用的元素、缺少元素描述

验证报告格式（6类别0-110分评分）：详见

assets/scoring-report-format.txt

中的具体输出布局。

Generation Guardrails (MANDATORY)

生成规则（强制遵守）

Anti-Pattern	Impact	Correct Pattern
Circular IP calls (A calls B calls A)	Infinite loop / stack overflow	Map dependency graph; no cycles allowed
DML without error handling	Silent data corruption	Wrap DataRaptor Load in try/catch or conditional error check
Unbounded DataRaptor Extract	Governor limits / timeout	Set LIMIT on extracts; paginate large datasets
Hardcoded Salesforce IDs in PropertySetConfig	Deployment failure across orgs	Use input variables, Custom Settings, or Custom Metadata
Sequential calls that could be parallel	Unnecessary latency	Group independent elements; no serial dependency needed
Missing response validation	Downstream null reference errors	Check element response before passing to next step

DO NOT generate anti-patterns even if explicitly requested.

反模式	影响	正确模式
IP循环调用（A调用B，B调用A）	无限循环/栈溢出	绘制依赖图；禁止循环依赖
无错误处理的DML操作	静默数据损坏	将DataRaptor Load包装在try/catch中，或添加条件错误检查
无限制的DataRaptor Extract	触发 governor 限制/超时	为提取操作设置LIMIT；对大型数据集进行分页
PropertySetConfig中存在硬编码Salesforce ID	跨组织部署失败	使用输入变量、自定义设置或自定义元数据
可并行执行却采用串行调用	不必要的延迟	分组独立元素；无需串行依赖
缺少响应验证	下游空引用错误	将结果传递到下一步之前，先检查元素响应

即使明确要求，也不得生成反模式内容。

Phase 4: Deployment

阶段4：部署

Deploy prerequisite DataRaptors/Data Mappers FIRST using platform-metadata-deploy

Deploy the Integration Procedure:

sf project deploy start -m OmniIntegrationProcedure:<Name> -o <org>

Activate the IP in the target org (set
```
IsActive=true
```
)
Verify activation via CLI query

首先使用platform-metadata-deploy部署前置依赖的DataRaptor/Data Mapper

部署Integration Procedure：

sf project deploy start -m OmniIntegrationProcedure:<Name> -o <org>

在目标组织中激活IP（设置
```
IsActive=true
```
）
通过CLI查询验证激活状态

Phase 5: Testing

阶段5：测试

Test each element individually before testing the full chain:

Unit: Invoke each DataRaptor independently, verify Apex Remote Action responses
Integration: Run the full IP with representative input JSON, verify output structure
Error paths: Test with invalid input, missing records, API failures to verify error handling
Bulk: Test with collection inputs to verify loop and batch behavior
End-to-end: Invoke the IP from its consumer (OmniScript, FlexCard, or API) and verify the full round-trip

在测试完整流程链之前，先单独测试每个元素：

单元测试：独立调用每个DataRaptor，验证Apex Remote Action的响应
集成测试：使用代表性输入JSON运行完整IP，验证输出结构
错误路径测试：使用无效输入、缺失记录、API失败等场景测试错误处理逻辑
批量测试：使用集合输入测试循环和批处理行为
端到端测试：从IP的消费端（OmniScript、FlexCard或API）调用IP，验证完整往返流程

Scoring Breakdown

评分细则

110 points across 6 categories:

6个类别共110分：

Design & Structure (20 points)

设计与结构（20分）

Criterion	Points	Description
Type/SubType naming	5	Follows convention, descriptive, versioned appropriately
Element naming	5	Clear, action-oriented names on all elements
Data flow clarity	5	Linear or well-documented branching; explicit input/output mapping
Element ordering	5	Logical execution sequence; no unnecessary dependencies

评估标准	分值	描述
Type/SubType命名	5	符合规范、描述清晰、版本管理合理
元素命名	5	所有元素名称清晰、以动作导向
数据流清晰度	5	线性或有完整文档说明的分支逻辑；显式输入/输出映射
元素顺序	5	执行顺序符合逻辑；无不必要的依赖

Data Operations (25 points)

数据操作（25分）

Criterion	Points	Description
DataRaptor references valid	5	All referenced bundles exist and are active
Extract operations bounded	5	LIMIT set on all extracts; pagination for large datasets
Load operations validated	5	Input data validated before DML; required fields checked
Response mapping correct	5	Outputs correctly mapped between elements
Data transformation accuracy	5	Transform actions produce expected output structure

评估标准	分值	描述
DataRaptor引用有效	5	所有引用的bundle均存在且处于激活状态
提取操作有限制	5	所有提取操作均设置LIMIT；对大型数据集进行分页
加载操作已验证	5	DML操作前验证输入数据；检查必填字段
响应映射正确	5	元素间输出映射正确
数据转换准确性	5	转换操作生成预期的输出结构

Error Handling (20 points)

错误处理（20分）

Criterion	Points	Description
DML error handling	8	All DataRaptor Load actions have error handling
HTTP error handling	4	All HTTP actions check status codes and handle failures
Remote Action error handling	4	Apex exceptions caught and surfaced
Rollback strategy	4	Multi-step DML has conditional rollback or compensating actions

评估标准	分值	描述
DML错误处理	8	所有DataRaptor Load操作均有错误处理
HTTP错误处理	4	所有HTTP操作均检查状态码并处理失败场景
Remote Action错误处理	4	捕获Apex异常并反馈
回滚策略	4	多步骤DML操作具备条件回滚或补偿动作

Performance (20 points)

性能（20分）

Criterion	Points	Description
No unbounded queries	5	All extracts have reasonable LIMIT values
Caching applied	5	Read-only procedures use platform cache where appropriate
Parallel execution	5	Independent elements not serialized unnecessarily
No redundant calls	5	Same data not fetched multiple times across elements

评估标准	分值	描述
无无限制查询	5	所有提取操作均设置合理的LIMIT值
已应用缓存	5	只读流程在合适场景下使用平台缓存
并行执行	5	独立元素未被不必要地串行化
无冗余调用	5	未在多个元素中重复获取相同数据

Security (15 points)

安全性（15分）

Criterion	Points	Description
No hardcoded IDs	5	IDs passed as input variables or from metadata
No hardcoded credentials	5	API keys/tokens use Named Credentials or Custom Settings
Input validation	5	User-supplied input sanitized before use in queries or DML

评估标准	分值	描述
无硬编码ID	5	ID通过输入变量或元数据传递
无硬编码凭证	5	API密钥/令牌使用命名凭证或自定义设置
输入验证	5	用户提供的输入在用于查询或DML前已被清理

Documentation (10 points)

文档（10分）

Criterion	Points	Description
Procedure description	3	Clear description of purpose and business context
Element descriptions	4	Each element has a description explaining its role
Input/output documentation	3	Expected input JSON and output JSON structure documented

评估标准	分值	描述
流程描述	3	清晰描述用途和业务背景
元素描述	4	每个元素均有描述其作用的说明
输入/输出文档	3	记录预期的输入JSON和输出JSON结构

CLI Commands

CLI命令

Read
scripts/cli-commands.sh
before querying or deploying Integration Procedures — it contains all SOQL queries and

sf project

deploy/retrieve commands ready to adapt.

Core Namespace Note: The

IsIntegrationProcedure=true

filter is REQUIRED (or equivalently

OmniProcessType='Integration Procedure'

). OmniScript and Integration Procedure records share the

OmniProcess

sObject. Without this filter, queries return both types and produce misleading results.

查询或部署Integration Procedure前，请阅读

scripts/cli-commands.sh

——其中包含所有可直接调整使用的SOQL查询和

sf project

部署/检索命令。

核心命名空间注意事项：必须添加

IsIntegrationProcedure=true

筛选条件（或等效的

OmniProcessType='Integration Procedure'

）。OmniScript和Integration Procedure记录共享

OmniProcess

sObject。如果不添加筛选条件，查询结果会包含两种类型的记录，导致结果不准确。

Cross-Skill Integration

跨技能集成

From Skill	To omnistudio-integration-procedure-generate	When
omnistudio-dependencies-analyze	-> omnistudio-integration-procedure-generate	"Analyze dependencies before building IP"
omnistudio-datamapper-generate	-> omnistudio-integration-procedure-generate	"DataRaptor/Data Mapper is ready, wire it into IP"
platform-apex-generate	-> omnistudio-integration-procedure-generate	"Apex Remote Action class deployed, configure in IP"

From omnistudio-integration-procedure-generate	To Skill	When
omnistudio-integration-procedure-generate	-> platform-metadata-deploy	"Deploy IP to target org"
omnistudio-integration-procedure-generate	-> omnistudio-omniscript-generate	"IP is active, build OmniScript that calls it"
omnistudio-integration-procedure-generate	-> omnistudio-flexcard-generate	"IP is active, build FlexCard data source"
omnistudio-integration-procedure-generate	-> omnistudio-dependencies-analyze	"Verify IP dependency graph before deployment"

来源技能	指向omnistudio-integration-procedure-generate	触发时机
omnistudio-dependencies-analyze	-> omnistudio-integration-procedure-generate	"构建IP前分析依赖关系"
omnistudio-datamapper-generate	-> omnistudio-integration-procedure-generate	"DataRaptor/Data Mapper已就绪，将其接入IP"
platform-apex-generate	-> omnistudio-integration-procedure-generate	"Apex Remote Action类已部署，在IP中配置"

来源omnistudio-integration-procedure-generate	指向技能	触发时机
omnistudio-integration-procedure-generate	-> platform-metadata-deploy	"将IP部署到目标组织"
omnistudio-integration-procedure-generate	-> omnistudio-omniscript-generate	"IP已激活，构建调用它的OmniScript"
omnistudio-integration-procedure-generate	-> omnistudio-flexcard-generate	"IP已激活，构建FlexCard数据源"
omnistudio-integration-procedure-generate	-> omnistudio-dependencies-analyze	"部署前验证IP依赖图"

Edge Cases

边缘场景

Scenario	Solution
IP calls itself (direct recursion)	Block at design time; circular dependency check is mandatory
IP calls IP that calls original (indirect recursion)	Map full call graph; omnistudio-dependencies-analyze detects cycles
DataRaptor not yet deployed	Deploy DataRaptors first; IP deployment will fail on missing references
External API timeout	Set timeout values on HTTP Action elements; implement retry logic or graceful degradation
Large collection input to Loop Block	Set batch size; test with realistic data volumes to avoid CPU timeout
Type/SubType collision with existing IP	Query existing IPs before creating; SubType versioning avoids collisions
Mixed namespace (Vlocity vs Core)	Confirm org namespace; element property names differ between packages

Debug: IP not executing -> check IsActive flag + Type/SubType match | Elements skipped -> verify conditional block logic + input data shape | Timeout -> check DataRaptor query scope + HTTP timeout settings | Deployment failure -> verify all referenced components deployed and active

场景	解决方案
IP自调用（直接递归）	设计阶段禁止；必须检查循环依赖
IP调用另一个IP，后者再调用原IP（间接递归）	绘制完整调用图；omnistudio-dependencies-analyze可检测循环
DataRaptor尚未部署	先部署DataRaptor；IP部署会因引用缺失而失败
外部API超时	在HTTP Action元素中设置超时值；实现重试逻辑或优雅降级
Loop Block输入大型集合	设置批处理大小；使用真实数据量测试以避免CPU超时
Type/SubType与现有IP冲突	创建前查询现有IP；使用SubType版本管理避免冲突
混合命名空间（Vlocity vs Core）	确认组织命名空间；不同包的元素属性名称不同

调试指南：IP未执行 -> 检查IsActive标志 + Type/SubType是否匹配 | 元素被跳过 -> 验证条件块逻辑 + 输入数据格式 | 超时 -> 检查DataRaptor查询范围 + HTTP超时设置 | 部署失败 -> 验证所有引用组件已部署并激活

Output Expectations

输出预期

Deliverables produced by this skill:

Integration Procedure JSON (
```
assets/omni-process-ip.json
```
template) —
```
OmniProcess
```
record ready for REST API creation with
```
IsIntegrationProcedure=true
```

Element JSON records (

assets/omni-process-element-dr-extract.json

assets/omni-process-element-set-values.json

templates) —

OmniProcessElement

records for each action step with

PropertySetConfig

wired

Validation report — 110-point score across 6 categories with deploy/review/block threshold result
Deployment checklist — confirms prerequisite DataRaptors are active, IP is activated, and consuming OmniScript or FlexCard can invoke it

此技能生成的交付物：

Integration Procedure JSON（
```
assets/omni-process-ip.json
```
模板）——设置
```
IsIntegrationProcedure=true
```
后，可通过REST API创建的
```
OmniProcess
```
记录

元素JSON记录（

assets/omni-process-element-dr-extract.json

、

assets/omni-process-element-set-values.json

模板）——每个动作步骤对应的

OmniProcessElement

记录，已配置好

PropertySetConfig

验证报告——6个类别共110分的评分结果，包含可部署/需审核/禁止部署的阈值判定
部署检查清单——确认前置DataRaptor已激活、IP已激活，且消费端OmniScript或FlexCard可调用它

Notes

注意事项

API: Latest (check current Salesforce release notes; was 66.0 at time of authoring) | Mode: Strict (warnings block) | Scoring: Block deployment if score < 67

Dependencies (optional): platform-metadata-deploy, omnistudio-datamapper-generate, omnistudio-dependencies-analyze

Creating IPs programmatically: Use REST API (

sf api request rest --method POST --body @file.json

). Required fields:

Name

Type

SubType

Language

VersionNumber

IsIntegrationProcedure=true

. Then create

OmniProcessElement

child records for each action step (also via REST API for JSON PropertySetConfig). Activate by setting

IsActive=true

after all elements are created.

API版本：最新版本（请查看当前Salesforce发布说明；编写本文时为66.0） | 模式：严格模式（警告会阻止部署） | 评分规则：评分低于67分时禁止部署

依赖项（可选）：platform-metadata-deploy、omnistudio-datamapper-generate、omnistudio-dependencies-analyze

程序化创建IP：使用REST API（

sf api request rest --method POST --body @file.json

）。必填字段：

Name

、

Type

、

SubType

、

Language

、

VersionNumber

、

IsIntegrationProcedure=true

。然后为每个动作步骤创建

OmniProcessElement

子记录（同样通过REST API处理JSON格式的

PropertySetConfig

）。所有元素创建完成后，设置

IsActive=true

激活IP。

Reference File Index

参考文件索引

File	When to read
`assets/omni-process-ip.json`	Phase 3 — Generation: use as the OmniProcess record template when creating the Integration Procedure via REST API
`assets/omni-process-element-dr-extract.json`	Phase 3 — Generation: use as the DataRaptor Extract Action element template; adapt for other DR action types
`assets/omni-process-element-set-values.json`	Phase 3 — Generation: use as the Set Values element template for variable assignment steps
`assets/scoring-report-format.txt`	Phase 3 — Validation: use as the output layout template when presenting the 110-point validation report
`references/best-practices.md`	Phase 2-5 — Design patterns: element composition, error handling, caching, parallel execution, and security guidance
`references/element-types.md`	Phase 2 — Element selection: read before configuring PropertySetConfig for any element type
`scripts/cli-commands.sh`	Phase 1 & 4 — CLI queries and deploy/retrieve commands; adapt by replacing `<Name>` and `<org>` placeholders

文件	阅读时机
`assets/omni-process-ip.json`	阶段3——生成：通过REST API创建Integration Procedure时，用作OmniProcess记录模板
`assets/omni-process-element-dr-extract.json`	阶段3——生成：用作DataRaptor Extract Action元素模板；可适配其他DR动作类型
`assets/omni-process-element-set-values.json`	阶段3——生成：用作Set Values元素模板，用于变量分配步骤
`assets/scoring-report-format.txt`	阶段3——验证：生成110分制验证报告时，用作输出布局模板
`references/best-practices.md`	阶段2-5——设计模式：元素组合、错误处理、缓存、并行执行和安全指南
`references/element-types.md`	阶段2——元素选择：配置任何元素类型的PropertySetConfig前阅读
`scripts/cli-commands.sh`	阶段1 & 4——CLI查询和部署/检索命令；替换 `<Name>` 和 `<org>` 占位符后使用