b2c-cip

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

B2C CIP Skill

B2C CIP 技能

Use

b2c cip

commands to query B2C Commerce Intelligence (CIP), also known as Commerce Cloud Analytics (CCAC).

Tip: If
b2c
is not installed globally, use
npx @salesforce/b2c-cli
.

使用

b2c cip

命令查询B2C Commerce Intelligence (CIP)，也称为Commerce Cloud Analytics (CCAC)。

提示： 如果
b2c
没有全局安装，请使用
npx @salesforce/b2c-cli
。

Command Structure

命令结构

text

cip
├── tables                        - list metadata catalog tables
├── describe <table>              - describe table columns
├── query                         - raw SQL execution
└── report                        - curated report topic
    ├── sales-analytics
    ├── sales-summary
    ├── ocapi-requests
    ├── top-selling-products
    ├── product-co-purchase-analysis
    ├── promotion-discount-analysis
    ├── search-query-performance
    ├── payment-method-performance
    ├── customer-registration-trends
    └── top-referrers

text

cip
├── tables                        - 列出元数据目录表
├── describe <table>              - 查看表的列信息
├── query                         - 执行原生SQL
└── report                        - 精选报表主题
    ├── sales-analytics
    ├── sales-summary
    ├── ocapi-requests
    ├── top-selling-products
    ├── product-co-purchase-analysis
    ├── promotion-discount-analysis
    ├── search-query-performance
    ├── payment-method-performance
    ├── customer-registration-trends
    └── top-referrers

Requirements

使用要求

OAuth client credentials:
```
--client-id
```
,
```
--client-secret
```
CIP tenant:
```
--tenant-id
```
(or
```
--tenant
```
)
API client has
```
Salesforce Commerce API
```
role with tenant filter for your instance

Optional:

```
--cip-host
```
(or
```
SFCC_CIP_HOST
```
) to override the default host
```
--staging
```
(or
```
SFCC_CIP_STAGING
```
) to force staging analytics host

::: warning Availability This feature is typically used with production analytics tenants (for example

abcd_prd

Starting with release 26.1, reports and dashboards data can also be enabled for non-production instances (ODS/dev/staging and designated test realms) using the Enable Reports & Dashboards Data Tracking feature switch.

Reports & Dashboards non-production URL:

https://ccac.stg.analytics.commercecloud.salesforce.com

:::

OAuth客户端凭证：
```
--client-id
```
、
```
--client-secret
```
CIP租户：
```
--tenant-id
```
（或
```
--tenant
```
）
API客户端拥有
```
Salesforce Commerce API
```
角色，且租户过滤器包含你的实例

可选参数：

```
--cip-host
```
（或
```
SFCC_CIP_HOST
```
）可覆盖默认主机地址
```
--staging
```
（或
```
SFCC_CIP_STAGING
```
）强制使用预发环境分析主机

::: warning 可用性说明该功能通常用于生产环境分析租户（例如

abcd_prd

）。

从26.1版本开始，你可以通过启用报表与仪表盘数据跟踪功能开关，为非生产实例（ODS/开发/预发和指定测试域）启用报表与仪表盘数据功能。

报表与仪表盘非生产环境地址：

https://ccac.stg.analytics.commercecloud.salesforce.com

:::

Quick Workflow

快速工作流

Discover available tables (
```
b2c cip tables
```
) or curated reports (
```
b2c cip report --help
```
).
Use
```
b2c cip describe <table>
```
or report
```
--describe
```
to inspect structure/parameters.
Use report
```
--sql
```
to preview generated SQL.
Pipe SQL into
```
cip query
```
when you need custom execution/output handling.

查找可用表（
```
b2c cip tables
```
）或精选报表（
```
b2c cip report --help
```
）
使用
```
b2c cip describe <表名>
```
或报表的
```
--describe
```
参数查看结构/参数
使用报表的
```
--sql
```
参数预览生成的SQL
当你需要自定义执行/输出处理时，将SQL通过管道传递给
```
cip query
```

Metadata Discovery Examples

元数据发现示例

bash

undefined

bash

undefined

List warehouse tables

列出数仓表

b2c cip tables --tenant-id abcd_prd --client-id <client-id> --client-secret <client-secret>

Filter table names

过滤表名

b2c cip tables --tenant-id abcd_prd --pattern "ccdw_aggr_%" --client-id <client-id> --client-secret <client-secret>

Describe table columns

查看表的列信息

b2c cip describe ccdw_aggr_ocapi_request --tenant-id abcd_prd --client-id <client-id> --client-secret <client-secret>

undefined

b2c cip describe ccdw_aggr_ocapi_request --tenant-id abcd_prd --client-id <client-id> --client-secret <client-secret>

undefined

Known Tables

已知表

For an efficient table catalog grouped by aggregate/dimension/fact families, use:

```
references/KNOWN_TABLES.md
```

For a general-purpose starter query pack with ready-to-run SQL patterns, use:

```
references/STARTER_QUERIES.md
```

The list is derived from official JDBC documentation and intended as a quick discovery aid.

如果你需要按聚合/维度/事实族分组的高效表目录，请查看：

```
references/KNOWN_TABLES.md
```

如果你需要包含可直接运行的SQL模板的通用入门查询包，请查看：

```
references/STARTER_QUERIES.md
```

该列表来源于官方JDBC文档，旨在作为快速查找的辅助工具。

Curated Report Examples

精选报表示例

bash

undefined

bash

undefined

Show report commands

查看报表命令

b2c cip report --help

Run a report

运行报表

b2c cip report sales-analytics
--site-id Sites-RefArch-Site
--from 2025-01-01
--to 2025-01-31
--tenant-id abcd_prd
--client-id <client-id>
--client-secret <client-secret>

Show report parameter contract

查看报表参数说明

b2c cip report top-referrers --describe

Print generated SQL and stop

输出生成的SQL并停止执行

b2c cip report top-referrers --site-id Sites-RefArch-Site --limit 25 --sql

Force staging analytics host

强制使用预发环境分析主机

b2c cip report top-referrers --site-id Sites-RefArch-Site --limit 25 --staging --sql

undefined

b2c cip report top-referrers --site-id Sites-RefArch-Site --limit 25 --staging --sql

undefined

SQL Pipeline Pattern

SQL管道模式

bash

b2c cip report sales-analytics --site-id Sites-RefArch-Site --sql \
  | b2c cip query --tenant-id abcd_prd --client-id <client-id> --client-secret <client-secret>

bash

b2c cip report sales-analytics --site-id Sites-RefArch-Site --sql \
  | b2c cip query --tenant-id abcd_prd --client-id <client-id> --client-secret <client-secret>

Raw SQL Query Examples

原生SQL查询示例

bash

b2c cip query \
  --tenant-id abcd_prd \
  --client-id <client-id> \
  --client-secret <client-secret> \
  "SELECT * FROM ccdw_aggr_sales_summary LIMIT 10"

You can also use:

```
--file ./query.sql
```
pipe query text from standard input (for example
```
cat query.sql | b2c cip query ...
```
)

bash

b2c cip query \
  --tenant-id abcd_prd \
  --client-id <client-id> \
  --client-secret <client-secret> \
  "SELECT * FROM ccdw_aggr_sales_summary LIMIT 10"

你还可以使用：

```
--file ./query.sql
```
从标准输入管道传入查询文本（例如
```
cat query.sql | b2c cip query ...
```
）

Date Placeholders

日期占位符

b2c cip query

supports placeholder replacement:

```
<FROM>
```
with
```
--from YYYY-MM-DD
```
```
<TO>
```
with
```
--to YYYY-MM-DD
```
```
--from
```
defaults to first day of current month
```
--to
```
defaults to today

If you provide

--site-id

, the common CIP format is

Sites-{siteId}-Site

. The command warns when

siteId

does not match that pattern but still runs with your input.

b2c cip query

支持占位符替换：

```
<FROM>
```
对应
```
--from YYYY-MM-DD
```
```
<TO>
```
对应
```
--to YYYY-MM-DD
```
```
--from
```
默认值为当月第一天
```
--to
```
默认值为当天

如果你提供了

--site-id

，CIP的通用格式为

Sites-{siteId}-Site

。如果

siteId

不符合该格式，命令会发出警告，但仍会按照你的输入运行。

Output Formats

输出格式

Both raw query and report commands support:

```
--format table
```
(default)
```
--format csv
```
```
--format json
```
```
--json
```
(global JSON mode)

原生查询和报表命令都支持以下格式：

```
--format table
```
（默认）
```
--format csv
```
```
--format json
```
```
--json
```
（全局JSON模式）

Service Limits and Best Practices

服务限制与最佳实践

The underlying JDBC analytics service has strict limits. Keep requests scoped:

avoid broad
```
SELECT *
```
queries
use narrow date ranges and incremental windows
prefer aggregate tables when possible
use report commands for common KPI workflows

Limits can change over time. Use the official JDBC access guide for current NFR limits:

https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/jdbc_access_guide.html

底层JDBC分析服务有严格的限制，请控制请求范围：

避免大范围的
```
SELECT *
```
查询
使用窄日期范围和增量窗口
尽可能优先使用聚合表
常用KPI工作流优先使用报表命令

限制可能会随时间变化，你可以查看官方JDBC访问指南了解当前的NFR限制：

https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/jdbc_access_guide.html

Troubleshooting

问题排查

tenant-id is required
: set

--tenant-id

(or

SFCC_TENANT_ID

)

Auth method error: CIP supports client credentials only; remove
```
--user-auth
```
403/unauthorized: verify API client role and tenant filter include target instance
Rate/timeout failures: reduce date window, select fewer columns, query aggregate tables

For full command reference, use

b2c cip --help

and CLI docs.

tenant-id is required
：设置

--tenant-id

（或

SFCC_TENANT_ID

）

认证方式错误：CIP仅支持客户端凭证模式，请移除
```
--user-auth
```
参数
403/未授权：验证API客户端角色和租户过滤器是否包含目标实例
限流/超时失败：缩小日期窗口、选择更少的列、查询聚合表

完整命令参考请查看

b2c cip --help

和CLI文档。