1. The first step is to navigate to https://my.osc.edu on your internet browser.

2. You will be greeted by the log in page for our client portal.

3. Click on "Sign Up - Academic".

4. The academic user registration page will be displayed. Please follow the instructions on the page and also fill it out as completely as possible.

 

5. If your PI has invited you to their project or has given you an access code to the project. Please enter that information in the correct box. If the project code is provided, you will be added to the project after the Project Admin accepts your request. If both the project code and corresponding access code (which is created by Project Admin as a time-limited code) are provided, you will be added to the project immediately once the signup is completed successfully. 

6. Once you have filled out all the information. You can hit the save button to submit the registration.

7. Once the submission is processed the web page will display that you will receive an email from OSC with further instructions.

8. Log into your email and find the email that was sent you from OSC. Click the link to verify your email.

9. A web page will be displayed with the OSC terms of use. Please read them and click that "I Agree" if you agree to the terms of use for our systems.

10. A webpage will be displayed to continue to the creation of your OSC Username and Password.

11.  The username and password creation will be displayed. Please create your username and password according to the constraints listed on the page.

12. Once you have successfully created your username and password you will be brought back to the login page. The login page will also have a pop up stating that your username and password have been successfully created. You will now be able to log in.

1. The first step is to navigate to https://my.osc.edu on your internet browser.

2. You will be greeted by the log in page for our client portal.

3. Click on "Sign Up - Commercial".

4. The commercial user registration page will be displayed. Please follow the instructions on the page and also fill it out as completely as possible.

5. If your PI has invited you to their project or has given you an access code to the project. Please enter that information in the correct box.  If the project code is provided, you will be added to the project after the Project Admin accepts your request. If both the project code and corresponding access code (which is created by Project Admin as a time-limited code) are provided, you will be added to the project immediately once the signup is completed successfully. 

6. Once you have filled out all the information. You can hit the save button to submit the registration.

7. Once the the submission is processed the web page will display that you will receive an email from OSC with further instructions.

8. Log into your email and find the email that was sent you from OSC. Click the link to verify your email.

9. A web page will be displayed with the OSC terms of use. Please read them and click that "I Agree" if you agree to the terms of use for our systems.

10. A webpage will be displayed to continue to the creation of your OSC Username and Password.

11.  The username and password creation will be displayed. Please create your username and password according to the constraints listed on the page.

12. Once you have successfully created your username and password you will be brought back to the login page. The login page will also have a pop up stating that your username and password have been successfully created. You will now be able to log in.

 

1. Click ‘New Academic Project’ within the ‘Projects' dropdown menu to get the application page as shown below:

2. Provide ‘Project Title’ and ‘Abstract’. Choose the ‘Project type’, ‘Allocation type’, and ‘Field of Science’ from the available options. The definitions are:
   1. Project type:
      1. Academic Project: to be used for academic purposes. See this link for more information: https://www.osc.edu/supercomputing/support/account
      2. Campus Champion Project: a project that will be headed by the OSC Champion of the given university
      3. Classroom Project: to be used for the purposes of education. See this link for more information: https://www.osc.edu/resources/getting_started/classroom_project_resource_guide
   2. Allocation type: see this link for more information: https://www.osc.edu/supercomputing/support/application_help
      1. Startup: for Ohio academics to begin work with OSC.
      2. Standard: for researchers with moderate high-performance computing use.
      3. Major: for researchers with significant high-performance computing use.
      4. Discovery: for researchers with intensive high-performance computing use.

Click ‘Save and Continue’ button on the upper-right corner of this page to continue.

 

3. The following discussions are based on the application of an academic startup project. The required information will be slightly different if you apply for other types.

 

Provide ‘Requested RU’ by either using the sliding bar or providing the absolute value in the box. The definition of RU is here:

Provide funding and publications by clicking ‘View Project Funding’ and ‘View Project Publications’. See ‘Manage your profile’ section on how to manage your funding and publications.

Click ‘Save and Continue’ button on the upper-right-corner of this page to continue.

 

4. Upload supporting files to provide the ‘RU Justification Document’ and ‘Additional Information’. You will see the name of files besides ‘Choose File’ button after the files are updated successfully:

Click ‘Save and Continue’ button on the upper-right-corner of this page.

5. You will arrive at the page to review the summary of your application ‘New Project - Review Project’. If all the information is correct, click ‘Submit for Approval’ button on the upper-right-corner of this page to submit the application.

6. After your application is submitted successfully, you will be re-directed to the page to manage users under this project. See ‘Manage users under a project’ section for how to proceed with it. Click ‘close’ to close this page.

7. You will be re-directed to the page to view all of your projects, where your new application should be listed in the page with status of ‘Requested’. You can also apply for a new academic project by clicking ‘Create New Academic Project’ button on the upper-right-corner of this page following the steps discussed in step 1-6.

8. You are also able to view all of your projects including the new applications by clicking ‘View Projects’ within the ‘Projects’ dropdown menu.

1. Click ‘New Commercial Project’ within the ‘Projects' dropdown menu to get the application page. You get the application page as shown below:

Provide ‘Project Title’ and ‘Description’. Also, you could provide ‘Estimated Core Hours (Millions)’, ‘Storage Space Quota (TB)’, and ‘File Count Quota (Thousands)’ by either using the sliding bar or providing the absolute value in the box:

1. Default Estimated Core Hours: 1 million 
2. Storage Space Quota (TB): project space allocated to this project. Default value: 0 TB
3. File Count Quota (Thousands): file count quota associated with the storage space listed in #b). Default value: 0

 

Click ‘Save and Continue’ button on the upper-right-corner of this page to continue.

 

2. You will arrive at the page to review the summary of your application ‘New Project - Review Project’. If all the information is correct, click ‘Submit’ button on the upper-right corner of this page to submit the application. Click ‘Back’ button if any information needs to be corrected.

3. After your application is submitted successfully, you will be re-directed to the page to manage users under this project. See ‘Manage users under a project’ section for how to proceed with it. Click ‘close’ to close this page.

4. You will be re-directed to the page to view all of your projects, where your new application should be listed in the page with status of ‘Requested’. You can also apply for a new commercial project by clicking ‘Create New Commercial Project’ button on the upper-right-corner of this page following the steps discussed in step 1-3.

Click ‘View Projects’ within the ‘Projects' dropdown menu to check the information of your projects. By default, this page lists all your projects with 15 rows per page. Click ‘>’ on the lower-right-corner of this page to go to the next page; click ‘<’ on the lower-right-corner of this page to go to the previous page. To modify the number of rows listed per page, adjust the value beside ‘Rows’ above the table.

 

To adjust which information to be displayed in this page, click ‘Columns’ within the ‘Actions' dropdown menu to get the ‘Select Columns’ pop-up window.

In the pop-up window, select the information (which will be highlighted after being selected) to be displayed using ‘>’; select the information to be NOT displayed using ‘<’. You can also adjust the order of columns using ‘↑’ and ‘↓’. Click ‘Apply’ button to apply the changes.

We will brief discuss how to use ‘search’ tool and view/edit a project here. For more interactive reporting functionalities, see ‘Interactive Reporting’ section.

 

The ‘Search’ tool enables you to narrow down the displayed projects that contains specific text only.

To search all columns, simply type the text in the search box and click on ‘Go’ or press ‘Enter’:

To search one specific column, select the column from the dropdown to the left of the search box before providing the text in the box:

To apply multiple search criteria, add another search criterion after one search criterion is applied. Always remember to click ‘Go’ or press ‘Enter’ to apply the search criterion. Once search criterion/criteria are applied, the table of your projects following the search criterion/criteria will be displayed, and the search criterion/criteria will be listed above the table:

• Check the box on the left to display/not display the results following this search criterion. The displayed results will be refreshed automatically
• Click the ‘x’ on the right to remove this search criterion. The displayed results will be refreshed automatically

You are able to view and edit your project, depending on the user roles of your account. To check your user role, please refer to ‘‘Manage your profile’ section.

 

To view/edit a project, click the ‘pencil icon’ to the left of the project:

You will arrive at the page to review the details of this project ‘Project Details’:

Different blue buttons, depending on your user roles, will be listed under ‘Project Details’. Click a blue button, and you will see either a pop-up window or a new page, which allows you to view or edit the information.

 

If you hold role as project PI, your will see the following available options:

• Project Users: manage users under this project. See ‘Manage users under a project’ section for more details.
• Project Allocations: information on your project allocations.
• Project Resource Usage: information on your RU usages.
• Project User Usage: you will be redirected to ‘HPC Job Activity’ page to search the information of users’ jobs. See ‘‘HPC Job Activity’ tool’ section for more details.
• Renew Project: you can renew this project by clicking ‘Renew Project’ button. See ‘How to renew a project’ for more details.

 

If you hold role as project user, your will see the following available options:

• Project Allocations: information on your project allocations
• Project Resource Usage: information on your RU usages.

1. You can renew a project by clicking on ‘View Projects’ within the ‘Project’ dropdown menu:

2. Select the project you would like to renew by clicking on the ‘pencil icon’ on the left hand side to open that project’s details page:

3. Click the button that is labeled ‘Renew Project’.

4. Select the allocation type you would like. (Ex: Standard, Major, or Discovery) and then click ‘Continue’.

5. Attach a proposal document to the application by clicking ‘Choose File’.

6. Add your abstract to the abstract section of the application.

7. Select the values you would like to request in the application for the renewal. (Ex: Estimated RU usage, Storage Space Quota, File Count Quota). Once you are ready to proceed to the next page, click ‘Save and Continue’.

8. Please add any additional documents. By clicking ‘Choose File’ in the RU justification document section and the addition information section. Once completed click ‘Save and Continue’.

9. You will see the new application by clicking on ‘Project’ -> ‘Project Allocations’ with the status of ‘REQUESTED’. See ‘View your allocations’ for more information on how to view your allocations.

As a project PI, you are able to do self-service project administration, such as adding or removing user accounts from a project, or changing user roles on the project.

1. Click ‘View Projects’ within the ‘Projects' dropdown menu to get the information of your projects:

2. Click the ‘pencil icon’ to the left of the project under which you would like to manage user accounts:

3. You will arrive at the page to review the details of this project ‘Project Details’. Click the blue button ‘Project Users’ to get a pop-up window named ‘Manage Project Users’ to manage users under this project.

The size of this pop-up window is fixed. There are three expandable lists in this window. Click ‘>’ on the left of each list to expand the list, and click ‘↓’ to collapse the list:

• Project Users: it allows you to manage current users under this project (remove the user or change the user’s PI approval status), and add other existing OSC users to this project.
• Invited Users: it allows you to add a user who does not own OSC account
• User Roles on Project: it allows you to manage the user roles on this project.

1. Click ‘>’ on the left of ‘Project Users’ to expand this list.

2. You will get a table listing the current users under this project, as shown below. By default, this page lists all users with 10 rows per page. Click ‘>’ on the upper-right-corner of this page to go to the next page; click ‘<’ on the upper-right-corner of this page to go to the previous page. To modify the number of rows listed per page, adjust the value beside ‘Rows’. The page will be refreshed automatically:

3. To remove a user from this project, click the ‘pencil icon’ beside the user who needs to be removed to get a pop-up window:

You will see the following information in the window:

• User: in the format of ‘username – First Last at Institution’
• OSC Approved
• PI Approved

 

4. To remove this user, click ‘Remove’ button at the bottom of this window:

5. A pop-up appears asking for confirmation:

Click ‘Cancel’ to cancel the removing action, or click ‘OK’ to confirm the removing action. Once you click ‘OK’, you will be re-directed to the table in which the removed user won’t be listed, with ‘Action Processed’ to confirm that this action has been processed:

Click the ‘x’ to close the message ‘Action Processed’:

1. Click ‘>’ on the left of ‘Project Users’ to expand this list.

2. You will get a table listing the current users under this project, as shown below. By default, this page lists all users with 10 rows per page. Click ‘>’ on the upper-right-corner of this page to go to the next page; click ‘<’ on the upper-right-corner of this page to go to the previous page. To modify the number of rows listed per page, adjust the value besides ‘Rows’. The page will be refreshed automatically:

3. To change the PI approval status of this user, click the ‘pencil icon’ beside the user to get a pop-up window:

You will see the following information in the window:

• User: in the format of ‘username – First Last at Institution’
• OSC Approved
• PI Approved

4. Check or uncheck the box beside ‘PI Approved’ to change the PI approval status. Click ‘save’ button, you will be re-directed to the table in which the user is listed with the changed status, with ‘Action Processed’ to confirm that this action has been processed.

 

5. In addition, click ‘>’ beside ‘Audit’ to check the log of this account:

6. To close this pop-up window, click ‘Cancel’ at the bottom of this window or the ‘x’ on the upper-right-corner of this window

1. Click ‘>’ on the left of ‘Project Users’ to get a table listing the current users under this project:

2. To add an existing OSC user to this project, click ‘Add User’ button on the upper-right-corner of this window:

3. A pop-up window will appear, as below:

To search the user, click ‘blank box’ beside ‘User’. You can search the user by OSC username, or the person's first and last name (make sure to have a space between first and last name). The wildcard "%" is also supported. The returned result will be in the format of ‘username – First Last at Institution’. Select the user who you would like to add to this project. You can also provide approval status by checking the box beside ‘PI Approved’

4. Once all is correct, click ‘Save’ button at the bottom of this window to add this user. You will be re-directed to the table in which the newly added user will be listed, with ‘Action Processed’ to confirm that this action has been processed:

The status of ‘OSC Approved’ for this newly added user will be ‘No’, which will be updated after OSC admin approves it.

 

5. Click the ‘x’ to close the message ‘Action Processed’

1. You are also able to add a user who does not have OSC account to the project by inviting new users. Click ‘>’ on the left of ‘Invited Users’ to expand this list:

2. You will get a table listing the users who has been invited to this project. By default, this page lists all users with 10 rows per page. Click ‘>’ on the lower-right-corner of this page to go to the next page; click ‘<’ on the lower-right-corner of this page to go to the previous page. To modify the number of rows listed per page, adjust the value beside ‘Rows’. The page will be refreshed automatically:

3. To invite a new user, click ‘Invite New User’ button on the right above this table:

4. A pop-up window will appear, as below:

All fields are required. We will check the information based on email address in our database to see whether the user is an existing OSC client or not. If this user is an existing OSC client, the message ‘This email already exists’ appears, as shown below:

 

In that case, you can close this window and follow the procedure ‘How to add an existing OSC user to this project’ to add this user.

 

Please select one of the user roles:

• Project, Regular User:
• Project, Limited Access: has limited access to the project information
• Project, Admin Access: access to project management, usage reports, bills, receives emails, takes project actions
• Project, No Admin Notifications: has no email notifications

 

5. Click ‘Invite New User’ to send the invitation if all information is correct, or click ‘Cancel’ to cancel the invitation:

6. Once you click ‘‘Invite New User’, you will be re-directed to the table listing all users who has been invited by you, with ‘Action Processed’ to confirm that this action has been processed:

Click the ‘x’ to close the message ‘Action Processed’:

1. By default, all users expect PI under this project hold the role of ‘Project, Regular User’. You can manage role of users under this project by clicking ‘>’ on the left of ‘User Roles on Project’ to expand this list:

You will get a table listing the users who has special roles

• Project, Limited Access: has limited access to the project information
• Project, Admin Access: access to project management, usage reports, bills, receives emails, takes project actions
• Project, No Admin Notifications: has no email notifications

 

By default, this page lists all users with 10 rows per page. Click ‘>’ on the lower-right-corner of this page to go to the next page; click ‘<’ on the lower-right-corner of this page to go to the previous page. To modify the number of rows listed per page, adjust the value beside ‘Rows’. The page will be refreshed automatically.

 

2. To add a special user role, click ‘Add User’ button on the right above this table

3. A pop-up window will appear, as below:

4. All fields are required. To search the user, click ‘blank box’ beside ‘User’

You can search the user by OSC username, or the person's first and last name (make sure to have a space between first and last name). The wildcard "%" is also supported. The returned result will be in the format of ‘username – First Last at Institution’. Select the user who you would like to add special user role to this project and specify the role:

• Project, Limited Access
• Project, Admin Access
• Project, No Admin Notifications

 

5. Click ‘Add User’ to add the new user role, or click ‘Cancel’ to cancel the invitation.

6. Once you click ‘‘Add User’, you will be re-directed to the table listing all users who has been added to special user role, with ‘Action Processed’ to confirm that this action has been processed:

1. Click ‘Project Allocations’ within the ‘Projects' dropdown menu to list all the allocations:

By default, this page lists all your allocations with 10 rows per page. Click ‘>’ on the lower-right-corner of this page to go to the next page; click ‘<’ on the lower-right-corner of this page to go to the previous page. To modify the number of rows listed per page, adjust the value beside ‘Rows’.

 

2. To adjust which information to be displayed in this page, click ‘Columns’ within the ‘Actions' dropdown menu to get the pop-up window as below:

Select the information to be displayed using ‘>’; select the information to be NOT displayed using ‘<’. You can also adjust the order of columns using ‘↑’ and ‘↓’. Click ‘Apply’ button to apply the changes.

How to use 'Search' tool

The ‘Search’ tool enables you to narrow down the displayed projects that contains specific text only.

 

1. To search all columns, simply type the text in the search box and click on ‘Go’ or press ‘Enter’:

2. To search one specific column, select the column from the dropdown to the left of the search box before providing the text in the box:

 

3. To apply multiple search criteria, add another search criterion after one search criterion is applied. Always remember to hit ‘Enter’ to apply the search criterion. Once search criterion/criteria are applied, the table of your projects following the search criterion/criteria will be displayed, and the search criterion/criteria will be listed above the table

• Check the box on the left to display/not display the results following this search criterion. The displayed results will be refreshed automatically
• Click the ‘x’ on the right to remove this search criterion. The displayed results will be refreshed automatically

 

4. There are more details on how to do advanced reports discussed in ‘Interactive Reporting’ section.

 

How to renew a project

You can renew a project by clicking ‘Renew Project’ button. See the ‘How to renew a project’ for more information.

 

1. Click ‘Current project’ within the Projects' dropdown menu to all of current active projects:

2. The ‘Current Active Projects’ page is shown below. By default, this page lists all of current OSC active allocations with 100 rows per page. Click ‘>’ on the upper-right-corner of this page to go to the next page; click ‘<’ on the upper-right-corner of this page to go to the previous page. To modify the number of rows listed per page, adjust the value beside ‘Rows’.

How to use 'Search' tool

The ‘Search’ tool enables you to narrow down the displayed projects that contains specific text only.

 

1. To search all columns, simply type the text in the search box and click on ‘Go’ or press ‘Enter’. To search one specific column, select the column from the dropdown to the left of the search box before providing the text in the box. To apply multiple search criteria, add another search criterion after one search criterion is applied. Always remember to hit ‘Enter’ to apply the search criterion.

 

2. Once search criterion/criteria are applied, the table of your projects following the search criterion/criteria will be displayed, and the search criterion/criteria will be listed above the table:

• Check the box on the left to display/not display the results following this search criterion. The displayed results will be refreshed automatically
• Click the ‘x’ on the right to remove this search criterion. The displayed results will be refreshed automatically

 

3. Click the PI name to redirect to PI’s web site (if available). Click the title to links to see more information of the project.

4. Click ‘Return to Portal’ to go back to your homepage:

5. There are more details on how to do advanced reports discussed in ‘Interactive Reporting’ section.

 

 

1. Click ‘Edit Profile’ from the dropdown menu of your name:

2. This brings up the ‘Contact Profile’ page:

3. It is very important that your email address is kept up-to-date. You can change the email address here in client portal. If changing email address, please note that the new email address won't be updated in the OSC system instantaneously. User will receive a verification email to their new email address. Only after verification process is complete, new email address will be updated in the OSC system.

 

4. If you need to change Institutions, please contact OSC Help so we can update that information.
   Email oschelp@osc.edu
   Phone 614-292-1800 or 800-686-6472
    
5. The ‘Web Page’ is optional and will be shown with the Principal Investigator of all active Projects.
    
6. The Projects button will bring up a page listing all the projects you are associated with.
    
7. The Publications button will bring up a page on which you can manage bibliographic information about publications you may wish to reference in account requests or renewals.

8. The Funding button will bring up a page on which you can record funding from other sources you may wish to reference in account requests or renewals. 

 

 

The HPC Job Activity menu item opens a powerful reporting tool. By default, the report shows all activity over the last 30 days for projects you are authorized to view usage of. There are simple filters available at the top to put in a specific job ID, narrow the report to a specific project, or select a specific date range.

Click ‘Refresh Report’ to get the job activity report as shown below:

There are more details on how to do advanced reports discussed in ‘Interactive Reporting’ section, but here are some basics about interacting with the report. Clicking on a column header will bring up a quick filter menu where you can filter the records, sort by that column, hide the column, or group by each unique entry.

 

In addition, you can do a quick text search, select which saved report you wish to view (if you have any saved reports), change the number of rows per page, and do advanced actions from changing the visible columns to aggregating data, creating charts, and saving your custom report formats.

 

To view the script associated with a job, you can click on the ‘Job ID’ for that job. This will open a pop-up dialog with the first 5kb of the job script, with a button to enable you to download the entire script.

Importantly, you will notice that the script is not identical to what you submitted on the command line; this is because our infrastructure scripts will add some additional information of value to the scheduler and record that information in the final job script.

 

If a job is interactive, the job script will not be recorded because there isn’t one! We do not have a mechanism to record what happens in an interactive batch job and store that in the accounting system. You may want to use descriptive job names in your batch submissions if you want to be able to review utilization and determine what a job was for when no script is recorded.

 

There is a column available in the report that provides a per-row button labeled “View/Add Note”. This button will open a dialog window that will allow you to view any notes that have been added to a job or create a note. At 200 characters, notes are fairly short, but they do allow you to add a little bit of metadata to a job once it is in the accounting system.

There are three “create” buttons available, which take slightly different actions. Clicking “Create” will just save the note in the job record. Clicking “Create & Notify OSC Admin” will allow you to save the note and notify OSC staff that there is a job note they should review. Please note, this is not the recommended or preferred method for reporting job problems. Please continue to email OSC Help. Finally, “Create & Send to project admin” will add the note to the job record and notify the PI and project admins that there is a job note that needs to be reviewed.

 

 

Click ‘HPC Job Activity’ within the ‘Individual' dropdown menu.

Click ‘Refresh Report’ to get the job activity report as shown below. By default, the report shows a table of all activity over the last 30 days for projects you are authorized to view usage of, with 10 rows per page. Click ‘>’ at the top right of the table to go to the next page; click ‘<’ at the top right of the table to go to the previous page. To modify the number of rows listed per page, adjust the value beside ‘Rows’:

There are simple filters available at the top to put in a specific job ID, narrow the report to a specific project, or select a specific date range. Click “Refresh Report” to update the table with new filters.

For more advanced functions of using filter, see the discussion of ‘Filter’.

Many actions can be performed by clicking on a column heading. These include:

• Sorting data (both ascending and descending)
• Hiding the column
• Creating a control break
• Viewing of the column text and the ability to select a value to create a quick filter

 

Let’s use the column ‘CPU Time Used’ as an example for detailed discussions. Click ‘CPU Time Used’:

• Click ‘’, and the jobs will be listed based on the value of CPU time in ascending order
• Click ‘’, and the jobs will be listed based on the value of CPU time in descending order
• Click ‘’, and the column ‘CPU Time Used’ will be removed from the table
• Click ‘’, and the table will be split into multiple groups, where each group shares the same value of CPU time

 

It also lists all the available values of CPU time. You can select a value to create a quick filter, and the table will be updated to list the jobs of which the CPU time is the specified value:

You can also use ‘search’ to narrow down the information to be viewed.

You can adjust the columns to be displayed in this table to see more/less information. Click ‘Columns’ within the ‘Actions' dropdown menu:

You will get the pop-up window shown below. The columns on the right are displayed. The columns on the left are hidden. Select the information to be displayed using ‘>’; select the information to be NOT displayed using ‘<’. You can also reorder the displayed columns using ‘↑’ and ‘↓’. Click ‘Apply’ button to apply the changes.

Most columns are self-explanatory. Computed columns are prefixed with **. Definitions of some columns are provided below:

• Project: which project this job is charged to
• Usage Date: the date when this job is charged
• Memory Used: in bytes
• CPU Time Used: in seconds
• Wall Time Used: in seconds

The ‘Search’ tool enables you to narrow down the displayed report that contains specific text only. To search all columns, simply type the text in the search box and click on ‘Go’ or press ‘Enter’.

The page will be refreshed automatically to display the results following the search criterion, with the search criterion being listed above the table:

To apply multiple search criteria, add another search criterion after one search criterion is applied. Always remember to hit ‘Enter’ to apply the search criterion:

Check the box on the left to display/not display the results following this search criterion. The displayed results will be refreshed automatically:

Click the ‘x’ on the right to remove this search criterion. The displayed results will be refreshed automatically:

To search one specific column, select the column from the dropdown ‘˅’ to the left of the search box before providing the text in the box:

For instance, if you would like to get a report of HPC jobs submitted by user ‘ucn1118’ only, select ‘Username’ from ‘˅’. ‘Search: Username’ will be displayed in the ‘search’ box:

Type ‘ucn1118’ and hit ‘Enter’ in the box, jobs submitted by ‘ucn1118’ only will be displayed in the table, as shown below:

The ‘Actions’ menu contains many tasks that are useful in querying data and customizing reports. Click ‘˅’ to get a list of available functions.

For more information, see: [1] and [2]

Adjust the displayed information in the table

Click ‘Columns’ within the ‘Actions' dropdown menu, you can adjust the columns to be displayed in this table to see more/less information.

See here for more info: ‘Adjust the displayed information in the table’.

Query data and format report

Within the ‘Actions' dropdown menu, it provides the following tools to query data and format report:

• Filter
• Data
• Format

Filter

Click ‘Filter’ within the ‘Actions' dropdown menu as below:

You can create the filter based on either ‘Column’ or ‘Row’.

If you filter by column, select a column using ‘▼’, a standard Oracle operator using ‘▼’, and enter an expression to compare against. Expressions are case sensitive. Use % as a wild card, if needed. You can also select the expression using ‘▼’.

If you filter by ‘Row’, you can create complex WHERE clauses using column aliases and any Oracle functions or operators. Click ‘Apply’ to apply the filter:

Data

Click ‘Data’ within the ‘Actions' dropdown menu. You can sort data, perform mathematical computation on column, add computed column to your report, and perform a flashback query within ‘Data’ menu. 

• Sort

It is used to change the columns to sort on and determines whether to sort in ascending or descending order. You can also specify how to handle NULLs. The resulting sorting displays to the right of column headings in the report.

• Aggregate

Aggregates are mathematical computations performed against one column. Click ‘Aggregate’ to get the pop-up window shown below:

Here, ‘Aggregation’ enables you to select a previously defined aggregation to edit; ‘Function’ is the function to be performed (for example, SUM, MIN); ‘Column’ is used to select the column to apply the mathematical function to. Only numeric columns display.

 

Click the ‘Apply’ button, the aggregates will be displayed at the end of the report within the column they are defined.

• Compute

It enables you to add computed columns to your report. These can be mathematical computations or standard Oracle functions applied to existing columns. Click ‘Compute’ to get the pop-up window shown below:

Here, ‘Computation’ enables you to select a previously defined computation to edit; ‘Column Heading’ is the name of this new column displayed in the table; ‘Format Mask’ is an Oracle format mask to be applied against the column; ‘Computation Expression’ is the computation to be performed where columns are referenced using their associated alias. Clicking on the column name or alias includes them in the Computation. Next to Columns is a keypad. This keypad functions as a shortcut to commonly used keys and inserts those keys in the Computation. On the far right are Functions.

 

Once the computation is defined, click ‘Apply’ button. The computed column will be displayed as the last column of the table.

• Flashback

A flashback query enables you to view the data as it existed at a previous point in time. The maximum amount of time that you can flashback is 7047 minutes.

Format

Click ‘Format’ within the ‘Actions' dropdown menu:

Using ‘Format’ menu, you can split the report into multiple groups, highlight the rows that meet the filter, and modify the number of rows listed per page.

• Control Break

It is used to create a break group on one or several columns. Click ‘Control Break’ to get the pop-up window shown below:

Enable or disable the column for control break. Click ‘Apply’ button. This pulls the columns out of the Interactive Report and displays them as a master record.

• Highlight

It allows you to define a filter. The rows that meet the filter are highlighted using the characteristics associated with the filter. You can highlight the entire row or just the affected cell and can select a new color both for the background and the text. Click ‘Highlight’ to get the pop-up window as below:

Here, the options include:

• Name: provide a name for this ‘highlight’. Once it is defined, it will be displayed on the top of the table with returned results
• Sequence: identifies the sequence in which the rules are evaluated.
• Enabled: identifies if a rule is enabled or disabled.
• Highlight Type: identifies whether the row or cell should be highlighted. If Cell is selected, the column referenced in the Highlight Condition is highlighted.
• Background Color: is the new color for the background of the highlighted area.
• Text Color: is the new color for the text in the highlighted area.
• Highlight Condition defines the filter condition.

 

Click the ‘Apply’ button. This pulls the columns out of the Interactive Report and displays the results with defined highlights.

 

• Rows Per Page

You can select the value to modify the number of rows listed per page.

Data visualization

Different tools are available in client portal for the data visualization, including:

• Chart
• Group By
• Pivot

Chart

Click ‘Chart’ to get the pop-up window as below:

Here, the options include:

• Chart Type: identifies the chart type to include. Select from horizontal bar, vertical bar, pie, or line.
• Label: enables you to select the column to be used as the label.
• Axis Title for Label: is the title that displays on the axis associated with the column selected for Label. This is not available for pie chart.
• Value: enables you to select the column to be used as the value. If your function is a COUNT, a Value does not need to be selected.
• Axis Title for Value: is the title that displays on the axis associated with the column selected for Value. This is not available for pie chart.
• Function: is an optional function to be performed on the column selected for Value.
• Sort: allows you to sort your result set.

 

Click the ‘Apply’ button. You will get the page in which the chart is generated. You can include one chart per Interactive Report. Once defined, you can switch between the chart and report views using the icons beside ‘Go’:

Group By

Click ‘Group By’ to get the pop-up window as below:

Here, the options include:

• Add Group By Column: the columns on which to group
• Add Function: the columns to aggregate along with the function to be performed

 

Click the ‘Apply’ button. You will get the page in which the Group By view is generated. You can include one Group By view per Interactive Report. Once defined, you can switch between the Group By and report views using the icons beside ‘Go’:

Pivot

Click ‘Pivot’ to get the pop-up window as below:

Here, the options include:

• Add Pivot Column: the columns on which to pivot
• Add Row Column: the columns to display as rows
• Add Function: the columns to aggregate along with the function to be performed

 

Click the ‘Apply’ button. You will get the page in which the Pivot view is generated. Please note that Pivot does not work for very large datasets e.g. ~5000 entries. You can include one Pivot view per Interactive Report. Once defined, you can switch between the Pivot and report views using the icons beside ‘Go’:

Save/Reset report

Within ‘Report’ menu, you can save the customized report for future use, or remove any customizations that you have made and reset the report to the default settings.

Save Report

‘Save Report’ saves the customized report for future use (it will be there after logging out and back in again). Click Save Report’ to get the pop-up window shown below:

You provide a name and an optional description. For now, all customized reports are private, which means only the end user that created the report can view, save, rename or delete the report. If you save customized reports, a Reports selector displays in the Search bar:

You will be able to choose the reports between ‘Default -> Primary Report’ (which is the report that initially displays) and ‘Private -> Your defined reports’

Reset

‘Reset’ brings the report back to the settings when logged in, removing any customizations that you have made. Click ‘Reset’ to get the pop-up window as below:

Click the ‘Apply’ to confirm. You can also uncheck the checkbox next to any customization to temporarily disable it or click the ‘x’ icon to remove the customization.

Download

‘Download’ enables the current result set to be downloaded. Click ‘Download’ to get the pop-up window:

The download formats differ depending upon your installation and report definition but may include CSV, HTML, PDF, or Email. Click the icon of the format you wish to download in.

Help

‘Help’ provides you more detailed user guide on ‘Action’ menu.

In this example, I’d like to provide step-by-step instructions for creating a chart report of HPC jobs, in which:

• All jobs submitted by user ‘xwang’
• The data range is from April 29, 2018 to May 7, 2018
• The report shows the total CPU time per day

 

The following functions will be demonstrated:

• Use simple filter on ‘HPC Job Activity’ page
• Use ‘search’ tool
• Adjust rows to be displayed per page
• Adjust columns to be displayed in the table
• Format the data using ‘Control Break’
• Generate a chart report
• Save report
• Download report

 

1. Click ‘Individual -> HPC Job Activity’

2. You will get the ‘HPC Job Activity’ page. Change ‘Minimum Date’ and ‘Maximum Date’ to ‘29-Apr-18’ and ’07-May-18’, respectively. Click “Refresh Report’ to updated the information displayed in the table

3. To listed the jobs submitted by user ‘xwang’ only, click ‘Search’ box and choose ‘Username’:

4. Type ‘xwang’ in the ‘search’ box and press ‘Enter’.

5. You will get the table that lists all jobs submitted by user ‘xwang’ between April 29, 2018 and May 7, 2018, with the filter listed above the table. Change the number of rows displayed per page to ‘All’ to list all jobs, as shown below:

6. Since we are interested in the daily CPU usage by ‘xwang’, we can remove some columns of the table by clicking the heading of some columns to hide the column. For instance, click ‘Hide Column’ icon in ‘Job ID’, the page will be refreshed automatically. The column ‘Job ID’ will NOT be displayed after refreshing:

7. Perform similar operations on other columns. You can also adjust the columns to be displayed by clicking ‘Columns’ within the ‘Actions' dropdown and make ‘Username’, ‘Usage Date’, and ‘CPU Time Used’ to be displayed in the report. The final table is as below:

8. To create a break group based on ‘Usage Date’, click ‘Actions -> Format -> Control Break’ as shown below:

9. You will get the ‘Control Break’ pop-up window. Choose ‘Usage Date’ under ‘Column’ with Status ‘Enabled’, as shown below:

10. Click ‘Apply’. This pulls the column ‘Usage Date’ out of the report and the jobs submitted by ‘xwang’ are grouped based on ‘Usage Date’, as shown below:

11. To generate a chart report that shows the total CPU time per day, click ‘Actions -> Chart’ as shown below:

12. You will get the ‘Chart’ pop-up window. Using the following information on the chart options, as shown in the image below:

• Chart Type: vertical bar
• Label: Usage Date
• Axis Title for Label: Date
• Value: CPU Time Used
• Axis Title for Value: Total CPU Time
• Function: Sum
• Sort: Default

13. Click the ‘Apply’ button. You will get the chart report showing the daily total CPU usage by ‘xwang’ between April 29, 2018 and May 7, 2018 (here, the CPU usage is zero if the date is missing in this chart):

14. From this chart, it is easy to see that ‘xwang’ used many CPU hours on May 4th, and very few CPU hours on other days. To switch back to report view, you can click the icon ‘View Report’ to the left of the row selection:

15. You can save this report for future use by clicking ‘Actions -> Report -> Save Report’ as shown below:

16. You will get the ‘Save Report’ pop-up window. Provide ‘xwang Daily Usage’ as the name and ‘Daily CPU Usage between April 29 and May 07’ as Description, as below:

17. Click ‘Apply’ button to save the report. Now, beside ‘Go’, you will be able to choose the reports between ‘Default -> Primary Report’ (which is the report that initially displays) and ‘Private -> xwang Daily Usage’, as shown below:

18. For now, all customized reports are private, which means only the end user that created the report can view, save, rename or delete the report.

 

19. You can download this report by clicking ‘Actions -> Download’ as shown below:

20. You will get the ‘Download’ pop-up window as below:

21. Click the icon of CSV, HTML, or PDF to download this report, or click the icon of Email to email this report to the desired recipient. Please note the downloaded report is in the format of table only, while other formats like ‘Chart’ won’t be available for downloading.