forcedotcom/sf-skills/consumer-goods-tpe-datakit-deploy
Claude Code and agent skill by forcedotcom/sf-skills
- community
Checking that the SKILL.md file is still in the repository.
Deploy the TPM Accruals Data Kit components specifically required for Trade Promotion Effectiveness (TPE) dashboards. Use when a customer or admin wants to install or deploy the TPM data kit for TPE dashboards, or as a delegated step from consumer-goods-tpe-dashboard-configure. Do not use this skill if the customer wants to deploy the TPM Accruals Data Kit for the Accruals feature.
Install
npx vskill@latest install forcedotcom/sf-skills/consumer-goods-tpe-datakit-deploySKILL.md
The same SKILL.md was published earlier as forcedotcom/sf-skills/consumer-goods-tpe-datakit-deploy.
TPE Data Kit Deploy
Deploys the TPM Accruals Data Kit and its DMO mappings into a Salesforce org. Standalone and self-contained — runs on its own, or as a delegated step invoked by consumer-goods-tpe-dashboard-configure (Step 7), which passes through its own already-collected username and dry-run flag rather than this skill re-deriving them.
Inputs to collect first
Ask before starting, unless already supplied by a calling skill. Do not guess.
- TPM System Admin username — already authenticated via
sfCLI. Verify via the sibling
script, never sf org display --json directly — that command's raw output includes accessToken (a live credential), which this script strips before printing: ``bash node ./scripts/sf-rest.js org-status --target-org <username> ` Prints {"username","alias","connectedStatus","orgId"}. Non-zero exit or connectedStatus != "Connected"` ⇒ stop, ask the user to log in themselves.
- Dry-run? — offer by default. In dry-run, Phase 1 (preflight) and Phase 2's read/diff steps still run; Phase 2's
FieldPermissionswrites and Phases 3-5 (deploy) are skipped and recorded aspending — not run (dry-run). - TPM Data Connector installed and active — cannot be verified programmatically. Ask the user, spelling out the exact navigation steps rather than just naming the setting: "Can you confirm the TPM Data Connector is Active? 1) Go to Setup → Data Cloud Setup. 2) In the left nav, under EXTERNAL INTEGRATIONS, click Other Connectors. 3) Find 'TPM Data Connector' in the list and check its status." Wait for an explicit yes. If missing or inactive, stop — tell the user we cannot proceed without the TPM Data Connector being active, and explain the two different paths depending on org type:
- Production orgs — it's typically auto-installed within ~24h of Processing Service pairing, provided the org has a Data Cloud license. If both prerequisites are met, ask the user to wait and retry; if either isn't met (no pairing yet, or no Data Cloud license), that's the real blocker to resolve first.
- Sandbox orgs — auto-install commonly does not happen; it typically needs to be activated manually under EXTERNAL INTEGRATIONS → Other Connectors. Tell the user this is expected in sandboxes and ask them to activate it there, then confirm before continuing.
Re-run this check once the user confirms it's Active.
- Salesforce CRM Home org connection — cannot be verified programmatically. Ask the user, spelling out the exact navigation steps: "Can you confirm the Salesforce CRM Home org connection is Active? 1) Go to Setup → Data Cloud Setup. 2) In the left nav, under SALESFORCE INTEGRATIONS, click Salesforce CRM. 3) Check that the Home org connection status is Active." Wait for an explicit yes. If missing/inactive, stop — tell the user we cannot proceed without this connection being active (Phase 2's field-permission grants require the
Data Cloud Salesforce Connectorpermission set, which won't exist until this connection is configured) — ask them to activate/configure it first, then re-run this check. - Permission set(s) for the TPM Admin persona + GenieAdmin permission set confirmed assigned — when invoked as a delegated step from
consumer-goods-tpe-dashboard-configure, it passes through both results already confirmed in its own earlier phases; reuse them, don't re-ask or re-query. When invoked standalone, confirm each directly:
- Permission set(s) for the TPM Admin persona — "TPM Admin persona" is a role, not an actual permission set name; the org-specific permission set backing that persona (name/assignment) cannot be verified programmatically. Ask the user to confirm: "Is the permission set(s) required for the TPM Admin persona assigned to <username>?" Wait for an explicit yes.
- GenieAdmin — resolve its Label first (never show the API
Nameto the user), then check the assignment:
``bash sf data query --target-org <username> --query "SELECT Label FROM PermissionSet WHERE Name = 'GenieAdmin'" sf data query --target-org <username> \ --query "SELECT PermissionSet.Name FROM PermissionSetAssignment WHERE Assignee.Username = '<username>' AND PermissionSet.Name = 'GenieAdmin'" ` Missing ⇒ tell the user the Label from the first query (e.g. *"User <username> is missing the <Label> permission set. Assign it now?"*) and ask permission to assign before continuing: `bash sf data create record --sobject PermissionSetAssignment \ --values "AssigneeId=<userId> PermissionSetId=<psId>" --target-org <username> `` If declined, skip and note it in the report.
- Namespace (`NS`) — when invoked as a delegated step,
consumer-goods-tpe-dashboard-configurepasses through its already-detectedNS(raw namespace string); reuse it, don't re-detect. When invoked standalone, detect it once yourself, before Phase 1, with the sibling script:
``bash node ./scripts/detect-namespace.js --target-org <username> ` Prints {"NS","NS_SEGMENT","NS_APEX","NS_FIELD"}` as one line of JSON. Store all four and reuse everywhere below.
Phase 1 — Preflight
- Baseline for later verification — capture the latest
DataKitDeploymentLogId now, before any deploy work, to avoid aCreatedDateclock-skew false-negative in Phase 5:
``bash sf data query --target-org <username> \ --query "SELECT Id FROM DataKitDeploymentLog ORDER BY CreatedDate DESC LIMIT 1" --json ` Store as LAST_ID_BEFORE_DEPLOY` (empty if zero rows).
- Download & unzip `CGCloudAddons` — this skill fetches it itself rather than asking the user to do it manually.
``bash node ./scripts/download-static-resource.js \ --target-org <username> --name CGCloudAddons ` Capture STATIC_RESOURCE_PATH=<dir> from stdout as <addons_root> — every path below is relative to it (e.g. <addons_root>/TPM/Accruals/TPM Accruals Data Kit). Zero StaticResource rows ⇒ **block**: the package version installed in this org doesn't ship CGCloudAddons`. Any other script failure ⇒ block and relay its stderr verbatim.
Phase 2 — Field permissions for CRM streams (derived from the downloaded package)
Two sibling scripts drive this phase — never hand-roll the parsing or the grant calls; see each script's own docstring for exactly what it does and why:
- Extract the
{sobject, fields[]}list from the downloaded package (read-only, always safe to run):
``bash node ./scripts/extract-crm-field-permissions.js \ --dir "<addons_root>/TPM/Accruals/TPM Accruals Data Kit/force-app/main/default/dataSourceObjects" \ > /tmp/crm-field-permissions.json `` Zero entries in the output ⇒ block and report — shouldn't happen if Phase 1 succeeded.
- Get the diff to update, silently (the script's own
--dry-run— read-only: permission set,sobject/describe, existingFieldPermissions/ObjectPermissionsrows) — don't show the user anything yet, this is just to find out whether there's anything to do:
``bash node ./scripts/update-field-permissions.js \ --target-org <username> --input /tmp/crm-field-permissions.json --dry-run ` {"error":"permission_set_not_found",...}` ⇒ stop this phase, mark it blocked, and tell the user: "Could not find the 'Data Cloud Salesforce Connector' permission set — a likely explanation is that Salesforce CRM hasn't been configured yet (Setup → Data Cloud → Salesforce CRM). Please configure that first, then re-run this phase."
- Only if `wouldGrant` or `objectWouldGrant` is non-empty, show the user exactly that diff (not the full extracted list) and get an explicit go-ahead before writing anything. If both are empty, everything's already granted — skip straight to step 5, no confirmation needed.
- On confirmation, run it for real — add-only at both field and object level (see script docstring for exact semantics):
``bash node ./scripts/update-field-permissions.js \ --target-org <username> --input /tmp/crm-field-permissions.json ` Exit code 3 (or a non-empty failed[]/objectFailed[]) ⇒ don't guess a workaround — prompt the user to do it manually via Setup → Permission Sets → Data Cloud Salesforce Connector → Object Settings, using exactly the failed[]/objectFailed[]` list, and note each in the report.
- Record pass/blocked/pending, and the touched-field/object outcome (
granted/alreadyGranted/notFlsEligible/failed,objectGranted/objectAlreadyGranted/objectFailed), for the final report. Dry-run mode (never proceed to step 4 when in dry run mode as it updates permissions, step1 and step2 can be run as they are read only) objectGranted/objectAlreadyGrantedentries withpermissionsViewAllRecords: falseare expected for a small, fixed set of sobjects (currently just Product2) whose license blocks that flag — this is a known platform restriction the script applies silently; don't flag it to the user or treat it as something needing manual Setup action.
Phase 3 — Prepare and deploy data kit metadata
- In
<addons_root>/TPM/Accruals/TPM Accruals Data Kit, find-and-replace every instance of the placeholder__SF_ORG_ID__with the org's 15-digit Id. Get the org Id via the following sibling script
``bash node ./scripts/sf-rest.js org-status --target-org <username> ` Take the orgId` field from the printed JSON and truncate it to 15 chars (this call is cheap and idempotent — always re-run it here rather than relying on the Inputs step 1 result still being in context).
- Deploy from that folder:
``bash sf project deploy start --target-org <username> ``
Phase 4 — Deploy DMO mappings and run the deployment script
- DMO mappings — maps the data kit's DLOs to Data 360 DMOs. From
<addons_root>/TPM/Accruals/DmoMappings:
``bash sf project deploy start --target-org <username> ``
- Deployment script — from
<addons_root>/TPM/Accruals/Accruals Data Kit Deployment Scripts:
``bash SF_ORG_ALIAS=<username> node deploy-tpm-tpe.js ` This script POSTs to /services/data/v67.0/actions/custom/flow/sfdatakit__DeployDataKitComponents and returns an async Flow interview guid immediately; that response alone doesn't mean success — always confirm via the DataKitDeploymentLog` check in Phase 5. This script runs from inside the downloaded/unzipped static resource.
Phase 5 — Verify
Every row for this run must have DeploymentStatus = 'Successful' and a blank DeploymentError. Never claim success while any row is `Failure` or has a non-empty error.
Alternative UI check: Data Cloud Setup → Data Kits → TPM Accruals → Local Deployment History → status Successful.
Known gotchas
FlowDefinitionis not SOQL-queryable — don't probe it for readiness.- An
sfdatakit__DeployDataKitComponentsApexClass probe can return 0 rows even when the framework is live — prefer probingDataKitDeploymentLogdirectly (Phase 5), never the Apex class.
Rules
This is the start of the file. Read the full SKILL.md on GitHub.
Security
- Security scanPassed, 90 of 100Pattern checks on the skill's files.
- Model reviewPassed
Quality evaluation
- Task evaluationNot runNo evaluation yet. Run one in Skill Studio.
Source
- SKILL.md in the repositoryCheckingskills/consumer-goods-tpe-datakit-deploy/SKILL.md
Popularity
- Repository stars
- 1,054
- Repository forks
- 353
- 7-day trend score
- 40
Stars and forks are for the whole GitHub repository, not this skill alone. Not refreshed yet.
Works with
Any agent vskill installs to: 56 targets in all. These 39 have a page on this site.
- Claude Code
- Cursor
- GitHub Copilot
- Windsurf
- Codex
- Gemini CLI
- Cline
- Amp
- Roo Code
- Goose
- Continue
- Kilo Code
- Junie
- Trae
- OpenHands
- Qwen Code
- AI Agent
- Tabnine Chat
- Sourcegraph Cody
- Amazon Q
- Firebase Genkit
- Sweep
- Devin
- Phind
- Mentat
- Claude Desktop
- Aider
- GPT Pilot
- Plandex
- bolt.new
- v0
- Replit Agent
- Anse
- TypingMind
- BetterChatGPT
- LibreChat
- Warp AI
- Pieces
- Fig AI
Embed badge
[](https://verified-skill.com/skills/forcedotcom/sf-skills/consumer-goods-tpe-datakit-deploy)