PluginBench
Skill
Pass
Audit score 90

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
Prerequisites
  • 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
Claude Code
Cursor
Windsurf
Cline

How to use omnistudio-datapacks-deploy

  1. 1.Install Vlocity Build globally: npm install --global vlocity
  2. 2.Authenticate source and target orgs using sf org login or existing aliases
  3. 3.Prepare or review the job file with projectPath, manifest, and deployment scope
  4. 4.Run validateLocalData to check DataPack integrity before deployment
  5. 5.Execute packExport to extract DataPacks from source org if needed
  6. 6.Run packDeploy to deploy DataPacks to target org
  7. 7.Use packRetry repeatedly until error counts stabilize or reach zero
  8. 8.Run packGetDiffs to verify post-deploy parity between orgs

Use cases

Good for
  • 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
Who it's for
  • 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

When should I use omnistudio-datapacks-deploy vs. platform-metadata-deploy?

Use omnistudio-datapacks-deploy for Vlocity DataPack operations (packDeploy, packExport, packRetry). Use platform-metadata-deploy for standard Salesforce metadata deployment via sf project deploy.

What does validateLocalData do and when should I run it?

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.

How do I handle 'No match found' or 'Duplicate Results' errors?

'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.

Can I use packRetry multiple times, and when should I stop?

Yes, use packRetry repeatedly when error counts are dropping. Stop when retries no longer improve results or errors stabilize, then investigate root causes.

What is the recommended CI/CD pipeline shape for DataPacks?

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, 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:

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 / 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:

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