Changes between Version 2 and Version 3 of SIS/UI/Tutorial-v1.0/Intro


Ignore:
Timestamp:
06/20/12 14:13:16 (5 years ago)
Author:
skientz
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • SIS/UI/Tutorial-v1.0/Intro

    v2 v3  
    2929      [#CreateNewLocation Create New Location] 
    3030 
    31     [#Other Links in this Section] 
     31    [#OtherLinksInThisSection Other Links in this Section] 
    3232 
    3333  [#Section_Instruments Section: Instruments] 
     
    8989This takes you to the login form that requests your username and password: 
    9090 
    91 Figure 1: Login form 
     91 
     92[[Image(LoginForm.PNG, center)]] 
     93 
     94 
     95{{{ 
     96#!html 
     97<p style="text-align: center"> 
     98Figure 1: Login Form 
     99</p> 
     100}}} 
    92101 
    93102 
     
    96105When you are logged in, a link to change your password appears in the top-right corner: 
    97106 
     107 
     108[[Image(AuthUserHeaderLinks.PNG, center)]] 
     109 
     110 
     111{{{ 
     112#!html 
     113<p style="text-align: center"> 
    98114Figure 2: New links appear in the header for authenticated users 
    99 Logging out 
     115logging out 
     116</p> 
     117}}} 
    100118 
    101119When you are done, please remember to click on the link ‘Log out’ in the top-right corner to end your session. This prevents unauthorized changes to the database from your account. 
    102 SIS Home Page 
     120 
     121== [=#SISHomePage SIS Home Page] == 
    103122 
    104123The Home Page is divided into the following sections: 
    105 Stations 
     124 
     125 Stations:: 
    106126    Links to the station pages and station/channel reports. 
    107 Instruments 
     127 Instruments:: 
    108128    Links to the instrument inventory and reports. 
    109 Devices 
     129 Devices:: 
    110130    Links to the non-response (power/telemetry) hardware and reports. 
    111 Section: Stations 
     131 
     132== [=#Section_Stations Section: Stations] == 
     133 
    112134Links to the station pages and station/channel reports: 
    113 Jump to Station 
     135 
     136=== [=#JumpToStation Jump to Station] === 
     137 
    114138This link takes you to a form to select a netcode from a dropdown menu, and a textbox to enter the desired station code (your entry for the station code is converted to uppercase before being processed by the database). Click the button to submit the form.   
    115139 
    116 Figure 3: Jump to Station form 
     140[[Image(JumptoStation.PNG, center)]] 
     141 
     142 
     143{{{ 
     144#!html 
     145<p style="text-align: center"> 
     146Figure 3: Jump to Station Form 
     147</p> 
     148}}} 
     149 
    117150 
    118151The (netcode, stationcode) uniquely identifies a station in the SIS database. If the submitted (netcode, stationcode) exists in the database, you are re-directed to the station’s summary page.  Every station in SIS has its own summary page accessible by either: 
    119     1. station database id (e.g. /sis/station/31/summary/) 
    120     2. Netcode and station-code (e.g. /sis/station/?net=CI&sta=BAR) 
     152   1. station database id (e.g.,  !/sis/station/31/summary/) 
     153   1. Netcode and station-code (e.g.,  !/sis/station/?net=CI&sta=BAR) 
    121154 
    122155More information about the Station Summary page can be found in the document:___ 
    123 Telemetry Locations 
     156 
     157=== [=#TelemetryLocations Telemetry Locations] === 
     158 
    124159This link takes you to the list of telemetry hub locations in SIS.  When you are logged in, there is a link on this page to create a new telemetry location. 
    125 Create New Location 
    126  
    127 The Location Form displays the fields for in the location header: 
    128  
     160 
     161{{{ 
     162image capture missing here, fig. 4 
     163}}} 
     164 
     165 
     166==== [=#CreateNewLocation Create New Location] ==== 
     167 
     168The Location Form displays the fields found in the location header: 
     169 
     170[[Image(LocationHeaderForm.PNG, center)]] 
     171 
     172{{{ 
     173#!html 
     174<p style="text-align: center"> 
    129175Figure 5. Location Form 
     176</p> 
     177}}} 
    130178 
    131179Note: The Email Update Codes is an SCSN-specific field referring to the ‘station’ codes used by email archive database. 
    132 Enter the values (required fields are in bold) and submit the form to create a new location. If there are no errors, you are re-directed to the location’s summary page. More information about the location’s 
    133 summary page is contained further on in this document. 
    134 Other links in this section 
     180 
     181Enter the values (required fields are in bold) and submit the form to create a new location. If there are no errors, you are re-directed to the location’s summary page. More information about the location’s summary page is contained further on in this document. 
     182 
     183=== [=#OtherLinksInThisSection Other links in this section] === 
    135184 
    136185Google Earth KML files 
     
    138187 
    139188ARRA extension data 
     189 
    140190This link takes you to the sub-section dealing with information specific to the SCSN ARRA upgrades. Information in this section: 
    141     1. Station Telemetry-types (qualitative description of the station telemetry) 
    142     2. Station Landowner-types (landowner information) 
    143     3. Station upgrades progress (Google map of the progress) 
    144  
    145 Stations by network 
     191 1. Station Telemetry-types (qualitative description of the station telemetry) 
     192 1. Station Landowner-types (landowner information) 
     193 1. Station upgrades progress (Google map of the progress) 
     194 
     195Stations by Network 
     196 
    146197This link takes to a list of the existing networks in the SIS database. The list contains both SCSN-operated and imported networks.  Click on a netcode link to view the station list for that network. 
    147198 
     
    149200This is a report of the currently installed loggers of a selected type.   
    150201 
    151 1. The user selects the desired loggertype(s) (checboxes) 
    152  
    153 2. Optionally filter the results by logger owner  (dropdown) 
    154  
    155 3. Optionally export the results to a .csv file that is readable by a spreadsheet program. 
     202 1. The user selects the desired loggertype(s) (checboxes) 
     203 
     204 1. Optionally filter the results by logger owner  (dropdown) 
     205 
     206 1. Optionally export the results to a .csv file that is readable by a spreadsheet program. 
    156207The user can sort the table by clicking on the arrows in the columns of the table display. 
    157208 
    158209Stations by sensortypes 
     210 
    159211This is a report of the currently installed sensors of a selected type, along with the sensor’s logger. 
    160212 
    161 1. The user selects the desired sensortype(s) (checkboxes) 
    162  
    163 2. Optionally filter the results by logger owner (dropdown) 
    164  
    165 3. Optionally filter the results by sensor owner (dropdown) 
    166  
    167 4. Optionally export the results to a .csv file that is readable by a spreadsheet program. 
     213 1. The user selects the desired sensortype(s) (checkboxes) 
     214 
     215 1. Optionally filter the results by logger owner (dropdown) 
     216 
     217 1. Optionally filter the results by sensor owner (dropdown) 
     218 
     219 1. Optionally export the results to a .csv file that is readable by a spreadsheet program. 
    168220The user can sort the table by clicking on the arrows in the columns of the table display. 
    169221 
    170222Instruments at active stations 
    171 This is a report of the currently installed loggers and sensors of selected type. This report allows the user to query for the stations that have a logger of selected type AND a broadband of a selected type AND an accelerometer of a selected type (i.e. the resultset is the intersection, not union). 
     223 
     224This is a report of the currently installed loggers and sensors of selected type. This report allows the user to query for the stations that have a logger of selected type AND a broadband of a selected type AND an accelerometer of a selected type (i.e., the resultset is the intersection, not union). 
    172225 
    173226Recent Response Changes 
     227 
    174228This report lists the stations and channel epoch ondate of the response changes logged in SIS.  The user can filter by netcode, epoch ondate range.   
     229 
    175230Note: Filtering the resultset by the list of common ‘reasons’ is only available for stations where field actions were recorded via SIS.  This means it is generally not available for imported stations. 
    176231 
    177232More Station Reports 
     233 
    178234Sub-section that lists the available station-oriented reports generated by SIS. 
     235 
    179236Section: Instruments 
     237 
    180238Links to the instrument inventory and reports 
    181239 
    182240Limitation: Although the SIS database schema is capable of storing various types of instruments such as amplifiers, discriminators, etc, the web interface currently only shows the inventory for sensors and dataloggers.  Future development will focus on generalizing instrument-types for the web UI. 
     241 
    183242Sensortypes 
     243 
    184244This section concerns the sensor inventory and related information. 
    185245The existing sensortypes (AKA sensor models) are listed, categorized under: 
     
    187247    BAROMETER 
    188248    VELOCITY TRANSDUCER 
     249 
    189250Limitation: Creating a new sensortype is currently executed via command-line scripts. Future development will allow this functionality through the UI. 
     251 
    190252Inventory 
     253 
    191254Click on the link ‘Sensors’ for any of the existing sensortypes.  This takes you to a report of the existing sensors of that model.  The user can filter the list by owner and/or inventory status. 
     255 
    192256Tip: To quickly find a sensor in the inventory list, use your browser’s Search tool (CTRL-F on most browsers) to search for a sensor by serialnumber. 
    193257 
    194258The table displays the list of sensor serialnumbers along with some of the attributes contained in the sensor header.  The attributes in the table are: 
    195 1. Serialnumber  (unique per sensortype) 
    196 2. Inventory Status. Possible choices are: 
     259 
     260 1. Serialnumber  (unique per sensortype) 
     261 1. Inventory Status. Possible choices are: 
    197262    INSTALLED:  instrument is currently installed at a station 
    198263    INVENTORY:  instrument is not currently installed, is in the inventory pool 
     
    200265    REPAIR:  instrument is in repair 
    201266    UPGRADED-RANGE:  This status was created to handle sensor upgrades based on         the input range of the sensor (e.g. 2G sensor upgraded to 4G sensor). 
    202 3. Owner agency 
    203 4. Propertytag (owner-assigned propertytag if exist) 
    204 5. Date Acquired  (instrument acquisition date if known) 
    205 6. Channeldefaults  (read-only field used internally by SIS) 
     267 1. Owner agency 
     268 1. Propertytag (owner-assigned propertytag if exist) 
     269 1. Date Acquired  (instrument acquisition date if known) 
     270 1. Channeldefaults  (read-only field used internally by SIS) 
    206271 
    207272The table display links each sensor serialnumber to the sensor’s summary page. 
    208273Every sensor in SIS has a summary page that displays information particular to that sensor. 
     274 
    209275Create New Sensor 
    210276 
    211277For authenticated users, there is a link on each sensortype’s inventory page to create a new sensor of that model. Click on the link ‘Create new sensor’ to get to the New Sensor Form: 
    212278 
     279[[Image(NewAccelSensorForm.PNG, center)]] 
     280 
     281{{{ 
     282#!html 
     283<p style="text-align: center"> 
    213284Figure 6. Create New Sensor Form (for Accelerometer) 
     285</p> 
     286}}} 
    214287 
    215288The New Sensor Form contains 2 fieldsets: 
    216 1. Sensor header fields  (serialnumber must be unique for a given model) 
    217 2. Initial Calibration fields  (instrument response per component, per date-calibrated). Multiple calibrations can exist over the lifetime of a sensor; this is to specify an initial state. 
     289 
     290 1. Sensor header fields  (serialnumber must be unique for a given model) 
     291 1. Initial Calibration fields  (instrument response per component, per date-calibrated). Multiple calibrations can exist over the lifetime of a sensor; this is to specify an initial state. 
    218292 
    219293Enter the values and submit the form to create a new sensor instrument in the database. 
     294 
    220295Tip: To create multiple sensors in succession, click on the ‘Save and add another’ button as a shortcut to return to this form. 
    221296If there are no errors in the submitted data, you are re-directed to either: 
    222297 
    223 1. The sensor’s summary page  (if you clicked Submit). 
    224  
    225 2. Back to this form (if you clicked Save and Add another).  You should see a message         indicating that your previous submit has been successfully processed. 
     298 1. The sensor’s summary page  (if you clicked Submit). 
     299 1. Back to this form (if you clicked Save and Add another).  You should see a message         indicating that your previous submit has been successfully processed. 
     300 
    226301By default, a new sensor is created with inventory status=’INVENTORY’.  This inventory status implies that the sensor is ready to be installed at a station. 
     302 
    227303More information about the sensor summary page is contained further on in this document. 
     304 
    228305Loggertypes 
     306 
    229307This section concerns the datalogger inventory and related information. 
    230308 
    231309The existing loggertypes (AKA logger models) are listed with links to their inventory pool. 
    232310Limitation: Creating a new loggertype is currently executed via command-line scripts. Future development will allow this functionality through the UI. 
     311 
    233312Inventory 
    234 Click on the link ‘Iinventory’ for any of the existing loggertypes.  This takes you to a report of the existing loggers of that model.  The user can filter the list by owner and/or inventory status. 
     313 
     314Click on the link ‘Inventory’ for any of the existing loggertypes.  This takes you to a report of the existing loggers of that model.  The user can filter the list by owner and/or inventory status. 
    235315Tip: To quickly find a logger in the inventory list, use your browser’s Search tool (CTRL-F on most browsers) to search for a logger by serialnumber. 
    236316 
     317 
    237318The table displays the list of logger serialnumbers along with some of the attributes contained in the logger header.  The attributes in the table are: 
    238 1. Serialnumber  (unique per loggertype) 
    239 2. Inventory Status. Possible choices are: 
     319 1. Serialnumber  (unique per loggertype) 
     320 1. Inventory Status. Possible choices are: 
    240321    INSTALLED:  instrument is currently installed at a station 
    241322    INVENTORY:  instrument is not currently installed, is in the inventory pool 
    242323    INACTIVE: instrument is no longer in commission (inactivated from the pool) 
    243324    REPAIR:  instrument is in repair 
    244 3. Owner agency 
    245 4. Propertytag (owner-assigned propertytag if exist) 
    246 5. Electronic Serialnumber (manufacturer-assigned, if applicable) 
    247 6. Date Acquired  (instrument acquisition date if known) 
    248 7. Channeldefaults  (read-only field used internally by SIS) 
     325 1. Owner agency 
     326 1. Propertytag (owner-assigned propertytag if exist) 
     327 1. Electronic Serialnumber (manufacturer-assigned, if applicable) 
     328 1. Date Acquired  (instrument acquisition date if known) 
     329 1. Channeldefaults  (read-only field used internally by SIS) 
    249330 
    250331The table display links each logger serialnumber to the logger’s summary page. 
    251332Every logger in SIS has a summary page that displays information particular to that logger. 
     333 
    252334Create New Logger 
     335 
    253336For authenticated users, there is a link on each loggertype’s inventory page to create a new logger of that model. Click on the link ‘Create new logger’ to get to the New Logger Form: 
    254337 
     338[[Image(NewLoggerSetupForm.PNG, center)]] 
     339 
     340{{{ 
     341#!html 
     342<p style="text-align: center"> 
    255343Figure 7: New Logger Part 1 form 
     344</p> 
     345}}} 
     346 
    256347Enter the values (required fields are in bold) and click Continue.  The logger is not yet created; the second part is the form for the initial calibration: 
    257348 
     349[[Image(NewLoggerPart2Form.PNG, center)]] 
     350 
     351{{{ 
     352#!html 
     353<p style="text-align: center"> 
    258354Figure 8: New Logger Part 2 form 
     355</p> 
     356}}} 
    259357 
    260358The form is initialized with: 
    261359 
    262 1. the default number of boards for this loggertype (AKA sensor ports) 
    263  
    264 2. the default number of modules per board (AKA channel cards) 
    265  
    266 3. the default response for each module (sensitivity and frequency-of-sensitivity). 
     360 1. the default number of boards for this loggertype (AKA sensor ports) 
     361 
     362 1. the default number of modules per board (AKA channel cards) 
     363 
     364 1. the default response for each module (sensitivity and frequency-of-sensitivity). 
    267365Enter in the date-calibrated and the board serialnumbers. The initial calibration date must be prior to the first install date of the logger. Multiple calibrations can exist over the lifetime of a logger; this is to specify an initial state. 
    268366 
     
    270368If there are no errors in the submitted data, you are re-directed to either: 
    271369 
    272 1. The logger’s summary page  (if you clicked Submit). 
    273  
    274 2. Back to the logger setup form (if you clicked Save and Add another).  You should         see a message indicating that your previous submit has been successfully processed. 
     370 1. The logger’s summary page  (if you clicked Submit). 
     371 
     372 2. Back to the logger setup form (if you clicked Save and Add another).  You should         see a message indicating that your previous submit has been successfully processed. 
     373 
    275374By default, a new logger is created with inventory status=’INVENTORY’.  This inventory status implies that the sensor is ready to be installed at a station. 
     375 
    276376More information about the logger summary page is contained further on in this document. 
    277 Owner agencies 
     377 
     378Owner Agencies 
     379 
    278380This link takes you to the list of owner agencies in SIS.  The owner list is referenced by both the instrument inventory and the non-response hardware inventory to store ownership attribute of the instrument/device. When you are logged in, there is a link on this page to create a new owner. 
    279381 
    280382Create New Owner 
    281383 
     384 
     385[[Image(OwnerForm.PNG, center)]] 
     386 
     387{{{ 
     388#!html 
     389<p style="text-align: center"> 
    282390Figure 9. Owner Form 
     391</p> 
     392}}} 
     393 
    283394The owner code must be unique in the list of owners. Enter the values and submit the form. If there are no errors, you are re-directed to the owner’s summary page.  In addition, the new owner is now present in the Owner dropdown menu in other forms. 
    284395The owner’s summary page contains links to all the loggers and sensors owned by itself. 
     
    291402 
    292403Limitation: The devicetypes are placed into either the Power or Telemetry hardwaretype category. Future development will focus on making the hardware category extensible. 
     404 
    293405Create New Devicetype 
     406 
    294407For authenticated users, there is a link in the Power Devicetypes section to create a new Power devicetype, and a similar link in the Telemetry section to create a new Telemetry devictype. Clicking on the link takes you to a form: 
    295408 
     409 
     410[[Image(DevicetypeForm.PNG, center)]] 
     411 
     412{{{ 
     413#!html 
     414<p style="text-align: center"> 
    296415Figure 10. Devicetype form 
     416</p> 
     417}}} 
    297418 
    298419The fields of the devicetype header are: 
     
    311432For authenticated users, a link appears to create a new devicemodel in the Devicemodels section. Click on the link ‘Create new devicemodel’ to get to the form  (this example figure is for the CELLULAR-MODEM devicetype) : 
    312433 
     434 
     435[[Image(DevicemodelForm.PNG, center)]] 
     436 
     437{{{ 
     438#!html 
     439<p style="text-align: center"> 
    313440Figure 11. Devicemodel Form 
     441</p> 
     442}}} 
    314443 
    315444The fields of the devicemodel header (for all devicetypes) are: 
     
    328457    If the devicetype is non-inventoryable: the devicemodel summary page states that an anonymous device is automatically created upon installation at a location. (Installing devices is explained further on in this document).  
    329458 
     459 
     460[[Image(DeviceForm.PNG, center)]] 
     461 
     462{{{ 
     463#!html 
     464<p style="text-align: center"> 
    330465Figure 12. Device Form 
     466</p> 
     467}}} 
    331468 
    332469Regardless of how it was created, the fields of the device header are 
     
    351488COSMOS V0 
    352489Related SIS-Tutorial Documents 
    353 Station/Channel data 
     490!Station/Channel data 
     491 
    354492The Station Summary page displays information specific to a station. It allows authenticated users to modify the station metadata. 
     493 
    355494Instrument inventory/response 
     495 
    356496The Sensor Summary page displays information specific to the sensor. For authenticated users, the summary page shows links to modify the sensor’s response. 
     497 
    357498Power/Telemetry hardware 
     499 
    358500The Logger Summary page displays information specific to the logger. For authenticated users, the summary page shows links to modify the logger’s response.