0YonBIPV3.0(R5_2312_1)旗舰版云平台篇-连接集成服务-集成总线用友网络科技股份有限公司2024年1月用户手册1/36版权©2024用友集团版权所有。未经用友集团的书面许可，本用户手册任何整体或部分的内容不得被复制、复印、翻译或缩减以用于任何目的。本用户手册的内容在未经通知的情形下可能会发生改变，敬请留意。请注意：本用户手册的内容并不代表用友网络所做的承诺。用户手册2/36目录第一章总体概述................................................................................................................................................41.1产品概述................................................................................................................................................41.2产品价值................................................................................................................................................4第二章应用场景................................................................................................................................................52.1场景一：主数据分发.............................................................................................................................52.1.1场景描述.......................................................................................................................................52.1.2业务流程.......................................................................................................................................52.1.3流程说明.......................................................................................................................................6第三章操作指南................................................................................................................................................63.1集成设计....................................................................................................................................................63.1.1集成应用.......................................................................................................................................63.2.1简单对照.....................................................................................................................................143.2集成资源.................................................................................................................................................163.2.1环境管理.....................................................................................................................................173.2.2驱动管理.....................................................................................................................................243.2.3证书管理.....................................................................................................................................263.3运行监控.................................................................................................................................................293.3.1监控日志.....................................................................................................................................293.3.2监控分析.....................................................................................................................................313.4系统配置.................................................................................................................................................33用户手册3/363.4.1系统配置.....................................................................................................................................33用户手册4/36第一章总体概述1.1产品概述企业信息化建设经历了这么多年，各种类型的企业应用层出不穷，且随着各低代码开发平台的逐步成熟，更是加速了企业数字化进程和众多创新应用产出；企业客户或多或少都在面临多年积累、以及创新场景下各种类型企业应用整合的问题，ERP、OA、电商、SaaS服务、企业自建应用或者遗留系统等等。用友在企业服务产业深耕30多年，结合多年为各大企业客户集成业务提供的产品交付和项目支持经验，研发了连接集成平台YonLinker的新一代集成总线YSB产品。集成总线YSB，提供标准化、可复用、生态共建的集成资源与各种类型企业应用互联互通，基于云原生、轻量化、安全、可靠、高性能的运行时，为用户提供web端轻量化的集成设计器，提供集成应用创建、模型设计、连接配置、流程编排、脚本扩展开发、应用部署、在线调试、运行调度、监控告警等全生命周期的服务编排能力。1.2产品价值丰富的可复用集成资源。预置大量通用的技术连接器、常见的业务连接器和流程编排逻辑组件等集成资源。用户手册5/36轻量化的集成设计器。为用户提供在线创建集成应用、模型设计、连接配置、流程编排、脚本扩展开发、应用部署、在线调试、运行调度、监控告警等全生命周期的集成应用设计能力。流程化的服务编排。基于丰富的可视化集成资源组件、低代码脚本开发和流程设计器，为用户提供各种协议和组件混排的服务编排能力。简单易用的低代码脚本。类JSON语法的在线脚本，学习门槛低，简单易用；预置了大量适用于各类消息转换场景的函数，可供用户快速复用；实时生效、高效执行的脚本引擎，用户只需要关心自身的业务逻辑。连接器共建机制。提供面向生态连接器扩展能力，提供标准化、具备开放性的共建机制提供丰富的监控功能。可监控所有编排流程的运行情况，提供多维度（成功调用次数，失败调用次数、流量、状态码）统计及错误统计，支持查看某个集成流在一段时间内的实时以及历史运行情况，并能查看集成流运行过程中哪个节点出现问题。云原生、安全、可靠、高性能的运行时。企业级数据转换能力。支持对消息进行数据编排、格式转换，支持映射、简单对照、常量以及表达式。第二章应用场景2.1场景一：主数据分发2.1.1场景描述主数据的数据变更之后，可以分发给第三方系统2.1.2业务流程用户手册6/362.1.3流程说明准备工作：在主数据中创建模型、集成系统、订阅权限集成系统中的分发地址需要填写主数据分发流程的地址设计流程：选择主数据监听连接器，配置主数据的连接配置，在集成对象中拉取该连接配置的数据模型，在主数据监听连接器中选择需要监听的数据模型根据集成系统判断走不同的分支如果第三方系统需要的数据根主数据分发出来的不一样，则可添加Transfrom组件处理第三方系统返回第三章操作指南3.1集成设计3.1.1集成应用用户手册7/363.1.1.1功能描述集成应用是集成设计的入口，支持多系统间集成业务场景的统一设计和管控，应用内支持集成流设计、系统连接、流程编排、应用部署、开发调试，每个集成应用对应一个具体的集成场景。3.1.1.2业务规则支持集成应用新建、编辑、删除、导入、导出、复制；支持根据集成应用编码和名称查询支持查看集成应用部署详情，历史部署日志支持设置应用级变量提供可视化低代码流程设计器，通过拖、拉、拽组件并设置参数即可完成复杂的集成业务逻辑，同时支持脚本语言来满足复杂集成业务场景的需求提供可视化组件：技术连接器有HTTPListener、HTTPRequest、JMS、AMQP、DataBase、SOQP、Email、Kafka、Redis,业务连接器有U8连接器、YonBIP高级版连接器、主数据连接器，核心组件有：日志、异步、设置消息体、设置流程变量、移除流程变量、数据转换、事务范围、条件分支、并行分支、失败重试、循环、并行循环、抛出错误、缓存范围、子流程引用、加解密、加签验签、定时器；流程化服务编排：支持拖拽组件并配置参数、条件分支、并行、串行等进行服务编排；YDX脚本设计器：提供丰富的内置变量、内置函数，支持自动联想、自动补全、语法高亮、错误提示、调试能力，支持数据集成、主数据和BIP翻译函数；问题快速定位：设计过程中的组件配置问题，提供查询列表，并能快速定位到具体的有问题的配置项；应用部署：集成应用设计完成后，支持快速选择环境进行部署，并能够查看部署日志，可查看应用的部署情况及异常问题；转换组件，支持对消息进行数据编排和格式转换，支持映射（自动映射、手动连线、脚本映射）、简单对照、表达式，支持输入输出数据测试；支持集成流的新建、编辑、复制、删除支持集成对象新建、编辑、选择、删除支持连接配置新建、编辑、选择3.1.1.3栏目说明栏目名称说明应用名称集成应用的名称应用编码集成应用的唯一标识用户手册8/36版本集成应用的版本状态应用的运行状态创建人创建集成应用的人更新人集成应用的最后修改人创建时间集成应用的创建时间更新时间集成应用的更新时间3.1.1.4操作说明集成应用支持设计、修改、复制、导出、删除、详情查看、导入、变量配置点击集成的【新增】按钮，可创建集成应用集成应用创建以后，可以点击【设计】进入集成流设计器页面。设计器，包括头部的问题、全局搜索及部署操作，左侧的集成流、子流程、连接配置、集成对象操作区、底部的问题及日志、中间的流程设计画布区域和右上角的缩略图。用户手册9/36左侧集成流，可创建分类。集成流分类上操作有：新建集成流、复制、重命名、删除新建集成流，填写集成流编码名称，点击完成。用户手册10/36左侧子流程（可将多次使用的集成流片段设置为子流程，可复用），可创建子流程分类子流程分类上操作有：新建子流程、复制、重命名、删除新建子流程，填写子流程编码名称，点击完成用户手册11/36创建完集成流和子流程后，可根据业务场景，编排集成流，选择需要使用的组件，集成流中可引用子流程，添加子流程引用节点，选择需要引用的子流程，用户手册12/36根据不同的组件去配置不同的属性，以及相关的连接配置。连接配置支持选择在连接配置节点已经创建的连接配置，也可以在设计器中新建连接配置。集成流使用的连接配置也可以，在左侧连接配置处，直接进行修改。用户手册13/36设计过程中配置项有校验不通过的配置项，可以在底部的问题列表中展示出来，可以通过问题列表及时查看错误的配置项，并修改。在集成流设计完成后，可进行部署集成流，可点击右上角的【部署】，选择可用的环境进行部署。用户手册14/36部署完成后，可在设计器中查看实时的部署日志。部署成功后，就可以调试该流程。专属化请求地址为：业务中台域名/iuap-ipaas-runtime/httplistenrer节点的path3.2.1简单对照用户手册15/363.2.1.1功能描述简单对照是一组键值对配置对应关系的规则定义，可用于在数据转换中对属性进行对照，根据定义的键值对进行值映射，是数据转换中用途比较广泛的一种规则。3.2.1.2业务规则支持简单对照的新建、编辑、删除支持根据编码和名称搜索支持简单对照内键值对的新建、编辑、删除支持简单对照导入导出3.2.1.3栏目说明简单对照主表栏目名称说明编码简单对照的唯一标识，必填项名称简单对照的名称，必填项描述简单对照的描述，非必填项简单对照数据子表栏目名称说明Key简单对照的Key值Value简单对照的Value值描述简单对照的键值对描述3.2.1.4操作说明首先进入简单对照首页，显示所有已维护的简单对照列表数据用户手册16/36点击【新增】按钮，弹出窗口打开新增简单对照页面点击【导入】按钮，打开简单对照导入页面，下载导入模板，按模板填写导入文件，上传导入文件3.2集成资源用户手册17/363.2.1环境管理3.2.1.1功能描述环境管理用于管理集成引擎，可以通过环境管理查看集成引擎的状态，运行的实例数量、每个实例节点的运行状态、日志，部署的集成应用运行情况、每个集成应用的运行日志。3.2.1.2业务规则支持环境编码和名称查询支持查看环境是否可用状态支持新增、修改、删除不可用环境支持查看环境下的运行时实例运行状态、重启实例、清除断开实例支持查看环境下部署的集成应用、查看状态、重新部署、查看日志支持查看运行时实例的日志，并能调整运行时日志文件存储的大小，以及可下载日志文件支持查看运行时实例CPU、内存、硬盘的使用情况3.2.1.3栏目说明环境的基本信息栏目名称说明环境编码环境的唯一标识环境名称环境的名称应用数量环境下部署的应用数量运行时数量环境下运行的集成引擎的数量最后执行人之后操作该环境的用户创建时间环境的创建时间最后执行时间环境的最后执行动作的时间运行时信息栏目名称说明用户手册18/36运行时ID运行时实例的唯一标识运行时名称运行时实例的名称运行时长该运行实例运行的时长版本集成引擎的版本状态运行时的状态是否技术中台安装技术中台安装或者是本地安装运行中的应用运行实例中运行的应用数量启动时间运行时实例的启动时间应用的信息栏目名称说明应用名称集成应用的名称应用编码集成应用的唯一标识版本集成应用的版本状态应用的运行状态创建人创建集成应用的人部署时间部署集成应用的时间最后执行动作最后操作集成应用的动作3.2.1.4操作说明专属化环境，默认安装完会自带一个环境，但是并没有集成设计控制台建立连接，需要配置后重启，可参考后面复制启动配置部分。界面支持环境编码或者名称进行查询。该页面可展示已经创建的环境列表，可查看环境的编码、名称、创建人、最后执行人、应用部署数量、运行时实例数量、创建时间和最后执行时间。状态显示为可用的环境可进行集成应用部署使用。用户手册19/36当有不同的集成应用需要部署到不同的环境进行隔离使用时，可添加新的环境。添加新的环境，需要提前准备好集成引擎的安装包，安装过程可参考安装文档。点击【添加】按钮，添加环境需要输入编码和名称，均需要在租户下保证唯一。点击【下一步】会自动生成集成引擎的启动配置。启动配置:用于集成引擎和控制台建立连接，只有建立连接后，集成应用才能部署到该集成引擎中。可临时复制该启动配置到剪贴板，或复制base64配置，后续使用。用户手册20/36点击【下一步】可进行日志配置。运行时日志配置：运行时日志为集成引擎运行过程中产生的日志，日志配置决定日志文件存储的大小以及日志文件数量，默认为最多存储100M，多余的日志文件会自动删除，可根据实际情况进行调整。云监控日志配置：默认启用云监控，该日志为集成应用调用日志，存储方式为统一存储（YMS统一配置的ES）或者独立ES存储（用户可使用自行搭建的ES）。只有启用云监控，运行监控中的监控日志和监控分析功能才能使用。用户手册21/36添加环境后，默认环境是不可用状态。需要将上面复制的启动配置复制到{ysbhome}/conf/con-auth.yml文件中，并启动集成引擎，若复制的是base64配置，则需要在yms控制台中添加一个配置信息，并发布yms配置，在技术中台启动集成引擎，如果为独立部署，则启动命令路径为：{ysbhome}/bin/ysb。启动成功后，该环境为可用状态。点击【编辑】可对运行时进行修改，只能修改名称。用户手册22/36点击环境，可进入环境的详细页面，该页面可查看运行时实例、集成应用、属性、日志、监控。运行时实例：可以查看环境下的运行时实例的运行情况、状态、可查看运行时实例的日志、查看详情、查看配置。并支持重启运行时实例，可清理已经断开连接的运行时实例。应用列表：可以查看环境下部署的应用的运行情况，并可以查看应用的日志、以及重新部署应用。属性：环境的启动配置信息，可从属性中进行复制。同时可以在属性中调整日志文件的大小。以及调整云监控的启用配置。用户手册23/36日志：可查看运行时的系统级日志，以及集成应用的日志，并支持日志下载。监控：可查看运行时的CPU、内存、磁盘的情况用户手册24/363.2.2驱动管理3.2.2.1功能描述驱动管理用于维护数据库、AMQP、JMS等中间件需要用到的驱动的管理，可用于扩展不支持的驱动版本。3.2.2.2业务规则支持驱动的新建、编辑、删除、上传，维护驱动的不同版本支持根据编码和名称搜索预置的驱动有MySQL-5.1.38、MySQL-8.0.22、SQLServer-11.2、Ojdbc6-11.2.0.3、ActiveMQ-5.15.4、AMQP-5.12.0。预置的驱动不能删除。3.2.2.3栏目说明栏目名称说明驱动编码驱动的唯一标识驱动名称驱动的名称类名驱动对应的类名版本驱动对应的版本类型驱动类型用户手册25/363.2.2.4操作说明首先进入的是驱动管理首页，展示了所有预置和自己维护的驱动列表数据，支持按租户ID、驱动名称或编码进行搜索。点击【新增】按钮，打开新增页面驱动列表上点击【修改】按钮，打开修改页面用户手册26/363.2.3证书管理3.2.3.1功能描述证书管理用于维护证书，证书可在需要配置证书的连接配置中使用。3.2.3.2业务规则支持证书库的新建、编辑、删除支持证书的新建、修改别名、删除、导出、支持P12证书导入、复制证书内容支持根据编码和名称搜索证书库，支持根据别名搜索证书3.2.3.3栏目说明证书库栏目名称说明编码证书组的唯一标识名称证书组的名称证书数量证书组的数量用户手册27/36证书栏目名称说明生成方式包括平台颁发和自签名2种方式，必填项别名证书的别名，必填项加密算法固定为RSA有效期证书的有效期，单位是天，必填项证书格式固定为X.509密码证书的私钥访问密码，必填使用者信息格式例如:C=CN,ST=beijing,O=yongyou,CN=127.0.0.1，必填项3.2.3.4操作说明首先进入的是证书管理首页，展示了所有已维护的证书组列表数据点击【新增】按钮，打开证书组的新增页面，输入编码和名称，不允许重复用户手册28/36点击证书组列表上的【修改】按钮打开证书组的修改页面，可以修改编码和名称值点击证书组列表上的【删除】按钮，提示是否确认删除，确认后将删除所选证书点击证书组列表上的【证书列表】按钮，打开证书列表页面证书列表页面点击【新增】按钮，打开新增证书页面用户手册29/36证书支持导入P12、导出证书和导出CA功能3.3运行监控3.3.1监控日志3.3.1.1功能描述监控日志是对集成应用调用过程的记录，默认记录所有集成应用、集成流、以及技术连接器和业务连接器详细进出日志，用于后期问题的排查。3.3.1.2业务规则记录应用的运行日志，比如：traceId、应用名称、集成流、节点名称、时间、日志类别（start,end）、状态（成功|失败）、Http响应状态码、协议（http,jms,amqp,db）、所属环境、请求参数、返回参数、请求字节大小、响应字节大小、请求地址、错误日志等。节点维度日志记录目前只有技术连接器（Http、JMS、AMQP、DB）、核心组件(定时器、log)、业务连接器，可以记录日志，用户手册30/36支持根据集成应用、集成流、环境、运行时实例、traceid，时间（默认近30分钟）、状态进行查询。支持查看日志的详情3.3.1.3栏目说明栏目名称栏目说明traceId调用的唯一标识请求参数只记录1M内数据返回参数只记录1M内数据请求字节数请求消息体字节数单位:byte响应字节数响应消息体字节数，单位byte日志记录时间记录日志的时间HTTP响应状态码http响应状态码状态(成功失败)失败日志异常堆栈运行的所属环境环境的主键运行时编码运行时编码集成应用当前调用的应用集成流当前调用的集成流节点当前调用的节点协议（httpjmsamqpdb）协议类型租户id当前集成应用的租户Id调用开始时间调用开始时间调用结束时间调用结束时间用户手册31/363.3.1.4操作说明进入【监控日志】菜单可以进入监控日志页面。可以查看集成流的运行情况，以及进出每个节点的日志。支持根据集成应用、集成流、环境、运行时实例、traceid，时间（默认近30分钟）进行查询。点击【详情】按钮，可查看详细日志3.3.2监控分析3.3.2.1功能描述监控日志是对集成应用调用过程的记录，默认记录所有集成应用、集成流、以及技术连接器和业务连接器详细进出日志，用于后期问题的排查。用户手册32/363.3.2.2业务规则记录应用的运行日志，比如：traceId、应用名称、集成流、节点名称、时间、日志类别（start,end）、状态（成功|失败）、Http响应状态码、协议（http,jms,amqp,db）、所属环境、请求参数、返回参数、请求字节大小、响应字节大小、请求地址、错误日志等。节点维度日志记录目前只有技术连接器（Http、JMS、AMQP、DB）、核心组件(定时器、log)、业务连接器，可以记录日志，支持根据集成应用、集成流、环境、运行时实例、traceid，时间（默认近30分钟）、状态进行查询。支持查看日志的详情3.3.2.3栏目说明栏目名称栏目说明traceId调用的唯一标识请求参数只记录1M内数据返回参数只记录1M内数据请求字节数请求消息体字节数单位:byte响应字节数响应消息体字节数，单位byte日志记录时间记录日志的时间HTTP响应状态码http响应状态码状态(成功失败)失败日志异常堆栈运行的所属环境环境的主键运行时编码运行时编码集成应用当前调用的应用集成流当前调用的集成流节点当前调用的节点协议（httpjmsamqpdb）协议类型租户id当前集成应用的租户Id调用开始时间调用开始时间用户手册33/36调用结束时间调用结束时间3.3.2.4操作说明进入【监控日志】菜单可以进入监控日志页面。可以查看集成流的运行情况，以及进出每个节点的日志。支持根据集成应用、集成流、环境、运行时实例、traceid，时间（默认近30分钟）进行查询。点击【详情】按钮，可查看详细日志3.4系统配置3.4.1系统配置3.4.1.1功能描述系统配置主要是系统级的预置参数，如流程的基础配置文件、根证书、连接器仓库等。用户手册34/363.4.1.2业务规则预置流程的基础配置文件、根证书、连接器仓库。可修改连接器仓库地址，专属化环境为文件服务器minio的地址3.4.1.3栏目说明栏目名称说明编码配置编码名称配置名称参数值配置项内容创建时间创建时间更新时间更新时间3.4.1.4操作说明系统配置菜单，展示配置的信息。专属化安装完成后，需要根据实际的仓库地址进行修改。用户手册35/36
