Implementation Tasks

Infrastructure Components

All pre-existing (MyEd)

Application Components

Deploy survey proxy service

Use bamboo to deploy the spring boot survey proxy application.

1. Drain connections from the four KB MyEd servers (Dev Tech)
2. Go to build 13 of the application plan: https://www.bamboo.is.ed.ac.uk/browse/UPORTALFOUROTWELVE-MYEDSP-13
3. Deploy to the KB servers for live environment
4. Check deployment on each of the four KB MyEd servers
5. Return the four KB to service (Dev Tech)
6. Repeat steps 1-5 for AT servers

Deploy web files (Skip this step - already live thanks to build #313)

Use bamboo to deploy the web files containing the updated channel.

1. Go to build 312* of the web files plan: https://www.bamboo.is.ed.ac.uk/browse/UPORTALFOUROTWELVE-WEBFILES-312
2. Deploy to test or live environment

* If this build is not the most recent build, you should confirm which to use.

Application Setup

Configure MyEd channels

1. Log into MyEd. You must have admin permissions.
2. Click Admin -> Manage Portlets
3. Search for surveys
4. Edit 'Student Surveys'
5. Go to 'Preferences' - 'Edit Rich Configuration', and change:
   1. 'General Configuration':'Base URL' = https://www-test.myed.ed.ac.uk/web_files/surveys/student.html (Change url for live environment)
   2. 'Static HTML Configuration':'Static Header' = <script> var studentSurveyProxyUrl = "/survey-proxy/student"; </script>  
6. Go back and edit 'Course Evaluation Surveys'
7. Change name from "Course Evaluation Surveys" to "Course Enhancement Questionnaires"
8. Go to 'Preferences' - 'Edit Rich Configuration', and change:
   1. 'General Configuration':'Base URL' = https://www-test.myed.ed.ac.uk/web_files/surveys/course.html (Change url for live environment)
   2. 'Static HTML Configuration':'Static Header' = <script> var courseSurveyProxyUrl = "/survey-proxy/course"; </script>

Integration Components

None

Data Population

None

Data Migration

None

Implementation Validation

Log off MyEd, then log in again (to refresh the channels).

Add both survey channels to your dashboard.

Use firebug or similar tool to inspect the channel HTML.

Look for the script tag which includes the mustache.js javascript file. It should be the only javascript file included in this way. If you see references to persistJSONP.js, up.jQuery-noconflict.cookie.js and jquery.jsonp-2.4.0.min.js, then you are looking at the old channel.

If the channel does not display any error message, then the survey proxy is working. It is normal that you do not have any surveys available because these are delivered on a per-uun basis.

Rollback

In the event of a problem, to roll back one or both channels:

1. Edit the channel(s) in the same manner as in step 3.
2. Revert the settings in 'Preferences' (for student survey):
   1. 'General Configuration':'Base URL' = https://www-test.myed.ed.ac.uk/web_files/course-surveys/content.html (Change url for live environment)
   2. 'Static HTML Configuration':'Static Header' = <script> var cookiePrefix = '001'; </script>
3. Revert the settings in 'Preferences' (for course survey):
   1. 'General Configuration':'Base URL' = https://www-test.myed.ed.ac.uk/web_files/launchers/surveys/index.html (Change url for live environment)
   2. 'Static HTML Configuration':'Static Header' = <script> // update the number to change cookie name var uoeSurveyPrefix = 'uoesurvey03-'; </script>