NCV5-自定义技术红皮书(精)

自定义技术红皮书

NC-UAP 5.0

用友NC-UAP

2013-04-15

目录

第一章

前言 ....................................................................................1 第二章

自定义项引用节点展现 ......................................................2 1.

实现方式................................................................................................... 2 2.

需要产品组配合的工作........................................................................... 2 2.1

预制脚本..................................................................................................... 2 2.2

程序中向bd_defused表中插入数据 . ............................................................. 3 第三章

自定义项引用校验 . .............................................................4 1.

V5以前版本自定义项引用的检查的注册机制及其存在的弊端......... 4 1.1

自定义项引用节点修改某个自定义项的引用关系的校验： (4)

1.2

删除校验..................................................................................................... 4 2.

V5中单据或档案自定义项使用了统计型自定义项后的检查分析..... 5 2.1

应用场景..................................................................................................... 5 2.2

解决方案..................................................................................................... 5 3.

总结：需要产品组配合的工作............................................................... 7 3.1

提供预制脚本.............................................................................................. 7 3.2

删除以前版本中在bd_ref_relation表中预置的脚本 ...................................... 7 第四章

自定义项使用后的显示 ......................................................8 1.

通用情况................................................................................................... 8 2.

特殊情况和特殊需求............................................................................... 8 3.

工具类设计............................................................................................... 8 4.

工具类使用说明....................................................................................... 9 4.1

卡片界面引用自定义项的显示：.................................................................. 9 4.2

列表界面引用自定义项的显示 ....................................................................10 4.3

管理界面引用自定义项的显示 ....................................................................10 5.

使用举例................................................................................................. 10 6.

特殊情况的处理..................................................................................... 10 6.1

查找自定义项的引用情况 ...........................................................................10 6.2

初始化自定义项 .........................................................................................10 6.3

显示引用了的自定义项...............................................................................11 第五章

自定义项使用后的打印 ....................................................12 1.

统计型自定义项打印涉及的修改......................................................... 12 2.

把统计型自定义项的主键翻译成名称的方法..................................... 12 3.

使用举例................................................................................................. 12 4.

类图......................................................................................................... 13 第六章

自定义项档案的升级API.................................................14 1.

API 介绍 ................................................................................................. 14 2.

本升级方案的前提................................................................................. 14 3.

升级方案................................................................................................. 14 3.1

普通情况的升级 .........................................................................................14 3.2 一张表中保存了两种或多种数据的单据或档案的升级 (15)

3.3 自定义项字段与业务字段不在同一张表的情况下的升级 (15)

第七章

附录 ..................................................................................16 1. 升级接口JAVADOC . . (16)

第一章前言

自定义项管理包括定义自定义项、引用自定义项及自定义项档案定义。主要解决系统业务单据中已有项目不能满足实际需要时，可以在系统中设置自定义项，并在单据中引用。较之以前版本，V5.0从效率和易用性上有比较大的改变，具体体现在如下几个方面：

● 任何档案的自定义项都可以引用基本档案、自定义项档案。例如：存货管理档案的自定义项1可以引用自定义项档案、也可以引用任何基本档案（包括存货管理档案它自己）。

● 档案或单据的自定义项使用后，如果使用的是统计性自定义项，则保存的都是被引用档案的主键。例如：存货的自定义项1引用了客商管理档案，则存货的自定义项1中保存的是客商管理档案的主键。（以前保存的可能是主键、也有可能是名称）。

● 自定义项引用节点的展现方式的改变。

我们提供了一些API 或注册机制以帮助开发人员快速实现上述这些改变。本文的目的是对这些API 或者注册机制进行详细的描述，以供开发人员参考。

第二章自定义项引用节点展现

本章指的是自定项引用节点的界面展现方式的改变，着眼于实现V5的如下新需求：

修改该档案的展现方式。完全列表的方式不便于应用，修改为左边是进行自定义项引用的对象树（都是平级的）（如果可能按照产品模块构造树），右侧是该对象包含的自定义项列表。[需求条目：B05090109][解决版本：V5]

1. 实现方式

为了实现自定义项引用的展现方式，并且“按照产品模块构造树”，决定在

bd_defused表中增加一个字段fun_code，其数据类型是varchar(60。用来存储某功能节点所属模块的功能节点号。

例如：客商档案和存货档案都是数据客户话的基本档案，所以客商和存货的自定义项引用在bd_defused表中的预制数据的fun_code的值都是“1008”（基本档案的功能节点号是1008）

2. 需要产品组配合的工作

2.1 预制脚本

凡是在安装盘中对表bd_defused进行预制数据的脚本都需要修改，添加对该表新加字段fun_code的初始值，其值是功能节点所属模块的功能节点号。

例如：

原预制脚本：

insert into bd_defused(pk_defused,objcode,objname,defnum,freenum,pk_corp,ts,dr

values( 'secent00000000000001','secent',' 结算中心',20,0,null,'2001-09-17

13:57:39',0

修改后预制脚本（由于“结算单位”是属于“基本档案”，其功能节点号是：1008）：

insert into bd_defused (pk_defused, objcode, objname, defnum, freenum, pk_corp, ts, dr , fun_code values( 'secent00000000000001','secent',' 结算中心',20,0,null,'2001-09-17 13:57:39',0,?1008?

2.2 程序中向bd_defused表中插入数据

现在只发现基本档案中的“项目档案”存在此种用法，如果还有其他产品组存在此种用法，请添加新加字段的预制值。

第三章自定义项引用校验

本章讲的自定义项引用的校验主要指如下两方面：

其一，自定义项引用节点修改某个自定义项的引用关系的校验：

例如：客商档案的自定义项1引用了自定义项档案“明族”，并且在某条具体的客商档案数据中的自定项1保存了具体的某个民族（如：汉族），如果在自定项档案中又想把客商档案的自定义1修改为自定义项档案“学历”，这就会在客商档案表中导致错误数据，所以要做此校验。

其二，就是删除校验。

1. V5以前版本自定义项引用的检查的注册机制及其存在的弊端

1.1 自定义项引用节点修改某个自定义项的引用关系的校验：以前版本中不管具体档案或单据中是否真正使用了该引用的自定义项，在自定义项引用节点中都没法修改该单据或档案的自定义项引用。

1.2 删除校验

V5以前采用的是使用向表bd_ref_relation表中注册默认脚本的方式来实现的。

例如：客商管理档案有30个自定义项（def1..def30），按照以前的做法，就往bd_ref_relation表中注册了30条语句，认为被引用表都是bd_defdoc。

这种默认注册机制存在以下弊端：

单据或档案自定义项引用后保存名称

这种情况下，以前的版本没有做引用检查。例如：客商的自定义项1引用了自定义项档案“民族”，某条具体客商记录中的def1保存了“汉族”这个民族自定义项档案内容的名称，则在删除自定义项档案“民族”的档案内容“汉族”时，是检查不到客商的自定义项1已经使用过它的，从而导致删除了不该删的数据。

单据或档案自定义项引用后保存主键

沿用上面的例子：客商的自定义项1引用了自定义项档案“民族”，某条具体客商记录中的def1保存了“汉族”这个民族自定义项档案内容的主键，则在删除自定义项档案“民族”的档案内容“汉族”时，可以通过自定义项引用检查，得知客商的def1已经使用了该自定义项档案内容，不能删除该自定义项档案。

由于向表bd_ref_relation表中注册的信息太多，会导致性能低下

例如：客商管理档案有30个自定义项（def1..def30），按照以前的做法，就往bd_ref_relation表中注册了30条语句，认为被引用表都是bd_defdoc（现在这种认为是错误的）！而在实际情况中，这30个自定义项极为少数的情况能都用上（即使用上也不一定都是统计型的），但是在引用检查时就需要检查30次了。

如果引用的不是自定义档案，而是引用基本档案，则以前没有办法做校验例如：如果客商档案通过自定义的方式引用的存货档案，根据以前的机制，在删除某存货档案时，是没法去校验该存货是否被某个客商档案引用了。

2. V5中单据或档案自定义项使用了统计型自定义项后的检查分析

基于V5自定义项档案部分的最新情况，也为了解决单据或档案的自定项使用了统计型自定义项后引用检查存在的问题（如果引用的是基本档案，则不能检查；检查的时候性能低下）。我们有了如下的解决方案：按需注册正确的引用脚本。

2.1 应用场景

A. 定义一个统计型自定义项“AAAA ”，让他引用“存货管理档案”

B. 在自定义项引用处，让客商管理档案的自定义项1，引用“AAAA ”，此

时在bd_ref_relation表中注册一条信息（如果修改成其他的统计型自定义项，也要相应的修改，如果修改成非统计型自定义项档案，择需要删除

C. 修改统计型自定义项“AAAA ”，让他引用“民族”（自定义项档案），则

修改B 在表bd_ref_relation中插入的注册信息（

如果已经被引用了的统计型自定义项也不能修改了，则不需要做此处理）

2.2 解决方案

为了实现上述引用场景，我们主要需要解决获取“引用表名”、“被引用表名”、“被引用字段名”的问题。

2.2.1 获取引用表名

由于自定义项引用表中，只能知道某个选择的自定义项引用记录是属于哪个

档案的（例如客商管理档案），具体哪个档案有哪几个表并不清楚，所以我们新加一个表：bd_defcsttblnme

我们需要在安装盘中提供这个表的预制数据。需要产品组提供本表的预制脚本。一个档案或单据，可能会牵涉到多个表，例如，供应链单据头，可能牵涉到多个表，则需要在此表中预制多条数据。

2.2.2 获取被引用表名和被引用字段名

可以通过这个自定义项引用的自定义档案所对应的bdinfo 中获取。

2.2.3 由此引起的其他变化

自定义项定义处，统计型的自定义项定义，如果被引用，则不能修改（以前是提示“请谨慎修改！”）；

自定义项引用处，如果引用的是统计型自定义项定义，则判断该统计型自定义项定义是否参照了档案，如果没有，则报错“您引用的是统计型自定义项，请先关联档案后在引用！”（以前没有这种判断）

3. 总结：需要产品组配合的工作

3.1 提供预制脚本

本工作需要产品组做的事只有一件，就是提供表bd_defcsttblnme的预制脚本。这个预制脚本的形式如下（如果checkclassname 字段和fieldclassname 需要预置的话，）：

Insert into bd_defcsttblnme(pk_defcsttblnme, pk_defused, tablename, checkclassname, fieldcl assname, dr, ts values (…BD000000000000000001?, ?

sm000000000000000003?, ?bd_cubasdoc?,0, null, null? 2006-06-08 13:57:39?

3.2 删除以前版本中在bd_ref_relation表中预置的脚本

由自定义项引用引起的一些在表bd_ref_relation中的预制脚本需要删除，这些脚本可以用如下一条语句来找出：

select * from bd_ref_relation where (referencingtablecolumn like 'def_' or referencingtablecolumn like 'def__' and referencedtablename='bd_defdoc'

第四章自定义项使用后的显示

本章介绍利用单据模板开发的单据或者档案使用了自定义项后的显示问题。具体介绍程序员经常使用的API 。

1. 通用情况

对于用单据模板来开发UI 界面的单据（或基本档案）使用自定义项，一般都需要做如下几件事：

● 该单据的自定义项引用是否引用了自定义项定义；

● 如果引用了，根据自定义项定义的数据类型，在界面上显示不同的控件；● 不同的数据类型，分别需要进行如下的处理：

?日期：日期参照

?备注：字符录入框（需要限定可录入长度，为100）

?统计：参照

?数字：数字录入框（需要判断小数位数和录入长度）；

2. 特殊情况和特殊需求

另外，在研究基本档案各个功能节点的自定义项引用情况发现有如下一些比较特殊的情况：

单据模板上显示自定义项一般指的是在卡片界面、列表界面显示自定义项。同时卡片和列表的表头和表体都有可能有自定义项。表头自定义项和表体自定义项都可能来自多个自定义项引用，例如：存货管理档案的表头自定义项来自“存货管理档案”和“存货档案”、客商管理档案的自定义项来自“客商管理档案”和“客商档案”等。

在项目支持过程中，有客户提出这样的需求：存货基本档案的自定义项即时引用了，也不是一定需要显示，只有集团用户登录的时候才需要显示。

3. 工具类设计

针对如上特殊情况和需求，对单据模板使用自定义项的UI ，设计了如下一些工具类（类图）：

4. 工具类使用说明

4.1 卡片界面引用自定义项的显示：

如果是卡片界面需要显示引用的自定义项，则需要在加载界面时插入如下代码：

String [] strDefObjs=new String[] {"结算单位"};

String [] strPrefix=new String[] {"def"};

new

CardDefShowUtil(this.getBillCardPanel(.showDefWhenRef(strDefObjs, strPrefix,true;

如果不想引用就显示, 而是根据单据模板自定义项的设置情况进行显示，可以自己实现显示策略：实现接口IDefShowStrategy impl (如果仅仅是根据单据模板原

自定义项的显示情况来判断是否显示，可以使用该默认实现：

nc.ui.trade.bill.DefaultDefShowStrategyByBillItem ，得到具体实现的实例impl ，然后用如下方式调用：

new

CardDefShowUtil(this.getBillCardPanel(,impl.showDefWhenRef(strDefObjs, strPrefix,true;

4.2 列表界面引用自定义项的显示

如果是列表界面，则用ListDefShowUtil ，使用方法与1类似；

4.3 管理界面引用自定义项的显示

如果是管理界面，则用ManageDefShowUtil ，是用方法与1类似；

5. 使用举例

可以参照NC5.0版的如下类：

nc.ui.bd.invdoc.InvMandocUI 存货管理档案

nc.ui.bd.invdoc.InvBasDocUI 存货基本档案

nc.ui.bd.settle.SettleUnitUI 结算单位

nc.ui.bd.settle.SettleCenterUI 结算中心

6. 特殊情况的处理

如果用以上工具不能解决问题，可以按照如下步骤来分解处理自定义项引用后的现实问题。

6.1 查找自定义项的引用情况

例如：

IDef defservice = (IDefNCLocator.getInstance(.lookup(IDef.class.getName(;

nc.vo.bd.def.DefVO[] defs=null;

try {

defs = defservice.queryDefVO("物料生产档案",getUnitCode(; } catch (BusinessException e {

Logger.error(e.getMessage(,e;

}

6.2 初始化自定义项

例如：

getBillListPanel(.getBillListData(.updateItemByDef(defs,"def",true;

getBillCardPanel(.getBillData(.updateItemByDef(defs,"def",true;

6.3 显示引用了的自定义项

例如：

SetDefVisuabled.getInstance(.setDefVisuabled(getBillListPanel(.getBillListData(,de fs,"def",true;

SetDefVisuabled.getInstance(.setDefVisuabled(getBillCardPanel(.getBillData(,defs, "def",true;

如果需要按照策略进行显示，则可以实像接口

nc.ui.trade.bill.IdefShowStrategy ，得到具体实现类的实例impl(如果仅仅是根据单据

模板原自定义项的显示情况来判断是否显示，可以使用该默认实现：

nc.ui.trade.bill.DefaultDefShowStrategyByBillItem ，用如下方式调用：

SetDefVisuabled.getInstance(impl .setDefVisuabled(getBillListPanel(.getBillListDa ta(,defs,"def",true;

SetDefVisuabled.getInstance(impl .setDefVisuabled(getBillCardPanel(.getBillData(, defs,"def",true;

第五章自定义项使用后的打印

统计型自定义项统一存主键后，由于打印模板的自定义项是主键，所以需要通过一定的方式把主键变成名称，以便于打印。

1. 统计型自定义项打印涉及的修改

首先，要修改打印模板（默认自定义项是不打印的）；

其次，修改数据源，如果自定义项存的是主键，把它翻译成名称。

2. 把统计型自定义项的主键翻译成名称的方法

原来的打印，一般都有一个数据源（继承nc.ui.pub.print.IdataSource 的接口），我们就叫orign_datasource，我写了一个装饰类，用来给原来的数据源添加新功能（把统计型自定义项的主键翻译成名称的功能）。

这个装饰类为nc.ui.trade.pub.PrtDefDealedDecorator ，它也继承了

nc.ui.pub.print.IdataSource 接口，同时它把原来的数据源（orign_datasource）通过构造注入，从而达到增加需要的功能的要求。同时，该装饰类的构造还需要两个参数： nc.ui.trade.pub.IcheckIsDef 接口的实现：用来判断某个属性是否是自定义项，有默认实现nc.ui.trade.pub.DefaultCheckIsDef ，认为以def 且长度小于等于5的表达式, 认为以vdef 且长度小于等于6的表达式, 认为以cdef 且长度小于等于6的表达式, 认为以c.def 且长度小于等于7的表达式开头的人为是自定义项；

nc.ui.trade.pub.IgetDefCodeOrName 接口的实现：用来获取统计型自定义项主键对应的名称。有默认实现nc.ui.trade.pub.DefaultGetDefCodeOrName ，那些采用本套自定义项显示机制（参见第四章）的，可以使用默认实现。

3. 使用举例

存货管理档案的打印：

………………………………

………………………………

orign_datasource//获取原来的数据源，认为原数据源变量名为orign_datasource /*为支持自定义打印需要添加的代码——begin*/

IGetDefCodeOrName

getdefcodeOrName=new DefaultGetDefCodeOrName(orign_datasource;//获得IgetDefCodeOrName 接口的实现（此处采用默认实现）

orign_datasource

=new PrtDefDealedDecorator(new DefaultCheckIsDef(,getdefcodeOrName,

orign_datasource;//创建装饰类的实例，此处采用IcheckIsDef 接口的默认实现

/*为支持自定义打印需要添加的代码——end*/

……………………

4. 类图

请参照具体类

第六章自定义项档案的升级API

由于V5各个档案或者单据的统计型自定义项都同意要求保存主键，以前有些档案或者单据的统计型自定义项保存的是名称，这就需要把那些保存名称的档案或单据的统计型自定义项修改为主键。

1. API 介绍

nc.itf.uap.bd.update35to50.IDefDocName2PKForV35Upgrate2V5

详细信息请该类的JavaDoc

2. 本升级方案的前提

要确定一个表的统计型自定义项都是用一个规则进行保存的。也就是说，不能在同一个表中既有保存名称的统计型自定义项，又有保存主键的统计型自定义项，这种情况本方案不支持。

本方案只升级档案或单据本身的统计型自定义项，对那些使用这些自定义项的报表或单据不提供升级。例如，以前可能有些报表要使用统计型自定义项（由于存的是名称，可以直接显示），还有可能其他的单据又引用了统计型自定义项，对这两种情况本方案都不支持，需要单独处理。

要确定的是那些档案的统计自定义项需要升级，即哪些档案或单据的统计型自定义项是保存名称的，对于这样的档案都需要升级。

本升级方案认为每个自定义项档案的档案内容的名称都是不重复的（重复规则是集团+公司）。

3. 升级方案

首先要确定哪些档案或者单据是需要升级的：那些在以前版本中自定义项中保存的是名称的单据或者档案就需要升级。

3.1 普通情况的升级

大多数情况都是一个表只保存一种数据的单据或自定义项，而且自定义项是和一般的业务数据保存在一张表中（固定资产的自定义项是保存在子表中），如果需要区分公司的话，也是根据该表中的公司字段来区分的。

也就是说，在自定义项使用表中(bd_defused，只有一条数据对应于这个表。对于这种情况，可以使用如下工具进行升级：

nc.itf.uap.bd.update35to50.IDefDocName2PKForV35Upgrate2V5

impl=(nc.itf.uap.bd.update35to50.IDefDocName2PKForV35Upgrate2V5NCLocator .getInstance(.lookup(nc.itf.uap.bd.update35to50.IDefDocName2PKForV35Upgrate2V5.c lass.getName(;

impl.upgrateDefDocName2PK("表名"," 公司字段名";

nc.itf.uap.bd.update35to50.IDefDocName2PKForV35Upgrate2V5的详细信息请参考附录1。

注意：如果在自定义项引用表中注册的自定名和实际表中的字段名不一致的话，可以调用impl.upgrateDefDocName2PK("表名"," 公司字段名", 映射关系的HashMap;

3.2 一张表中保存了两种或多种数据的单据或档案的升级

例如：bd_accid表中，即保存了账户档案数据，有保存了内部账户数据；项目管理档案的数据也都保存在一个表中的，但是根据项目类型来引用自定义项的，也就是说不同的项目类型引用的自定义项档案也可能不一样。对于这种情况需要特殊处理。

目前只发现这两个表有此种情况，已确认不需要升级。

3.3 自定义项字段与业务字段不在同一张表的情况下的升级

固定资产有些单据有200个自定义项，把自定义项保存在一个子表中的。现已确定，固定资产不需要升级！

第七章附录

1. 升级接口JAVADOC