API Reference toolbox v1.1.0

modules

Modules

Dead-letter message produced when evaluating of raw-topic failed.

Dead-letter message produced when evaluating of raw-topic failed.

Module extends Toolbox.Workflow and abstracts how regular incident behaves.

Module provides functions to generate incident id.

Formerly delayed messages/late events, when jitter around incoming topic is out of threshold.

Altworx message runtime representation.

Generic load topic parser.

Normalizer pipeline helper for generic load topic.

Set of utility functions for use in notification templates.

Functions for working with deterministic (pseudo)randomness in scenarios.

Behaviour module for notification reports.

Report state

Struct produced by scenario representing instruction for runtime.

Instruction to register unit timeout.

Struct representing a unit.

Library for scenario modules.

Provides configuration to a scenario.

Support for helper processes for scenarios.

Behaviour and struct for scenario manifest.

Struct representing incident manifest

Struct representing one column in incident forecast UI widget.

Toolbox for formatting notifications.

Struct representing side effects produced by run. There are several constructor functions to simplify and standardize side effect definition.

Body for Asset output actions

Body for asset attributes patch output action.

Body for Edge output actions

Body for new Incident action

Module defines behaviour used in scenarios as template.

Behaviour used to detect scenario template source files.

Definition of action to be fired from UI.

Toolbox for working with scenario user actions.

A set of utility functions for Enums.

A set of utility functions for Maps.

Utilities for handling configured paths.

Module provides API to define state machine based workflow. Workflow is represented by struct containing all configuration needed to handle state of individual instances of given workflow.

Workflow instance is simple struct which keeps state if individual workflow instances. Workflow updates its status/state via defined callbacks during workflow transitions.

Transitions forms workflow configuration. Struct is used internally - workflow client should not know internal details about transition struct.