Customize TPE Dashboard KPIs
Headlessly clones the base TPE Analytics semantic-model parameters, visualizations, and dashboards
under a customer-chosen suffix, so a customer's own KPI measure codes appear on the Promotion/Tactic
Analysis dashboards without ever mutating the shipped base model. Driven entirely by sf CLI +
REST against an already-authenticated org. Requires consumer-goods-tpe-dashboard-configure to
have already installed the TPE Analytics app and the Extended TPM Analytics SDM — this skill never
installs those, only customizes on top of them.
Persona: a Salesforce TPM System Admin customizing TPE dashboards for their org's own KPIs.
There is no native "clone" endpoint for any of the three artifact types this skill touches
(semantic-model parameters, visualizations, dashboards) — every clone is the same three-step
pattern: GET the base artifact, deep-copy its JSON and apply overrides, POST the copy as
a new artifact. Base-model artifacts are never mutated in place.
The 5 KPI slots — two artifacts per slot, not one
The shipped Extended TPM Analytics SDM exposes 5 generic List-type parameters that the standard
dashboards bind to: Promotion Measure 1-3 (Promotion_Measure_{1,2,3}_prm / _value) and Tactic
Measure 1-2 (Tactic_Measure_{1,2}_prm / _clc). Never assume Tactic mirrors Promotion's
_value naming — resolve both slots' measurement apiNames from the live model per slot, never by
pattern. See references/payload-shapes.md for the confirmed apiNames and JSON shapes.
Each slot is two SDM artifacts: the parameter (*_prm, a List type with allowedValues
menu entries and a defaultValue) and the calculated measurement (what visualizations actually
query; its expression links back to the parameter by apiName). Customizing a slot means cloning
both — the parameter gets the customer's KPI as a new/selected allowedValues entry, and the
measurement's expression is rewritten to reference the cloned parameter's new apiName.
This skill always produces clones of all 5 slots (10 artifacts), whether or not a given slot has
a requested override — an unmentioned slot is still cloned as an exact copy of the base artifacts
(only apiName/label suffixed).
Two override modes per slot (see references/procedure.md for exact --overrides shapes):
- APPEND mode (default): upserts one
{measureCode, displayName} entry into the base menu by
measure code — same code relabels in place, new code appends.
- REPLACE mode: a full
allowedValues array supplied by the customer becomes the entire menu.
Either way this skill assumes the underlying measure data is already populated by prior
setup-rtr-datacloud-export/data-kit setup — it does not create that underlying data itself.
Inputs to collect first
Ask before starting. Do not guess.
- TPM System Admin username — verify connectivity via
node ./scripts/sf-rest.js org-status --target-org <username> (never sf org display --json
directly — that leaks a live accessToken). Non-Connected ⇒ stop, ask the user to log in.
- Dry-run? — offer by default.
- Suffix — distinguishes cloned metadata from the base model (e.g.
Cust). Suggest Cust as a
default. Applied to every new artifact's API name/label — never reuse a base-model API name.
- Per-measure overrides — walk the customer through the 5 measures via
AskUserQuestion,
batched by dashboard (Promotion Measure 1-3 in one call, Tactic Measure 1-2 in a second call —
never all 5 in one call, the tool caps at 4 questions per call), never using the internal term
"slot" toward the user. Never ask a separate plain free-text follow-up question to collect the
list — a plain-text message doesn't block the next tool call, so if you fire another
AskUserQuestion for the next measure before the customer's reply lands, their answer races
ahead and lands on the wrong question. Instead, collect the full list inside the same blocking
question: every AskUserQuestion question automatically gets a "Type Something" free-text
option appended after your listed options — no need to add your own placeholder option for it,
and never rely on a bare canned option label (e.g. "Replace with custom list") to actually carry
the list, since selecting it only returns that label text, not the customer's data. Word the
question and its second option's description to point the customer at "Type Something"
explicitly, e.g. option 2 = "Replace with custom list", description: "Select Type Something
(last option, below) and type comma-separated {measureCode}: {displayName} pairs, plus which
one should be default." A menu can have more than one entry — always collect the full array,
never just one pair (a single-pair answer is still an array of length 1). This collected array
maps directly to that slot's REPLACE-mode override ({"allowedValues":[...], "defaultValue": "<first displayName unless the customer says otherwise>"}) — see references/procedure.md's
override-mode shapes. Confirm the resolved list per measure back to the user before Phase 0.
- Which dashboards to produce — Promotion Analysis, Tactic Analysis, or both. Default to both
if any measure on either has an override; otherwise ask explicitly.
How it works — phase list
- Namespace detection — resolve
NS via sf package installed list for consistency with
sibling skills, but never apply it to any /services/data/... path (those are never namespaced).
- Phase 0 — Preflight & discovery: verify connectivity, pin API version
v67.0, resolve the
installed app + asset ids (model, both dashboards, visualizations) by walking the app's asset
list — never hardcode an id. Block with a pointer to consumer-goods-tpe-dashboard-configure if
prerequisites are missing. Full detail: references/procedure.md.
- Phase 1 — Resolve the 5-slot plan: deep-copy each base parameter/measurement with overrides
applied, print the plan, get explicit user confirmation before any writes.
- Phases 2-4 — Clone parameters, measurements, visualizations, dashboards: run
scripts/clone-tpe-dashboards.js (preferred over hand-rolling individual REST calls) — see
references/procedure.md for the full CLI usage, override-mode payload shapes, and every
real-write gotcha the script encodes (label uniqueness, dataSource .type stripping rules,
cloning every KPI-bound visualization not just one "designated" viz, cosmetic label-text
replacement, upsert-by-measure-code).
- Phase 5 — Verify: GET every created artifact back and confirm parameters, measurements,
visualizations, and dashboards all correctly reference the new suffixed clones, never a base
apiName. Full detail:
references/procedure.md.
Key rules (see references/procedure.md for the complete list)
- Never mutate a base-model artifact — every write is a new POST of a suffixed copy.
- Never create anything without explicit user go-ahead on the Phase 1 plan.
- Always produce all 5 slots' worth of clones, even with zero overrides.
- Never leave a cloned measurement's
expression referencing a base parameter apiName.
- Never hardcode an artifact id, api-name, or namespace across orgs.
- Never assume only one visualization per dashboard needs cloning — clone every widget whose viz
references a slot measurement.
Reference map
| Topic |
File |
| Full phase-by-phase procedure, script CLI usage, all real-write gotchas, complete Rules list |
references/procedure.md |
| Confirmed live JSON shapes for parameters, calculated measurements, visualizations, dashboards, and POST body shapes for all 4 create endpoints |
references/payload-shapes.md |
Org REST helper (strips accessToken; org-status subcommand) |
scripts/sf-rest.js |
| Deterministic driver for Phases 2-4 |
scripts/clone-tpe-dashboards.js |
Report
At the end of a run, give the user a structured status per phase (0-5): pass / blocked / pending,
with the specific blocking reason where applicable, and the final list of created artifacts (slot →
new parameter, base viz → new viz, base dashboard → new dashboard). Call out anything skipped due
to dry-run or a declined confirmation.
When invoked via delegation (the calling skill used the Skill tool to reach this file, rather
than the user directly — e.g. consumer-goods-tpe-dashboard-configure's customization step): this
report is an intermediate result. Return it to the calling skill and let it continue with its own
report — do not present this as the final answer to the user unless this skill was invoked
standalone.
1---2name: consumer-goods-tpe-dashboard-custom-kpi-configure3description: Customize the Trade Promotion Effectiveness (TPE) Analytics dashboards' generic KPI slots (Promotion Measure 1-3, Tactic Measure 1-2) with customer-chosen KPI measure codes and display names, without touching the shipped base model. Use when a customer/admin wants to "customize TPE dashboards", "change the KPIs on the Promotion/Tactic Analysis dashboard", or "swap in our own measure codes on the TPE dashboard".4---5
6# Customize TPE Dashboard KPIs
7
8Headlessly clones the base TPE Analytics semantic-model parameters, visualizations, and dashboards
9under a customer-chosen suffix, so a customer's own KPI measure codes appear on the Promotion/Tactic
10Analysis dashboards without ever mutating the shipped base model. Driven entirely by `sf` CLI +
11REST against an already-authenticated org. Requires `consumer-goods-tpe-dashboard-configure` to
12have already installed the TPE Analytics app and the Extended TPM Analytics SDM — this skill never
13installs those, only customizes on top of them.
14
15Persona: a **Salesforce TPM System Admin** customizing TPE dashboards for their org's own KPIs.
16
17There is no native "clone" endpoint for any of the three artifact types this skill touches
18(semantic-model parameters, visualizations, dashboards) — every clone is the same three-step
19pattern: **GET** the base artifact, **deep-copy** its JSON and apply overrides, **POST** the copy as
20a new artifact. Base-model artifacts are never mutated in place.
21
22## The 5 KPI slots — two artifacts per slot, not one
23
24The shipped Extended TPM Analytics SDM exposes 5 generic **List-type parameters** that the standard
25dashboards bind to: Promotion Measure 1-3 (`Promotion_Measure_{1,2,3}_prm` / `_value`) and Tactic
26Measure 1-2 (`Tactic_Measure_{1,2}_prm` / `_clc`). **Never assume Tactic mirrors Promotion's
27`_value` naming** — resolve both slots' measurement apiNames from the live model per slot, never by
28pattern. See `references/payload-shapes.md` for the confirmed apiNames and JSON shapes.
29
30Each slot is **two SDM artifacts**: the **parameter** (`*_prm`, a `List` type with `allowedValues`
31menu entries and a `defaultValue`) and the **calculated measurement** (what visualizations actually
32query; its `expression` links back to the parameter by apiName). **Customizing a slot means cloning
33both** — the parameter gets the customer's KPI as a new/selected `allowedValues` entry, and the
34measurement's `expression` is rewritten to reference the cloned parameter's new apiName.
35
36This skill always produces clones of **all 5 slots (10 artifacts)**, whether or not a given slot has
37a requested override — an unmentioned slot is still cloned as an exact copy of the base artifacts
38(only apiName/label suffixed).
39
40Two override modes per slot (see `references/procedure.md` for exact `--overrides` shapes):
41
42- **APPEND mode** (default): upserts one `{measureCode, displayName}` entry into the base menu by
43 measure code — same code relabels in place, new code appends.
44- **REPLACE mode**: a full `allowedValues` array supplied by the customer becomes the entire menu.
45
46Either way this skill assumes the underlying measure data is already populated by prior
47`setup-rtr-datacloud-export`/data-kit setup — it does not create that underlying data itself.
48
49## Inputs to collect first
50
51Ask before starting. Do not guess.
52
531. **TPM System Admin username** — verify connectivity via
54 `node ./scripts/sf-rest.js org-status --target-org <username>` (never `sf org display --json`
55 directly — that leaks a live `accessToken`). Non-`Connected` ⇒ stop, ask the user to log in.
562. **Dry-run?** — offer by default.
573. **Suffix** — distinguishes cloned metadata from the base model (e.g. `Cust`). Suggest `Cust` as a
58 default. Applied to every new artifact's API name/label — never reuse a base-model API name.
594. **Per-measure overrides** — walk the customer through the 5 measures via `AskUserQuestion`,
60 **batched by dashboard** (Promotion Measure 1-3 in one call, Tactic Measure 1-2 in a second call —
61 never all 5 in one call, the tool caps at 4 questions per call), never using the internal term
62 "slot" toward the user. **Never ask a separate plain free-text follow-up question to collect the
63 list** — a plain-text message doesn't block the next tool call, so if you fire another
64 `AskUserQuestion` for the next measure before the customer's reply lands, their answer races
65 ahead and lands on the wrong question. Instead, collect the full list **inside the same blocking
66 question**: every `AskUserQuestion` question automatically gets a "Type Something" free-text
67 option appended after your listed options — no need to add your own placeholder option for it,
68 and never rely on a bare canned option label (e.g. "Replace with custom list") to actually carry
69 the list, since selecting it only returns that label text, not the customer's data. Word the
70 question and its second option's description to point the customer at "Type Something"
71 explicitly, e.g. option 2 = "Replace with custom list", description: "Select **Type Something**
72 (last option, below) and type comma-separated `{measureCode}: {displayName}` pairs, plus which
73 one should be default." **A menu can have more than one entry — always collect the full array,
74 never just one pair** (a single-pair answer is still an array of length 1). This collected array
75 maps directly to that slot's REPLACE-mode override (`{"allowedValues":[...], "defaultValue":
76 "<first displayName unless the customer says otherwise>"}`) — see `references/procedure.md`'s
77 override-mode shapes. Confirm the resolved list per measure back to the user before Phase 0.
785. **Which dashboards to produce** — Promotion Analysis, Tactic Analysis, or both. Default to both
79 if any measure on either has an override; otherwise ask explicitly.
80
81## How it works — phase list
82
831. **Namespace detection** — resolve `NS` via `sf package installed list` for consistency with
84 sibling skills, but never apply it to any `/services/data/...` path (those are never namespaced).
852. **Phase 0 — Preflight & discovery**: verify connectivity, pin API version `v67.0`, resolve the
86 installed app + asset ids (model, both dashboards, visualizations) by walking the app's asset
87 list — never hardcode an id. Block with a pointer to `consumer-goods-tpe-dashboard-configure` if
88 prerequisites are missing. Full detail: `references/procedure.md`.
893. **Phase 1 — Resolve the 5-slot plan**: deep-copy each base parameter/measurement with overrides
90 applied, print the plan, get explicit user confirmation before any writes.
914. **Phases 2-4 — Clone parameters, measurements, visualizations, dashboards**: run
92 `scripts/clone-tpe-dashboards.js` (preferred over hand-rolling individual REST calls) — see
93 `references/procedure.md` for the full CLI usage, override-mode payload shapes, and every
94 real-write gotcha the script encodes (label uniqueness, dataSource `.type` stripping rules,
95 cloning every KPI-bound visualization not just one "designated" viz, cosmetic label-text
96 replacement, upsert-by-measure-code).
975. **Phase 5 — Verify**: GET every created artifact back and confirm parameters, measurements,
98 visualizations, and dashboards all correctly reference the new suffixed clones, never a base
99 apiName. Full detail: `references/procedure.md`.
100
101## Key rules (see `references/procedure.md` for the complete list)
102
103- Never mutate a base-model artifact — every write is a new POST of a suffixed copy.
104- Never create anything without explicit user go-ahead on the Phase 1 plan.
105- Always produce all 5 slots' worth of clones, even with zero overrides.
106- Never leave a cloned measurement's `expression` referencing a base parameter apiName.
107- Never hardcode an artifact id, api-name, or namespace across orgs.
108- Never assume only one visualization per dashboard needs cloning — clone every widget whose viz
109 references a slot measurement.
110
111## Reference map
112
113| Topic | File |
114|---|---|
115| Full phase-by-phase procedure, script CLI usage, all real-write gotchas, complete Rules list | `references/procedure.md` |
116| Confirmed live JSON shapes for parameters, calculated measurements, visualizations, dashboards, and POST body shapes for all 4 create endpoints | `references/payload-shapes.md` |
117| Org REST helper (strips `accessToken`; `org-status` subcommand) | `scripts/sf-rest.js` |
118| Deterministic driver for Phases 2-4 | `scripts/clone-tpe-dashboards.js` |
119
120## Report
121
122At the end of a run, give the user a structured status per phase (0-5): pass / blocked / pending,
123with the specific blocking reason where applicable, and the final list of created artifacts (slot →
124new parameter, base viz → new viz, base dashboard → new dashboard). Call out anything skipped due
125to dry-run or a declined confirmation.
126
127**When invoked via delegation** (the calling skill used the `Skill` tool to reach this file, rather
128than the user directly — e.g. `consumer-goods-tpe-dashboard-configure`'s customization step): this
129report is an intermediate result. Return it to the calling skill and let it continue with its own
130report — do not present this as the final answer to the user unless this skill was invoked
131standalone.