.. /*  
    * 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
    */

.. _app-tools-savapage-matrix-messaging-service:

Matrix Messaging Service
------------------------

SavaPage can be configured to publish realtime and summary messages
to an *unencrypted* Matrix Room as shown in the table below.

.. list-table:: Matrix Messaging Configuration Properties
   :width: 100%
   :header-rows: 1
   
   * - Configuration property
     - Description
     
   * - system.matrix.enable
     - Set to ``Y`` or ``N`` (default) to enable or disable Matrix services.
      
   * - system.matrix.homeserver
     - Matrix home server. For example: ``matrix.org``

   * - system.matrix.access-token
     - Matrix access token.

   * - system.matrix.roomid
     - ID of the *unencrypted* Matrix room messages are send to. 
       For example: ``!CAfJdIOajJsRVhGJfk:matrix.org`` 

   * - system.matrix.publish.enable
     - Set to ``Y`` (default) or ``N`` to enable or disable publishing. 

   * - system.matrix.publish.html
     - Set to ``Y`` (default) or ``N`` to publish in HTML (default) or plain text format.

   * - system.matrix.publish.realtime.enable
     - Set to ``Y`` (default) or ``N`` to enable or disable realtime publishing of runtime errors.

   * - system.matrix.publish.realtime.timeslot
     - An hourly timeslot, within which runtime errors are published, formatted 
       as hour ``from-to``. |br| 
       For example: ``8-18`` (8 AM till 6 PM).
       Default: empty (equals to ``0-0``, 24 hours a day). 

   * - system.matrix.publish.summary.enable
     - Set to ``Y`` (default) or ``N`` to enable or disable publishing of summaries.
 
   * - system.matrix.publish.summary.day.enable
     - Set to ``Y`` (default) or ``N`` to enable or disable publishing of a daily summary.

   * - system.matrix.blish.summary.day.schedule
     - Daily summary schedule according to the default 
       :ref:`Cron Trigger Expression <app-job-scheduling-cron>` ``"0 0 8 ? * 3-7"``.
       See :ref:`Matrix Summary Job <app-job-scheduling-matrix-summary-job>`.


See |RST_LINK_CONFIG_EDITOR| on how to change these properties.

.. note::

   The configuration can be tested in the Admin Web App. 
   See :ref:`Matrix Messaging <ch-webapp-admin-options-advanced-matrix-messaging>`.