| Contributors | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Table of Contents:
| Table of Contents | ||||||||
|---|---|---|---|---|---|---|---|---|
|
...
| Anchor | ||||
|---|---|---|---|---|
|
SPARCRequest utilizes a number of settings to allow you to customize content and enable or disable functionality based on your institution's needs. These settings are stored in the settings database table and are populated from config/defaults.json.
...
current_api_version: This is the current version of the SPARCRequest API.
remote_service_notifier_protocol: This is the HTTP protocol (HTTP/HTTPS) of the SPARCRequest API.
remote_service_notifier_username: This is the authentication username of the SPARCRequest API.
remote_service_notifier_password: This is the authentication password of the SPARCRequest API.
remote_service_notifier_host: This is the host domain of the SPARCRequest API.
remote_service_notifier_path: This is the URL path of the SPARCRequest API.
2.9 Configuring SPARC / OnCore API
use_oncore: indicates whether the application is going to use SPARC/OnCore API.
oncore_endpoint_access: designates users that should have access to OnCore information.
oncore_api: the base OnCore URL (i.e. for MUSC test environment it’s: https://musc-oncore-test.forteresearchapps.com) **be sure to include https://**oncore_default_department:This is the default value that is sent over to OnCore/CTMS to the department field with the minimal footprint API.oncore_default_library: This is the default value that is sent over to OnCore/CTMS to the library field (i.e. Oncology, Non-oncology) with the minimal footprint API.oncore_default_organizational_unit: This is the default value that is sent over to OnCore/CTMS to the organization unit field with the minimal footprint API.oncore_default_protocol_type: This is the default value that is sent over to OnCore/CTMS to the protocol type field (i.e., Treatment) with the minimal footprint API.oncore_default_institution: This is the default value that is sent over to OnCore/CTMS to the institution field with the minimal footprint API.
oncore_default_pi_role: This is the setting to indicate that SPARC will be sending primary PI identity over to OnCore with the minimal footprint API.
...
| Anchor | ||||
|---|---|---|---|---|
|
3.1 Permissible Values (Most of the Permissible Values can now be managed from SPARCAdmin module by Site Admin users)
Permissible Values are options and labels used across SPARCRequest, most of which can be customized for your institution. These are stored in the permissible_values database table and categorized by their category attribute.
...