handlers.enforce_naming_convention_handler

class EnforceNamingConventionHandler(handlers.eventhandler.EventHandler):

This automation enforces naming conventions, e.g. for Interface fact sheets. Example:

{
    t.b.d.
}

name = 'Interface: Automatic Naming Convention'

description = 'Automatically determines an interface name based on consumers, providers, data flow direction etc.'

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

supports_initial_sync = True

config_template = {'fs_types': ['Interface', 'Application'], 'name_template': '{provider} {direction} {consumer} - {action} {information_object}', 'initial_suffix': '[Name will be generated automatically after all mandatory fields are filled]', 'all_mandatory_status_field': 'allMandatoryStatus', 'definitions': {'provider': "fs.provider_applications()[0]['displayName']", 'consumer': "'Any' if len(fs.consumer_applications()) > 1 else fs.consumer_applications()[0]['displayName']", 'direction': "{'incoming': 'from', 'outgoing': 'to', 'biDirectional': 'to/from'}.get(fs['data_flow_direction'])", 'action': "{'incoming': 'Consume', 'outgoing': 'Provide', 'biDirectional': 'Provide/Consume'}.get(fs['data_flow_direction'])", 'information_object': "fs['description']"}}

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 update_name(self, fs):

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