omnistudio-datapacks-deploy
forcedotcom/sf-skills
Automate Salesforce OmniStudio DataPack deployment, validation, and retry workflows using Vlocity Build.
What is omnistudio-datapacks-deploy?
This skill orchestrates Vlocity DataPack export, deployment, validation, and troubleshooting for Salesforce Industries. Use it when deploying or validating OmniStudio DataPacks with vlocity commands, setting up DataPack CI/CD pipelines, or diagnosing migration errors—not for standard metadata deployment or artifact authoring.
- Execute vlocity packDeploy, packRetry, packExport, and packGetDiffs commands with org authentication
- Design and validate DataPack job files with manifest-driven scope control and dependency resolution
- Run pre-deploy quality gates including validateLocalData and packGetDiffs to catch errors early
- Troubleshoot DataPack failures: matching-key mismatches, GlobalKey duplicates, missing dependencies, and settings conflicts
- Orchestrate multi-step retry loops and continue interrupted deployments to reach stable state
- Integrate DataPack CI/CD pipelines with git-based change detection and incremental deployment optimization
How to install omnistudio-datapacks-deploy
npx skills add https://github.com/forcedotcom/sf-skills --skill omnistudio-datapacks-deploy- npm ≥9.0.0 and npx ≥9.0.0 installed globally
- Salesforce CLI (sf) ≥2.0.0 installed and authenticated to source and target orgs
- Vlocity Build CLI (vlocity) ≥1.16.0 installed globally via npm
- Valid job file (.yaml) with projectPath, expansionPath, and deployment configuration
How to use omnistudio-datapacks-deploy
- 1.Install Vlocity Build globally: npm install --global vlocity
- 2.Authenticate source and target orgs using sf org login or existing aliases
- 3.Prepare or review the job file with projectPath, manifest, and deployment scope
- 4.Run validateLocalData to check DataPack integrity before deployment
- 5.Execute packExport to extract DataPacks from source org if needed
- 6.Run packDeploy to deploy DataPacks to target org
- 7.Use packRetry repeatedly until error counts stabilize or reach zero
- 8.Run packGetDiffs to verify post-deploy parity between orgs
Use cases
- Migrate OmniStudio configurations from sandbox to production with validation and retry safeguards
- Export DataPacks from a source org and deploy to multiple target orgs with dependency sequencing
- Diagnose and resolve DataPack deployment failures by analyzing error logs and applying targeted fixes
- Set up automated CI/CD pipelines that validate, export, and deploy DataPacks on code commit
- Bootstrap new sandboxes by deploying complete DataPack bundles with matching-key and GlobalKey integrity checks
- Salesforce Industries solution architects managing DataPack migrations
- DevOps engineers building DataPack CI/CD pipelines
- Salesforce administrators troubleshooting OmniStudio deployment failures
- Integration engineers coordinating org-to-org DataPack transfers
omnistudio-datapacks-deploy FAQ
Use omnistudio-datapacks-deploy for Vlocity DataPack operations (packDeploy, packExport, packRetry). Use platform-metadata-deploy for standard Salesforce metadata deployment via sf project deploy.
validateLocalData checks DataPack integrity locally before deployment, catching matching-key mismatches, GlobalKey duplicates, and missing dependencies. Always run it as a pre-deploy quality gate before packDeploy.
'No match found' means a dependency is missing in the target org—include the missing DataPack key and redeploy. 'Duplicate Results' means duplicate records exist in the target—clean duplicates and re-run deploy.
Yes, use packRetry repeatedly when error counts are dropping. Stop when retries no longer improve results or errors stabilize, then investigate root causes.
Authenticate orgs → validateLocalData → packExport (or manifest-driven export) → packDeploy → packRetry loop → packGetDiffs → publish report. Use job-file options like gitCheck for incremental optimization.
Full instructions (SKILL.md)
Source of truth, from forcedotcom/sf-skills.
name: omnistudio-datapacks-deploy description: "Salesforce Industries DataPack deployment automation using Vlocity Build. TRIGGER when: user deploys or validates OmniStudio/Vlocity DataPacks with vlocity commands (packDeploy/packRetry/packExport/packGetDiffs), sets up DataPack CI/CD pipelines, or troubleshoots DataPack migration errors. DO NOT TRIGGER when: deploying Salesforce metadata with sf project deploy (use platform-metadata-deploy), authoring OmniStudio artifacts (use omnistudio-*-build), or writing Apex/LWC business logic (use platform-apex-generate/experience-lwc-generate)." metadata: cliTools: - tool: ["npm"] semver: ">=9.0.0" - tool: ["npx"] semver: ">=9.0.0" - tool: ["sf"] semver: ">=2.0.0" - tool: ["vlocity"] semver: ">=1.16.0" relatedSkills: - "experience-lwc-generate" - "omnistudio-epc-catalog-generate" - "omnistudio-flexcard-generate" - "omnistudio-integration-procedure-generate" - "omnistudio-omniscript-generate" - "platform-apex-generate" - "platform-apex-logs-debug" - "platform-metadata-deploy" version: "1.0" domains: ["OmniStudio"]
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:
- deploying standard metadata with
sf project deploy-> platform-metadata-deploy - building OmniScripts, FlexCards, IPs, or Data Mappers ->
omnistudio-*-build - designing Product2 EPC bundles -> omnistudio-epc-catalog-generate
- writing Apex/LWC code -> platform-apex-generate, experience-lwc-generate
Critical Operating Rules
- Use Vlocity Build (
vlocity) commands for DataPacks, notsf 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:
validateLocalData- optional
packGetDiffs - then
packDeploy
- Use
packRetryrepeatedly 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:
vlocity help
sf org list
sf org display --target-org <alias> --json
test -f <job-file>.yaml
Recommended Workflow
1. Ensure tool readiness
npm install --global vlocity
vlocity help
2. Validate project data locally
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)
vlocity -sfdx.username <source-alias> -job <job-file>.yaml packExport
vlocity -sfdx.username <source-alias> -job <job-file>.yaml packRetry
4. Deploy to target
vlocity -sfdx.username <target-alias> -job <job-file>.yaml packDeploy
vlocity -sfdx.username <target-alias> -job <job-file>.yaml packRetry
5. Continue interrupted jobs
vlocity -sfdx.username <target-alias> -job <job-file>.yaml packContinue
6. Verify post-deploy parity
vlocity -sfdx.username <target-alias> -job <job-file>.yaml packGetDiffs
Job-file starter: references/job-file-template.md
Gotchas
| Error / symptom | Likely cause | Default fix direction |
|---|---|---|
No match found for ... | missing dependency in target org | include missing DataPack key and redeploy |
Duplicate Results found for ... GlobalKey | duplicate records in target | clean duplicates and re-run deploy |
Multiple Imported Records ... same Salesforce Record | source duplicate matching-key records | remove duplicates in source and re-export |
No Configuration Found | outdated DataPack settings | run packUpdateSettings or enable autoUpdateSettings |
Some records were not processed | settings mismatch / partial dependency state | refresh settings both orgs, then retry |
| SASS / template compile failures | missing referenced UI template assets | export/deploy referenced template dependencies first |
Detailed matrix: references/troubleshooting-matrix.md
CI/CD Guidance
Default pipeline shape:
- authenticate orgs (
sf org login ...) - validate local DataPack integrity (
validateLocalData) - export changed scope (
packExportor manifest-driven export) - deploy (
packDeploy) - retry loop (
packRetry) until stable - compare (
packGetDiffs) and publish deployment report
For incremental deploy optimization, use job-file options such as:
gitCheck: truegitCheckKey: <folder>manifestfor deterministic scope control
Cross-Skill Integration
| Need | Delegate to | Reason |
|---|---|---|
| metadata deploy outside DataPacks | platform-metadata-deploy | Metadata API workflows |
| OmniStudio component authoring | omnistudio-*-build | build artifacts before deploy |
| EPC product and offer payload authoring | omnistudio-epc-catalog-generate | Product2/DataPack model quality |
| Apex trigger/log error diagnosis | platform-apex-logs-debug, platform-apex-generate | automation-side root-cause fixes |
Output Expectations
After completing a DataPack operation, deliver a completion block:
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
| File | When to read |
|---|---|
references/job-file-template.md | Before advising on job file structure — load as baseline configuration reference |
references/troubleshooting-matrix.md | When user reports deploy failures — load to diagnose DataPack errors and apply fix directions |
examples/business-internet-plus-bundle/TRANSCRIPT.md | Example of validation planning and execution for a Product2 bundle |
examples/business-internet-plus-bundle/deploy-business-internet-plus-bundle.yaml | Example job file for scope-limited validateLocalData run |
examples/business-internet-plus-bundle-deploy/TRANSCRIPT.md | Example of full deploy cycle including packDeploy and packRetry outcomes |
examples/business-internet-plus-bundle-deploy/deploy-business-internet-plus-bundle.yaml | Example job file for staged deployment with manifest targeting |
Related skills
More from forcedotcom/sf-skills and the wider catalog.

omnistudio-dependencies-analyze
Analyze OmniStudio dependencies, detect namespaces, and visualize component impact across your org.

omnistudio-epc-catalog-generate
Create and model Salesforce EPC product bundles, attributes, and offer catalogs with DataPack JSON templates.

omnistudio-flexcard-generate
Create and validate OmniStudio FlexCard UI components with 130-point scoring for Salesforce Industries.

omnistudio-integration-procedure-generate
Create and validate OmniStudio Integration Procedures with 110-point scoring for server-side process orchestration.

omnistudio-omniscript-generate
Build guided multi-step OmniScripts with 120-point validation scoring for Salesforce OmniStudio.

orchestrating-datacloud
Orchestrate multi-phase Salesforce Data Cloud pipelines: connect, prepare, harmonize, segment, and act.