SurveyTool Step-by-step setup

Out of Date. To fix in https://unicode-org.atlassian.net/browse/CLDR-14213

(Prerequisite: you must first be able to see the "CLDR Web Applications" webpage using either Eclipse or Ant based setup)

Step by Step Configuration

(Ant users: The instructions and video assume Eclipse. You will find context.xml in the tomcat../conf directory, and you will have to restart Tomcat from the command line. Sorry.)

Video: http://www.youtube.com/watch?v=CCirfKI0TdQ

    1. (video time: 0:39) Right-click on the "cldr-apps" project,

    2. choose Run-as->Run On Server

    3. 1:27 you should see the "CLDR Web Applications" appear, stating that the SurveyTool is in setup mode.

    4. Click on CLDR Survey Tool

    5. 1:46 you will see "Administrator: please open the file /..../admin.html". Click on this link, or, open the file to which it refers. (the link may not work in your browser due to security reasons.)

    6. 1:52 click on the "Setup" link in the admin.html local file.

    7. 2:08 You should see "SurveyTool Configurator .. Set Parameters".

    8. (If you see a message which says "The SurveyTool is not in Setup mode", don't worry, just do the following:

    9. #1 click on the "go into setup mode" button. You should see "Now restart the server", so:

    10. #2 in the Servers tab of Eclipse (Window menu -> Show View -> Other.. -> Servers),

    11. right-click on "Tomcat ...,Server at localhost" and choose Restart"

    12. #3 refresh the "Now restart the server" page, it should now say "SurveyTool Configurator".)

      1. You can learn more about these properties at this page: cldr.properties

    13. 2:09 - the CLDR_VAP is your master/admin password. You can leave it as is or change it.

    14. (If you change it, delete the "admin.html" file so that it will be recreated with the correct password.)

    15. Click Save and Continue to go to the next page..

    16. 2:18 - CLDR_DIR - type in the full path to the root where you checked out CLDR - this directory must contain "common", "seed", etc.

    17. Example 1: if you checked out individual directories in eclipse piecemeal, give your workspace path here. ( /home/user/workspace ).

    18. Example 2: if you checked out all of CLDR somewhere, give that path. ( /home/user/src/cldr-trunk/ ).

    19. ( If you leave the default value, you will be prompted to check-out a new, separate copy of CLDR.)

    20. Click Save and Continue to go to the next page...

    21. 2:39 - CLDR_OLDVERSION - Type in the suggested "old" value. This is the "previous" CLDR version.

    22. Click Save and Continue to go to the next page...

    23. 2:44 - CLDR_NEWVERSION - Type in the suggested "new" value. This is the "new" CLDR version.

    24. Click Save and Continue to go to the next page...

    25. 2:54 - CLDR_PHASE - Leave this at "BETA"

    26. Click Save and Continue to go to the next page...

    27. 2:59 - CLDR_MESSAGE - leave this blank.

    28. Click Save and Continue to go to the next page...

    29. 3:04 - CLDR_HEADER - this the Welcome message given at the top of each page. Change it or remove it entirely, or leave it alone.

    30. Click Save and Continue to go to the next page...

    31. There will be a delay at this point - the OLD and NEW CLDR versions are automatically being checked out.

  1. 3:38 -If you see an X next to CLDR_DIR Verifying CLDR_DIR - if CLDR_DIR is not valid, you will be given the option and guidance to execute a "svn checkout" to make CLDR_DIR valid. Then, refresh the webpage.

  2. (Recommended: If your CLDR_DIR is already valid, you can skip this step.)

    1. 4:51 - if CLDR_DIR shows up with a checkmark next to it. it is now valid and you can continue.

    2. 4:53 - Setting up a database.

    3. Recommended: use MySQL. See SurveyTool Database configuration. for details.

    4. MySQL #1#2#3 ( hit the "MySQL Configurator" button and follow the instructions, also see this page

    5. The configurator will finish with a chunk of XML in a dialog for you to copy.)

    6. #3 5:22 hit Control-Shift-R ( Command-Shift-R ) and search for context.xml.

    7. (It is inside the Servers project on the left hand side of your Eclipse Projects)

    8. #4 5:29 Paste the chunk of text just before the closing </Context> tag in the context.xml file.

    9. #5 Save this context.xml file

    10. #6 5:52 Right click on the Tomcat server and Restart

    11. #7 6:07 Reload the webpage- Now your Database should be valid! (Should see a checkmark next to 1 and 2 in the box)

    12. 6:13 - click Remove Maint Mode

    13. 6:20 - Restart your server one more time..

    14. 6:48 - SurveyTool is now running!

    15. 6:52 - from "admin.html" (reload admin.html if you had deleted it) you can click the "Admin Panel" link to login to the SurveyTool as administrator.

      1. Note 1: There's a "Create Test User" link in the admin panel, that will let you create a random test user.

      2. Note 2: to login as admin, the email is "admin@" and the password is your CLDR_VAP password.