更新时间:2024-11-04 GMT+08:00
分享

管理功能配置

操作场景

在创建数据实体时,应用设计态为其提供了三种基础功能(基础数据服务、安全受控和文件服务),您可以根据实际业务需求添加可选功能或自定义功能。数据实体创建成功后,需要进行功能配置。功能设置用于为数据实体所选功能的所有接口设置使用规则。

前提条件

登录应用设计态

新增功能

  1. 在左侧导航栏中,选择数据模型管理 > 数据实体,进入数据实体页面。
  2. 单击需要添加功能的数据实体编码,进入该数据实体详情页面。
  3. 单击“编辑”,进入编辑状态。
  4. “功能列表”栏中,单击“添加”

    图1 添加功能

  5. 在弹出的窗口中,勾选需要添加的功能,单击“确定”

    表1 功能列表

    类型

    描述

    可选功能

    提供多种可选功能(如权限管理、业务编码生成器、分类管理、数据分类管理、扩展属性、扩展类型、文件夹管理、生命周期管理、树形结构、失效管理、标签管理等)。随父模型选择不同,支持可选的功能不同。

    更多功能详情请参见数据建模引擎功能

    自定义功能

    • 如果您没有可勾选的自定义功能,请参阅创建接口模型进行创建。
    • 如果您已有可勾选的自定义功能,请根据实际需求进行勾选。勾选后,数据实体会继承该接口模型中的属性和关系。

  6. 在弹出的提示框中,单击“我知道了”

    如果勾选的功能中无需配置规则,跳过此步骤。

  7. 单击“保存”
  8. 如果勾选的功能需要配置规则,选择“功能配置”页签,设置如下信息,并“保存”

    图2 功能配置
    表2 功能配置-参数说明

    类型

    参数

    参数说明

    设置规则

    版本服务

    M-V模型实体中Version模型实体(版本对象)的默认功能,用于自定义版本号生成规则。如果在填写基本信息时,“父模型”选择为“VersionObject”,可在“功能配置”中设置“版本服务”的规则。关于M-V模型的内容请参见什么是M-V模型?

    • 流水码:默认为“字母(不包含I、O、Z)”
    • 前缀:可以选择当前实体提供的属性,可以手动输入版本号的前缀,也可以选择分隔符“-”和“_”。
    • 后缀:可以选择分隔符“-”和“_”,可以选择当前实体提供的属性,也可以手动输入版本号的后缀。

    多维版本

    M-V模型实体中Version模型实体(版本对象)的可选功能,用于以不同视角差异化管理同一个数据对象。如果在填写基本信息时,“父模型”选择为“VersionObject”,且“功能列表”添加了“多维视图&多维分支”功能,可在“功能配置”中设置“多维版本”。一个M-V模型实体至多可添加3个多维版本。

    单击“新增”,设置如下信息,定义多维版本。

    • 属性英文名称:填写多维版本的英文名称。
    • 属性中文名称:填写多维版本的中文名称。
    • 参考对象:选择参考对象的目标端(数据实体)。
    • 必填:设置该多维版本是否必填,默认为“是”

    当您发布数据实体时,该实体会根据新增的多维版本自动在基本属性中生成对应的多维版本属性。

    将具有“多维视图&多维分支”功能的M-V模型实体部署至运行态后,您可以通过调用API的方式创建多维版本实例,具体操作请参见创建多维版本的数据实例

    业务编码生成器

    如果在填写基本信息时,“功能列表”添加了“业务编码生成器”,可在“功能配置”中设置“业务编码生成器”的生成规则。

    生成的业务编码由自定义字段1自定义字段2...自定义字段10生成,初始业务编码值可在业务编码生成器的说明中查看。

    说明:
    • 当数据实体的“父模型”为自定义的抽象模型且配置了业务编码生成器功能,数据实体如需使用父模型的业务编码生成规则,可保持默认配置(即“选择绑定属性”为空),即可继承父模型的业务编码生成规则。
    • 如果数据实体更新了父模型,该数据实体支持的业务编码生成器功能会被删除,需重新配置业务编码生成器功能。
    • 选择绑定属性:
      • 如果您没有可使用的属性,请新增一个“类型”“文本”“唯一键”“是”的属性,具体操作可参见管理数据实体属性
      • 如果您已有可使用的属性,请选择需要绑定的属性。
    • 自定义字段:支持如下字段,请根据实际业务需求进行选择。如需设置多个自定义字段,可单击“添加编码段”进行添加,至多只能添加10个自定义字段。如需调整自定义字段排序,将需要调整的自定义字段拖动至所需位置后松开鼠标即可。
      • 常量:输入自定义常量,例如下划线(_)、中横线(-)。
      • 流水码:支持“字母”“数字”“数字+字母”,请根据实际业务进行选择。

        如果“流水码”“字母”:需设置流水码位数和初始流水码,还支持设置需要排除的字母。

        如果“流水码”“数字”:需设置流水码位数和初始流水码。

        如果“流水码”“数字+字母”:需设置流水码位数和初始流水码,还支持设置需要排除的字母。

        其中,“流水码位数”只能为1~9的正整数,“初始流水码”只能为≥0的整数,且初始流水码的长度不能超过流水码位数。

      • 属性:选择当前实体可使用的属性。

        如果当前实体是单实体,不可使用的属性包括:ID属性,“类型”“参考对象”“URL”“文件”“JSON”“枚举”(约束信息的“多值”“是”)、“人员”(约束信息的“多值”“是”)和“文本”(约束信息的“值加密”“是”)的属性。

        如果当前实体是M-V模型,不可使用的属性包括:ID属性,Iteration属性,Master属性,Version属性,Branch属性,“类型”“参考对象”“URL”“文件”“JSON”“枚举”(约束信息的“多值”“是”)、“人员”(约束信息的“多值”“是”)和“文本”(约束信息的“值加密”“是”)的属性。

      • 日期:日期格式,支持“YYYY”“YYMM”“YYMMDD”“YYYYMMDD”。其中,Y表示年,M表示月,D表示日。

    树形结构

    如果在填写基本信息时,“功能列表”添加了“树形结构”,可在“功能配置”中设置“树形结构”的规则。

    指定全路径字段:仅支持选择文本类型或数值类型的属性,为树形节点全路径绑定属性。建议选择ID字段的属性,如将全路径字段选择为非ID字段属性,可能会影响后续对树形结构相关接口的调用。

    配置完成后,在应用运行态创建实体的数据实例时,会根据您填写的父节点信息,自动填充其全路径字段(fullPath,以指定属性构建的从根到叶子节点全路径)、原始全路径字段(rawFullPath,以ID属性构建的从根到叶子节点全路径);更新实体的数据实例时,会根据您填写的父节点信息,自动更新其全路径信息、原始全路径信息,更新方式为非实时性的异步任务(待异步任务执行完成后,刷新路径信息)。

    生命周期管理

    如果在填写基本信息时,“功能列表”添加了“生命周期管理”,可在“功能配置”中设置“生命周期管理”的规则。

    单击“新增”,设置如下信息,用于约束运行态应用下的生命周期管理。如未新增,默认使用“LifecycleTemplate”生命周期模板。

    • 模板属性定义:自定义模板属性的英文名称、中文名称、英文描述和中文描述,选择出厂默认生命周期模板。如果您没有可选择的生命周期模板,可先输入出厂默认生命周期模板名称,待数据实体部署至运行态后,再在运行态创建同名的生命周期模板。具体操作请参见创建生命周期模板
    • 状态属性定义:自定义状态属性的英文名称、中文名称、英文描述和中文描述。

    扩展属性

    如果在填写基本信息时,“模型类型”选择为“实体模型”“功能列表”添加了“扩展属性”,可在“功能配置”中设置“扩展属性”的规则,用于约束应用运行态下该实体可添加的扩展属性类型数量、文本长度等配置。

    单击“新增”,参考如下说明进行设置。

    • 属性类型:用于约束应用运行态下该实体可添加的扩展属性类型。当前支持选择文本、长文本、整型、长整型、浮点型、浮点型(自定义精度)、布尔值、日期、枚举、分类、URL、文件和参考对象类型。
    • 数量:用于约束应用运行态下该实体可添加对应扩展属性类型的数量。
      • 如果应用的数据库类型为mysql,文本、长文本、布尔、日期、分类类型的属性数量不可超过200个,整型、长整型、浮点型、浮点型(自定义精度)类型的属性数量不可超过100个,枚举类型的属性数量不可超过55个,URL类型的属性数量不可超过4个,文件类型的属性数量不可超过183个,参考对象类型的属性数量不可超过45个。
      • 如果应用的数据库类型为postgresql,每种类型的属性数量不可超过200个。
    • 文本长度:表示存储至数据库的文本总长度。如果应用的数据库类型为mysql,其文本总长度不可超过14234字节(Byte)。
    • 是否索引:选择为“是”,系统会在对应实体扩展表中创建普通索引,后续您在应用运行态为该实体添加“索引”“是”的扩展属性时,将自动匹配至有索引的列。同时存在如下约束:
      • 长文本、文件、布尔值、URL不支持选择“索引”“是”
      • 文本、日期、分类和参考对象类型的属性数量不可超过60个,整型、长整型、浮点型和浮点型(自定义精度)类型的总属性数量不可超过60个。
      • 如果应用的数据库类型为postgresql,枚举类型的属性数量不可超过60个。
      • 如果应用的数据库类型为mysql,且“文本长度”的设置大于768个字符,则该配置无效,无需配置。
    • 扩展表名称:默认为“应用英文名称_数据实体英文名称+属性类型+EXAValue”,可自定义。

      例如应用名为DMEApp,数据实体为Parts,属性类型为整型,扩展表名称默认为“DMEApp_PartsNumberEXAValue”

    将具有“扩展属性”功能的实体部署至运行态后,运行态会基于设计态的扩展属性约束规则,自动生成对应的扩展属性值宽表。例如,您在设计态对A实体设置扩展属性类型为数值类型,数量为10个,则在运行态中会自动创建一个“A数值扩展属性值宽表”的实体。

    联合索引管理

    如果在填写基本信息时,“模型类型”选择为“实体模型”,且需要对该实体进行多属性查询时,可在“功能配置”中定义联合索引,提高查询效率。更多关于联合索引的介绍请参见联合索引管理

    API列表

    -

    应用发布后,API列表中的API会注册到APIG,提供调用。

删除功能

  1. 在左侧导航栏中,选择数据模型管理 > 数据实体,进入数据实体页面。
  2. 单击需要删除功能的数据实体编码,进入该数据实体详情页面。
  3. 单击“编辑”,进入编辑状态。
  4. “功能列表”栏,勾选需要删除的功能,单击“删除”

    • 基础功能和从父模型继承的功能不能删除。
    • 如果可选功能中的扩展属性、扩展类型、文件夹管理、生命周期管理和多维视图&多维分支功能已在数据实体中发布,则不能删除。
    图3 删除功能

  5. 在弹出的提示框中,单击“确定”
  6. 单击“保存”

修改功能配置

  1. 在左侧导航栏中,选择数据模型管理 > 数据实体,进入数据实体页面。
  2. 单击需要修改功能规则的数据实体编码,进入该数据实体详情页面。
  3. 选择“功能配置”页签,进入功能配置页面。
  4. 单击“编辑”,进入编辑状态。
  5. 找到需要修改规则的功能,修改相应功能规则,单击“保存”

相关操作

完成数据实体的功能新增、删除、编辑等操作后,您还需要发布数据实体、发布应用生成相应代码包、部署应用,更新后的数据实体才会在应用运行态中生效。相关操作请参见:

相关文档