YonBIPV3.0(R5_2312_1)旗舰版云平台篇-数字化建模-消息平台用友网络科技股份有限公司2024年1月用户手册1/32版权©2024用友集团版权所有。未经用友集团的书面许可,本用户手册任何整体或部分的内容不得被复制、复印、翻译或缩减以用于任何目的。本用户手册的内容在未经通知的情形下可能会发生改变,敬请留意。请注意:本用户手册的内容并不代表用友网络所做的承诺。用户手册2/32目录第一章总体概述................................................................................................................................................41.1产品概述................................................................................................................................................41.2应用价值................................................................................................................................................4第二章应用场景................................................................................................................................................52.1分级管控业务.......................................................................................................................................52.2模板全球化应用..................................................................................................................................52.3业务事件类消息设置和接收...........................................................................................................52.4业务动作类消息设置和接收...........................................................................................................52.5业务流程类消息设置和接收...........................................................................................................62.6预警类消息设置和接收....................................................................................................................6第三章操作指南................................................................................................................................................63.1消息模板................................................................................................................................................63.1.1功能描述............................................................................................................63.1.2业务规则............................................................................................................73.1.3栏目说明.........................................................................................................133.1.4操作说明.........................................................................................................143.2模板全球化.........................................................................................................................................173.2.1功能描述.........................................................................................................173.2.2业务规则.........................................................................................................183.2.3操作说明.........................................................................................................18用户手册3/323.3消息通道.............................................................................................................................................193.3.1功能描述.........................................................................................................193.3.2栏目说明.........................................................................................................193.3.3操作说明.........................................................................................................193.4业务消息配置....................................................................................................................................233.4.1功能描述.........................................................................................................233.4.2业务规则.........................................................................................................233.4.3栏目说明.........................................................................................................253.4.4操作说明.........................................................................................................263.5消息发送策略....................................................................................................................................283.5.1功能描述.........................................................................................................283.5.2业务规则.........................................................................................................293.5.3栏目说明.........................................................................................................293.5.4操作说明.........................................................................................................29第四章初始准备.............................................................................................................................................31用户手册4/32第一章总体概述1.1产品概述消息平台提供全面的业务消息触达服务,消息平台提供友空间、短信、邮件三个消息通道,可按业务动作、业务事件、预警、流程四种消息类型为每个通道设置消息模板,进行消息发送设置。企业可根据需要决定本企业在应用时哪些业务需要采用哪些消息通道以何种格式和内容将消息发送到消息接收人。通过消息平台,企业可以实现基于业务的按需消息触达,实现消息驱动的业务。业务消息配置聚合不同消息通道:友空间、邮件、短信;支持多消息类型:待办、通知、预警;覆盖多消息来源:预警、流程、业务事件和业务动作。消息触发支持运行态动态配置业务动作发送消息。消息接收人可取自业务数据集(例如采购订单的业务员)、系统用户角色及扩展的用户组,触发条件支持动态配置业务消息触发条件。流程消息触发与流程融合,预警消息触发与预警融合,业务事件消息触发与业务事件(调度任务或前台直接选择触发)。消息的触发完全融入业务场景。1.2应用价值聚合不同消息通道,统一通道配置:友空间、邮件、短信接入各种消息来源:预警、流程、业务事件和业务动作提供富文本的消息模版编辑器,支持企业自定义不同通道的消息模版支持消息模板分配到组织支持企业自定义消息发送条件、接收人、消息通道和相应模板支持待办、通知、预警消息类型,统一消息发送接口提供统一的消息安全控制策略支持多种消息发送策略:批量、过滤、即时/延时消息的统一存储,支持对历史消息的查询支持消息驱动业务,支撑EDA架构用户手册5/32第二章应用场景2.1分级管控业务在人力业务场景中,集团公司的人力需要为分公司和子公司创建模板,所以不需要通过切换账号就能进行模板的创建和修改。通过将分公司的权限给集团公司的人力,由集团公司人力统一设置各组织的模板。在使用时子公司A不想设置模板,直接使用集团公司模板则可以直接共享使用集团公司模板。2.2模板全球化应用跨国公司在做消息发送时能够按照本国内的语言和国外的语言设置模板体,通过设置的模板不同能够对不同国家的人员发送不同的消息。如在中国的公司需要对台湾的子公司发送人力通知,则需要在国内的模板上设置中文和繁体中文的模板,台湾在接受到消息时的首选语言为繁体,则接受到的消息也为繁体。2.3业务事件类消息设置和接收业务事件消息,是企业预知的业务行为发送给固定的人员。例如生日祝福只要事件发生就给员工发送生日祝福消息。这类消息在企业中需要根据自己企业的特点来制作个性化的消息模板,需要消息平台提供模板和消息触达能力。这类消息的触发一种是通过调度任务,将调度产生的结果也通知相应的业务员或者用户,一种是通过业务交互界面由用户确定选择模板发送。策略是开发态预置好业务实践的消息接收人、消息通道、发送策略;运行态企业根据企业自身情况设置模板。通过调度任务或界面交互触发消息推送2.4业务动作类消息设置和接收用户手册6/32业务动作按照不同的动作类型为各个领域提供模板,通过区分动作类型设置不同模板给不同的组织或者个人。因为业务是按组织运行的,所以不同的组织需要按不同的模板发送。例如当采购订单审核后通知收货人,以便做好收货准备,还要通知供应商可以发货了。策略是开发态预制可能发消息的业务动作,运行态根据需要设置消息模板、消息发送条件、发送通道、发送语种。2.5业务流程类消息设置和接收业务流程消息,是审批流各环节消息的设置和接收。在审批流各环节配置好消息模板,当环节动作结束时,审批流会自动调用消息平台接口,发送消息给指定的接收人。消息的接收人由流程系统指定。流程系统默认预制了17种消息模板。用户也可以增加自己的消息模板,在流程设计器选择自己的消息模板即可使用。策略是开发态预置系统消息模板;运行态根据需要设置消息模板、发送通道、发送语种。2.6预警类消息设置和接收预警消息,是预警平台产生消息的设置和接收。在消息平台设置好预警消息模板,在预警平台选择设置好的预警消息模板,并设置好消息接受人。预警任务触发预警产生的预警信息,按预制好的预警模板发送给预警任务设置好的消息接收人。策略是开发态预置系统预警消息模板;运行态根据需要设置消息模板、发送通道、发送语种。第三章操作指南3.1消息模板3.1.1功能描述消息模板用于定义系统发送的各种消息的展现样式,包括消息标题和消息内容。用户手册7/32系统支持四种消息类型:业务动作、预警、业务流程、业务事件,并提供系统消息模板,企业也可根据需要设置自己的模板,支持组织级及交易类型级消息模板。需要跟当前的实体的内容关联,所以需要考虑支持元数据,并能支持关联的业务变量和系统变量。1.支持按照元数据/系统变量/业务变量的消息模板定义2.系统消息模板类型注册与配套的配置,适应多种消息通道要求3.提供统一的消息开发框架,保障复用性、可靠性和扩展性4.支持消息模板设计和统一管理,支持同一业务消息的消息模板可区分消息模板类型分别设置5.支持企业级账号、组织、交易类型模板的新增、删除、编辑6.支持复制功能7.须预置默认模板8.支持消息模板能够按照领域-应用-业务对象(表单)的结构呈现9.消息模板支持国家地区属性3.1.2业务规则业务事件消息模板业务事件消息模板主要是为HR的业务事件发送消息所用。系统已为业务事件预置了系统消息模板,用户需要将系统消息模板复制到企业账号(租户)下并根据企业实际需要设置模板,用户可以设置组织级消息模板,把系统模板或租户级消息模板添加或复制给组织,即成为组织级消息模板。系统级消息模板和租户级消息模板在默认页签下展现,如果当前所属组织是某组织,默认页签下显示该组织的消息模板。无论所属组织是当前租户还是具体组织,默认页签显示的都是非交易类型级消息模板(业务事件不支持交易类型级模板,业务动作和业务流程支持交易类型级模板)(1)消息模板新建消息模板,用户可以完全自定义新建。租户级、组织级和交易类型级都可以新建模板。点击新建按钮创建消息模板用户手册8/32(2)消息模板添加如果所属组织选中某组织,消息模板可以通过添加功能复制消息模板到该组织下(3)从系统消息模板复制用户手册9/32可以复制给组织或交易类型,业务事件不支持交易类型。如果不选择组织,默认复制给该租户。注意:添加和复制按钮,实际上都是从系统或租户级模板选择一个模板进行拷贝,不同的是,添加按钮是从系统级或租户级模板中选择一个模板拷贝到当前组织或交易类型下。复制是把当前模板拷贝给组织或交易类型用户手册10/32(4)复制到企业账号下后,按企业实际需要修改模板,注意,一个消息模板类型可设置多个消息模板,以备不同组织需要。可为每种消息模板类型设置企业账号级默认模板。(5)消息模板设置默认模板每种模板类型下可以设置一个默认消息模板。系统模板不能设置为默认模板。用户手册11/32注意:业务事件消息或是通过调度任务或界面交互触发消息推送的,系统匹配消息模板时,首先匹配当前组织的模板,如果匹配不到则匹配企业账号级的默认模板,如果再匹配不到则匹配系统模板。业务动作消息模板业务动作消息模板主要是为采购和财务业务发送消息所用。系统已为业务动作预置了系统消息模板,用户需要将系统消息模板复制到企业账号下并根据企业实际需要设置模板。业务动作支持组织级和交易类型级模板注意:业务动作是按每个动作、条件、接收人发送消息的,所以,如果不同的业务动作要发送的消息内容不同,则需要设置多个模板,例如:采购订单的保存动作发送给业务主管和业务员要用不同的模板;采购订单又是按采购组织进行的业务,每个采购组织发送的内容也不一样,这就需要为每个组织设置不同模板。但是:不需要将模板分配到组织。组织级模板或交易类型级模板可以通过添加或者复制按钮拷贝消息模板注意:业务动作消息在设置租户级消息模板以后,还需要进行业务消息设置:消息发送条件、发送通道、发送内容(模板),才能将消息发送给接收人。预警消息模板预警消息模板是为预警消息所用。系统已为预警消息预置了系统消息模板,用户需要将系统消息模板复制到企业账号下并根据企业实际需要设置模板。用户手册12/32预警消息模板不需要分配到组织。注意,预警消息类型由于是运行态可动态增加的,所以,针对动态增加的预警类型,务必要设置相关的消息模板。如下图动态增加的预警类型没有系统消息模板,需要手工设置。注意:预警消息是在预警任务中配置的,预警任务中选择了消息模板才能发送相应的内容。业务流程消息模板流程消息模板主要为流程的各种场景所用,系统为各种场景预置了通用的系统消息模板和预置流程的消息模板:注意:通用的和各领域流程都包含一下场景:待办、抄送、审批撤回、审批结束、驳回到制单人、驳回终止、驳回抄送、超时前预警、超时提醒、超时自动完成、超时自动终止、前加签提醒。用户手册13/32由于流程类型可在运行态动态增加,则消息模板需要为新流程设置消息模板,如果不设置,系统自动匹配通用消息模板。注意:流程消息是在流程模型中配置的,流程模型中选择了消息模板才能发送相应的内容。3.1.3栏目说明栏目名称说明消息编码和消息名称新增某一个模板分类下的模板时,模板编码需要手工输入,多个通道的模板编码是相同的消息通道同一个消息模板不同的通道:消息中心、邮件、短信可设置不同的消息模板。不设模板的通道不会发送消息消息标题/短信签名消息标题将出现在:邮件和消息中心消息标题中,短信签名出现在短信最前面;消息标题可以是业务变量/系统变量/元数据内容消息内容消息内容支持富文本,可以是常量、业务变量/系统变量/元数据的组合;元数据是和消息内容相关的;消息模板所属的模板分类不同,可以应用的变量也可能不同,有些模板可以应用系统变量、元数据设置消息内容,有些可以应用系统变量、业务变量设置消息内容消息内容-元数据当前业务实体对应的所有字段变量消息内同-系统变量系统预置的数据或客户端信息,比如系统日期、系统时间消息内容-业务变量系统预置的与业务实体有业务相关性的扩展变量、未能包含在元数据中的变量用户手册14/323.1.4操作说明在消息模板节点可以按照不同消息类型下不同领域的消息模板类型定制消息模板,在模板中配送消息的内容和格式。编辑消息模板步骤1:按下图领域分类属性结构①②③步骤选择分类(例如业务动作)→领域(例如采购供应)→消息模板分类中选定一个模板分类(例如调价单审核),点击“复制”按钮或“+”直接新增,输入模板名称、模板描述,注意模板编码是系统自动生成的。步骤2:如果是复制的则选择已复制出来的消息模板,进入消息模板的编辑界面。如果是新增的则直接进入消息模板编辑界面,输入模板名称、模板描述,注意模板编码是系统自动生成的。点击“编辑”对复制出来的相应通道的消息模板进行编辑:用户手册15/32进入某通道的消息模板内容设置界面,可将鼠标焦点放在右边内容区要插入内容的位置,然后双击左边的元数据等变量,变量会自动嵌入到右边当前位置。注意:消息标题支持变量。设置号后按下“确定”按钮返回主编辑界面。注意:如果是短信消息,则要输入审核过的短信签名,否则短信无法发送。用户手册16/32步骤3:返回主编辑界面,如果还需要设置其他通道内容,则按下“新增”按钮。全部完成后点击“保存”,即完成消息模板设置。注意:如果点击“取消”,则不会保留刚才为每个消息通道设置的模板。消息模板管理业务事件消息模板可分配到组织,支持设置企业账号级的默认消息模板,支持消息模板的删除、停用、启用。注意:消息模板的删除系统不会做任何校验,所以务必确保要删除的消息模板未被引用设置,建议通过停用消息模板,确保已引用设置不出错,新引用不再被引用到停用的模板。用户手册17/321.预览:能够在不进入编辑页面就预览模板。1.编辑:点击编辑页面进入编辑页面对消息体进行编辑。2.复制:复制时按照当前表单复制,复制时消息类型不能修改,消息名称不能重复。3.设为默认:同类型的模板只能有一个默认,点击默认后悔打默认标签。默认的模板在发送消息时为默认选择的模板。3.2模板全球化3.2.1功能描述用户手册18/32全球化是指针对不同的国家所发送的消息不同,所设置的模板语言也不同。在中文国家设置的主体语言为中文,模板也为中文,但为其他国家如英文为主的国家则需要设置英文模板,接收方接收到的语言也为英文。3.2.2业务规则支持在企业账号级设置当前国家的语言和其他国家的语言,目前支持中文、英文、繁体的模板设置支持使用者在首选语言确定后选择自己的首选语言设置模板3.2.3操作说明1.在我的>我的首选里选择我的语言,默认登录后按照租户购买的语种设置,这里假设默认语言为中文。2.选择语言为英文后,整个UI模板的界面变为英文,所设置的模板也变为英文。3.在使用的消息体里看到的表单也为英文模板。用户手册19/323.3消息通道3.3.1功能描述系统支持消息中心、短信、邮件、微信、企业微信等5种信息发送方式,其中短信、邮件、企业微信的方式需要通过企业账号管理员登录系统,进入消息通道进行行相关配置。短信还需要进入APIlink进行短信签名设置。消息中心通道无须配置。微信通道只支持协同、采购云系统预置的微信服务号,无需配置。3.3.2栏目说明名称说明通道类型通道类型包括了短信、邮箱、企业微信3.3.3操作说明短信通道如果企业需要发送短信消息,则需要购买短信包并充值到企业账号的系统应用下,并设置企业短信签名。进入消息通道功能,选择短信页签,点击“如何在线充值”按步骤进行行相关配置。用户手册20/32注意:在APIlink配置短信签名后需要等待平台审核,以确保无敏感违规词汇,审核通过后才可发送短信。邮箱通道配置即配置邮件消息从哪个邮件服务器的哪个邮箱发送;设置后在未保存前向一个真实接收邮箱测试发送测试邮件以确保发件邮箱的正确性。一般来说SMTP地址是域名(mail.yonyou.com)具体地址由DNS解析。系统也支持SMTP邮箱地址是IP地址,但不建议设为IP地址(比如外网无法识别内网IP地址),只在局域网内收发邮件时可以设置。企业邮箱可以在线编辑,编辑具体如下所示:|主要栏目信息|说明||配置名称|邮箱服务器的配置名称,作为邮件的发件人名称||—|—|用户手册21/32|邮箱发送SMTP服务器|外网发件地址的配置,遵循URI地址协议名.服务器地址,例如:“smtp@126.com”;如果是局域网支持IP地址,如“192.168.1.1”||邮件发送服务器SMTP端口号|发件端口的配置,默认25|||||发送人邮箱的账号|发件邮箱的账户名,例如sample@126.com||发送人邮箱的密码/授权码邮箱|发件邮箱的账户密码/授权码||邮箱自定义参数|示例:{“mail.smtp.ssl.protocols”:”TLSv1.2”,”mail.smtp.starttls.enable”:“true”}||测试邮箱|发送测试邮件可及时验证邮件发送服务器是否失效|企业微信通道配置即配置企业微信消息通道;消息平台的企业微信属于一个普通通道,接入完毕后会发送企业微信卡片消息。消息通道配置企业微信通道,目前来源为集成认证中心的企业微信账号集成认证中心”配置企业微信用户手册22/32用户绑定用户用企业微信扫描需要开通的账号二维码进行yht绑定,本过程可以后续随时做消息通道添加企业微信通道用户手册23/323.4业务消息配置3.4.1功能描述业务消息配置是为业务事件类消息发送的通知配置消息模板、发送方式,配置接收人等,根据不同的业务单据配置业务消息。业务动作在消息平台配置并选择消息模板,预警在预警平台跟随预警的配置选择消息模板、流程在流程平台跟随流程配置选择消息模板。业务事件是开发态预置的,在运行态由业务操作时选择模板(例如HR在相应的业务操作界面手工选择模板)。3.4.2业务规则设置消息接收人,接收人的来源;单据上的人员;直接选用户、角色、组织部门(组织部门下的人员);按规则选人,规则是系统预置的,与单据相关的人员,例如采购订单的需求组织负责人、仓库负责人等。用户手册24/32设置消息发送通道,必须设置,可同时选择多种通道:消息中心:发送通知类消息(不是预警和待办);邮件;短信:短信未充值不会发送,未设置短信签名则不会发送注意:如果选择了多个通道,但是选择的模板未包含此通道,则消息不会从没有设置模板的通道发送。发送条件,可以不设;如果设置则达到条件时才发送,不设则动作发生即发送消息;可设置多个条件,可以设置条件为同时满足或满足其一。用户手册25/323.4.3栏目说明栏目名称说明消息名称新增某一个消息时,名称要手工输入,可以为一个类型的相同动作设置不同的消息,例如同样是采购订单审核动作,当金额大于10万时要发送给领导,否则只通知仓库和需求部门,发送的消息模板也不一样消息动作当动作发生时发送通知配置类型不同的单据类型消息接收人单据上的人员例如制单员、业务员;或直接选人例如某用户、角色、组织部门下的人员;或按规则选人,规则是预置的,例如采购订单的需求部门负责人;友空间通知接收人是友户通用户;短信是友户通用户手机号;邮箱是友户通用户邮箱消息发送通道消息发送通道的选择:消息中心、短信、邮件,以及消息模板;消息发送条件当前单据所包含字段的条件范围,可以设多个用户手册26/323.4.4操作说明创建业务消息选择领域→应用→单据类型(例如采购订单),点击<+>按钮,新增业务配置。按①②③步骤输入消息名称、触发动作、消息接收人。消息接收人可直接选择单据上人员,也可添加跟多人员选择用户手册27/32选择消息发送通道,可多选选择消息发送条件,此步骤不是必须的,不设表示无条件发送。注意包含以下“任意条件”表示多行条件满足一个即发送通知消息,含以下“全部条件”表示多行条件同时满足才发送通知消息。按①②步骤输入多个条件即可。用户手册28/32全部信息设置完毕后,点击左下<保存>按钮,消息设置完毕。业务消息管理已设置好的业务消息可以删除、停用、启用。3.5消息发送策略3.5.1功能描述用户手册29/32消息发送策略是指能够批量的设置通道及发送次数和时间的规则,通过设置不同的规则可以在不同的时间点批量发送消息。消息策略生效后,默认在业务消息配置里的设置同样生效,策略只是对业务消息的增强。需要支持发几次,发送间隔,比如抽专家,专家不回复隔1小时通知一次,连续发3次,不回复就换专家——该场景需要业务事件来解决,需要支持配置次数、间隔等。3.5.2业务规则招投标专家抽取,抽取后自动发消息给专家,内容是邀请消息;专家不回复则每1小时发一次,连续发3次消息,消息内容是提醒回复;按消息分类/领域选择消息类型设置发送的通道/次数/时间;能够设置策略的启用/停用。3.5.3栏目说明栏目名称说明消息类型消息模版的类型消息所属领域能够按照领域区分消息消息分类可以区分消息是事件/动作/预警/业务流程消息所属组织默认为企业账号消息通道可以设置的消息通道,包括友空间/短信/邮箱发送次数可以设置发送的次数,每天最多三次发送频率消息能发送的频率,按照一个起始时间发送是否启用设置策略是否启用3.5.4操作说明消息发送策略能够设置必须要有相应的模版和接口支持,已经设置好的模版类型能够设置发送策略。步骤如下:1.打开消息发送策略,选择消息分类和所属领域,如下所示:用户手册30/321.可以在当前页面的列表里设置启用/停用,如下所示:1.点击一行模版类型的<编辑>按钮,弹出设置策略的编辑框,如下所示:用户手册31/321.设置允许消息发送通道,如果选择了邮件通道,支持收件人是否显示。选择消息发送机制,支持按动作发生时间或固定时间发送消息。如果选择按固定时间发送,要设置消息发送的开始时间、发送的次数、每隔多久生效。注意:消息策略生成是按照天来生成,策略支持每天都会按照规则执行,一旦有消息并且启用次规则就会生效。第四章初始准备需要创建领域的组织、用户需要创建业务对象及表单类型业务元数据需要对消息平台的消息模板、消息通道、消息通道配置节点进行授权需要对使用预警任务的预警类型和预警任务节点进行授权