.. /*  
    * This file is part of the SavaPage project <https://www.savapage.org>.
    * Copyright (c) 2026 Datraverse B.V.
    * Author: Rijk Ravestein.
    *
    * SPDX-FileCopyrightText: (c) 2020 Datraverse B.V. <info@datraverse.com>
    * SPDX-License-Identifier: CC-BY-SA-4.0
    *
    * For more information, please contact Datraverse B.V. at this
    * address: info@datraverse.com
    */

.. _ch-webapp-user-main-user-details:

User Details
------------

.. contents:: Table of Contents
   :depth: 2
   :local:

Buttons
~~~~~~~

The User Details dialog shows the
:ref:`Pagometers <ch-webapp-user-main-user-details-pagometers>` and
:ref:`Financial <ch-webapp-user-main-user-details-financial>` status of
the user, and is shown after a tap on the |RST_BUTTON_USER| button in the
:ref:`footer <ch-webapp-user-main-footer>` of the main panel.

.. note::

   Depending on :ref:`User Privileges <ch-webapp-admin-user-group-edit-user-privileges>`
   the :ref:`Financial <ch-webapp-user-main-user-details-financial>` section
   might not be shown.

.. _ss-user-details-actions:

.. figure:: ../images/manual/screenshots/user/sp-01-00-user-details-actions.png
   :alt: User Web App: User Details - Buttons
   :width: 400px

   User Web App: User Details - Buttons


-  For an :ref:`Internal User <ch-webapp-admin-options-internal-users>`
   a |RST_BUTTON_PASSWORD| button is shown, when a password has been set (i.e. not
   erased): see :ref:`Password <ch-webapp-admin-user-edit-password>`.
   A tap on the button will show the :ref:`Password Reset Dialog <ss-admin-user-password-reset>`.

-  If users are allowed to change their PIN a |RST_BUTTON_PIN| button is shown. A
   tap on the button will show the :ref:`PIN Reset Dialog <ss-admin-user-pin-reset>`.
   Also see :ref:`User Authentication <ch-webapp-admin-options-user-auth>`.

-  If an :ref:`Internet Print <ch-webapp-admin-options-internet-print>`
   ``protocol://authority`` is present the |RST_BUTTON_INTERNET_PRINTER| button is
   shown. A tap on the button will show the 
   :ref:`Internet Printer Device URI <ch-webapp-user-main-user-details-internet-printer>`.

-  If :ref:`Telegram Messaging <ch-webapp-admin-options-advanced-telegram>` is enabled
   the |RST_BUTTON_TELEGRAM| button is shown. It leads you to the 
   :ref:`Telegram Configuration <ch-webapp-user-main-user-details-telegram-config>`
   dialog.

   .. warning::

      Telegram support is **deprecated** and will be removed in a next
      release.

-  If :ref:`2-step Verification <ch-webapp-admin-options-user-auth-2-step>` is
   enabled the |RST_BUTTON_AUTHENTICATION| button is shown. It brings you to the
   :ref:`Authentication Dialog <ch-webapp-user-main-user-details-authentication>`.


.. _ch-webapp-user-main-user-details-internet-printer:

Internet Printer
~~~~~~~~~~~~~~~~

Users can copy/paste their private
:ref:`Internet Print <ch-webapp-admin-options-internet-print>` Device URI
for driver print from this dialog. The ``SAVAPAGE.ppd`` file can be
downloaded.

This dialog also shows the URL and credentials for
:ref:`macOS <ch-printer-macos>`, :ref:`Chrome OS <ch-printer-chrome-os>` and
the :ref:`SavaPage Android Print App <ch-printer-android-savapage-print-app>`.

The UUID can be replaced with a new one by pressing the |RST_BUTTON_UUID| button.

.. _ss-user-internet-printer:

.. figure:: ../images/manual/screenshots/user/sp-01-00-user-internet-printer.png
   :alt: User Web App: User Details - Internet Printer
   :width: 600px

   User Web App: User Details - Internet Printer


.. _ch-webapp-user-main-user-details-telegram-config:

Telegram Configuration
~~~~~~~~~~~~~~~~~~~~~~

.. warning::

   Telegram support is **deprecated** and will be removed in a next
   release.

This dialog contains a step by step procedure to configure 
:ref:`Telegram Messaging <ch-webapp-admin-options-advanced-telegram>` for a Telegram
ID owned by a user.

.. figure:: ../images/manual/screenshots/user/sp-01-00-user-telegram-config.png
   :alt: User Web App: User Details - Telegram Configuration
   :width: 400px

   User Web App: User Details - Telegram Configuration


.. _ch-webapp-user-main-user-details-authentication:

Authentication
~~~~~~~~~~~~~~

In this dialog :ref:`2-Step Verification <ch-webapp-user-login-2-step>`
can be |RST_BUTTON_ENABLED|, and the user can |RST_BUTTON_REPLACE| their TOTP code.
To ensure that the TOTP code is scanned/copied correctly, the user must enter a
verification code before pressing the |RST_BUTTON_APPLY| button.

.. _ss-user-2-step-verification:

.. figure:: ../images/manual/screenshots/user/sp-01-00-user-2-step-verification.png
   :alt: User Web App: User Details - Authentication
   :width: 400px

   User Web App: User Details - Authentication


.. note::

   If 2-Step Verification is |RST_BUTTON_ENABLED| and 
   :ref:`User Telegram Configuration <ch-webapp-user-main-user-details-telegram-config>`
   is applied, the |RST_BUTTON_SEND_CODE_TO_TELEGRAM| option is visible: if checked,
   no Authenticator app is needed and verification codes are send to the
   user's Telegram ID. However, at this time, you must enter a
   verification code generated by an Authenticator app.

.. warning::

   Telegram support is **deprecated** and will be removed in a next
   release.

.. _ch-webapp-user-main-user-details-pagometers:

Pagometers
~~~~~~~~~~

This section shows the *personal*
:ref:`Pagometers <ch-webapp-admin-options-advanced-pagometers>` of the
user, and are analogous to the ones in the Admin Dashboard as shown in
:ref:`Admin Web App: Dashboard - Pagometer <ss-admin-dashboard-pagometer>` and
:ref:`Admin Web App: Dashboard - Environmental Impact <ss-admin-dashboard-environmental-impact>`. 

.. _ss-user-pagometers:

.. figure:: ../images/manual/screenshots/user/sp-01-00-user-details-pagometer.png
   :alt: User Web App: User Details - pagometer
   :width: 400px

   User Web App: User Details - pagometer


.. _ss-user-env-impact:

.. figure:: ../images/manual/screenshots/user/sp-01-00-user-details-env-impact.png
   :alt: User Web App: User Details - Environmental Impact
   :width: 400px

   User Web App: User Details - Environmental Impact


The |RST_GUILABEL_ENVIRONMENTAL_IMPACT| section can be hidden with configuration property
in table below.

.. list-table:: User Web App Environmental Impact Configuration Properties
   :width: 100%
   :widths: 30 70
   :header-rows: 1
   
   * - Configuration property
     - Description
     
   * - webapp.user.show-env-info
     - Set to ``Y`` (default) or ``N``, to show/hide the Environmental Impact section.


See |RST_LINK_CONFIG_EDITOR| on how to set these items.


.. _ch-webapp-user-main-user-details-financial:

Financial
~~~~~~~~~

This section shows the financial status of the user account and ways to
increment the account balance from an external account.

.. note::

   Depending on :ref:`User Privileges <ch-webapp-admin-user-group-edit-user-privileges>`
   the section for account transactions might not be shown.


.. _ss-user-financial:

.. figure:: ../images/manual/screenshots/user/sp-01-00-user-details-financial.png
   :alt: User Web App: User Details - Financial
   :width: 400px

   User Web App: User Details - Financial


-  |RST_GUILABEL_BALANCE| : the user's account balance.

-  |RST_GUILABEL_CREDIT_LIMIT| : see :ref:`Financial <ch-webapp-admin-user-edit-financial>`.

-  If :ref:`PaperCut Personal User Account <app-papercut-personal-user-account>`
   is enabled, the |RST_GUILABEL_BALANCE| label is prefixed with the PaperCut icon and
   |RST_GUILABEL_CREDIT_LIMIT| is not shown.

-  A push on the |RST_BUTTON_VOUCHER| button opens the
   :ref:`Redeem Voucher <ch-webapp-user-main-user-details-redeem-voucher>`
   dialog. The visibility of this button is dependent on an
   :ref:`application setting <ch-webapp-admin-options-financial-vouchers>`.

-  A push on the |RST_BUTTON_TRANSFER| button opens the
   :ref:`Transfer Credit <ch-webapp-user-main-user-details-redeem-voucher>`
   dialog. The visibility of this button is dependent on an 
   :ref:`application setting <ch-webapp-admin-options-financial-transfer-funds>`
   and a |RST_GUILABEL_BALANCE| amount greater than zero.

If a :ref:`Generic <app-plugin-payment-gateway-generic>` Payment Gateway
Plug-in is enabled, an icon is shown for each active payment method.
Pushing (clicking) the payment method icon will pop-up the dialog to
:ref:`Transfer Money <ch-webapp-user-main-user-details-transfer-money>`.

.. note::

   The dedicated :ref:`Payment Web App <ch-webapp-payment>` can be used if a
   :ref:`Generic Payment Plug-in <app-plugin-payment-gateway-generic>`
   is enabled.

.. _ch-webapp-user-main-user-details-redeem-voucher:

Redeem Voucher
~~~~~~~~~~~~~~

.. _ss-user-redeem-voucher:

.. figure:: ../images/manual/screenshots/user/sp-01-00-user-details-redeem-voucher.png
   :alt: User Web App: Redeem Voucher
   :width: 400px

   User Web App: Redeem Voucher


-  Enter the voucher |RST_GUILABEL_NUMBER| in the dialog box and press
   |RST_BUTTON_REDEEM|. Make sure to enter the number exactly as listed on
   the voucher including any dashes (-).

-  If you entered the number correctly, the value as shown on the
   voucher will be transferred to your account and a new entry will list
   in your :ref:`transaction log <ch-webapp-user-main-log-transactions>`.


.. _ch-webapp-user-main-user-details-transfer-credit:

Transfer Credit
~~~~~~~~~~~~~~~

This dialog is used to transfer funds to another user.

.. _ss-user-details-transfer-credit:

.. figure:: ../images/manual/screenshots/user/sp-01-00-user-details-transfer-credit.png
   :alt: User Web App: Transfer Credit
   :width: 400px

   User Web App: Transfer Credit


-  Enter the |RST_GUILABEL_AMOUNT| in currency units and cents. 
   The available amount is shown in green at the top.

-  Enter the |RST_GUILABEL_TO_USER| id and an optional |RST_GUILABEL_COMMENT|.
   A Quick Search for a User ID can be
   :ref:`configured <ch-webapp-admin-options-financial-transfer-funds>`
   for this dialog.

-  When you press the |RST_BUTTON_TRANSFER| button the amount will be transferred
   from your account to the account of the target user. New entries will
   list in your :ref:`transaction log <ch-webapp-user-main-log-transactions>`
   and the log of the target user.

To configure this dialog see :ref:`Transfer Funds <ch-webapp-admin-options-financial-transfer-funds>`.


.. _ch-webapp-user-main-user-details-transfer-money:

Transfer Money
~~~~~~~~~~~~~~

This dialog is used to transfer money from an external account. The
figure below shows a dialog in preparation for a credit card
transaction. Other payment methods are available as defined by the
active :ref:`Generic Payment Gateway Plug-in <app-plugin-payment-gateway-generic>`.
See for example :ref:`Mollie Payment Plug-in <app-plugin-mollie>`.

.. _ss-user-details-transfer-money:

.. figure:: ../images/manual/screenshots/user/sp-01-00-user-details-transfer-money.png
   :alt: User Web App: Transfer Money from Credit Card
   :width: 400px

   User Web App: Transfer Money from Credit Card


-  Enter the amount in currency units and cents, in this case |RST_GUILABEL_EUR|.

-  Press the |RST_BUTTON_START| button to start the payment transaction.