Skip to content

Services

As of version 4.0.0, Digital Process Factory consists of a number of small, autonomous services. Each service is self-contained and implements a single capability within the DPF context. Below you find the list of DPF services in alphabetical order with a short description what each service does.

seal-consul-agent

seal-consul-agent service provides Consul by HashiCorp, a tool for service discovery and configuration.

  • Log file:

    • Windows: C:\ProgramData\SEAL Systems\log\seal-consul-agent.log
    • Linux: /opt/seal/log/seal-consul-agent.log

  • Ports: refer to Ports

seal-dpf-accounting

seal-dpf-accounting service logs accounting information. The information logged and it's order is specified in the LOGFORMAT keyword of the <accounting> element in main(.customer).xml.

  • Consul path: /dc/home/env/service/dpf-accounting

  • main(.customer).xml section: accounting

  • Log file:

    • Windows: C:\ProgramData\SEAL Systems\log\seal-dpf-accounting.log
    • Linux: /opt/seal/log/seal-dpf-accounting.log

  • Ports: refer to Ports

Hint - use accounting service

By default, seal-dpf-process-manager is writing the accounting.log log file as known of DPF 3.x.x. In cluster mode, you have to set USE_ACCOUNTING_SERVICE to true for seal-dpf-accounting service to create cluster compliant log files.

seal-dpf-filebeat

seal-dpf-filebeat forwards the DPF log file data to Elasticsearch.

  • Consul path: /dc/home/env/service/seal-dpf-filebeat

  • Log file:

    • Windows: C:\ProgramData\SEAL Systems\log\seal-dpf-filebeat.log-<timestamp>.ndjson
    • Linux: /opt/seal/log/seal-dpf-filebeat.log-<timestamp>.ndjson

seal-dpf-jobcleaner

seal-dpf-jobcleaner service checks the MongoDB in intervals for jobs to be deleted. The interval is specified by the environment variable DPF_JOBCLEANER_INTERVAL. The deletion is done in two separate steps:

  • The first step ("delete job") deletes all temporary files from the job directory. The job.log and input files remain. The jobState is set to DELETED.

  • The second step ("forget job") deletes the job from MongoDB and the file system completely.

The service can be called by the DPF CLI command dpf clearjobs to delete jobs immediately.

  • Consul path: /dc/home/env/service/dpf-jobcleaner

  • main(.customer).xml section: jobcleaner

  • Log file:

    • Windows: C:\ProgramData\SEAL Systems\log\seal-dpf-jobcleaner.log
    • Linux: /opt/seal/log/seal-dpf-jobcleaner.log

  • Ports: refer to Ports

seal-dpf-jobclient-api

seal-dpf-jobclient-api provides a REST service interface at port 4303. The service creates and starts jobs and creates the job directory. The interface is downward compatible. When creating a job via DPF Batch Client, seal-dpf-jobclient-api service is called.

  • Consul path: /dc/home/env/service/dpf-jobclient-api

  • Log file:

    • Windows: C:\ProgramData\SEAL Systems\log\seal-dpf-jobclient-api.log
    • Linux: /opt/seal/log/seal-dpf-jobclient-api.log

  • Ports: refer to Ports

Example - create a job via DPF Batch Client

dpfclient -wf example -protocol http -host localhost:4303 -s userName=Bob jobName=helloworld -a

seal-dpf-management-api

seal-dpf-management-api provides the REST API for DPF management tasks. When administrating jobs via DPF CLI, seal-dpf-management-api service is called.

  • Consul path: /dc/home/env/service/dpf-management-api

  • Log file:

    • Windows: C:\ProgramData\SEAL Systems\log\seal-dpf-management-api.log
    • Linux: /opt/seal/log/seal-dpf-management-api.log

  • Ports: refer to Ports

seal-dpf-process-manager

seal-dpf-process-manager handles the execution of workflows. The job.log and the job history entries in the database are created by it. By default, the service also writes the accounting.log.

For SaaS operation, seal-dpf-process-manager also reads and updates workflow configurations from MongoDB. Refer to Administrate the SaaS Configuration for more information.

  • Consul path: /dc/home/env/service/dpf-process-manager

  • main(.customer).xml section: processmanager

  • Log file:

    • Windows: C:\ProgramData\SEAL Systems\log\seal-dpf-process-manager.log
    • Linux: /opt/seal/log/seal-dpf-process-manager.log

  • Ports: refer to Ports

seal-dpf-sap-connect

seal-dpf-sap-connect receives SAP fax orders via RFC, forwards them as raw jobs to the DPF REST API, and reports the results back to SAP asynchronously via a DPF webhook callback and RFC. Refer to Connect to SAP via SAPconnect Interface (BC-CON) for more information.

  • Mandatory environment variables:

  • Consul path: /dc/home/env/service/dpf-sap-connect

  • Log file:

    • Windows: C:\ProgramData\SEAL Systems\log\seal-dpf-sap-connect.log
    • Linux: /opt/seal/log/seal-dpf-sap-connect.log

  • Ports: refer to Ports

seal-dpf-urlcallback

seal-dpf-urlcallback sends the status of a job to a URL supplied by the assigning client. It does this for the job states job_sending and job_finished. Refer to URL Callback for more information.

  • Consul path: /dc/home/env/service/dpf-urlcallback

  • Log file:

    • Windows: C:\ProgramData\SEAL Systems\log\seal-dpf-urlcallback.log
    • Linux: /opt/seal/log/seal-dpf-urlcallback.log

seal-dpf-workingunit-abbyy-ocr

seal-dpf-workingunit-abbyy-ocr submits documents to ABBYY FlexiCapture 12 for OCR processing and retrieves the results.

The following FLEXICAPTURE_OPTIONS have to be specified:

  • FC_BASE_URL: https://your-flexicapture-server
  • FC_USERNAME: <DOMAIN>\<user>

  • FC_PASSWORD: <base64-encoded-password>

  • Consul path: /dc/home/env/service/dpf-workingunit-abbyy-ocr

  • Log file:

    • Windows: C:\ProgramData\SEAL Systems\log\dpf-workingunit-abbyy-ocr.log
    • Linux: /opt/seal/log/dpf-workingunit-abbyy-ocr.log

seal-dpf-workingunit-hdm-checkin

seal-dpf-workingunit-hdm-checkin checks documents into SAP via HDM interface.

  • Mandatory environment variables:

  • Consul path: /dc/home/env/service/dpf-workingunit-hdm-checkin

  • Log file:

    • Windows: C:\ProgramData\SEAL Systems\log\seal-dpf-workingunit-hdm-checkin.log
    • Linux: /opt/seal/log/seal-dpf-workingunit-hdm-checkin.log

  • Ports: refer to Ports

seal-dpf-workingunit-hdm-checkout

seal-dpf-workingunit-hdm-checkout checks out documents from SAP via the HDM interface. It is used in a SaaS context.

  • Mandatory environment variables:

  • Consul path: /dc/home/env/service/dpf-workingunit-hdm-checkout

  • Log file:

    • Windows: C:\ProgramData\SEAL Systems\log\seal-dpf-workingunit-hdm-checkout.log
    • Linux: /opt/seal/log/seal-dpf-workingunit-hdm-checkout.log

  • Ports: refer to Ports

Hint - only KPRO

With HDM checkout, only KPRO storage is possible. File 1/2 storage is not supported.

seal-dpf-workingunit-odata-notify

seal-dpf-workingunit-odata-notify provides a working unit for SAP OData notifications.

  • Mandatory environment variables:

  • Consul path: /dc/home/env/service/dpf-workingunit-odata-notify

  • Log file:

    • Windows: C:\ProgramData\SEAL Systems\log\dpf-workingunit-odata-notify.log
    • Linux: /opt/seal/log/dpf-workingunit-odata-notify.log

seal-dpf-workingunit-print-ipp

seal-dpf-workingunit-print-ipp is a working unit. It sends IPP print jobs from DPF to a PLOSSYS Output Engine printer. It uses seal-dpf-rest-job-poller to poll DPF for new jobs. It sends documents from the RLI job file to PLOSSYS Output Engine. Only documents with IS_DIST_FILE set to Y are sent. Each document is sent as part of a document stream. It provides two REST endpoints: one to report the IPP job status, and one used internally as a callback for seal-dpf-wu-manager-rest, see Used Ports.

  • Mandatory environment variables:

    • PLS_PRINTSERVER_URL: full URL of the PLOSSYS Output Engine IPP Checkin to which the print jobs will be sent to, example: ipp://localhost:631
    • PLS_PLOTTER: name of the printer on the PLOSSYS Output Engine to which the print jobs will be sent to, example: printer1

  • Consul path: /dc/home/env/service/dpf-workingunit-print-ipp

  • Log file:

    • Windows: C:\ProgramData\SEAL Systems\log\dpf-workingunit-print-ipp.log
    • Linux: /opt/seal/log/dpf-workingunit-print-ipp.log

seal-dpf-wujavacall4

seal-dpf-wujavacall4 service starts and manages Java working units, e.g. working units of the type WUJavaCall.

  • Consul path: /dc/home/env/service/dpf-wujavacall4

  • main(.customer).xml section: javawu

  • Log file:

    • Windows: C:\ProgramData\SEAL Systems\log\seal-dpf-wujavacall4.log
    • Linux: /opt/seal/log/seal-dpf-wujavacall4.log

  • Ports: refer to Ports

seal-dpf-wu-manager-rest

seal-dpf-wu-manager-rest service starts and manages REST working units, e.g. working units of the type WURestCall.

  • Consul path: /dc/home/env/service/dpf-wu-manager-rest

  • Log file:

    • Windows: C:\ProgramData\SEAL Systems\log\seal-dpf-wu-manager-rest.log
    • Linux: /opt/seal/log/seal-dpf-wu-manager-rest.log

  • Ports: refer to Ports

seal-dpf-wusendback

seal-dpf-wusendback provides a working unit to send back files after a job was processed.

  • Consul path: /dc/home/env/service/dpf-wusendback

  • Log file:

    • Windows: C:\ProgramData\SEAL Systems\log\seal-dpf-wusendback.log
    • Linux: /opt/seal/log/seal-dpf-wusendback.log

  • Ports: refer to Ports

seal-dpf-wustandard

seal-dpf-wustandard is a DPF WU Manager service. It hosts a set of standard, reusable Node.js working units, for example file and INI reading and S3 copy-from-RLI. It can also load additional custom WU packages or filesystem-based working units at runtime.

  • Consul path: /dc/home/env/service/dpf-wustandard

  • Log file:

    • Windows: C:\ProgramData\SEAL Systems\log\seal-dpf-wustandard.log
    • Linux: /opt/seal/log/seal-dpf-wustandard.log

  • Ports: refer to Ports

seal-dpf-wusystemcall

seal-dpf-wusystemcall service starts and manages all working units of the type WUSystemCall but the application converter.

  • Consul path: /dc/home/env/service/dpf-wusystemcall

  • main(.customer).xml section: workingunit

  • Log file:

    • Windows: C:\ProgramData\SEAL Systems\log\seal-dpf-wusystemcall.log
    • Linux: /opt/seal/log/seal-dpf-wusystemcall.log

  • Ports: refer to Ports

seal-dpf-wuwait

seal-dpf-wuwait service starts and manages all working units of the type WUWait.

  • Consul path: /dc/home/env/service/dpf-wuwait

  • Log file:

    • Windows: C:\ProgramData\SEAL Systems\log\seal-dpf-wuwait.log
    • Linux: /opt/seal/log/seal-dpf-wuwait.log

  • Ports: refer to Ports

Back to top