OVERVIEW

By applying this patch, you are making the following changes to your ACT Test network web client:

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

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: 

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

Validate the change by logging into the shrine application (web client) on the Test network and observing the yellow "COVID-19 Network Info" link in the upper right. Click that link to open a Google Sheet of information about the state of nodes providing covid19 data on ACT Test. 

 

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

RESTORATION OF PATCH (only if necessary)

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. 

Adding a Help Link to the New Webclient

The User Profile menu seen below comes with two default links "Application Help" and "Network Help".  

To add additional help links, 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 docs link provided when clicked.

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"
    }
 }

After restarting tomcat, the new "Site Data Details" link will be displayed in the User Profile menu:

Changing the Network Help link in the Legacy Webclient.

The Legacy Webclient has a Network Help link in the upper right that is customizable.  

To customize this link, go to: /opt/shrine/tomcat/webapps/shrine-api/shrine-webclient-legacy

and open the file index.html in a text editor.

To change the title of the link go to line 538 and you will see the current setting "Network Help".

To change this link replace "Network Help" with the title of your choosing, in this example we are changing the title to "Site Data Details"

Now, to change the url that the link points to, go to around line 323 and you will see a networkHelp.onclick method that will direct the user to a local .pdf file when clicked.

Change the url to your desired link.  Note the comma following the end quote...be sure to keep this in place.  In the example below, we are changing the url to a google docs link.