Skip to content

Latest commit

 

History

History
68 lines (55 loc) · 3.44 KB

EiffelActivityTriggeredEvent.md

File metadata and controls

68 lines (55 loc) · 3.44 KB

EiffelActivityTriggeredEvent (ActT)

The EiffelActivityTriggeredEvent declares that a certain activity - typically a build, test or analysis activity - has been triggered by some factor. Note that this is crucially different from the activity execution having started (as declared by EiffelActivityStartedEvent).

In a situation where execution follows immediately upon triggering these two events should be sent together. Where that is not the case (e.g. due to queuing) the time delta between EiffelActivityTriggeredEvent and EiffelActivityStartedEvent constitutes the queue time.

Data Members

data.name

Type: String
Required: Yes
Description: The name of the activity. Uniqueness is not required or checked, but is useful.

data.categories

Type: String[]
Required: No
Description: Any categorization of the activity. This can be used to group multiple similar activities for analysis and visualization purposes. Example usage is to label the similar but unique build activities of all the components of system X as "System X Component Build" (whereas the name would be e.g. "System X Component Y Build").

data.triggers

Type: Object[]
Required: No
Description: The circumstances triggering the activity.

data.triggers.type

Type: String
Required: Yes
Legal values: MANUAL, EIFFEL_EVENT, SOURCE_CHANGE, TIMER, OTHER
Description: The type of trigger.
MANUAL signifies that the activity was manually triggered.
EIFFEL_EVENT signifies that the activity was triggered by one or more Eiffel events. These events should be represented via CAUSE links.
SOURCE_CHANGE signifies that the activity was triggered as a consequence of a detected source change not represented by Eiffel events.
TIMER signifies that the activity was triggered by a timer.
OTHER signifies any other triggering cause.

data.triggers.description

Type: String
Required: No
Description: A description of the trigger.

data.executionType

Type: String
Required: No
Legal values: MANUAL, SEMI_AUTOMATED, AUTOMATED, OTHER
Description: The type of execution (often related to, but ultimately separate from, data.triggers.type).

Version History

Version Introduced in Changes
1.0.0 edition-bordeaux Initial version.

Examples