Skip to content
Snippets Groups Projects
Commit fb57dd8b authored by Steve Crouch's avatar Steve Crouch
Browse files

Add PEDASI account details and process, and viewing/accessing data sources

parent 0a736578
Branches
No related tags found
No related merge requests found
...@@ -11,13 +11,13 @@ PEDASI User Guide ...@@ -11,13 +11,13 @@ PEDASI User Guide
User Model User Model
---------- ----------
There are three classes of users within PEDASI: There are four classes of users within PEDASI:
- *Basic User*: these are anonymous users, able to browse and search the catalogue's public data sources and associated metadata, and retrieve public datasets from those data sources. They can also request a *PEDASI User* account. The data access activities of Basic Users are not tracked by PEDASI. - *Basic User*: these are anonymous users, able to browse and search the catalogue's public data sources and associated metadata, and retrieve public datasets from those data sources. They can also request a *PEDASI User* account. The data access activities of Basic Users are not tracked by PEDASI.
- *PEDASI User*: in addition to what a Basic User can do, these users can also request access to specific data sources, which may be approved by *Data Providers*. These users are also *observed* within PEDASI, with data access activities tracked by the system (for those data sources that opt to track user activities). - *PEDASI User*: in addition to what a Basic User can do, these users can also request access to specific data sources, which may be approved by *Data Providers*. These users are also *observed* within PEDASI, with data access activities tracked by the system (for those data sources that opt to track user activities).
Two other types of user types exist for administering PEDASI data sources and applications, that build on what PEDASI Users can do: Another class of user is the *Provider*, used for administering PEDASI data sources and applications. These build on what PEDASI Users can do:
- *Data Provider*: these users may register new data sources within PEDASI, update data sources and their metadata, remove data sources, and approve data source access requests. - *Data Provider*: these users may register new data sources within PEDASI, update data sources and their metadata, remove data sources, and approve data source access requests.
...@@ -25,15 +25,37 @@ Two other types of user types exist for administering PEDASI data sources and ap ...@@ -25,15 +25,37 @@ Two other types of user types exist for administering PEDASI data sources and ap
Applications developed for PEDASI also function as PEDASI Users, having their data access activities optionally tracked within the system, depending on the configuration of data sources. Applications developed for PEDASI also function as PEDASI Users, having their data access activities optionally tracked within the system, depending on the configuration of data sources.
There is also a PEDASI *Central Administrator* user, able to approve PEDASI User account requests, and assign/remove Data and Application Provider roles to users. There is also a PEDASI *Central Administrator* role, able to approve PEDASI User account requests, and assign/remove Data and Application Provider roles to users.
Registering for a PEDASI Account Obtaining a PEDASI Account
-------------------------------- --------------------------
Why Register for an Account?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Registering for an account enables you to be authenticated within the system as a PEDASI User and request access to private data sources and use them if approved.
Data Source Activity Tracking
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
One of the research aims of PEDASI is to explore research challenges around linkages between data. As such, a PEDASI User's activities in relation to data sources is recorded within the system to assist this research, to determine usage and provenance relationships between datasets across the PEDASI user/application ecosystem, and help inform Data Providers how PEDASI uses their data sources.
As an authenticated PEDASI User, the following data is recorded for each data access for those data sources that opt to record usage data:
- The date and time of access
- Your unique PEDASI account reference ID (not your personal Google account details)
- The type of activity (e.g. access, update, etc.)
These records are held internally within PEDASI and are available to Central Administrators and explicitly approved users (e.g. Data Providers and researchers).
Registering for an Account
^^^^^^^^^^^^^^^^^^^^^^^^^^
The preferred method to register an account with PEDASI is to register your Google account. If you don't have a Google account, you can `sign up for one`_. Once you have an account, you should contact the PEDASI Central Administrator via their contact details and request that your account be added to the system. The preferred method to register an account with PEDASI is to register your Google account. If you don't have a Google account, you can `sign up for one`_. Once you have an account, you should contact the PEDASI Central Administrator via their contact details and request that your account be added to the system.
Once approved, log in to the system using your Google account by selecting *Google Login* on the front page. Once approved, log in to the system as a PEDASI User using your Google account by selecting *Google Login* on the front page navigation bar.
.. _`sign up for one`: https://accounts.google.com/signup .. _`sign up for one`: https://accounts.google.com/signup
...@@ -41,19 +63,50 @@ Once approved, log in to the system using your Google account by selecting *Goog ...@@ -41,19 +63,50 @@ Once approved, log in to the system using your Google account by selecting *Goog
Browsing the Data Catalogue Browsing the Data Catalogue
--------------------------- ---------------------------
You can view the available data sources within PEDASI by selecting *Data Sources* from the front page navigation bar.
Viewing Data Sources Details
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Selecting *Details* for a data source from the Data Sources page shows the following information:
- *Owner*: the Data Provider who administers this data source
- *URL*: a URL to the Application Programming Interface (API) for this data source
- *Licence*: the licence under which the data is provided. You must ensure you comply with these licensing conditions when using data provided by this data source
- *Metadata*: additional fields, listed by metadata type, for this data (e.g. data query parameters, etc.)
Viewing data sources
^^^^^^^^^^^^^^^^^^^^
Requesting Access to a Datasource Requesting Access to a Datasource
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you're logged in as a PEDASI User (and not anonymously), you may request access to a data source by selecting *Manage Access* from a data source overview page. From here, you can supply the following details for an access request via a form:
- The level of access, where a given level also provides access to previous levels:
- *NONE*: to revoke access to a data source
- *VIEW*: to view a data source's high-level details
- *META*: to view a data source's metadata
- *PROV*: to view a data source's PROV records
- Push requested: to allow the data source to receive updates and/or new data from the user, where the data source supports it (currently only internal PEDASI data sources)
- Reason: the reason for the request
The data source's Data Provider will then consider and optionally approve the request. Subsequent requests can be made by the user to either escalate or de-escalate their access level, each requiring approval.
Using the Data Explorer Using the Data Explorer
^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^
The Data Explorer allows you to explore and obtain data from data sources by building and submitting queries based on that data source's API parameters.
Selecting *Data Explorer* from the data source overview page shows an interface to do this, using the following process:
1. *Select a specific data set, if supported*: firstly, if the data source supports multiple data sets, select one from the *Datasets* panel on the bottom right. Dataset-specific metadata will be displayed in the *Metadata* panel on the bottom left.
2. *Use the Query Builder to construct a query*: in the *Query Builder* panel on the top left, select a query parameter from the dropdown selector (or if they are not configured, you can add one manually in the *Parameter* field), assign a value to that parameter, and select *Add to Query*. Repeat this as required to build a complete query. You'll be able to see the query that will be sent to PEDASI in the *Query URL* text box as the query is constructed.
3. *Submit the query and see the results*: select *Submit Query* to submit the query, with the results displayed in the *Query Results* panel on the top right.
Results are presented in the Query Results panel precisely as returned by the data source.
References References
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment