Navigation
You access Redwood Server using its web-based user interface (UI) which has been adapted for screen-readers. The web UI allows you to access the complete functionality for which you have authorizations. It offers the same features as an application installed on your local workstation, the browser context-menu has been replaced with specific context-menus. Context-menus are opened with a alternative pointing device (with a mouse or touchpad, the right-click operation) in the target region of the UI that supports context-menus.
Keyboard Shortcut Keys
You access the documentation using the F1
key.
You access the More dialog, displayed when a field has a long list of values, using the F2
key.
The Main Screen
Upon a successful login, the user interface appears. It may take a few seconds to organize the display if this is the first time. The summary page shows the status of the entire system. This summary page can be used to access other parts of the system.
The following figure shows the main screen.
The product name displayed at the top of the page in the title bar will vary depending on what licenses you have purchased. On the right-hand side of the title bar is the name of the user who is logged into RunMyJobs. To the right of the user name is a logout button. The tool bar is located below the title bar; it provides access to frequently used facilities. The navigation bar is on the left-hand side, this allows access to the different screens that are shown in the main pane on the right-hand side. More details about these are provided later.
Browsing and Working with Objects
You can use the navigation bar on the left-hand side to access different objects within the system.
- Choose Definitions, this shows a list of modules to choose from.
- Choose Definitions > Processes. A new tab opens on the right-hand side, showing a list of all process definitions in alphabetical order by name.
- Choose the first process in the list (do not click on a column that is a hyperlink). A preview pane appears. The preview pane shows more detailed information about the currently selected object in the table.
- Select the System_RemoveDeletedJobFiles process in the list (do not click on a column that is a hyperlink). When this process definition is selected, the preview pane changes to show its details.
- At the top of the details pane, click on the process definition name, which is a hyperlink. A new tab is created with only that process definition; it is the show page. Now, access the context-menu of System_RemoveDeletedJobFiles in the process definitions table. This is accomplished by right-clicking on System_RemoveDeletedJobFiles in the table. A pop-up menu appears.
- Choose Submit. This opens the Submit Wizard; select System in the Process Server field. In the Submit Wizard times and dates at which the process runs can be specified, as well as the queue and priority to use. This process runs fine with the defaults, so choose Submit.
- Using the navigation bar, navigate to Monitoring > Processes; this is the overview of all processes that appear in a new tab labeled Processes.
- Select the System_RemoveDeletedJobFiles process in the table by clicking on any non-hyperlink column, which will result in the details pane appearing with additional information about the process.
- In the details pane, some items have a caret (>) in a box next to them; these can be expanded to show more information. The second item with a caret (>) next to it is Files. This shows the files that the process created while it was running. Choose the caret (>) next to Files to expand this option. This process created an output file while it was running. A second file will be created if any errors occurred.
- Choose the file name (stdout.log), this opens a new tab, showing the file contents.
- In the stdout.log tab, click on the (x) to close it. If you hover over the x, you will see a close tab tooltip. After closing the tab, focus will revert to the processes (monitor) tab.
note
If you do not see the System_RemoveDeletedJobFiles process in the Processes tab, it is likely because the processes filter needs to be changed. The filter is in the tool bar. Click on the filter's drop down arrow and select Custom Maintenance (Background) Processes, then click on the refresh icon to the right of the filter.
The Title bar and Tool bar
The following figure shows the title and tool bars.
The title bar provides the following:
- Redwood product name - this can vary depending on the licenses purchased. It is RunMyJobs in this example.
- User name and_Logout_button - in the upper right-hand corner is the name of the user who is logged in, followed by a logout button.
The tool bar provides quick access to several frequently used facilities. Each tool bar button displays a tool tip when you mouse over it. The tool bar buttons, from left to right, are as follows:
- Home - the home page provides an overview of system status.
- Submit Process - this link submits a new process.
- Processes Monitor - this provides a direct link to the processes monitor.
- User Settings - this opens the user specific settings dialog.
- Extension Points - the two tool bar buttons that follow User Settings, enclosed by vertical lines "|", provide access to a variety of add-on functionality, called extension points. In this example, the two buttons are related to the SLA (Service Level Agreement) extension point. What you see in your environment will depend on whether your Redwood Server's functionality has been extended using extension points.
- Refresh - refreshes the currently selected tab.
- Object Search - search for objects of various types.
- Information - allows you to access version information, the online help, suggestions, as well as support.
Tool bar with additional buttons
The figure below depicts a tool bar with the buttons described above, as well as three additional buttons. The additional buttons (Filter, Add, and IntelliSearch) are present because the current overview, Process Definitions, supports the functionality. Many other overviews include some or all of these additional buttons.
The three additional tool bar buttons are described below.
- Filter - the context-sensitive filter is displayed in some monitor and object overviews. It filters the data in the currently selected tab. There are built in filters, displayed in a drop down list, and you can optionally create your own.
- Add - a quick way to create a new object.
- IntelliSearch - quick and efficient object search, which limits the search to the current tab.
Actions
All objects have actions associated with them. In some cases not all actions are available.
There are three reasons why this may be:
- The local security policy.
- Restrictions in the license.
- The object has become read-only, like a process that has reached the status Queued.
There are 5 basic actions that are supported by most objects:
- New
<object_type>
- create a new object of type<object_type>
- Edit - edit an existing object
- Delete - delete an object
- Export - export the object to a CAR file for backup
- Refresh - refresh the current overview to display recent changes
Many objects also support specific actions. Some examples are:
- Processes can be restarted, resubmitted, held, released, and so on.
- Process definitions and chains can be submitted as processes.
- Queues can be held and released.
- Process servers can be started and stopped.
Some actions require further input before they can be completed, these actions are shown with a trailing ellipsis (...) to indicate that further input is required. Actions without the trailing ellipsis are executed immediately.
- Example actions that require further input: Edit, Add Note and Resubmit.
- Example actions that don't require further input: Hold, Release and Refresh
Additional actions for navigation:
- Navigation Bar - allows you to select the navigation bar to use. One way to access this option is by right-clicking anywhere in the navigation bar area, then selecting Navigation Bar. If there are any custom navigation bars, they will appear in a list. If not, you will simply see Default Navigation Bar.
- Toggle fullscreen - allows you to hide the navigation bar and optimize screen real-estate. One way to access this option is by right-clicking anywhere in the navigation bar, then selecting Toggle Full Screen. Using this option removes the UI's navigation bar, title bar and tool bar. To remove only the navigation bar, click on the main pane's caret (<), which is located on the left side of the main pane, about halfway down. This caret functions as a toggle, to hide/show the navigation bar.
- Help - display the help topic covering the current tab. Right-click on the feature you wish to access help for, then select Help.
- Refresh - update the display for the current tab. One way to access this option is by right-clicking anywhere in the navigation bar, then selecting Refresh.
- Close tab - will close the current tab and switch to the previously selected tab. Clicking the tab’s (x) is the quickest method.
- Close all other tabs - closes all tabs except for the current tab. This option is accessed with a right-click on the tab you wish to keep open. From there, select Tab > Close all other tabs.
Restrictions on Actions
License restrictions can prevent the following actions:
- Editing or Duplicating process definitions of type
System
- these are supplied by Redwood, a number can be edited. - Creating definition types - these are supplied by Redwood.
- Creating Users or Roles - these are automatically synchronized.
Furthermore, it is not possible to create or delete time zones, as these are fixed. It is possible to change the description of a time zone.
Add-Ons
Rich Text
A rich text editor is available for Documents; when you edit a document, a popup invites you to download it from http://support.redwood.com
. The editor allows you to use text styling in documents.
ACE Editor
The Redwood Server process definition editor can use the ACE editor which improves the usability of source editors and is downloaded from http://cloudfront.net
. Users with administrator privileges are asked after login if the ACE editor should be used, until a Yes or No answer is given; the administrator can choose between Yes, No and Ask me later.
The definition editor uses the ACE editor for improved usability.
The registry entry /system/ui/configuration/DisableAceEditor
allows you to disable the ACE editor and use the standard browser editor; you set it to true
or t
to disable it and you delete the registry entry or set it to false
or f
to enable the ACE editor.