...
SparkPlug is configured for use in a given ClinSpark environment by the definition of of a ‘Volunteer Monitoring URL’ value, via Administration > General Settings. This URL represents the SparkPlug instance that web service calls will be sent through. The deployment of SparkPlug and management of the endpoint URL is facilitated by IQVIA ‘superadmin’ users. However once put in place, qualified users with access to the Administration > General Settings area (via Role Action) can view the configuration.
...
...
The deployment of an instance of SparkPlug must be requested by the user through the Service Desk. The URL for a SparkPlug instance for any given environment will be <environment>-sparkplug.clinspark.com. For example, if a given test environment address is test.clinspark.com the corresponding SparkPlug address will be test-sparkplug.clinspark.com.
ClinSpark Features Enabled by
...
Volunteer Monitoring URL
The Volunteer Monitoring URL defines the endpoint for volunteer monitoring connectivity in a ClinSpark environment. The existence of a configured ‘Volunteer Monitoring URL’ is linked to URL enables several device based features , and must be present for these features to exist/function in ClinSpark. When a work as designed. SparkPlug instances are also reliant on this URL for web service calls.
When a monitoring URL is defined, the following features will be are enabled:
Use of ‘monitoring’ and ‘API enrollment’ style devices of EDC devices configured with ‘Monitoring Types’ of Client, API, API Enrollment, and Mobile to be configured for use on integrated study forms
Use of EDC devices that utilize ‘monitoring source’ parameters, to be configured for use on device integrated study forms
Use of ‘monitoring’ style devices to be used in SparkPlug enrollment scenarios
Use of ‘Monitoring’ features on Volunteer profiles supporting the ability to see and manage connected devices/data/audits
Device Interface Configurations
SparkPlug is deployed with a number of standard device interface configurations. Updates or changes to these SparkPlug device interfaces are independent from core ClinSpark releases/code changes. If an interface needs an update, it can typically be done with a change to just SparkPlug, and not ClinSpark.
...
Users should review SparkPlug and requested device technical file documentation to confirm whether requested device interfaces or functionality require an update to their defined ClinSpark endpoint.
When selecting an available interface, certain settings are exposed for review and use. The available information and controls of an interface depend on its purpose and intended use in ClinSpark.
...
Modifying SparkPlug Settings
...
These settings are typically maintained by Foundry Health IQVIA engineering team members , to ensure proper function and use of each interface. It may be necessary to reference or modify these values, however, changes made to the device settings will impact all ClinSpark environments that utilize that instance of SparkPlug.mirror or copy Settings from one SparkPlug instance to another to replicate functionality during verification processes. As such, there is an added Import and/or Export functionality to Export settings from the source environment and Import into the target environment. The Export feature will create a password protected JSON file which can then be imported to another instance of SparkPlug.
...
SparkPlug Hosts
Hosts define what ClinSpark environments are able to use the SparkPlug instance. ClinSpark instances can only communicate with SparkPlug if there is a proper ‘host’ configuration.
...
A single SparkPlug deployment can be used to support interfaces configured for use in multiple ClinSpark environments. Each of those environments (for example, Prod Main, Prod Test, Val, UAT, etc,) would need to be defined as an available host in SparkPlug.
...
Host configurations are reliant on a Clinspark ClinSpark user account that contains the API role action. Customers can discuss with IQVIA engineering teams the best course of action for systems integrations accounts as needed.
...
Once device connections are made in a given ClinSpark environment, web service calls through to the SparkPlug instance will using use whatever is configured for that device interface.
...
Audits are visible for changes made to global configurations and host settings.
Versioning
The current SparkPlug version, build, and endpoint for a given instance can be found by interrogating the page properties.
...
on the login page.
...
Logs
SparkPlug contains logs to various errors encountered by that instance. These errors can be related to configuration issues, various login errors, and other application errors. The Logs can be found within the Administration > Logs component and are made available for download. Logs will be organized by Types such as File or Event and listed in a table which can be viewed or downloaded.
...