YonBIPV3.0(R6_2407_1)旗舰版云平台-连接集成平台-集成公共用友网络科技股份有限公司2024年9月用户手册1/38版权©2024用友集团版权所有。未经用友集团的书面许可，本用户手册任何整体或部分的内容不得被复制、复印、翻译或缩减以用于任何目的。本用户手册的内容在未经通知的情形下可能会发生改变，敬请留意。请注意：本用户手册的内容并不代表用友网络所做的承诺。用户手册2/38目录第一章集成公共..............................................................31.1连接管理..............................................................31.1.1总体概述...............................................31.1.2混合云网关.............................................31.1.3连接配置..............................................151.2集成模型管理.........................................................301.2.1集成系统..............................................301.2.2YonBIP连接密钥.......................................331.2.3集成对象..............................................34用户手册3/38第一章集成公共1.1连接管理1.1.1总体概述连接管理作为集成平台统一的连接配置能力，提供混合云网关作为网络穿透，提供连接器做为连接三方通道，为上层任务同步提供统一通道能力。1.1.2混合云网关1.1.2.1功能描述网关是一个运行在企业DMZ区，可以帮助企业内部ERP与外部云端服务互联互通的桥梁，承载着外部系统接入ERP管理服务、API调用、数据同步等重要功能。根据不同的服务器操作系统需要下载对应的网关，安装部署并下载密钥放入指定文件夹。一个网关可以承载多个系统的连接，同时也支持多个网关分别部署连接同一个BIP。1.1.2.2关键应用•网关首页：显示租户所有已创建的网关，可以查看各网关的在线情况；•创建网关：新增网关，维护网关编码、名称和描述信息；•编辑网关：维护网关信息，提供修改网关基本信息，Client端连接信息，查看网关下连接器，更新和部署连接器适配器等功能；•下载网关：下载网关客户端；•下载密钥：下载身份密钥。1.1.2.3栏目说明网关基本信息用户手册4/38栏目名称说明网关编码用户定义的网关编码网关名称用户定义的网关名称网关服务器IP网关部署的服务器IP地址，网关启动时可点击获取IP地址获取出网端口号内网调用网关时的指定端口白名单能够调用网关的IP白名单，多个用逗号隔开；不设置默认均可访问连接器信息字段名称说明连接器实例ID连接配置里的连接器实例标识连接器编码连接器类型标识连接适配器编码连接对应的适配器类型标识连接适配器名称连接对应的适配器类型名称连接编码用户定义的连接标识连接名称用户定义的连接名称连接适配器状态ONLINE表示适配器已部署连接适配器版本连接对应的适配器版本信息1.1.2.4操作说明进入【连接集成服务>数据集成>网关>混合云网关】功能。1.1.2.4.1网关首页显示当前租户所有已创建的网关，按照网关创建时间倒序排列。用户手册5/381.1.2.4.2新建网关点击网关首页中的<新建网关>按钮，弹出【新建网关】窗口录入网关编码、名称和描述信息，其中编码和名称是必填项，编码不能重复。选择网关客户端部署模式，可以选择单一部署和集群部署，其中单一部署表示仅安装一个客户端；集群部署表示根据需要安装多个客户端组成一个集群，可以安装在同一服务器，也可用户手册6/38以安装在不同服务器，一个网关集群下的客户端实例，一定要使用同一个网关下载的密钥文件，不同密钥文件的客户端不能组成同一个网关集群。若部署模式选择了集群部署，则服务器IP编辑框中需要输入所有客户端安装所在服务器的IP，换行输入。只有先录入服务器IP并保存后，这些服务器上的客户端才可以正常启动。1.1.2.4.3编辑网关点击网关卡片或更多中的详情进入网关编辑页面，网关需要在线才能够编辑信息弹出【网关编辑】页面，如下图所示：用户手册7/38在【基础配置】标签页，显示了网关的基本信息、客户端连接信息和高级设置，点击<编辑网关>按钮，可以修改网关基础配置信息，点击<保存>按钮进行保存。界面中根据部署模式和连接方式，会显示不同的内容，具体如下图所示：【单一部署、WEBSOCKET长连接】用户手册8/38【单一部署、HTTP直连】图【集群部署、WEBSOCKET长连接】图用户手册9/38【集群部署、HTTP直连】图基本信息中各字段内容和新建网关页面中的内容一样，不再赘述。客户端连接信息中各字段说明如下：连接方式：指的是YonBIP公有云与客户端之前的连接方式，包括【WEBSOCKET长连接】和【HTTP直连】2种方式，其中:【WEBSOCKET长连接】：指的是客户端启动的时候会向公有云Server端发起连接请求，连接上后此通道将长时间生效，公有云Server端和客户端可直接通过此通道进行通信，无需实时建立HTTP连接。此方式安全性更高，只需客户端所在服务器开通访问公有云Server端的网络权限即可，无需开通外网访问客户端所在服务器的网络权限。【HTTP直连】：需要开通外网访问客户端所在服务器的权限，公有云和客户端的访问请求需要实时通过HTTP协议进行连接，由于需要开通外网访问权限，安全性上比【WEBSOCKET长连接】低。内网访问IP：部署模式为单一部署时显示。客户端提供接口可以让客户内部系统通过客户端访问公有云服务，此接口的IP和端口就是设置的【内网访问IP】和【内网访问端口】。如果网关客户端服务器有多个网卡，就需要管理员通过<获取>按钮选择其中一个网卡的IP。用户手册10/38内网访问端口：部署模式为单一部署时显示。网关客户端启动后系统自动分配的端口号，默认是【22277】，若此端口号已被占用，网关客户端将无法成功启动，就需要管理员修改此端口并保存，客户单会使用新端口进行启动。客户端直连地址：部署模式为单一部署且连接方式为【HTTP直连】时显示。此地址必须是外网可访问的，且是包含http(s)://的完整地址，例如：http://10.10.10.10:8888。客户可以直接给客户端开通外网访问权限，此地址就是此客户端的外网地址。客户也可以在DMZ区安装一个nginx，然后通过nginx路由到客户端，此地址就是nginx的外网地址。客户端直连端口：部署模式为单一部署且连接方式为【HTTP直连】时显示。客户端启动时会分配一个用于被公有云Server端直连的端口号。若客户是通过nginx路由到客户端的，需要在nginx上增加跳转到此端口的配置。nginx访问地址：部署模式为单一部署的【HTTP直连】和【集群部署】时显示。对于集群部署的客户端，需要前置安装一个nginx进行路由跳转。若是长连接方式，则【nginx访问地址】输入集群nginx所在内网地址即可；如果是直连方式，客户可以直接将集群nginx开通外网访问权限，输入集群nginx外网可访问的地址，客户还可以将集群nginx放在内网，单独安装一个外网可以访问的nginx，此nginx上配置跳转到集群nginx上，【nginx访问地址】输入此外网nginx即可。访问地址必须是包含http(s)://的完整地址，例如：http://10.10.10.10:8888。运行实例列表：部署模式为集群部署时显示。显示了同一集群下的所有客户端实例，可以配置每一个实例的实例IP、实例端口号、直连端口号。其中直连端口号仅在连接方式为【HTTP直连】时显示。<获取实例>按钮：刷新客户端实例数据和客户端状态。<下载nginx配置文件>按钮：如果客户在集群里增加了新的客户端，或者删除了一个客户端，需要重新【下载nginx配置文件】，覆盖到nginx服务器上的配置文件，并重启nginx。用户手册11/38<删除>按钮：客户如果要减少集群里的客户端，除了去客户端所在服务器上停掉相应客户端程序，还需要在【运行实例列表】中删除相应的客户端实例，然后重新【下载nginx配置文件】，覆盖到nginx服务器上的配置文件，并重启nginx。IP白名单：可以录入允许第三方系统直接调用网关客户端接口的IP列表，多个IP之间用英文逗号进行分割【连接器】标签页里显示的是当前网关所有已部署的连接器，管理员可以重新部署和卸载连接器。<部署>按钮：用于更新适配器，从云端下载最新的适配器文件。网关客户端的各种功能，是由不同的网关适配器来实现的。例如，网关访问ERP的功能，由ERP通用适配器实现；网关访问云端服务的功能，由ERP服务请求转发适配器实现。网关初次启动时，会自动安装默认适配器。<卸载>按钮：卸载不使用的连接器适配器。【适配器】标签页里显示的是当前网关所有已部署的适配器，管理员可以重新部署和卸载连接器。支持更新、部署、删除与检查各状态用户手册12/381.1.2.4.4下载网关在【网关首页】新建网关后，管理员需要先下载网关客户端，下载位置如下图红框所示：根据网关客户端安装服务器的操作系统，选择下载相应版本的网关客户端。安装说明可点击网关首页右上角的<安装说明>按钮查看详细说明，如下图所示：用户手册13/381.1.2.4.5下载密钥管理员需在网关首页的指定网关上下载密钥，请将下载的密钥解压至Client端解压目录的config文件夹下，下载位置如下图红框所示：注：每个网关有各自不同的密钥文件，一定要从指定网关下载密钥文件，然后覆盖到网关客户端安装目录里，不能随意使用其他网关的下载密钥。用户手册14/381.1.2.4.6启动网关网关下载后需要部署在一台可以访问云端BIP的服务器，并将下载好的网关密钥放入然后启动网关即可用户手册15/381.1.2.4.7测试连接完成以上操作后可以测试网关在线情况1.1.3连接配置1.1.3.1功能描述用于配置和管理连接。根据不同的连接需要，选择相应的连接器，按照要求填写相应的连接配置内容。目前平台支持U8C连接器、HRPS连接器、U9/U9C连接器、NC连接器、NCC连接器、U8连接器、YonBIP高级版连接器、YonBIP连接器、MySQL连接器、SQlServer连接器、通用HTTP转发连接器。后续平台会持续增加支持的连接器。1.1.3.2业务规则•新建/编辑连接：可新建和维护指定连接器的连接配置信息；•删除连接：删除不需要的连接；•测试连接：测试连接的网络连通性；•任务初始化：将后台预置的同步任务初始化到租户里，初始化后租户就可以进行数据同步。用户手册16/381.1.3.3栏目说明栏目名称说明连接器连接器的类型，包括NC连接器、YonBIP连接器、MySQL连接器版本连接器类型对应的版本，例如NC65或mysql5.6连接编码用户定义的连接编码连接名称用户定义的连接名称连接地址连接服务地址，如果为ERP时填写连接地址；如果是数据库类填写IP和端口等信息appKey当连接为公有云比如BIP时，需要填写appKey以便连接身份认证secretKey当连接为公有云比如BIP时，需要填写secretKey以便连接身份认证账套编码当连接为NC等系统时，需要填写账套编码集团编码当连接为NC等系统时，需要填写集团编码用户当连接为NC等系统时，需要填写用户编码1.1.3.4操作说明1.1.3.4.1连接配置首页显示当前租户多有已配置的连接配置信息，按照连接器分组显示，按照创建时间正序排序。用户手册17/38注：系统默认给每个租户都预置了【当前YonBIP连接】，此连接代表当前YonBIP系统，无需维护连接信息。1.1.3.4.2新建连接新建连接有2个入口，一个是连接配置首页右上角的<新建连接>按钮，一个是每个连接器标题右侧的<新建连接>按钮。其中首页右上角<新建连接>，需要先选择连接器，再维护连接信息；连接器标题右侧的<新建连接>，无需选择连接器，使用对应的连接器，直接维护连接信息。以下以首页右上角<新建连接>为例，介绍完整的操作说明，点击首页右上角的<新建连接>按钮，打开选择连接器页面，如下图所示：右上角新建连接配置将会显示全部连接器，按照业务连接器，技术连接器分类，按照场景类型二次分类，支持搜索，一般混合云用友系使用nc，ncc，高级版，u8c，u9，u8等连接器选择指定连接器后，点击<下一步>按钮，平台会跳转到指定连接器的连接配置页面。以下按连接器分别介绍不同连接器对应的连接配置功能。默认连接配置每个租户只能配置一个租户级的默认连接。当调用网关接口(gwmanage/ncopenapilcommonap和/gwmanage/ncopenapi/6xcommonitf)时，若没有传网关D参数，平台会取租户级的默认连用户手册18/38接;目前仅NCNCCloud、YonBIP高级版、U8Cloud支持香署租广级连接配置，默认否该功能移入到右上角统一配置YonBIP旗舰版连接器手工输入连接名称和连接编码，其中连接编码不允许重复；选择连接关联的网关。连接配置各属性说明如下表所示：栏目名称说明用户手册19/38服务地址私有云YonBIP访问地址，含http(s)://，必填项appKey、secretKey管理员需要在私有云YonBIP工作台里【YonBIP连接密钥】功能节点里维护一个连接密钥，然后到公有云连接配置里输入此密钥对应的appKey和secretKey，必填项旧版YonBIP连接器的appKey、secretKey需要在另外一个租户的YonBIP密钥管理节点获取YonBIP高级版连接器手工输入连接名称和连接编码，其中连接编码不允许重复；选择连接关联的网关。用户手册20/38连接配置各属性说明如下表所示：栏目名称说明服务地址YonBIP高级版访问地址，含http(s)://，必填项账套编码YonBIP高级版的账套编码，可通过<获取参数>按钮自动填充集团编码YonBIP高级版的集团编码，可通过<获取参数>按钮自动填充用户编码尽量输入稳定不变的用户，比如系统管理员或者集团管理员租户级默认连接该功能移入右上角统一配置应用公钥使用系统管理员登录YonBip高级版系统，打开节点OpenAPI应用管理卡片页面，复制“公钥”至此应用密钥使用系统管理员登录YonBip高级版系统，打开节点OpenAPI应用管理卡片页面，复制“应用密文”至此应用编码默认ublinker无需修改加密级别默认L0无需修改连接超时时间默认10000ms无需修改套接字超时默认50000ms无需修改高级版外网访问地址YonBIP高级版外网访问地址，含http(s)://非必填轻应用网关外网地址1.网关外网地址输入格式应为http://网关服务器外网ip:轻应用网关端口2.如网关服务器配置有nginx之类的服务，请填写nginx提供的外网地址并映射到1.中的地址3.测试移动轻应用服务是否安装成功可通过浏览器访问http://网关服务器外网ip:轻应用网关端口/openapi/test正确返回mobilelightapptestconnectsuccess轻应用网关端口轻应用网关启动会开放此端口，用于轻应用访问，默认端口号是22290，如果此端口被占用，用户可修改端口号用户手册21/38NC连接器管理员需要先下载补丁，并把下载的补丁打到NC中，重启NC。选择版本，手工输入连接名称和连接编码，其中连接编码不允许重复；选择连接关联的网关。连接配置各属性说明如下表所示：栏目名称说明服务地址NC系统访问地址，含http(s)://，必填项账套编码NC的账套编码，可通过<获取参数>按钮自动填充集团编码NC的集团编码，可通过<获取参数>按钮自动填充用户编码尽量输入稳定不变的用户，比如系统管理员或者集团管理员租户级默认连接该功能移入右上角统一配置用户手册22/38轻应用网关地址输入格式应为http://网关服务器外网ip:轻应用网关端口轻应用混合云密钥点击<获取混合云密钥>按钮，平台会通过轻应用网关地址获取到混合云密钥NCC连接器管理员需要先下载补丁，并把下载的补丁打到NCC中，重启NCC。选择版本，手工输入连接名称和连接编码，其中连接编码不允许重复；选择连接关联的网关。连接配置各属性说明如下表所示：栏目名称说明服务地址NCC系统访问地址，含http(s)://，必填项账套编码NCC的账套编码，可通过<获取参数>按钮自动填充集团编码NCC的集团编码，可通过<获取参数>按钮自动填充用户编码尽量输入稳定不变的用户，比如系统管理员或者集团管理员用户手册23/38租户级默认连接该功能移入右上角统一配置轻应用网关地址输入格式应为http://网关服务器外网ip:轻应用网关端口轻应用混合云密钥点击<获取混合云密钥>按钮，平台会通过轻应用网关地址获取到混合云密钥U8C连接器管理员需要先下载补丁，并把下载的补丁打到U8C中，重启U8C。选择版本，手工输入连接名称和连接编码，其中连接编码不允许重复；选择连接关联的网关。连接配置各属性说明如下表所示：栏目名称说明服务地址U8C系统访问地址，含http(s)://，必填项账套编码U8C的账套编码，可通过<获取参数>按钮自动填充集团编码U8C的集团编码，可通过<获取参数>按钮自动填充用户手册24/38用户编码尽量输入稳定不变的用户，比如系统管理员或者集团管理员租户级默认连接每个租户只能配置一个租户级的默认连接。当调用网关接口（/gwmanage/ncopenapi/commonapi和/gwmanage/ncopenapi/6x/commonitf）时，若没有传网关ID参数，平台会取租户级的默认连接；目前仅NC、NCCloud、YonBIP高级版、U8Cloud支持配置租户级连接配置，默认否U8连接器管理员需要先下载U8开放平台客户端，并安装在可同时访问U8服务器和U8开放平台网站的windows服务器上。选择版本，手工输入连接名称和连接编码，其中连接编码不允许重复；选择连接关联的网关。连接配置各属性说明如下表所示：栏目名称说明BIP组织编码请选择BIP的指定组织，平台会建立此BIP组织和U8账套之间的映射关系，点击【选择BIP组织】按钮进行选择用户手册25/38系统编码U8的EAI接口配置里的系统编码服务地址U8的EAI所在服务器地址数据库地址U8数据库的IP地址数据库U8数据库标识，例如：UFDATA_999_2022数据库账号U8数据库的登录账号数据库密码U8数据库的登录密码设为主账套U8多账套有且只能有一个是主账套，某些U8档案的同步只有主账套才会同步1.1.3.4.3删除连接删除连接，需要注意操作不可逆。1.1.3.4.4测试连接测试连接有2个入口，一个是连接配置首页里每个连接都有个<测试连接>按钮，另一个是连接详情页面里有个<测试>按钮。用户手册26/38测试成功将提示连接成功，如果异常将提示错误信息。1.1.3.4.5任务初始化连接配置里只有NC、NCC、YonBIP高级版、U8、U8C、U9C支持任务初始化，其他系统的任务初始化，必须先购买资产包的方式，然后通过工作台里的【集成资产】功能节点进行初始化。在【连接配置首页】指定连接上点击<初始化>按钮，打开<初始化>页面，如下图所示：用户手册27/38打开页面，平台会去业务系统里获取自定义档案，管理员需要选择要同步的自定义档案，并维护对应YonBIP档案，若有对应的自定义档案则选择相应的BIP自定义档案，若没有则选择【新建档案】。点击<保存自定义档案>按钮，平台会保存管理员选择的自定义档案设置数据。然后点击<初始化ERP任务>按钮，平台会将后台预置的当前连接的同步任务初始化到当前租户下。其中，支持选择初始化档案类型，对于ncc系列需要指定是否用的hr核心人力版本与使用的用户手册28/38职级体系1.1.3.5复制集成对象为减少用户的重复操作，集成对象支持复制操作，见下图所示用户手册29/38复制后的集成对象，见下图所示用户手册30/381.2集成模型管理1.2.1集成系统1.2.1.1功能描述用于管理集成系统，默认包含当前YonBIP系统。可以管理需要集成的各个系统，包括来源系统和目标系统，并关联相应的连接。集成系统下支持管理集成API。1.2.1.2栏目说明栏目名称说明编码用于区分不同的集成系统编码名称用于区分不同的集成系统名称环境区分公有云、私有云说明对于集成系统的补充文字说明用户手册31/381.2.1.3操作说明1.2.1.3.1新增/编辑新增集成系统，给集成系统添加编码和名称，集成系统关联连接配置需要在创建连接配置时建立。一个集成系统仅能关联一个连接配置。用户手册32/381.2.1.3.2删除当集成系统下有关联的连接配置或者API时，集成系统无法删除。如需删除请先移除连接配置和API。其中开放API需要到API发布移除，集成API在集成系统API管理下移除。1.2.1.3.3API管理•当前环境BIP系统：集成API发布在API发布菜单，在集成系统下支持查看集成API。•非当前环境BIP系统：支持在集成系统下同步集成系统对应连接配置下全部的集成API。点击【同步】按钮，连接配置下的全部集成API自动同步到当前环境。当API发布生变更时，需要手动点击【同步】获取最新的API信息用户手册33/38•高级版集成API：支持将高级版已有的API的定义在集成系统中管理。点击【新增】进入高级版增加自定义API页面。1.2.2YonBIP连接密钥1.2.2.1功能描述用于公有云appKey和secretKey密钥管理，可以生成相应的AK/SK，授权允许其他系统与当前系统进行集成。在建立集成连接时通过校验授权密钥来确保读取、写入档案的合法性。1.2.2.2关键应用管理AKSK密钥（新增、编辑、删除）。1.2.2.3栏目说明栏目名称说明AK密码appKey，API接口验证序号，是用于验证API接入合法性的SK密钥secretKey，与appkey对应使用的密钥类型自建（目前全部为自建）备注用户自行编辑的注解说明启动状态开启/关闭1.2.2.4操作说明1.2.2.4.1新增如果需要外部系统对接BIP时，需要通过AKSK密钥，新增时系统会自动生成相应的。用户手册34/38AKSK，其中SK默认为隐藏，需要点击1.2.2.4.2编辑：点击<编辑>，可以修改备注信息，查看AKSK密钥。1.2.2.4.3删除：可以对无用的AKSK密钥进行删除。1.2.3集成对象用户手册35/381.2.3.1功能描述连接集成服务内包含集成应用设计、API定义、连接器API管理时，这些模型的规划和设计都需要用到集成对象。集成对象作为公共底座的一部分，也支持用户的拓展、新增、编辑及删除等操作。1.2.3.2关键应用•支持集成对象的查询及展示如果在租户下，业务连接器已经完成连接配置，就可以查看该业务连接器下的集成对象。集成对象是按照业务连接器的分类进行展示。•支持原厂集成对象的拓展，具有拓展标识的集成对象，支持用户复制原厂集成对象，或用户可以对原厂集成对象进行拓展操作。•支持用户新增、编辑及删除集成对象1.2.3.3字段说明编辑属性：字段名称说明编码不允许非法字符，不允许一个对象内字段编码重复名称不允许非法字符，不允许一个对象内字段名称重复类型字段类型支持任意类型、文本、布尔、整数、数值、日期和参照是否数组若开启数组，字段支持数组格式数据描述维护字段属性描述URI信息参照URI信息（含URI数据结构）用户手册36/38高级属性：字段名称说明扩展属性含起始页码、分页大小、排序字段、查询条件、起始时间、结束时间，集成应用设计内需要使用该属性继承集成对象可引用已有Object型的数据结构，无需反复创建。1.2.3.4操作说明1.2.3.4.1新增集成对象进入【集成公共】/【集成对象】,用户创建集成对象，见下图所示维护集成对象编码、名称及创建方式用户手册37/38用户根据需求，添加字段参数
