.. /*  
    * 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-admin-doclog:

Documents
---------

.. contents:: |RST_TABLE_OF_CONTENTS|
   :depth: 2
   :local:

.. _ch-webapp-admin-doclog-intro:

Introduction
~~~~~~~~~~~~

This section is shown after:

-  A *tap* on the |RST_BUTTON_DOCUMENTS| button in the :ref:`Main Menu <ss-admin-menu>`.

   - All processed documents are shown.

-  A *tap* on the |RST_BUTTON_LOG| button in the :ref:`User List <ss-admin-user-list>`.

   - All documents processed by the selected user are shown. The user's
     name is shown in the header and the :ref:`Select and
     Sort <ss-admin-doclog-select-and-sort>` is within the scope of
     this user.

-  A *tap* on the |RST_BUTTON_LOG| button in the :ref:`Queues
   List <ss-admin-queue-list>`.

   - The :ref:`Select and Sort <ss-admin-doclog-select-and-sort-in>`
     is initialized with, and applied for the selected Queue.

-  A *tap* on the |RST_BUTTON_LOG| button in the :ref:`Proxy Printers
   List <ss-admin-proxyprinter-list>`.

   - The :ref:`Select and Sort <ss-admin-doclog-select-and-sort-print>` is 
     initialized with, and applied for the selected Proxy Printer.


.. _ch-webapp-admin-doclog-list:

Document List
~~~~~~~~~~~~~

.. _ss-admin-doclog-list:

.. figure:: ../images/manual/screenshots/admin/sp-01-07-doclog-list.png 
   :alt: Admin Web App: Document - List
   :width: 400px

   Admin Web App: Document - List


The list can be traversed by tapping one of the buttons at the pager at
the top or bottom of the page.

Some samples of other entries...

.. _ss-doclog-list-item-ipp-routing:

.. figure:: ../images/manual/screenshots/admin/sp-01-07-doclog-list-item-ipp-routing.png
   :alt: Admin Web App: Document - |IPP_ROUTING|
   :width: 400px

   Admin Web App: Document - |IPP_ROUTING|

-  A |PROXYPRINT| as a result of :ref:`IPP_Routing <ch-webapp-admin-queue-ipp-routing>`.
   The entry is marked as “Auto” (automatic) with QR code “1fa51673...” delivered by
   an :ref:`IPP_Routing Plug-in <app-plugin-ipp-routing>`.

-  The button at the bottom opens a pop-up with financial details.


.. _ss-webapp-admin-doclog-figure-papercut-costs:

.. figure:: ../images/manual/screenshots/admin/sp-01-07-doclog-list-item-proxy-print-papercut-cost.png
   :alt: Admin Web App: Document - Proxy Print PaperCut Costs
   :width: 400px

   Admin Web App: Document - Proxy Print PaperCut Costs


-  A |PROXYPRINT| to a PaperCut managed printer where PaperCut
   :ref:`Printer Costs <ch-webapp-admin-proxyprinter-costs-per-media-side>` were
   leading.

-  The left button at the bottom opens a pop-up with financial details,
   the right button downloads the
   :ref:`Print Journal <ch-webapp-admin-proxyprinter-journal>`.

-  Note the SavaPage (print supplier) and PaperCut (third-party
   print manager) icons just above the buttons.

-  For a sample screenshot of the financial transaction, see
   :ref:`User Web App: Log - Proxy Print PaperCut Transaction <ss-user-log-transaction-proxy-print-papercut>`.

.. figure:: ../images/manual/screenshots/admin/sp-01-07-doclog-list-item-in-printers.png
   :alt: Admin Web App: Documents - Print-in - Default
   :width: 400px

   Admin Web App: Documents - Print-in - Default

.. figure:: ../images/manual/screenshots/admin/sp-01-07-doclog-list-item-in-printers-ipp-options.png
   :alt: Admin Web App: Documents - Print-in - IPP Options
   :width: 400px

   Admin Web App: Documents - Print-in - IPP Options

.. figure:: ../images/manual/screenshots/admin/sp-01-07-doclog-list-item-in-printers-airprint.png
   :alt: Admin Web App: Documents - Print-in - AirPrint
   :width: 400px

   Admin Web App: Documents - Print-in - AirPrint

.. figure:: ../images/manual/screenshots/admin/sp-01-07-doclog-list-item-in-mailprinter.png
   :alt: Admin Web App: Documents - Print-in - Mail
   :width: 400px

   Admin Web App: Documents - Print-in - Mail

.. figure:: ../images/manual/screenshots/admin/sp-01-07-doclog-list-item-in-webprinter.png
   :alt: Admin Web App: Documents - Print-in - Web
   :width: 400px

   Admin Web App: Documents - Print-in - Web

.. figure:: ../images/manual/screenshots/admin/sp-01-07-doclog-list-item-out-pdf.png
   :alt: Admin Web App: Documents - PDF out
   :width: 400px

   Admin Web App: Documents - PDF out

Each document is displayed with data depending on its input source
(SavaPage Print :ref:`Queue <ch-webapp-admin-queues>`) or output
target (:ref:`PDF <ch-webapp-user-main-pdf>` export,
:ref:`Proxy Printer <ch-webapp-user-main-print>` print). From top to
bottom:

-  The creation date at the top right corner.

-  Source or destination, shown in a color depending on its type.

   -  A SavaPage Queue, like "/printers/", is displayed in *blue*
      (when RAW printed to the default Queue the word “Printer” is
      displayed, Driverless File Transfer Print shows “Web Printer” or
      “Mail Printer”).

   -  A PDF is shown in *green*.

   -  A |PROXYPRINTER|, like “Ricoh Aficio MP C7500”, is displayed in
      *red* prefixed with an inline pagometer Pie-Chart. The *red* color
      in the chart represents the number of *pages* in the job. The
      *orange* color represents the number of printed *sheets*.

-  User: the user id as creator of the document.

-  The document name, with optionally (PDF export) the PDF author name,
   subject and keywords.

   -  In case of a Proxy Print Job, icons |image47| or |image48|
      indicate the presence of a |PRINT_ARCHIVE| or |PRINT_JOURNAL|.
      Pressing the |RST_BUTTON_EYE_SYMBOL| button at the bottom of the document entry will
      download the printed PDF. See :ref:`Document
      Store <ch-webapp-admin-options-advanced-document-store>`.

   -  In case of a Print-in Job the |image49| icon indicates the
      presence of a |QUEUE_JOURNAL|. Depending on :ref:`User
      Privileges <ch-webapp-admin-user-group-edit-user-privileges>`,
      action buttons are displayed at the bottom of the document entry.
      Pressing the |RST_BUTTON_EYE_SYMBOL| button will download and pressing the 
      |RST_BUTTON_CROSS_SYMBOL| button will delete the journaled PDF. Also see
      :ref:`Queue Journal <ch-webapp-user-main-log-documents-queue-journal>`.

      If :ref:`Inherit IPP options from print-in
      document <ch-webapp-admin-options-proxy-print-modes>` is
      enabled for :ref:`Fast Print
      Mode <ch-webapp-admin-devices-card-reader-proxy-print-fast>`
      the :ref:`IPP Options from
      PostScript <ch-printer-postscript-driver-ipp-options>` Driver
      Print-in are displayed.

   -  If a PDF was uploaded at “Web Printer” the document name is
      appended with |RST_BUTTON_3_DOTS| , a click on the dots shows the properties
      of the uploaded file. For example:
      
      .. _ss-pdf-document-item-web-printer:

      .. image:: ../images/manual/screenshots/admin/sp-01-07-doclog-list-item-in-webprinter-pdf-props.png
        :width: 350px


-  The number of pages and size (bytes). With optionally...

   -  The CUPS Job number (|PROXYPRINTER| only).

   -  The CUPS printing status: *Pending, Held, Processing, Stopped,
      Canceled, Aborted, Completed* (|PROXYPRINTER| only).

   -  The paper size, like "ISO-A4" (Queue and |PROXYPRINTER| only).

   -  "LH" indicator in case a letterhead was applied (Proxy Printer and
      PDF only).

   -  "Duplex" indicator (|PROXYPRINTER| only).

   -  "DRM" indicator when exported PDF was encrypted (PDF only), or
      printed document was an encrypted PDF. (Queue only).

   -  "Denied" indicator when printed document was an encrypted PDF and
      such printing is not permitted (Queue only). See :ref:`Printing
      Encrypted PDF <ch-printer-encryped-pdf>`.

   -  Owner ("O") and User ("U") password indicators (PDF only).

-  Destination (PDF only). The client IP address (:ref:`PDF
   Download <ch-webapp-user-main-pdf-download>`) or the recipient
   email address (:ref:`Send PDF <ch-webapp-user-main-pdf-send>`)

-  An gear icon with text “Web Service” in case a :ref:`RESTful Print
   Service <app-restful-user-print>` printed to a
   :ref:`Queue <ch-webapp-admin-queues>` other than the reserved
   ``/webservice`` queue.

*Tap* the |RST_BUTTON_SELECT_AND_SORT| button to expand the section, and select
a document Type :

-  Option |RST_BUTTON_MINUS_SYMBOL| selects all document types:
   :ref:`more ... <ss-admin-doclog-select-and-sort>`

-  Option |RST_BUTTON_IN| selects documents printed to a SavaPage Queue:
   :ref:`more ... <ss-admin-doclog-select-and-sort-in>`

-  Option |RST_BUTTON_OUT| selects documents printed to a Proxy Printer or exported
   to PDF: :ref:`more ... <ss-admin-doclog-select-and-sort-out>`

-  Option |RST_BUTTON_PDF| selects documents exported to PDF:
   :ref:`more ... <ss-admin-doclog-select-and-sort-pdf>`

-  Option |RST_BUTTON_PRINT| selects documents printed to a |PROXYPRINTER|:
   :ref:`more ... <ss-admin-doclog-select-and-sort-print>`

Depending on the selected |RST_GUILABEL_TYPE|, selection and sort options are shown
or hidden. However, there are common selections for all document types as
discussed at the :ref:`screenshot below <ss-admin-doclog-select-and-sort>`.

.. _ss-admin-doclog-select-and-sort:

.. figure:: ../images/manual/screenshots/admin/sp-01-07-doclog-select-and-sort.png
   :alt: Admin Web App: Documents - Select and Sort - All
   :width: 400px

   Admin Web App: Documents - Select and Sort - All


-  Select a |RST_GUILABEL_DOCUMENT| by entering a part (fragment)
   of its name.

-  Select a creation |RST_GUILABEL_PERIOD| by entering a |RST_GUILABEL_FROM|
   and |RST_GUILABEL_TO| date. Tap the |RST_BUTTON_CANCEL_SYMBOL| button after
   a date to clear it. See this example
   :ref:`Data Selection Dialog <ss-admin-applog-select-and-sort-date>`.

-  Documents can sorted |RST_BUTTON_ASCENDING| or |RST_BUTTON_DESCENDING|
   by creation |RST_BUTTON_DATE| or |RST_BUTTON_NAME|.


.. _ss-admin-doclog-select-and-sort-in:

.. figure:: ../images/manual/screenshots/admin/sp-01-07-doclog-select-and-sort-in.png
   :alt: Admin Web App: Documents - Select and Sort - In
   :width: 400px

   Admin Web App: Documents - Select and Sort - In


As an extra to the :ref:`common options <ss-admin-doclog-select-and-sort>`,
the |RST_BUTTON_IN| |RST_GUILABEL_TYPE| offers:

-  A selection on |RST_GUILABEL_QUEUE|

-  A |RST_GUILABEL_SORT| on |RST_GUILABEL_QUEUE|


.. _ss-admin-doclog-select-and-sort-out:

.. figure:: ../images/manual/screenshots/admin/sp-01-07-doclog-select-and-sort-out.png
   :alt: Admin Web App: Documents - Select and Sort - Out
   :width: 400px

   Admin Web App: Documents - Select and Sort - Out


As an extra to the :ref:`common options <ss-admin-doclog-select-and-sort>`,
the |RST_BUTTON_OUT| |RST_GUILABEL_TYPE| offers:

-  A selection on |RST_GUILABEL_DESTINATION|

-  A selection on |RST_GUILABEL_LETTERHEAD|


.. _ss-admin-doclog-select-and-sort-pdf:

.. figure:: ../images/manual/screenshots/admin/sp-01-07-doclog-select-and-sort-pdf.png
   :alt: Admin Web App: Documents - Select and Sort - PDF
   :width: 400px

   Admin Web App: Documents - Select and Sort - PDF


As an extra to the :ref:`Out options <ss-admin-doclog-select-and-sort-out>`,
the |RST_BUTTON_PDF| |RST_GUILABEL_TYPE| offers:

-  A selection on |RST_GUILABEL_AUTHOR|

-  A selection on |RST_GUILABEL_SUBJECT|

-  A selection on |RST_GUILABEL_KEYWORDS|

-  A selection on |RST_GUILABEL_ENCRYPTION|

-  A selection on |RST_GUILABEL_USER_PASSWORD| and |RST_GUILABEL_OWNER_PASSWORD|

   -  Use the |RST_BUTTON_EYE_SYMBOL| button on the right side of these entry
      fields to show/hide the password.


.. _ss-admin-doclog-select-and-sort-print:

.. figure:: ../images/manual/screenshots/admin/sp-01-07-doclog-select-and-sort-print.png
   :alt: Admin Web App: Documents - Select and Sort - Print
   :width: 400px

   Admin Web App: Documents - Select and Sort - Print


As an extra to the :ref:`Out options <ss-admin-doclog-select-and-sort-out>`,
the |RST_BUTTON_PRINT| |RST_GUILABEL_TYPE| offers:

-  A selection on |RST_GUILABEL_PRINTER|

-  A selection on |RST_GUILABEL_JOB_STATE|

   -  Status |RST_GUILABEL_UNKNOWN| is explained in :ref:`CUPS Job
      ID <ch-install-config-cups-job-id>`.

-  A selection on |RST_GUILABEL_LAYOUT|: Simplex or Duplex.

-  A |RST_GUILABEL_SORT| on |RST_BUTTON_PRINTER|


.. _ss-admin-doclog-select-and-sort-ticket:

.. figure:: ../images/manual/screenshots/admin/sp-01-07-doclog-select-and-sort-ticket.png
   :alt: Admin Web App: Documents - Select and Sort - Ticket
   :width: 400px

   Admin Web App: Documents - Select and Sort - Ticket


The |RST_BUTTON_TICKET| |RST_GUILABEL_TYPE| shows a slightly changed version of
the :ref:`Print Type options <ss-admin-doclog-select-and-sort-print>`:

-  A selection on |RST_GUILABEL_TICKET| is added (at the expense of the Printer
   selection). You can enter any part of a Ticket Number.

-  Selection on |RST_GUILABEL_LAYOUT| is dropped.


.. _ch-webapp-admin-doclog-proxyprint-reversal:

Proxy Print Reversal
~~~~~~~~~~~~~~~~~~~~

For a |PROXYPRINT| that is Canceled or Aborted a reverse button (at the
right) is available in the document item to adapt counters and refund
accounts charged. The button is available for administrators with
:ref:`Editor permission for
Accounts <ch-webapp-admin-user-group-edit-admin-privileges>`. In case
of a Job Ticket print the button is disabled as long as the :ref:`Job
Ticket <ch-webapp-jobtickets-reversal>` is Open (its |RST_BUTTON_CLOSE|
button is not pressed yet).

.. image:: ../images/manual/screenshots/admin/sp-01-07-doclog-list-item-print-out-canceled-refund.png
   :width: 400px

After the refund it looks like this:

.. image:: ../images/manual/screenshots/admin/sp-01-07-doclog-list-item-print-out-canceled-refunded.png
   :width: 400px

See :ref:`Proxy Print Costs <app-proxyprint-scenarios-costs>`.


.. _ch-webapp-admin-doclog-proxyprint-set-status:

Proxy Print Status
~~~~~~~~~~~~~~~~~~

For an Active or Unknown |PROXYPRINT|, buttons are available to simulate a
|RST_BUTTON_CANCEL| or |RST_BUTTON_COMPLETE| of a print job whose status is
not automatically updated due to a duplicate CUPS Job ID. See :ref:`CUPS Job ID
Duplicates <ch-install-config-cups-job-id-duplicates>`.

.. image:: ../images/manual/screenshots/admin/sp-01-07-doclog-list-item-print-out-simulate-cancel-or-complete.png
   :width: 350px

The buttons are shown in the Admin Web App for administrators that have
:ref:`permission to edit accounts <ch-webapp-admin-user-group-edit-admin-privileges>`
if :ref:`Configuration property <ch-webapp-admin-options-advanced-config-editor>`
``proxy-print.job-state.edit.enable = Y``.


.. /*
    * Images
    */

.. |image47| image:: ../images/manual/archive-32x32.png
   :width: 16px
.. |image48| image:: ../images/manual/journal-32x32.png
   :width: 16px
.. |image49| image:: ../images/manual/journal-32x32.png
   :width: 16px