Access command assistance from the administrative console

Use command assistance, we can view wsadmin scripting commands in the Jython language for the last action run in the administrative console. This topic discusses how to access command assistance from the administrative console.

We must have WebSphere Application Server and the administrative console running to access command assistance.

Use command assistance to see wsadmin scripting commands that correspond to actions in the administrative console. Seeing these commands might help you develop the commands necessary to administer WebSphere Application Server from the wsadmin utility.

If a command assistance link is listed in the help portlet, wsadmin commands exist for the last console action that you completed, and command assistance is available for that action.

When command assistance is unavailable in the help portlet: Some console actions do not have wsadmin commands directly associated with them. When the help portlet of the administrative console panel does not have a command assistance link in it, no command assistance data is available for the last console action.

1. Click the link under Command assistance to view wsadmin scripting commands for the last action run for this administrative console panel.

   After the Command assistance window opens, it refreshes automatically when new command assistance data is available.

   Examples of actions include a click on a button or a click on a link in the navigation bar, a collection panel, or a detail panel. The editing of forms is not a user action.

   The wsadmin scripting commands display in the Jython language in a secondary window that we can view by clicking on the Command assistance link in the help portlet.

   If we perform an administrative console action after you launch the Command assistance window, whether or not the scripting commands display in the window depends on whether the browser supports Javascript. If the browser supports Javascript, the Command assistance window automatically refreshes the command list to reflect the most recent console action. If the browser does not support Javascript, click the link again under Command assistance in the help portal to refresh the command list.

2. To view the description of a specific wsadmin command, place the cursor over the command.

   Hover text is displayed.

3. Optionally, log the command assistance data to a file by selecting the Log command assistance commands setting on the Preferences page of the administrative console.

   A timestamp and the breadcrumb trail of the panel that produced the command assistance data are provided with the wsadmin data.

   This file is saved to ${LOG_ROOT}/server/commandAssistanceJythonCommands_user name.log:

   • server is the server process where the console runs, such as dmgr, server1, adminagent, or jobmgr.

   • user name is the administrative console user name.

   • When you manage a profile using an administrative agent, the command assistance log is put in the location of the profile that the administrative agent is managing. The ${LOG_ROOT} variable defines the profile location.

4. Optionally, allow command assistance to emit JMX (JMX) notifications by selecting the Enable command assistance notifications setting on the Preferences page of the administrative console.

   Enablement of the notifications allows integration with product tools such as the Rational Application Developer Jython editor to assist you in writing scripts.

   The notification type is websphere.command.assistance.jython.user_name where user_name is the name of the administrative console user.

Results

You have viewed wsadmin scripting commands from the administrative console, optionally logged the commands to a file, and optionally allowed command assistance to emit JMX notifications.

What to do next

We can continue the administration of the administrative console.

Subtopics

• Administrative console actions with command assistance
  Using command assistance, we can view wsadmin scripting commands in the Jython language for the last action that runs in the administrative console. This topic lists the administrative console actions that have wsadmin commands available in the command assistance option of the Help portlet.

Related tasks

Use the administrative console

Monitor application logging using JMX notifications

Console preferences settings