Wikier

Archiving and Retrieving Laboratory Data with AURORA

AURORA is a system for retrieving, storing and managing data generated in laboratories at NTNU.

The system is available here:

https://www.aurora.it.ntnu.no

For user documentation of the system, please see https://www.aurora.it.ntnu.no/docs/user/.

For more information as well as how to register your laboratory, research group and/or instrument/PC for use in

AURORA, go to:

https://hjelp.ntnu.no

See under "Research" -> "AURORA".

For problems or issues with the system, please contact NTNU-IT orakel on phone number (735) 91500.

PREPARING A WINDOWS COMPUTER/INSTRUMENT

If you have gotten your computer/instrument registered, you need to install a small AURORA-client on the computer in question. This can be done in the following manner:

  1. Go to start-menu and select run (hotkey is windows key + R).
  2. In run write: fagit.it.ntnu.no\dyndns and hit OK (not smb-pub.nt as the image shows).{{https://app.nt.ntnu.no/ed/lib/exe/fetch.php?media=fil:dyndns1.jpg|dyndns1.jpg}
  3. Authenticate with your username@ntnu.no and password information when prompted.
  4. A share appears. Go first into folder called ActivePerl.
  5. Run script called install.cmd to install ActivePerl. If this is Windows 7 or higher, right-click the install-script and select “Run as Administrator”.
  6. Run script called install.cmd. . If this is Windows 7 or higher, right-click the install-script and select “Run as Administrator”. During install of CopSSH, you will be asked to:
    1. Go to the CopSSH Control Panel (which should appear automatically).
    2. Click Users-tab, select Administrator and select:
      1. Shell: Linux shell and Sftp.
      2. Public key authentication (deselect other).
      3. Click Apply and Exit the CopSSH Control Panel.

dyndns2.jpg

Your computer/instrument should now be ready to be used by the AURORA-system.

ADMINISTRATION OF ROLE-GROUPS IN GROUP-ADMIN

!NB! This guide is not valid until after the 04th of November 2021!!!

Research-groups in AURORA are being sync'ed from the central service called group-admin (part of BAS). This means that all users that have been designated an administrator of a research group are able to add/remove NTNU-users to role-groups belonging to such a research group. The only exception right now is external users that still have to be added through AURORA.

BASIC CONCEPTS

A research group in AURORA is synced in place based on role-groups in group-admin. If we look at the group "Center for Quantum Spintronics" at the department of physics we will see that one typically create these role-groups in group-admin:

  • fg_nv-ify-quspin
  • fg_nv-ify-quspin_admin
  • fg_nv-ify-quspin_gjest

The first role-group "fg_nv-ify-quspin" is the base role-group for this research group. It contains all the members of the research group itself, excluding any guests or other special categories such as admins. The base role-group is the source from which AURORA infers the name of the research group itself. It removes the "fg_"-prefix and in addition it will add the description field from the role-group to the name of the research group after a hyphen thus:

nv-ify-quspin - Quspin - Center for Quantum Spintronics

A typical research group in AURORA based on these 3 role-groups will look as follow:

  • nv-ify-quspin - Quspin - Center for Quantum Spintronics
    • roles
      • fg_nv-ify-quspin - Quspin - Center for Quantum Spintronics
      • fg_nv-ify-quspin_admin - Quspin - Center for Quantum Spintronics admin
      • fg_nv-ify-quspin_gjest - Quspin - Center for Quantum Spintronics gjest

Role-groups can only be created by certain superusers and must adher to a defined syntax and form in order to do as intended. For those of you who are not superusers that are able to create "fg_"-groups, and you will know if you can, can ignore the rest of this chapter on basic concepts.

This syntax and form of "fg_"-role groups in group-admin is as follows:

  1. All role-groups names must be in lower-case and only use a-z, 0-9 in addition to special separators "_" (underscore) and "-" (hyphen).
  2. The role-group name must be prefixed with "fg_".
  3. Everything after "fg_" must be separated by hyphens, except for an optional undescore at the end before a role-variant name.
  4. Each part after a hyphen describes the NTNU organizational structure down to where the research group belongs, except for the last name which is the group-name itself, such as "nortem".
  5. No part after a hyphen can be the word "roles". It is reserved.
  6. It must always be created a base role-group without the optional variant name at the end (after an underscore).
  7. The organizational structure must adhere to established short form acronyms already established at NTNU, such as "nv" for the Faculty for Natural Sciences or "mh" for Faculty of Medicine and Health Sciences, or "ify" for department of physics and so on. Groups that are administratively assigned to one faculty, but which are cross-discplinary should be put under the acronym "felles". Part of the structure can also be a projectname as part of a research group.
  8. The optional role variant name at the end after the last underscore should as much as possible adhere to established variant names, such as "admin" or "gjest".

Examples of valid role-groups are: "fg_nv-ibi-funplant" or "fg_nv-ibi-funplant_admin", "fg_mh-kin-witter", "fg_nv-felles-nanolab", "fg_nv-felles-nanolab_admin" and so on. An example of a project beloging to a group would eg. be: "fg_nv-ibi-funplant-usoc", where the existence of the base-groups "fg_nv-ibi-funplant" and "fg_nv-ibi-funplant-usoc" will result in two research groups being created thus (also assuming both of them have 3 role-groups as above):

  • nv-ibi-funplant - Functional Plant Biology
    • nv-ibi-funplant-usoc - Functional Plant Biology USOC project
      • roles
        • fg_nv-ibi-funplant-usoc - Functional Plant Biology USOC project
        • fg_nv-ibi-funplant-usoc_admin - Functional Plant Biology USOC project admin
        • fg_nv-ibi-funplant-usoc_gjest - Functional Plant Biology USOC gjest
    • roles
      • fg_nv-ibi-funplant - Functional Plant Biology
      • fg_nv-ibi-funplant_admin - Functional Plant Biology admin
      • fg_nv-ibi-funplant_gjest - Functional Plant Biology gjest

Please refrain from making unecessary deep structures or groups unless strictly necessary.In the case of AURORA it is also important that you create 2 roles groups besides the base role group with the variant name "_admin" and "_gjest".

HOW TO USE GROUP-ADMIN

To use group-admin open a browser of choice and point it to:

https://bas.ntnu.no/groupadmin/

Login with your NTNU username and password.

In group-admin there will be users that have super-privileges and being able to actually create certain "fg_"-groups and it will be others that simply just have admin-privileges for a given set of "fg_"-groups. This documentation will mainly be focusing on the vast majority of group-admin users that only have privileges to administrate already existing "fg_"-groups.

Please also note that when adding users to groups in group-admin you have to add them by referring to their username, not their email address or full name. It might therefore be a good idea to ask users that wish to be added for their username.

Adding user to a role-group

Please note that administrators of a role-group are only to be added as members of a "_admin" role-group in group-admin.

To add users to a "fg_" role-group in group-admin do the following:

  1. Locate the "fg_"-group after having logged into group-admin that you wish to add users to.
  2. Left-click on the name of the role-group to administrate it.
  3. To add users on the group go to the input field labeled "Add members" and write the username(s) of the user(s) to add separated with space.
  4. Left-click the button "Modify" to make the changes in the group.

One should then see the users added to the list on the bottom titled "Members and admins".Members and admins list

Also the tick for "member" is on all rows where a user is a member. Again, please do not add users to be admins by ticking the "Admin" column for that user here. Add all admin-users to the separate role-group that ends in "_admin".

Please note that it can take up to 10-30 minutes before the new member(s) is visible in AURORA on the role-group in question. It is also a requirement that the user has logged into AURORA once with FEIDE either before or after being added in group-admin. Without having done this, the user will not appear as a member in the role-group inside AURORA, but it is fine for you to add it in group-admin and it will be synced in place as soon as the user logs in with FEIDE into AURORA.

Change the description of a role-group

If the description of a role-group is not as desired and which are also displayed in AURORA after the group-name and a hyphen, change it by doing the following:

  1. Locate the "fg_"-group after having logged into group-admin that you wish to change the description of.
  2. Left-click on the name of the role-group to administrate it.
  3. In the input field labelled "Description" change and write whatever description that you wish.Role-group description field in group-admin
  4. Left-click the "Modify"-button on the page.

The changed description will be synced in AURORA just as the members are synced. It can take up to 10-30 minutes before it is in place. Please also note, again, that the description of the research group itself in AURORA comes from the base role-group in group-admin (eg. fg_nv-ibi-funplant).

Remove a user from a role-group

To remove a user from a role-group in group-admin do the following:

  1. Locate the "fg_"-group after having logged into group-admin that you wish to remove user(s) from.
  2. Left-click on the name of the role-group to administrate it.
  3. Go to the user list when the role-group view appears and deselect all ticks in the member-column after the users that you wish to remove.Remove user from role-group
  4. Left-click the button "Modify" to effectuate the change.

The user(s) that you deselected should then have been removed. Please note that the sync with AURORA can take up to 10-30 minutes before it is in place.