• Documentation
    • Search documentation
    karat

    +

    K

    API Reference ↗
    Ontology buildingObject and link typesShared propertiesEdit shared properties

    Edit shared properties

    Edit shared property metadata

    You can edit metadata for a shared property by first selecting the shared property to edit from the Shared property page of the Ontology Manager.

    Edit shared property metadata

    Because shared properties can be used on multiple object types across the Ontology, it is possible for users with Ontology Editor permissions on a shared property to not have Ontology Viewer permissions on all object types where the shared property is used. Therefore, breaking edits to shared properties, such as a change of base type, will throw an error if doing so would break any object types, whether visible or non-visible. This is done to prevent inadvertent impacts to object types with incompatible schemas. Such edits are permitted when all object types that use the shared property have schemas compatible with the shared property edit.

    The available options for editing shared property metadata are clustered into four different tabs: General, Display, Interaction, and Details. These tabs contain the following configurations:

    • 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.
    • 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.

    Additionally, you can view the object types that use this shared property on the Usage tab and update the permissions on the shared property on the Permissions tab.

    Delete a shared property

    To delete a shared property, complete the following steps:

    1. Navigate to the Shared property page of the Ontology Manager.
    2. Select one or more shared properties for deletion, then select Delete property.
    Delete shared property
    1. Confirm the delete action in the modal.
    Confirm shared property deletion
    1. Select Save in the upper right.

    When a shared property is deleted, all object types using this shared property will revert to regular properties.