# 主数据管理

主数据管理模块是一种关键的企业管理工具，用于集中管理和维护企业中的主数据，通过主数据模型和主数据服务，集中管理和维护企业中的主数据，提高数据一致性、质量和可用性，支持业务决策和提升工作效率。

## 主数据模型

主数据模型是一种用于管理组织中核心数据的框架。它定义了一组标准化的数据实体、属性和关系，用于确保数据的一致性、准确性和完整性。主数据通常是指代组织中最重要、最关键的数据，如客户、产品、供应商等。

![orbit-meta](../images/masterdata/orbit-masterdata-list.png)

### 新建主数据模型

点击新建主数据模型按钮，进入新建页面。

- 填写模型基本信息
  - 模型名称：待创建的主数据模型名称
  - 模型描述：主数据模型的描述说明信息
- 配置模型视图信息
  - 主视图配置：每个模型默认有一个主视图，不可删除
    - 基本信息
      - 视图名称：主视图名称
      - 存储表名：用于存储视图数据，具体存储位置在【运营管理】【系统设置】中配置
      - 视图描述：主视图描述
    - 字段设置
      - 快速导入：可以通过上传文件或者选择已有元数据进行快捷导入
      - 中文名称：字段中文名
      - 英文名称：字段英文名，创建数据库表时使用英文名作为字段名
      - 数据类型：字段数据类型，支持字符型、整型、浮点型、日期型、时间戳、布尔型
      - 长度：数据长度
      - 精度：数据小数位数
      - 是否可为空：字段是否可以为空
      - 是否唯一：字段是否唯一
      - 描述：字段描述
  - 从视图配置：每个模型可以配置任意多个从视图
    - 基本信息
      - 视图名称：从视图名称
      - 存储表名：用于存储视图数据，具体存储位置在【运营管理】【系统设置】中配置
      - 视图描述：从视图描述
    - 字段设置
      - 快速导入：可以通过上传文件或者选择已有元数据进行快捷导入
      - 中文名称：字段中文名
      - 英文名称：字段英文名，创建数据库表时使用英文名作为字段名
      - 数据类型：字段数据类型，支持字符型、整型、浮点型、日期型、时间戳、布尔型
      - 长度：数据长度
      - 精度：数据小数位数
      - 关联主视图字段：关联主视图的字段，用于关联查询
      - 是否可为空：字段是否可以为空
      - 是否唯一：字段是否唯一
      - 描述：字段描述
- 编码配置
  - 字符串：固定字符串作为编码的一部分
  - 时间：时间作为编码的一部分，支持“YYYY”、“YYYYMM”、“YYYYMMDD”、“YYYYMMDDHH”、“YYYYMMDDHHMI”、“YYYYMMDDHHMISS”、“HHMISS”
  - 流水码：流水码作为编码的一部分，支持设置起止号码、长度以及步长，长流水号码小于长度时，会在号码前补0
- 创建完成

### 编辑主数据模型

在主数据模型列表页面，鼠标移至待编辑的主数据模型上，点击编辑按钮即可进入编辑模式，根据业务需要编辑后保存即可。

### 删除主数据模型

删除主数据模型支持批量删除和单独删除，但仅可删除未上线的主数据模型。如果使用主数据模型建立过主数据服务，则需要先手动删除关联服务之后，才能删除主数据模型。

### 主数据模型上下线

在主数据模型列表中，找到待上/下线的主数据模型，鼠标移至主数据模型上，即可看到上/下线按钮，点击上/下线按钮后，填写审批申请，审批通过后主数据模型上/下线才成功。

### 主数据模型权限

主数据模型权限点包括创建、查询、删除、修改四种，其中**创建**权限点仅可在用户中心进行配置，其余权限点除了用户中心可以配置外，单击左侧树形列表中数据字典对象上的权限按钮也可进行配置。

## 主数据服务

主数据服务是将本系统维护的主数据，用对外查询接口的形式，为外部系统和应用程序提供便捷的访问、查询服务。

![orbit-api](../images/masterdata/orbit-masterdata-api-list.png)

### 新建主数据服务

点击“新建主数据服务”按钮，进入新建页面。新建流程需要填写下列内容

- 接口名称
- 接口描述
- 来源主数据模型: 进行数据查询的主数据模型
- 来源主数据视图：从上一步选择的主数据模型下，选择一个视图进行查询
- 取数条件配置方式：提供两种配置方法：可视化配置和自定义SQL方式。其中，可视化配置方式操作简单易用，可以直观并快速地配置好筛选条件、入参出参、排序方式等。自定义SQL方式则需要具备一定的SQL使用知识，通过配置SQL取数模板，以及传参的配置方式，来实现更加灵活多变的查询。

#### 可视化配置

- 输入参数：定义查询接口的请求输入
  - 名称：参数的序号
  - 名称：参数的名称
  - 默认值：如果用户在调用查询接口的时候没有传值，则使用这里记录的默认值查询
  - 类型：参数的数据类型。包括字符型、整形、浮点型、日期型、时间戳、布尔型等
  - 输入参数的单条操作：可以通过每个参数列右侧的操作按钮，进行拖拽排序、单条删除操作。
  - 输入参数的批量操作：可以参数表格通过右上角的“新增”“删除”按钮进行新增和批量删除操作。
- 筛选条件：定义主数据视图里的字段与输入参数进行筛选对比的条件。可以设置多条条件，满足全部条件的数据行才会被查询出来。
  - 左侧参数：通过下拉菜单选择主数据视图里的字段
  - 比较符：左右侧参数做比较的方法。支持的比较符包括大于、小于、等于、为空、包含等关系
  - 右侧参数：通过下拉菜单选择输入参数。如果比较符选择了“为空”这种单侧比较符，则不会出现右侧参数
- 输出参数：定义查询接口输出主数据的哪些字段
  - 序号：参数的序号
  - 名称：参数的名称。默认会使用“来源字段”的名称
  - 来源字段：选择主数据视图的一个列
  - 类型：用来提示来源字段的类型，不能手动修改
- 排序字段：定义如何输出的结果进行怎么样的排序。如果配置了多个字段，则序号越靠前的字段排序优先级越高。如果不配置排序字段，则结果输出不会保证顺序
  - 序号：字段的序号
  - 名称：排序字段的名称，通过下拉菜单选择主数据视图里的一个列
  - 排序方式：支持正序、倒序的排序方式
- 记录数返回上限：限制接口单次查询返回的记录数上限值，可以选择具体的上限数量或“无上限”
- 返回字段数据信息：在数据服务的返回结果内增加"schema"字段，提示返回数据的数据结构和字段类型，例："data":[{"编号":1, "姓名":"小明"}], "schema": [{"index":0, "name": "编号", "dataType": "整型"}, {"index":1, "name": "姓名", "dataType": "字符型"}]”

#### 自定义SQL配置

- 来源主数据模型：取数条件配置方式选择了“自定义SQL配置”后，“来源主数据模型”会变成多选的状态，且“来源主数据视图”项被隐藏，不需选择。这一步选中的所有主数据，都可以在下面SQL取数模板的配置中使用
- SQL语句：编写一个符合SQL标准的模板语句，定义查询范围、筛选方式和输入参数。编辑SQL模板与普通SQL的区别如下：1、每次输入空格，都会弹出一个推荐窗口，将选中的主数据模型内的全部视图和字段展示出来，供快速填写。SQL模板里的表名、列名都不应直接填写原始数据的名称，必须在推荐窗口中选择 2. 在SQL模板中，使用方括号（例如```[input1]```）表示输入参数，设置好输入参数的名称和位置；3. 其他内容，如字段名称、运算语句等照常输入。
- 输入参数：查询接口的请求输入，与SQL模板里填写的输入参数联动
  - 序号：参数的序号
  - 名称：参数的名称
  - 默认值：如果用户在调用查询接口的时候没有传值，则会使用这里记录的默认值查询。进行SQL试运行时也会使用默认值进行查询。
  - 类型：参数的数据类型。包括字符型、整形、浮点型、日期型、时间戳、布尔型等
  - 输入参数的单条操作：可以通过每个参数列右侧的操作按钮，进行拖拽排序、单条删除操作。
  - 输入参数的批量操作：可以参数表格通过右上角的“新增”“删除”按钮进行新增和批量删除操作。
- 试运行：编写完成“SQL语句”和“输入参数”之后，需要进行SQL试运行。试运行期间，会检查主数据相应的数据源的连接情况、SQL模板的语法、输入参数定义正确与否。完成试运行后，还会自动识别出SQL模板产生的输出参数，并回显在下方“输出参数”模块里。
- 输出参数：定义查询接口输出主数据的哪些字段，由“试运行”完成之后生成。可以在自动生成的基础上，调整参数名称、位置顺序，或删除部分不需要的参数。
  - 序号：参数的序号
  - 名称：参数的名称。默认会使用“来源字段”的名称，可以任意修改
  - 来源字段：SQL模板输出的原始字段，不能手动修改
  - 类型：用来提示来源字段的类型，不能手动修改
- 记录数返回上限：限制接口单次查询返回的记录数上限值
- 返回字段数据信息：在数据服务的返回结果内增加"meta"字段，提示返回数据的数据结构和字段类型，例："data":[{"编号":1, "姓名":"小明"}], "meta": [{"index":0, "name": "编号", "dataType": "整型"}, {"index":1, "name": "姓名", "dataType": "字符型"}]”


### 编辑主数据服务

在主数据服务列表页面，鼠标移至未上线、待编辑的主数据服务上，点击编辑按钮即可进入编辑页面，根据业务需要编辑后保存即可。

### 编辑主数据试运行

在主数据服务列表页面，鼠标移至已上线的主数据服务上，点击“试运行”按钮即可进入试运行页面，可以在页面上查看输入输出的参数示例，并且快速发送试运行的请求。

### 删除主数据服务

删除主数据服务支持批量删除和单独删除，但仅可删除未上线的主数据服务。

### 主数据服务上下线

在主数据服务列表中，找到待上/下线的主数据模型，鼠标移至主数据服务上，即可看到上/下线按钮，点击上/下线按钮后，填写审批申请，审批通过后主数据服务上/下线才成功。只有状态为已上线的服务才能正常返回查询结果。

### 主数据服务权限

主数据服务权限点包括创建、查询、删除、修改、执行四种，其中**创建**是系统权限，不绑定具体某个元素，仅可在用户中心进行配置。其余权限点除了用户中心可以配置外，单击左侧树形列表中数据字典对象上的权限按钮也可进行配置。

### 主数据服务调用历史

可以在指定的时间范围之内查看运行的历史记录，包括总数统计、分时段调用趋势图、分用户调用图、调用状态分布图，还可以查看具体每条的调用详情，包括调用时间、调用用户、IP、执行状态、返回时长、数据量、具体请求参数等。