handlers.link_fact_sheet_by_field_handler

class LinkFactSheetByFieldHandler(handlers.eventhandler.EventHandler):

Whenever somebody sets a specific field value, we link this fact sheet to another fact sheet.
If somebody changes the field value to something else, we remove the link to the other fact sheet.

Configuration:
field: Name of the field to be monitored, e.g. hostingType of an Application.
relation: Type of the relation, e.g. relApplicationToITComponent.
mapping: Combinations of the value of the field and the id of the fact sheet that should be linked automatically.

Example: "saas": "abcdefff-1234-abcd-defa-12345678abcd"
Links the ITComponent abff... if the application's hostingType value is set to "saas".

name = 'Link a Fact Sheet based on the value of a field'

description = 'Whenever somebody sets a specific field value, we link this fact sheet to another fact sheet.'

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

supports_initial_sync = True

config_template = {'fs_types': ['Application'], 'field': 'hostingType', 'relation': 'relApplicationToITComponent', 'mapping': {'saas': '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.

def initial_sync_event(self, fs):

Inherited Members

handlers.eventhandler.EventHandler: EventHandler; get_trigger; get_event_types; get_fs_types; get; all; lx_client; 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