Relation members

Note

To configure Content Hub, you must either be a superuser or have the necessary permissions granted to you through user group policies.

The Sitecore Content Hub data model (that is, the schema) is made up of entity definitions (for example, M.Asset, M.PCM.Product, M.Project.Task, and so on). Each entity definition is made up of members that contain various properties and relations. When you create a relation member, you are adding a new relation between an entity definition and a non-taxonomy definition.

After you select a data type, you must fill in various other fields related to that type. These fields are divided into several sections.

General information

You can define the following general information for relation members.

Field

Description

Name

Name of the member. This is a mandatory field.

Role

The role of the relationship between this definition and the related definition. This is a read-only field.

Label

User interface label of the member.

Help text

Visual hint displayed under the field in edit mode.

Associated label

User interface label of the related entity.

Associated definition

Name of the definition this entity is based on. This is a mandatory field.

Cardinality

The degree of relationship between two entities, expressed in the form Term1ToTerm2, where Term1 is the number of occurrences of the first entity, and Term2 is the number of occurrences of the second entity. Options are:

Degree of relationship in the form of Term1ToTerm2 where Term1 represents the number of occurrences of the first entity that are associated to the number of occurrences of the second entity represented by Term2. Options are:

  • OneToMany - One parent to many children

  • OneToOne - One parent to one child

  • ManyToMany - Many parents to many children

This is a mandatory field.

Conditional

A member that has one or more conditions will only be displayed if at least one of those conditions is true. Conditional members appear in details pages, but they do not appear in inline preview, grid, or table views.

Required fields have a red asterisk. Conditional required fields have a red asterisk only if the condition is met. If a triggering field changes, the asterisk is recalculated immediately to reflect the new required status.

Note

If a triggering field makes another field required and that field is in a different member group without a value, the member group will automatically enter edit mode, allowing you to fill in the required field and save the entity.

To add a condition, on the Conditional tab, select a property from the list and click Add. Then, click Add and select the related property. For example, selecting the AssetTypeToAsset property and then selecting the Poster type means this field will be visible only if the asset type is a poster.

Required

You can specify that either the parent or the child is required for the relation. If you do this, you can also add validation conditions that determine whether the requirement is enforced:

  • If you add conditional validation, the parent or child becomes mandatory when all the conditions are met.

  • If you don't add conditional validation, the parent or child is always mandatory.

To add a validation condition, click  Add filter . In the Parent conditional validation section, select either Property or Relation for filter type, select a field name (for example, AssetTypeToAsset), an operator (anyall, or none) and then click  Add. For example, setting AssetTypeToAsset to Product Asset means this field will be mandatory if the asset type is a product asset.

Tip

To find empty required fields, use the Validation component.

Advanced

You can specify advanced settings for relations, including navigation and security settings.

Tip

Content Hub information architects and those in technical roles can find more detailed information about path relations in the Accelerate Cookbook for Content Hub, a collection of recipes that provides information to help you successfully set up, configure, and implement Content Hub.

Field

Description

Path relation

Creates a related path on the child side of the relation. This allows for path expansion of hierarchical entities on a related entity.

Is path hierarchy relation

Connects path-enabled definitions and hierarchical definitions, creating a path hierarchy. This is usually set on self-relations.

Path hierarchy score

Score given to the relation marked as IsPathHierarchyRelation. If an entity has multiple parent relations, the paths of that entity are sorted in ascending order according to this score. Unless marked otherwise, the first path is used as a sole entity path when only one is required.

Taxonomy relation

Whether the relation is taken into account when faceting.

Is taxonomy hierarchy relation

The taxonomy hierarchy for entities of this definition. This is usually set on self-relations and is taken into account when faceting. Due to the nature of self-relations, you can have only one taxonomy hierarchy relation per entity definition.

Is rendition relation

Sets the relation as the source of rendition. The main rendition of the entity is always determined by this relation. An entity cannot have more than one relation with this option on.

Content copied

Whether the full-text content is inherited through the relation, letting users search for the child entity based on the full-text content of the parent entity.

Completion copied

Whether auto-completion content is inherited through the relation, making auto-completion content for the parent entity available when searching for the child entity.

Allow navigation

Whether navigation over this relation is allowed using the REST API. This is usually set to false on the parent side of relations, which can contain a large number of children entities.

Inherits security

Defines whether security is inherited at entity level. This is usually used for pages.

Secured

Indicates whether the relation is visible to all users or only to those with sufficient access rights.

Allow updates

Whether the value of this property can be updated using the REST API. This is usually set to false for technical properties.

Nested

Whether this relation is nested, meaning that the ID and properties of the related entities are directly included in the requested entity resource.

Include permissions

Includes the related entity permissions in the entity resource.

Include properties

Lets you include specific properties of the related entity in the entity resource.

Tip

Do not turn on the Allow navigation switch for relations that have a large number of child entities, because this can cause significant performance issues.

Do you have some feedback for us?

If you have suggestions for improving this article,