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.
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, delivered with the DPF installation. Reference > Configuration Files > Elastic Stack Configuration Files documents the underlying configuration directory structure.
Use Cases > Filter RLI Lines documents the RLI filter of working units: operators, several values and filters, filters per workflow position, and variables in the filter value.
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 > Secure Jobclient API documents OIDC authentication for DPF Batch Client, including automatic access token refresh.
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.
Troubleshooting was split into topic pages and has gained new entries.
Reference > Workflow File and Reference > Working Unit File are new pages describing the structure of workflow and working unit files.
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.

Removed:

DPF Director: since DPF Director is not part of the delivery, it is no longer part of this documentation. Instead, Reference > Workflow File and Reference > Working Unit File describe the structure of workflow and working unit files.
Use Cases > DPF System > Web Service: the page was 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:

Introduction > Architecture Overview expanded the SEAL NATS description and gained the section "Job Processing" with a diagram of how workflows and working units work together.
Introduction > Basic Terms in This Documentation gained the terms DPF/SEAL Environment, RLI, and Node Working Unit.
Windows/Linux > Installation > Requirements on Windows or Linux notes that Elastic Stack configuration is bundled with the installation.
Windows/Linux > Installation > Installation on Windows or Linux gained steps for sysinit -auto, TRACKER_URL, and checking DPF Tracker. Requirements on Linux gained the section "User seal".
Windows/Linux > Installation > Update on Windows or Linux gained an "Update to 4.3.0" section covering the end of Elastic Stack 7 support and the Filebeat configuration merge.
Windows/Linux: Secure DPF Tracker on Windows or Linux moved from Advanced Configuration to Security Configuration.
Components > DPF Batch Client gained command line options for OIDC authentication.
Use Cases > Set Parameters refers to workflow and working unit files instead of processes and DPF Director.
Use Cases > URL Callback gained a "Differences to DPF 3.x" section.
Reference > Job Parameters: DeleteJob and ForgetJob are marked as not evaluated by DPF 4.x.
Reference > Keys gained key groups for OIDC authentication, S3 output, SAP Connect, and the message broker, as well as ACTION_EXECUTOR, MAX_INSTANCES, RESTWU_URL_ORIGIN, SECRET, SECRET_FILE, SERVICE_PORT, TLS_UNPROTECTED, and TRACKER_URL.
Reference > Metrics gained a "Custom Service Metrics" section for the working-unit services, seal-dpf-process-manager, and seal-dpf-sap-connect.
Reference > Operators gained a "Differences to DPF 3.x" section.
Reference > Used Ports has been updated.
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, seal-dpf-workingunit-print-ipp, and seal-dpf-wustandard.
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. Reference > Configuration Files > main.customer.xml lists only the keys that DPF 4.x evaluates.
Reference > Directories and Files on Linux or Windows has been updated.
Reference > API Description > Introduction describes both REST APIs, the Jobclient API and the Management API, with port and path prefix.