What is SparkPlug?

SparkPlug is a separately deployed and maintained web application used to facilitate connected device workflows in a given ClinSpark environment. It contains configurations used by device interfaces that leverage web services.

SparkPlug is used with certain integrations that leverage programming interfaces made available by device manufacturers, in order to allow certain device enrollment, data collection, and data review workflows to take place in ClinSpark. Additionally, SparkPlug ensures that once a connection to a ‘monitoring’ style device is established for a given study subject (volunteer), data can continue to be made available in ClinSpark for review throughout a study.

Configuring ClinSpark for SparkPlug

SparkPlug is configured for use in a given ClinSpark environment by the definition 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 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.

Open

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 URL enables several device based features and must be present for these features to work as designed. SparkPlug instances are also reliant on this URL for web service calls.

When a monitoring URL is defined, the following features are enabled:

• Use 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

Updates or changes to SparkPlug device interfaces are independent from core ClinSpark releases/code changes. 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.

Open

Modifying SparkPlug Settings

SparkPlug settings are exposed in an Administration area. This controls all of the available device settings, in addition to modifications related to the ClinSpark ‘host’ environments that an instance of SparkPlug is configured to communicate with.

These settings are typically maintained by IQVIA engineering team members to ensure proper function and use of each interface. It may be necessary to 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.

Host configurations are reliant on a ClinSpark user account that contains the API role action with a valid API token as discussed in ClinSpark APIs | Bearer HTTP Tokens. 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 use whatever is configured for that device interface.

Audits

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 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.

See Also

• SparkPlug Data