系统业务函数

服务端函数 - 系统业务函数API汇总。

计算实体字段平均值-AvgColumnFunc()

计算指定实体的字段的平均值并返回。
参数与返回值:
名称
类型
描述
参数1
String
活动集实体；其他变量实体需要加上变量的前缀；
参数2
String
计算平均值的字段名称；
返回值
Number
平均值；
示例及效果：
名称
描述
示例
代码示例：AvgColumnFunc("BR_IN_PARENT.xiaoshu","price")；
返回值为：实体字段price的平均值。
效果

将人民币金额转成中文大写-ChangeMoneyToChinese()

将人民币金额转成中文大写。
参数与返回值:
名称
类型
描述
参数1
String
要转换的金额；
返回值
String
大写金额；
示例及效果：
名称
描述
示例
ChangeMoneyToChinese(998.1314)
返回值
"玖佰玖拾捌元壹角叁分壹厘肆毫"
效果

校验验证码-CheckCertCodeFun()

校验输入的验证码是否正确。
参数与返回值:
名称
类型
描述
参数1
String
原字符串；
返回值
Boolean
验证码是否正确；
示例及效果：
名称
描述
示例
CheckCertCodeFun("EEDS")
返回值
True
效果

中文检查-CheckChinese()

检查指定字符串是否包含中文字符。
参数与返回值:
名称
类型
描述
参数1
String
待检查字符串；
返回值
Boolean
包含中文字符返回True，否则返回false。
示例及效果：
名称
描述
示例
CheckChinese("a你好bc")
返回值
True
效果

数字/字符串/布尔格式转换-ConvertFunc()

格式转换，将指定值转换成指定格式返回。
参数与返回值:
名称
类型
描述
参数1
Indefinite
传入的数据；不定类型
参数2
Integer
转换的类型，1-整数, 2-字符串, 3-布尔值, 4-小数； 
注：整数的支持范围是：[-2147483648，2147483647]，小数位数最大支持6位。
返回值
Indefinite
转换后的格式；不定类型，根据参数2的格式而定。
示例及效果：
名称
描述
示例1
ConvertFunc(3,1)  
返回:   3
示例2
ConvertFunc(3,2)  
返回:   "3"
示例3
ConvertFunc(3,3)  
返回:   True
效果

转换页码-ConvertPageNumber()

转换页码，将记录开始数转换成页码。
参数与返回值:
名称
类型
描述
参数1
Integer
记录开始数；
参数2
Integer
分页显示数；
返回值
Integer
页码；
示例及效果：
名称
描述
示例
代码示例：ConvertPageNumber (3,4) ；
返回值为：1。
效果

插入字符串到实体字段值-ConvertVarToEntityColumn()

将字符串的值添加到实体中指定的字段里面。
参数与返回值:
名称
类型
描述
参数1
String
来源字符串；必填
参数2
String
实体编码；（必填，必须带前缀，实体可以是方法输入(BR_IN_PARENT.entityCode)、方法输出(BR_OUT_PARENT.entityCode)、方法变量(BR_VAR_PARENT.entityCode)）；
参数3
String
字段编码；必填
参数4
String
参数一中多个数据之间的分隔符；必填
返回值
无返回值；
示例及效果：
名称
描述
示例
ConvertVarToEntityColumn("今天;明天;后天","entityCode","fieldCode",";")；
效果

返回文件id-CopyFileByFileId()

根据文件标识id复制文件;
参数与返回值:
名称
类型
描述
参数1
String
文件标识id；
返回值
String
复制后的文件id；注：如果文件标识id不存在，就返回"-1"。
示例及效果：
名称
描述
示例
代码示例：CopyFileByFileId("fileId")；
返回值为：复制后的文件id。
效果

字符串64位解码-DecodeBASE64()

对字符串基于64位解码，返回值为字符串。
参数与返回值:
名称
类型
描述
参数1
String
所需解码的字符串；
参数
字符编码（字符串类型）；
返回值
String
示例及效果：
名称
描述
示例
代码示例：DecodeBASE64("PCF4bWw+PC8+","utf-8")；
返回值为： <!xml></>。
效果

字符串URI解码-DecodeURIComponent()

将字符串作为URI组件进行解码。
参数与返回值:
名称
类型
描述
参数1
String
需要解码的字符串；
返回值
String
经过解码的字符串；
示例及效果：
名称
描述
示例
DecodeURIComponent("www.baidu.com%2Fs%3Fwd%3D%E5%90%8C%E6%9C%9B%E7%A7%91%E6%8A%80")；
返回值
"www.baidu.com/s?wd=同望科技"
效果

字符串解密-DecryptFunc()

对字符串进行解密，解密算法目前只支持AES解密方式。
参数与返回值:
名称
类型
描述
参数1
String
需要解密的字符串，必填，默认使用UTF-8编码。
参数2
String
解密算法，必填，不区分大小写。目前只支持AES。
参数3
String
密钥，必填。
返回值
String
解密后的字符串。
示例及效果：
名称
描述
示例
DecryptFunc("12345","AES","xxxx")
效果

下载文件到本地-DowdloadFileToFileSystem()

下载网络文件到本地文件系统。
参数与返回值:
名称
类型
描述
参数1
String
网络文件路径；
参数2
String
文件类型；（可不传，不传可能导致无法识别文件类型）
返回值
String
成功时返回文件id字符串，失败时返回-1字符串。
示例及效果：
名称
描述
示例
DowdloadFileToFileSystem("http://img07.tooopen.com/images/20170316/tooopen_sy_201956178977.jpg","jpg")
效果

从ftp下载文件-DownloadFromFtp()

从ftp下载文件到文件服务中， 返回文件id。
参数与返回值:
名称
类型
描述
参数1
String
ftp文件名；
参数2
String
服务器地址；
参数3
Integer
端口号；
参数4
String
ftp用户名；
参数5
String
ftp密码；
参数6
String
ftp文件所在路径；
返回值
String
文件ID；
示例及效果：
名称
描述
示例
代码示例：DownloadFromFtp("test.docx","www.url.com",21,"user","pwd","ftp/test")；
效果

字符串64位编码-EncodeBASE64()

对字符串基于64位编码，返回值为字符串。
参数与返回值:
名称
类型
描述
参数1
String
所需编码的字符串；
参数2
String
字符编码；
返回值
String
64位编码字符串；
示例及效果：
名称
描述
示例
代码示例：EncodeBASE64("<!xml></>")；
返回值为："PCF4bWw+PC8+"。
效果

字符串URI编码-EncodeURIComponent()

将字符串作为URI组件进行编码。
参数与返回值:
名称
类型
描述
参数1
String
需要编码的字符串；
返回值
String
经过编码的字符串；
示例及效果：
名称
描述
示例
DEncodeURIComponent("www.baidu.com/s?wd=同望科技")
返回值
"www.baidu.com%2Fs%3Fwd%3D%E5%90%8C%E6%9C%9B%E7%A7%91%E6%8A%80"
效果

加密字符串-EncryptFunc()

对字符串进行加密。
参数与返回值:
名称
类型
描述
参数1
String
需要加密的字符串；必填，默认使用UTF-8编码
参数2
String
加密算法；必填，不区分大小写。支持以下类型：
md5：基于RFC 1321。安全性一般，性能高，不可逆，返回32位16进制。主要用于一致性验证、数字签名等
SHA-1：基于NIST's FIPS 180-4，安全比md5高，性能比md5慢，不可逆，返回32位16进制。
SHA-256：基于NIST's FIPS 180-4，安全比SHA-1高，性能比SHA-1慢，不可逆，返回64位16进制。
SHA-384：基于NIST's FIPS 180-4，安全比SHA-256高，性能比SHA-256慢，不可逆，返回96位16进制。
SHA-512：基于NIST's FIPS 180-4，安全比SHA-384高，性能比SHA-384慢，不可逆，返回128位16进制。
AES：基于PKCS #5。对称加密，可逆，安全性高，是一种区块加密标准。广泛用于金融财务、在线交易等领域。
参数3
String
加密密钥（必填，当且仅当参数2为AES，请填写正确密钥，其他参数任意填写。）；
返回值
String
加密后的字符串；
示例及效果：
名称
描述
示例
EncryptFunc("12345","md5","xxxx")
效果

加密字符串-EncryptFunc()

对字符串进行加密。
参数与返回值:
名称
类型
描述
参数1
String
需要加密的字符串；必填，默认使用UTF-8编码；
参数2
String
加密算法，必填，不区分大小写。支持以下类型： 
md5：基于RFC 1321。安全性一般，性能高，不可逆，返回32位16进制。主要用于一致性验证、数字签名等
SHA-1：基于NIST's FIPS 180-4，安全比md5高，性能比md5慢，不可逆，返回32位16进制。
SHA-256：基于NIST's FIPS 180-4，安全比SHA-1高，性能比SHA-1慢，不可逆，返回64位16进制。
SHA-384：基于NIST's FIPS 180-4，安全比SHA-256高，性能比SHA-256慢，不可逆，返回96位16进制。
SHA-512：基于NIST's FIPS 180-4，安全比SHA-384高，性能比SHA-384慢，不可逆，返回128位16进制。
AES：基于PKCS #5。对称加密，可逆，安全性高，是一种区块加密标准。广泛用于金融财务、在线交易等领域。
参数3
String
密钥，必填；当且仅当参数2为AES，请填写正确密钥，其他参数任意填写。   
AES密钥要求：长度要求为16byte，不足将补0，超过16byte将自动截取。  
不建议使用中文作为密钥，推荐大小字符以及数字的组合。
返回值
String
加密后的字符串；
示例及效果：
名称
描述
示例
EncryptFunc("12345","md5","xxxx");
效果

字符串加密-EncryptionFunc()

按照加密策略，对字符串进行加密。
参数与返回值:
名称
类型
描述
参数1
String
加密策略；支持：MD5，Base64，AES；
参数2
String
需要加密的字符串；
返回值
String
加密后的字符串；
示例及效果：
名称
描述
示例
EncryptionFunc("MD5","eee11")
返回值
"cF8FevsV8QeVyD/X1ClR3A=="
效果

校验执行表达式-EvalExpression()

校验执行表达式的函数。
参数与返回值:
名称
类型
描述
参数1
String
字符串表达式；
返回值
Indefinite
表达式执行结果；
示例及效果：
名称
描述
示例
EvalExpression("@@userName")
返回值
系统变量userName的值
效果

取连续的流水号-GenerateSequenceNumber()

取连续的流水号。
参数与返回值:
名称
类型
描述
参数1
String
流水号种子。根据该种子生成流水号，最长128位字符串，建议64位或者更短。
参数2
String
生成模式；
支持模式：
INC：最大号+1；
REUSE：重用废弃的流水号，当没有废号可用时，同INC；
ASSIGNERR：用给定的值作为流水号，如果该值已被占用，那么生成失败；
ASSIGNINC：用给定的值作为流水号，如果该值已被占用，那么同INC；
ASSIGNREUSE：用给定的值作为流水号，如果该值已被占用，那么同REUSE；
参数3
Integer
需要使用的废弃流水号。当且仅当参数2为ASSIGNERR、ASSIGNINC、ASSIGNREUSE才有效。
返回值
Integer
流水号；
示例及效果：
名称
描述
示例
GenerateSequenceNumber ("123456", "INC")
返回值
"1"
效果

取流水号-GenerateSequenceNumberQuick()

取流水号，最优化处理。有断号。
参数与返回值:
名称
类型
描述
参数1
String
流水号种子；根据该种子生成流水号，最长128位字符串，建议64位或者更短。
返回值
Integer
流水号；
示例及效果：
名称
描述
示例
GenerateSequenceNumberQuick("123456")
返回值
1
效果

生成uuid-GenerateUUID()

生成一个uuid。
参数与返回值:
名称
类型
描述
参数
无参数；
返回值
String
uuid字符串；
示例及效果：
名称
描述
示例
GenerateUUID()
返回值
uuid字符串；
效果

根据身份证号码获取年龄-GetAgeByIdCard()

根据身份证号码获取年龄。（服务器时间 - 身份证出生日期）
注：
1、当前日期是获取服务器的时间。
2、年龄是精确到日来计算的。
参数与返回值:
名称
类型
描述
参数1
String
身份证号码；
返回值
Integer
年龄；精确到日来计算。
示例及效果：
名称
描述
示例
GetAgeByIdCard("440103201003076041")
返回值
假设系统时间为：20210910，身份证出生日期20100307。
返回年龄：11
效果

查询父节点集合组装的字符串-GetAllParentIds()

根据树节点id查出它所有的父节点集合组装成约定的字符串。
参数与返回值:
名称
类型
描述
参数1
String
节点id值；
参数2
String
实体编码；
实体可以是方法输入(BR_IN_PARENT.entityCode)、方法输出(BR_OUT_PARENT.entityCode)、方法变量(BR_VAR_PARENT.entityCode) ；
参数3
Boolean
是否包含自身节点；
参数4
String
分隔符；
返回值
String
父节点集合字符串；
示例及效果：
名称
描述
示例
代码示例: GetAllParentIds("a","BR_IN_PARENT.entityCode",True,";")，
id为a，父节点有b、c，分隔符为;
若包含自身节点，则返回b;c;a，
若不包含自身节点，则返回b;c，
返回节点顺序为从高到低。
效果

按照条件获取对应的实体的字段信息-GetConditionColumnValue()

1、根据条件查询指定数据源中某个字段的值。
2、如果该条件下返回多条记录，则取第一条记录的值。
参数与返回值:
名称
类型
描述
参数1
String
方法实体编码；
方法输入实体（BR_IN_PARENT.entityCode）、
方法变量实体（BR_VAR_PARENT.entityCode）、
方法输出实体（BR_OUT_PARENT.entityCode）；
参数2
String
方法实体中某个字段的编码；
参数3
String
查询条件(如果值是字符串类型，则需要加单引号，参考示例2)； 
若参数3中的条件值来源变量，则参数3需要用一个变量代替，如：
GetConditionColumnValue("BR_VAR_PARENT.TableName","name",BR_VAR_PARENT.cs3)
其中BR_VAR_PARENT.cs3的值=ConcatStr("name=",BR_VAR_PARENT.cs3_z)
若BR_VAR_PARENT.cs3_z为字符串，拼接参数3时，还需要加上单引号，如：
ConcatStr("name=","'",BR_VAR_PARENT.cs3_z,"'")
返回值
String
字段的值；
示例及效果：
名称
描述
示例1
GetConditionColumnValue("BR_IN_PARENT.entityCode","name","age=1")
示例2
GetConditionColumnValue("BR_VAR_PARENT.entityCode","name","wb='文本'")
效果

获取服务连接的数据库类型-GetDataBaseType()

 获取服务连接的数据库类型。
参数与返回值:
名称
类型
描述
参数
无参数；
返回值
String
服务连接的数据库类型；
数据库类型枚举：Mssql2000、Mssql、DB2、Oracle、Mysql、H2、Unknow，其中SqlServer 2000以上版本都返回Mssql，若读取不到数据库类型，则返回Unknow。
示例及效果：
名称
描述
示例
GetDataBaseType()
返回执行系统服务连接的数据库类型；
效果

获取轨迹里程-GetDistance()

根据经纬度数据顺序集合，自动计算轨迹里程。
参数与返回值:
名称
类型
描述
参数1
String
实体编码（必填），必须带前缀，
实体可以是方法输入(BR_IN_PARENT.entityCode)；
方法输出(BR_OUT_PARENT.entityCode)；
方法变量(BR_VAR_PARENT.entityCode)；
参数2
String
经度字段编码（必填）；
参数3
String
纬度字段编码（必填）；
返回值
Integer
轨迹里程；
示例及效果：
名称
描述
示例
代码示例：GetDistance("BR_IN_PARENT.locationEntity","lng","lat")，
根据经纬度数据顺序集合，自动计算轨迹里程，
例如返回轨迹里程为6200.30（单位米）
效果

根据条件从实体获取记录数-GetEntityRowCountFunc()

根据条件从实体获取记录数。
参数与返回值:
名称
类型
描述
参数1
String
实体编码。实体可以是方法输入(BR_IN_PARENT.entityCode)、方法输出(BR_OUT_PARENT.entityCode)、方法变量(BR_VAR_PARENT.entityCode)；
参数2
String
筛选条件，其运算结果应该是布尔值。如果该参数省略，则返回实体总记录数；
返回值
Integer
满足条件的实体记录数；
 [!Tip]
注意：
1、若参数2中的条件值来源变量，则参数2需要用一个变量代替，如：
GetEntityRowCountFunc("BR_VAR_PARENT.TableName",BR_VAR_PARENT.cs2)
其中BR_VAR_PARENT.cs2的值等于：
ConcatStr("name=",BR_VAR_PARENT.cs2_z)
2、若BR_VAR_PARENT.cs2_z为字符串，拼接参数2时，还需要加上单引号，如：
ConcatStr("name=","'",BR_VAR_PARENT.cs2_z,"'")
注：筛选条件中的字符串需要用单引号引起来。
示例及效果：
名称
描述
示例
GetEntityRowCountFunc("BR_IN_PARENT.entityCode","wb='A'")
返回方法输入实体[entityCode]中字段wb的值是A的记录数。
效果

获取文件信息-GetFileInfo()

 根据文件id与文件信息类型获取文件信息。
参数与返回值:
名称
类型
描述
参数1
String
文件标识；
参数2
String
文件信息类型；其中：
fileName为文件名，
fileSize为文件大小（单位KB），
fileType为文件类型扩展名，
md5为文件md5码；
返回值
String
文件信息(文件名/文件大小/文件类型扩展名/文件md5码)；
示例及效果：
名称
描述
示例
GetFileInfo("8a819ab551c2421c0151c3b597b80ddf","fileName")；
效果

获取文件URL-GetFileUrlByFileId()

根据文件Id获取文件url。
参数与返回值:
名称
类型
描述
参数1
String
文件id；
返回值
String
文件url；
示例及效果：
名称
描述
示例
代码示例：GetFileUrlByFileId("9f51cb5f88a65347581a0e15e343fca9")；
返回值为：文件url。
效果

获取实体变量首行记录字段值-GetFirstRowColumnValue()

获取实体变量首行记录字段值。
参数与返回值:
名称
类型
描述
参数1
String
实体名称；界面实体为字符串类型，其他变量实体需要加上变量的前缀。
参数2
String
字段名；
返回值
Indefinite
实体变量首行记录字段值；不定类型，与参数二所选字段的类型一致。
示例及效果：
名称
描述
示例
界面实体：GetFirstRowColumnValue("entity","id");
返回值为：该实体变量首行记录的id字段值。 
活动集实体：GetFirstRowColumnValue("BR_VAR_PARENT.interView","id")
效果

获取图片URL-GetImageUrl()

根据图片的文件id获取图片的URL路径。
参数与返回值:
名称
类型
描述
参数1
String
图片的文件id；
返回值
String
图片的URL路径；
示例及效果：
名称
描述
示例
代码示例：GetImageUrl("8a819ab551c2421c0151c3b597b80ddf")；
返回值为：图片的URL路径。
效果

获取IP地址-GetIPAddressFunc()

返回当前客户端的IP地址(注意返回的是服务器端获取到的请求IP地址)。
参数与返回值:
名称
类型
描述
参数1
无参数；
返回值
String
客户端请求的IP地址；
示例及效果：
名称
描述
示例
代码示例：GetIPAddressFunc()；
返回值为：当前客户端请求的IP地址字符串。
注意返回的是服务器端获取到的请求IP地址，
如果使用了代理服务器，则返回代理之前的真实客户端地址。
效果

获取经度或纬度-GetLngOrLatByAddr()

根据地址获取经度或纬度。
注：使用此函数前，需要在业务系统控制台配置相关参数：
（1）前往控制台（system/console）-- 系统维护 -- 配置管理 -- 百度鹰眼服务 配置ak；
（2）ak的获取：前往百度开放平台创建应用后获取，注意在创建时：
【应用类型】需选【服务端】（http://lbsyun.baidu.com/apiconsole/key）。
参数与返回值:
名称
类型
描述
参数1
String
地址（必填），目前仅限国内地址，地址结构（（省/市/区/街道/门牌号））越完整，地址内容越准确，解析的坐标精度越高。
参数2
String
lng或lat，其中lng为取经度，lat为取纬度（必填）；
返回值
Number
根据参数2，返回地址的经度或纬度；
示例及效果：
名称
描述
示例
代码示例：GetLngOrLatByAddr("广东省珠海市港湾大道科技五路19号","lng")；
取相应地址的经度，若第二个参数为lat，则取纬度。
效果

获取地理位置-GetLoactionPlace()

根据经度纬度获取地理位置。
参数与返回值:
名称
类型
描述
参数1
Decimal
纬度；
参数2
Decimal
经度；
返回值
String
地理位置；
示例及效果：
名称
描述
示例
GetLoactionPlace(22.280539000,113.5719410)
返回值
珠海
效果

获取对象属性-GetProperty()

获取对象属性值。
参数与返回值:
名称
类型
描述
参数1
String
对象；
参数2
String
属性名；
返回值
String
对象的属性值；
示例及效果：
名称
描述
示例
GetProperty("Entity1","name")
返回值
获取对象Entity1的name属性值。
效果

流水号处理-GetSerialNumberFunc ()

根据前缀，取出表里的最大流水号加1后，补齐位数返回字符串。
参数与返回值:
名称
类型
描述
参数1
String
表名；
参数2
String
字段名；
参数3
String
前缀字符串(只用于查询流水号时使用，不包含在返回结果中)；
参数4
String
流水号长度；
参数5
String
补位符(长度必须为1)；
参数6
String
查询语句的like值；
参数7
String
截取流水号的起始位置，下标从0开始(字符串类型)；
参数8
String
是否从左边截取；
参数9
String
是否重用流水号；
返回值
String
返回处理好的流水号；
示例及效果：
名称
描述
示例
代码示例：GetSerialNumberFunc("TableName","ColumnName","20151103--","11","0","0","3","true","true") ；
返回值为：00000000001。
效果

获取构件常量或变量-GetSystemVariable()

获取构建变量或者构建常量，如无该构件变量时，就取构件常量。
参数与返回值:
名称
类型
描述
参数1
String
构建变量或者常量名；
返回值
indefinite
返回构建变量或者构建常量；不定类型，由参数1决定。
示例及效果：
名称
描述
示例
GetSystemVariable(BR_IN_PARENT.arg1)
返回值
"EEEE"
效果

过滤表中数据-GetTableData()

根据表名字段名以及过滤条件获取数据,返回获取的结果。
参数与返回值:
名称
类型
描述
参数1
String
表字段名称；
参数2
String
表名称；
参数3
String
过滤条件；
返回值
String
过滤后获取的结果；
[!Tip]
注意：
1、若参数3中的条件值来源变量，则参数3需要用一个变量代替，如：
GetTableData("ColumnName","Table1,BR_VAR_PARENT.cs2)；
其中BR_VAR_PARENT.cs2的值等于：
ConcatStr("ID==",BR_VAR_PARENT.cs2_z)；
2、若BR_VAR_PARENT.cs2_z为字符串，拼接参数3时，还需要加上单引号，如：
ConcatStr("ID==","'",BR_VAR_PARENT.cs2_z,"'")
注：筛选条件中的字符串需要用单引号引起来。
示例及效果：
名称
描述
示例
GetTableData("ColumnName","Table1","ID='3'")
返回值
表Table1中ID=3的行的ColumnName列的值。
效果

获取地图坐标缩放等级-GetZoomLevel()

根据经纬度数据集合，自动计算缩放等级。
参数与返回值:
名称
类型
描述
参数1
String
实体编码（必填），必须带前缀，
实体可以是：
方法输入(BR_IN_PARENT.entityCode)、
方法输出(BR_OUT_PARENT.entityCode)、
方法变量(BR_VAR_PARENT.entityCode)；
参数2
String
经度字段编码（必填）；
参数3
String
纬度字段编码（必填）；
返回值
Integer
地图坐标缩放等级；
示例及效果：
名称
描述
示例
GetZoomLevel("BR_IN_PARENT.locationEntity","lng","lat")
返回值
根据经纬度数据集合，自动计算缩放等级，例如返回缩放等级为6。
效果

检查指定的表是否有数据-HasRecord()

计算数据库表中数据量。
参数与返回值:
名称
类型
描述
参数1
String
数据库表名；
返回值
Integer
数据库表中数据量；
示例及效果：
名称
描述
示例
HasRecord("TableName")
返回值
3
效果

空值处理-IsNull()

检查输入的参数是否为空值,不为空返回原值，为空返回默认值。
参数与返回值:
名称
类型
描述
参数1
Indefinite
被检查的值；不定类型
参数2
String
为空时的缺省值；
返回值
Indefinite
返回参数的数据类型；
示例及效果：
名称
描述
示例
IsNull(arg,defaultVal)；
第一个参数不为空直接返回第一个参数,为空时返回默认值。
效果

空值空字符串处理-IsNullOrEmptyFunc()

判断参数是否为空或0长度字符串,返回 true 或者 false。
参数与返回值:
名称
类型
描述
参数1
String
被检查的值；
返回值
Indefinite
被检查的值的状态；
示例及效果：
名称
描述
示例
IsNullOrEmptyFunc("")
返回值
true
效果

将实体某个字段拼接成一个字符串返回-ListToStringFunc()

将实体某个字段拼接成一个字符串返回。
参数与返回值:
名称
类型
描述
参数1
String
实体名称。
参数2
String
字段名称；
参数3
String
拼接时的分隔符；
参数4
Boolean
是否去重复。可省略，默认为false，如果参数=true，则去除重复记录。
返回值
String
实体字段拼接的字符串；
示例及效果：
名称
描述
示例
ListToStringFunc("BR_IN_PARENT.aa","code",",",false)
返回值
拼接后的字符串。
效果

输出日志信息-LogFunc()

打日志信息到控制台上。
参数与返回值:
名称
类型
描述
参数1
String
日志信息；
参数2
String
日志类型（"debug","info","warn","error"）；
返回值
Boolean
示例及效果：
名称
描述
示例
LogFunc("aaaa","error")
返回值
true
效果

返回实体字段最大值-MaxColumn()

查询指定实体的字段的最大值并返回。
参数与返回值:
名称
类型
描述
参数1
String
实体名（字符串类型，需要加入前缀)；例如：
BR_IN_PARENT:方法输入实体，
BR_OUT_PARENT：方法输出实体，
BR_VAR_PARENT：方法变量实体；
参数2
String
字段名称；
返回值
Number
实体的字段的最大值；
示例及效果：
名称
描述
示例
MaxColumn("EntityCode","ColumnCode")
返回值
实体"EntityName"的"ColumnName"字段的最大值。
效果

MD5加密-MD5Encrypt()

对字符串进行加密，加密算法为MD5+BASE64算法。
参数与返回值:
名称
类型
描述
参数1
String
需要加密的字符串；
返回值
String
加密后的字符串；
示例及效果：
名称
描述
示例
MD5Encrypt("Example")；
返回值加密后的字符串。
效果

utf-8字符集的MD5加密-MD5EncryptByUTF8()

utf-8字符集的MD5加密。
参数与返回值:
名称
类型
描述
参数1
String
需要加密的字符串；
返回值
String
加密后的字符串；
示例及效果：
名称
描述
示例
MD5EncryptByUTF8("同望")
返回值
"wd7VFY1HGgjdEK2kbS7L+w=="
效果

获取实体的某个字段的最小值-MinColumn()

查询指定实体的字段的最小值并返回。
参数与返回值:
名称
类型
描述
参数1
String
实体名(需要加入前缀)； 例如：
BR_IN_PARENT:方法输入实体，
BR_OUT_PARENT：方法输出实体，
BR_VAR_PARENT：方法变量实体；
参数2
String
字段名称；
返回值
Number
实体的字段的最小值；
示例及效果：
名称
描述
示例
MinColumn("BR_IN_PARENT.student","grade")
返回值
方法输入实体"student"的"grade"字段的最小值。
效果

产生空值-Null()

产生空值。可在加载规则查询条件中使用，令查询条件失效。
参数与返回值:
名称
类型
描述
参数
无参数；
返回值
Null
Null值；
示例及效果：
名称
描述
示例
Null()
返回值
Null
效果

编码字符串累加-NumberCodeAdd()

对数值型的字符串进行数值加减操作，并依照原格式返回字符串。
参数与返回值:
名称
类型
描述
参数1
String
能转换成数值的编码字符串(仅支持正整数的字符串)；
参数2
Integer
累加的数值(整型)；
返回值
String
运算结果；返回值长度由参数1决定，补前导零，相加值小于零，结果将为零。
示例及效果：
名称
描述
示例
NumberCodeAdd("0010203",-3)
返回值
"0010200"
效果

作废流水号-RecyclingSequenceNumber()

作废流水号。
参数与返回值:
名称
类型
描述
参数1
String
流水号种子。最长128位字符串，建议64位或者更短；
参数2
Integer
需要废弃的流水号；
返回值
无返回值；
示例及效果：
名称
描述
示例
RecyclingSequenceNumber("123456", 89)
效果

标准MD5加密-StandardMD5Encrypt()

对字符串进行标准MD5加密。
参数与返回值:
名称
类型
描述
参数1
String
需要加密的字符串(必填)；
参数2
String
加密的位数(选填，有16位和32位两种类型，默认为32)；
参数3
String
输出的大小写(选填，有"big"和"small"两种类型，默认为big)；
返回值
String
加密后的字符串；
示例及效果：
名称
描述
示例
StandardMD5Encrypt("123456","16","big")
返回值
"49BA59ABBE56E057"
效果

计算实体字段的总和-TotalColumnFunc()

计算实体某个字段的总和。
参数与返回值:
名称
类型
描述
参数1
String
活动集实体；
参数2
String
计算总和的字段名称；
返回值
Number
总和;
示例及效果：
名称
描述
示例
otalColumnFunc("BR_IN_PARENT.xiaoshu","price")
返回值
实体的price字段的汇总值。
效果

树数据向根节点汇总-TreeDataUpwardCollect()

树数据根据权重向根节点汇总。
参数与返回值:
名称
类型
描述
参数1
String
实体编码;
方法输入实体（BR_IN_PARENT.entityCode）、
方法变量实体（BR_VAR_PARENT.entityCode）、
方法输出实体（BR_OUT_PARENT.entityCode）；
参数2
String
统计字段编码集合，如有多个统计字段用,分隔；
参数3
String
权重字段编码；
权重字段编码就是占比。例如计算绩效，为个人评价+领导评价的和， 个人评价占20%，领导评价占80%（20%、80%就是权重）， 个人评价是10分，领导评价是80分， 那么总分就是10*20%+80*80%。
参数4
String
树结构配置项，仅支持层级树结构，
其中pidField为父节点字段，
treeCodeField为层级码字段，
orderField为排序字段，
isLeafField为叶子节点字段，
busiFilterField为树过滤字段；
返回值
无返回值；函数处理完成后，最终汇总结果保存在传入的实体中。
示例及效果：
名称
描述
示例
TreeDataUpwardCollect("BR_IN_PARENT.workEntity","ca,cb,cc","weight","type:1,pidField:PID,treeCodeField:InnerCode,orderField:orderNo,isLeafField:isLeaf,busiFilterField:busCode")
效果

上传文件到ftp-UploadToFtp()

系统文件上传到ftp。
参数与返回值:
名称
类型
描述
参数1
String
文件系统中待上传的文件id；
参数2
String
服务器地址；
参数3
Integer
端口号；
参数4
String
ftp用户名；
参数5
String
ftp密码；
参数6
String
文件存放路径；
参数7
String
文件保存名称；
返回值
无返回值；
示例及效果：
名称
描述
示例
UploadToFtp("6b4a71d391adfbd27313e583dc3bd44b","www.url.com",21,"user","pwd","ftp/test","test.docx")；
效果

三元运算函数-V3If()

先计算条件表达式的结果，再根据结果返回参数值；
结果为true,则返回第1个参数，否则返回第2个参数。
参数与返回值:
名称
类型
描述
参数1
Boolean
条件表达式；
参数2
Indefinite
条件表达式为true时返回值；
参数3
Indefinite
条件表达式为false时返回值；
返回值
Indefinite
参数值；不定类型，由参数2，或者参数3决定。
示例及效果：
名称
描述
示例
V3If(1==1,20,30)
返回值
20
效果

将变量实体转换为二维数组json-VConvertEntityToJsonFunc()

将变量实体转换为二维数组json。
参数与返回值:
名称
类型
描述
参数1
String
要转换json的实体编码；
参数2
Integer
字段编码，指实体中某些字段的值是json格式，需要特殊处理的，多个字段用逗号隔开（此参数可选）。
【注】参数2不要理解成需要转成json的字段。
返回值
String
json字符串；
示例及效果：
名称
描述
示例
VConvertEntityToJsonFunc("BR_IN_PARENT.entityCode","fieldMapping1,fieldMapping2")
返回值
二维数组形式的json。
效果

将变量实体转换为XML字符串-VConvertEntityToXMLFunc()

将变量实体转换为XML字符串。
参数与返回值:
名称
类型
描述
参数1
String
实体编码；
返回值
String
XML字符串；
示例及效果：
名称
描述
示例
VConvertEntityToXMLFunc("BR_IN_PARENT.a","BR_OUT_PARENT.b") 
返回值为：拼装后的XML内容。
效果

二维数组json还原为实体-VRestoreJsonToEntityFunc()

二维数组json还原为实体。
参数与返回值:
名称
类型
描述
参数1
String
由VConvertEntityToJson/VConvertEntityToJsonFunc函数生成的二维数组json信息；
参数2
String
还原数据的目标实体名称；
返回值
无返回值；
示例及效果：
名称
描述
示例
VRestoreJsonToEntityFunc("json内容","BR_IN_PARENT.entityCode")
效果

将XML数据还原为实体数据-VRestoreXMLToEntityFunc()

将XML数据还原为实体数据。
参数与返回值:
名称
类型
描述
参数1
String
由VConvertEntityToXML/VConvertEntityToXMLFunc函数生成的XML信息；
参数2
String
还原数据的来源与目标实体映射关系（选填，整个参数不填时则按原编码完全匹配），映射格式：源1:目标1,源2:目标2（即多个映射采用逗号分隔），
方法输入实体（BR_IN_PARENT.entityCode）、
方法变量实体（BR_VAR_PARENT.entityCode）、
方法输出实体（BR_OUT_PARENT.entityCode）；
备注：目标实体结构（字段和类型）必须和源实体一致，才能还原成功。
无返回值。
返回值
无返回值；
示例及效果：
名称
描述
示例
VRestoreXMLToEntityFunc("xml内容","BR_IN_PARENT.a1:BR_IN_PARENT.a2,BR_IN_PARENT.b1:BR_OUT_PARENT.b2")
示例描述
表示将XML还原后的方法输入a1实体还原到方法输入a2实体，方法输入b1实体还原到方法输出b2实体。
效果