跳转至

Create a shared property(创建共享属性)

Create and configure a new shared property from the shared property page in the Ontology Manager application.

To access the page, follow the steps below:

  1. Select the Shared properties menu option in Ontology Manager.

Shared properties page in Ontology Manager

  1. Once on the shared property page, select New shared property at the top right.

Create shared property button

  1. This will open the shared property creation modal, where you can configure the name, description, type, and other metadata to create the shared property.

Create shared property modal

A shared property can be configured with a subset of regular property metadata:

  • Name: The name for the shared property.
  • Description: Explanatory text about the shared property. For example, the description of the start date shared property may be The day the employee or contractor began working.
  • Base type: Indicates the type of values for this property and determines the set of operations available in user applications. For example, the start date property will have base type date. User applications will allow you to configure a timeline widget with this property. Base types are related to the underlying column type and must match the column type in order to be applied on an object type
  • Value formatting: Depending on the base type of the property, numeric formatting, date and time formatting, user ID, and resource ID formatting are available to apply to the property, transforming its raw values into more readable versions in user applications. Learn more about value formatting.
  • Type classes: Additional metadata that are interpreted by user applications. Learn more about type classes.
  • Render hints: Indications to user applications about how to render the property that may be different than most properties of the same base type. Many render hints can be used to impact the performance of reindexes of the object type on which the property is defined. For example, if you do not expect any users to search or sort on the start date property in user applications, you can deselect the searchable and sortable render hints and improve the reindex performance of the Employee object type. Learn more about render hints.
  • Visibility: An indication to user applications for how prominently to display the property. A prominent property will lead applications to show this property first to users. A hidden property will not appear in user applications. By default, the start date property will have normal visibility.

  • To persist the shared property to the Ontology, select Save in the upper right of the Ontology Manager.


中文翻译


创建共享属性

在 Ontology Manager 应用程序的共享属性页面中创建并配置新的共享属性。

要访问该页面,请按照以下步骤操作:

  1. 在 Ontology Manager 中选择 Shared properties(共享属性) 菜单选项。

Ontology Manager 中的共享属性页面

  1. 进入共享属性页面后,点击右上角的 New shared property(新建共享属性)

创建共享属性按钮

  1. 这将打开共享属性创建弹窗,您可以在其中配置名称、描述、类型及其他元数据来创建共享属性。

创建共享属性弹窗

共享属性可以使用常规属性元数据的一个子集进行配置:

  • Name(名称): 共享属性的名称。
  • Description(描述): 关于共享属性的说明性文本。例如,start date(开始日期)共享属性的描述可以是 员工或承包商开始工作的日期
  • Base type(基础类型): 指示此属性的值类型,并决定用户应用程序中可用的操作集。例如,start date 属性的基础类型为 date(日期)。用户应用程序将允许您使用此属性配置时间线组件。基础类型与底层列类型相关,并且必须与列类型匹配才能应用于对象类型。
  • Value formatting(值格式化): 根据属性的基础类型,可对属性应用数字格式化、日期和时间格式化、用户 ID 及资源 ID 格式化,将其原始值转换为用户应用程序中更易读的版本。了解更多关于值格式化的信息。
  • Type classes(类型类): 由用户应用程序解释的附加元数据。了解更多关于类型类的信息。
  • Render hints(渲染提示): 向用户应用程序提供的关于如何渲染属性的指示,可能与大多数同基础类型的属性不同。许多渲染提示可用于影响定义了该属性的对象类型的重新索引性能。例如,如果您不希望用户在应用程序中搜索或排序 start date 属性,可以取消选择 searchable(可搜索)和 sortable(可排序)渲染提示,从而提高 Employee(员工)对象类型的重新索引性能。了解更多关于渲染提示的信息。
  • Visibility(可见性): 向用户应用程序指示属性显示的突出程度。prominent(突出)属性将引导应用程序优先向用户显示此属性。hidden(隐藏)属性不会出现在用户应用程序中。默认情况下,start date 属性的可见性为 normal(正常)。

  • 要将共享属性持久化到 Ontology,请点击 Ontology Manager 右上角的 Save(保存)