Release Notes¶
7.4.0¶
New Features:
-
Redundant job metadata has been removed. The environment key
VALIDATE_MSG_SIZEhas been introduced forseal-out-ngn-message-relayservice to further decrease the amount of metadata per job if needed. (PLS-2402) -
SAP device notifications can be enabled or disabled by the new environment variable
ACTIVATE_DEVICE_CALLBACKSforseal-co-notifierservice. To improve failure tolerance regarding NATS KV issues the environment variablesKV_MAX_BUCKET_SIZE,KV_MAX_VALUE_SIZEandKV_TTLhave been added forseal-co-notifierservice. (PLS-2408) -
Node.js 22.22.2 and Consul 2.0.1 are included in delivery. (PLS-2429)
-
As of Local Spooler 7.4.0, digital output to an S3 bucket is supported. To enable this, new service keys for the
seal-checkoutservice and new printer keys have been introduced. For more information, refer to Output to S3. (PLS-2456) -
The
TLS_EXTERNAL_DIRenvironment key is supported byseal-jo-notifierservice. (PLS-2474) -
For security reasons, the PLOSSYS CLI no longer uses the lodash module. (PLS-2526)
-
The default for
QUERY_LIMIThas been increased to30000. (PLS-2607)
Bug-Fixes:
-
The housekeeper election works in cluster mode. (PLS-2410)
-
When retrieving IDP certificates fails, the
seal-restservice terminates with a corresponding log message. (PLS-2444) -
Notifications for offline SAP systems do not block the entire notification flow. (PLS-2475)
-
The
seal-ipp-checkinservice returns RFC 2911-compliant job IDs to IPP clients. (PLS-2522) -
The IPP
release-jobcommand of theseal-ipp-checkinservice specifies the target queue in the IPPprinter-nameattribute. (Previously, the target queue was set asprinter-uri.) (PLS-2523) -
The
seal-housekeeperservice's search for orphan chunks no longer blocks the deletion of expired jobs. (Previously, this search could take long enough on systems with a high job volume that expired jobs accumulated faster than they could be deleted, causing excessive database growth.) (PLS-2616) -
A potential OS command injection vulnerability in
seal-plossyshas been fixed. (PLS-2619)
Known Issues:
- When a key has been entered into Consul with leading or trailing spaces it can override the correct version of the key. (PLS-1985)
7.3.0¶
New Features:
-
IPP queues can be used with Driverless Windows Printing. The
ipp-checkinservice provides IPP attributes for queues based on their properties. For this, the printer keyinputTrayCountand the sectionippwith theattributeskey have been added. (PLS-2379) -
For driverless IPP pick-up queues, the new environment key
DEFAULT_PRINTER_PAUSED_STATEspecifies how thepausedprinter status is mapped to IPP. You can use the printer keyprinterPausedStateto specify the mapping for each queue individually. Refer to Driverless Windows Printing. (PLS-2396) -
The new environment key
REMOVE_WINDOWS_DOMAIN_FROM_USERNAMEforipp-checkinservice specifies if the Windows domain is stripped from usernames. (PLS-2400) -
Node.js has been updated to version 22.22.0. (LSP-61)
7.2.0¶
New Features:
-
Node.js has been updated to version 22.21.1 due to security issues. (LSP-52)
-
The
SOCKET_CLOSE_TIMEOUTconfiguration is evaluated for the IPP protocol. (PLS-2263) -
The new configuration
AUTH_PROXYallows OIDC identity providers to be used behind a firewall. (PLS-2266) -
Services connected to the database reconnect to the database after a connection failure. (PLS-2295)
-
The OKTA identity provider is supported. Therefore, the new environment key
AUTH_USE_STATEhas been added forseal-co-notifierservice. (PLS-2319)
7.1.0¶
New Features:
-
Bulk actions with PLOSSYS CLI are at least as fast as the same bulk actions in PLOSSYS Administrator. (PLS-2176)
-
SAP print jobs with attachments are supported. In this case all documents within the print job are handled as a document stream to ensure they are printed without being interrupted and in correct order. Only one notification is sent after the last document in the document stream has been processed. (PLS-2235)
-
The new printer key
finisherspecifies a list of available finishing types for the printer. Possible values areSTAPLE,PUNCH,FOLD,SORT. (PLS-2248)
Bug-Fixes:
- A bug has been fixed where, on a new system, a first filtered out SAP notification could block the
co-notifierservice until manual restart. (PLS-2256)
7.0.1¶
New Features:
- Node.js has been updated to version 22.16.0 due to security reasons. (LSP-45)
7.0.0¶
New Features:
-
For security reasons, Node.js has been updated to version 22.13.1. (LSP-41)
-
As of version 7.0.0, SAP Spool printing has been improved to fully comply with the SAP specifications. On how to use it, refer to Configure Output from SAP Spool on Windows or on Linux. The following changes have been implemented:
-
The
seal-co-notifierservice can send job and device notifications to multiple SAP systems. (PLS-2055) -
Masterlock of the
seal-co-notifierhas been abolished. Instead it is locked perrmgId(per LOMS). This enables correct horizontal scaling of the service. (PLS-2102) -
Device notifications are supported according to the BC-XOM specification. (PLS-2106)
-
In the event of a problem with a printer, the feedback is sent to SAP in an SAP-compliant manner. This makes it clear that the problem was with the printer and not the job. (PLS-2135)
-
SAP ROMS reconfiguration settings are evaluated by the
seal-co-notifierservice and logged. (PLS-2137) -
For the BC-XOM certification, job notifications have been modified according to the SAP requirements. (PLS-2138)
-
Device feedback with interval control works according to the BC-XOM specification. (PLS-2143)
-
In a cluster, multiple instances of
seal-co-notifierservice share their workload. For customers with several IPP or SAP systems, this results in load distribution. (PLS-2167) -
For the
seal-co-notifierservice, two new service keysKV_HISTORY_SIZEandKV_STORAGE_TYPEare available to configure the NATS key-value store. (PLS-2171) -
The
seal-co-notifierservice uses nwrfcsdk 7.50.15. (PLS-2172)
-
-
The
seal-co-notifierservice provides the new Prometheus metricout_ngn_sap_function_calls_totalto monitor communication with SAP. For the existing metricout_ngn_sap_notifications_totalthe labelnotification_typehas been added. (PLS-2168) -
For container based installations distroless images are available via Github. (PLS-2191)
Bug-Fixes:
-
The
firewall.shscript will not start the firewall anymore. (LSP-23) -
Sometimes BC-XOM notifications to SAP were lost. This error has been fixed. (PLS-1476)
-
The directory of the
sapnwrfc.inifile is explicitly set inseal-co-notifierservice via theSAPNWRFCINI_PATHenvironment key. (PLS-2013) -
The bug has been fixed, where PLOSSYS 4 scaling parameter were not evaluated if not received via IPP. (PLS-2058)
-
If job metadata have been changed by a converter service, the job parameter
job.metadatais updated accordingly to be used in the flow ofseal-convert-dispatcherservice. (PLS-2147) -
SAP device notifications are fail-safe like job notifications. (PLS-2165)
-
Special characters like umlauts in printer names do not cause errors in the
seal-co-notifierservice. (PLS-2178)
6.2.0¶
New Features:
-
Node.js has been updated to 20.17.0.
-
The new environment key
ANALYZE_PDF_PAGE_SIZESforseal-convert-dispatcherservice specifies if incoming PDF files are to be analyzed to detect the page sizes. The default value isfalse. (PLS-1783) -
CALLBACK_NOTIFICATIONS_MAX_RETRIESspecifies the maximum number of attempts for notification callbacks in theseal-co-notifierservice. (PLS-1995)
Bug-Fixes:
- The bug has been fixed, where
seal-checkindid not save the original page orientation of TIFF files as page metadata in the database. (PLS-2074)
6.1.3¶
Breaking:
-
The
seal-logrotateservice to cleanup outdated log files is no longer included in the installation of Local Spooler. Please download and install SEAL Logrotate separately, refer to SEAL Logrotate documentation. (LSP-18) -
As of version 6.1.3, the service
seal-plossys-message-relayhas been renamed toseal-out-ngn-message-relay. For more information, refer to Update on Windows or Update on Linux. (PLS-1931, PLS-1950, PLS-1951, PLS-1952, PLS-1953)
New Features:
-
Node.js has been updated to version 20.17.0. (LSP-36)
-
As of Local Spooler 6.1.3, the version number of Local Spooler and its included services have been adjusted to the respective version number of PLOSSYS Output Engine. (LSP-38)
-
Internal communication has been changed to NATS methods. Thus the service keys MONGO_ACTIONS_URL and MONGO_ACTIONS_AGE are no longer needed or available. (PLS-1579)
-
The bug has been fixed, that prevented the overwriting of the printer when using a zip file with the
plossys job printcommand. (PLS-1648) -
The new environment variable
TLS_MIN_VERSIONallows to define the minimum TLS protocol version to be used. (PLS-1771) -
The log files for
seal-controllerhas been improved. It will state received error from requested service instead of unexpected error code 500 if an error stems originally from another service. (PLS-1819) -
Used third party tools such as Consul or EnvConsul are now available for the s390x processor architecture. (PLS-1836)
-
All services of Local Spooler using Node.js are now available for the s390x processor architecture. (PLS-1837)
-
As of version 6.1.3, Local Spooler supports document streams. Document streams are the Output Engine way to ensure that a series of individual documents can be printed without being interrupted by other documents. The new service key
DOCUMENT_STREAM_TIMEOUTspecifies the inactivity timeout of a printer after processing the last job of a document stream. For more information, refer to the Output Engine documentation about Using Document Streams. (PLS-1822, PLS-1848) -
The new environment key
NOTIFICATION_CALLBACKSspecifies callback actions for particular events like task or document updates. For more information on the usage of callback actions, refer to the Output Engine documentation on how to Create Callback Actions. (PLS-1856) -
The MongoDB Node.js driver has been updated to 5.9.2. (PLS-1903, PLS-2012)
-
Performance of the
seal-housekeeperservice has been improved. (PLS-1854) -
Local Spooler can be monitored by Prometheus. Prometheus metrics are available for all services. For detailed information, refer to Metrics in the Output Engine documentation. (PLS-1964, PLS-1966)
-
Service key
MONGODB_FORCE_TLSis available to specify if connections to MongoDB always use TLS. -
The new service key
RFC_TRACE_DIRfor theseal-co-notifierservice can be used to specify the directory for the SAP trace files. (PLS-2001) -
Analog to the log messages of
seal-checkout,seal-controllerlogs the end of input stream if all documents of a job have arrived. (PLS-2059)
Bug-Fixes:
-
PLOSSYS CLI returned not
0when trying to shut down an already shut down service. This has been fixed. If the service is not running in the end, the return code will be0. (PLS-1123) -
The bug has been fixed, where repeating jobs in virtual queues took too long. (PLS-1901)
-
The bug has been fixed, that prevented the overwriting of the printer when using a zip file with the
plossys job printcommand. (PLS-1648) -
The bug has been fixed, that caused an error with
seal-copierservice when activating Consul ACL. (PLS-1815) -
The bug with unprocessed notifications from the
seal-notifierandseal-co-notifierservices has been fixed. (PLS-1852) -
The bug has been fixed, that caused a crash of the
seal-checkoutservice when sending large files per IPP to a printer. (PLS-1978) -
In rare cases
convert-dispatcherservice started a job before the metadata were written into the database. This bug has been fixed. A new status added is set byseal-checkinandseal-ipp-checkinfor the timeframe needed. (PLS-1997) -
Jobs without printer name will fail with status
ERROR. (PLS-2002) -
The bug that caused
ipp-checkinto freeze when writing to the MongoDB database has been fixed. (PLS-2027) -
The bug has been fixed that caused
seal-checkoutto crash saying "Cannot destructure property 'writableEnded'". (PLS-2072)
1.2.0¶
Breaking:
-
The SEAL NATS message broker has been introduced to improve the message handling and has to be installed before updating to Local Spooler 1.2.0, refer to the SEAL NATS documentation.
-
With Local Spooler 1.2.0, the MongoDB service has been replaced by a newer incompatible version. Therefore, the data stored in MongoDB has to be exported before the update and imported again after the update. For how to do this, refer to the SEAL-specific MongoDB documentation.
-
The v2 REST routes have been deactivated. Now, only v3 with authentication is supported. For this, easyPRIMA as of version 1.7.0 is required.
-
The
JOBNAMEandUSERNAMEparameters are stored in the job asjobNameanduserName. To display job and user names correctly at the printer, especially when using 3rd-party pickup printing systems or secure printing with a PIN, make sure you update to printer templates from March 2022 or later. (PLS-1315)
New Features:
-
Opening the firewall ports is no longer part of the installation due to this is normally done by the system administrators on customer side. However, a separate script firewall.ps1 for Windows or firewall.sh for Linux is contained in delivery and can be used for opening the firewall ports. For more information, refer to Open the Firewall Ports on Windows or Open the Firewall Ports on Linux.
-
After installing or updating Local Spooler and the components such as NATS and MongoDB, the install scripts no longer start the services. The services have to be started manually after the installation or update. For more information, refer to the installation and update descriptions for Windows and Linux. (LSP-14)
-
Installation and update times have been significantly reduced. (PLS-1386)
-
Before updating, the existent envconsul.json file is backed up with a timestamp and can be manually merged into the newly installed envconsul.json file after the update. (PLS-1455)
-
Node.js has been updated due to security vulnerability. (PLS-1218, PLS-1276)
-
The driver for MongoDB has been updated to 4.11.0. (PLS-1607)
-
The security certificates contained in delivery have been updated.
-
The
socketCloseTimeoutprinter key is available for specifying the timeout for closing the connection to the printer for each printer separately. (PLS-1193) -
New service key
IPP_SYSTEMSspecifies the authentication and proxy configuration for the source IPP systems. (LSP-19, PLS-1713) -
New service key
TLS_EXTERNAL_DIRto specify the external certificate files necessary for the services handling external requests. (PLS-1723) -
SOCKET_CLOSE_TIMEOUThas been implemented for the lpr transfer protocol. (PLS-1759) -
Housekeeping has been improved in order to lower the system load with MongoDB. (PLS-1096)
-
Instead of outputting a job to a printer, a script can be executed with the spool data, for example, for sending an e-mail or copying the spool file to the file system. For more information, refer to Configure a Script as Job Output on Windows or Linux. (PLS-1126)
-
The
USE_ETAGkey is available for deactivating the ETag handling. (PLS-1290) -
The default of the
MONGO_LOCKS_AGEkey has been changed from ten seconds (10s) to one minute (1m). (PLS-917) -
The
LOG_FULL_JOB_PROPERTIESkey is available for specifying if the metadata of the jobs are logged. (PLS-1212) -
The successful SAP notifications are logged with the log level info. (PLS-1213)
-
With the job metadata, only one attribute concerning the number of copies is displayed. For how the number of copies are determined from the input data, refer to Set Copies. (PLS-662)
-
The default of the time after which the successfully terminated jobs
JOB_LIFETIME_PROCESSEDare deleted has been set to one hour. (PLS-1275) -
The
PICKUP_BLOCK_INACTIVITY_TIMEOUTkey is available which for specifying an additional inactivity timeout after processing one or more pickup jobs released by a user via IPP. (PLS-1313) -
For IPP, HTTPS is supported with the printer connection. (PLS-1344)
-
Changes in
job.properties.currentwill be saved in the database at the end of a flow or before the call of a converter. Only the userName can't be changed. (PLS-1029) -
All original job parameters will be kept in
job.orig. (PLS-1470) -
For the check-in services, the
PRINTER_CACHE_TTLkey is available for specifying the time interval after that a cached printer object expires. (PLS-1399) -
Virtual queues are available for failover, loadbalancing and routing. For the available keys, refer to Printer Keys. (PLS-1374)
-
For printers supporting the PLJ protocol, PLJ replies from the printers can be evaluated. This way, it can be ensured that jobs are completely output and jobs can be repeated at the page where the output was interrupted. For the restrictions with the PJL output and page failover and how to activate and configure the PLJ output, refer to Use PJL Output. (PLS-1534)
-
The format of the Consul log file has been changed to JSON. For this, "log_json": true, has been added to consul.json. (PLS-1509)
-
For PLOSSYS CLI,
-
the
plossys printer checkcommand is available for checking the connections to the printers and, optionally, sending test files to the printers. For more information, refer to Check Printer Connections. (PLS-136) -
plossys printer-configcommands are available for managing additional printer configurations. For more information, refer to Administrate Additional Printer Configurations. (PLS-1668) -
the command
plossys service stopnow has the option--full.plossys service stop --fullstops all services including the services of the infrastructure tools such as MongoDB and Consul.plossys service stoponly stops the Local Spooler services but not the services of the infrastructure tools. (PLS-1593) -
the commands
plossy printer set-messageandplossys printer remove-messageare available to manage printer messages. For more information, refer to Administrate the Printers. (PLS-1584) -
the command
plossys printer redirectis available to enable the redirection from one printer to another one. For more information, refer to Redirect a Printer. (PLS-1584)
-
Bug-Fixes:
-
The bug that objects were output incorrectly in the log messages has been fixed. (PLS-1209)
-
The bug that jobs were fetched more than once if they were stopped on the target system has been fixed. (PLS-1159)
-
The crash of seal-controller after an error occurred with MongoDB has been fixed. (PLS-1148)
-
A fatal message is logged in case of a service crash. (PLS-1127)
-
The housekeeper service no longer harm jobs which just have arrived. (PLS-1307)
-
Jobs paused on the source system are no longer fetched by the IPP Proxy. (PLS-1194)
-
When stopping Local Spooler on Windows, all services of SEAL Systems are searched and not only those in the "running" status in order to catch all services in an "unclear" status as well. (PLS-1145)
-
PostScript properties without PLS_ prefix are interpreted correctly. (PLS-1250)
-
The audit log messages have been fixed. (PLS-1312)
-
The bug with hanging queues at high load has been fixed. (PLS-1129)
-
The messages when updating Local Spooler have been improved. (PLS-1233)
-
The error handling with the installation script has been improved.(PLS-1325)
-
The bug that sometimes SAP notifications were logged more than once has been fixed. (PLS-1326)
-
The bug that erroneous jobs were replied to SAP as successful has been fixed. (PLS-1268)
-
The port numbers opened by the firewall script has been fixed. (PLS-1365)
-
The PLOSSYS CLI commands on Linux execute the commands with sudo for users without root privileges. (PLS-1305)
-
The memory leak with controller and checkout has been fixed. (PLS-1385)
-
The bug with "Invalid Printer URL" when updating a printer with multiple URLs has been fixed. (PLS-1204)
-
The bug that the housekeeper did not purge jobs with queue names containing upper and lower cases has been fixed. (PLS-1618)
-
The firewall.sh for Linux has been improved. (PLS-1487)
-
The bug that jobs were output twice when a printer was paused has been fixed. (PLS-1558)
-
SOCKET_CLOSE_TIMEOUT has been implemented for the lpr transfer protocol. (PLS-1759)
-
The bug has been fixed, that caused print jobs to stop with an unexpected status code 500. (PLS-1761)
-
The bug has been fixed, that prevented the successful stop of jobs and queues in a cluster. (PLS-1714)
-
The bug has been fixed, where queue names and output destinations were not processed correctly and thus made pickup printing impossible. (PLS-1751)
-
The bug has been fixed, where too many job parameters led to a job error. (PLS-1684)
-
The logging of status changes has been improved. (PLS-1622)
-
The bug has been fixed, where status notifications to SAP has been sent in the wrong order. For this, the new service seal-co-notifier has been implemented. For necessary changes, refer to Update to 5.6.0 for Windows or Update to 5.6.0 for Linux. (PLS-1778)
1.1.0¶
Breaking:
-
With Local Spooler 1.1.0, the MongoDB service has been replaced by a newer incompatible version. Therefore, the data stored in MongoDB has to be exported before the update and imported again after the update. For how to do this, refer to the SEAL-specific MongoDB documentation.
-
MongoDB is no longer included in the installation of Local Spooler. For how to install and configure MongoDB, refer to the SEAL-specific MongoDB documentation.
New Features:
-
Relay Serverhas been renamed toLocal Spoolerto avoid confusion with the relay service. -
Instead of outputting a job to a printer, a script can be executed with the spool data, for example, for sending an e-mail or copying the spool file to the file system.
-
The job notifier has been added to Local Spooler and, therefore, reply messages can be sent.
-
The installation script for Local Spooler on Windows has been changed from a batch file to a PowerShell script.
-
Node.js has been updated due to security vulnerability.