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

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

...

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

Image Modified

PROCEDURE

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

VALIDATION

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

Image Modified

Legacy Web Client: Changing

...

"Network Help" to "Site Data Details"

DEFAULT CONDITIONS

The Legacy Webclient web client has a Network Help link in the upper right that is customizableby default. We will change that text and link destination..  

PROCEDURE

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

...

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

VALIDATION

In the legacy web client, you should see the Site Data Details link in the upper right.

Image Added