Start the Workstation

Start the Workstation launches workstation.exe which connects to the Enterprise Manager. When you finish, you can log out or you can close the Workstation. Logging out from the Workstation ends the current session, but does not shut it down. You can log in again from the Authentication dialog. This capability is useful if you want to log in with different connection parameters, such as a different host, port, user name, or password. Exiting the Workstation logs you out of the Workstation and stops the Workstation process. The Workstation saves the number of open Investigator and Console windows, so that the same configuration appears when you log in.
apmdevops106
Start the Workstation launches workstation.exe which connects to the Enterprise Manager. When you finish, you can log out or you can close the Workstation. Logging out from the Workstation ends the current session, but does not shut it down. You can log in again from the
Authentication
dialog. This capability is useful if you want to log in with different connection parameters, such as a different host, port, user name, or password. Exiting the Workstation logs you out of the Workstation and stops the Workstation process. The Workstation saves the number of open Investigator and Console windows, so that the same configuration appears when you log in.
Start the Workstation
Windows
To launch the Workstation on Windows, double click the Workstation desktop shortcut or from the command prompt run Introscope workstation.exe
To launch the Workstation in Red Hat Linux 6.x, install the following package: Package name: libXrender*686*
Browser
Follow these steps:
  1. Input the following URL in your web browser:
    http://<EM_Host>:8081/
    • where EM_Host is the host name of the Enterprise Manager
  1. Choose one of the following options:
    • Select
      Start
      Introscope Workstation
      .
    • Click a flag to start the Workstation in a specific language.
Note:
Your first time launching the Workstation, you are prompted to launch workstation.jnlp or save the file. We do
not
recommend that you save the file and select the
Do this automatically for files like this from now on
option. This option prevents you from properly launching the Workstation through a URL.
Command Line
Log in to the Workstation
To log in:
  1. In the login dialog, enter the following information:
    • Host name or IP address
      Note:
      Use the IP address instead of the host name only if both your client computer and the host computer support the same IP protocol.
    • Port number
    • User name and password
  2. Click
    Connect
    , or to make the current host and user information the default for future logins, click
    Set Defaults
    .
    The Console opens. If the authentication process is unsuccessful, a message notifies you of the failure.
Launch the Workstation Using Specific Parameters
You can launch Workstation using specific parameters that specify which view in the Workstation you want to access. You can use these parameters in the following ways:
  • A Java launch command that is issued from a command line
  • A URL that launches the Workstation using Java Web Start
  • An argument in the IntroscopeWorkstation.lax file
You can use standard URL encoding to escape special characters in agent or metrics names.
Example 1
For example, in the command line, the
-page
and
-agent
options would be:
java -client -Xms64m -Xmx256m -Dsun.java2d.noddraw=true -jar launcher.jar -consoleLog -noExit -product com.wily.introscope.workstation.product -name "Introscope Workstation" -install ".\\product\\workstation" -configuration ".\\product\\workstation\\configuration" -page investigator -agent "SuperDomain|localhost|WebLogic|WebLogic Agent"
In a URL, the same combination would be:
http://<localhost>:8081/workstation?page=investigator&agent=SuperDomain|localhost|WebLogic|WebLogic%20Agent
In the IntroscopeWorkstation.lax file, point to the same page by editing the
lax.command.line.args
specifier. The end of the string, specify the same page and agent location as follows:
lax.command.line.args=$CMD_LINE_ARGUMENTS$ -consolelog -noExit -product com.wily.introscope.workstation.product -name "Introscope Workstation" -install ".\\product\\workstation" -configuration ".\\product\\workstation\\configuration" -page investigator -agent "SuperDomain|localhost|WebLogic|WebLogic Agent"
After you add these arguments, the Workstation opens to the specified page and agent location whenever you start it from the
Start
menu.
Note the way each of the examples handles the space character in the agent name.
  • In the example, quotes are used around the entire agent name because the name contains a space.
  • In the URL example, a space character is rendered as
    %20
    .
Example 2
If the agent name is
MyAgent%1
, use the following string in the URL:
MyAgent%251
In which
%25
is the URL encoding for the literal % character.
Example 3
If the agent name is WhatIsThisAgent??, use the following string in the URL:
WhatIsThisAgent%3F%3F
%3F is the character URL encoding for the literal ?.
The following table describes the other parameters.
Note
: You cannot specify the -
start
and -
end
parameters in the Console window.
Options
Description
-loginimmediate
Suppresses the login screen and logs in to Workstation immediately using specified hostname and port number, or default values.
-loginhost <hostname>
Specifies login host name; defaults to
localhost
if unspecified.
-loginport <portnumber>
Specifies login port number; defaults to 5001 if unspecified.
-loginresponse <values>
Specifies authentication values for username and password in a comma-separated list.
-page
The name of the Workstation screen to be launched. You must include this parameter with every request to the Workstation Command Line Interface.
Supported values:
investigator
historicalquery
console
-agent
The fully qualified agent name to display in the Investigator window. Required if the
page
parameter is
investigator
. Use URL encoding to render special characters in agent names.
-metric
The metric path to display in the Investigator window, for a specified agent. You must specify an agent when you use this parameter. Use URL encoding to render special characters in metric names.
-start
The start time, n standard Java milliseconds format, for a historical time range in the Investigator window. Also, the end time for a transaction tracer historical query, depending on the value of the page parameter.
Note:
The
start/end
or
guid
parameters are required when the
page
parameter is
historicalquery
. In addition, you cannot specify
-
start and
-end
parameters in the Console window.
-end
The end time, in standard Java milliseconds format, for a historical time range in the Investigator window. Also, the end time for a transaction tracer historical query, depending on the value of the
page
parameter. When the
page
parameter is
historicalquery
,
t
he
start/end
or
guid
parameters are required
The following example uses Java timestamp values. You can convert calendar dates to Java timestamp values using widely available converters, including some available on the Internet.
http://
<localhost>
:8081/workstation?page=historicalquery&start=1135686483474&end=1136686483474
Note:
You cannot specify
-start
and
-end
parameters in the Console window.
-guid
When the page parameter is
historicalquery
,
t
he unique identifier for a transaction to display in the Transaction Tracer Historical Query window. The
start/end
or
guid
parameters are required.
For example:
http://<localhost>:8081/workstation?page=historicalquery&guid=aRx345
-agentSpecifier
Filters data to limit the dashboard display to data from the agent you specify. Can be used only when the page parameter =
console
.
The argument to the AgentSpecifier parameter must contain the agent name including the Enterprise Manager host name. Special characters, such as the | symbol which separates elements of the agent name, must be escaped with backslashes.
Substitute the string
%20
for spaces in agent names.
In this example, the dashboard displays only data from WebLogic Agent:
http://<localhost>:8081/workstation?page=console&agentSpecifier=machine1\|WebLogic\|WebLogic%20Agent&metric=GC%20Heap:Bytes%20In%20Use
-dashboardName
Specifies a dashboard to display. Can be used only when the page parameter =
console
.
Substitute the string
%20
for spaces in dashboard names.
In this example, the URL jumps to the dashboard named GC Memory In Use:
http://<localhost>:8081/workstation?page=console&dashboardName=GC%20Memory%20In%20Use&metric=GC%20Heap:Bytes%20In%20Use
Executing one of the URLs (or launching a Workstation with an equivalent Java command line) starts a Workstation instance and opens the appropriate window. The subsequent URL request opens a new window in the existing Workstation instance.
Additional examples
To launch the Workstation using Java Web Start, here are the several examples of using a URL:
  • Launch Web Start to a particular dashboard in the Console view, where the dashboard name is An Intro to Introscope:
    http://localhost:8081/workstation?host=localhost&port=5001&username=<User_ID>&password=<Your_Pwd>&page=console&dashboardName=An%20Intro%20to%20Introscope
  • Launch Web Start to a particular Agent (
    <Agent_Name>
    ) in the Investigator:
    http://localhost:8081/workstation?host=localhost&port=5001&username=<User_ID>&password=<Your_Pwd>&page=investigator&agent=SuperDomain|<Host_Name>|AppServers|<Agent_Name>
  • Launch Web Start to a particular Agent and Metric in the Investigator:
    http://localhost:8081/workstation?host=localhost&port=5001&username=<User_ID>&password=<Your_Pwd>&page=investigator&agent=SuperDomain|<Host_Name>|AppServers|<Agent_Name>&metric=GC%20Heap:Bytes%20In%20Use
  • Launch Web Start to a particular Transaction Trace GUID (
    <GUID_Number>
    ) in the Historical Query Viewer:
    http://localhost:8081/workstation?host=localhost&port=5001&username=<User_ID>&password=<Your_Pwd>&page=historicalquery&guid=<GUID_Number>
JVM Requirements for Java Web Start
The server where you plan to use Java Web Start to launch the Workstation must have a supported version of the JVM available locally.
Java Web Start installs a temporary copy of the Workstation client. Computers using proxy authentication to connect to an Enterprise Manager could encounter problems when an incorrect version of JVM is used.
On the client system, Java Web Start launches the workstation (using a Java version) through the following files:
  • <EM_Home>\product\enterprisemanager\plugins\com.wily.introscope.workstation.webstart_<version>\WebContent\jnlp\workstation.jsp
  • <EM_Home>\product\enterprisemanager\plugins\com.wily.introscope.workstation.webstart_<version>\WebContent\jnlp\com.wily.introscope.workstation.feature.jsp
Both files contain a j2se node with a version attribute that determines the Java version to launch the Workstation. View the comments in the files for a more detailed explanation of how Java Web Start detects and reacts to the present JVM.
Note
: For the JVM requirements, see the Product Compatibility Matrix. For information about the certificate that Web Start uses, see TEC1854484.
Connecting to alternate Enterprise Managers
You can start multiple Workstation application instances on different Enterprise Manager hosts from a single browser. Use the parameters that are specified in Launching the Workstation using specific parameters. To connect to an alternate or different Enterprise Manager, change the
loginHost
parameter as appropriate.
Time Zone Display in the Web Start Workstation
You can specify the time zone to display in the Web Start Workstation by updating the workstation.jsp file.
Follow these steps:
  1. Start the Enterprise Manager and connect to the Workstation using Java Web Start.
  2. Open the workstation.jsp file in the following location:
    EM install directory\product\enterprisemanager\plugins\com.wily.introscope.workstation.webstart_<version>\WebContent\jnlp
  3. By default, workstation.jsp has the following argument:
    <argument><%=emDefaults.kTimeZoneStrings[0]%></argument> <argument><%="timezone"%></argument>
  4. Enter a time zone ID that you want to display in the Workstation. For example:
    <argument><%=emDefaults.kTimeZoneStrings[0]%></argument> <argument><%="IST"%></argument>
    If you enter an invalid time zone ID, then the time displays in GMT.
  5. Save the changes.
  6. Restart the Enterprise Manager and connect to the Workstation using Java Web Start.
    The specified time zone is displayed.