Skip to content

forcedotcom/sf-skills / plugins/builder/consumer-goods/skills/consumer-goods-tpe-dashboard-configure

consumer-goods-tpe-dashboard-configure

Verified

End-to-end headless setup of Trade Promotion Effectiveness (TPE) dashboards for a Trade Promotion Management (TPM) Cloud org, covering tenant pairing checks, permission sets, SSOT and Tableau Next enablement, C360 SDM verification, the TPM Accruals data kit install, business-period export, RTR Data Cloud export configuration, the TPM_PROMOTION_MEASURE Data Transform, TPE Analytics app install, and optional KPI dashboard customization. Use when a customer or admin wants to set up TPE dashboards, enable Trade Promotion Effectiveness, install the TPE analytics app, or set up and customize TPE dashboards with their own KPIs.

FileKindSize
SKILL.mdskill md5.7 KB
references/phases-1-6.mdmarkdown9.3 KB
references/phases-7-12.mdmarkdown21.4 KB
scripts/find-failure-reason.jsexecutablescript4.8 KB
scripts/poll-status.jsexecutablescript3.5 KB
scripts/render-apex.jsexecutablescript2.0 KB
scripts/run-data-transform.jsexecutablescript4.2 KB
scripts/schedule-business-period-export.apexother1.7 KB
scripts/sf-rest.jsexecutablescript5.7 KB
scripts/soql-escape.jsexecutablescript755 B

scripts/sf-rest.js

View on GitHub
#!/usr/bin/env node
/**
 * Authenticated Salesforce REST callout, replacing `sf api request rest`
 * everywhere in this skill — that command is beta, doesn't support --json,
 * and beta CLI surfaces can change or be pulled without notice. Fetches the
 * org's instanceUrl and access token via the `sf` CLI, then performs a
 * plain HTTP request with Node's built-in fetch. Access token retrieval is
 * version-gated the same way as `datakit-for-tpe`'s
 * `download-static-resource.js`: `sf org auth show-access-token` for CLI
 * >= 2.136.8 (below that version, `sf org display`'s own `result.accessToken`
 * is a redacted hint string, not a real token — see the `sfJson`/`getAccessToken`
 * pair below). The token is never printed.
 *
 * CLI usage:
 *   node sf-rest.js --target-org <username> --path <path> \
 *     [--method GET|POST|PATCH|DELETE] [--body <json-string>]
 *
 * <path> is relative to the org's instanceUrl, e.g.
 * "/services/apexrest/tpm-api/..." or "/services/data/v67.0/...".
 * Prints the response body as one line of JSON to stdout on both success
 * and failure, so a non-2xx error body (e.g. `{"error":"..."}`) is still
 * readable by the caller. Exit codes: 0 = 2xx response, 1 = non-2xx
 * response, 2 = usage/CLI error.
 *
 * Module usage (for sibling scripts in this same skill's scripts/ dir —
 * never imported across skill directories):
 *   const { restRequest } = require('./sf-rest');
 *   const { ok, status, body } = await restRequest({ targetOrg, path, method, body: jsonString });
 */

/**
 * Also exposes two subcommands that print only safe, non-secret fields from
 * `sf org display --json` — that command's `result` includes `accessToken`
 * (a live credential), so nothing in this skill should run it directly and
 * surface the raw output; these strip it before printing:
 *   node sf-rest.js org-status --target-org <username>
 *     -> {"username","alias","connectedStatus","orgId"} ; exit 1 if not Connected
 */

const { execFileSync } = require('child_process');

function sfJson(cliArgs) {
  const raw = execFileSync('sf', cliArgs, { encoding: 'utf8' });
  return JSON.parse(raw).result;
}

const ACCESS_TOKEN_VIA_SHOW_COMMAND_SINCE = [2, 136, 8];

function getCliVersion() {
  // Unlike every other `sf ... --json` command, `sf version --json` returns
  // its fields at the top level — no `{status, result}` envelope.
  const raw = execFileSync('sf', ['version', '--json'], { encoding: 'utf8' });
  const { cliVersion } = JSON.parse(raw);
  const match = cliVersion.match(/(\d+)\.(\d+)\.(\d+)/);
  // A pre-release/suffixed version string (e.g. a nightly build) that
  // doesn't match this pattern is treated as "new enough" below, via
  // isAtLeast's null passthrough — never silently fall back to the
  // redacted-token path on an unparseable version.
  return match ? match.slice(1).map(Number) : null;
}

function isAtLeast(version, minVersion) {
  if (!version) return true;
  for (let i = 0; i < minVersion.length; i += 1) {
    const a = version[i] || 0;
    const b = minVersion[i] || 0;
    if (a !== b) return a > b;
  }
  return true;
}

function getAccessToken(targetOrg) {
  const useShowAccessTokenCommand = isAtLeast(
    getCliVersion(),
    ACCESS_TOKEN_VIA_SHOW_COMMAND_SINCE
  );
  if (useShowAccessTokenCommand) {
    return sfJson([
      'org', 'auth', 'show-access-token',
      '--target-org', targetOrg,
      '--no-prompt', '--json',
    ]).accessToken;
  }
  return sfJson(['org', 'display', '--target-org', targetOrg, '--json']).accessToken;
}

async function restRequest({ targetOrg, path, method, body }) {
  const { instanceUrl } = sfJson(['org', 'display', '--target-org', targetOrg, '--json']);
  const accessToken = getAccessToken(targetOrg);

  const headers = { Authorization: `Bearer ${accessToken}` };
  if (body !== undefined) headers['Content-Type'] = 'application/json';

  const response = await fetch(`${instanceUrl}${path}`, {
    method: method || 'GET',
    headers,
    body,
  });
  const text = await response.text();
  let parsedBody = {};
  if (text.length) {
    try {
      parsedBody = JSON.parse(text);
    } catch {
      parsedBody = text;
    }
  }
  return { ok: response.ok, status: response.status, body: parsedBody };
}

function getOrgStatus(targetOrg) {
  const info = sfJson(['org', 'display', '--target-org', targetOrg, '--json']);
  return {
    username: info.username,
    alias: info.alias || null,
    connectedStatus: info.connectedStatus,
    orgId: info.id,
  };
}

function parseArgs(argv) {
  const args = {};
  for (let i = 0; i < argv.length; i += 1) {
    const token = argv[i];
    if (!token.startsWith('--')) continue;
    args[token.slice(2)] = argv[i + 1];
    i += 1;
  }
  return args;
}

function requireArg(args, name) {
  if (!args[name]) {
    console.error(`Missing required --${name}`);
    process.exit(2);
  }
  return args[name];
}

async function main() {
  const [maybeCommand, ...rest] = process.argv.slice(2);

  if (maybeCommand === 'org-status') {
    const args = parseArgs(rest);
    const status = getOrgStatus(requireArg(args, 'target-org'));
    process.stdout.write(JSON.stringify(status));
    if (status.connectedStatus !== 'Connected') process.exit(1);
    return;
  }

  const args = parseArgs(process.argv.slice(2));
  const targetOrg = requireArg(args, 'target-org');
  const path = requireArg(args, 'path');
  const method = args.method || 'GET';

  const { ok, status, body } = await restRequest({ targetOrg, path, method, body: args.body });
  process.stdout.write(JSON.stringify(body));
  if (!ok) {
    console.error(`sf-rest: HTTP ${status}`);
    process.exit(1);
  }
}

if (require.main === module) {
  main().catch((err) => {
    console.error(err);
    process.exit(1);
  });
}

module.exports = { restRequest, getOrgStatus };
deprecation-and-migrationaddyosmani/agent-skillsManages deprecation and migration. Use when removing old systems, APIs, or features. Use when migrating users from one implementation to another. Use when migrating a database schema in production, such as renaming or dropping a column without downtime (expand/contract). Use when deciding whether to maintain or sunset existing code.Stars: 119kUpdated Claude CodeCodexVerifiedInstall
performance-optimizationaddyosmani/agent-skillsOptimizes application performance across frontend, backend, queries, and databases. Use when performance requirements exist, when you suspect performance regressions, when Core Web Vitals or load times need improvement, when N+1 query patterns need fixing, or when profiling reveals bottlenecks.Stars: 119kUpdated Claude CodeCodexVerifiedInstall
agent-cost-reportthedotmack/claude-memBelievable agent cost report for any period, default the last 7 full days PT, not counting today. Measured tokens from Claude Code transcripts priced at OpenRouter list prices (ESTIMATED), measured provider spend when a sanctioned source exists, note-taker cost separate, Timing-style HTML/PDF plus report.json, line-items.csv, evidence.json.Stars: 118kUpdated Claude CodeCodexVerifiedInstall
agent-cost-reportthedotmack/claude-memBelievable agent cost report for any period, default the last 7 full days PT, not counting today. Measured tokens from Claude Code transcripts priced at OpenRouter list prices (ESTIMATED), measured provider spend when a sanctioned source exists, note-taker cost separate, Timing-style HTML/PDF plus report.json, line-items.csv, evidence.json.Stars: 118kUpdated Claude CodeCodexVerifiedInstall