Steven R. Loomis srl@icu-project.org. Updated 2008 Feb 22
Copyright 2008 IBM and others. All Rights Reserved
This document is directed towards the Operation of the Survey Tool. Please see 'readme.txt' in this directory for the building and installation of the survey tool.
Read the readme.txt in this dir. You should have:
You can log in as the Administrator account with the email address 'admin@' and the password specified in the CLDR_VAP parameter in the cldr.properties file.
When logged in, you will see a red bar at the top of the page that says:
'Be careful, you are an administrator!'
This is here to warn you that some normal user safeguards are not in place, and also that you have access to advanced functions. Also, it reminds you that your votes have 'override' capability.
As the administrative account has override capability, it is possible to break ties. As well, another user named "Admin Override" was added, with level zero (admin). In theory it has full administrator access as well. However, we have given its access out to a select few TC members, with the express instruction that they were not to play with any of the other buttons, but just to cast the overriding votes where the TC had decided to do so.
The SQL interface provides access to more or less anything that the admin interface does not cover. It is both powerful and dangerous and will be covered separately. SQL access does not actually require a login, but uses a special URL which includes the admin password. So, SQL activity can be done without logging in if the URL is kept.
The "Manage users for.." link works for the Admin user as it does for others, however all users are visible, not just those of one organization. There are a few extra options, as well.
The "Admin" link in the top right corner brings up the "SurveyTool Administration" panel. It has two levels, the "main" level (fairly safe), and the "EXPERT" level (dangerous, possibly experimental). The EXPERT-ADMIN-use-only link brings up the additional items.
As with SQL, Admin does not actually require a login, but uses a special URL which includes the admin password. So, Admin activity can be done without logging in if the URL is kept.
This section describes settings found in the cldr.properties
file inside the cldr directory. SurveyTool must be
restarted for these to take effect.
By default, the ST runs in "unofficial mode" and declares itself to be so with a banner. Setting CLDR_OFFICIAL=yes
causes this banner to be hidden.
The "Phases" (vetting, submission, etc) are controlled by the CLDR_PHASE
parameter. For example, set CLDR_PHASE=SUBMIT
to use the Data Submission phase. As of this writing, the valid phases are: SUBMIT VETTING VETTING_CLOSED CLOSED DISPUTED FINAL_TESTING READONLY BETA
Set CLDR_OLDVERSION=1.5.1
to indicate the prior version of CLDR which will be picked up via CVS, in other words, the version which is currently present in common in XML form.
Set CLDR_NEWVERSION=1.6
to indicate the new version of CLDR which is being worked on.
Various messages can be shown to users either by configuration parameters, or at run-time for things such as closing for maintanance, announcement of news, etc.
CLDR_HEADER
- this property displays a message at the top of the page without preventing user login. It can be set temporarily in the "Update Special Message" area of the Admin panel.
CLDR_LOCKOUT
- this property locks out all users who do not have the specified passcode. For example, if 'CLDR_LOCKOUT=zanzibar', then users must visit the URL …apps/survey?unlock=zanzibar to log in. This is used for special-purpose testing.
Here are some Survey Tool tasks, with instructions.
During the Beta process, users may input any data to test the SurveyTool. At the end of the Beta period, all data is deleted, and reloaded from CVS.
cldr/
directory from the serverdrop table CLDR_DATA
drop table CLDR_SRC
Name: User name (can be in their native script, but may want to include Latin transliteration)
Email: User's email
Organization: Organization or group. Should be spelled as seen on previous page.
Userlevel: Set to 1 to create a TC for the specific organization or 5 for a vetter.
Locales responsible: Can be left blank for TC. For vetter, should be a list of locales they have write access to.
Some tasks do not have a nice UI yet, however, they can be accomplished through the SQL Console.
select * from cldr_users where name like '%Jones%'
select distinct org from cldr_users where org like '%United Vetters%'
update cldr_users set org='United Vetters' where id=731 and name='Vet R. Jones'
select * from cldr_users where name like '%Jones%'