SAP Cloud 应用程序编程模型数据检查器插件

关于此工程

@cap-js/data-inspector 是一个插件 视图数据 cAP Node.js 应用程序。 它带有一个SAPUI5的应用可消耗出盒子.

快速启动

安装

在您的 CAP 节点中安装插件 :

npm install @cap-js/data-inspector

运行

运行它

cds watch

• 数据检查员OData服务 http://localhost:4004/odata/v4/data-inspector/。 。 。 .
• 当请求用户时,使用 alice 没有密码.

说明: 这个 alice 用户仅用于本地测试。 对于生产部署,总是如文件后文所述,通过XSUAA配置适当的认证.

SAPUI5 应用程序是 没有 由 CAP 服务器服务(参见 正在本地访问 UI) (中文(简体) ).

特征

• 排除特定实体和元素被插件所曝光. 见 不包括实体和要素。 。 。 .
• 使用 @cap-js/audit-logging。见 审计日志。 。 。 .
• 提供 xsuaa 出入控制的范围。 见 授权。 。 。 .

画面上的UI

1. 登陆页:

2. 寻找实体数字 :
   1. 使用 Data Source 放下菜单.

      Database 是数据库中存在的原始数据. Service 是CDS服务服务提供的数据.

   2. 使用 Entity Name 搜索区域.

3. 选择一个实体的检查要素数字 :
   1. 选择要显示元素的实体。 它们作为第二列出现在屏幕上.
   2. 使用复选框来选择您想要的元素.
   3. 选择 Show Data 以显示数据内容.

4. 查看选定元素的数据内容数字 :

   选择后 Show Data中,第三列显示并自动扩展为全屏,显示选定元素的数据。 选择 More 以加载数据的下一页。 选择 Advanced Filter 创建过滤对话框.

5. 在高级过滤对话框中添加过滤条件数字 :

   在过滤对话框中添加过滤条件并选择 Apply。 。 。 .

6. 查看过滤后的数据数字 :

   显示过滤后的数据 .

建议数字 :

只选择所需的列并添加过滤器以限制显示的数据.

正在本地访问 UI

SAPUI5应用程序并非直接从插件包运行. 相反, cds build 在您的工程中制作一个即时运行的副本 gen/cap-data-inspector-ui,预配置到您运行的 CAP 服务器 (见 CDS 构建插件) (中文(简体) ). 从生成的 UI 运行 文件夹 :

1. 确保启动您的 CAP 服务器 (在一个终端),所以OData服务是可用的 时间 http://localhost:4004数字 :

   cds watch
   

2. 生产UI 与 CDS 构建(在另一个终端)。 这个副本和 配置 UI5 应用程序 gen/cap-data-inspector-ui数字 :

   cds build
   

3. 运行 UI 从生成的文件夹中。 开始 ui5 serve打开 在浏览器中应用,并代理 OData 请求您的 CAP 服务器( 已配置) 在生成时 ui5.yaml:

   cd gen/cap-data-inspector-ui
   npm install
   npm start
   

说明: 如果您的 CAP 服务器运行在非默认端口上, 请按 本地服务器 URL( ui5 服务代理)。 。 。 .

说明: 重新运行 cds build 当您更改插件配置时( 例如 ) . cds.data-inspector.* 设置),因此重生成 gen/cap-data-inspector-ui 捡起你的零钱.

不包括实体和要素

向数据检查员隐瞒实体或要素,请注明: @HideFromDataInspector 在您的CDS定义中.

示例

使用 @HideFromDataInspector cDS实体定义中的注释:

entity Foo {
    id   : String;
    name : String @HideFromDataInspector;
}

这个 name 要素 Foo 实体不由 @cap-js/data-inspector。 。 。 .

@HideFromDataInspector
entity Bar {
    id   : String;
    name : String;
}

这个 Bar 实体不由 @cap-js/data-inspector。 。 。 .

BTP 设置

先决条件

1. 确保您的项目使用 @sap/cds 第9版,第6个版本.
2. 设置 xsuaa SAP BTP 授权服务.
3. 可选添加 @cap-js/audit-logging 编辑 auditlog SAP BTP 审计记录服务.

设置 cds add data-inspector

运行 cds add data-inspector 自动添加 @cap-js/data-inspector 配置到您的项目 .

注: 运行 cds add data-inspector 是可选的。 要手动添加所需的配置,请参见本文件中的相关章节.

以下修改适用于: cds add data-inspector数字 :

• 苏亚 (当 xs-security.json 文件已存在 : 添加 xsuaa 范围 capDataInspectorReadonly 给您的 xs-security.json确保将这一范围用于适当的角色收集。 见 授权。 。 。 .
• 移动 (当 mta.yaml 文件已存在 : 将数据检查器 HTML5 模块和文物添加到您的 mta.yaml。见 MTA 部署。 。 。 .
  • 添加数 html5 模块 capdatainspectorapp 指向 SAPUI5 应用程序 gen/cap-data-inspector-ui。 。 。 .
  • 添加 capdatainspectorapp hTML5 内容模块中的文物 com.sap.application.content 模块 html5-apps-repo app-host 资源).
• 云端服务 (当发现于 mta.yaml 文件和 a portal-site/CommonDataModel.json 文件已存在 : 添加数 catalog 财务报告和审定财务报表 group 数据检查器平板到您的配置 CommonDataModel.json 文件,并创建可转换标题的 i18n 属性文件。 见 云端服务配置。 。 。 .

授权

定义和使用 xsuaa 范围 capDataInspectorReadonly 在你身边 xs-security.json 用于授权读取该插件的 SAPUI5 应用程序和基本的 OData 服务的文件。 关于地方发展和测试,范围 capDataInspectorReadonly 自动添加到默认值中 alice 模拟用户。 关于设置其他模拟用户,请参见: Capire 文档。 。 。 .

注: 运行 cds add data-inspector 添加范围 capDataInspectorReadonly 在你身边 xs-security.json 自动。 一定要用在您喜欢的 roles 财务报告和审定财务报表 role-collections。 。 。 .

说明: @cap-js/data-inspector 仅通过可用的CDS服务读取数据,从而披露基于以下内容的数据: xsuaa 授予实体和用户的范围。 它没有执行自己的访问控制. 它不执行任何直接的SQL查询.

审计日志

如果您的 SAP Cloud 应用程序编程模式 Node.js 应用程序使用 @cap-js/audit-logging 插头, @cap-js/data-inspector 自动发布阅读访问敏感数据要素的审计日志 @PersonalData.IsPotentiallySensitive关于SAP云应用程序编程模式的审计记录,参见 Capire 文档。 。 。 .

SAP BTP 的 UI配置

CDS 构建插件

@cap-js/data-inspector cDS 构建插件 cds build它将捆绑的 SAPUI5 应用程序复制到 gen/cap-data-inspector-ui ,并为您的工程配置 :

• OData 服务 URL ——已补齐 manifest.json 财务报告和审定财务报表 xs-app.json。见 OData 服务基础路径。 。 。 .
• OData 目的地 ——已补齐 xs-app.json。决心从 cds.data-inspector.destination,或从现有的 app/*/xs-app.json,或默认为 srv-api。见 自定义目标名称。 。 。 .
• 认证类型 ——已补齐 xs-app.json。决心从 cds.data-inspector.authenticationType,或从现有的 app/*/xs-app.json,或默认为 xsuaa。见 认证类型。 。 。 .
• sap.cloud.service ——已补齐 manifest.json 当可用时。 决定从 cds.data-inspector.cloudService 或从现有的 app/*/webapp/manifest.json。见 sap.cloud. 服务配置。 。 。 .
• Dev 代理服务器 —— 说 ui5.yaml 被配置为将 OData 请求转发到运行中的 CAP 服务器(http://localhost:4004 为节点.js. 见 本地服务器 URL。 。 。 .

结果 gen/cap-data-inspector-ui 文件夹是用于部署的真理的唯一来源,无论您是否使用 基于MTA的部署 或者说 @sap/html5-app-deployer。 。 。 .

OData 服务基础路径

OData V4 基础路径决定了数据检查员 OData 服务的预期服务地点( 默认 : /odata/v4) (中文(简体) ). 构建插件将此补丁入 SAPUI5 应用程序 manifest.json 财务报告和审定财务报表 xs-app.json。基路径按此顺序解决:

1. 明确配置 - 设定 cds.data-inspector.odataV4BasePath 在你身边 .cdsrc.json 文档或 package.json 文件 :

   {
     "cds": {
       "data-inspector": {
         "odataV4BasePath": "/my-api"
       }
     }
   }
   

2. CAP 节点协议配置 如果 cds.protocols['odata-v4'].path 被配置,它被用作倒置.

3. 默认 - 倒计时 /odata/v4。 。 。 .

自定义目标名称

默认 OData 路由目的地为 srv-api。如果您的工程使用不同的目的地名称,构建插件会按此顺序自动解决:

1. 明确配置 - 设定 cds.data-inspector.destination 在你身边 .cdsrc.json 文档或 package.json 文件 :

   {
     "cds": {
       "data-inspector": {
         "destination": "my-custom-srv-api"
       }
     }
   }
   

2. 自动检测 ——插件扫描您已有的 app/*/xs-app.json 用于 OData 路由的文件,并使用其目的地值.

3. 默认 - 这又回到了 srv-api。 。 。 .

sap.cloud. 服务配置

这个 sap.cloud.service sAPUI5 应用程序中的属性 manifest.json sAP 构建工作区需要文件。 这个 cds build 插件在可用时自动补丁此值 :

1. 明确配置 - 设定 cds.data-inspector.cloudService 在你身边 .cdsrc.json 文档或 package.json 文件 :

   {
     "cds": {
       "data-inspector": {
         "cloudService": "my.cloud.service"
       }
     }
   }
   

2. 自动检测 ——插件扫描您已有的 app/*/webapp/manifest.json 已存在的文件 sap.cloud.service 价值和用途.

3. 跳过 - 如果两个来源都没有提供价值, sap.cloud.service sAPUI5 应用程序中未添加 manifest.json 文档.

认证类型

SAPUI5应用程序中的路线 xs-app.json 文件声明程序 authenticationType默认为 xsuaa如果您的项目通过SAP Cloud身份服务(IAS)认证,请设定为 ias编辑 cds build 插件按此顺序自动解析值 :

1. 明确配置 - 设定 cds.data-inspector.authenticationType 在你身边 .cdsrc.json 文档或 package.json 文件 :

   {
     "cds": {
       "data-inspector": {
         "authenticationType": "ias"
       }
     }
   }
   

2. 自动检测 ——插件扫描您已有的 app/*/xs-app.json oData 路由的文件并使用其 authenticationType 数值.

3. 默认 - 这又回到了 xsuaa。 。 。 .

插件只写过 xsuaa 或者说 ias数值 none (在approuter上无法认证)是 永远 自动写入: 明示 none 被警告拒绝,然后返回 xsuaa自动检测 none 被忽略。 要禁用认证,请编辑生成的 gen/cap-data-inspector-ui/xs-app.json 运行后手动文件 cds build。 。 。 .

本地服务器 URL( ui5 服务代理)

生成的 ui5.yaml 包括一个 dev 代理, 将 OData 请求转发到本地开发期间运行的 CAP 服务器( ) ui5 serve) (中文(简体) ). 代理 URL 默认为 http://localhost:4004 (节点.js). 如果您的服务器运行于不同的端口, 请编辑 backend[0].url 在生成时 gen/cap-data-inspector-ui/ui5.yaml 运行后 cds build。 。 。 .

MTA 部署

注: 运行 cds add data-inspector 在您中添加以下所需的配置 mta.yaml 自动文件。 在承诺之前,确保审查所产生的变化.

数据检查器插件的 SAPUI5 应用程序,由 cds build 在您的项目中 gen/cap-data-inspector-ui 目录必须以 html5 模块 mta.yaml 文件并包含在 HTML5 内容模块中,用于部署到 HTML5 Application Repository 服务.

1. 添加一个 html5 模块如下:

- name: capdatainspectorapp
  type: html5
  path: gen/cap-data-inspector-ui
  build-parameters:
    build-result: dist
    builder: custom
    commands:
      - npm install
      - npm run build:cf
    supported-platforms: []

2. 包含 html5 hTML5 内容模块中的模块—— com.sap.application.content 模块 html5-apps-repo app-host 资源。 例如:

- name: <your app content module name>
  type: com.sap.application.content
  path: <your app content module path>
  requires:
    - name: <your html5-apps-repo app-host resource name>
      parameters:
        content-target: true
  build-parameters:
    build-result: <your module build output path>
    requires:
      - name: capdatainspectorapp
        artifacts:
          - datainspectorapp.zip
        target-path: <your html5 app artifact build output path>

@sap/html5-应用部署

用于部署 @sap/html5-app-deployer,使用 SAPUI5 应用程序的来源 cds build 在你身边 gen/cap-data-inspector-ui 创建时包含的目录 html5-app-deployer 图像.

1. 运行 cds build 在您的工程中生产补丁的数据检查器插件 SAPUI5 应用程序 gen/cap-data-inspector-ui 目录.
2. 构建用于生产的 SAPUI5 应用程序 : cd gen/cap-data-inspector-ui && npm install && npm run build:cf。 。 。 .
3. 包含结果 dist/ 内容(具体为: datainspectorapp.zip在你身边 html5-app-deployer 图像与您的其他 SAPUI5 应用程序.

确切的步骤取决于您的部署管道。 详情参见 使用 HTML5 应用程序部署内容。 。 。 .

云端服务配置

注: 运行 cds add data-inspector 在您中添加以下所需的配置 portal-site/CommonDataModel.json 如果在您中检测到 Cloud 门户服务,则自动 mta.yaml 文件( 编号service: portal, (中文(简体) ), service-plan: standard) (中文(简体) ). 在承诺之前,确保审查所产生的变化.

执行下列步骤来配置数据检查器平板:

1. 添加一个 目录 (单位:千美元) 组 输入数据检查器插件的 SAPUI5 应用程序平板到您的 portal-site/CommonDataModel.json 文档.

在现有的 catalog (单位:千美元)payload.catalogs[*].payload.viz:

{
  "appId": "sap.cap.datainspector.datainspectorui",
  "vizId": "datainspectorui-display"
}

在现有的 group (单位:千美元)payload.groups[*].payload.viz:

{
  "id": "sap.cap.datainspector.datainspectorui",
  "appId": "sap.cap.datainspector.datainspectorui",
  "vizId": "datainspectorui-display"
}

您也可以创建新的 catalog 财务报告和审定财务报表 group 用于数据检查器平板. cds add data-inspector 这样做。 例如:

{
  "payload": {
    "catalogs": [
      {
        "_version": "3.0.0",
        "identification": {
          "id": "capDataInspectorCatalogId",
          "title": "Data Inspector",
          "entityType": "catalog",
          "i18n": "your_i18n_file_path"
        },
        "payload": {
          "viz": [
            {
              "appId": "sap.cap.datainspector.datainspectorui",
              "vizId": "datainspectorui-display"
            }
          ]
        }
      }
    ],
    "groups": [
      {
        "_version": "3.0.0",
        "identification": {
          "id": "capDataInspectorGroupId",
          "title": "Data Inspector",
          "entityType": "group",
          "i18n": "your_i18n_file_path"
        },
        "payload": {
          "viz": [
            {
              "id": "sap.cap.datainspector.datainspectorui",
              "appId": "sap.cap.datainspector.datainspectorui",
              "vizId": "datainspectorui-display"
            }
          ]
        }
      }
    ]
  }
}

2. 创建一个 i18n 属性文件 带有目录和组条目的可转换标题. cds add data-inspector 自动执行.
3. 附录 capDataInspectorGroupId 组合 ID 到您的首选网站 groupsOrder 因此,瓦片默认可见于SAP Fiori启动板. cds add data-inspector 仅当一个 site 找到实体。 如果您有多个站点,请手动将组ID添加到 groupsOrder 运行后在您首选的网站上 cds add data-inspector。 。 。 .

SAP 构建工作区配置

如果您使用 SAP 建设区,您必须手动将数据检查器插件SAPUI5应用程序添加到SAP构建工作区CDM配置文件中(cdm.json) (中文(简体) ). 这个 sap.cloud.service 数值 manifest.json 插件的 SAPUI5 应用程序的文件应该已经 已补齐 cds build 插件 与 SAP 建设区。 。 。 .

根据您的工作区内容模式,您可能需要:

• 将应用程序添加到 a 目录 实体的可发现性.
• 在目录中引用 角色 控制访问的实体.
• 将组包含在 a 空间 或者说 工作页 导航.

确保以下数值 appId 财务报告和审定财务报表 vizId 为插件中的 SAPUI5 应用程序设置 cdm.json 文档.

"viz": {
  "appId": "sap.cap.datainspector.datainspectorui",
  "vizId": "datainspectorui-display"
}

关于清洁发展机制内容结构的详情,请参阅 SAP 构建工作区文件。 。 。 .

(可选) flpSandbox.html 数据检查员插件的 SAPUI5 App Tile 本地测试配置

如果你在使用一个 flpSandbox.html 要本地测试,请在沙盒 SAP Fiori 启动板中添加数据检查器插件的 SAPUI5 应用平板.

单位 ClientSideTargetResolution.adapter.config.inbounds数字 :

CAPDataInspectorDisplay: {
  semanticObject: "datainspectorui",
  action: "display",
  signature: {
    parameters: {},
    additionalParameters: "ignored"
  },
  resolutionResult: {
    additionalInformation: "sap.cap.datainspector.datainspectorui",
    applicationType: "URL",
    url: "/data-inspector-ui"
  }
}

单位 LaunchPage.adapter.config.groups数字 :

{
  id: "Supportability",
  title: "Support Tools",
  isPreset: true,
  isVisible: true,
  isGroupLocked: false,
  tiles: [
    {
      id: "CAPDataInspector",
      tileType: "sap.ushell.ui.tile.StaticTile",
      properties: {
        title: "Data Inspector",
        targetURL: "#datainspectorui-display",
        icon: "sap-icon://database"
      }
    }
  ]
}

支助、反馈和贡献

此项目可通过功能请求、建议和错误报告打开 GitHub 问题我们鼓励并欢迎各方作出贡献和反馈。 关于如何作出贡献的更多信息,见项目结构和额外贡献信息 贡献准则。 。 。 .

开发设置

为了快速测试和体验插件,在您的本地机器中没有依赖项目,请使用包含在这个存储器中的国家预防机制测试工作空间.

1. 清除仓库 : git clone https://github.com/cap-js/data-inspector.git

2. 安装依赖性 : npm i

3. 通过保存任何数据类型生成核心数据服务( CDS) 模式类型 .cds 来自 VS 代码的文件。 详情请参见 CDS 打字机。 。 。 .

4. 创建测试 sqlite db :

   1. cd test
   2. cds deploy -2 sqlite:db/testservice.db
   3. cd ..

5. 运行测试服务器 : npm run dev

   SAPUI5应用程序以网页浏览器推出.

6. 使用下列证书:

   用户名 : alice

   密码: 保持空

安全/披露

如果你发现一个可能存在安全问题的bug, 请遵守我们的指示 安全政策 以报之. 不要为安全相关问题创建 GitHub 问题.

行为守则

成员、贡献者和领导人保证使参加我们的社区成为每个人不受骚扰的经历。 通过参与这个项目,你同意遵守 行为守则 在任何时间.

许可证发放

版权:2025-2026 SAP SE或SAP下属公司和数据检查员贡献者. 请看我们的 自由主义 版权和许可证信息。 包括第三方部件在内的详细资料及其许可证/版权信息可通过下列途径获取: REUSE 工具