Description

The SourceTag component allows you to automatically add a tag to a source.

It must be added in a Node and applies to all sources that are assigned to that Node.

The following types of tags are available:

  • Marker
  • String
  • Double
  • Integer
  • Boolean
  • DynamicEnum

 

This is the SourceTag name which is used for the creation of the tag and not the displayName.

It is therefore advisable not to use a displayName on the SourceTag to avoid confusion.


Implementation

Add a SourceTag in a Node

(warning) The name of the SourceTag will become the name of the tag added to the sources, so it is strongly recommended that the tag name be in the format "nameShortDictionary:TagName" (e.g.: b:area)

(info)  It is possible to define a tag from any dictionary (e.g.: hs:ahu for the Haystack dictionary).

If no dictionary is specified, the tag will be created in the BtibDictionary dictionary (and a b: will thus be added in the sources)

Properties

  • Status: SourceTag status. Can be {ok}, {fault}, {disabled} or {null}. See the corresponding actions.
  • FaultCause: Message that complements the state of the SourceTag (generally used to explain the reason for an initialization failure)
  • Tip: Description of the tag. Used in views (including AssignmentView on the InfoSource)
  • DefValue: The default value of the tag when added to a Node
  • Flags: Adds flags to the tag of each source. Only hidden and readonly are handled.
  • Facets: Adds facets to the tag of each source.

Actions

  • Initialize: Initializes the SourceTag and changes its state to {ok} or {fault}. Creates the tag in the Sources linked to the parent Node if it does not exist
  • Disable: Disables the SourceTag and changes its state to {disabled}. Disables the tag added in the Sources (but keeps the slot, which keeps the tag value). This action is reversible by an initialization.
  • Clean: Clears the SourceTag and changes its state to {null}. Deletes the slot added in the Sources. This action is irreversible and must be performed before permanently deleting the SourceTag.