About Relationships

Relationships associate Objects, Elements, or Tags. These relationships can include all combinations of objects (Object-Tag, Element-Tag, Tag-Tag).

A relationship is defined by:

  • A name
  • An origin type or Tag
    A list of properties for the type identifies the origin of the relationship.
    For Tags, the list of properties must be selected among the common properties of the types sharing the same tag set.
  • A target type or Tag
    A list of properties for the type identifies the target of the relationship. These properties must match the origin properties.
    For Tags, the list must be selected among the common properties of the types sharing the same tag set.

In this example, two relationships are described:

  • An aggregates relationship (system relationship) where:
    • The Object Type ObjectA is origin as well as target.
    • Id1 and Id2 properties are used to identify the target and origin objects.
  • An account relationship (customized relationship) between the ElementA Element Type and the Account Object Type.

System relationships

Seven system relationships are provided to handle the links between the traces issued from the Rule Engine Audit trail.

Relationship Description
Modifies

Modifies from tag: Input, to tag Input.

Links Input-Events before and after an Enrichment-Rule is applied.

Aggregates

Aggregates from: tag Audit, to: tag Audit

Links the event before and after aggregation:

  • Input-Events can be aggregated into one Input-Event.
  • Output-Events can be aggregated into one Output Event.
Transforms

Transforms from: tag Input, to: tag Output

Links an Input-Event to an Output-Event before and after a Transformation-Rule is applied.

Transfers

Transfers from: tag Output, to: tag Input

Links an Output-Event issued from a Rule Engine session to an Input-Event going into a new Rule Engine session.

Rejects

Rejects from: tag Input, to: tag Input

Links an Input-Event to its rejected one when a RuleEngine execution rejects the Input-Event.

Anomaly

Anomaly from: tag Input, to: tag Input

Links an Input-Event to its 'in anomaly' one when a RuleEngine execution detects an anomaly on the Input-Event.

Recycles

Recycles from: tag Input, to: tag Input

Links an Input-Event to a recycled Input-Event when this one is sent from a recycling action in Interplay

Comment System relationship to add or view Comments on a Datastore record (Collection, Object or Element).
Error System relationship to mark Errors on a Datastore record (Collection, Object or Element).

Define customized relationships

You can however define additional types of relationships by creating custom relationship fields using the Designer.

For more detailed information, refer to Define Relationships for Datastore.

Use relationships in queries

You can use relationships to query the Datastore. You can, for instance:

  • Get ElementA instances that are linked to the Account Object Type with an account number property is "123456".
  • Get ObjectA instances that were aggregated and or geographical property is ”Europe”.
  • Get ElementA instances that:
    • Are linked to the Account Object Type and for which the Account number property is ”123456”.
    • Have as container an ObjectA instance that was aggregated and for geographical property is ”Europe”.

Define relationships on groups of types (Tags)

Relationships can also be defined on group of types using Tags.

In this example:

  • The account relationship links the Line Tag Line (or group) to the Account Object Type.
  • The Line group is composed of types that own the Line Tag.
    All the types of this group have a common Accnumber property that identifies the Account to link to.

You can, for instance, define the query: Get all Line where Account.Number = "123456". The Datastore will return all the Lines that are linked to an Account for which the Label property is "counterparty" and such as Line.AccNumber=Account.AccountNumber.

Manage audit trail from different sources

To manage audit trail from AI Suite and others applications, you must define additional relationships to link the default Datastore audit trail and the audit trail from others systems.

The different types must have property types to carry audit trail identifiers and must be identified by a dedicated tag. You must define audit trail relationships using those property types and tags.

For navigation queries, use those new relationships in addition to the system relationships.

 

Related Links