src/app/features/inherited-field/inherited-field-config.ts

Description

Special default value config inherit a field from a related entity (source) and keep it updated on this (target) entity.

Index

Properties

Properties

sourceReferenceEntity
sourceReferenceEntity: string
Type : string
Optional

EntityType of the related source entity from which the value is inherited from

If not defined, the source entity is identified by a field on this (target) entity.

sourceReferenceField
sourceReferenceField: string
Type : string

field ID that holds the reference to the source (parent) entity's ID. This field is either on the current (target) entity (if sourceReferenceEntity is undefined) or on the related entity defined by sourceReferenceEntity.

e.g. if a child's field should be updated based on a school's value then this is the field on the school entity of type "entity", holding the child's entity for the relevant relation and the sourceReferenceEntity is "school".

sourceValueField
sourceValueField: string
Type : string

field ID of the relatedEntity which triggers updates of this value

valueMapping
valueMapping: { }
Type : { }
Optional

Optional Key-Value map defining "when-then" rules to update the value, where keys are values of the relatedEntity's relatedSourceField and mapped values are the new values of this field that get updated automatically.

If not defined, the value is copied unchanged.

export interface DefaultValueConfigInheritedField {
  /**
   * EntityType of the related source entity from which the value is inherited from
   *
   * If not defined, the source entity is identified by a field on this (target) entity.
   */
  sourceReferenceEntity?: string;

  /**
   * field ID that holds the reference to the source (parent) entity's ID.
   * This field is either on the current (target) entity (if sourceReferenceEntity is undefined)
   * or on the related entity defined by sourceReferenceEntity.
   *
   * e.g. if a child's field should be updated based on a school's value then
   * this is the field on the school entity of type "entity", holding the child's entity for the relevant relation
   * and the sourceReferenceEntity is "school".
   */
  sourceReferenceField: string;

  /**
   * field ID of the relatedEntity which triggers updates of this value
   */
  sourceValueField: string;

  /**
   * Optional Key-Value map defining "when-then" rules to update the value, where
   * keys are values of the relatedEntity's relatedSourceField and
   * mapped values are the new values of this field that get updated automatically.
   *
   * If not defined, the value is copied unchanged.
   */
  valueMapping?: { [key: string]: string };
}

results matching ""

    No results matching ""