summaryrefslogtreecommitdiff
path: root/libeufin/nexus-manual.rst
diff options
context:
space:
mode:
authorAntoine A <>2024-02-06 18:21:11 +0100
committerAntoine A <>2024-02-06 18:21:11 +0100
commit7444aabbcc51fc6069be52dd64f6022658ed6898 (patch)
tree7c210ff0fe3ae31f7a9fcaf42a200f32f776424f /libeufin/nexus-manual.rst
parent7e6ab6e7dd3f863d811d70a91c16f43602e09c50 (diff)
downloaddocs-7444aabbcc51fc6069be52dd64f6022658ed6898.tar.gz
docs-7444aabbcc51fc6069be52dd64f6022658ed6898.tar.bz2
docs-7444aabbcc51fc6069be52dd64f6022658ed6898.zip
Update libeufin doc
Diffstat (limited to 'libeufin/nexus-manual.rst')
-rw-r--r--libeufin/nexus-manual.rst28
1 files changed, 14 insertions, 14 deletions
diff --git a/libeufin/nexus-manual.rst b/libeufin/nexus-manual.rst
index 9a1199aa..9b71249d 100644
--- a/libeufin/nexus-manual.rst
+++ b/libeufin/nexus-manual.rst
@@ -236,8 +236,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.
+The ``--debug-ebics $SAVEDIR`` flag will cause the files to be stored in
+``$SAVEDIR/$YYYY-MM-DD/submit`` where ``$YYYY-MM-DD`` represents the
+date when the upload took place. This is mostly useful for debugging.
For production
--------------
@@ -276,7 +277,7 @@ be set up.
The responsible subcommand for sending payments is ``ebics-fetch``, and its
configuration is a **superset** of core-config_. On top of that, it expects
the database connection string and *optionally* a frequency at which it will
-downloads any unseen notifications and ingest them in the database.
+downloads any new EBICS files and ingest them in the database.
The frequency **may** be specified as
@@ -287,24 +288,23 @@ The frequency **may** be specified as
The supported time units are ``s`` (seconds), ``m`` (minutes), ``h`` (hours).
-Assuming that ``$CONFIG_FILE`` contains all required options, the following command
-would download any unseen notifications (as ``camt.054`` files):
+Assuming that ``$CONFIG_FILE`` contains all required options, the following
+command would download any unseen EBICS files:
.. code-block:: console
- $ libeufin-nexus ebics-fetch -c "$CONFIG_FILE" --transient --debug-ebics
+ $ libeufin-nexus ebics-fetch -c "$CONFIG_FILE" --transient
The ``ebics-fetch`` subcommand will always cause libeufin-nexus to download
-the transaction data, parse the CAMT files and import the statements into its
-local database.
+then parse EBICS files and ingest their content statements into its local
+database.
-The ``--transient`` flag makes the command download and import transaction
-data only once and return immediately afterwards. Without the flag, Nexus
-will download the transaction records at the frequency specified in the
-configuration.
+The ``--transient`` flag makes the command download and import EBICS files only
+once and return immediately afterwards. Without the flag, Nexus
+will download at the frequency specified in the configuration.
-The ``--debug-ebcis`` flag will cause the CAMT files to be stored in
-``$LIBEUFIN_DATA_HOME/camt/$YYYY-MM-DD`` where ``$YYYY-MM-DD`` represents the
+The ``--debug-ebics $SAVEDIR`` flag will cause the files to be stored in
+``$SAVEDIR/$YYYY-MM-DD/fetch`` where ``$YYYY-MM-DD`` represents the
date when the download took place. This is mostly useful for debugging.