Portal Configuration

How to Configure your Portal

Step 1

  • Log into your portal using
    User: admin@chordsrt.com
    Password: realtimedata
    

Step 1 Sign in


Step 2

  • Click on the “Configure” selection in the upper right part of the screen

Step 2 Configure

It will take you to a page called Configuration

Step 2 Configure Page

From here enter the:

  • Project name
  • DOI (optional)
  • Affiliation
  • Page title (e.g. what project you’re working on. Like Orcas, STORM, NCAR Portal, etc.)
  • Domain name: The domain name should either be the fully qualified domain name of the portal (if you have one) or the IP address of the server on which the portal is hosted, e.g. from AWS. Make sure to change the default value as archiving will fail if it is not set!
  • Time zone
  • Project Description: A short description of what your project is. This may use HTML Markup, if you haven’t used HTML markup or aren’t sure what it is, go to this link
  • Logo File: You may upload a customized logo for your portal here. It will appear in the portal header page.
  • Enter your Google Maps API Key Special note to CUAHSI workshop participants: You can cut and past this text to use as your Google Maps API Key:
      AIzaSyCaJcuGGmb9pumPJ8tptUobGUMlMWpmSRQ
    
  • Select security options. For production use we recommend that a key be used for data entry (see example in Step 4).

Once you’ve entered all of that click Save.

If you are planning to archive the data at one of NSF’s data archive sites, you can enter the archive-specific settings below. Here we use the example of settings needed for the Consortium of Universities for the Advancement of Hydrologic Science, Inc. (CUAHSI) archive:

Step 2 Archive Configure Page

Click Save.



Step 3

Note: In the following screens, it may not be obvious that you can click on the areas highlighted in light green to change the settings there.

  • Create a new Site by clicking on the Sites selection in the middle left part of the screen and clicking the Add A New Site button. Sites

Fill out the highlighted fields to create a new Site:

Name: Name of site
Lat, Lon and Elevation: Physical location of site
Site Type: Select among the terms in the pull-down menu
CUAHSI Site Code: Leave this field blank as it will be auto-configured
  • Click on the Instruments button in the middle left part of the screen. Instruments

  • Click on New Instrument, it will open up a new page where you can create an instrument.



New Instrument

  • Enter your information here and then click “Create Instrument

Definitions:

Name: The name you gave the instrument
Topic category: Pull down menu of categories of instruments
Description: (Add additional information you feel necessary here. Like location, website, or purpose.)
Site: Site that the instrument resides at

Description

Display Points: How many points are shown on the graph
Plot offset: How often the plot window should span
Sample Rate: How often you are sampling data, in seconds (fastest is 1 second)



Description



  • Click on Add a New Variable

  • Change the short name, name, units, the minimum and maximum for plotting, the measured property and general measurement category to match what your Instrument will be measuring.

Note: This will be more fully described later, but the short name you choose will be used in the URLs for entering data points. Make sure that they make sense for later use. (e.g. use a short name like temp for temperature): http://localhost:8080/measurements/url_create?instrument_id=2&temp=202.0&bv=209.5&uv=218.3&aq=231.9&at=2017-02-15T23:16:21.988Z&key=key&test)



Step 4

Now you’ve gotten logged into your portal and set up your instrument. Click on the Data URLs link in the Data Access and Downloads box. Data In

Data URLs page

This page describes how to put data into your portal and get data out via simple URLs. A data point can be submitted to a portal by just copying and pasting the URL into the address bar of a browser, using the short variable names you have set up add the key if you specified one. Thus, a sample URL to put one item of test data into your portal, using the configuration specified in these instrcutions, could be:

http://portal.chordsrt.com/measurements/url_create?instrument_id=4&depth=202.0&bv=209.5&at=2017-02-
15T23:16:21Z&key=chordskeyforvalues&test

By entering this URL in your browser, one point of test data is entered into your portal. The URL specifies that the data were collected on February 15th, 2017 at 23:16:21 GMT and that the depth value recorded was 202.0 and the battery voltage was 209.5

This method, however, isn’t meant for serious data submission as it would be more likely that you would write a script to automate the data entry via URLs rather than typing them in manually. If you’d like more information on this, the Data In tab from chordsrt.com shows code examples as well.



Step 5

Now that you’ve learned how to put Data In and Out via web services protocols, how about downloading all data across a block of time? You can do this from the Portal by clicking on “Data” Data out

Once there you can choose which instrument you want the data from, the timeframe and in what format. CHORDS offers data in

  • GeoCSV (Standardized Comma Separated Value file)
  • GeoJSON (Standardized JavaScript Object Notation file)
  • XML (Extensible Markup Language)

as options for downloading and viewing the data collected. Once you click on one of these buttons your data will be downloaded into the specified format which can be opened in Excel, Word or Notepad.

Data Download

If you’d like to see more about this, the Data out tab from chordsrt.com will provide additional information as well as programming examples.


Step 6

Now your portal is up and running and you’re ready to add your team in. But how on earth do we do that?

  • First your users will have to create an account of their own. They can do this by clicking on the “Sign In” Button at the top right hand corner of your chords site.

Sign in

  • Then Click on “Sign up

Sign up

  • They will have to enter an email and create a password of their own. Then click “Sign up

Sign up

  • When the user first signs up they won’t have any permissions so admins will have to go and grant them special permissions after they’ve created an account. Admins can assign permissions by going to “Users

Sign up

  • From there they can toggle yes or no for whether or not the users can be admins view or load data just by clicking on the yes’s and no’s highlighted in green

Users


Geo Button

When you click on the geo button you will see one of two things.

Geo Button

The first will be a map showing the areas where you have set up the instruments with some distinct geographical pointers.

The second is a satellite image showing a snapshot of the area and where you’ve specified the instruments are. Picture courtesy of Tanzania Volcano Observatory.

Geo Button

Next, you can configure CHORDS services, such as CUAHSI Data Services for hydrology data which will connect your CHORDS data stream to an official archive.

Note: If the map says “Opps!…”, you need to enter a google Maps API key in CHORDS configuration. Google allows up to 25,000 free map accesses per day. You can request a google maps API key if you have a Google account. After you have the key, go to the Configure page and enter it into the “google Maps JavaScript API Key” box.