ApusicESB_v6.0_参数配置

1、ApusicESB v6.0 参数配置参数配置深圳市金蝶中间件有限公司2021 年 12 月时间作者版本修改描述I目目 录录前言前言 .1阅读对象阅读对象.11服务器服务器.21.1MBEAN参数.21.1.1 BPMService.21.1.2 ESBScheduler .21.1.3 ESBDataSource.31.1.4 ESBTrigger .31.1.5 ESBClientConnector.31.1.6 ESBServerConnector .41.1.7 ESBServerRequestProcessorManager .41.1.8 ESBServer.51.1.9 BDA

2、.61.2SERVERLIFECYCLE.XML 参数.61.2.1 com.apusic.esb.ESBCommonLifeCycleListener .61.2.2 com.apusic.esb.ESBServerLifeCycleListener .71.2.3 com.apusic.esb.uddi.deploy.ESBUDDIModuleLifeCycleListener.71.2.4 com.apusic.esb.ws.deploy.ESBWebServiceModuleLifeCycleListener.71.2.5 com.apusic.esb.ws.ESBWSLifeCycl

3、eListener.81.2.6 com.apusic.esb.schedule.ESBSchedulerLifeCycleListener .81.2.7 com.apusic.esb.bpm.schedule.ErrorProcessScannerLifeCycleListener .82客户端客户端.92.1MBEAN参数.92.1.1 ESBClient .9IIII2.1.2 ESBClientConnector.102.1.3 ESBClientRequestProcessorManager.112.1.4 ESBDataSource.112.1.5 ESBTrigger .122

4、.2SERVERLIFECYCLE.XML 参数.122.2.1 com.apusic.esb.ESBCommonLifeCycleListener .122.2.2 com.apusic.esb.ESBClientLifeCycleListener.122.2.3 com.apusic.esb.ws.deploy.ESBWebServiceModuleLifeCycleListener.132.2.4 com.apusic.esb.ws.ESBWSLifeCycleListener.13第 1 页前言前言本文描述了 ESB 的配置参数，实施时大部分参数无需修改，采用默认值即可。本文假定 ES

5、B 服务器的安装目录是%Server_Install_Dir%，ESB 客户端的安装目录是%Client_Install_Dir%。阅读对象阅读对象ESB 实施人员与开发人员第 2 页1 服务器服务器1.1 MBean 参数参数1.1.1 BPMService1.1.1.1 主要功能主要功能提供 ESB 内置的流程服务。1.1.1.2 属性属性1) WorkSpace：指明流程定义文件的存储目录，相对于 ESB 服务器的安装目录。出厂配置值是 bpm，即流程定义文件存储在%Server_Install_Dir%/bpm 目录下。2) UseSingleton：指明一条流程定义在某一时刻是否只能

6、有一个流程实例处于正在运行时或挂起状态（因异常而挂起） 。出厂配置值是 true，即不允许一条流程有两个或两个以上的流程实例处于运行时或挂起状态。3) NeedSendMailException：当流程运行过程中出现异常时，是否发邮件通知相关人员。关于如何设置邮箱地址，请参见TODO 。出厂配置值是false，即流程运行出错，不发送邮件通知信息。1.1.2 ESBScheduler1.1.2.1 主要功能主要功能提供 ESB 调度服务。1.1.2.2 属性属性1) Workspace：指明调度定义文件的存储目录，相对于 ESB 服务器的安装目录。出厂配置值是 schedule，即调度定义文件存

7、储在%Server_Install_Dir%/schedule 目录下。第 3 页1.1.3 ESBDataSource1.1.3.1 主要功能主要功能提供 ESB 数据源管理服务。1.1.3.2 属性属性1) DriverPath：指明数据源定义所需的 Jar 包存储目录，相对于 ESB 服务器的安装目录。出厂配置值是 driver。1.1.4 ESBTrigger1.1.4.1 主要功能主要功能提供 ESB 数据库触发器服务。1.1.4.2 属性属性1) Workspace：指明触发器定义文件的存储目录，相对于 ESB 服务器的安装目录。出厂配置值是 trigger，即触发器定义文件存储在

8、%Server_Install_Dir%/trigger 目录下。1.1.5 ESBClientConnector1.1.5.1 主要功能主要功能提供 ESB 逻辑客户端（消息被动接收端）的队列定义。1.1.5.2 属性属性1) AdminRequestQueueName：接收管理类型请求信息的本地队列名。缺省为 ESBClientAdminRequestQueue。2) AdminReplyQueueName：管理类型应答信息的本地队列名。出厂配置值为 ESBClientAdminReplyQueue。3) DataRequestQueueName：接收业务数据操作类型的请求信息的本地队列名

9、。出厂配置值为 ESBClientDataRequestQueue。第 4 页4) DataReplyQueueName：业务数据操作类型的应答信息的本地队列名。出厂配置值为 ESBClientDataReplyQueue5) TimeOut：仅用于业务数据操作类型的接收应答超时时间。以秒计。出厂配置值为 0，表明不作超时处理。1.1.6 ESBServerConnector1.1.6.1 主要功能主要功能提供 ESB 逻辑服务端（消息主动发送端）的队列定义。1.1.6.2 属性属性1) AdminRequestQueueName：接收管理类型请求信息的本地队列名。出厂配置值为 ESBServ

10、erAdminRequestQueue。2) AdminReplyQueueName：管理类型应答信息的本地队列名。出厂配置值为 ESBServerAdminReplyQueue。3) AdminRequestQueueName：出厂配置值为ESBServerAdminRequestQueue。4) DataRequestQueueName：接收业务数据操作类型的请求信息的本地队列名。出厂配置值为 ESBServerDataRequestQueue。5) DataReplyQueueName：业务数据操作类型的应答信息的本地队列名。出厂配置值为 ESBServerDataReplyQueue。

11、6) TimeOut：仅用于业务数据操作类型的接收应答超时时间。以秒计。出厂配置值为 0，表明不作超时处理。1.1.7 ESBServerRequestProcessorManager1.1.7.1 主要功能主要功能管理 ESB 服务端基于 Request-Command 模式的请求处理器。1.1.7.2 属性属性1) ServerRequestQueueName：ESB 服务端接收管理类型的请求的队列名。出厂配置值为 ESBServerAdminRequestQueue第 5 页2) ServerReplyQueueName：ESB 服务端发送管理类型的应答信息的队列名。出厂配置值为 ESB

12、ServerAdminReplyQueue3) ClientRequestQueueName：ESB 客户端接收管理类型的请求的队列名。出厂配置值为 ESBClientAdminRequestQueue4) ClientReplyQueueName：ESB 客户端发送管理类型的应答信息的队列名。出厂配置值为 ESBClientAdminReplyQueue。1.1.8 ESBServer1.1.8.1 主要功能主要功能ESB 服务端的主控 MBean 。1.1.8.2 属性属性1) UserName：登陆系统的用户名，用户通过 JNDI 创建队列连接等。出厂配置值为 admin。2) UseU

13、DDI：是否启用 UDDI。出厂配置值为 true。3) UnregisterServiceBeforeShutdown：当服务器关机时，是否通知与之有关联的 ESB 节点反注册所有服务。默认值为 true。4) UDDIUserName：向 UDDI 注册信息时，所需的用户名。出厂配置值为 admin。5) UDDIPassword：向 UDDI 注册信息时，所需的密码。出厂配置值为admin。6) TargetNameSpace：服务的命名空间。出厂配置值为空。7) ServiceWorkSpace：指明服务定义文件的存储目录，相对于 ESB 服务器的安装目录。出厂配置值是 service

14、s，即服务定义文件存储在%Server_Install_Dir%/services 目录下。8) Servers：本 ESB 服务器所关联的其它自治网络服务器名。初始值为空。9) RetryQueueInterval：当 ESB 网络出现故障时，间隔多少分钟后尝试去恢复一次。以分钟计。出厂配置值为 5。10)RetryQueueTimes：当 ESB 网络出现故障时，总共进行多少次尝试恢复操作。出厂配置值为 288。第 6 页11)MqFileTempDir：大文件传输时的临时工作目录，可以是绝对路径，也可以是相对路径。出厂配置值是 temp，即临时工作目录为%Server_Install_D

15、ir%/temp 目录。12)FileBackupDir：Excel、以及文本文件增量数据传输时的历史文件备份目录，相对于 ESB 服务器的安装目录。出厂配置值是 fileBackup，即历史文件备份目录为%Server_Install_Dir%/fileBackup。13)EnableNotification：是否在 Windows 系统中显示托盘，当组件运行过程中出现异常或有数据进出时，是否在 Windows 托盘区显示信息。出厂配置值是 false。14)ConnFactoryJNDI：指向连接工厂的 JNDI 值。出厂配置值为空，采用默认值。15)Clients：本 ESB 服务器所关

16、联的 ESB 客户端名。初始值为空。16)BulkDataCachePath：大数据量分批传输时的临时工作目录，相对于ESB 服务器的安装目录。出厂配置值是 bulkDataCache，即分批传输时的临时工作目录为%Server_Install_Dir%/bulkDataCache。1.1.9 BDA1.1.9.1 主要功能主要功能管理 BDA 相关信息（即业务日志） 。1.1.9.2 属性属性无。1.2 serverlifecycle.xml 参数参数serverlifecycle.xml 中所指定的 listener 是在 Apusic 加载了所有 Mbean 与应用之后被回调。1.2.1

17、 com.apusic.esb.ESBCommonLifeCycleListener1.2.1.1 功能功能该 listener 负责启动 MQ 大文件的接收服务。删除或屏蔽该 listener 之后，将不能接收不到 MQ 传输过来的文件。第 7 页1.2.1.2 属性属性无。1.2.2 com.apusic.esb.ESBServerLifeCycleListener 1.2.2.1 功能功能当 ESB 服务器启动后，1）向联邦服务器与它所关联的客户端发送“本服务器已启动”通知，2）并启动向联邦服务器注册服务的服务注册管理器，3）装载调度服务。当 ESB 服务器关机前，1）停止所有的调度，2

18、）停止注册服务的服务注册管理器，3）向联邦服务器与它所关联的客户端发送“本服务器准备关机”通知。1.2.2.2 属性属性无。1.2.3 com.apusic.esb.uddi.deploy.ESBUDDIModuleLifeCycleListener1.2.3.1 功能功能布署 UDDI。1.2.3.2 属性属性无。第 8 页1.2.4 com.apusic.esb.ws.deploy.ESBWebServiceModuleLifeCycleListener1.2.4.1 功能功能布署 WebService 引擎。1.2.4.2 属性属性无。1.2.5 com.apusic.esb.ws.ES

19、BWSLifeCycleListener1.2.5.1 功能功能当服务器启动后，将所有需要 WebService 绑定的服务发布成WebService，并根据 1.1.8 中 UseUDDI 属性值，决定是否该 WebService 注册到 UDDI 中。1.2.5.2 属性属性无。1.2.6 com.apusic.esb.schedule.ESBSchedulerLifeCycleListener1.2.6.1 功能功能ESB 服务器启动后，在延迟指定时间后启动指定的调度。1.2.6.2 属性属性1) delay：延迟多少分钟后启动调度。出厂配置值为 15，即 ESB 服务器启动 15 分钟

20、后开始启动调度。第 9 页2) start_schedule：需要启动的调度名称，星号（“*” ）代表启动所有的调度，其它值代表的是正则表达式，所有调度名称符合该正则表达式的调度均被启动。出厂配置值为*。3) 可扩展的以“start_schedule_”为开头的其它属性：要求该 listener 下的所有属性名称不能重复，当 start_schedule 所指定的正则表达式不能满足需求时，可任意扩展以“start_schedule_”为开头的其它属性，其含义与start_schedule 属性相同，其值也是正则表达式。1.2.7 com.apusic.esb.bpm.schedule.Erro

21、rProcessScannerLifeCycleListener1.2.7.1 功能功能周期性地尝试恢复因异常而挂起的流程实例。1.2.7.2 属性属性1) delay：ESB 服务器启动后，延时多少分钟开始扫描是否已存在因异常而挂起的流程实例。出厂配置值为 20。2) period：自从第一次检测是否已存在因异常而挂起的流程实例后，每间隔多少分钟再次检测是否已存在因异常而挂起的流程实例。出厂配置值为 20，即扫描间隔为 20 分钟。3) needToRestartSchedule：当一个流程实例恢复执行成功后，是否尝试启动该实例所属流程所关联的自动调度。出厂配置值为 true。4) peri

22、odPolicyForResumingFail：当一个流程实例恢复失败后，采用何种策略计算下一次尝试恢复的时间间隔。取值范围只能有：fixed、exponent、power、linear。记两次尝试恢复的时间间隔的 y，累计恢复次数为 x，各函数对应的值（见 valueForPeriodPolicy 属性）为 k，则：对于fixed，y=k；对于 exponent，y=kx；对于 power，y=xk；对于 linear，y=kx。出厂配置值为 linear。5) valueForPeriodPolicy：上述指定策略所对应的值.。对于 fixed 而言，表示固定间隔几分钟； 对于 expon

23、ent 而言，表示指数函数的底数(分钟)；对于 power 而言，表示幂函数的幂数（分钟） ；对于 linear 而言，表示线性函数的斜率。出厂配置值为 10。6) persistenceDataSource： 持久化尝试恢复流程记录的数据源名称。出厂配置值为 esb_process_auto_recovering。第 10 页2 客户端客户端2.1 MBean 参数参数2.1.1 ESBClient2.1.1.1 主要功能主要功能ESB 客户端主控 MBean。2.1.1.2 属性属性1) UserName：登陆系统的用户名，用户通过 JNDI 创建队列连接等。出厂配置值为 admin。2)

24、 UseUDDI：是否启用 UDDI。出厂配置值为 true。3) UnregisterServiceBeforeShutdown：当服务器关机时，是否通知与之有关联的 ESB 节点反注册所有服务。默认值为 true。4) UDDIUserName：向 UDDI 注册信息时，所需的用户名。出厂配置值为 admin。5) UDDIPassword：向 UDDI 注册信息时，所需的密码。出厂配置值为admin。6) TargetNameSpace：服务的命名空间。出厂配置值为空。7) ServiceWorkSpace：指明服务定义文件的存储目录，相对于 ESB 服务器的安装目录。出厂配置值是 se

25、rvices，即服务定义文件存储在%Client_Install_Dir%/services 目录下。8) ServerName：本 ESB 客户端所关联的 ESB 服务器名称。初始值为空。9) RetryQueueInterval：当 ESB 网络出现故障时，间隔多少分钟后尝试去恢复一次。以分钟计。出厂配置值为 5。10)RetryQueueTimes：当 ESB 网络出现故障时，总共进行多少次尝试恢复操作。出厂配置值为 288。11)MqFileTempDir：大文件传输时的临时工作目录，可以是绝对路径，也可以是相对路径。出厂配置值是 temp，即临时工作目录为%Client_Instal

26、l_Dir%/temp 目录。第 11 页12)FileBackupDir：Excel、以及文本文件增量数据传输时的历史文件备份目录，相对于 ESB 服务器的安装目录。出厂配置值是 fileBackup，即历史文件备份目录为%Client_Install_Dir%/fileBackup。13)EnableNotification：是否在 Windows 系统中显示托盘，当组件运行过程中出现异常或有数据进出时，是否在 Windows 托盘区显示信息。出厂配置值是 false。14)ConnFactoryJNDI：指向连接工厂的 JNDI 值。出厂配置值为空，采用默认值。15)BulkDataCa

27、chePath：大数据量分批传输时的临时工作目录，相对于ESB 服务器的安装目录。出厂配置值是 bulkDataCache，即分批传输时的临时工作目录为%Client_Install_Dir%/bulkDataCache。2.1.2 ESBClientConnector2.1.2.1 主要功能主要功能提供 ESB 逻辑客户端（消息被动接收端）的队列定义。2.1.2.2 属性属性1) AdminRequestQueueName：接收管理类型请求信息的本地队列名。缺省为 ESBClientAdminRequestQueue。2) AdminReplyQueueName：管理类型应答信息的本地队列名

28、。出厂配置值为 ESBClientAdminReplyQueue。3) DataRequestQueueName：接收业务数据操作类型的请求信息的本地队列名。出厂配置值为 ESBClientDataRequestQueue。4) DataReplyQueueName：业务数据操作类型的应答信息的本地队列名。出厂配置值为 ESBClientDataReplyQueue5) TimeOut：仅用于业务数据操作类型的接收应答超时时间。以秒计。出厂配置值为 0，表明不作超时处理。2.1.3 ESBClientRequestProcessorManager2.1.3.1 主主要功能要功能管理 ESB 客

29、户端基于 Request-Command 模式的请求处理器。第 12 页2.1.3.2 属性属性1) ServerRequestQueueName：ESB 客户端接收管理类型的请求信息的队列名。出厂配置值为 ESBClientAdminRequestQueue。2) ServerReplyQueueName：ESB 客户端发送管理类型的应答信息的队列名。出厂配置值为 ESBClientAdminReplyQueue。2.1.4 ESBDataSource2.1.4.1 主要功能主要功能提供 ESB 数据源管理服务。2.1.4.2 属性属性1) DriverPath：指明数据源定义所需的 Jar 包存储目录，相对于 ESB 客户端的安装目录。出厂配置值是 driver。2.