Add a Component Relationship

To add a relationship to a component

  1. Open the Component in Component Management.
  2. Click on the Relationships tab. Two subforms display all the existing relationships. The first subform displays all the relationships where the component you have opened is the Primary component.

    The second subform displays all the relationships where the component you have opened is the Associative component.
  3. Click on Add New Relationships (found at the bottom of the subform)
  4. Type data into the fields. See Relationship Properties for full details of properties relevant to component relationships.
  5. Save.

The next steps

  • Add the Relationship to a form or view.
  • Add the Relationship to a report or graph.

Relationship Properties

These properties need to be set for all relationships. They define the Relationship Type and its behavior.

Property

Settings

Related Component

Select the component lookup icon and choose the component you want to relate the current component to.

Relationship Name (from THIS component)

Name of the relationship field as displayed in the current component.

BI Name (from THIS component)

Name of the relationship as being used in BI reporting.

Note: for new relationships, this field will be auto-populated when the record is saved.

One [THIS component] record can have how many [RELATED component] records?

1 or MANY option

Delete [THIS component] record(s) when [RELATED component] record(s) are deleted?

YES or NO option.

Is [THIS component] record required for [RELATED component]?

YES or NO option.

Relationship Name (from RELATED component)

Name of the relationship field as displayed in the related component.

BI Name (from RELATED component)

Name of the relationship as being used in BI reporting.

Note: for new relationships, this field will be auto-populated when the record is saved.

One [RELATED component] record can have how many [THIS component] records?

1 or MANY option.

Delete [RELATED component] records(s) when [THIS component] record(s) are deleted?

YES or NO option.

Is [RELATED component] record required for [THIS component]?

YES or NO option.

Mark for deletion (Will be deleted on next publish)

Checkbox

Exclude from BI Cubes

Tick this option when you want to exclude this relationship from the BI Cubes.

The relationship however will continue to be included for all other reports.

Relationship ID

System-generated ID number; you cannot change it.

Warning

CAUTION:

When creating 1 - to - Many relationships, it is important from which side this relationship is being created, because this can affect all Views/Reports/Filters/Rules/Security/etc. See previous chapter "Component Relationships"

If you are unsure, please contact Customer Support.

Note

The text within the [Square Brackets] will be replaced with current values once you save the record. As an example:

Current Component: Incident
Related Component: Action

  • Text BEFORE saving the record:
    One [THIS component] record can have how many [RELATED component] records?
  • Text AFTER saving the record:
    One INCIDENT record can have how many ACTION records?

Note

Why are we differentiating between PRIMARY and ASSOCIATIVE relationships?

  • Each relationship has two sides, which we need to distinguish.
  • In technical terms, the PRIMARY relationship is real, whereas the ASSOCIATIVE relationship is 'virtual'.
  • Having two sides is also useful when it comes to configuring Filters and Security.

See Also

Component Relationships

Relation Types and Behavior

Edit Component Relationships

Add a Component Rollup Relationship