跳到主要内容

勾选框控件

使用场景

  • 特性:在签署合同的时候, 使用勾选框组合控件进行签署。如下图: 勾选框控件展示
⚠️ 勾选框组合控件分为主子控件的概念1. 主控件 : VIRTUAL_COMBINATION 是个虚拟的控件,只是表示下面的子控件为勾选框控件的组合。 2. 子控件 : 其中包括 CHECK_BOX (勾选框控件) (必须包含) 可以有多个CHECK_BOX控件支持多选和单选。
  • 适用场景:签署方在签署的时候,设置选项。
  • 使用限制:勾选框控件的子组件必须包含勾选框控件。

使用包含勾选框组合控件的模板发起合同

接下来的示例默认您对通过模板发起签署流程 已经熟悉,如您未阅读过此部分,建议先了解如何通过模版发起签署流程

  1. 登录 腾讯电子签控制台

  2. 模板中,配置一个包含勾选框组合控件的模板。 勾选框拖动到模板

  3. 保存模板。

  4. 合同中,选择模板发起合同,使用刚才创建的模板进行发起, 即可发起一份包含勾选框组控件的合同。

使用文件发起一份包含勾选框控件的合同

接下来的示例默认您对通过文件发起签署流程 已经熟悉,如您未阅读过此部分,建议先了解如何通过文件发起签署流程

  1. 调用用PDF文件创建签署接口(ChannelCreateFlowByFiles)创建签署流程,如: 此示例为 一份 B2C 合同,B 端签署人有两个签署控件 (签字和审批控件), C 端签署人只有审批控件

     
    {
    "Agent": {
    "AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
    "ProxyOrganizationOpenId": "org_dianziqian",
    "ProxyOperator": {
    "OpenId": "n9527"
    }
    },
    "FlowName": "文件发起-签批",
    "FlowApprovers": [
    {
    "ApproverType": "ORGANIZATION",
    "OrganizationOpenId": "org_dianziqian",
    "OpenId": "n9527",
    "Name": "典子谦",
    "Mobile": "13200000000",
    "OrganizationName": "典子谦示例企业",
    "SignComponents": [
    {
    "ComponentType": "SIGN_SEAL",
    "ComponentHeight": 119,
    "ComponentWidth": 119,
    "ComponentPage": 1,
    "FileIndex": 0,
    "ComponentPosX": 219,
    "ComponentPosY": 157,
    "ComponentName": "企业印章",
    "ComponentRequired": true
    }
    ],
    "Components": [
    {
    "ComponentType": "VIRTUAL_COMBINATION",
    "ComponentId": "ComponentId_1",
    "ComponentHeight": 120,
    "ComponentWidth": 120,
    "ComponentPage": 1,
    "FileIndex": 0,
    "ComponentPosX": 100,
    "ComponentPosY": 100,
    "ComponentName": "选择",
    "ComponentExtra": "{\"SubType\":\"CHECK_BOX_GROUP\",\"MultiSelect\":true,\"Children\":[\"ComponentId_11\",\"ComponentId_10\"]}"
    },
    {
    "ComponentType": "CHECK_BOX",
    "ComponentId": "ComponentId_10",
    "ComponentHeight": 20,
    "ComponentWidth": 20,
    "ComponentPage": 1,
    "FileIndex": 0,
    "ComponentPosX": 110,
    "ComponentPosY": 100,
    "ComponentName": "选择1"
    },
    {
    "ComponentType": "CHECK_BOX",
    "ComponentId": "ComponentId_11",
    "ComponentHeight": 20,
    "ComponentWidth": 20,
    "ComponentPage": 1,
    "FileIndex": 0,
    "ComponentPosX": 140,
    "ComponentPosY": 100,
    "ComponentName": "选择2"
    }
    ]
    },
    {
    "ApproverType": "PERSON",
    "Name": "张三",
    "Mobile": "18888888888",
    "SignComponents": [
    {
    "ComponentExtra": "{\"Date\":true,\"isAfterCut\":true}",
    "ComponentHeight": 43,
    "ComponentId": "ComponentId_17",
    "ComponentName": "个人签名/印章",
    "ComponentPage": 1,
    "ComponentPosX": 285,
    "ComponentPosY": 478,
    "ComponentRequired": true,
    "ComponentType": "SIGN_SIGNATURE",
    "ComponentWidth": 119,
    "Relation": "ComponentId_18"
    }
    ]
    }
    ],
    "FileIds": [
    "yDCWqUUckpve5id3U4f5EL77tlNh6zTZ"
    ],
    "Unordered": true
    }
    - `UserId` 为发起方经办人的用户 ID,访问 [腾讯电子签控制台](https://qian.tencent.com) 获取。
    - `FlowName` 为合同名称。
    - `Approvers` 指定签署方信息。
    - `ApproverType` 签署方类型。

审批控件类型解释

勾选框组控件属于一种特殊的控件。由一个虚拟组合控件(ComponentType 为VIRTUAL_COMBINATION), 最多四个不同类型的子控件。其中包括 CHECK_BOX (勾选框控件控件) (必须包含)

VIRTUAL_COMBINATION 虚拟控件

component_typecomponent_extra描述
VIRTUAL_COMBINATION两种方式两种只能选一种。 方式1: Children:绝对定位模式下,用来指定此签批控件的组合子控件 children中包含的子Component的ComponentId,保证唯一即可
方式2:是ChildrenComponents:关键字定位模式下,用来指定此签批控件的组合子控件
子控件的集合详情可看 (https://qian.tencent.com/developers/companyApis/dataTypes/#component) 和下方示例

CHECK_BOX 勾选框控件

component_typecomponent_extra描述
CHECK_BOX勾选框控件 子控件必须项可以有多个

方式 1:Children:绝对定位模式下,用来指定此签批控件的组合子控件 children中包含的子Component的ComponentId,保证唯一即可。

{
"Components": [
{
"ComponentType": "VIRTUAL_COMBINATION",
"ComponentId": "ComponentId_1",
"ComponentHeight": 120,
"ComponentWidth": 120,
"ComponentPage": 1,
"FileIndex": 0,
"ComponentPosX": 100,
"ComponentPosY": 100,
"ComponentName": "选择",
"ComponentExtra": "{\"SubType\":\"CHECK_BOX_GROUP\",\"MultiSelect\":true,\"Children\":[\"ComponentId_11\",\"ComponentId_10\"]}"
},
{
"ComponentType": "CHECK_BOX",
"ComponentId": "ComponentId_10",
"ComponentHeight": 20,
"ComponentWidth": 20,
"ComponentPage": 1,
"FileIndex": 0,
"ComponentPosX": 110,
"ComponentPosY": 100,
"ComponentName": "选择1"
},
{
"ComponentType": "CHECK_BOX",
"ComponentId": "ComponentId_11",
"ComponentHeight": 20,
"ComponentWidth": 20,
"ComponentPage": 1,
"FileIndex": 0,
"ComponentPosX": 140,
"ComponentPosY": 100,
"ComponentName": "选择2"
}
]
}

方式 2:ChildrenComponents:关键字定位模式下,用来指定此签批控件的组合子控件 。

{
"Components": [
{
"ComponentType": "VIRTUAL_COMBINATION",
"ComponentId": "甲方(盖章)",
"GenerateMode": "KEYWORD",
"ComponentHeight": 120,
"ComponentWidth": 120,
"ComponentPage": 1,
"FileIndex": 0,
"ComponentPosX": 10,
"ComponentPosY": 127,
"ComponentName": "选择",
"ComponentExtra": "{\"SubType\":\"CHECK_BOX_GROUP\",\"MultiSelect\":true,\"ChildrenComponents\":[{\"ComponentType\":\"CHECK_BOX\",\"ComponentHeight\":20,\"ComponentWidth\":20,\"ComponentPage\":1,\"ComponentOffsetX\":10,\"ComponentOffsetY\":30,\"ComponentName\":\"选择1\"},{\"ComponentType\":\"CHECK_BOX\",\"ComponentHeight\":20,\"ComponentWidth\":20,\"ComponentPage\":1,\"ComponentOffsetX\":40,\"ComponentOffsetY\":30,\"ComponentName\":\"选择2\"}]}"
}
]
}