核销平台业务插件扩展介绍

核销平台基于苍穹平台的业务扩展功能提供扩展开发，供开发者自定义扩展核销、反核销执行的逻辑。（适用于6.0版本）

业务扩展场景

位于开发服务云 – 扩展平台 – 业务扩展点

核销平台在核销、反核销等逻辑中提供了12个场景供开发者使用，便于开发核销逻辑。开发者可根据其对应扩展要求实现对应场景开发插件，并通过配置业务扩展插件，实现核销平台扩展开发。

注意：核销平台的插件均需要实现getWriteOffTypeIds方法，在该方法里面返回当前插件使用的核销类别ID。范例如下：

核销插件

核销插件扩展点一览

IWriteOffPlugin 核销通用执行插件

beforeWfRecordGenerate

可以在此方法修改核销记录对象，实现无法通过核销记录映射赋值的业务场景。例如核销记录上的金额计算场景等。

注意：请勿在该方法中修改核销数量等反写规则关联字段，可能会导致实际反写数量与核销记录上数量不同。

buildBackSql

可以在此方法构造SQL语句，实现无法通过反写规则配置的数据更新场景。例如更新核销标识、尾差调整等场景。

核销平台根据返回的SQL语句，根据DBRouteKey通过“分布式事务”分发到不同事务执行SQL语句，保证数据一致性。

注意：该方法应与IUnWriteOffPlugin.buildBackSql方法的逻辑相反。如实现该方法，执行反核销时也要注意把对应数据进行反向处理（例如IWriteOffPlugin中增加数量，则IUnWriteOffPlugin中应减少数量），否则可能会导致数据异常。

afterWfRecordStrategy

在分布式事务中处理，与核销主体事务独立。可以在此方法中根据核销记录进行其他逻辑处理。例如调用其他应用微服务接口等场景。

afterWfAutoGenerate

在分布式事务中处理，与核销主体事务独立。可以在此方法中对已经保存的生成单据进行进一步处理。例如调用提交、审核等操作。

viewWfLog

可以在此方法中根据核销执行日志进行其他业务处理，例如通知对应人员核销执行情况。

注意：请勿在此修改核销执行日志。核销执行日志为监控核销执行的重要数据信息，禁止修改核销执行日志，否则可能会导致某些场景下自动补偿出错。

IKdtxWfPlugin 核销分布式事务处理插件

getKdtxWfPluginParam

可以在此方法中根据传入的参数（核销记录、核销对象等）构造需要后续分布式事务中执行的业务逻辑所需参数。核销平台会将返回的参数map传入分布式事务，作为kdtxWfPlugin方法参数。

注意：此处构造返回的参数map请勿使用DynamicObject等复杂对象或自定义对象，否则可能导致序列化错误或失败，从而影响后续kdtxWfPlugin方法执行。

kdtxWfPlugin

可以在此方法中根据核销记录、构造的参数进行各种业务逻辑处理。例如调用其他应用微服务等。

IMatchPlugin 核销匹配插件

matchCondition

可以在此方法为发起方添加匹配维度信息。例如添加分录id维度（与botpTrackRelation方法联用实现分录按关联关系匹配）。

botpTrackRelation

用于启用添加botp关联关系过滤并表示发起方单据与匹配方单据上下查关系。

注意：核销单据对象为核销平台定义的单据类型（为了区分主辅方相同单据对象，例如红蓝核销），如需获取单据对象，可参考如下代码：

IFilterPlugin 核销过滤插件

filterCondition

可以在此方法中对发起方、匹配方的数据进行二次过滤，实现核销平台无法配置的过滤场景。

IWriteOffCheckPlugin 核销检查插件

check

 可在此方法中校验核销平台生成的核销记录是否符合业务需求。

IWfEndWriteBackPlugin 核销反写后处理插件

endWriteBack

可以在此调用微服务通知核销反写数量执行完并进行其他数据更新处理。

反核销插件

反核销插件一览

IUnWriteOffPlugin 反核销通用执行插件

buildBackSql

可以在此方法构造SQL语句，实现无法通过反写规则配置的数据更新场景的反向处理。

核销平台根据返回的SQL语句，根据DBRouteKey通过“分布式事务”分发到不同事务执行SQL语句，保证数据一致性。

注意：该方法应与IWriteOffPlugin.buildBackSql方法的逻辑相反。如IWriteOffPlugin实现buildBackSql方法，执行则该插件在执行时也要注意把对应数据进行反向处理（例如IWriteOffPlugin中增加数量，则IUnWriteOffPlugin中应减少数量），否则可能会导致数据异常。

beforeWfRecordDelete

可以在此方法中根据核销记录信息更新反核销信息到其他单据上。

autoBillDelete

可以在此方法中对单据进行反审核等反写操作处理，将自动生成单设置为暂存状态。该方法与IWriteOffPlugin. beforeWfRecordGenerated方法的逻辑相对应。

注意：该方法后会调用单据的删除操作，因此需要在该方法内将单据处理可删除的状态，避免后续单据删除失败。例如调用反向操作到暂存态等。

IKdtxUnWfPlugin 反核销分布式事务处理插件

kdtxBackWfPlugin

可以在此调用微服务通知当前核销记录进行反核销。该方法与IKdtxWfPlugin.kdtxWfPlugin方法的逻辑相对应。 

IUnWriteOffCheckPlugin反核销检查插件

check

可在此方法验证当前核销记录是否可以进行反核销操作。

IUnWfEndWriteBackPlugin 反核销反写后处理插件

endWriteBack

可以在此调用微服务通知反核销反写数量执行完并进行其他数据更新处理。该方法应IWfEndWriteBackPlugin. endWriteBack方法的逻辑对应。