forcedotcom/sf-skills

omnistudio-datapacks-deploy

Salesforce Industries DataPack deployment automation using Vlocity Build.

查看源码

使用方法

  1. 复制安装命令,在自己的智能体环境安装前先检查源码包。
  2. 从原始文档核对所需工具、凭据和支持的宿主。
  3. 说明输入材料与期望交付物,并对照来源检查输出。
npx skills add https://github.com/forcedotcom/sf-skills --skill omnistudio-datapacks-deploy

开始前需了解

  • 安装不包含模型订阅、API 额度或访问文件的权限。
  • 仓库星数和安装量反映活跃情况,不等于独立质量或安全测试。
仓库原始内容

按源仓库内容呈现,保留标题、案例、代码、表格、链接以及原文引用的演示图片。

omnistudio-datapacks-deploy: Vlocity Build DataPack Deployment

Use this skill when the user needs Vlocity DataPack deployment orchestration: export/deploy workflow, manifest-driven deploys, failure triage, and CI/CD sequencing for OmniStudio/Industries DataPacks.


Scope

Use omnistudio-datapacks-deploy when work involves:

  • vlocity packDeploy, packRetry, packContinue, packExport, packGetDiffs, validateLocalData
  • DataPack job-file design (projectPath, expansionPath, manifest, queries)
  • org-to-org DataPack migration and retry loops
  • troubleshooting DataPack dependency, matching-key, and GlobalKey issues

Delegate elsewhere when the user is:


Critical Operating Rules

  • Use Vlocity Build (`vlocity`) commands for DataPacks, not sf project deploy.
  • Prefer Salesforce CLI auth integration (-sfdx.username <alias>) over username/password files when available.
  • Always run a pre-deploy quality gate before full deploy:

1) validateLocalData 2) optional packGetDiffs 3) then packDeploy

  • Use packRetry repeatedly when error counts are dropping; stop when retries no longer improve results.
  • Keep matching-key strategy and GlobalKey integrity consistent across source and target orgs.

Required Context to Gather First

Ask for or infer:

  • source org and target org aliases
  • job file path and DataPack project path
  • deployment scope (full project, manifest subset, or specific -key)
  • whether this is export, deploy, retry, continue, or diff-only
  • namespace model (%vlocity_namespace%, vlocity_cmt, or core)
  • known constraints (new sandbox bootstrap, trigger behavior, matching key customizations)

Preflight checks:

bash
vlocity help
sf org list
sf org display --target-org <alias> --json
test -f <job-file>.yaml

Recommended Workflow

1. Ensure tool readiness

bash
npm install --global vlocity
vlocity help

2. Validate project data locally

bash
vlocity -sfdx.username <source-alias> -job <job-file>.yaml validateLocalData

Use --fixLocalGlobalKeys only when explicitly requested and after explaining impact.

3. Export from source (when needed)

bash
vlocity -sfdx.username <source-alias> -job <job-file>.yaml packExport
vlocity -sfdx.username <source-alias> -job <job-file>.yaml packRetry

4. Deploy to target

bash
vlocity -sfdx.username <target-alias> -job <job-file>.yaml packDeploy
vlocity -sfdx.username <target-alias> -job <job-file>.yaml packRetry

5. Continue interrupted jobs

bash
vlocity -sfdx.username <target-alias> -job <job-file>.yaml packContinue

6. Verify post-deploy parity

bash
vlocity -sfdx.username <target-alias> -job <job-file>.yaml packGetDiffs

Job-file starter: references/job-file-template.md


Gotchas

Error / symptomLikely causeDefault fix direction
No match found for ...missing dependency in target orginclude missing DataPack key and redeploy
Duplicate Results found for ... GlobalKeyduplicate records in targetclean duplicates and re-run deploy
Multiple Imported Records ... same Salesforce Recordsource duplicate matching-key recordsremove duplicates in source and re-export
No Configuration Foundoutdated DataPack settingsrun packUpdateSettings or enable autoUpdateSettings
Some records were not processedsettings mismatch / partial dependency staterefresh settings both orgs, then retry
SASS / template compile failuresmissing referenced UI template assetsexport/deploy referenced template dependencies first

Detailed matrix: references/troubleshooting-matrix.md


CI/CD Guidance

Default pipeline shape:

  1. authenticate orgs (sf org login ...)
  2. validate local DataPack integrity (validateLocalData)
  3. export changed scope (packExport or manifest-driven export)
  4. deploy (packDeploy)
  5. retry loop (packRetry) until stable
  6. compare (packGetDiffs) and publish deployment report

For incremental deploy optimization, use job-file options such as:

  • gitCheck: true
  • gitCheckKey: <folder>
  • manifest for deterministic scope control

Cross-Skill Integration

NeedDelegate toReason
metadata deploy outside DataPacksplatform-metadata-deployMetadata API workflows
OmniStudio component authoringomnistudio-*-buildbuild artifacts before deploy
EPC product and offer payload authoringomnistudio-epc-catalog-generateProduct2/DataPack model quality
Apex trigger/log error diagnosisplatform-apex-logs-debug, platform-apex-generateautomation-side root-cause fixes

Output Expectations

After completing a DataPack operation, deliver a completion block:

text
DataPack goal: <export / deploy / retry / diff / ci-cd>
Source org: <alias or N/A>
Target org: <alias or N/A>
Scope: <job file + manifest/key/full>
Result: <passed / failed / partial>
Key findings: <errors, dependencies, retries, diffs>
Next step: <safe follow-up action>

Reference File Index

FileWhen to read
references/job-file-template.mdBefore advising on job file structure — load as baseline configuration reference
references/troubleshooting-matrix.mdWhen user reports deploy failures — load to diagnose DataPack errors and apply fix directions
examples/business-internet-plus-bundle/TRANSCRIPT.mdExample of validation planning and execution for a Product2 bundle
examples/business-internet-plus-bundle/deploy-business-internet-plus-bundle.yamlExample job file for scope-limited validateLocalData run
examples/business-internet-plus-bundle-deploy/TRANSCRIPT.mdExample of full deploy cycle including packDeploy and packRetry outcomes
examples/business-internet-plus-bundle-deploy/deploy-business-internet-plus-bundle.yamlExample job file for staged deployment with manifest targeting

按任务相关推荐

来自同一仓库

更多 Skills

全部 Skills
forcedotcom
社区

design-systems-slds-apply

Apply SLDS-compliant UI using the correct blueprints, styling hooks, utility classes, and icons. Use when building any UI that needs SLDS, choosing between Lightning Base Components and SLDS Blueprints, applying styling hooks for theming, using utility classes for layout and spacing, or selecting icons. Triggers include \"build a modal\", \"create a form\", \"data table\", \"SLDS styling\", \"style with hooks\", \"add an icon\".

1小时安装量
1
GitHub Stars
1172
最近更新
11月13日
forcedotcom
社区

dx-code-analyzer-run

Run Salesforce Code Analyzer to scan code for security, performance, best practice, and code style violations. Supports all engines (PMD, ESLint, CPD, RetireJS, Flow, SFGE, ApexGuru), targets (files, folders, git diff), categories, and severities. Also handles post-scan exploration: filtering results by engine/severity/category/file, and explaining what rules mean. TRIGGER when: user says 'scan my code', 'check security issues', 'run PMD/ESLint', 'find duplicates', 'analyze Flows', 'check vulner

1小时安装量
1
GitHub Stars
1172
最近更新
11月13日
forcedotcom
社区

experience-lwc-accessibility-jest-run

Use ALWAYS when running Sa11y accessibility Jest tests for an LWC — locally before pushing, producing the command(s), running one file vs a suite, selecting tests by naming convention, saving Sa11y-rendered HTML, or reproducing a Sa11y/A11yBug failure. Covers core (Bazel; bazel test // : ) and standalone npx jest (.accessibility.test.js, @sa11y/jest). REQUIRED for a run-plan.md, a failing a11y test's exit code, or SA11Y/A11yBug/core-Bazel test paths. DO NOT TRIGGER for functional Jest tests, a11

1小时安装量
1
GitHub Stars
1172
最近更新
11月13日
forcedotcom
社区

experience-lwc-generate

Lightning Web Components with PICKLES methodology and 165-point scoring. Use this skill when the user creates or edits LWC components, builds wire service patterns, or writes Jest tests for LWC. TRIGGER when: user creates/edits LWC components, touches lwc//.js, .html, .css, .js-meta.xml files, or asks about wire service, SLDS, or Jest LWC tests. DO NOT TRIGGER when: Apex classes (use platform-apex-generate), Aura components, or Visualforce.

1小时安装量
1
GitHub Stars
1172
最近更新
11月13日