跳转至

Metadata reference（元数据参考）

An object type is represented in the Ontology by the following metadata:

  • ID: A unique identifier of the object type, primarily used to reference objects of this type when configuring an application. For example, employee may be the ID of the Employee object type.
  • RID: An automatically generated unique identifier for every resource in Foundry. An object type’s RID will be referenced in error messages across the platform.
  • Icon: A picture and color used as a visual identifier of the object type that will appear in user applications when a user views an object of this type. For example, the person icon may be used to depict the Employee object type.
  • Display name: The name shown to anyone accessing an object of this type in user applications. For example, the display name for the Employee object type may be Employee.
  • Plural display name: The name shown to anyone accessing multiple objects of this type in user applications. For example, the plural display name for the Employee object type may be Employees.
  • Description: Explanatory text about the object type that anyone can read in user applications. For example, the description of the Employee object type may be All full-time and part-time employees of Organization X.
  • Groups: A group is a label that helps you categorize your object types. For example, the Employee object type may belong to groups HR and Employee 360.
  • API name: The name used when referring to the object type programmatically in code. For example, the API name of the Employee object type may be Employee. Read more about API names.
  • Visibility: An indication to user applications for how prominently to display the object type. A prominent object type will lead applications to show this object type first to users. A hidden object type will not appear in user applications. By default, the Employee object type will have visibility normal.
  • Status: A signal to users and other Ontology builders about where in the development process the object type stands. It can be active, experimental, or deprecated. By default, the Employee object type will have status experimental. Read more about statuses.
  • Index status: The status of the last reindex of the object type and its backing datasources. It can be success, failed, or not started. Read more about index statuses.
  • Writeback: An indication of whether the object type has a writeback dataset generated, and whether allowing end users to make edits to objects of this type is enabled or disabled. Read more about writeback datasets.

Learn more about creating and configuring an object type in the Ontology and about validation requirements for object type metadata.

Learn more about Properties (characteristics of an object type).

中文翻译

元数据参考

对象类型在本体（Ontology）中通过以下元数据表示：

  • ID： 对象类型的唯一标识符，主要用于在配置应用程序时引用该类型的对象。例如，employee 可以是 Employee 对象类型的 ID。
  • RID： Foundry 中每个资源自动生成的唯一标识符。对象类型的 RID 将在平台各处的错误消息中被引用。
  • 图标（Icon）： 用作对象类型视觉标识的图片和颜色，当用户在应用程序中查看该类型的对象时会显示。例如，人物图标可用于表示 Employee 对象类型。
  • 显示名称（Display name）： 用户在应用程序中访问该类型对象时看到的名称。例如，Employee 对象类型的显示名称可以是 Employee。
  • 复数显示名称（Plural display name）： 用户在应用程序中访问多个该类型对象时看到的名称。例如，Employee 对象类型的复数显示名称可以是 Employees。
  • 描述（Description）： 关于对象类型的说明性文本，任何人都可以在应用程序中阅读。例如，Employee 对象类型的描述可以是 Organization X 的所有全职和兼职员工。
  • 分组（Groups）： 分组是一种标签，帮助您对对象类型进行分类。例如，Employee 对象类型可能属于 HR 和 Employee 360 分组。
  • API 名称（API name）： 在代码中以编程方式引用对象类型时使用的名称。例如，Employee 对象类型的 API 名称可以是 Employee。了解更多关于 API 名称 的信息。
  • 可见性（Visibility）： 向用户应用程序指示对象类型的显示优先级。prominent 对象类型将引导应用程序优先向用户展示该类型。hidden 对象类型将不会出现在用户应用程序中。默认情况下，Employee 对象类型的可见性为 normal。
  • 状态（Status）： 向用户和其他本体构建者指示对象类型在开发流程中所处的阶段。可以是 active、experimental 或 deprecated。默认情况下，Employee 对象类型的状态为 experimental。了解更多关于 状态 的信息。
  • 索引状态（Index status）： 对象类型及其支持数据源的最后一次重新索引的状态。可以是 success、failed 或 not started。了解更多关于 索引状态 的信息。
  • 回写（Writeback）： 指示对象类型是否生成了回写数据集（writeback dataset），以及是否允许最终用户编辑该类型的对象，状态为 enabled 或 disabled。了解更多关于 回写数据集 的信息。

了解更多关于在本体中创建和配置对象类型以及对象类型元数据的验证要求。

了解更多关于属性（对象类型的特征）。