Concepts
Understanding these core concepts will give you the mental model for everything in the workflow engine. They are ordered from most fundamental to most advanced.
Key Terms at a Glance
| Term | Quick Definition |
|---|---|
| Workflow | A YAML definition describing a sequence of automation steps |
| Function Block | A versioned, reusable unit of execution (e.g., "read config", "push template") |
| Blackboard | The shared job queue between the engine and workers |
| Context | Runtime data available during execution (devices, parameters, step results) |
| Seed Entity | The entity type a workflow operates on (device, interface, group, or global) |
| Acquire | The phase where the engine gathers entity data from the CMS |
| Pure | A function block with no side effects -- safe to discard |
| Idempotent | A function block safe to re-run -- same input always gives same result |
| CMS | Content Management System (neops-core) -- manages devices, groups, facts, credentials |
| JMESPath | Query language for JSON, used in parameter interpolation ({{ ... }}) |
See the full Glossary for all terms.
-
Workflows
What a workflow is, how it is structured, and what it can express.
-
Function Blocks
The reusable execution units that workflows compose.
-
Context
How entity data flows into and through a workflow execution.
-
Transactions
How the engine treats workflows like database transactions.
-
Execution Model
How the engine traverses steps, creates jobs, and processes results.
-
The Blackboard
The shared job queue that connects the engine to workers.