Research Platform Services Wiki

If you're a researcher, we'll help you do stuff.

User Tools

Site Tools


Sidebar

data_management:mediaflux:howto:login_with_aterm

ATERM

1 Introduction

ATERM is a command-line Java application. It can be run in GUI mode (the default) whereby it presents a GUI into which you type service commands. It can also be run in a no-GUI mode whereby you type commands into it from the shell which you launched it from.

2 Run ATERM as a GUI

ATERM can be downloaded from any Mediaflux server (see the downloads page).

Run the ATERM application by double clicking on it. You have to enter the appropriate Mediaflux server HTTPS details (which it will remember subsequently).

Also check the Proxy and Allow Untrusted check boxes.

2.1 Login

Mediaflux requires the triple of (domain, username and password) to log in. All the Mediaflux login screens show these fields.

2.1.1 Australian Access Federation (AAF) Account

It is possible to use your institutional credential to log in to Mediaflux if

  • your institutional identity provider (IdP) has installed the ECP plugin
  • the specific Mediaflux server you are working with has been configured to trust your IdP

Only the UniMelb Primary Mediaflux service is configured to offer AAF account logins (see table above)

To login with your AAF account

  • Enter “AAF” (or aaf) into the Domain entry field and press TAB to go to the next field.
  • A drop-down selection of known Institutions will then appear under the heading “AAF Virtual Home”.
  • Select your institution and then enter your usual institutional username (for the user field) and password (for the password field and click “Sign In ”.

The screen shot shows the selection of the University of Melbourne as the institution.

2.1.2 Local Account

If your account is a local account (i.e. not using your institutional account), you will have been provided with the details for domain, user and password. Just enter them and click “Sign In” or “Login”.

Here is an example for a local VicNode account.

3 Run ATERM without a GUI

3.1 Configure

In this mode, ATERM commands can be executed at the command-line without a GUI - it's headless mode. In this way it can be used for scripting.

  • Research Platform Services provides a script wrapper (called aterm) for ATERM to make this process a little easier.
  • This wrapper is provided as part of the unimelb-mf-clients GitLab repository. Download directly from GitLab.
  • Further details on ATERM are available here. This includes examples of executing the script.
  • The wrapper will fetch ATERM for you as well so no need to download it.

To work with the aterm script wrapper in this way you first need to setup a configuration file to tell ATERM which server and which Mediaflux account to use.

Here are the service details

ServiceTransportServerPortAAF AVailable
UniMelbhttpsmediaflux.researchsoftware.unimelb.edu.au443Yes
UniMelb-Internal httpsmediaflux.cloud.unimelb.edu.au443No

3.2 Login

Mediaflux requires the triple of (domain, username and password) to log in. All the Mediaflux login screens show these fields.

3.2.1 Australian Access Federation (AAF) Account

It is possible to use your institutional credential to log in to Mediaflux if

  • your institutional identity provider (IdP) has installed the ECP plugin
  • the specific Mediaflux server you are working with has been configured to trust your IdP

Only the UniMelb Primary Mediaflux service is configured to offer AAF account logins (see table above)

To login with your AAF account

  • Set domain=AAF
  • Set user=<short name>:<user name>
  • Set your standard institutional password.

The <short name> is a short name for your institution The current list of short names is here. Use your standard institutional user name for <user name>

3.2.2 Local Account

If your account is a local account (i.e. not using your institutional account), you will have been provided with the details for domain, user and password. Just use them as provided.

data_management/mediaflux/howto/login_with_aterm.txt · Last modified: 2018/10/24 13:03 by Neil Killeen