BOS内置服务函数说明手册.docx
《BOS内置服务函数说明手册.docx》由会员分享，可在线阅读，更多相关《BOS内置服务函数说明手册.docx（30页珍藏版）》请在冰豆网上搜索。
BOS内置服务函数说明手册
Kingdee
K/3BOS开发指导手册
BOS内置服务函数说明手册
金蝶软件（中国）有限公司研发中心K/3BOS系统开发部
BOS内置服务函数说明手册
金蝶软件（中国）有限公司
研发中心K/3BOS系统开发部
RaymondYao2006.03.22
1扩展Action
1.1简介
现有扩展Action如下表：
资源ID
Action名称
Action描述
100000
BOSSer_ShowMsg
显示提示信息
100001
BOSSer_POPriceAlert
限价预警
100002
BOSSer_Break
中止后续Action,并提示
100003
BOSSer_PriceQueryPO
采购价格查询
100004
BOSSer_GetSupplyInfo
获取供应商供货信息
100005
BOSSer_HPriceQry
历史价格查询
100006
BOSSer_VStockStatus
库存状态查询
100007
BOSSer_GetTaxRate
获取税率
100008
BOSSer_CurrencyCal
币别转化计算
100009
BOSSer_GetExchangeRate
获取币别的税率
100010
BOSSer_VItemReplace
物料替代查询
100011
BOSSer_Reload
重新加载数据
100012
BOSSer_GetMenuInfo
获取菜单的信息
100013
BOSSer_SetMenuInfo
设置菜单信息
100014
BOSSer_GetBillInfo
获取单据信息
100015
BOSSer_ExecRtnSQL
执行有简单返回值的SQL
100016
BOSSer_UpdateItemPrice
更新物料价格
100017
BOSSer_UpdatePOPrice
更新供应商价格资料
100400
MBOSSer_ExecSQL
中间层执行SQL
100401
MBOSSer_UpdateItemPrice
中间层更新物料价格
100402
MBOSSer_ExecRtnSQL
执行有简单返回值的SQL
1.2客户端适用的扩展Action
1.2.1BOSSer_ShowMsg-显示提示信息
资源ID
100000
Action名称
BOSSer_ShowMsg
Action描述
显示提示信息
公式
BOSSer_ShowMsg{sErrMsg,MessageType}
参数
参数
含义
说明
sErrMsg
提示信息内容
MessageType
显示信息的方式
0：
代表一般的提示框，只有OK按钮和通知消息图标。
1：
代表交互的提示框，有OK和Cancel按钮和通知消息图标。
备注
1、当为一般提示框时，且是序时簿触发的，则不会直接显示提示框，而是将信息包含在操作结束时的“序时簿操作事件执行结果”对话框中；
2、当为交互提示框时，如果用户选择了“Cancel”，则会引发终止该Action序列中的后续Action执行。
1.2.2BOSSer_POPriceAlert-采购价格预警
资源ID
100001
Action名称
BOSSer_POPriceAlert
Action描述
采购价格预警
公式
BOSSer_POPriceAlert{Para=[FKey,...];Return=[FKey,...];BOSAction={FKey,...}}
参数
参数名
边界
描述
P_SupplyKEY
必须传入
供应商键值
P_CurrencyKEY
必须传入
币别键值
P_ExChangeRate
必须传入
汇率键值
P_PriceType
默认值为1
单价类型，0-委外，1-外购
P_PriceKEY
必须传入
单价键值
P_TaxPriceKEY
可以为空
含税单价键值
P_ItemKEY
必须传入
物料键值
P_UnitKEY
必须传入
单位键值
P_TaxRateKEY
必须传入
税率键值
P_DiscountRateKEY
必须传入
折扣率键值
P_InvStyleKey
可以为空
业务类型键值
分为委外类型/外购类型
如果指定这个字段，则“单价类型”则会取单据上的这个字段值来决定判断
P_SaveOrApprove
默认值为0
操作类型，0-保存，1-审核
P_UseSInvoiceDecimal
默认值为0
是否使用专用发票单价精度设置，1-使用，0-使用物料上的精度
备注
1、按顺序选择单据上上述字段；
2、需要选择的是[字段.键]类型的；
3、如果有确认信息，确认后流程是否继续，取消后流程之后终止。
1.2.3BOSSer_Break-中止后续Action
资源ID
100002
Action名称
BOSSer_Break
Action描述
中止后续Action
公式
BOSSer_Break{sErrMsg}
参数
参数
含义
说明
sErrMsg
提示信息内容
可选。
需要填写多语言信息。
备注
1、如果包含信息，则信息在操作结束时显示在“操作事件执行结果”对话框中；
2、结合“执行条件”设置，当条件满足时触发。
1.2.4BOSSer_PriceQueryPO-采购价格查询
资源ID
100003
Action名称
BOSSer_PriceQueryPO
Action描述
采购价格查询
公式
BOSSer_PriceQueryPO{Para=[FKey,...];Return=[FKey,...];BOSAction=[FKey,...]}
参数
参数名称
边界
描述
P_CallByBill
默认值为true
调用方式
P_SupID
默认值为0
供应商ID
P_PriceType
默认值为1
单价类型
P_InvStyle
默认值为0
发票类型
P_ICItemID
默认值为0
物料ID
备注
1.2.5BOSSer_GetSupplyInfo-获取供应商供货信息
资源ID
100004
Action名称
BOSSer_GetSupplyInfo
Action描述
获取供应商供货信息
公式
BOSSer_GetSupplyInfo{Para=[FKey,...];Return=[FKey,...];BOSAction=[FKey,...]}
参数
参数名称
边界
描述
P_SupplyID
供应商ID
P_CurrencyID
默认值为1
币别ID
P_ExChangeRate
默认值为1
汇率
P_PriceType
默认值为1
单价类型
P_InvStyle
发票类型
P_ICItemID
必须传入
物料ID
P_UnitID
必须传入
计量单位ID
P_AuxQty
默认值0
数量
P_GetICItemPOPrice
默认值为1
是否获取物料采购单价
备注
1.2.6BOSSer_HPriceQry-历史价格查询
资源ID
100005
Action名称
BOSSer_HPriceQry
Action描述
历史价格查询
公式
BOSSer_HPriceQry{Para=[FKey,...];BOSAction=[FKey,...]}
参数
参数名称
边界
描述
P_QueryType
默认值为1
查询类别（客户为1，供应商为2）
P_CompanyID
默认值为0
客户或供应商ID
P_ICItemID
默认值为0
物料ID
备注
1.2.7BOSSer_VStockStatus-库存状态查询
资源ID
100006
Action名称
BOSSer_VStockStatus
Action描述
库存状态查询
公式
BOSSer_VStockStatus{Para=[FKey,...];BOSAction=[FKey,...]}
参数
参数名称
边界
描述
P_ICItemID
默认值为””。
如果需要返回全部表体物料，则类型为数组，否则为String
物料ID
备注
1.2.8BOSSer_GetTaxRate-携带税率
资源ID
100007
Action名称
BOSSer_GetTaxRate
Action描述
携带税率
公式
BOSSer_GetTaxRate{Para=[FKey,...];Return=[FKey,...];BOSAction=[FKey,...]}
参数
参数名称
边界
描述
P_SystemType
0表示采购，1表示销售
系统
P_CompanyType
0表示客户，1表示供应商
类别
P_CompanyID
客户或供应商ID
P_ICItemID
物料ID
P_TaxRateOption
0表示客户或供应商；1表示物料，缺省使用系统选项
当前税率来源
备注
1.2.9BOSSer_CurrencyCal-币别转换
资源ID
100008
Action名称
BOSSer_CurrencyCal
Action描述
币别转换
公式
BOSSer_CurrencyCal{Para=[FKey,...];Return=[FKey,...];BOSAction=[FKey,...]}
参数
参数名称
边界
描述
P_CurrencyID
币别ID
P_OldCurrencyID
转换前币别
P_OldExchangeRate
转换前汇率（和转换前币别参数二选一）
P_CalField1
需要计算的字段1
P_CalField2
需要计算的字段2
P_CalField3
需要计算的字段3
P_CalField4
需要计算的字段4
P_CalField5
需要计算的字段5
备注
1.2.10BOSSer_GetExchangeRate-获取币别的汇率
资源ID
100009
Action名称
BOSSer_GetExchangeRate
Action描述
获取币别的汇率
公式
BOSSer_GetExchangeRate{Para=[FKey,...];Return=[FKey,...];BOSAction=[FKey,...]}
参数
参数名称
边界
描述
P_CurrencyID
币别ID
备注
1.2.11BOSSer_VItemReplace-物料替代查询
资源ID
100010
Action名称
BOSSer_VItemReplace
Action描述
物料替代查询
公式
BOSSer_VItemReplace{Para=[FKey,...];BOSAction=[FKey,...]}
参数
参数名称
边界
描述
P_ICItemID
默认值为””。
如果需要返回全部表体物料，则类型为数组，否则为String
物料ID
备注
1.2.12BOSSer_Reload-刷新界面
资源ID
100011
Action名称
BOSSer_Reload
Action描述
刷新界面
公式
BOSSer_Reload{}
参数
备注
本Action不需要配置。
在序时簿和单据上，重新加载数据并刷新当前界面
1.2.13BOSSer_GetMenuInfo-获取菜单信息
资源ID
100012
Action名称
BOSSer_GetMenuInfo
Action描述
获取菜单信息
公式
BOSSer_GetMenuInfo{变量名=菜单.Visible,...}
参数
备注
1、在单据或序时簿状态的Action环境获取菜单的状态；
2、获取菜单的Caption、Name、ToolTip属性返回值为字符串；
3、获取菜单的Visible、Checked、Enabled属性返回值为布尔型；
4、获取菜单的Tag属性返回值为变体；
1.2.14BOSSer_SetMenuInfo-设置菜单信息
资源ID
100013
Action名称
BOSSer_SetMenuInfo
Action描述
设置菜单信息
公式
BOSSer_SetMenuInfo{变量名=菜单.Visible,...}
参数
备注
1、在单据或序时簿状态的Action环境设置菜单新的状态和信息；
2、设置菜单的Caption、Name、ToolTip属性，使用值为字符串；
3、设置菜单的Visible、Checked、Enabled属性，使用值为布尔型；
1.2.15BOSSer_GetBillInfo-获取单据的一些信息
资源ID
100014
Action名称
BOSSer_GetBillInfo
Action描述
获取单据的一些信息
公式
BOSSer_GetBillInfo{$$.Var1=BillInfo1,$$.Var2=BillInfo2,...}
参数
备注
1、在单据操作过程中，获取单据的一些运行时信息
1.2.16BOSSer_ExecRtnSQL-执行有简单返回值的SQL
资源ID
100015
Action名称
BOSSer_ExecRtnSQL
Action描述
执行有简单返回值的SQL
公式
BOSSer_ExceRtnSQL{SQL="";Params=[];Return=[];}
参数
参数名称
描述
SQL
运行的SQL语句
Para
配置参数值列表
Return
返回值配置列表
备注
在客户端直接运行指定SQL，如果SQL中包含了变量，则配置变量数据;如果还需要返回值，则可以配置返回值
1.2.17BOSSer_UpdateItemPrice-更新物料价格
资源ID
100016
Action名称
BOSSer_UpdateItemPrice
Action描述
更新物料价格
公式
BOSSer_UpdateItemPrice{Para=[FKey,...];BOSAction=[FKey,...]}
参数
参数名称
边界
描述
P_PriceType
价格类型
P_ItemKEY
物料字段
P_CurrencyKEY
币别字段
P_ExChangeRateKEY
汇率字段
P_UnitKEY
单位字段
P_PriceKEY
价格字段
P_TaxRateKEY
税率字段
P_DiscountRateKEY
折扣字段
P_ROBKEY
红蓝字字段
P_TaxInPrice
价格字段是否已含税
P_TargetTaxInPrice
目标价格资料是否含税
备注
1.2.18BOSSer_UpdatePOPrice-更新供应商价格资料
资源ID
100017
Action名称
BOSSer_UpdatePOPrice
Action描述
更新供应商价格资料
公式
BOSSer_UpdatePOPrice{Para=[FKey,...];BOSAction=[FKey,...]}
参数
参数名称
边界
描述
P_InterID
单据内码
备注
1.3中间层适用的扩展Action
1.3.1MBOSSer_ExecSQL-中间层执行SQL
资源ID
100400
Action名称
MBOSSer_ExecSQL
Action描述
中间层执行SQL
公式
MBOSSer_ExecSQL{SQL,Para...}
参数
参数名称
描述
SQL
中间层运行的SQL语句
Para
SQL语句中可能包含的变量以及取值来源字段。
变量在SQL中，必须以@作为前后缀
备注
在中间层直接运行指定SQL，如果SQL中包含了变量，则按照变量取值来源字段，先取值，替换SQL中变量后再执行
1.3.2MBOSSer_UpdateItemPrice-更新物料价格资料
资源ID
100401
Action名称
MBOSSer_UpdateItemPrice
Action描述
更新物料价格资料
公式
MBOSSer_UpdateItemPrice{Para=[FKey,...];BOSAction=[FKey,...]}
参数
参数名称
边界
描述
P_PriceType
价格类型
P_ItemKEY
物料字段
P_CurrencyKEY
币别字段
P_ExChangeRateKEY
汇率字段
P_UnitKEY
单位字段
P_PriceKEY
价格字段
P_TaxRateKEY
税率字段
P_DiscountRateKEY
折扣字段
P_ROBKEY
红蓝字字段
P_TaxInPrice
价格字段是否已含税
P_ApplyPriceManageParam
应用启用价格管理参数
备注
1.3.3MBOSSer_ExecRtnSQL-执行有简单返回值的SQL
资源ID
100402
Action名称
MBOSSer_ExecRtnSQL
Action描述
执行有简单返回值的SQL
公式
MBOSSer_ExceRtnSQL{SQL="";Params=[];Return=[];}
参数
参数名称
边界
描述
SQL
运行的SQL语句
Para
配置参数值列表
Return
返回值配置列表
备注
在中间层直接运行指定SQL，如果SQL中包含了变量，则配置变量数据;如果还需要返回值，则可以配置返回值
2典型Action序列说明
2.1关闭、反关闭
2.1.1关闭
类别
序号
Action
说明
单据操作前事件
1
BOSSer_CheckCancel
自定义扩展业务服务函数（可选）
账套是否做初始化结束检查，如果不通过则结束后续Action
2
BOSSer_Break
根据执行条件判断[单据头.单据状态]字段的值来判断单据是否已经关闭；如果字段的值等于3，代表该单据已经关闭，则提示用户，并终止后续Action
3
BOSSer_Break
根据执行条件判断[单据头.单据状态]字段的值来判断单据是否已经审核；如果字段的值等于0，代表该单据没有审核，则提示用户，并终止后续Action
单据操作事件
1
MBOSSer_ExecSQL
执行SQL，更新POOrder表FStatus字段值为3，代表为关闭状态；更新POOrderEntry表FMRPClosed字段，表示该单据分录行业务关闭。
单据操作后事件
1
BOSSer_ShowMsg
提示用户单据关闭成功
2
BOSSer_Reload
重新加载单据
序时簿操作前事件
序时簿操作事件
1
BOSSer_CheckCancel
自定义扩展业务服务函数（可选）
账套是否做初始化结束检查，如果不通过则结束后续Action
2
BOSSer_ExecRtnSQL
执行SQL，从POOrder表中获取FStatus的值，并保存在变量中
3
BOSSer_Break
根据执行条件判断变量FStatus的值来判断单据是否已经关闭；如果值等于3，代表该单据已经关闭，则提示用户，并终止后续Action
4
BOSSer_Break
根据执行条件判断变量FStatus的值来判断单据是否已经审核；如果值等于0，代表该单据没有审核，则提示用户，并终止后续Action
5
MBOSSer_ExecSQL
执行SQL，更新POOrder表FStatus字段值为3，代表为关闭状态；更新POOrderEntry表FMRPClosed字段，表示该单据分录行业务关闭。
序时簿操作后事件
1
BOSSer_Reload
重新加载序时簿
2.1.2反关闭
类别
序号
Action
说明
单据操作前事件
1
BOSSer_CheckCancel
自定义扩展业务服务函数（可选）
账套是否做初始化结束检查，如果不通过则结束后续Action
2
BOSSer_Break
根据执行条件判断[单据头.单据状态]字段的值来判断单据是否已经关闭；如果字段的值不等于3，代表该单据没有关闭，则提示用户，并终止后续Action
单据操作事件
1
BOSSer_ExecRtnSQL
执行SQL，获取单据上存在分录的关联数量<该行数量的行数
2
BOSSer_Break
如果上面取得的行数等于0，代表单据上所有物料的数量均已选完，不能进行反关闭，提示用户并终止后续Action
3
BOSSer_ExecRtnSQL
执行SQL获取单据分录中关关连数量不为0的分录数
4
BOSSer_ExecRtnSQL
如果上述分录数为0，令变量FStatus值为1，否则为2
5
MBOSSer_ExecRtnSQL
执行SQL更新POOrder表中获取FStatus的值等于上面的变量值；更新所有表体分录中入库数量<该行数量分录的行业务关闭标志为0
单据操作后事件
1
BOSSer_ShowMsg
提示用户单据反关闭成功
2
BOSSer_Reload
重新加载单据
序时簿操作前事件
序时簿操作事件
1
BOSSer_CheckCancel
自定义扩展业务服务函数（可选）
账套是否做初始化结束检查，如果不通过则结束后续Action
2
BOSSer_ExecRtnSQL
执行SQL，从POOrder表中获取FStatus的值，并保存在变量中
3
BOSSer_Break
根据执行条件判断变量FStatus的值来判断单据是否已经关闭；如果值不等于3，代表该单据没有关闭，则提示用户，并终止后续Action
4
BOSSer_ExecRtnSQL
执行SQL，获取单据上存在分录的关联数量<该行数量的行数
5
BOSSer_Break
如果上面取得的行数等于0，代表单据上所有物料的数量均已选完，不能进行反关闭，提示用户并终止后续Action
6
BOSSer_ExecRtnSQL
执行SQL获取单据分录中关关连数量不为0的分录数
7
BOSSer_ExecRtnSQL
如果上述分录数为0，令变量FStatus值为1，否则为2
8
MBOSSer_ExecRtnSQL
执行SQL更
升级会员 