YonBIPV3.0(R5_2312)YonSuite云平台篇-低代码开发平台-可视化应用构建用友网络科技股份有限公司2024年1月用户手册1/58版权©2024用友集团版权所有。未经用友集团的书面许可，本用户手册任何整体或部分的内容不得被复制、复印、翻译或缩减以用于任何目的。本用户手册的内容在未经通知的情形下可能会发生改变，敬请留意。请注意：本用户手册的内容并不代表用友网络所做的承诺。用户手册2/58目录第一章总体概述..............................................................................................................................................31.1产品概述..............................................................................................................................................31.2应用地图..............................................................................................................................................31.3产品价值..............................................................................................................................................31.4应用场景..............................................................................................................................................41.5初始准备..............................................................................................................................................7第二章操作指南..............................................................................................................................................72.1应用构建..............................................................................................................................................72.1.1功能描述...........................................................................................................72.1.2业务规则...........................................................................................................72.1.3栏目说明...........................................................................................................72.1.4操作说明...........................................................................................................82.2脚本服务............................................................................................................................................562.2.1功能描述.........................................................................................................562.2.2操作说明.........................................................................................................57用户手册3/58第一章总体概述1.1产品概述应用构建平台的标准版入口在工作台下，为云上企业租户的实施和个性化提供可视化应用构建配置（无代码）、函数式开发（在线脚本）能力；应用构建平台的专业版入口在开发者中心下，面向开发者生态提供开发构建、开放连接、部署运维、在线运营的全生命周期能力。对于企业租户，有源码扩展、独立部署运维需求时，亦可在工作台的应用构建基础版内通过引导快速进入开发者中心进行专业版开发。1.2应用地图应用构建沙箱管理传输包管理传输包部署传输包上载移动工作台1.3产品价值零代码应用构建：为业务管理、IT支持、开发者等不同人群提供无代码构建应用能力。开放集成：支持多种开发体系，实现组件化扩展，并连接和驱动多种来源数据及服务。原厂扩展：为原厂应用提供数据和业务逻辑扩展，支持个性化。一体化服务：提供计算资源管理、代码管理、持续集成等全生命周期的DevOps服务。业务创新：丰富的模板组件，满足各类型业务开发场景，支撑企业快速实现业务创新。用户手册4/581.4应用场景某集团期望打造集约标准的后台、共享贯通的中台、快速创新的前台，并通过中台建设推动企业业务创新和持续积淀的能力，同时让企业进行低成本业务试错、开放自己的能力，实现服务复用。应用构建平台需要提供快速、简单、专业的开发解决方案，并结合开源技术，建设分布式中间件体系（包括分布式消息、缓存、调度等），统一技术框架及界面规格，提高开发实施效率，降低开发实施成本，最后与业务中台、技术中台、数据中台融合贯通，支持中台化架构能力的快速创新。根据集团建设的前台及业务中台业务应用能力的不同，依据应用构建平台分别采取如下三种开发模式。1.4.1.1场景一：快速交付模式1.4.1.1.1业务描述对于模式化的记录型业务应用，采用快速交付模式。1.4.1.1.2业务流程用户手册5/581.4.1.1.3应用清单应用构建沙箱管理传输包管理传输包部署传输包上载移动工作台1.4.1.2场景二：简单开发模式1.4.1.2.1业务描述对于需要个性化的业务应用，采用简单开发模式。1.4.1.2.2业务流程1.4.1.2.3应用清单应用构建沙箱管理用户手册6/58传输包管理传输包部署传输包上载移动工作台1.4.1.3场景三：原生开发模式1.4.1.3.1业务描述对于复杂的、创新型业务应用，采用原生开发模式。1.4.1.3.2业务流程1.4.1.3.3应用清单应用构建沙箱管理传输包管理传输包部署传输包上载用户手册7/58移动工作台1.5初始准备环境开通。第二章操作指南2.1应用构建2.1.1功能描述提供可视化的应用构建过程，分为：数据建模、页面建模、流程&自动化、集成配置、发布管理。从数据模型开始驱动应用设计，从业务模板、数据支持、组件支持、样式扩展4个方面，完善基于元数据和MDD框架页面设计，支持快速类ERP业务单据设计能力；通过拖拽布局和组件元素创建以交互为中心的高度定制化的组装页面；创建业务规则和业务流程，为多种不同的业务或应用的数据流转和工作执行提供支撑；同时通过前后端脚本能力，实现应前端UI控件交互控制，数据计算加工、状态更新、数据流转前后事件等扩展能力；集成智多星RPA机器人，快速和自动执行业务操作；应用支持多端运行和发布，为应用提供PC和移动同等业务执行支撑能力。2.1.2业务规则数据建模：构建数据资源的维护，包括实体、查询和枚举的管理；页面建模：构建应用的页面，包含单据页面、分析页面和第三方页面；流程&自动化：应用的到审批流设计、业务流设计、RPA以及函数的维护；集成配置：应用集成相关配置；发布管理：应用发布到菜单和工作台。2.1.3栏目说明用户手册8/58栏目名称说明应用名称新建应用的名称所属领域新建应用的所属领域应用引擎默认值且为公共引擎应用图标新建应用时所选择图标2.1.4操作说明2.1.4.1数据建模数据建模提供应用中数据存储的基本服务，可根据业务数据特征快速引用审批、业务流、交易类型、自动编码、档案状态、主组织等系统属性；同时提供基于数据实体的关联及合并查询定义，为综合的数据应用提供基础。2.1.4.1.1资源列表如下图所示，数据建模中包含当前租户、当前领域、当前应用创建的所有实体、查询和枚举类型的数据资源，支持按名称搜索、按类型和编码手动排序、翻页等功能。用户手册9/58实体：环境中的存储应用数据的对象（表），包括应用中自行创建的实体，也包括原厂应用（财务、采购等）的实体，提供数据存储；查询：基于实体或其他查询通过关联过滤等一系列描述返回的数据集合和显示方式；枚举：提供枚举数据供实体中的单选和多选进行引用。2.1.4.1.2新建实体实体功能：a属性设计与维护，包括主属性、业务属性和系统属性，如下图所示：b实体数据关系查看，通过ER图的方式显示，如下图所示。关系图显示当前实体的上一级和下一级实体，没有则不显示；下面的列表显示选中实体的所有属性，提供全屏查看实体属性的功能，属性不可编辑。用户手册10/58c实体的发布、停用和删除。实体发布以后，在页面建模和自动化流程等可以使用实体数据，停用或删除实体后将无法继续使用。新增实体：新增实体有两种方式：直接新增实体、复制已有实体、Excel导入，如下图所示：用户手册11/58方法一：创建新实体时，如下图所示，根据应用构建的需要编辑实体信息，包括主表和属性，系统属性自动生成。1.主表包括实体名称、编码、父实体、描述信息、引用接口等实体名称/编码：必填，不可重复父实体：可选项，下拉选择，可选当前应用已发布的实体名称；描述信息：可选项，对实体进行简要描述用户手册12/58引用接口：可选项，接口包括审批、业务流、交易类型、树型结构等；2.实体的属性：属性编码/名称：可手动修改，首次编辑属性名称时编码会生成对应的拼音字段；属性类型：默认类型为文本，可根据需要进行重新选择；引用：当类型为单选引用时，可选实体范围：平台已发布参照、当前租户已购买应用的参照、协同表单发布的参照、自建应用中发布的参照等；当类型为单选或多选时，可选的枚举范围为：平台已发布枚举和租户自建枚举；表字段名：不可编辑，系统自动生成；标签：可多选，从参照中选择，无默认值，从右侧操作面板中进行操作。3.系统属性：包括基类属性+特性的属性两部分内容，作为系统属性显示在“系统属性”页签，仅查看，不提供编辑和删除功能。如下图所示，系统属性与勾选的引用接口有关，根据选择的接口分成基础可选项、审批、业务流、交易类型等八种，每一种下面包含多个系统属性，可以展开查看。用户手册13/581.唯一性校验：可以设置应用下业务属性的唯一性，同时绑定系统字段。当设置了唯一性规则使用该实体新建数据时，被设置为唯一性字段数据不可以重复，如图所示；1.索引：设置业务属性和系统属性作为实体的联合索引，提升实体的查询效率，如图所示；实体修改完成后，点击保存返回实体列表，如下图所示，此时实体状态为“未发布”，在实体列表中选中当前实体进行发布，状态变为“发布”，发布后的实体可以被页面建模引用，用以创建新的页面。已发布的实体支持修改，修改后状态为“更新”，修改内容需要进行发用户手册14/58布后才会生效。若是该实体后续不再使用可以进行停用操作，停用后无法新建页面但不影响之前创建页面，停用后支持再启用，启用后恢复原有状态。方法二：复制已有实体，如下图所示，选择已发布的实体，在选择的实体的基础上新增实体，适用于新增实体与已发布实体属性具有一定的重复。若复制的实体为主子实体/主子孙实体，则选择复制其主实体后，进入层级结构选择，支持直接复制子实体或复制主子实体或主子孙实体，复制前需要先编辑其实体编码和名称，不可重复，如下图所示：用户手册15/58复制后的实体状态为“未发布态”，开发者可点击“编辑”对复制后的实体进行增删改操作，确认修改完成后进行发布。主实体支持直接发布，子实体发布时提示“该实体存在未发布的父实体xxx，发布时将与其一同发布”，如下图所示：方法3：Excel批量导入。新增实体支持通过下载Excel模板后，根据模板上的格式要求，将实体及其属性信息编辑录入，然后上传至数据建模。详细操作步骤如下图所示：用户手册16/58用户手册17/582.1.4.1.3新建查询数据建模中的查询元数据，供应用构建自身使用，此处的数据显示范围为当前应用创建的查询。查询元数据提供以下功能：查询元数据包括领域预置的内容和租户自定义，因此支持设计器入口；查询元数据使用时在业务仓执行数据；查询元数据能够选择的资源包括实体元数据和其他查询元数据。新增查询，如下图所示，查询元数据支持两种关系类型：关联、合并。用户手册18/58输入名称和编码，选择查询类型，保存后点击设计进入到查询设计器页面，如下图所示：查询设计器页面的左侧按实体、查询分别显示，当前领域已购买的应用的实体和平台的实体，查询数据包括系统预置的及自建的。分别点击两表上面头部部分的方式建立两表之间的关系，默认内连接，提供内连接、左连接及右连接，可修改。根据两个表的数据关联关系，选择对应的关联字段进行关联连接。用户手册19/58过滤条件的设置可以支持多个筛选条件进行数据过滤查询，设置界面如下：数据过滤条件的设置，主要包括以下部分：a、逻辑符：支持与条件和或条件，当有多个条件时按现有的顺序执行；用户手册20/58b、过滤条件的操作符：包含/不包含、等于/不等于、大于/大于等于、小于/小于等于、开始是、结尾是、中间是c、空值规则：空值返回所有数据/空值不返回数据，默认空值返回所有数据；d、值类型：包括常量和参数标签，根据不同类型，对应不同的取值；e、操作：支持增加和删除。新增脚本查询，输入名称、编码、描述，选择类型为sql，设置界面如下：同时支持“编辑”、“发布”、“删除”操作。点击<设计>，进入yonQL脚本编辑页面，通过脚本实现实体表的关联、过滤等查询，并可以“执行”查看结果，以及判断语法是否正确。设置界面如下：用户手册21/58将查询结果反向生成实体，可以编辑实体属性的编码、名称、类型，设置界面如下：可以配置物化任务，包括配置物化表的名称、描述，配置任务的定时时间，启用、停用、删除等操作，设置界面如下：用户手册22/582.1.4.1.4新建枚举当实体的字段类型选择“单选/多选”时，后面的引用字段可编辑，引用枚举页面如下图所示，该页面内显示系统级枚举及租户自定义的枚举。用户手册23/58新建枚举时在数据建模下点击【新建枚举】进入如下图页面，填写新建枚举数据的名称和编码，依次点击<新增>创建多个枚举并修改枚举值，最后保存即可。枚举数据支持二次编辑，保存会将自动同步至给相应的“单选/多选”。2.1.4.2页面建模提供构成应用的功能页面设计器、组合页面设计器、报表设计器，支持不同功能业务页面的构建，同时支持前后端扩展，实现单据页面、业务事件的构建和交互驱动过程的个性化扩展。用户手册24/58打开要创建页面的应用，切换到页面建模页签，会看到页面、参照和打印模板三个页签。页面：用于创建构建应用的各类页面。参照：用于创建自建档案的参照页面。打印：应用内所有需要打印的页面对应的打印模板。2.1.4.2.1单据页面根据创建的页面类型，选择不同的页签的来创建页面，包括单据、分析和第三方页面。点击<新建页面>按钮，弹出创建单据页面的向导，如下图所示：用户手册25/58创建单据页面设计器为单据页面预置了8种样式的模板，同时提供了多种布局容器、数据容器、基础控件和业务控件等组件，支持单表、一主子多、主子孙、左树右表、左树右卡、树型表等多种页面的组装能力。1）预置模板提供列表、单卡、左树右表、左树右卡、树形表、一主多子、主子孙、行编辑表8个常用模板。单据页面，提供两种创建方式：通过预置模板创建，通过空白页面创建。下面简单介绍下预置模板的使用场景：列表：通常用于配置一个节点的浏览页面，用于展现业务数据的全貌，比如销售订单的列表。用户手册26/58单卡：通常用于配置一个节点的编辑页面，用于录入业务数据，比如品牌的卡片。一主多子：由列表和卡片两个页面组成，区别于单卡，多子会根据子表的个数自动按页签来创建多个子表。比如销售订单的卡片页面。用户手册27/58列表页面支持单主列表及主子列表的选择，既新版本的一主多子模板既支持原来的单主列表，也支持主子列表。主子孙：由列表和卡片两个页面组成，区别于一主多子，主子孙会在子表增加一个对孙表的触发，用于录入或显示某行对应的孙表数据。比如生产订单的卡片页面。列表页面支持单主列表及主子列表的选择，既新版本的主子孙模板既支持原来的单主列表，也支持主子列表。用户手册28/58左树右卡：一个左边是树右边是卡片的页面，用于构建数据本身有层级关系的页面。比如部门树。左树右表：由左树右表页面和卡片页面组成。左树右表页面的列表是一个浏览态的列表，与单列表的作用相同，卡片页面是一个编辑态的页面，用于数据的维护。比如员工档案。树形表：是树形列表，由树形表页面和卡片页面组成。对应的实体是一个树结构。用户手册29/58行编辑表：一个可批量编辑的列表页面。常用于字段数量不多的公共档案的维护。2）创建页面创建页面时，会根据选择模板的不同给出不同的引导，比如创建左树右表页面时，会给出下面的引导页面，输入相关的内容后即可生成需要的页面。用户手册30/58比如上图创建一个左树右表的页面，需要以下构成元素：页面名称：当前页面的名称；树：构成左树的元数据；在数据建模页签已创建并发布的，树结构的实体元数据；表：构成右表的元数据；在数据建模页签已创建并发布的实体元数据；关联关系：左树和右表两个实体之间的关系字段；生成单卡页面：默认勾选，在生成左树右表页面的同时，生成右表的卡面页面用于维护右表的数据；同时生成参照：是否需要同时生成左树右表的参照。页面生成完成后，会显示在页面建模页面。如下图所示：用户手册31/583）单据设计器对于已生成的页面，选中后可打开单据设计器进行编辑。下面以生成的一主多子的卡片页面如下图所示：模板由三个区域构成：组件区、设计区和属性区。组件区：提供构成页面的元素，包括布局容器、数据容器、工具栏、按钮控件、基础控件、业务控件、协作控件等。用户手册32/58设计区：页面的设计区域。包括卡片头部按钮区、卡片底部按钮区、数据显示区域等，根据需要来设计。属性区：选中的页面元素的属性设置区域。4）布局和组件布局容器：构成页面布局的元素，系统提供了网格、模态框、卡片组、卡片、多页签、子页签、锚点容器七种布局容器，容器支持样式包括大小和位置，背景图边框颜色等属性设置；通过在布局容器中拖入数据容器或组件控件来实现单据页面的组装。数据容器：装载页面数据的容器，根据数据展现的样式及用途又分为：表单、表格、树型表格、查询区、搜索树和穿梭框。用户手册33/58工具栏：定义单据页面中的操作按钮区域及按钮区域的样式。按钮控件：定义页面中按钮区域的按钮，包括草稿、模板、按钮和下拉按钮四个控件，可定义按钮类型、规格类型及单击按钮的动作，包括新增、编辑、删除、提交、撤回、启用、停用等。草稿和模板需要与页面上的保存为草稿和保存为模板配合使用，页面需要时可进行配置。用户手册34/58基础控件：构成单据页面的基础控件，包括文本框、多行文本、富文本、多语文本、手机、电话、邮箱、证件号、数值、选项、开关、日期框、日期时间、时间框、评分、地图定位、图片上传、静态图片、超链接等。用户手册35/58业务控件：定义单据页面中需要的业务类控件，包括附件管理、单选参照、自动编码、业务流按钮、描述信息、多选参照、主子切换、页面、统计图、甘特图、打印模板、复合列、关键信息区、使用说明等。用户手册36/58协作控件：与协作套件相关的控件，包括协作套件和沟通套件。其他：包括自定义控件，即用户可通过关联扩展组件或配置关联属性的方式来定义系统中不存在的控件使用。5）控件的属性下面以单选参照为例，说明一下控件的属性：属性区显示的内容是设计区的所属部门这个字段的属性，它是一个单选参照，可以将其他档案比如部门，发布为一个参照供其他单据使用。用户手册37/58单选参照有与其他控件一样的公共的属性，比如关联数据源、字段、字段别名、字段名称、是否显示、允许为空、允许修改、不允许复制、默认值、布局占比、允许导出外，还有这个控件本身的属性，比如：只选择末级：树参照的属性，可配置是否只能选择末级的数据；设置后在运行态，树参照只能取到末级节点的数据；默认展开级次：树参照的属性，设置打开树参照时，默认展开至几级；模糊匹配：设置参照是否允许模糊匹配；联想匹配：设置参照是否允许联想匹配；展现方式：设置参照的展现方式，下拉或者弹窗，默认弹窗；参照设置：配置元数据时，参照选择的是实体元数据，但一个实体元数据可以发布为多种样式的参照，通过参照配置可以选择不同样式的参照、配置参照带入字段及配置参照过滤；用户手册38/58参照带入：作为参照的档案会有很多个不同的字段，如果在当前单据上想显示参照档案中的其他字段时，可以通过配置参照带入来实现。参照带入的第一个字段是选择带入的参照列表中的哪个字段，第二个值是带入到当前单据的哪个字段上，这个字段可以是一个元数据字段，也可以是一个非元数据字段。参照过滤：当前单据在使用参照数据时，有可能只需要使用一部分数据，那可通过参照过滤来配置过滤条件，运行态仅显示符合条件的数据。6）页面规则系统提供了页面规则，包括交互规则和校验规则，供配置页面时使用。交互规则：用于配置当页面初始化时，或值发生改变时，或者页面状态发生变化时，改变控件的属性，包括显示隐藏、必填项、可编辑、赋值、数值精度、明细子表的数值列是否合计等。支持配置前置条件，当符合某些条件时，发生上述改变。用户手册39/58校验规则：用于配置当页面符合一定条件时，不能保存或给出相应的提示。提示的内容是可以配置的。创建分析页面分析页面分为分析、报表、分析卡片和已有页面引用，可以直接从这个入口创建智能分析页面，也可以引用在智能分析中制作好的页面。用户手册40/58选择好分析页面类型，下一步就是数据模型的绑定，数据模型的范围是应用构建平台的数据实体和查询。选择了数据模型进入到的智能分析制作页面将会自动添加该数据实体/查询做为数据模型，可以基于此模型直接创建分析图表也可以在此基础上添加数据模型联合创建分析图表，智能分析图表的创建详见数据智能服务章节。创建第三方页面可以在应用中引入第三方的链接页面。通过URL直接引用即可。用户手册41/582.1.4.2.2参照页面创建的档案信息需要发布为参照后才能被其他单据页面使用。页面建模提供了创建和发布参照的入口。页面建模页签，切换到参照页面，可以看到如下页面：点击〖新建参照〗按钮，弹出创建参照页面的向导，如下图所示：用户手册42/58参照也同样预置了常用的参照模板：表参照、树参照、树表参照、穿梭表参照，以适应不同的使用场景。2.1.4.2.3打印模板请参考打印模板的相关文档。2.1.4.3流程&自动化包括工作流、业务流、机器人和函数的设置。2.1.4.3.1工作流应用构建的工作流，为当前应用的引用了审批的业务单据创建流程的审批服务，提供流程模型的新增、编辑、删除、设计、启用等功能。详见数字化建模-流程管理-模型管理章节。用户手册43/582.1.4.3.2业务流应用构建的业务流，把各种类型的能力、服务、APP组装编排起来,通过数智驱动来保障企业或组织的业务目标或价值目标的实现。为应用和其他应用的业务单据创建数据流转服务，提供流程的管理和日志功能，详见数字化建模-流程管理-业务流章节。流程设计器页面分为左中右结构，可设置拉单、推单、回写等功能。用户手册44/582.1.4.3.3机器人全面集成智多星RPA机器人，集模板的创建、机器人的创建和部署于一体，机器人可以在流程、定时调度任务启动运行,帮助自动完成重复耗时的任务,提高工作效率。要能使用该模块，须购买智多星RPA机器人服务。创建机器人：支持全新创建和引用已有的机器人。创建过程分为5个步骤：基本信息—>选择模板—>设置变量—>数据集-部署。用户手册45/58基本信息：填写机器人名称和调用方式。选择模板：选择机器人模板，可以选择制作好的各领域的模板。用户手册46/58变量设置：设置模板中用到的变量值。用户手册47/58数据集：下载和上传模板中用到的数据集。用户手册48/58部署：选择机器人运行的客户端环境，该环境需安装RPA客户端。用户手册49/58调用机器人：目前提供在流程中和调度任务中调用机器人。流程中调用：流程环节中增加机器人环节，设置环节的名称并选择要调用的机器人。设置后在流程流转到该机器人环节时就会启动任务的执行。用户手册50/58调度任务：为机器人设置调度任务信息（定时规则、消息设置），设置成功后会按时启动调度任务去执行。部署机器人：选择机器人运行的客户端环境，该环境需安装RPA客户端，可多选，可查看部署详情。用户手册51/58函数基于应用构建平台的脚本引擎，支持用户完成自定义逻辑的脚本编写；类型分为前端脚本和后端脚本，无论前端还是后端脚本都是以JS为语言规范，其中操作元数据是以平台提供的YonSQL对数据进行操作，YonSQL支持SQL95标准规范与绝大部分SQL编写方式。前端脚本：可用于控件状态控制、控件赋值、简单数据计算、openAPI调用；后端脚本：可用于后端数据计算、业务调用、数据实体赋值、openAPI调用；用户手册52/58函数应用：在单据页面、画布页面、流程（工作流、业务流）、表达式、变量、及作为通用函数使用，有以下三种使用场景：1、在应用构建中支持MDF扩展，有独立的函数资源管理，在单据页面设计器页面中调用；2、在具体的设计器中嵌入使用，没有独立的函数资源管理，在画布页面设计器、工作流设计器、业务流设计器中使用，由各设计器自行管理脚本，统一存储和调用执行；用户手册53/583、作为通用扩展能力在支持在环境中支持扩展脚本能力，有独立的函数资源管理，表达式、变量、通用函数；脚本开发支持版本控制。版本控制包括编辑版本和启用版本。编辑版本记录用户脚本开发的过程，并支持还原到之前版本。启用版本可以切换当前可以被调用的脚本。2.1.4.4集成配置通过集成配置可以订阅API和发布API2.1.4.4.1API订阅API订阅提供订阅原厂公共API、服务商API和私有API的能力，通过订阅API，应用就可以用户手册54/58获得相关API的使用权限，并通过脚本和后端服务调用相关接口2.1.4.4.2API发布API发布模块提供了将后端脚本发布成私有API的能力，具体操作过程参照开放平台API发布的帮助文档2.1.4.5应用管理应用管理提供应用的基本信息的维护，以及对外发布的服务和菜单的管理。用户手册55/58同时支持web/移动的应用发布。2.1.4.5.1创建菜单结构添加分组列表。2.1.4.5.2添加页面服务在分组列表下添加页面服务。用户手册56/582.1.4.5.3发布应用可同时发布到工作台和友空间，应用主页支持按菜单结构默认生成和指定页面的方式。支持应用服务的发布，发布后可被系统其它模块当做服务调用。2.2脚本服务2.2.1功能描述用户手册57/58作为租户级脚本调用，有独立的脚本资源管理，只支持后端函数，可以被调度任务定时调用。2.2.2操作说明进入应用构建服务->脚本服务，直接进行脚本开发。使用方式参照应用构建的函数设计器。
