Tutorial 06 - PHP Reference Gateway for Airavata - End-User Guide

 Introduction to PHP Reference Gateway

PHP Reference gateway is the UI developed by the Airavata team for demonstration purposes and also for interested science communities to work with. This user manual provides step-by-step information on obtaining a complete science gateway experience for science and scholarly communities using Airavata as a middleware platform. In the user manual we would also discuss main features and services provided for gateway communities via Airavata.

User manual will facilitate;

• How to create and modify projects

• How to register users in PHP reference gateway.

• How to create, execute and monitor, etc... experiments.

• How to submit issues, user feedback and user request for new applications.

For more details on Airavata please visit Airavata site

Test/Demo Environment Details

1. PHP Reference Gateway link;
   http://test-drive.airavata.org/pga/public/
2. Download application input files from;
   https://cwiki.apache.org/confluence/display/AIRAVATA/XSEDE14+Gateway+Tutorial+Application+Input+Files+and+Parameters 

Tutorial I - Gateway Login

Create Account

1. A new user has to create an account using ‘Create account’ link on top right hand corner of the gateway top banner.
2. To create an account;
   1. Please enter User information and submit. A confirmation message will confirm the creation.
   2. Important;
      1. Username cannot have spaces.
      2. Username & password must be longer than 5 characters.
      3. Password is case sensitive.
      4. Enter all the mandatory fields indicated by a star; *.
   3. Account creation page
      1. Link:http://test-drive.airavata.org/pga/public/create
      2. Create User Account Page

Image I - Create Account

Login to Account

1. Once the account is created successfully; login to the gateway using the created account.
2. Gateway login screen link
   1. http://test-drive.airavata.org/pga/public/login
3. OR
   1. use the 'Log In' link given on the 'Create New Account' page after account retain is successful.
   2. Login Page;

Image II - Login

Tutorial II - Create & Search Projects

Create Project

1. To create Projects navigate to ‘Project --> Create Project’ from the main menu. Enter Project Name (Mandatory) & Project Description (Optional) and Save.
2. Project creation Screen
   
   
   Image II - Create Project
   
   
3. Prior to submission, fields can be cleared using Clear button.
4. Successful creation of projects will be confirmed by message;
   1. Project <Project Name> created!

Search Projects

1. Screen navigation 'Project --> Search Projects' from the main menu.
2. Search keys are;
   1. Project Name
   2. Project Description
3. Search Project Page;
   
   Image III - Search Project
   
   
4. After selecting the search by key, user has to give  a value to search using the selected key. Click on Search.
5. All the Projects as per entered key value pair will be listed.
6. User can search for all projects by using (*) as a wild character. The * can be used when searching either options; Project name or description.
7. When projects are listed by clicking ‘View’ at the end of the row user can navigate to ‘Project Summary’ page; all experiments created under the project will be listed. User can click on the experiment ‘Status’ and navigate to ‘Experiment Summary’ page.

Image IV - Project Summary

Image V - Experiment Summary

Tutorial III - Create & Launch Experiment

Create Experiment

1. To create an experiment click on ‘Create Experiment’ from the main menu. Navigation Experiment --> Create Experiment
2. Create Experiment Page - Experiment Information
   
   Image VI - Create Experiment
   
   
3. Initially user need to enter/select given fields in order to continue.
   1. Experiment Name (Mandatory)
   2. Experiment Description (Optional)
   3. Project (Select from the available LOV)
   4. Application (Select from the available LOV)
   and click on ‘Continue’ button. If user requires to clear any entered fields can click ‘Reset Values’ before continuing.
4. Then continue entering Application configuration information.
   1. Experiment application input (Mandatory) - Application input can be in the form of entering data manually or uploading a single or multiple files.
      NOTE: Uploading file validity is not checked by the gateway. User has the responsibility of uploading correct files.
   2. Compute Resource (select from the available LOV)
   3. Node Count (If not entered default value will be taken as the input)
   4. Total Core Count (If not entered default value will be taken as the input)
   5. Wall Time Limit (If not entered default value will be taken as the input)
5. NOTE:
   1. For values c, d and e if user does not enter,  default value will be taken as the input.
   2. For c and d user has to enter a value greater than or equivalent to 1.
   3. For e user has to enter a value greater than or equivalent to 0.
6. Create Experiment - Application Configuration Part
   
   Image VII - Create Experiment Contd..
   
   
7. Save the Experiment. Upon successful creation of an experiment, confirmation message will be displayed;
   Experiment <Experiment Name> created!
8. While entering application configurations user can reset just the application configurations using ‘Reset Application Configuration’ button or can start over from the beginning using ‘Start Over’ button.
9. Once saved or Saved and launched user will be directed to ‘Experiment Summary’ page; can refresh the page and monitor experiment status changes.
10. Experiment Summary Page
    
    Image VIII - Experiment Summary

Launch Experiment

1. To launch an experiment can use the same 'Create Experiment' screen. Apart from saving the experiment user can Save & Launch at the same time using button ‘Save and Launch’.

2. When an experiment is saved and launched at the same time, two messages will be displayed; Experiment <Experiment Name> created! & Experiment launched!  

3. User can also create and save the experiment to launch later. To launch later user has to navigate to 'Experiment Summary' Page.

4. If the experiment is not suppose to be launched e.g.: a COMPLETED, LAUNCHED experiment, then the launch button will be disabled.

Tutorial IV - Search Experiments

1. User can search for experiment created by him/her through

1. Experiments → Search Experiments

2. Search Projects → View Project → View Experiment (by clicking on the status of the experiment) - Please refer Search Projects in Tutorial II above.

2. In Search Experiments search keys are;

1. Experiment Name

2. Experiment Description

3. Application

4. …

3. Search Experiments Page

Image IX - Search Experiments

1. After selecting the search by key, user has to give  a value to search for using the key. Partial values, complete values, (*) wild card can be used to search.

2. Click on Search once the search key is selected and value is entered.

3. All the experiments as per entered Key value pair will be listed.

4. By clicking on the 'Status' user will be navigated to ‘Experiment Summary’ screen of each experiment.

5. In experiment summary users can;

1. Launch experiment - Explained in above Tutorial III

2. Cancel experiment

3. Clone experiment

4. Edit experiment

6. User can edit an experiment by navigating to 'Edit Experiment' page. Edit button next to each experiment name will navigate user to 'Edit Experiment' page of each experiment.

Tutorial V - Modify, Cancel & Clone Experiments

Modify Experiment

1. Modify experiment by clicking on the edit icon (pencil) next to experiment name OR by clicking on ‘Edit’ button in Experiment Summary Page.

2. User can modify all available fields except experiment status, application & experiment ID.  

3. User can update experiments with statuses;

1. CREATED

2. CANCELED  

3. FAILED

4. UNKNOWN  

5. VALIDATED

4. Edit Experiment Page

Image X - Edit Experiment

Cancel Experiment 

1. Experiments can be canceled by navigating to experiment’s 'Experiment Summary’ screen.
2. Experiment statuses which allows cancellations;
   1. LAUNCHED
   2. EXECUTING
   3. SCHEDULED
3. Click on ‘Cancel’ button and immediately the Experiment status will change to CANCELING.
4. If the job is not already processing in the remote resource the job will proceed to COMPLETE and upon completing the experiment status will change to CANCELLED. Since the user requested a cancellation generated output will not be provided back to the gateway.
5. If the job was successfully CANCELLED upon changing the job state to CANCELLED experiment status will also change to CANCELED.
6. CANCELED experiments are only available for cloning in the PGA.

Clone Experiment

1. Experiments can be cloned irrespective of the experiment status by clicking ‘Clone’ in ‘Experiment Summary’ page.

2. When clicks ‘Clone’ from experiment summary user will be navigated to ‘Edit Experiment’ page of the new experiment. The new experiment will have exact same information as the earlier existing experiment.   

3. The new experiment will have a new experiment ID and the status will always be CREATED.

New experiment name = Clone of + Old experiment name

1. User can change existing information in ‘Edit Experiment’ page and save or save & launch.

Tutorial VI - User Assistance

Report Issue

1. Gateway user can report issues faced within the gateway through this page.

2. Page navigation: Help → Report Issue

3. Raise a Bug Page

Image XI - Raise a Bug

Request Feature

1. Gateway allows users to provide feedback as well as request for new applications via Request Feature Page.

2. Page Navigation; Help → Request Feature

3. Got Feedback? Page

Image XII - Got Feedback?