Importing streams

Importing streams

CE.png

You can import streams into a solution in three main ways, depending on what you want to achieve. If you are just getting started, you can import curated example streams directly from the Example streams page. Each example opens in the Stream editor with annotations that explain how the stream is built and what each function does, so you can explore Usage Engine without designing a stream from scratch.

For your own configurations, you can import streams from JSON in the UI or via the Stream management API. In the UI, you upload or paste a JSON stream definition from the Solutions page. Usage Engine validates the configuration, then lets you either create a new stream or replace an existing one, with support for version tags and descriptions. When a name conflict occurs, the import workflow guides you through choosing whether to import as a new copy or replace the current stream, and it surfaces validation errors and warnings, such as missing functions.

For automated or cross‑environment workflows, you can use the Stream management API to import streams. The import endpoint takes a JSON stream configuration and a target solution, then either creates a new stream or updates an existing one. You can choose how to handle name conflicts (overwrite, create a new stream, or skip) and whether to allow function (node) deletions when replacing a stream. This is useful when moving configurations between environments or integrating stream imports into deployment pipelines, while still using version tags and safely handling stateful functions.


This section has the following subsections: