Documentation Changes¶

This page summarizes structural and content changes to this documentation compared to the previous version. For product changes, refer to Release Notes.

4.3.0¶

This version has no dedicated release notes section, since there was no official DPF 4.2.0 release. The following lists everything documented since DPF 4.1.0.

Added:

Introduction > Feature Overview is a new page listing the most important features of DPF, grouped by topic.
Reference > Bibliography is a new page listing the external documentation this documentation links to, grouped by topic.
Release Notes > Documentation Changes, this page, is new.
Introduction > Differences to DPF 3 is a new page listing how DPF 4 differs from DPF 3.
Introduction > Version is a new page listing the Node.js, Filebeat, and Consul versions bundled with Digital Process Factory.
Windows/Linux > Advanced Configuration > Configure SEAL Elastic Stack on Windows or Linux documents Elasticsearch, Kibana, and Filebeat configuration, now delivered with the DPF installation. Reference > Configuration Files > Elastic Stack Configuration Files documents the underlying configuration directory structure.
Use Cases > Connect to SAP via SAPconnect Interface (BC-CON) documents the new seal-dpf-sap-connect service, which receives SAP fax orders via RFC and forwards them as jobs.
Use Cases > Connect to SAP via the HDM Interface (OData) documents the new seal-dpf-workingunit-hdm-checkout, seal-dpf-workingunit-hdm-checkin, and seal-dpf-workingunit-odata-notify services, which exchange documents and status information with SAP via OData as an alternative to RFC-based connectivity.
Use Cases > Output Files to an S3 Bucket is a new use case for uploading job output files to an S3-compatible object store.
Use Cases > Administrate the DPF SaaS Configuration documents the new dpf saas command for deploying process and working-unit configuration to the database for SaaS installations.
Use Cases > Administrate Security documents the new dpf security command for encrypting passwords used by certain working units.
Use Cases > Secure Jobclient API documents OIDC authentication for DPF Batch Client, including automatic access token refresh.

Removed:

Use Cases > DPF System > License: all license administration instructions were removed. For DPF 4.0.0 and newer, no license management exists.
Use Cases > Administrate the DPF Configuration: the dpf config import --update command is no longer available.

Changed:

Reference > Services gained documentation for the services seal-consul-agent, seal-dpf-filebeat, seal-dpf-sap-connect, seal-dpf-workingunit-abbyy-ocr, seal-dpf-workingunit-hdm-checkin, seal-dpf-workingunit-hdm-checkout, seal-dpf-workingunit-odata-notify, and seal-dpf-wustandard.
Reference > Used Ports gained ports 4311 (seal-dpf-sap-connect), 5440 and 5441 (WU HDM Checkin/Checkout).
Reference > Keys gained key groups for OIDC authentication, S3 output, SAP Connect, and the message broker, as well as SERVICE_PORT.
Reference > Metrics gained a "Custom Service Metrics" section for the working-unit services, seal-dpf-process-manager, and seal-dpf-sap-connect.
Components > DPF Batch Client gained command line options for OIDC authentication.
Use Cases > Construct Working Units in DPF Director gained a section on adding a node working unit.
Troubleshooting > Job Processing gained the entries "Subjobs Are Not Processed" and "Working Unit Does Not Start".
Introduction > Basic Terms in This Documentation gained the terms DPF/SEAL Environment, RLI, and Node Working Unit, and is now sorted alphabetically.
Introduction > Architecture Overview expanded the SEAL NATS description.
Windows/Linux > Installation > Requirements on Windows or Linux notes that Elastic Stack configuration is now bundled with the installation.
Windows/Linux > Installation > Update on Windows or Linux gained an "Update to 4.3.0" section covering the Filebeat configuration merge.
Reference > Directories and Files on Linux or Windows gained an entry for the working units and workflow definitions directory, marked unconfirmed.
Reference: dpfserver_main_customer.md and dpftracker_passwd.md moved into a new reference/configuration_files/ subdirectory, alongside the new Elastic Stack Configuration Files page.