Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt

...

Include Page
TERMS:Relationship Field
TERMS:Relationship Field

Relationship Overview

Icon

Image Modified

Behavior

VIDEO: How Relationship Behaves

You select Content Items based on the Query Filter of the Field. On assignment, you must provide information about the relationship between the assigned and the original content. The underlying relationship schema defined which relationship information you must provide.  

Pre-Requirement

Before creating a Relationship Field, you must create the schema used for providing information about the relationship. This schema shows up when assigning a Content Item in this field. 

Parent-Child Setup

You can create a schema "Relationship" following a parent-child setup. When you connect your Relationship schema to the Relationship field the parent-child hierarchy is ignored. If you connect the Relationship field to a parent you will only see fields on the parent. If you connect the Relationship field to a child you will only see fields on the child, no propagated fields from the parent.

Batch Actions:

  • Download all related Content Items

  • Add all related Content Items to basket

Related content items can be downloaded all together or placed all together into the basket, for further processing e.g. for editing or sharing. Additionally, each individual item can be downloaded directly or added to the basket.

Image Modified

Limitation

Relationship Fields are not available in Batch Editor! You can not edit a single or multi relationship in the Batch Editor batch edit mode (only in single edit), nor Excel Roundtripping App. You can easily edit them via API. 

Furthermore, Content Items or List Items cannot be sorted based on Relationship fields.  
You cannot add Relationship Fields to filters in the Content Browser or List Browser.  

Important to note is that you can set the search settings (search, index) on the relationship field. However, the Content Browser search only delivers results back for the Content Item, which metadata matches the search. The Content Browser does not deliver related Content Items. 

Display pattern

Picturepark does not use the Display Pattern on the Relationship Schema. 

All relationship information in the view mode of a Content Item is hard-coded and not considering Display Patterns.

Single Relationship

One item can be related. Examples are:

  • one employee image for a person

  • one hero shot for a campaign

  • one logo for a company

Multi Relationship

Multiple items can be related. Examples are:

  • different angles of a product (e.g., front View, top View, side view)

  • featured images in press kits

  • screenshots for FAQ

  • related or featured products

Permissions

Inside a relationship field, the Content Item permissions apply. For example, if you have a user that cannot view a Content Item in a relationship field he will get this view:

Image Modified

However, double-clicking on that field will allow him to view the relationship details - when the layer is visible and thanks to the "view for all" permission on the relationship schema.

Image Modified

Examples

On a Content item for a product, you might have a Relationship field for product photos. In your relationship schema for this field, you might have a single field for "View" that is, in turn, assigned to a List that provides the values Front, Top, and Side.

When a user relates a photo to the product Content Item, the field for "View" would appear, enabling the user to define the context of the related image. When the Content Item was published, this contextual information would be available.

Info

VIDEO: How to use the Relationship field for storing different product views. 

Another valid approach is to use the Relationship field to relate creative files. Wether you are linking the zip package or individual files is up to you. 

Info

VIDEO: How to Use Relationship for linking creative files 

In addition, your relationship schema could include fields for Caption or any other context information about the related content.

Relationship Value Handling

IL:_Query Field is EmptyIL:_Query Field is Empty Include PageIL:_Query Multi Schema FieldsIL:_Query Multi Schema Fields Include PageIL:_Query for _refId or _targetIdIL:_Query for _refId or _targetId

Use in Display Pattern

Include PageIL:_DP RelationshipIL:_DP Relationship

Picturepark Setup Example

Layer: Corporate Information (ID: CorporateInformation)

Field: Corporate Logo (ID: corporateLogo)

Fieldpath

corporateInformation.corporateLogo

Advanced search for field

_exists_:corporateInformation.corporateLogo

  • Finds all Content Items with a Logo assigned in the Relationship Field "Corporate Logo."

Include PageIL:_Query Field ExistsIL:_Query Field Exists

Advanced search for the field value

Include Page

Use in Display Pattern

Filter by label (Content by label)
showLabelsfalse
excerptTypesimple
cqllabel = "display-pattern" and label = "relationship"

Returned field value options

Single:

  • targetId (related item)

  • targetDocType (type of related item e.g. content)

  • relationType (Id of the relation selected)

  • sourceDocType (original item)

  • Field Id from relationship schema

  • Value in field


    Multi: Array

  • targetId (related item)

  • targetDocType (type of related item e.g. content)

  • relationType (Id of the relation selected)

  • sourceDocType (original item)

  • Field Id from relationship schema

  • Value in field

Returned field value

The field itself does not return values. You must access the individual values per option (e.g., data.corporateInformation.corporateLogo.mediaType)

Specific field value in single: data.LAYER.FIELDID._targetId
Specific field value in multi: data.LAYER.FIELDID[0]._targetId

Relationship Field Settings

Name

Include Page
IL
TERMS:
_Field
Name
IL
TERMS:
_Field
Name

ID

Include Page
IL
TERMS:
_
Field ID
IL
TERMS:
_
Field ID

Single item relationship

Allowing one or multiple data entries into the Relationship Field. You cannot change this setting once saved.

Relationship name

The name of the relationship you create when assigning a Content Item. 

Relation ID

Constructed from the name by removing spaces and special characters. 

This setting is relationType.

Relationship type

The type of items you can assign in the Relationship Field. Currently limited to Content Items only.

This setting is the targetDocType.

Relation

The underlying schema used to insert information about the relation e.g., a schema with two fields for legend title and description, which you must fill out when relating a hero shot.

An empty relationship schema can be used to relate content to each other without providing further information about the related content. The relationship schema can be extended at a later stage if needed.

Item filter

Limit the Content Items available for selection by using a filter e.g., only show logos.

Minimum

Only whole numbers (integers) are supported. By adding a minimum value, you set the field required.

Maximum

Setting the maximum value to one turns a multi-item relationship to a single item relationship; however, we recommend to choose a single item relationship instead.

Required

This allows ensuring that at least one item is always related e.g. for press kits the hero shot or the logo. The minimum value fulfills the same purpose, but we recommend using the correct required flag for the desired required option. 

Include in filters

Picturepark uses indexing settings from the relation schema.

Keep in mind that Picturepark does not index metadata of the related content e.g. all the Product Information or an assigned Media Type. Only the relationship information given on the assignment of a Content Item is indexed.

Include in search

Keep in mind that Picturepark does not index metadata of the related content e.g., all the Product Information or an assigned Media Type. Only the relationship information given on the assignment of a Content Item is indexed.

Boost value

Include Page
IL
TERMS:
_Field Boost
Boosting
IL
TERMS:
_Field Boost
Boosting