Event types

This is the catalogue of things a rule can listen to. NirmaanOne raises system events itself (a demand goes overdue, a booking is cancelled, a construction stage is achieved); you add custom events to chain one rule after another or to bring in events from your own systems.

Where to find it

Account menu > Settings > Workflows > Event types. The rule editor's Event type hint also points here ("Custom event types are defined on the Event types tab.").

You need the View permission on Workflow Rules. Without it the page shows "No access" and "You do not have permission to view workflow event types. Ask your administrator."

What you see

The page header reads "Named things that can happen to a record. System event types are raised by the engine (demand due soon, booking cancelled…); add custom ones to chain rules or to raise events from your own integrations."

Above the grid you have:

• Search (placeholder "Search by code or name").
• Entity filter ("Any entity").
• Origin filter: System and custom, System only or Custom only.
• Active filter: Active and inactive, Active only or Inactive only.

The grid columns:

Column	What it shows
Code	The event's code, such as BOOKING_CANCELLED. A lock icon marks a system event; a grey reserved badge marks a generic or internal event that rules can't listen to.
Name	The event's name, with its description underneath.
Entity	The kind of record the event is about.
Rules	How many rules listen to the event.
Order	The sort order used in pickers.
Active	An Active or Inactive badge.
(icons)	Edit (or View) and, for custom events, Delete.

The list opens sorted by order. When nothing matches, the grid reads "No event types match".

Every organization starts with the system events. The business ones are: an opportunity's stage changes or it is assigned; an estimate is sent, finalized, submitted for approval, approved, rejected, cancelled or expires; a booking is created or cancelled; possession is offered or handed over; conveyance is registered; a termsheet is issued, accepted, signed, reopened or cancelled; a demand is issued, cancelled or overdue; a payment is received, cleared, bounced or cancelled; a construction stage is commenced, achieved or reopened; a commission is approved or cancelled; and an installment falls due. "Demand overdue (daily)" and "Installment due (daily)" are raised once a day per record. Each entity also has a generic "record created" and "record updated" event, marked reserved: rules react to those through the On Create and On Update triggers instead.

What you can do

New event type

Opens the "New event type" panel, pre-filled with the entity you have filtered on and sort order 100:

• Code (required): capital letters, digits and underscores, unique in your organization (hint "A–Z, digits, _ ; unique in your organization"; placeholder "DEMAND_ESCALATED"). What you type is turned into capitals. It must start with a letter and be at least two characters long. Messages: "Code is required", "Use at most 100 characters", "Use letters, digits and underscores only". A code already in use gives "An event type with this code already exists."; a code the app reserves for its own events gives "This code is reserved for the engine's own event types."
• Name (required, up to 100 characters). Placeholder "Demand escalated".
• Entity (required; "The kind of record the event is raised for."). Message: "Choose an entity".
• Description: "Optional; shown to people picking the event for a rule." Up to 255 characters.
• Sort order (required, 0 to 100000; "Order in pickers"). The list and the pickers sort by it, so a lower number puts the event higher.
• Active (ticked by default): "Inactive event types are hidden from new rules; rules already listening keep working."

Add event type saves it with the message ""<name>" added."; Cancel closes the panel.

• Who: anyone with the Create permission on Workflow Rules. Without it the button isn't shown.

Edit / View

The pencil icon (or the eye icon when you may only view) opens the panel "Edit <name>" (or just "<name>"). Save changes (greyed out until you change something) saves with ""<name>" updated."; Cancel (or Close) leaves it.

• Who: anyone with the Edit permission on Workflow Rules to change; anyone who can see the page to view.
• On a system event the panel shows "A system event type: the engine raises it itself. Only the description, order and active flag can change." Code, Name and Entity are greyed out, and Code and Entity carry the hint "Fixed for system rows".
• On a reserved event it also shows "Reserved: generic record events cannot be used by On Event rules (use On Create / On Update instead)."
• On a custom event that rules or outbox events already refer to, the entity can't change; the save is refused with "Rules listen to this event type. Deactivate it or change those rules first."
• A custom code that is already used gives "An event type with this code already exists." on Code; a code the app reserves for its own events gives "This code is reserved for the engine's own event types."

Delete

The bin icon opens "Delete event type?": "<name> (<code>) will be removed. An event type that rules listen to cannot be deleted; deactivate it or change those rules first." Delete removes it with ""<name>" deleted."

• Who: anyone with the Delete permission on Workflow Rules. The icon isn't shown on system events, which can't be deleted.
• If any rule or outbox event still refers to the event, the dialog shows "Rules listen to this event type. Deactivate it or change those rules first."

Statuses

• Active: offered when building a rule.
• Inactive: hidden from new rules; rules already listening keep working.

Things to know

• System events can't be renamed or deleted because the app raises them by code; only their description, order and active flag are yours to change. Making a system event inactive only hides it from new rules.
• Reserved events are not for On Event rules. The generic "record created" and "record updated" events of every entity power the On Create and On Update triggers, so a rule can't listen to them directly.
• A custom event is how you chain rules. Create the event on the same entity as both rules; in the first rule, set Emits event type under Advanced; in the second, choose the On Event trigger with that event. The chain can go two levels deep (see New rule, "Advanced").
• "Rules listen to this event type" can appear for an event no rule listens to. The check also counts a rule that emits the event, and outbox events of the type that are kept for up to 30 days after they were processed. Wait, or make the event inactive instead.

Related

• Rules
• New rule
• Rule
• Outbox