- 27 Nov 2024
- 4 Minutes to read
- Print
- DarkLight
- PDF
Selecting and Configuring a Workflow Event
- Updated on 27 Nov 2024
- 4 Minutes to read
- Print
- DarkLight
- PDF
An Event can come from a third-party system or from inside Axonius when there is a change in your asset pool. Learn about the supported Workflow Events.
A Workflow configured with an Event as an initial trigger runs only on assets that have that event (one asset at a time). When an Event is used in the middle of a workflow, it triggers on the asset from the previous node.
Selecting an Event
To select the Workflow Event
The Trigger Type pane (for a triggering Event) or Event pane (for any other Event node) opens in Cards view, displaying all available Workflow Events according to their categories.
- You can toggle between the List view and Cards view by clicking the Cards icon and Tiles ticons.
Under Select Event Type, you can filter the events by name or category. For details on each event, refer to the Events Library.
- In the Search Event box, type all or part of the event name. The list is automatically filtered as you type. From the search results, select an event.
- In the Category dropdown, select one or more categories, and then select an event from that category that appears in the pane. Available categories are Axonius Utilities, Message Received, Message Responses, User Onboarded or Offboarded, and Incident Created or Updated.
- Click Collapse All to show only the selected event categories.
- Click Expand All to show all available events under the selected event categories.
- Click the Collapse icon to the right of a category to hide its events.
- Click the Expand icon to the right of a category to show its events.
The selected event is displayed in the Event node and shows the asset that the Event retrieves. See an example of a trigger Event node.The following is an example of a non-trigger Event node that retrieves the asset from the previous Event node.
Configure the Workflow Event, if required, and any prerequisite configurations required to use the selected event. Refer to the Events Library for prerequisite and configuration details of each supported Workflow Event.
Enable parsing an Event field into additional fields, if required.
For a non-triggering Event node, set the event's timeout settings, if required.
Parsing an Event Field
It is possible to configure an Event (including the triggering event) to automatically parse one of its string fields during the execution of the Event in the Workflow. A field can be parsed only if the "magic word" AXONIUSPARSER (case-insensitive) precedes the JSON text in the field.
In the case of an Asset value changed Event, you can parse the previous event field value or the current event field value.
- Only String type fields are supported.
- Only single-level JSONs are supported.
For example: {"key1": "value1","key2": "value2"} - Nested JSONs are not supported (although some may be successful).
- There can be no blank space between the curly brackets and the beginning or end of the JSON object.
- If the field does not contain the "magic word" AXONIUSPARSER or the JSON syntax is incorrect, parsing does not take place. In this case, the Workflow continues, and the Run History does not include information about parsing.
- If the field does not contain JSON, parsing fails. In this case, the Workflow continues but the Run History shows that parsing failed.
The Run History drawer lists the data of each Event that was executed in the Workflow, under Data. This includes all fields in the original schema and their values. When parsing is enabled for an Event field, the field name and all its parsed key-value pairs are also listed.
The parsed fields do not appear in the Syntax Helper. However, you can configure a Dynamic Value Statement in an Action with these parsed fields.
To parse an Event field
In the Workflow, click the Event in which you want to parse an Event field.
In the Event pane, toggle on Parse additional fields.
From the Select event field to parse JSON from dropdown, select a field to parse. Only string fields appear in the dropdown, as only they can be parsed.
For the Asset value changed Event, select to parse the current Field Value or the Previous Field Value.
Configuring Event Timeout Settings
The first event in a workflow (i.e., the triggering event) does not have Timeout settings.
By default, Timeout is disabled for an event, so that the event continues to run until you change its settings or delete it.
Configure the amount of time in seconds, days, weeks, or months that the event waits before it times out to enable Timeout settings for an event. You can then do one of the following:
Define a Timeout condition in the Event Conditions node below the Event node, with two branches:
- True branch to take in the Workflow if the Event has timed out after the defined amount of time.
- False branch to take in the Workflow if the Event has not timed out after the defined amount of time.
Do not define a Timeout condition, so that the Workflow run terminates when timeout is reached.
To configure an event's timeout
- In the Event pane, toggle on Add Timeout to enable timeout for the event.
- In After, set the timeout to a specific number of Days, Weeks, or Months. The default is 90 days.
For more information about working with Workflows, refer to the following:
Viewing and Configuring Workflows Events Settings
Selecting and Configuring the Workflow Trigger
Selecting and Configuring a Workflow Event
Configuring an Event Condition
Selecting and Configuring a Workflow Action
Configuring an Action Condition
Deleting and Deactivating/Activating Workflows