---
url: "https://vueda.dev/v3/reference/api/py/vueda.workflow.checks.md"
title: "workflow.checks"
---

# workflow.checks

## Overview

System checks for the workflow definitions and object states that workflow-enabled models require.

## `check_workflow_definitions` {#check_workflow_definitions}

Report a workflow-enabled model whose definition or object states are missing.

``vueda_workflow.W001`` names a model with no ``Workflow`` definition, and ``vueda_workflow.W003``
one whose workflow has no initial state. ``vueda_workflow.W002`` names a model with objects that
have no ``ObjectState`` row, which is what objects created by the previous release during a deploy
look like until ``backfillworkflowstates`` runs.

Registered with the ``database`` tag, so it runs only when a command names databases, which
``migrate`` does. Both are warnings rather than errors for that reason: an error would stop the
very migration that creates the missing definition and object states.

### Signature {#check_workflow_definitions-signature}

`check_workflow_definitions(app_configs, databases, kwargs)`

#### Parameters {#check_workflow_definitions-parameters}

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| <span id="check_workflow_definitions-param-app_configs">app_configs</span> |  | no | `None` |  |
| <span id="check_workflow_definitions-param-databases">databases</span> |  | no | `None` |  |
| <span id="check_workflow_definitions-param-kwargs">kwargs</span> |  | no |  |  |

### Source {#check_workflow_definitions-source}

`server/vueda/workflow/checks.py:13`

## Source

`server/vueda/workflow/checks.py`