
# 通用清单模板卡片配置
#### 前提条件
已按[IPDCenter外部集成开发](https://support.huaweicloud.com/devg-craftartsipdcenter/ipdcenter_08_0218.html)规范完成认证逻辑。
#### 适用场景
通用清单卡片适用于展示表格分页数据，可以通过配置表格的表头、数据源来快速自定义不同的表格。支持配置单个表格，也支持配置多个表格，多个表格以tab页签切换的方式展示在卡片中。
通用清单卡片类似如[图1]所示，卡片中展示三个表格，您可以单击页签名称切换查看相应的表格信息。
图1通用清单卡片模板预览效果   
![](https://support.huaweicloud.com/devg-craftartsipdcenter/figure/zh-cn_image_0000001889289040.png "点击放大")
#### 配置模板卡片的配置文件
1. 打开文本编辑工具，新建一个文件。 
   您也可以在开发工具新建一个文件作为配置文件。
   
   
2. 在文件中填写配置文件信息，配置文件的参数配置说明请参见[通用清单卡片配置文件参数配置说明]。
   
   配置文件格式如下：
   ```
   {
     "tableList": [
       {
         "tableName": "表格1",
         "columns": [
           {
             "title": "title1",
             "field": "field1"
           },
           {
             "title": "title2",
             "field": "field2",
             "type": "link",
             "jumpUrl": "${detailPageUrl}"
           },
           {
             "title": "title3",
             "field": "field3",
             "type": "date",
             "format": "yyyy-MM-dd HH:mm:ss"
           }
         ],
         "queryDataType": "api",
         "apiConfig": {
           "url": "url",
           "method": "GET",
           "headers": {
             "authorizationKey": "",
             "applyId": ""
           },
           "body": {},
           "pageNoField": "pageNo",
           "pageSizeField": "pageSize",
           "dataBody": "resp.data.data",
           "totalBody": "resp.data.totalCount"
         }
       }
     ]
   }
   ```
   
   
3. 将配置文件保存在本地，文件需要保存为json格式。
 
 #### 通用清单卡片配置文件参数配置说明
表1配置项 
| **名称**    | **类型**          | **默认值** | **说明**                                                                                                                                                                                |
|:---|:---|:---|:---|
| tableList | tableConfig\[\] | \[\]    | 表格项的配置信息，支持配置多个表格项。 表格项超过1个时，各个表格以tab页签方式组合，可以切换查看每个表格。最多支持配置5个表格项，表格项中的具体配置请参考[表2]。 |
   
 表2表格项配置 
| **名称**        | **类型**       | **默认值** | **说明**                                                                          |
|:---|:---|:---|:---|
| tableName     | string       | --      | 表格名称，展示为tab页签的标题。 当表格项个数为1个时不展示。 |
| columns       | columnConfig | --      | 表格列的配置信息，具体配置请参考[表3]。           |
| queryDataType | string       | --      | 获取表格数据源的方式，当前仅支持配置为"api"。                                                       |
| apiConfig     | apiConfig    | --      | 数据源接口的配置，具体配置请参考[表4]。        |
   
 表3表格列配置 
| **名称**  | **类型** | **默认值**               | **说明**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|:---|:---|:---|:---|
| title   | string | --                    | 列标题，展示为表格中各列的参数名称。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| field   | string | --                    | 列的key值，用于映射数据源中的字段。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| type    | string | --                    | 数据处理方式，包括如下选项： - link：链接方式，配置此种方式时，需要配置"jumpUrl"参数。  - date：日期方式，配置此种方式时，需要配置"format"参数。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| jumpUrl | string | --                    | 跳转链接，只在" type"配置为"link"时有效。 若使用${fieldName}，则取表格数据中的fieldName字段的值替换${fieldName}生成跳转链接。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| format  | string | 'yyyy-MM-dd HH:mm:ss' | 时间转换格式，只在 "type"配置为"date"'时列有效。 日期格式配置规则如下： - y：四位数的年份  - yyy：四位数的年份  - yyyy：四位数的年份  - yy：两位数年份  - M: 不带前导0的月份（例如：1-12）  - MM：带前导0的月份（例如：01-12）  - MMM：月份的缩写（例如：Jan、Feb）  - d：不带前导0的日期（例如：1-31）  - dd：带前导0的日期（例如：01-31）  - h：12 小时制的小时，不带前导零（例如：1-12）  - hh：12小时制的小时，带前导零（例如：01-12）  - H：24 小时制的小时，不带前导零（例如：0-23）  - HH：24小时制的小时，带前导零（例如：00-23）  - m：不带前导0的分钟（例如：0-59）  - mm：带前导0的分钟（例如：00-59）  - s：不带前导0的秒钟（例如：0-59）  - ss：带前导0的秒钟（例如：00-59）  - SSS：毫秒（例如：000-999）   |
   
 表4数据源接口配置 
| **名称**        | **类型** | **默认值**    | **说明**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|:---|:---|:---|:---|
| url           | string | ''         | 接口的URL地址。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| method        | string | 'GET'      | 接口的请求方式，包括如下选项： - GET  - POST  - DELETE  - PUT   |
| headers       | Object | {}         | 接口请求头配置，支持HTTP标头配置项，同时支持机机认证逻辑。如果配置为机机认证，需要配置机机认证信息，具体配置请参考[表5]。                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| body          | Object | {}         | 接口参数。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| pageNoField   | string | 'pageNo'   | 接口分页参数中页码对应的名称。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| pageSizeField | string | 'pageSize' | 接口分页参数中分页条数对应的名称。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| dataBody      | string | ''         | 接口响应返回值中表格数据链式路径。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| totalBody     | string | ''         | 接口响应返回值中表格总条数链式路径。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
   
 表5机机认证配置 
| **名称**           | **类型** | **默认值** | **说明**                             |
|:---|:---|:---|:---|
| applyId          | string | --      | 接入机机认证机制的第三方接口对应的应用ID，用于获取token。   |
| authorizationKey | string | --      | 接入机机认证机制的第三方接口自定义的请求头字段，用于携带token。 |
   
