summaryrefslogtreecommitdiff
path: root/libeufin
diff options
context:
space:
mode:
authorMS <ms@taler.net>2023-11-22 11:50:48 +0100
committerMS <ms@taler.net>2023-11-22 11:51:18 +0100
commitad8a7751009769494c2cb9fd11d46ad6fe92332d (patch)
tree9b53ad2e9ee499c11a76e5c15883243559d8b8b1 /libeufin
parentdc470fbc2cb82adc2469d712067d1f9404ca20ad (diff)
downloaddocs-ad8a7751009769494c2cb9fd11d46ad6fe92332d.tar.gz
docs-ad8a7751009769494c2cb9fd11d46ad6fe92332d.tar.bz2
docs-ad8a7751009769494c2cb9fd11d46ad6fe92332d.zip
nexus manual: how to redownload transactions
Diffstat (limited to 'libeufin')
-rw-r--r--libeufin/nexus-manual.rst30
1 files changed, 28 insertions, 2 deletions
diff --git a/libeufin/nexus-manual.rst b/libeufin/nexus-manual.rst
index cecc69b8..63dbb0d5 100644
--- a/libeufin/nexus-manual.rst
+++ b/libeufin/nexus-manual.rst
@@ -126,8 +126,9 @@ The frequency **may** be specified as
.. code-block:: console
[nexus-submit]
-
frequency = 5m
+ # Optional, but useful to check what Nexus sends to the bank
+ submissions_log_directory = $LIBEUFIN_DATA_HOME/uploads
The supported time units are ``s`` (seconds), ``m`` (minutes), ``h`` (hours).
@@ -180,6 +181,9 @@ send it to the bank.
The ``--transient`` flag instructs the software to perform only one pass on
the database, submit what is submittable, and return.
+Alternatively, the ``--debug`` flag makes ebics-submit accept data from STDIN,
+and submit it to the bank.
+
For production
--------------
@@ -220,7 +224,7 @@ be stored.
config = postgres:///nexus
[nexus-fetch]
# Optional, but usfeful against data loss.
- statement_log_directory = $LIBEUFIN_DATA_HOME/camt
+ statement_log_directory = $LIBEUFIN_DATA_HOME/downloads
Assuming that ``$config_file`` contains any required option, the following command
would download any unseen notifications (as camt.054 files).
@@ -246,3 +250,25 @@ to only return documents that are timestamped *from* (inclusive) the last incomi
.. code-block:: console
libeufin-nexus ebics-fetch -c $config_file
+
+Testing
+-------
+
+If the bank account history has transactions that are useful for testing, it is
+possible to redownload them via the ``--pinned-start`` argument. Note: if the Nexus
+database contains already the bank account history, you might need to **reset** it,
+in order to have the redownloaded transactions ingested.
+
+.. note::
+
+ double-check the configuration: resetting the wrong database might cause DATA LOSS!
+
+For example, say that three back on the 2023-06-01 an handful of incoming transactions
+got booked at the bank account watched by Nexus. After such day, the following command
+would redownload them (and ingest them, if the database doesn't have them):
+
+.. code-block:: console
+
+ libeufin-nexus ebics-fetch -c $config_file --pinned-start 2023-06-01
+
+Note: the command redownloads transactions *from* the pinned start until the present.