Agent Skills

omnistudio-datapacks-deploy

devopsforcedotcom4.7K installs

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 platfo

Install

npx skills add https://github.com/forcedotcom/sf-skills --skill omnistudio-datapacks-deploy
SKILL.md

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:

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:

  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

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

azure-diagnosticsmicrosoft608KDebug Azure production issues on Azure using AppLens, Azure Monitor, resource health, and safe triage. WHEN: debug production issues, troubleshoot app service, app service high CPU, app service deployment failure, troubleshoot container apps, troubleshoot functions, troubleshoot AKS, VM RDP, Linux SSH, VM black screen, can't connect to VM, reset VM password, NSG or firewall blocking, kubectl cannot connect, kube-system/CoreDNS failures, pod pending, crashloop, node not ready, upgrade failures, aazure-preparemicrosoft608KPrepare azd-based Azure projects for deployment: generates azure.yaml, infrastructure (Bicep/Terraform), and Dockerfiles for the Azure Developer CLI (azd) workflow. USE ONLY when the user explicitly wants to use azd as the deployment tool, or the project already has an azure.yaml file. DO NOT USE FOR: non-azd deployments, Python App Service code-only deploys (use python-appservice-deploy), or cross-cloud migration (use azure-cloud-migrate). WHEN: prepare app for azd, create azure.yaml, set up azazure-aimicrosoft608KUse for Azure AI: Search, Speech, OpenAI, Document Intelligence. Helps with search, vector/hybrid search, speech-to-text, text-to-speech, transcription, OCR. WHEN: AI Search, query search, vector search, hybrid search, semantic search, speech-to-text, text-to-speech, transcribe, OCR, convert text to speech.azure-deploymicrosoft607KExecute Azure deployments for ALREADY-PREPARED applications that have existing .azure/deployment-plan.md and infrastructure files. DO NOT use this skill when the user asks to CREATE a new application — use azure-prepare instead. This skill runs azd up, azd deploy, terraform apply, and az deployment commands with built-in error recovery. Requires .azure/deployment-plan.md from azure-prepare and validated status from azure-validate. WHEN: \"run azd up\", \"run azd deploy\", \"execute deployment\",

Search skills and MCP servers

Fuzzy search across 23,137 skills and servers