Skip to content

Publish and unpublish workflows

A workflow is operational and able to analyze documents only if it's published. A published workflow is like a program that runs when requested through the NL Flow API or the test GUI.

To publish a workflow you can use the editor inside the workflow's workspace or the Runtime view of the dashboard.

In the Workflows view of the dashboard you can see which workflows are published by looking at the color of their dot (green means published).

Only published workflows that are linked to an API key can be used via the NL Flow API, while all published workflows can be tested interactively.
API keys are an authorization mechanism: each request submitted to the API must contain—inside a specific header—the API key that has been linked to the workflow.
There can be a many-to-many relationship between published workflows and API keys: the same API key can be linked to more workflows and the same workflow can be linked to more keys. To manage API keys use the Runtime view of the dashboard.

The NL flow runtime is the virtual computer where published workflows are hosted and run. The runtime has a predetermined capacity in terms of CPUs, RAM memory, Javascript processor blocks and number of workflows. Runtime information is displayed in the Runtime Core panel of the Runtime view.

A workflow—new or modified—can be published only if the resources it requires (CPUs, memory, Javascript processor blocks), added to those already allocated to other published workflows, don't exceed the runtime capacity and also the number of allowed workflows is not exceeded.

To unpublish a workflow use the editor or the Workflows view of the dashboard.