handlers.link_fact_sheet_by_tag_handler

class LinkFactSheetByTagHandler(handlers.eventhandler.EventHandler):

Whenever somebody sets a specific tag, we link this fact sheet to another fact sheet.

Configuration:
fs_type: Fact sheet type of the fact sheets to be linked automatically, e.g. ITComponent.
relation: The relation type that will be used for linking.
mapping: Combinations of the tags and the ids of the fact sheets that should be linked automatically.

Examples:

"EAI": {
"*": "abcdefff-1234-abcd-defa-12345678abcd"
}

Links the fact sheet abcd... if any tag in the group EAI is added.

"EAI": {
"LeanIX Team": "abcdefff-1234-abcd-defa-12345678abcd"
}

Links the fact sheet abcd... if the tag "LeanIX Team" in the tag group "EAI" is added.

name = 'Link a Fact Sheet based on tags'

description = 'Whenever somebody assigns a specific tag, we link this fact sheet to another fact sheet.'

conditions = {'event_types': ['FactSheetUpdatedEvent']}

supports_initial_sync = True

config_template = {'fs_types': ['Application'], 'relation': 'relApplicationToITComponent', 'mapping': {'EAI': {'*': 'abcdefff-1234-abcd-defa-12345678abcd'}}}

def data_requirements(self):

Declare the exact fact-sheet data this handler needs, so the webhook event loop (process_event in workspace/views_module.py) can load a single lean FastFactSheet per event instead of the full fact sheet.

Return a dict: { "fields": [], "relations": [], "subscriptions": bool, # True if handle() reads fs["subscriptions"] "tags": bool, # True if handle() reads tags / has_tag() "documents": bool, "acls": bool, "completion": bool, # True if handle() reads fs["completion"] "base_fields": [], # optional; omit/None = full # default base field set. A list restricts the # base scalars to just those (id and type are # always loaded). Advanced opt-in for max speed. } Fields referenced by this handler's trigger are folded in automatically by the event loop (into "fields"), so only declare what handle() itself needs on top of them.

Return None (the default) to signal "requirements cannot be declared statically" - e.g. handlers that exec/eval config-supplied code. The event loop then loads the full fact sheet for that event, so correctness is always preserved. This is a standalone hook (deliberately not tied to the initial_sync_* hooks, which are slated to migrate onto it later).

def handle(self, event, fs, **kwargs):

Called automatically whenever a FactSheetUpdated event comes in via webhook.

Inherited Members

handlers.eventhandler.EventHandler: EventHandler; get_trigger; get_event_types; get_fs_types; get; all; lx_client; initial_sync_event; update_with_uniqueness_check; facet_matches; is_tag_key; SUBSCRIPTION_TYPES; parse_subscription_key; get_mapped_subscriptions; get_notification_users; get_send_email_for_users; get_email_callback; get_due_date