Process Deployment and Configuration v1.1.0.0

Deploying this process plugin to the DSF involves copy the process jar-file and configuring environment variable for the business process engine (BPE). Information of fixed issues and new features see Release Notes v1.1.0.0.

Prerequisite

Download Process Plugin

• Add the codex-process-data-transfer-1.1.0.0.jar to the folder /opt/bpe/process.

  wget https://github.com/num-codex/codex-processes-ap1/releases/download/v1.1.0.0/codex-process-data-transfer-1.1.0.0.jar
  

  Make sure the file is readable by the bpe user or group (uid: 2202, gid: 2202), for example by executing:

  sudo chmod 440 codex-process-data-transfer-1.1.0.0.jar
  sudo chown root:bpe codex-process-data-transfer-1.1.0.0.jar
  

Data Integration Center (DIC)

Configuration

For a list of all configurable environment variables see Configuration Parameters. Relevant parameters are tagged with Processes: wwwnetzwerk-universitaetsmedizinde_dataSend.

Exclude configuration

Make sure, that the excluded process list contains all processes, that you don't need.

      DEV_DSF_BPE_PROCESS_EXCLUDED: |
        [...]
        wwwnetzwerk-universitaetsmedizinde_dataTranslate|1.1
        wwwnetzwerk-universitaetsmedizinde_dataReceive|1.1

Typical configuration options: environment variables

• DE_NETZWERK_UNIVERSITAETSMEDIZIN_RDP_CRR_PUBLIC_KEY: /run/secrets/crr_public_key.pem
• DE_NETZWERK_UNIVERSITAETSMEDIZIN_RDP_DATA_BASE_URL: http://dic-fhir-store:8080/fhir
• DE_NETZWERK_UNIVERSITAETSMEDIZIN_RDP_VALIDATION_PACKAGE_CACHEFOLDER: /opt/bpe/cache/Package/
• DE_NETZWERK_UNIVERSITAETSMEDIZIN_RDP_VALIDATION_STRUCTUREDEFINITION_CACHEFOLDER: /opt/bpe/cache/StructureDefinition/
• DE_NETZWERK_UNIVERSITAETSMEDIZIN_RDP_VALIDATION_VALUESET_CACHEFOLDER: /opt/bpe/cache/ValueSet/
• DE_NETZWERK_UNIVERSITAETSMEDIZIN_RDP_VALIDATION_VALUESET_EXPANSION_CLIENT_AUTHENTICATION_CERTIFICATE: /run/secrets/app_client_certificate.pem
• DE_NETZWERK_UNIVERSITAETSMEDIZIN_RDP_VALIDATION_VALUESET_EXPANSION_CLIENT_AUTHENTICATION_CERTIFICATE_PRIVATE_KEY: /run/secrets/app_client_certificate_private_key.pem
• DE_NETZWERK_UNIVERSITAETSMEDIZIN_RDP_FTTP_SERVER_BASE_URL: https://ip-test-fttp-w.num.med.uni-greifswald.de/ttp-fhir/fhir/dispatcher
• DE_NETZWERK_UNIVERSITAETSMEDIZIN_RDP_FTTP_CLIENT_TRUST_SERVER_CERTIFICATE_CAS: /run/secrets/app_client_trust_certificates.pem
• DE_NETZWERK_UNIVERSITAETSMEDIZIN_RDP_FTTP_CLIENT_CERTIFICATE: /run/secrets/fttp_num_client_certificate.pem
• DE_NETZWERK_UNIVERSITAETSMEDIZIN_RDP_FTTP_CLIENT_CERTIFICATE_PRIVATE_KEY: /run/secrets/fttp_num_client_certificate_private_key.pem
• DE_NETZWERK_UNIVERSITAETSMEDIZIN_RDP_FTTP_CLIENT_CERTIFICATE_PRIVATE_KEY_PASSWORD_FILE: /run/secrets/fttp_num_client_certificate_private_key.pem.password
• DE_NETZWERK_UNIVERSITAETSMEDIZIN_RDP_FTTP_API_KEY: SOME_API_KEY
• DE_NETZWERK_UNIVERSITAETSMEDIZIN_RDP_FTTP_TARGET: dic_STANDORT

Depending on whether the private keys are encrypted with a password, the corresponding additional secrets are required (shown here using the configuration option DE_NETZWERK_UNIVERSITAETSMEDIZIN_RDP_FTTP_CLIENT_CERTIFICATE_PRIVATE_KEY_PASSWORD_FILE as an example).

Depending on the authentication used, further configuration parameters are required to connect to the local FHIR store (e.g. DE_NETZWERK_UNIVERSITAETSMEDIZIN_RDP_DATA_CLIENT_BASICAUTH_USERNAME, see complete list of configuration options).

Typical configuration options: secrets and mounts

You have to add the required additional secrets to your docker compose file:

services:
  app:
    secrets:
      - crr_public_key.pem
      - fttp_num_client_certificate.pem
      - fttp_num_client_certificate_private_key.pem
      - fttp_num_client_certificate_private_key.pem.password
    
[...]    

secrets:
  crr_public_key.pem:
    file: ./secrets/rdp/crr_public_key.pem
  fttp_num_client_certificate.pem:
    file: ./secrets/rdp/fttp_num_client_certificate.pem
  fttp_num_client_certificate_private_key.pem:
    file: ./secrets/rdp/fttp_num_client_certificate_private_key.pem
  fttp_num_client_certificate_private_key.pem.password:
    file: ./secrets/rdp/fttp_num_client_certificate_private_key.pem.password

Also you should ensure to have the cache directory mounted into the BPE container:

      - type: bind
        source: ./cache
        target: /opt/bpe/cache

Central Research Repository (CRR)

Configuration

For a list of all configurable environment variables see Configuration Parameters. Relevant parameters are tagged with Processes: wwwnetzwerk-universitaetsmedizinde_dataReceive.