webclient workflow Install Notes

ARCH i2b2 Plugin - notes

The ARCH plugin consists of 2 components:

• A main plugin (the PatientSetViewer) is the primary interface with the user. It is used to query the ARCH SHRINE adapter for data set requests, generate data sets based on the request criteria, and upload those data sets to the ARCH portal.
• A helper plugin (the ShrineConnector) that is used by the main plugin to query the SHRINE adapter

User requirements

In order to access and use the ARCH plugin, the i2b2 user (functioning in the role as a local site's data steward) must have the following i2b2 roles in the ARCH project:

• Admin: Manager
• Data Path: De-identified Data, Limited Data Set, Protected

!Quickstart Guide to Install!

1. Deploy the webclient-workflow folder to your webserver
2. Set up the i2b2_config_data.js as per the normal webclient
3. Set up SHRINE specific connection at js-i2b2/cells/SHRINE/cell_config_data.js
4. Set up connection to AWS in js-i2b2/cells/plugins/ARCH/PatientSetViewer/config.php
5. In the same config.php above, make sure the patient set directory exists on the server.
6. The cell relies on the workplace cell! Make sure it is set up and that the WORKPLACE_ACCESS table is populated as per usual i2b2 setup (verify that you can see your username in the workplace).
7. Log into the webclient, open the javascript console, and run i2b2.PatientSetViewer.ShrineConnector.setWorkplaceRootIndex(userId) once to create the correct workplace root folder.

Additional Site Code setup, for uploading to the SSP (portal)

• Replace all instances of ARCH-Local-Site with your local site code in i2b2 request data templates (e.g. 'BCH', 'PHS', etc.) Template code exists at the following locations:
  • worker_sxe.php
  • webclient/js-i2b2\cells\plugins\ARCH\PatientSetViewer\config.php