Page History
Warning |
---|
The patch configurations detailed on this page is only for nodes participating in the ACT Test network.Production network and after upgrading to SHRINE 3.0 |
OVERVIEW
By applying this patch, you are making the following changes to your ACT Test network web client:following these steps you are adding a link to a Google Sheet in each of the web clients available in SHRINE 3.0:
- Legacy Web Client: Change the default Change the "Network Help" link in the upper right of the web client to read "COVID-19 Network Info"
- Change the text color of the link
- Change the destination of the link
See "Validation" for the expected appearance in the web client. The destination of the link is a Google Sheet.
- Site Data Details"
- New Web Client: Adding a "Site Data Details" link to the user profile menu, which links to the same Google Sheet.
The destination for these links is: https://docs.google.com/spreadsheets/d/16Z23xRbeyvcnM_BEtecgMQDFCL0BOTUDZiZLfkdmV-0/edit#gid=0
New Web Client: Adding "Site Data Details" to User Profile Menu
DEFAULT CONDITIONS
The User Profile menu seen below comes with two default links "Application Help" and "Network Help".
PROCEDURE
In the webclient section of shrine.conf, add a helpLinks section with a "site name" : "site url" name value pair. In the example below, a link with the title "Site Data Details" will be added as a help link and it will open the google sheet link provided when clicked.PROCEDURE
Replace shrine's existing tomcat/webapps/shrine-api/shrine-webclient/index.html with this modified index.html. Most shrine nodes have this file installed at /opt/shrine/tomcat/webapps/shrine-api/shrine-webclient/index.html , but yours may have a different path from root to tomcat.
For most systems these shell commands will make the change:
Code Block | ||||
---|---|---|---|---|
| ||||
cd /opt/shrine/tomcat/webapps/shrine-api/shrine-webclient/
wget -O index.html https://open.catalyst.harvard.edu/wiki/download/attachments/77040288/index.html |
VALIDATION
...
webclient {
domain = "shrine-webclient-dev-node01.catalyst.harvard.edu"
name = "SHRINE"
nextStepsUrl = "https://www.actnetwork.us/national"
urlCellPM = "http://shrine-webclient-dev-node01-i2b2.catalyst.harvard.edu:9090/i2b2/services/PMService/"
siteAdminEmail = "isha_test@goo.com"
usernameLabel = "isha_test"
passwordLabel = "isha_test"
queryFlaggingInstructions = "isha_test"
flaggingIconInstructions = "isha's test flagging"
flaggingPlaceholderText = "isha's sample message"
helpLinks = {
"Site Data Details": "https://docs.google.com/spreadsheets/d/16Z23xRbeyvcnM_BEtecgMQDFCL0BOTUDZiZLfkdmV-0/edit#gid=0"
}
} |
VALIDATION
After restarting tomcat, the new "Site Data Details" link will be displayed in the User Profile menu:
Legacy Web Client: Changing "Network Help" to "Site Data Details"
DEFAULT CONDITIONS
The Legacy web client has a Network Help link in the upper right by default. We will change that text and link destination..
PROCEDURE
Click this link: index.html to download a new index.html with the updated Site Data Details link.
Use it to replace the existing index.html file located at
REVERTING (only if necessary)
Should you need to restore the original shrine-api application's index.html: Stop tomcat; delete : /opt/shrine/tomcat/webapps/shrine-api; start tomcat. At start-up tomcat will unpack the shrine-ap.war restoring the original /shrine-webclient-legacy/index.html .
RESTORATION OF PATCH (only if necessary)
In the legacy web client, you should see the Site Data Details link in the upper right.
If you replace shrine-api.war with a newer version then you will need to install this patch again to restore the appearance and destination of the link.