Skip to content

Connect to SAP via the HDM Interface (OData)

Overview

Digital Process Factory provides three working units for exchanging documents and status information with SAP via OData, through the SAP HDM interface:

  • seal-dpf-workingunit-hdm-checkout checks documents out of SAP.
  • seal-dpf-workingunit-hdm-checkin checks documents into SAP.
  • seal-dpf-workingunit-odata-notify sends job status notifications back to SAP.

This is an alternative to RFC-based SAP connectivity, primarily relevant for installations connecting to an SAP S/4HANA Public Cloud system where RFC is undesirable, for example due to VPN overhead.

Hint - only KPRO storage

With seal-dpf-workingunit-hdm-checkout, only KPRO storage is supported. File 1/2 storage is not supported.

Prerequisites

  • The SAP system reachable via OData, with the corresponding service activated in SAP: API_CV_ATTACHMENT_SRV for check-out and check-in, /SEAL/BAS_OD_USRFCT_SRV for the notification. Activating OData services in SAP is outside Digital Process Factory.

Install the Working Units

seal-dpf-workingunit-hdm-checkout, seal-dpf-workingunit-hdm-checkin, and seal-dpf-workingunit-odata-notify are DPF services, refer to Services.

Configure the SAP Connection

All three services connect to SAP the same way, through SAP_SYSTEMS:

  • SAP_SYSTEMS: Mandatory. One entry per SAP system:

    SAP_SYSTEMS: |
  - systemId: H20
    srvHostPort: https://<sap-host>:44300
    user: <sap-user>
    password: <sap-password>
    • systemId: mandatory, must match the SAP system ID transmitted with the job.
    • srvHostPort: mandatory, base URL of the SAP system.
    • user: mandatory, SAP logon user for the OData call.
    • password: mandatory, SAP logon password for the OData call. It can be encrypted. Decrypt it with SECRET or SECRET_FILE.
    • srvPath: optional, defaults to the service's own OData endpoint. seal-dpf-workingunit-hdm-checkout and seal-dpf-workingunit-hdm-checkin default to /sap/opu/odata/sap/API_CV_ATTACHMENT_SRV/AttachmentContentSet. seal-dpf-workingunit-odata-notify defaults to /sap/opu/odata/SEAL/BAS_OD_USRFCT_SRV/UserFctSet.

  • RESTWU_URL_ORIGIN: Optional. Default: https://localhost:9126.

  • ACTION_EXECUTOR: Optional. Default: MOCK, which does not call SAP. Set it to real to execute the SAP call.

Caution - other SAP_SYSTEMS format for seal-dpf-sap-connect

seal-dpf-sap-connect reads SAP_SYSTEMS in a different format. If that service and one of the three services above run on the same installation, set SAP_SYSTEMS per service instead of once for any service.

Use the Working Units in a Workflow

seal-dpf-workingunit-hdm-checkout, seal-dpf-workingunit-hdm-checkin, and seal-dpf-workingunit-odata-notify do nothing on their own. Add each one as a step to a process, like any other working unit. Without a process referencing it, a working unit is loaded but never called.

Hint - SaaS installation

In a SaaS installation, workflow and working unit configuration is administrated via DPF CLI's dpf saas command.

Back to top