YonBIPV3.0(R6_2407_1)旗舰版云平台-三方集成资产-BIP和钉钉新版集成资产操作手册用友网络科技股份有限公司2024年9月用户手册1/41版权©2024用友集团版权所有。未经用友集团的书面许可，本用户手册任何整体或部分的内容不得被复制、复印、翻译或缩减以用于任何目的。本用户手册的内容在未经通知的情形下可能会发生改变，敬请留意。请注意：本用户手册的内容并不代表用友网络所做的承诺。用户手册2/41目录第一章前期准备（非必需）.............................................................................................................................51.1初始化钉钉企业内部应用...................................................................................................................51.2添加接口授权..........................................................................................................................................61.3开发设置-安全设置..............................................................................................................................71.4开发设置-分享设置..............................................................................................................................71.5发布钉钉企业内部应用.......................................................................................................................7第二章集成资产包导入与配置.........................................................................................................................82.1集成应用导入（集成应用包请先联系相关人员获取）............................................................82.2API授权....................................................................................................................................................82.3BIP连接配置创建................................................................................................................................102.4钉钉连接配置创建...............................................................................................................................122.5集成应用连接配置绑定.....................................................................................................................142.6开通租户事件订阅白名单（仅公有云需要）.............................................................................142.7配置事件订阅........................................................................................................................................152.7.1添加待办事件订阅..................................................................................................................152.7.2更新待办事件订阅..................................................................................................................182.7.3工作通知事件订阅..................................................................................................................202.8配置API路由........................................................................................................................................212.8.1添加待办API路由配置.........................................................................................................212.8.2更新待办API路由配置.........................................................................................................23用户手册3/412.8.3工作通知API路由配置.........................................................................................................25第三章集成方案配置说明................................................................................................................................273.1BIP行政业务单元同步钉钉部门.....................................................................................................273.2BIP行政业务单元停用同步删除钉钉部门...................................................................................283.3BIP部门同步钉钉部门.......................................................................................................................293.4BIP部门停用同步删除钉钉部门.....................................................................................................293.5BIP简版员工同步钉钉用户..............................................................................................................303.6BIP简版员工停用同步删除钉钉用户............................................................................................313.7BIP简版员工钉钉用户主键关系绑定............................................................................................323.8BIP人力云员工同步钉钉用户..........................................................................................................333.9BIP人力云员工停用同步删除钉钉用户.......................................................................................333.10BIP人力云员工钉钉用户主键关系绑定.....................................................................................343.11BIP添加待办消息同步创建钉钉待办任务................................................................................353.12BIP更新待办消息同步更新钉钉待办执行者状态...................................................................363.13BIP工作通知同步发送钉钉工作通知..........................................................................................38第四章注意事项..................................................................................................................................................394.1同步任务执行顺序...............................................................................................................................394.2关于常量、默认值、直接映射使用说明......................................................................................394.3数据同步任务执行频率.....................................................................................................................404.4员工档案同步不支持存在上下级关系的员工同时同步..........................................................404.5行政业务单元和部门档案同步方案不适用期初数据同步......................................................40用户手册4/414.6不支持BIP部门负责人不在本部门下的部门同步....................................................................404.7其它..........................................................................................................................................................40用户手册5/41第一章前期准备（非必需）1.1初始化钉钉企业内部应用访问钉钉开放平台（网址：https://open-dev.dingtalk.com/）切换应用开发页签，创建钉钉企业内部应用用户手册6/411.2添加接口授权需要授权接口如下：⚫通讯录部门信息读权限⚫维护通讯录的接口访问权限用户手册7/41⚫成员信息读权限⚫根据手机号获取成员基本信息权限⚫通讯录部门成员读权限⚫待办应用中待办写权限1.3开发设置-安全设置配置重定向URL（回调域名）：URL：http://+{单点服务域名}+/index示例：http://89730820diov.vicp.fun/index配置端内免登地址：URL：http://+{单点服务域名}+/index示例：http://89730820diov.vicp.fun/index1.4开发设置-分享设置配置微应用回调的URL：URL：http://+{单点服务域名}+/index示例：http://89730820diov.vicp.fun/index1.5发布钉钉企业内部应用用户手册8/41第二章集成资产包导入与配置2.1集成应用导入（集成应用包请先联系相关人员获取）在用友YonBIP系统中的云平台>连接集成服务>数据集成>集成设计>集成方案设计界面，点击右上角“集成应用设计”按钮，将取得的集成应用包在该界面，左上角点击“导入”功能，完成集成应用的导入新建工作。2.2API授权创建授权配置，并授权相关API用户手册9/41需要授权接口如下：⚫业务单元列表数据同步：/yonbip/digitalModel/OrgUnitSync/doSync⚫组织单元详情查询:/yonbip/digitalModel/orgunit/detail⚫部门详情查询：/yonbip/digitalModel/admindept/detail⚫员工列表查询：/yonbip/digitalModel/staff/list⚫员工详情查询：/yonbip/digitalModel/staff/detail⚫员工信息列表查询MDD：/yonbip/hrcloud/staff/listmdd用户手册10/41⚫获取员工详细信息MDD：/yonbip/hrcloud/HRCloud/getStaffDetail⚫集成认证中心获取登录临时code：/yonbip/yht/getThirdLoginCode2.3BIP连接配置创建集成应用导入成功之后，需要进行连接配置后才能使用，操作步骤如下：1、在用友YonBIP系统中的云平台>连接集成服务>集成实施工具>连接管理>连接配置界面，点击新建连接按钮>选择对应的连接器>填写基本配置信息>确认>测试连接，提示连接测试成功即可。2、填写host、appkey、appsecret（用上面创建授权配置获取的appkey、appsecret）host:域名，根据部署环境填写（例如：https://bip-new18.yyuap.com）用户手册11/413、填写完毕后点击测试连接用户手册12/412.4钉钉连接配置创建在用友YonBIP系统中的云平台>连接集成服务>集成实施工具>连接管理>连接配置界面，点击新建连接按钮>选择对应的连接器>填写基本配置信息>确认>测试连接，提示连接测试成功即可。具体创建步骤可参照BIP连接配置创建。用户手册13/41具体属性说明：⚫应用类型：钉钉的应用类型，internalApp-企业内部应用；thirdPartyApp-第三方企业应用，该字段全场景必填⚫钉钉企业ID：钉钉的企业ID⚫钉钉应用ID：钉钉企业内部应用ID⚫钉钉应用公钥：钉钉企业内部应用公钥⚫钉钉应用私钥：钉钉企业内部应用私钥⚫钉钉域名：钉钉开放平台API域名，默认https://oapi.dingtalk.com⚫钉钉待办域名：钉钉开放平台待办类API域名，默认https://api.dingtalk.com⚫连接请求超时(s)：请求的超时时间设置，单位秒⚫网关代理：如果bip和钉钉都是私有云，网络是连通的则不需要开启；如果bip是公有云，钉钉是私有云，网络没有连通则需要将混合云网关部署至本地内网中，用于打通云上云下的内外网穿透⚫网关信息：如果网关代理打开，需要选择对应的混合云网关，创建网关具体请请参考第三章注意：连接配置信息录入完成以后，一定要点击一下“测试连接”按钮，这样可以提前校验出错误的配置信息，尤其是操作配置属性。用户手册14/412.5集成应用连接配置绑定来源系统和目标系统连接配置创建完成之后，点击集成应用【BIP和钉钉】的编辑按钮，将刚创建的连接配置选择上，进行保存即可。2.6开通租户事件订阅白名单（仅公有云需要）注意:公有云订阅事件待办事件，需要发送邮件给消息与打印开发部胡连平（hulp@yonyou.com）进行开通，同时抄送宗腾飞（zongtf3@yonyou.com）和肖萌（xiaomenga@yonyou.com），需要包含信息如下：1.项目2.开通原因3.租户id和数据中心；参考模板如下：你好，请帮忙开通事件订阅中创建待办和更新待办事件，具体信息如下：1.项目：中电海康项目2.开通原因：三方系统集成YonBIP待办3.租户id:oxv67tfi，数据中心:公有云核心2用户手册15/41租户ID的查询方法如下：菜单目录：数字化建模>我的企业>企业设置>企业信息2.7配置事件订阅菜单路径：云平台>连接集成服务>API管理>事件订阅。2.7.1添加待办事件订阅鼠标悬停在【钉钉集成测试】应用条目，点击【事件订阅】按钮，配置添加待办事件订阅回调地址。第1步：查询“监听BIP添加待办事件推送三方系统”API地址。API文档菜单目录：云平台>连接集成服务>API管理>调用API>API文档用户手册16/41第2歩：配置事件订阅回调地址事件订阅回调地址格式：https://YonBIP业务中台统一域名/iuap-api-gateway/yonbip/uspace/event/todocenter/addTodo。回调地址示例：https://bip-pre.yonyoucloud.com/iuap-api-gateway/yonbip/uspace/event/todocenter/addTodo第3歩：新增“添加待办消息”订阅：用户手册17/41第4歩：访问【API调用】节点，对授权Key进行API授权API调用菜单地址：云平台>连接集成服务>API管理>调用API>API调用用户手册18/412.7.2更新待办事件订阅第1歩：添加“BIP更新待办推送三方系统”授权Key第2步：查询“监听BIP更新待办事件推送三方系统”API地址，配置回调地址，添加“更新待办消息”订阅事件。事件订阅回调地址格式：https://YonBIP业务中台统一域名/iuap-api-gateway/yonbip/uspace/event/todocenter/updateTodo。回调地址示例：https://bip-pre.yonyoucloud.com/iuap-api-gateway/yonbip/uspace/event/todocenter/updateTodo用户手册19/41第3歩：访问【API调用】节点，对授权Key进行API授权授权API列表：1.监听BIP更新待办事件推送三方系统用户手册20/412.7.3工作通知事件订阅第1歩：添加“BIP工作通知推送三方系统”授权Key，配置事件订阅第2歩：查询“监听BIP工作通知事件推送三方系统”API地址，配置回调地址，添加“工作通知”、“更新工作通知”订阅事件。事件订阅回调地址格式：https://{YonBIP业务中台统一域名}/iuap-api-gateway/yonbip/uspace/event/worknotify/addWorkNotify回调地址示例：https://bip-pre.yonyoucloud.com/iuap-api-gateway/yonbip/uspace/event/worknotify/addWorkNotify用户手册21/41第3歩：访问【API调用】节点，对授权Key进行API授权授权API列表：1.监听BIP工作通知事件推送三方系统2.8配置API路由菜单目录：云平台>连接集成服务>API管理>调用API>API路由2.8.1添加待办API路由配置1.新增API路由规则，选择“监听BIP添加待办事件推送三方系统”API用户手册22/412.点击【设计】按钮，设计API路由规则3.点击【新建规则】，配置API路由规则名称、触发条件、以及执行集成方案。规则名称：用户手册23/41规则名称：BIP添加待办消息同步创建钉钉待办任务触发条件：actionKey=ucenter集成方案：BIP添加待办消息同步创建钉钉待办任务4.保存路由配置2.8.2更新待办API路由配置第1歩：新增API路由规则，选择“监听BIP更新待办事件推送三方系统”API，点击【设计】按钮，设计API路由规则。用户手册24/41第2歩：点击【新建规则】，配置API路由规则名称、触发条件。选择“BIP更新待办消息同步更新钉钉待办执行者状态”集成方案作为执行动作。规则名称：BIP更新待办消息同步更新钉钉待办任务触发条件：actionKey=finish::ucenter、actionKey=revocation::ucenter集成方案：BIP更新待办消息同步更新钉钉待办执行者状态用户手册25/41第3歩：并保存路由配置。2.8.3工作通知API路由配置第1歩：新增API路由规则，选择“监听BIP工作通知事件推送三方系统”API，点击【设计】按钮，设计API路由规则。第2歩：点击【新建规则】，配置API路由规则名称、触发条件。选择“BIP工作通知同步发送钉钉工作通知”集成方案作为执行动作。用户手册26/41规则名称：BIP工作通知同步发送钉钉工作通知触发条件：actionKey=UCenterAppIdShareNotify集成方案：BIP工作通知同步发送钉钉工作通知第3歩：并保存路由配置。用户手册27/41第三章集成方案配置说明3.1BIP行政业务单元同步钉钉部门⚫方案编码：bip_orgunit_dingtalk_dept_sync_timer⚫集成场景：定时将BIP的行政业务单元同步到钉钉部门用户手册28/413.2BIP行政业务单元停用同步删除钉钉部门⚫方案编码：bip_orgunit_dingtalk_dept_del_timer集成场景：BIP的行政业务单元停用，同步删除钉钉部门用户手册29/413.3BIP部门同步钉钉部门⚫方案编码：bip_dept_dingtalk_dept_sync_timer集成场景：定时将BIP的部门同步到钉钉部门3.4BIP部门停用同步删除钉钉部门⚫方案编码：bip_dept_dingtalk_dept_del_timer集成场景：BIP的部门停用，同步删除钉钉部门用户手册30/413.5BIP简版员工同步钉钉用户⚫方案编码：bip_psndoc_dingtalk_user_sync集成场景：定时将BIP的简版员工同步到钉钉用户用户手册31/413.6BIP简版员工停用同步删除钉钉用户⚫方案编码：bip_psndoc_dingtalk_user_del_timer集成场景：BIP的简版员工停用，同步删除钉钉用户用户手册32/413.7BIP简版员工钉钉用户主键关系绑定⚫方案编码：bip_psndoc_dingtalk_user_bind集成场景：绑定BIP简版员工用户ID和钉钉用户unionId的主键映射关系用户手册33/413.8BIP人力云员工同步钉钉用户⚫方案编码：bip_staff_dingtalk_user_sync_timer集成场景：定时将BIP的人力云员工同步到钉钉用户3.9BIP人力云员工停用同步删除钉钉用户⚫方案编码：bip_staff_dingtalk_user_del_timer集成场景：BIP的人力云员工停用，同步删除钉钉用户用户手册34/413.10BIP人力云员工钉钉用户主键关系绑定⚫方案编码：bip_staff_dingtalk_user_bind集成场景：绑定BIP人力云员工用户ID和钉钉用户unionId的主键映射关系用户手册35/413.11BIP添加待办消息同步创建钉钉待办任务⚫方案编码：bip_todo_dingtalk_todo_sync_realtime集成场景：监听BIP添加待办事件，创建钉钉待办任务用户手册36/413.12BIP更新待办消息同步更新钉钉待办执行者状态⚫方案编码：bip_todo_dingtalk_todo_update_realtime集成场景：监听BIP更新待办事件，更新钉钉待办执行者状态用户手册37/41用户手册38/413.13BIP工作通知同步发送钉钉工作通知⚫方案编码：bip_worknotify_dingtalk_message_sync集成场景：监听BIP工作通知事件，发送钉钉工作通知用户手册39/41第四章注意事项4.1同步任务执行顺序人力云租户：1.BIP行政业务单元同步钉钉部门2.BIP部门同步钉钉部门3.人力云员工同步钉钉用户4.人力云员工钉钉用户主键关系绑定5.待办消息、工作通知事件监听简版员工同步顺序：1.BIP行政业务单元同步钉钉部门2.BIP部门同步钉钉部门3.BIP简版员工同步钉钉用户4.BIP简版员工钉钉用户主键关系绑定5.待办消息、工作通知事件监听4.2关于常量、默认值、直接映射使用说明1、常量配置必须配置来源，按照来源取值作为转换前映射转换后数据，需清除默认值。2、默认值使用必须清除来源字段，否则默认值不生效。用户手册40/414.3数据同步任务执行频率集成应用下的所有集成方案，定时执行的时间频率可根据项目需求自行选择4.4员工档案同步不支持存在上下级关系的员工同时同步受BIP员工档案不支持树形档案同步影响，存在上下级关系的员工档案无法一次同步成功。期初数据同步需执行两次。4.5行政业务单元和部门档案同步方案不适用期初数据同步行政业务单元和部门下的部门负责人字段依赖员工档案同步集成方案同步，部门同步集成方案和员工档案同步集成方案互为依赖。项目上做期初数据同步时，当同步完人员档案后，需要二次同步部门档案，以更新部门负责人信息。4.6不支持BIP部门负责人不在本部门下的部门同步BIP部门负责人可以不在本部门下，钉钉部门负责人必须是本部门的员工。4.7其它BIP的单据编号不允许超过32位，否则无法保存。
