Event Definition Groups

What is an Event Definition Group?

Event definition groups allow you to define groups under which individual event keys can be asscociated. The ability to nest the event keys in groups allows for a simplified workflow design allowing you to assign group triggers to tasks instead of requiring a trigger for each event key, thus reducing clutter.

How do Event Definition Groups work within workflows?

For example, lets say you have an event definition group with the group key event-group-1 with 3 event keys (event-key-1, event-key-2, and event-key-3) assigned to the group. You can then add a trigger for this group to a workflow task definition by selecting the group event type and then the group event event-group-1. This would then mean that any of the event keys assigned to this event definition group (event-key-1, event-key-2, and event-key-3) would trigger this task or mutation.

How do you create an Event Definition Group?

To create an event definition group, click the Event Definition Groups tab in the side bar menu and then click the plus (+) icon in the top right of the page. Here you must enter a unique name for the event definition group as well as a unique group key. Please note it is not possible to edit the group key after creation, however you will be able to edit the name. Once you are happy you can click the check button. Your created event definition group will now appear in the list and you will have a few actions available to you to manage this group.

Group Key Formatting Rules

There are a number of formatting rules which are set out which you must follow. They are as follows:

• Only contains lowercase letters, numbers and dashes, e.g. key-123.
• Starts with a letter e.g. 123-key will not be valid but key-123 will be.

Event Definition Group Actions

Editing Group Name

By clicking on the event definition group name you will be able to edit the name value. Please note this must be unique.

Deleting Groups

By clicking the delete icon you will be presented with a confirmation box. Please note that deleting an event definition group won’t remove it from any task triggers within workflow definitions, however any events in the group will no longer trigger those tasks or mutations. For example, before deleting the group, if you had an event definition group with the group key event-group-1 with 3 event keys (event-key-1, event-key-2, and event-key-3) assigned and then you had a workflow definition with a task which is triggered by event-group-1 then any of the event keys (event-key-1, event-key-2, and event-key-3) would trigger this task. However, after deleting the event definition group event-group-1 the event keys (event-key-1, event-key-2, and event-key-3) would no longer trigger the task, however the event definition group key event-group-1 would still remain in the workflows task definition. It should also be noted that because event-group-1 still remains in the workflow task definition that if you were to create a new event definition group with the key event-group-1 then the triggers would become active again and any event keys defined in the new event-group-1 would now trigger the task/mutation.

Exporting and Importing Groups

There is an option to export event definition groups. Clicking the export button will open a json formatted text area where you can copy this value and then import using the import option next to the plus (+) button in the top right of the page. You will need to ensure that when you import the group that the name and groupKey values are both unique.

Editing Group's Event Keys

Here you will be able to select event definitions which you have already defined in the event definitions page using the dropdown, as well as being able to type an event key which you do not have a definition for and then hit enter to add it to the group. Once you have selected/added your event keys to the group you can then click the save button. You also have the option of removing the event keys from the event definition group by clicking the X button on the event key you would like to remove and then clicking save.

Assigning a Group as a Task Trigger

You can then add a trigger against a workflow task definition by selecting the group event type and then the group event e.g. event-group-1. Please visit the Triggers page for more information on triggers.

Assigning a Group as a Task Mutation Trigger

You can then add a mutation trigger against a workflow task definition by selecting the group event type and then the group event e.g. event-group-1. Please visit the Mutations page for more information on mutations.