diff options
| -rw-r--r-- | libeufin/nexus-manual.rst | 28 | ||||
| -rw-r--r-- | manpages/libeufin-nexus.1.rst | 2 |
2 files changed, 15 insertions, 15 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. diff --git a/manpages/libeufin-nexus.1.rst b/manpages/libeufin-nexus.1.rst index d4922a99..7a8abd00 100644 --- a/manpages/libeufin-nexus.1.rst +++ b/manpages/libeufin-nexus.1.rst @@ -99,7 +99,7 @@ Its options are as follows: ebics-fetch ----------- -This subcommand downloads banking records via EBICS and stores them into the database. Along the download, ebics-fetch would bounce incoming payments that do not have a valid Taler subject, or as well those with an already existing valid subject. Valid incoming payments are then stored in the database so that they can trigger Taler withdrawals. Along this process, ebics-submit would as well reconcile initiated outgoing payments with any outgoing transactions that shows up in the downloaded records. +This subcommand downloads and parse EBICS files and ingest them into the database. Along the download, ebics-fetch would bounce incoming payments that do not have a valid Taler subject, or as well those with an already existing valid subject. Valid incoming payments are then stored in the database so that they can trigger Taler withdrawals. Along this process, ebics-submit would as well reconcile initiated outgoing payments with any outgoing transactions that shows up in the downloaded records. **-h** \| **--help** Print short help on options. |