Skip to content

Commit addb885

Browse files
committed
Documentation update
1 parent 6f149d6 commit addb885

File tree

2 files changed

+32
-8
lines changed

2 files changed

+32
-8
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ The Oracle WebLogic Server Remote Console is a lightweight, open source console
55

66
The Remote Console is fully supported with WebLogic Server 12.2.1.3, 12.2.1.4, and 14.1.1.
77

8+
Ready to download and use the Remote Console? See [Get Started](#start).
89

910
## Key Features of the WebLogic Server Remote Console
1011
The WebLogic Server Remote Console provides an alternative WebLogic Server administration GUI that enables REST-based access to WebLogic management information, in alignment with current cloud-native trends. When connected to a WebLogic domain using the Remote Console, you can:
@@ -23,11 +24,11 @@ The WebLogic Server Remote Console provides an alternative WebLogic Server admin
2324
If you are already familiar with the WebLogic Server Administration Console deployed as part of your WebLogic domain, you'll notice these key differences in the WebLogic Server Remote Console:
2425
* The user interface has been completely redesigned to conform to the Oracle Alta UI Design system and the Oracle Redwood theme included with Oracle JET.
2526
* The configuration and monitoring content is separated into separate pages in the Remote Console. In the WebLogic Server Administration Console, the configuration and runtime information is presented on one page. See [Separation of Configuration and Runtime Data](site/console_uidesign.md#separation).
26-
* The Change Center is now expressed as a shopping cart.
27+
* The Change Center is now expressed as a shopping cart. See [Use the Shopping Cart](site/console_uidesign.md#cart).
2728
* Instead of logging directly into the Administration Console deployed in a WebLogic domain, the Remote Console connects to the Administration Server in a WebLogic domain, with the credentials supplied by the user, using WebLogic REST APIs.
2829

29-
## Get Started
30-
You can download a `console.zip` installer, or build the console from source. In this version, the console consists of the Remote Console JAR file, associated libraries necessary to use the console, and a web application that provides an extension that you can configure in your WebLogic Server domain. The extension provides additional functionality that is not available with the console only. Although installing the extension is optional, we recommend that you install it to get the optimum functionality from the Remote Console.
30+
## Get Started <a name ="start"></a>
31+
You can download a `console.zip` installer from [https://github.com/oracle/weblogic-remote-console/releases](https://github.com/oracle/weblogic-remote-console/releases), or build the console from source. In this version, the console consists of the Remote Console JAR file, associated libraries necessary to use the console, and a web application that provides an extension that you can configure in your WebLogic Server domain. The extension provides additional functionality that is not available with the console only. Although installing the extension is optional, we recommend that you install it to get the optimum functionality from the Remote Console.
3132

3233
To install the software, simply unzip the `console.zip` installer on a machine that has JDK 11 installed. After unzipping the archive, the console is ready to use. You simply start the console application, enter the console URL in a browser, and provide the Administration credentials and URL for the domain of your choice.
3334

@@ -44,3 +45,10 @@ See the following list of [Known Issues](site/known_issues.md), limitations, and
4445
* For information for tuning the environment, see [Tuning the Remote Console Environment](site/tuning.md).
4546
* For information for developers, such as building the Remote Console from source, see the [Developer Guide](site/developer_guide.md).
4647
* For information to help troubleshoot configuration issues, see [Troubleshoot](site/troubleshoot.md).
48+
49+
## Need more help? Have a suggestion? Come and say, "Hello!"
50+
51+
We have a **public Slack channel** where you can get in touch with us to ask questions about using the Remote Console or give us feedback
52+
or suggestions about what features and improvements you would like to see. We would love to hear from you. To join our channel,
53+
please [visit this site to get an invitation](https://weblogic-slack-inviter.herokuapp.com/). The invitation email will include
54+
details of how to access our Slack workspace. After you are logged in, please come to `#remote-console` and say, "hello!"

site/console_uidesign.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
## Separation of Configuration and Runtime Data <a name ="separation"></a>
77
Unlike the WebLogic Server Administration Console, which has pages that combine the configuration and runtime data, the Remote Console has separate pages for each. For example, in the Remote Console:
88
* The Servers table under Environment in the Configuration perspective shows all the configured servers (in the 'edit' tree), but does not show whether each server is running.
9+
* The Server States table in the Monitoring perspective lists all the servers, both configured and dynamic, (in the Administration Server's 'server config' tree) and the status of each server. This page also provides control operations to change the state of the servers.
910
* The Running Servers table in the Monitoring perspective lists the servers (in the Administration Server's 'server config' tree) that are currently running.
10-
* The Server States table in the Monitoring perspective lists all the servers, both configured and dynamic, (in the Administration Server's 'server config' tree) and the status of each server.
1111

1212
You can navigate easily between the two perspectives using the drop-down list in the breadcrumbs and the icons in the NavStrip on the left.
1313

@@ -54,6 +54,7 @@ Consider the following usage notes when using the WebLogic Server Remote Console
5454
- [Use the Tool Bar Icons in the Content Pane](#tool_bar)
5555
- [Use the Shopping Cart](#cart)
5656
- [Use the Remote Console Help](#help)
57+
- [Use the Remote Console Control Operations](#controls)
5758

5859
### Create MBeans <a name ="create"></a>
5960
The Remote Console includes simplified wizards for deploying applications and creating JDBC system resources.
@@ -79,16 +80,31 @@ You can use the shopping cart to:
7980
* Discard all the changes currently in the shopping cart. There is currently no support for removing an individual shopping cart item.
8081

8182
If you installed the [Remote Console extension](install_config.md#extension) in your domain, you can:
83+
* View the status of the lock in the Change Manager.
8284
* View additions and deletions of configuration objects.
8385
* View the before and after values of fields modified through forms.
8486
* Navigate to the form associated with the addition or change.
8587

86-
This content is visible in a Kiosk pop-up, accessible by clicking View Changes from the Shopping Cart menu, or by clicking the Kiosk tab on the bottom right side of the page.
88+
These pending changes and lock status are visible in a Kiosk window, accessible by clicking View Changes from the Shopping Cart menu, or by clicking the Kiosk tab on the bottom right side of the page.
8789

88-
Note that when you activate nondynamic changes, you need to navigate to the 'Running Servers' table in the Monitoring perspective to see which servers need to be rebooted so that they can start using the new configuration.
90+
**Difference Between the Change Center and Change Manager**
91+
In the WebLogic Server Administration Console, the Change Center provides a way to lock a domain configuration so you can make changes to the configuration while preventing other accounts from making changes during your edit session. It can be enabled or disabled in a development domain, and is enabled by default in a production domain. When locking is enabled, you start the edit process by obtaining a lock. When you finish making changes, you save the changes. The changes do not take effect, however, until you activate them, distributing them to all server instances in the domain.
92+
93+
The WebLogic Server Remote Console provides similar locking functionality in the shopping cart. In the Remote Console, in both development and production domains, the pages are always read/writeable. When you create an MBean or save a change to page, the Remote Console automatically grabs the lock. To view details about the lock, expand the Change Manager in the Kiosk. The changes are not activated until you click Commit Changes.
94+
95+
When you activate nondynamic changes, you need to navigate to the 'Running Servers' table in the Monitoring perspective to see which servers need to be rebooted so that they can start using the new configuration.
96+
97+
In both consoles, the configuration change lock does not prevent you from making conflicting configuration edits using the same administrator user account. For example, if you obtain a configuration change lock using the WebLogic Server Remote Console, and then use the Administration Console or WebLogic Scripting Tool (WLST) with the same user account, you will access the same edit session that you opened in the Remote Console and you will not be locked out of making changes with the other tools.
98+
99+
**Note:** Oracle recommends against making changes using multiple tools because when one of the sessions activates their changes, it releases the lock and the other session will not be able to save or activate their changes.
89100

90101
### Use the Remote Console Help <a name ="help"></a>
91102

92103
The Remote Console provides several types of online help on each page.
93-
* Use the ? icon to the left of each field to access summary and detailed help for the field. If you place the mouse over the ?, a summary help description displays. Click the ? icon to display a more detailed help description, if available.
94-
* Click the ![Help icon](../frontend/src/images/help-icon-blk_24x24.png) in the top left of the content pane to view reference information about all of the fields displayed on the page.
104+
* Use the ? icon to the left of each field to access summary and detailed help for the field. If you hover over the ?, a summary help description displays. Click the ? icon to display a more detailed help description, if available.
105+
* Click the ? icon in the top right of the content pane to toggle the view of the reference information for all of the fields displayed on the page.
106+
107+
### Use the Remote Console Control Operations <a name ="controls"></a>
108+
The Remote Console provides control operations in the Monitoring perspective.
109+
* The Server States page contains the control operations to change the state of a server. Server state signifies the specific condition of a server in the life cycle management. To change the server state, click the desired control at the top of the table. Then, in the next window, select the servers on which you want to perform the control operation. Consistent with the WebLogic Server Administration Console, the Remote Console includes support for graceful shutdowns.
110+
* The App Deployments Runtimes page, under Domain Information in the Navigation tree, provides controls to start and stop applications. To start or stop an application, select the control, then in the next window, select the applications on which you want to perform the operation.

0 commit comments

Comments
 (0)