BPMN Process Validation and Deployment

Overview

Before a BPMN process is deployed in Pantarey for production use, it goes through two central steps: Validation and Deployment. Validation checks model correctness, while deployment publishes the executable version.

In Brief

The process is modeled, validated, and deployed. A new version is created that is immediately available to authorized users. Deployment settings control how running process instances are handled during model updates.

Why This Is Helpful

Through systematic validation and controlled deployment, errors are detected early and running processes remain stable even during changes.

Video (YouTube)

▶️Open video on YouTube

Benefits

✅ Validation: Errors are detected before deployment and can be corrected.
🚀 Versioning: Each deployment creates a new version with comment and timestamp.
🔄 Continuity: Running process instances are seamlessly continued depending on the setting.
📋 Traceability: Deployment comments document changes over time.

Deploying Processes

Performing Deployment

The desired process is opened in the Process Designer.
Deploy is selected.
A meaningful comment is entered (e.g., "Initial version" or "Added approval step").
If necessary, deployment settings are adjusted (see next section).
The deployment is confirmed.

Note

Each deployment creates a new version. The version is automatically incremented and saved with timestamp and user information.

What Happens During Deployment?

The current state of the process is committed.
The published version is immediately available via Overview to authorized users.
Only deployed processes can be started.
Non-deployed changes remain as drafts.

Deployment Settings

Overview

The deployment setting controls how running process instances are handled during a model deployment. This configuration is important to ensure that existing process instances continue to run properly, even when a new BPMN model is deployed.

Options

Two options are available:

1. New Processes Use the Updated Model

Existing processes are automatically switched to the new BPMN model.

Advantages:

Immediate application of changes to all processes.
No parallel model versions in the system.

Disadvantages:

Can cause problems if the model contains significant changes.
Deleted activities or changed structures can interrupt running processes.
Risk of inconsistencies with complex changes.

Attention

This option should only be used for smaller, backward-compatible changes (e.g., text adjustments, additional documentation).

2. Smart Caching (recommended)

Running processes initially remain connected to the original BPMN model and continue to use it for execution. The new model is only used for newly started processes. After some time, running processes will also be executed with the new model.

Advantages:

Maximum stability for running processes.
No interruptions to existing instances.
Gradual transition to the new model.

How It Works:

Running processes use the original model until completion.
New processes automatically start with the updated model.
After a certain time (depending on process runtime), the old model is removed from the cache.
Particularly quickly completed processes typically still use the old model.

Recommendation

Smart Caching provides more stability in most scenarios and is the preferred option for production environments.

Changing Deployment Settings

The process is opened in the Process Designer.
The desired option is selected in the deployment dialog.
The setting takes effect with the next deployment.

Best Practices

Deployment Comments

Meaningful comments are used (not just "Update" or "Change").
Examples: "Added approval step for managers", "Updated email template", "Fixed bug #42".
For breaking changes, a corresponding note is included in the comment.

Deployment Strategy

Small Changes: Frequent deployment with clear comments.
Large Changes: Test in test environment first, then deploy with Smart Caching.
Breaking Changes: Ensure no critical processes are running before deployment.

Version Control

Important versions are documented (e.g., "v1.0 – Initial release").
The current model is exported before major changes (backup).
Version numbers are referenced in deployment comments.

Testing

Changes are tested in a test environment.
Critical processes are monitored after deployment.
In case of problems, the previous version is rolled back (by redeploying the old version).

Troubleshooting

Deployment Fails

Cause: Validation errors in the model

Solution:

Validation errors in the Process Designer are checked (red markings).
Errors are fixed (e.g., missing connections, invalid expressions).
The deployment is retried.

Running Processes Abort After Deployment

Cause: Setting "New processes use the updated model" with breaking changes

Solution:

Switch to Smart Caching.
The model is adjusted to be backward compatible.
If necessary, the previous version is redeployed.
Affected processes are manually restarted.

Changes Are Not Visible

Cause: Browser cache or process has not been restarted

Solution:

Browser cache is cleared (Ctrl+F5).
Process is stopped and restarted.
Deployment details are checked to verify the correct version is active.

Old Version Is Still Being Used

Cause: Smart Caching active – running processes use the old model

Solution:

This is normal behavior with Smart Caching.
New processes already use the new model.
After all running processes complete, the transition is complete.

FAQ – Frequently Asked Questions About Validation and Deployment

Can a deployment be undone?
Yes. The previous version is opened and redeployed. This creates a new version with the old state.

How many versions are stored?
All versions are stored permanently. There is no automatic deletion of old versions.

Can multiple people deploy simultaneously?
No, a mechanism prevents multiple people from interfering with each other. When a user edits a BPMN model, it is locked for others and only displayed in "view" mode.

What happens to running processes during deployment?
It depends on the deployment setting. With Smart Caching, they continue with the old model; with the other option, they are switched to the new model.

Can deployment comments be changed afterward?
No. Deployment comments are immutable and serve traceability.

How long does a deployment take?
Typically a few seconds.

Are permissions affected by deployment?
No. Permissions are managed independently of deployment.

Can a process be tested without deployment?
No. Processes must be deployed to be executable. A separate test environment is recommended for testing. A test mode is currently under development.

Technical Details (for Administrators)

Versioning

Versions are automatically incremented (1, 2, 3, ...).
Each version contains timestamp, user, and comment.
Old versions remain in the system and can be restored.

Performance

Deployments are optimized for fast execution.
Smart Caching uses server-side caching mechanisms.
Old models are automatically removed from the cache when no processes access them anymore.

Permissions

Deployment operations require the role Create processes or admin.