Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This document represents a recommended process and ‘step plan’ for customers and IQVIA support teams who collaborate on ClinSpark upgrades. Summarized, the general process is:

  1. Customer and IQVIA teams collaborate to prepare for taking an upgrade

  2. Customers perform validation activities

  3. Once validation is complete, a plan is prepared to coordinate and execute the upgrade

This is not an exhaustive list of procedures or tasks, but should provide many of the essential activities for both customer and IQVIA teams to consider when planning an upgrade.

Stage

Responsible

Activity

Notes

1

Preparation

One-two weeks

Customer

Expresses intent to upgrade ClinSpark

Sandboxes are usually out of the scope of an upgrade as they are only normally provided during initial onboarding.

Review the ClinSpark release notes and technical file documentation via the service desk portal.

If upgrading several versions, customers will want to reference all of the release notes from their current version to upgrade version. If available, customers can also reference the applicable release overview area in this documentation site.

If customers want to explore the latest release of ClinSpark before proceeding to formal validation they can have access to

a 3

the ‘community’ dev environment.

2

Customer

Expresses intent to upgrade ClinSpark to IQVIA team

If customers are engaged in regular meetings with IQVIA PM teams, please share thoughts/plans regarding upgrades. Otherwise, please raise a service desk ticket to engage with the support team on the topic.

Note: Sandbox environments are out of the scope of standard upgrade cycles, as they are only normally provided during initial onboarding periods.

3

IQVIA PM

Inform customer that Reports/Dashboards and all other configuration items and integrations are NOT part of the regular ClinSpark release testing process and therefore it needs the Customer's special attention during testing / validation of the new version. 

Key items to focus on:

  • Dashboards

  • Reports / Exports

  • APIs

  • Lab integrations

  • Other integrations

Details about the upgrade process and environment management is here: Upgrading ClinSpark

4

IQVIA PM

Request Customer to formalise their request for VAL instance (if not done already) in a Service Desk ticket.

Aim to provide the timelines for the validation and a planned upgrade slot.

If customers already have a VAL instance, the request would be to

update their existing

terminate any prior VAL instances and be provided with a new instance to the

intended

upgrade version.

If the customer does not have a

If no VAL instance exists yet, the request would be to create the VAL instance.

4
5

Customer

Create Service Desk ticket requesting upgrade of applicable instance.

The ticket must contain all the details requested here: https://foundryhealth.atlassian.net/wiki/spaces/DOCS/pages/3700293727/Upgrading+ClinSpark#Requesting-VAL-Instances

If a VAL instance already exists that is being upgraded, the

The customer must decide on

how existing

any special considerations for configurations (dashboards, reports, etc)

are to be managed

. Typically, our

recommendation

approach is to also upgrade all configurations for reports and dashboards to latest available using

the

system synchronization

feature

features.

System Configurations and Synchronization States

Where improved and revised dashboards and reports / exports are bundled with a software release, they may have an effect on downstream processes (processing and analysis by e.g. SAS programs, ingesting into data warehouses), and need to be thoroughly tested.

If certain report/dashboard configurations are not expected to be updated to the latest

from the WAR file

, these need to be specified in the request.

We cannot guarantee that older dashboards and reports / exports remain forward compatible with newer versions of ClinSpark.

5
6

IQVIA Engineer

Provide / Upgrade Customer VAL environment version, whatever is agreed upon and update the corresponding

FHSD

Service Desk ticket.

If updating existing VAL environment, also update all system configurations based upon agreed approach in

FHSD 7

Service Desk ticket.

6

IQVIA PM

Once upgrade has been completed

IQVIA Engineers can share an artifact of the configuration update process, which shows changes applied to configurations int he VAL environment. This document can help guide customers on decisions towards configuration validation activities.

7

IQVIA PM

Verify with customer they are able to access the VAL environment, and then close the Service Desk ticket.

Inform the customer that separate tickets should be raised for an issues/questions arising during validation.

Users can use self-service password reset to gain access to VAL environments if needed.

8

Validation

Three months (depending on the scope and approach taken by the customer)

Customer

Test

Inform IQVIA PM of validation scope, if not already done via service desk previously.

We recommend that customers perform validation activities around their own specific use of ClinSpark and not replicate our functional testing under simulated business conditions.

9

Customer

TEST new functionality and

Configuration

configuration items / integrations in upgraded ClinSpark environment.

8

10

Customer

Create Service Desk tickets for issues

arrising with configuration items

or questions arising due to the upgrade.

9

11

IQVIA

Engineer / IQVIA solution specialist

Support

If applicable, ensure

Configuration

configuration issues arising from the Customer's testing/validation exercise are addressed

Responsible depends

.

The responsible party is dependent on the

issue arising10

issues arising; certain topics may require engineering input, while others can be addressed by the service desk team and/or solution specialists.

12

Customer

Confirm to the IQVIA PM that customer validation exercise is complete, including validation / testing of the configuration items

11

.

Customers are strongly encouraged to share a summary of validation activities with the IQVIA team once validation is complete, to understand scope of testing performed. This will help ensure that the IQVIA team is able to answer questions or provide clarifications about release changes ahead of PROD upgrades, and mitigate support challenges arising by missed validation activities.

13

Prep for

Prod

Upgrade

Time required requires discussion

Customer

Raise a service desk ticket with intent to initiate the upgrade process in PROD MAIN/TEST instances. Details submitted must specify:

  • Version number and build to deploy (this usually matches the VAL version/build).

  • Time slots indicating dates/times on when the upgrade would be suitable to occur. If providing multiple, indicate a preferred time slot.

Confirm to the IQVIA PM

of

the FHSD ticket number and the preferred time slot for

upgrading the Customer's Prod Main and Test instances

upgrade.

  • Ideally, multiple time slots (including timezone) would be provided for consideration, so IQVIA PM can coordinate with available engineering resources. Example: Monday, July 1st, 9am - 10am CST; 2pm-4pm CST

  • Customers may want to consider a suitable ‘quiet’ time in the clinic

, whilst being mindful of the timezone of the applicable engineer
  • Please ensure adequate warning of the intended upgrade

Three
  • ; minimum three weeks notice is preferred

12
14

IQVIA PM

Collaborate with the engineering team

/ Engineer / Solution Specialist

Discuss to check if one of the preferred time slots works for engineering, and ensure alignment is reached

.  Inform the customer accordingly / block Upgrade Prod Environment

on all necessary activities to support the upgrade.

Multiple team members may be involved depending on the scope of upgrade, any integrations involved, special considerations, etc.

15

IQVIA Engineer

Check to confirm the customer PROD MAIN / TEST infrastructure state will properly support upgrade version.

Due to enhancements or fixes related to security findings, engineering may need to check the infrastructure state of PROD / TEST to confirm if any additional changes or considerations are necessary to successfully support the upgrade.

16

IQVIA PM

Inform the customer of the preferred time slot in Service Desk Ticket, and receive confirmation / agreement.

Schedule the time slot chosen in the agenda of the IQVIA engineer (and wider implementation team if deemed necessary)

13

Customer

Create a service desk ticket formalising the request for upgrade of the Customer Prod Main and Test instances

14

17

Day of Upgrade

Hours

Customer

Ensure all activity on Prod

Main

MAIN / TEST has ended (including lab data transfers)

and confirm to IQVIA engineer in the corresponding service desk ticket15

.

18

Customer

Ensure any updates to existing data is done, if needed.  

If a customer is traversing many versions of ClinSpark in an upgrade cycle, significant changes may have occurred

to e.g. database tables.

For example it might be important to ensure that all sample processing paths are complete before upgrading.

16

to the data model or to certain features which may require additional checks and updates to occur. These would have been identified and included as part of the customer’s validation testing.

19

Customer

Inform the IQVIA team in the corresponding service desk ticket that the upgrade can proceed.

20

IQVIA Engineer

Take backup of Prod

Main

MAIN and

Test

TEST - should rollback be required

17

21

IQVIA Engineer

Start actual upgrade of Prod

Main

MAIN

Pay special attention to configuration items

18
22

IQVIA Engineer

Inform Customer (via service desk ticket) once Prod

Main

MAIN is upgraded

19

23

Customer

Perform final testing / validation, including QC of configuration items

3-5 hours?

20
24

Customer

Go / No-

No

Go decision

If all is well, confirm that last the validation confirmation steps, including QC of configuration items, has been performed / all is per expectations and that IQVIA engineer can start with upgrade of Prod

Test

TEST instance. In case of issues, decide to revert back to the old situation/re-install the backup (< 1 hour)

Customer PM and decision makers need to be available to make decisions, should things not go as planned.

21
25

IQVIA Engineer

Start actual upgrade of Prod

Test

TEST

Pay special attention to configuration items

22
26

IQVIA Engineer

Inform Customer representative (via service desk ticket) once Prod

Test

TEST is upgraded

23

27

Customer

Perform final testing/validation, including QC of configuration items

24

28

Customer

Confirm that last validation confirmation steps, including validation of configuration items, has been performed / all is per expectations and that the ticket can be closed