Documentation 2.0.0.0

Documentation for ping-pong process version 2.0.0.0-RC1

Changes to previous versions can be found in the release notes.

FHIR search expression to retrieve a list of endpoints to ping. Below is an example of getting all Endpoint resources that belong to an organization with identifier 'test.identifier.org':
Endpoint?status=active&organization:identifier=http://dsf.dev/sid/organization-identifier|test.identifier.org
Leave empty to ping all active endpoints

Specifies the size of the resource to be generated to make download tests with
DSF 1.x has a ~400MB limitation on resource size. DSF 2.0 is confirmed working with up to 10GB of data provided the right settings are used for all communicatiion partners, meaning all proxies allow file uploads of 10GB, and timeouts (DSF FHIR Server, BPE and pong) are configured in such a way that no read timeouts can occur
Setting this value to -1 disables resource generation and download, making the process function like v1.x versions of the process plugin
Leave empty to default to 10MB

Specifies the amount of time the process waits to receive a pong message
Uses the ISO 8601 duration format, e.g. PT1H5M30S for a duration of 1 hour, 5 minutes and 30 seconds
Leave empty to default to 30 seconds

Property: dev.dsf.bpe.ping.maxDownloadSizeBytes
Required: No
Processes: dsfdev_ping, dsfdev_pong
Description: Sets the download limit on resource downloads, essentially limiting the amount of data downloaded from other ping instances. Setting this to a negative value will disable resource downloads, effectively resulting in running the slim (v1.x) ping process.
Default: 400000000

Property: dev.dsf.bpe.ping.maxUploadSizeBytes
Required: No
Processes: dsfdev_ping, dsfdev_pong
Description: Sets the upload limit on resource uploads, essentially limiting the amount of data other ping instances are able to download from this instance.
Default: 400000000

Property: dev.dsf.bpe.ping.networkSpeedUnit
Required: No
Processes: dsfdev_ping, dsfdev_pong
Description: Unit to display upload and download speeds in. Eligible values are: "bps", "kbps", "Mbps", "Gbps", "Bps", "kBps", "MBps", "GBps". If left empty, the process will try to fit the network speed to appropriate units.

Property: dev.dsf.dsf.bpe.ping.mail.onPingProcessFailed
Required: No
Processes: dsfdev_ping
Description: To enable a mail being sent if the ping process fails, set to 'true'. This requires the SMPT mail service client to be configured in the DSF
Default: false

Property: dev.dsf.dsf.bpe.ping.mail.onPongProcessFailed
Required: No
Processes: dsfdev_pong
Description: To enable a mail being sent if the pong process fails, set to 'true'. This requires the SMPT mail service client to be configured in the DSF
Default: false