elsa-workflows / elsa-workflows/elsa-core

Custom Workflow Instance Attributes

Open
#1,524 1 comment 2 reactions 0 assignees View on GitHub
enhancement triaged
Dominant language
C#
Stars
7.9k
Forks
1.5k
Avg merge
15h 22m
Merged PRs (30d)
114

Description

There are scenarios where it would be useful to be able to associate custom data with a workflow instance and be able to query on this as well.

We could do to this by adding a new property to `WorkflowInstance` called `CustomAttributes`, which would be a simple dictionary of string/object pairs.

To make this searchable, we would also introduce a new table called `WorkflowInstanceAttributes`.

This has the potential to solve the following requests:

- https://github.com/elsa-workflows/elsa-core/discussions/1518

Contributor guide

Open the contributing guide

Research direction

Start by reading the WorkflowInstance model and the related request in discussion 1518. Trace how workflow-instance data is persisted and queried before deciding how the CustomAttributes dictionary and WorkflowInstanceAttributes table should fit. Done means custom values can be associated with instances and queried reliably.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
backend, databases
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.