Added documentation about Account Lookup Analyser by CS-DaS · Pull Request #545 · Project60/org.project60.banking

CS-DaS · 2026-07-14T17:45:15Z

No description provided.

dontub

Thanks @CS-DaS. Having a documentation for that analyser would be great. Can you have a look at my comments?

dontub · 2026-07-23T09:58:55Z

+`_party_ba_id`. This magic field gets evaluated by several matcher plugins,
+including CreateContribution and ExistingContribution.
+
+Additionaly, this plugin can look up the CiviCRM BankAccount for the


Suggested change

Additionaly, this plugin can look up the CiviCRM BankAccount for the

Additionaly, this plugin can look up the CiviCRM `BankAccount` for the

dontub · 2026-07-23T10:12:20Z

+account reference from the currently analysed transaction, it looks up if this
+account reference already exists as a CiviCRM BankAccountReference. It then
+stores the internal CiviCRM-ID for the BankAccount in a magic field
+`_party_ba_id`. This magic field gets evaluated by several matcher plugins,


I thought it's party_ba_id, isn't it?

dontub · 2026-07-23T10:12:50Z

+including CreateContribution and ExistingContribution.
+
+Additionaly, this plugin can look up the CiviCRM BankAccount for the
+organization's account reference and store it's id in a magic field `_ba_id`.


I thought it's ba_id, isn't it?

CS-DaS · 2026-07-23T15:52:11Z

Thanks for your feedbacks! I will go through it and add some changes.

…hat it does with the result

CS-DaS · 2026-07-23T16:01:10Z

I did all the corrections. Just for the evaluation of _IBAN I don't know what the plugin does, but at least the field is mentioned now in the documentation.

dontub · 2026-07-24T08:22:20Z

I did all the corrections. Just for the evaluation of _IBAN I don't know what the plugin does

Actually the same as with _party_IBAN, but the found BankAccount ID is stored in ba_id instead of party_ba_id.

In pseudo code it should be more or less like this:

For every bank account reference type:
  Look for a bank account reference of type <bank account reference type> with the value in field 
    $lookup_donor_account_prefix<bank account reference type>
  If a BankAccount ID is found: Put it in party_ba_id. Stop.

For every bank account reference type:
  Look for a bank account reference of type <bank account reference type> with the value in field
    $lookup_org_account_prefix<bank account reference type>
  If a BankAccount ID is found: Put it in ba_id. Stop.

CS-DaS · 2026-07-24T08:48:44Z

The part that I don't understand is, what happens with ba_id? Is is later evaluated somehow or has some other impact?

dontub · 2026-07-24T09:27:00Z

The part that I don't understand is, what happens with ba_id? Is is later evaluated somehow or has some other impact?

As with party_ba_id it's stored in the BankTransaction entity and could be used by other analysers or matchers.

…t of field.

CS-DaS · 2026-07-24T09:41:22Z

ah, ok. I added that.

dontub

I've noted few more things that came to my mind. Please have a look and see what you think about it.

dontub · 2026-07-27T08:25:04Z

+example. The second part of the field name (`IBAN` and `NBAN_PP` in this
+example) can be any CiviBanking bank account reference type option value.
+The first part of the field name (`_party_` in this example) can be configured
+in this plugin. It also evaluates the field `_IBAN` and stores the id for the


I'm unsure if it's clear that the IBAN in _IBAN can by any bank account reference type option value as above and that _ is a configurable prefix like _party_... Would it make sense to explain it in a way that makes clear that for the configurable prefixes _ and _party the same kind of lookup is performed?

dontub · 2026-07-27T08:28:44Z

+
+In a typical setup, your importer plugin writes the account reference to the
+field `_party_IBAN` or `_party_NBAN_PP`. The Account Lookup Analyser
+evaluates the field and writes to a magic field `party_ba_id`, which later is


[...] which later is evaluated [...]

Technically correct would be "can be" instead of "is".

dontub · 2026-07-27T08:36:54Z

+example) can be any CiviBanking bank account reference type option value.
+The first part of the field name (`_party_` in this example) can be configured
+in this plugin. It also evaluates the field `_IBAN` and stores the id for the
+`BankAccount` in a magic field `ba_id`. Later, `ba_id` gets stored in the


Actually I'm wondering what "magic" means here (as well as below for party_ba_id). Technically it's just a field of the BankTransaction entity that can be accessed by analysers and matchers like other BankTransaction fields.

dontub · 2026-07-27T08:49:59Z

+    "plugin_type_name": "match",
+    "plugin_class_name": "analyser_account",
+    "name": "Account Lookup",
+    "description": "Provides potential contacts, based on account lookups",


Is the description really accurate? Actually the matcher is just about BankAccounts not contacts, isn't it? Should it rather be something like "Associates transaction with bank account"?

CS-DaS · 2026-07-27T09:26:41Z

I added all the corrections.

CS-DaS added 3 commits July 14, 2026 19:43

Added documentation about Account Lookup Analyser

80e9bb4

Documentation about probability for Account Lookup analyser

8b5301d

Fix in Documentation about Account Lookup Analyser

ef9d362

dontub requested changes Jul 23, 2026

View reviewed changes

dontub added documentation status:needs work There is code, but it needs additional work before it should be reviewed labels Jul 23, 2026

dontub self-assigned this Jul 23, 2026

typo layout

1aace0e

CS-DaS added 3 commits July 23, 2026 17:55

typo layout

9873fb3

mention evaluation of field _IBAN. I unfortunately don't understand w…

7eb5d27

…hat it does with the result

fix wrong field names in documentation

177b3af

CS-DaS requested a review from dontub July 23, 2026 16:01

documentation Account Lookup Analyser: Add information about treatmen…

a2510c2

…t of field.

dontub requested changes Jul 27, 2026

View reviewed changes

CS-DaS added 4 commits July 27, 2026 11:11

Account Lookup Analyser documentation: precise that can be evaluated

d08724a

remove word magic for field explanations

3e089dd

clarify plugin description

3411c91

clarify configuration for fields etc.

7c8aea5

CS-DaS requested a review from dontub July 27, 2026 09:26

	Additionaly, this plugin can look up the CiviCRM BankAccount for the
	Additionaly, this plugin can look up the CiviCRM `BankAccount` for the

Uh oh!

Conversation

CS-DaS commented Jul 14, 2026

Uh oh!

dontub left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dontub Jul 23, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dontub Jul 23, 2026

Choose a reason for hiding this comment

Uh oh!

dontub Jul 23, 2026

Choose a reason for hiding this comment

Uh oh!

CS-DaS commented Jul 23, 2026

Uh oh!

CS-DaS commented Jul 23, 2026

Uh oh!

dontub commented Jul 24, 2026

Uh oh!

CS-DaS commented Jul 24, 2026

Uh oh!

dontub commented Jul 24, 2026

Uh oh!

CS-DaS commented Jul 24, 2026

Uh oh!

dontub left a comment

Choose a reason for hiding this comment

Uh oh!

dontub Jul 27, 2026

Choose a reason for hiding this comment

Uh oh!

dontub Jul 27, 2026

Choose a reason for hiding this comment

Uh oh!

dontub Jul 27, 2026

Choose a reason for hiding this comment

Uh oh!

dontub Jul 27, 2026

Choose a reason for hiding this comment

Uh oh!

CS-DaS commented Jul 27, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants