Script Apps a.k.a. Intents#

Script applications (also often referred to as intents) are EDA applications powered by Python scripts that are executed as a result of some external event. The simplest event is a user creating or modifying a resource in EDA that triggers a script app to be executed as a reaction to this event.

For example, when a user creates an instance of a Banner resource via any of the EDA interfaces, the script application associated with the Banner resource is triggered to execute its logic - in this case, to configure a banner message on a network device.

There exists three types of scripts:

• config
• state
• conversion

Among these, config and state are the most common.

config scripts¹ are triggered when a resource is created, updated or deleted, and typically result in transactions to targets describing intended configuration.

state scripts² are responsible for alarm generation, subscription and normalization of telemetry data, and publishing updates to the status field of resources, or the creation of state-only resources.

conversion scripts are run when a resource is converted from one version to another, i.e. only during upgrades and resource version translation.