NCV6-参数设置平台技术红皮书

参数设置平台技术红皮书NC-UAP6.0用友NC-UAP2020-05-252/20目录第一章前言...........................................3第二章参数模板注册....................................41.参数模板管理.............................................41.1节点描述及功能...................................................41.2参数属性及其操作说明.............................................5第三章参数设置......................................141.参数设置1.1节点描述及功能..........................................141.2参数属性和基本功能操作说明..............................15第四章API...........................................171．参数平台对外提供的需实现的接口说明......................172．参数平台对外提供的调用接口说明..........................17附录...................................................161.可能遇到的问题及解决方法................................182.多语言资源注册说明......................................193.常见问题................................................194.代码示例203/20第一章前言NC管理软件为了企业在软件应用过程中能够有效达成管理控制的效果，专门开发了参数设置平台。在参数设置平台中，完成了对系统所有参数的定义、值设置、逐级分配（使上级可以控制一些重要参数，不允许下级公司修改，只能够使用）工作。参数设置平台由两部分组成：参数模板管理和参数设置。参数模板管理是程序员注册系统参数的平台，而注册的参数将在参数设置中供实施人员使用。一个参数从定义到被赋值，再到被正常使用需通过以下三步来实现：首先，进行参数模板注册。此过程主要是对参数固定属性值的输入（如序号、组编码、参数名称、参照控件等）、为可选值属性选定值（如组织类型、编辑样式等）、围绕参数值的规范定制（如参数值的类型、默认值、取值范围等）。其次，进行参数设置。该过程主要是对两个值的确定。其一，参数值的设定—依据参数模板注册设定的规范，或通过参照或输入或下拉框选择的形式对参数值进行设定。其二，通过对“是否控制下级”选择设定，确定该参数是否具有控制下级的能力。最后，调用接口方法根据需求获取参数对象。注：参数模板注册与参数设置的关系如下图（以参数为例）：（参数模板注册）(参数设置)由图知，当参数在参数模板注册定义为集团级时，所有的集团都拥有同样一份参数编码为NC001的参数，而在参数设置时可以根据集团的需求作设置。NC001（集团级）NC001（Group1）NC001（Group2）NC001（Group3）4/20第二章参数模板注册1.参数模板管理1.1节点描述及功能参数模版设置提供给各产品组进行参数模版的注册。只有当各产品组的程序员在参数模板设置节点对参数进行注册和设置后，用户（实施人员）才能在参数设置界面看到这些参数。页面进入：开发平台开发配置工具（交易管理模块下）参数模板设置图2-1.1-1图2-1.1-1，左侧红色区域表示参数应用的模块（公共参数、动态企业建模、应用集成、开发平台等），模块意义只是人为的做了一个分类处理便于显示和查；右侧显示了在公共参数模块下注册的参数。5/201.2参数属性和基本功能操作说明a)参数各属性说明：属性名称属性意义及其设置方式要求说明序号手工输入，必输项（默认值为0，若自己输入得是整型）组编码对于互相有制约关系的参数分组，输入代码组名称手工输入，显示名称参数代码不能重复，必输项；直接用于编码参数名称参数显示名称（推荐根据用途来命名）参数值类型日期、逻辑、字符和整型、Double型该四属性一般基于一个组合进行考虑，因其存在互相制约默认值根据选择的参数值类型预置参数的值取值范围指参数输入范围或选择范围编辑样式参数的编辑控件参照控件某一数据来源的参照（如人员档案）组织类型转换模式不转换、支持某种特定转换（例如：公司-库存组织）模式组织类型所选组织的类型参数说明对参数的说明，需手动输入是否组主参数对于某个参数组定义一个主参数,主要服务于有互斥关系存在时情况互斥值与主参数的互斥关系是否显示决定该参数在参数设置界面的显示与否检查类业务组用于检查参数是否可编辑、是否合法默认值是java类针对复杂参数流程配置中很难表示的则调用产品组的参数设置界面参照属性修改控制类为满足业务组需控制参照的要求（比如设定wherepart）6/20参照：(注意：默认不需填，给出也无意义；取值范围可以手动写上与参照控件名相同的值，这样便于在参数设置页面理解)如下：参数值类型默认值取值范围编辑样式整型依参数值类型而定m-n，m为最小值，n为最大值（如0-8）文本框Double型(需设定精度)依参数值类型而定m-n，p,m为最小值，n为最大值,p为指定的精度（如0.0-8.8，8）文本框逻辑自动给出的是否，或者No(视当前语种而定)，可以改成是或Yes不需填写，自动生成当前语种下的样式，如：是/否，Yes/No（强烈建议不要去更改）布尔框CheckBox字符自定无文本框无某一特定参照参照(Example)自定自定（罗列值，但各值之间必须用逗号(英文输入法下的)）选择框日期不用写，因暂时不支持恢复默认值参照7/20组编码：对于互相有制约关系的参数分组，输入代码。互相有制约关系的参数指A参数选择某值，B参数就不能选择该值；或者A参数选择某值，B参数必须输入该值等等这些情况都叫做互相制约。对于不互相制约的参数不用分组。另外还有一种需要进行分组的参数就是复杂参数，定义为默认java类的参数，其整个界面和界面里的参数定义为一组（默认值部分有示例）。默认值：根据选择的参数值类型预置参数的值，主要为了防止实施人员或用户由于误操作设错了某个值无法恢复，所以在这里设了默认值，可以恢复为默认值。默认值为Java类：对于一些复杂参数流程配置中很难表示的则调用产品组的参数设置界面。对于这样的参数在“默认值是Java类”项上打勾，代表选中，那么在“默认值”这一项中输入完整的类名称（包括路径）。在用户的参数设置界面，双击这个参数的“参数值”项即可进入产品组的参数设置界面。对于界面中的其他参数也要在下面输入，但是“是否显示”项置为不显示。【例子】下面是设置个人信息界面，采用界面切入到参数设置中的方式，每个参数如何设置？这个界面将存为4个参数，整个界面存为一个参数比如将参数名设为个人信息，姓名为一个参数，年龄为一个参数，文化为一个参数，一共四个。确定了有这么多参数后我们就要逐个定义了，首先定义个人信息这个参数，选中“默认Java类”项，在默认值中输入完整的类名，是否显示项为显示；然后定义姓名，不选“默认Java类”项，是否显示项为不显示；同理其他两个参数的设置与姓名参数相同。各项值如下图：（编辑样式以文本框为例）组名参数名默认值编辑样式默认java类显示PersonInf个人信息设置nc.ui.pub.para.SysinitUIDialogExample文本框√√PersonInf姓名张三文本框PersonInf年龄20文本框PersonInf文化程度大学文本框这样设置以后，在用户的参数设置界面，只能看到一个参数就是个人信息设置参数，在个人信息姓名：年龄：文化程度：8/20“参数值”下显示“参数对象，请双击”，双击鼠标将弹出产品组的参数设置界面，用户逐项输入即可。组名参数名参数值PersonInf个人信息设置参数对象，请双击参数摸板设置的部分截图图2-1.2-1图2-1.2-2图2-1.2-3双击9/20在进行修改后，点击保存即完成对姓名、年龄、文化程度的修改（注：nc.ui.pub.para.SysinitUIDialogExample）取值范围：指参数输入范围或选择范围。对于整型和DOUBLE型的参数，取值范围的编辑形式是m-n，m为最小值，n为最大值，必需用“-”分割，选择的范围为包含m、n的集合；对于选择框的参数，取值范围的编辑形式为：x,y,z，该参数在进行参数值设置时表现为有x,y,z三个选项的下拉列表，必需用“,”分割。Eg1(输入范围用“-”分割)图2-1.2-4Eg2:（选择范围用“,”分割）图2-1.2-5编辑样式：参数的编辑控件。注意要和参数类型配合。编辑样式中，系统预制了集中参照类型。如果要选择的参照类型，在编辑样式中不存在，可以在“参照”栏目中选择，这里包含所有的系统默认参照。是否组主参数：对于某个参数组定义一个主参数，在设置界面，该项打上勾即为组主参数，一个参数组可以没有主参数。被定义为主参数的参数其编辑样式必须为选择框，取值范围必须输入。互斥值：即与主参数的互斥关系。在一个组中将其他参数的互斥值与主参数值的选项进行比较，互斥值与主参数选项顺序值相同的参数，在用户界面可以编辑，证明与主参数不互斥；互斥值与主参数值选项顺序值不同的参数，在用户界面就不能编辑，证明与主参数互斥。图2-1.2-610/20如图2-1.2-6是否主参数和互斥项作如此设置，那么在参数设置页面，当主参数的参数值为0的时候，从属参数1可以进行修改，而从属参数2的不能进行修改；当主参数的参数值为1的时候，从属参数1不能进行修改，而从属参数2可以进行修改图2-1.2-7图2-1.2-8检查类：在参数模版中只能对参数进行数据校验，但是有的参数还需要业务校验，用以检验这个参数是否能保存，因此我们提供了检查类项，对于这种参数，产品组可以在此处输入检查类的完整路径。该参数在进行编辑后进行保存时，系统会调用该检查类检查输入参数值的合法性，如不合法，则不允许保存。图2-1.2-9作如图2-1.2-9设置（参数模板设置），在检查类一栏手动输入检查类的完整路径Eg：nc.ui.pub.para.TestCheckClass（详细见附录代码说明），该类主要功能是在进行参数设置时，参数值不能设为1(如若不然，将出现以下对话框)图2-1.2-10参照控件：“参照”栏目为V5.3新增功能。可以选择系统默认的参照。如果编辑样式选择了某参照，这里也选择了参照。本栏目下的选择优先。11/20组织类型转换模式：转换模式模式说明与组织类型选择不转换组织类型可选择任何存在于参照的组织类型公司-财务核算账簿公司是财务核算账簿组织所属的公司，组织类型选择只能是两者之一公司—库存组织公司是库存组织所属的公司，组织类型选择只能是两者之一集团—公司集团是公司所属的集团，组织类型选择只能是两者之一集团—采购组织集团是采购组织所属的集团，组织类型选择只能是两者之一…………………………………………………………………………………组织类型：通过参照形式展现支持如下，在修改态双击组织类型单元格即可弹出可供选择的组织类型。（不转换模式）图2-1.2-10指明特定转换模式（公司-财务核算账簿）图2-1.2-1112/20参数说明：对参数的用途，是否允许修改等进行说明参照属性修改控制类：参照栏目中选择了参照，如果产品组要控制参照（系统提供的参照），注册控制类（该类需实现接口IParaEditComponentCtrl）。参照初始化后会调用此类定制参照。是否显示：新增的参数该属性默认一律为显示（如下图，该栏为“”状态）图2-1.2-12当有某些参数有不需要在参数设置页面显示要求时，取消标记（示例链接）b