3. User Interface
3.11. RSM Notification Icon and Context Menu
3.1. Main Window
To launch the RSM application main window:
• If you are using a Windows system, select Start > All Programs > ANSYS 15.0 > Remote Solve Manager
> RSM 15.0.
• If you are using a Linux system, run the rsmadmin script.
The main window displays as shown below:
The RSM main window interface elements are described in the table that follows.
Description Interface
Element
Provides access to the following menus: File, View, Tools, and Help.
Menu Bar
Contains the following tools, from left to right: the Show drop-down and the Remove, All Owner Jobs, and Job Log icons.
Toolbar
Displays defined Solve Managers, along with the Queues and Compute Servers configured for each.
Tree View
Displays a listing of current jobs. You can delete jobs from this area by selecting one or more jobs from the list and selecting Remove from the context menu.
List View
Displays the progress and log messages for the job selected in the List view.
Job Log View
Displays an icon indicating the status of the active operation.
Status Bar
3.2. Menu Bar
The menu bar provides the following functions:
Function Selections
Menu
Hides the RSM main window. RSM continues to run in the system tray.
Alternatively, you can right-click the RSM icon in the notification area (or system tray) and select Exit from in the context menu.
Controls the display of jobs in the List view, allowing you to display or hide jobs according to ownership.
All Owner Jobs View
Deselect to display only your own jobs.
Select to display the jobs of all owners.
Displays or hides the Job Log view.
Job Log
Forces the List view to update immediately, regardless of the update speed setting.
Refresh Now
Provides the following submenu selections:
Update Speed
• High - updates the display automatically every 2 seconds.
• Normal - updates the display automatically every 4 seconds.
• Low - updates the display automatically every 8 seconds.
• Paused - the display does not automatically update.
When this option is selected , the main RSM window remains in front of all other windows unless minimized.
Always On Top
When this option is selected, RSM will not appear in the task bar when minimized. An RSM icon will display in the notification area (or system tray).
Hide When Minimized
Enables/disables the desktop alert window.
Desktop Alert Tools
Deletes the job or jobs selected in the List view.
Remove
Displays the Submit Job dialog, which allows you to submit jobs manually.
Submit a Job
Displays the Manager Options dialog, which allows you to define Managers and specify desktop alert set-tings.
Options
Displays the Help system in the ANSYS Help Viewer.
ANSYS Re-mote Solve Help
Manager Help
Provides information about the program.
About AN-SYS Re-mote Solve Manager
3.3. Toolbar
The toolbar provides the following functions:
Function Selections
Tool
When this menu item is selected from the drop-down, all jobs display in the List view.
All Jobs Show
When this menu item is selected from the drop-down, only completed jobs display in the List view.
Com-pleted
These jobs display with a Status of Finished.
When this menu item is selected from the drop-down, only running jobs display in the List view.
Run-ning
These jobs display with a Status of Running.
When this menu item is selected from the drop-down, only queued jobs display in the List view.
Queued
These jobs display with a Status of Queued.
When this menu item is selected from the drop-down, only failed jobs display in the List view.
Failed
These jobs display with a Status of Failed.
When this menu item is selected from the drop-down, only cancelled jobs display in the List view.
Can-celled
Toolbar
These jobs display with a Status of Cancelled.
This icon allows you to delete the currently selected job or jobs. It functions in the same way as the Remove option Not
applic-able.
Remove
of the right-click context menu, the Tools > Remove option in the menu bar, or the Delete key.
This icon allows you to display or hide jobs that belong to owners other than yourself. The function is the same as using the View > All Owner Jobs option in the menu bar.
Selected or deselected.
All Owner Jobs
This icon allows you to display or hide the Job Log view.
The function is the same as using the View > Job Log op-tion in the menu bar.
Selected or deselected.
Job Log
3.4. Tree View
The Tree view contains a list of Compute Servers, Queues, and Managers. Compute Servers and queues that appear may be set up on either your local machine (shown as My Computer) or remotely on a Manager.
The components in the list are summarized below:
• Each Manager node is a separate configuration, defined by the machine designated as the Manager. New Managers are added via the Options dialog, accessed by Tools > Options on the menu bar.
• The Queues node for a Manager contains all of the queues that have been defined for that Manager. You can expand a Queue to view the Queue Compute Servers associated with it; these are the Compute Servers that have been assigned to the Queue (i.e., the machines to which the Manager will send queued jobs for processing).
• The Compute Servers node contains all of the Compute Servers associated with the Manager; these are the machines that are available to be assigned to a Queue and to which jobs can be sent for processing.
Note
• If you disable a Manager, Queue, or Compute Server, it will be grayed out on the Tree view.
– For information on disabling Managers, see Options Dialog Box (p. 40).
– For information on disabling Queues, see Creating a Queue (p. 53).
– For information on disabling Compute Servers, see Adding a Compute Server (p. 55).
• If a connection cannot be made with a Manager, the Manager will be preceded by a red “X”
icon.
– For information on testing Managers, see Testing a Compute Server (p. 70).
Tree View Context Menus
When a Manager node is selected, Properties and Accounts options are available in the context menu.
If you haven’t yet cached your password with RSM, the Set Password option is also available.
When a Queues node is selected, only the Add option is available in the context menu.
When a queue is selected, the Properties and Delete options are available in the context menu.
Tree View
When a Compute Server is selected under a Queues node or under a Compute Servers node, the Properties and Test Server options are available. The Delete option becomes available if a Compute Server that is not assigned to any queue is selected under a Compute Servers node, as shown in the image on the right below.
When a Compute Servers node is selected, only the Add option is available.
For more information on using the Tree view context menu options, see RSM Administration (p. 51).
3.5. List View
You can sort the displayed fields by clicking on the column by which you want to sort. You can delete one or more jobs that belong to you by selecting the jobs and clicking the Remove button in the toolbar. Alternatively, you can also select Remove from the context menu, select Remove from the Tools menu, or press the Delete key. When you delete a job, the job may not be removed from the List view immediately; it will be removed the next time that the List view is refreshed.
Note
If a job is still running, you cannot remove it. Use either the Abort or the Interrupt option in the List view context menu. Once the job Status changes to either Finished or Canceled, you can click the Remove button to delete the job. The Interrupt command allows a job to clean up the processes it has spawned before termination; the Abort command terminates the job immediately. There may also be a job stopping option in the client application that submitted the job (for example, ANSYS Workbench Mechanical Stop Solution command).
There may also be a disconnect option in the client application that submitted the job (for example, the ANSYS Workbench Mechanical Disconnect Job from RSM command).
The List view context menu provides the following options:
Function Option
Inquire about a running job. This action depends on the type of job being run.
Inquire
Generally, the Inquire command will run some additional job script code to perform some action on a running job. It can also bring back intermediate output and progress files.
Immediately terminates a running job. Enabled only if a running job is selected.
Abort
Jobs terminated via this option will have a Status of Canceled in the List view.
Terminates a running job. Enabled only if a running job is selected.
Interrupt
Jobs terminated via this option will have a Status of Finished in the List view.
Deletes the selected job or jobs from the List view. Enabled only if a completed job is selected.
Remove
Cannot be used on a running job. It functions in the same way as the Tools > Remove option in the menu bar.
Allows you to set the submission priority for the selected job or jobs.
When jobs are submitted they have a default priority of Normal. En-abled only for jobs with a Status of Queued.
Set Priority
The higher priority jobs in a queue run first. To change the priority of a Queued job, right-click on the job name, select Set Priority and change the priority. Only RSM administrators can change a job priority to the highest level.
The status of each job displayed in the List view is indicated by the Status column and an icon. For jobs that have completed, the Status column and an icon indicate the final status of the job; the addition of an asterisk (*) to the final status icon indicates that the job has been released.
Released Icon Icon
Description Status
Job is being uploaded to RSM.
Input Pending
List View
Job has been placed in the Manager queue and is waiting to be run.
Queued
Job is running.
Running
Job has been terminated via the Abort option.
Also applies to jobs that have been aborted be-cause you exited a project without first perform-ing one of the followperform-ing actions:
Cancelled
• Saving the project since the update was initiated
• Saving results retrieved since your last save Job has completed successfully.
Also applies to jobs that have been terminated via the Interrupt option or for which you have saved results prior to exiting the project.
Finished
Job has failed.
Also may be applied to jobs that cannot be cancelled due to fatal errors.
Failed
3.6. Status Bar
The Status bar indicates the status of the currently running operation by displaying either a Busy icon or a Ready icon in its bottom left corner.
3.7. Job Log View
The Job Log view provides log messages about the job. The log automatically scrolls to the bottom to keep the most recent messages in view. To stop automatic scrolling, move the vertical slider from its default bottom position to any other location. To resume automatic scrolling, either move vertical slider back to the bottom or select End from the Job Log view context menu.
The right-click context menu provides the following options:
Description Status
Copy selected text in the Job Log view.
Copy
Alternatively, you can use the Ctrl+C key combination.
Select all of the text in the Job Log view.
Select All
Alternatively, you can use the Ctrl+A key combination.
Go to the top of the Job Log view.
Home
Go to the bottom of the Job Log view.
End
This option allows you to generate a Job Report for the job item selected from the RSM List view. Enabled when the job has completed (i.e., has a final Status of Finished, Failed, or Cancelled).
Save Job Report...
The Job Report will include job details and the contents of the job log shown in Job Log view. When generating the report, you can specify the following report preferences:
• Include Debug Messages: whether debugging messages are included in the Job Report
• Include Log Time Stamp: whether a log time stamp is included in the Job Report
• Include Line Numbering: whether line numbering will be displayed on the Job Report
Click the Browse button to select the directory to which the report will be saved, type in report filename (RSMJob.html by default), select the report format (HTML or text format), and click Save.
Enable or disable the display of line numbers in the Job Log view. Right-click inside the inside the Job Log view and select or deselect Line Numbering from the context menu.
Line Numbering
Enable or disable the display of the time stamp for each line in the Job Log view. Right-click inside the Job Log view and select or deselect Time Stamp from the context menu.
Time Stamp
Enable or disable the display of debugging information. Right-click inside the Job Log view and select or deselect Debug Messages from the context Debug Messages
menu to toggle between standard job log messages and debugging mes-sages.
Note
When making a support call concerning RSM functionality, send the RSM job report. Note the HTML-format job report uses color highlighting by row to distinguish the Job Log view contents from other information, which can be helpful for troubleshooting.
Job Log View
3.8. Options Dialog Box
From the menu bar, select Tools > Options to open Options dialog. Use the Options dialog to configure Managers or set up desktop alert settings.
The Options dialog contains the following functions:
• The Managers pane lists available RSM Manager machines.
– To enable or disable a Manager, select or deselect the preceding check box. Disabled Managers will display as grayed out in the Tree view.
– To add a new Manager, type its name into the Name field and click the Add button.
– To remove a Manager, highlight it in the list and click the Delete button.
– To change the name of a Manager, highlight it in the list, edit the name in the Name field, and click the Change button.
• The Desktop Alert Settings pane contains check boxes to configure the following desktop alerts:
– Show Running Jobs – Show Pending Jobs – Show Completed Jobs
3.9. Desktop Alert
The desktop alert automatically appears when jobs are active. It displays the running, queued, and completed jobs. The number of queued, running and completed jobs is also displayed in the window title. If all jobs are finished, the desktop alert disappears automatically.
If you wish to hide the desktop alert window, use the menu options or tray context (right-click on the RSM icon in the notification area (or system tray) menu to turn it off. If you close the desktop alert , it will not remain hidden permanently. It will display again as long as jobs are active unless the alert is turned off.
You can specify what jobs display on the desktop alert via the Options dialog. To access the Options dialog, select Options from the RSM icon context menu or select Tools > Options from the menu bar.
3.10. Accounts Dialog
The Accounts dialog allows you to add, edit, and delete primary and alternate accounts. You can also define Compute Servers and change the passwords for primary and alternate accounts. To access the Accounts dialog, right-click the Manager node in the Tree view and select Accounts from the context menu.
The Add Primary Account button allows you to define primary accounts for RSM. A primary account must be defined for your current user name in order for you to add new primary accounts. If a primary account is not defined for your current user name, the User Name field of the Adding Primary Account dialog defaults to your current user name.
When you right-click an existing account, the following context menu options are available:
Accounts Dialog
Function Option
Create an alternate account for the selected primary account.
Add Alternate Account
Available only when a primary account is selected.
Change the password for the selected account.
Change Password
Deletes the selected account.
Remove
When a primary account is removed, any associated alternate accounts are also removed.
By default, the primary account can send jobs to all of the Compute Servers. If an alternate account is defined, the check boxes in the Compute Servers list allow you to specify which Compute Servers will use the alternate account.
For details on working with accounts, see RSM User Accounts and Passwords (p. 45)
3.11. RSM Notification Icon and Context Menu
When RSM is minimized, it does not display in the task bar, but you can open the interface by double-clicking on the RSM icon in the notification area (also called the “system tray” for Windows XP or Linux GNOME).
On a Windows system, the notification area or system tray is accessible from the desktop and the RSM icon is loaded to the notification area by default. On a Linux system, you may need to enable the noti-fication area or system tray for the desktop.
To open the RSM interface, double-click the notification icon. The icon changes based on the status of jobs, and tooltip on the icon displays the current status of the jobs (i.e., the status and how many of those jobs are running, queued, failed, etc.).
Job Status Notification
Icon
No jobs are running.
At least one job is running.
At least one job has failed.
All jobs have completed.
Right-click the RSM icon to access its context menu. The context menu contains most of options that are available on the RSM menu bar, as shown below:
Description Menu
Op-tion
Displays the Options dialog.
Options
Functions in the same way as Tools > Options on the menu bar.
Displays the Help system in another browser window.
Help
Provides information about the program.
About
Displays or hides jobs that belong to other owners.
All Owner Jobs
Works in conjunction with the View > All Owner Jobs option in the menu bar and theAll Owner Jobs icon in the toolbar.
Enables/disables the desktop alert window (see Desktop Alert (p. 40)).
Desktop Alert
Works in conjunction with the Tools > Desktop Alert option in the menu bar.
Displays the RSM main window.
Open Job Status
Exits the RSM application.
Exit
Functions in the same way as File > Exit on the menu bar.
RSM Notification Icon and Context Menu
Chapter 4: RSM User Accounts and Passwords
The Accounts dialog allows you to configure accounts and passwords for RSM users. The changes you are able to make depend on your RSM privileges, as follows:
RSM Administrative Privileges If you are a member of the RSM Admins user group, you have
RSM Administrative Privileges If you are a member of the RSM Admins user group, you have