Start
- Sarah Bigault (Deactivated)
Description
This unit is a Source unit type.
The Start unit generates a single event every time a flow is started. This is, when it is first started, when it is stopped and then restarted, and when it is reset while running.
Events are output through the out port, optionally containing a field with the current time.
Configuration
After dragging this unit into the Flow canvas, double-click it to access its configuration options. The following table describes the configuration options of this unit:
Tab | Field | Description |
|---|---|---|
General | Name | Enter a name for the unit. It must start with a letter, and cannot contain spaces. Only letters, numbers, and underscores are allowed. |
Description | Enter a description detailing the scope of the unit. | |
Time field name | Enter the name of an input event field containing the current time, to be added to the output event. optional |
Input ports
This unit does not have any input ports.
Output ports
Port | Description |
|---|---|
out | Outputs a single event, with the optional field containing the current time. |
Example
Imagine you wish to generate an event containing the current time and send it to an Email sink unit.
You can use the Start unit to emit an event with the current time. To do this, we add a Start unit to fire out an event and link it to the in input port of an Email sink unit to send it to the required recipients.
In order to glean the current time, you must simply set a name for the Time field. By filling in this field, a field with the current time is generated in the output event.
In the Email Sink unit properties, specify the email to send the events to in the to recipients tab.
Download this example
You can try this flow by downloading the following JSON file and uploading it to your domain using the Import option:
