1 Get Started

WebLogic Remote Console is easy to install and you can quickly start managing your domains.

WebLogic Remote Console is available in two formats:

  • Desktop WebLogic Remote Console, a desktop application installed on your computer.
  • Hosted WebLogic Remote Console, a web application deployed to an Administration Server and accessed through a browser.

Generally, the two formats have similar functionality, though the desktop application offers certain conveniences that are not possible when using a browser.

If your environment has restrictions on installing applications, consider enabling Hosted WebLogic Remote Console. See Deploy Hosted WebLogic Remote Console.

System Requirements

Review the system requirements needed to run WebLogic Remote Console.

WebLogic Remote Console is compatible with WebLogic Server 12.2.1.4.0 and later.

Note:

Hosted WebLogic Remote Console is only supported on Administration Servers running WebLogic Server 14.1.2.0.0 or later, and is subject to the same system requirements as its associated WebLogic Server release. To see the applicable certification matrix for your release of WebLogic Server, refer to Oracle Fusion Middleware Supported System Configurations.

Desktop WebLogic Remote Console is supported on the following platforms.

Table 1-1 Requirements

Platform Minimum Requirement
Linux

64 bit only.

  • Debian 11 and later
  • Fedora 40 and later
    • Oracle Linux 7 and later
  • Ubuntu 16.04 and later
macOS

13 (Ventura) or later

Note: Intel machines must be 64 bit.

Windows

64 bit only.

Windows 10 and later.

We recommend setting the viewport of WebLogic Remote Console to 1300 px or wider. On narrower viewports, UI elements may overlap or disappear.

Install Desktop WebLogic Remote Console

Desktop WebLogic Remote Console is a version of WebLogic Remote Console that is based on the Electron framework and installed as a desktop application.

  1. Download the latest version of WebLogic Remote Console from the WebLogic Remote Console GitHub Repository releases page. Choose the appropriate installer for your operating system.
  2. Follow the typical process for installing applications on your operating system.
  3. Launch WebLogic Remote Console.

If you are using WebLogic Server 14.1.1.0 or earlier, you can enhance the functionality for managing Administration Servers by installing the WebLogic Remote Console extension. See Install the WebLogic Remote Console Extension. The extension comes pre-installed in WebLogic Server 14.1.2.0 and later.

Deploy Hosted WebLogic Remote Console

Hosted WebLogic Remote Console is a version of WebLogic Remote Console that is hosted on the Administration Server of the domain and accessed through a browser.

Hosted WebLogic Remote Console is useful for situations where it is not feasible to install external applications in your environment.

Note:

Deploying Hosted WebLogic Remote Console is only supported on Administration Servers running WebLogic Server 14.1.2.0.0 or later.
  1. Start the Administration Server.
  2. Deploy the Hosted WebLogic Remote Console application using the WebLogic Scripting Tool (WLST).
    1. Open a command line terminal and go to ORACLE_HOME/oracle_common/common/bin.
    2. Invoke WLST with the following options:

      For Unix operating systems, enter:

      wlst.sh WL_HOME/server/bin/remote_console_deployment.py t3://hostname:port username < password.txt

      For Windows operating systems, enter:

      wlst.cmd WL_HOME\server\bin\remote_console_deployment.py t3://hostname:port username < password.txt

      Where:

      • WL_HOME is the top-level installation directory for WebLogic Server.
      • hostname is the host name of the Administration Server.
      • port is the port number of the Administration Server.
      • username is a user account capable of deploying applications.
      • password.txt is the path to a file containing the password for the specified user account.

      Examples:

      On Unix operating systems:

      wlst.sh /Users/smithdoe/Oracle/Middleware/Oracle_Home/wlserver/server/bin/remote_console_deployment.py t3://localhost:7001 admin < /Users/smithdoe/password.txt

      On Windows operating systems:

      wlst.cmd C:\Oracle\Middleware\Oracle_Home\wlserver\server\bin\remote_console_deployment.py t3://localhost:7001 admin < C:\Users\smithdoe\password.txt

Hosted WebLogic Remote Console is now deployed and will remain active as long as the weblogic-remote-console-app application is deployed and the Administration Server is running.

Do not stop or delete the Hosted WebLogic Remote Console application, weblogic-remote-console-app, if you want to continue to use Hosted WebLogic Remote Console.

To use Hosted WebLogic Remote Console to manage the running Administration Server, see Start Hosted WebLogic Remote Console.

Start Hosted WebLogic Remote Console

Hosted WebLogic Remote Console is a version of WebLogic Remote Console that is accessible using a browser.

Before you can start Hosted WebLogic Remote Console, you must have deployed it. See Deploy Hosted WebLogic Remote Console.

  1. Start the Administration Server.
  2. Open a browser and enter http://hostname:port/rconsole (or for HTTPS, https://hostname:port/rconsole).

    Where hostname and port match the values you set when you deployed Hosted WebLogic Remote Console.

    Note:

    If your Administration Server is behind a firewall or load balancer, or otherwise externally unavailable, you must manually expose the rconsole/* endpoint to make it accessible, similar to exposing console/* for the WebLogic Server Administration Console.

    This is in addition to exposing the management/* endpoint which is required for general domain configuration.

  3. Log in to Hosted WebLogic Remote Console.
  4. In the Providers drawer, select This Server.

Hosted WebLogic Remote Console is active as long as the weblogic-remote-console-app application is deployed and the Administration Server is running.

Note:

You can use Hosted WebLogic Remote Console to connect to and manage other providers beyond the Administration Server it is hosted on. See Connect to a Provider.

Install the WebLogic Remote Console Extension

The WebLogic Remote Console extension enhances the management capabilities of WebLogic Remote Console for Administration Server connections.

For an overview of the functionality provided by the WebLogic Remote Console extension, see Features of the WebLogic Remote Console Extension.

Note:

You only need to perform this procedure if you are running WebLogic Server 14.1.1.0.0 or earlier. As of WebLogic Server 14.1.2.0.0, the WebLogic Remote Console extension is automatically installed in your domain and updated with each Patch Set Update (PSU).
  1. Under DOMAIN_HOME/, create a folder and name it management-services-ext.
  2. Download the latest WebLogic Remote Console extension, console-rest-ext-2.4.16.war, from the WebLogic Remote Console GitHub Repository releases page.

    console-rest-ext-jakarta-2.4.16.war is intended for domains running WebLogic Server 15.1.1.0.0 or later; you should not need to install it manually.

  3. Save the extension under management-services-ext.
    You do not need to deploy console-rest-ext-2.4.16.war as an application in your domain.
  4. Restart the Administration Server.
  5. In WebLogic Remote Console, disconnect and then reconnect to the Administration Server.

The WebLogic Remote Console extension is updated with WebLogic Remote Console. Whenever you update WebLogic Remote Console, make sure you also update the extension to match.

If you need to update the WebLogic Remote Console extension separately from the console, follow the instructions outlined in step 2 of Upgrade Desktop WebLogic Remote Console. Note that if you manually install the WebLogic Remote Console extension in domains running WebLogic Server 14.1.2.0.0 or later, under DOMAIN_HOME/, it will supersede the version of the extension that is automatically installed and updated.

Features of the WebLogic Remote Console Extension

The WebLogic Remote Console extension adds many features to WebLogic Remote Console that are useful for the administration of WebLogic Server domains.

When the WebLogic Remote Console extension is installed, it grants the following capabilities to WebLogic Remote Console:

  • View pending changes - Identify any changes that are saved to the domain but not yet committed. Pending changes are listed in the Shopping Cart.

  • Access the Security Data Tree perspective - Edit security data that is stored in the embedded LDAP server, including, but not limited to, managing:

    • Users and Groups

    • Roles and Policies

    • Credential Mappings

    You can also view (but not edit) the users and groups for any authentication provider that supports it.

  • Create and edit application deployment plans - Use deployment plans to extend or override an application's deployment descriptors.

  • Manage JMS messages - Import, export, or delete messages.

  • Manage JTA transactions - Import, export, or delete transactions.

  • Test data source connections - Verify that the domain can successfully connect to the configured database.

  • View objects in JNDI structure - Examine objects such as Java EE services and components such as RMI, JMS, EJBs, and JDBC data sources.

  • Upload applications or database client data for redeployment - Update and redeploy applications or database client data with new versions that were not already deployed to the Administration Server.

    The redeployment of applications or database client data that are already on the server is supported without the extension.

  • Analyze server connection issues - Test connections between the Administration Server and Managed Servers or clusters.

For installation instructions, see Install the WebLogic Remote Console Extension.

Provider Types

Use WebLogic Remote Console to connect to the following provider types, each of which offers a different approach for managing your WebLogic Server domains.

Provider Description
Administration Server Connect to a running WebLogic Server domain through its Administration Server.
WDT Model Files Edit WebLogic Deploy Tooling (WDT) metadata models of WebLogic Server domains.
WDT Composite Models Combine and compare settings across multiple WDT model files.
Property Lists Edit the key-value pairs that enable the use of variables in WDT model files.

Connect to a Provider

You can connect WebLogic Remote Console to a WebLogic Administration Server, WDT model file, or another provider.

  1. Open the Providers drawer and click More ︙.
  2. Choose a provider type from the list:
    • Add Admin Server Connection Provider
    • Add WDT Model File Provider
    • Add WDT Composite Model File Provider
    • Add Property List Provider
    • Create Provider for new WDT Model File
    • Create Provider for New Property List
    For information on the different providers, see Provider Types.
  3. Fill in any required connection details for the selected provider.
  4. Click OK to establish the connection.

    The Administration Server must be running for the connection to succeed.

Upgrade Desktop WebLogic Remote Console

Upgrade to the latest version of Desktop WebLogic Remote Console and take advantage of the latest features in both the console and WebLogic Server.

If a newer version of Desktop WebLogic Remote Console is available, an alert will appear in the menu bar.

  1. In Desktop WebLogic Remote Console, open Updates Available, then Download and install.

    Desktop WebLogic Remote Console update runs in the background so you can continue working in WebLogic Remote Console with no interruptions. The next time the console is launched, the updates will apply.

    You can also download the update from the WebLogic Remote Console GitHub Repository releases page and apply the update manually.

  2. For WebLogic Server 14.1.1.0.0 and earlier: Update the WebLogic Remote Console extension.

    In WebLogic Server 14.1.2.0.0 and later, the WebLogic Remote Console extension is included with the initial installation and is updated by subsequent Patch Set Updates (PSU) and should not be updated manually.

    For the best experience, you should keep the versions of WebLogic Remote Console and its extension in sync with each other. That is, when you are running WebLogic Remote Console 2.4.16, you should have console-rest-ext-2.4.16.war installed.

    1. While connected to the domain, open the Providers drawer and beside the provider connection, click the Get Info icon to see the Console Extension Version. If it matches WebLogic Remote Console version, you can skip the rest of the steps. Otherwise, continue.
    2. Go to DOMAIN_HOME/management-services-ext and delete the existing WebLogic Remote Console extension.
    3. Download the WebLogic Remote Console extension that matches your WebLogic Remote Console from the WebLogic Remote Console GitHub Repository. It will be within the matching WebLogic Remote Console release section.
    4. Save the extension to DOMAIN_HOME/management-services-ext.
    5. Restart the Administration Server.