Transaction Rules documentation vs reality #78

New Issue

adam · 2025-12-28T23:25:21+01:00

adam commented

2025-12-28 23:25:21 +01:00

Originally created by @zkutasi on GitHub (Nov 28, 2025).

Maybe I am missing something, but I would like to try to add some tules to automatically categorize things for example...
I am trying to follow the Wiki: https://github.com/eitchtee/WYGIWYH/wiki/Transaction-Rules
But I do not see the same on the UI.

Adding a new Rule
I see:

Wiki states:
Each rule has the following configuration options:

Name & Description: To identify the rule.
Active: A rule will only run if it's active.
Triggering Events:
    Run on creation: The rule will run when a new transaction is created.
    Run on update: The rule will run when an existing transaction is updated.
    Run on delete: The rule will run when a transaction is deleted.
Sequenced: A sequenced rule will update its [variables](https://github.com/eitchtee/WYGIWYH/wiki/Transaction-Rules#available-variables) between each rule execution, meaning that the next action will have access to the values of the previous action instead of the originating transaction.
Trigger: A condition that must evaluate to True for the rule's actions to be executed.

I would suggest documenting the fields in order...
What is "if..." on the UI? I should write there my rule text? Is it the same as Trigger in the Wiki?
What is Order?
Where is the Sequenced input text/switch?

I somehow create one... I can view/delete/activate/share... I do not see Edit... but then I see it is inside. Not really intuitive.
In the view panel
I see:

So here, the X I put into the "If..." field, but another field appeared: The "Then", I have not seen before, so I was unable to fill it... or is it like something more clever? I do not find it on the Wiki how this should be done. I cannot edit the actions... so how I can add one?

Originally created by @zkutasi on GitHub (Nov 28, 2025). Maybe I am missing something, but I would like to try to add some tules to automatically categorize things for example... I am trying to follow the Wiki: https://github.com/eitchtee/WYGIWYH/wiki/Transaction-Rules But I do not see the same on the UI. 1. Adding a new Rule I see: <img width="703" height="817" alt="Image" src="https://github.com/user-attachments/assets/7b5eed02-2292-4bb7-a61b-1a869f8ac5d2" /> Wiki states: Each rule has the following configuration options: Name & Description: To identify the rule. Active: A rule will only run if it's active. Triggering Events: Run on creation: The rule will run when a new transaction is created. Run on update: The rule will run when an existing transaction is updated. Run on delete: The rule will run when a transaction is deleted. Sequenced: A sequenced rule will update its [variables](https://github.com/eitchtee/WYGIWYH/wiki/Transaction-Rules#available-variables) between each rule execution, meaning that the next action will have access to the values of the previous action instead of the originating transaction. Trigger: A condition that must evaluate to True for the rule's actions to be executed. - I would suggest documenting the fields in order... - What is "if..." on the UI? I should write there my rule text? Is it the same as Trigger in the Wiki? - What is Order? - Where is the Sequenced input text/switch? 2. I somehow create one... I can view/delete/activate/share... I do not see Edit... but then I see it is inside. Not really intuitive. 3. In the view panel I see: <img width="703" height="508" alt="Image" src="https://github.com/user-attachments/assets/204d35d1-d845-4685-ac57-d34a2406d64a" /> So here, the X I put into the "If..." field, but another field appeared: The "Then", I have not seen before, so I was unable to fill it... or is it like something more clever? I do not find it on the Wiki how this should be done. I cannot edit the actions... so how I can add one?

adam added the documentation label 2025-12-28 23:25:21 +01:00

adam closed this issue

2025-12-28 23:25:22 +01:00

adam commented

2025-12-28 23:25:22 +01:00

@zkutasi commented on GitHub (Nov 28, 2025):

Ohhh I see, on the View Panel, the "Add New" will add a new Action... and there I can see the missing fields:

I suggest then to name the button "Add new Action". The previous discrepancies also apply: naming on the Wiki vs on the UI is very different.

@zkutasi commented on GitHub (Nov 28, 2025): Ohhh I see, on the View Panel, the "Add New" will add a new Action... and there I can see the missing fields: <img width="689" height="581" alt="Image" src="https://github.com/user-attachments/assets/510fa028-3cd0-4f31-ab21-62f214d29a23" /> I suggest then to name the button "Add new Action". The previous discrepancies also apply: naming on the Wiki vs on the UI is very different.

adam commented

2025-12-28 23:25:23 +01:00

@zkutasi commented on GitHub (Nov 28, 2025):

One more question: How can I run a Rule after an import? Like in Outlook for example, if I add a new Rule, there is a button to execute the Rule on an existing folder and then the Rule runs on its own after... I found the Test which is super awesome, but cannot find the execution.

@zkutasi commented on GitHub (Nov 28, 2025): One more question: How can I run a Rule after an import? Like in Outlook for example, if I add a new Rule, there is a button to execute the Rule on an existing folder and then the Rule runs on its own after... I found the Test which is super awesome, but cannot find the execution.

adam commented

2025-12-28 23:25:23 +01:00

@eitchtee commented on GitHub (Nov 28, 2025):

Hey there,

You got it right in the end. You're not the first person getting lost in this, thanks for the suggestion for changing the text, will do.

One more question: How can I run a Rule after an import? Like in Outlook for example, if I add a new Rule, there is a button to execute the Rule on an existing folder and then the Rule runs on its own after... I found the Test which is super awesome, but cannot find the execution.

Transaction Rules are ran for each transaction individually after any of the configured events happen, this includes imports. So, if you configure a rule to run On Create, and import a csv with transactions, it should run for all imported transactions as long as the trigger (the If... part) matches.

This behavior can be changed with the trigger_transaction_rules setting in the Import profile, but it defaults to true if unspecified.

However there isn't a way of running it on previously added transactions. One trick you might do is configure the rule to run "On update" and then use the bulk actions bar to set the transaction to Unpaid, then Paid again, this should trigger the rule. I haven't tried doing this for thousand of transactions at once, but it should be fine, but you might want to temporarily change the TASK_WORKERS=1 variable to a higher number (keep in mind each worker is a CPU thread) so there's more workers processing the transactions concurrently.

@eitchtee commented on GitHub (Nov 28, 2025): Hey there, You got it right in the end. You're not the first person getting lost in this, thanks for the suggestion for changing the text, will do. > One more question: How can I run a Rule after an import? Like in Outlook for example, if I add a new Rule, there is a button to execute the Rule on an existing folder and then the Rule runs on its own after... I found the Test which is super awesome, but cannot find the execution. Transaction Rules are ran for each transaction individually after any of the configured events happen, this includes imports. So, if you configure a rule to run On Create, and import a csv with transactions, it should run for all imported transactions as long as the trigger (the If... part) matches. This behavior can be changed with the `trigger_transaction_rules` [setting ](https://github.com/eitchtee/WYGIWYH/wiki/Import#csv-specific-settings) in the Import profile, but it defaults to true if unspecified. However there isn't a way of running it on previously added transactions. One trick you might do is configure the rule to run "On update" and then use the bulk actions bar to set the transaction to Unpaid, then Paid again, this should trigger the rule. I haven't tried doing this for thousand of transactions at once, but it should be fine, but you might want to temporarily change the TASK_WORKERS=1 variable to a higher number (keep in mind each worker is a CPU thread) so there's more workers processing the transactions concurrently.

adam commented

2025-12-28 23:25:24 +01:00

@zkutasi commented on GitHub (Nov 29, 2025):

Thanks, your trick works like a charm :)

@zkutasi commented on GitHub (Nov 29, 2025): Thanks, your trick works like a charm :)

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/WYGIWYH#78