Identifying LISTEN Ports for Hyperion Services

Identifying LISTEN Ports for Hyperion Services [ID 1109448.1]
		Modified 18-AUG-2011     Type REFERENCE     Status PUBLISHED

In this Document
  Purpose
  Scope
  Identifying LISTEN Ports for Hyperion Services

---

Applies to:

Hyperion BI+ - Version: 9.3.1.0.00 to 11.1.2.1.000 - Release: 9.3 to 11.1
Hyperion BI+ - Version: 9.3.1.0.00 to 11.1.2.1.000   [Release: 9.3 to 11.1]
Hyperion BI+ - Version: 9.3.1.0.00 to 11.1.2.1.000   [Release: 9.3 to 11.1]
Hyperion BI+ - Version: 9.3.1.0.00 to 11.1.2.1.000   [Release: 9.3 to 11.1]
Hyperion Essbase - Version: 9.3.1.0.00 to 11.1.2.1.000   [Release: 9.3 to 11.1]
Information in this document applies to any platform.

Purpose

The purpose of this article is to:

1. Identify existing documentation that identifies the fixed/default LISTENING ports for Hyperion services.
2. Provide procedures to identify the ports associated with Dynamic services that do not consistently bind to fixed/specific ports on start-up.

Scope

The intended audience for this document is:

1. Hyperion Support Analysts troubleshooting Hyperion Services communication issues.
2. Persons installing/configuring Hyperion Services.

Identifying LISTEN Ports for Hyperion Services

Standard LISTEN ports:

Standard fixed LISTEN ports for Hyperion Services are defined in the Install documents.  The install document for Version 9.3.1.x can be accessed at:

http://download.oracle.com/docs/cd/E10530_01/doc/epm.931/hsys9_install_start_here.pdf

The installation document for Version 11.1.1.x may be viewed at:

http://download.oracle.com/docs/cd/E12825_01/epm.111/epm_install_start_here.pdf

The installation document for Version 11.1.2.x may be viewed at:

http://download.oracle.com/docs/cd/E17236_01/epm.1112/epm_install_start_here.pdf

These documents also identify where the ports are configured.  Refer to this configuration information to identify the LISTEN for a service that is running on a non-standard port.

Dynamic LISTEN ports:

If the installation lists the port as “Dynamic,” the service will, by default, bind to a randomly selected port when it starts.  If the service can be configured to bind to specific ports on startup, the installation documents will identify where the port is configured.  If you need to find the LISTEN port for a service identified as “Dynamic,” review the appropriate configuration file first to see if a LISTEN port has been specified.

If the port is not specified, the LISTEN port for the “Dynamic” service can be identified using the following procedures:

Windows OS:

On the machine where the service is running:

1. Right-click on the Windows Task bar and select “Task Manager.”

2. In Task manager, select the “Processes” tab

3. Select “View->Select Columns”

4. Select “PID (Process Identifier)” to display the Process Identifier associated with the running service.

5. Select OK.

6. In the “Processes” tab, locate the process associated with the service for which you wish to identify the port.

7. Note the “PID” associated with the process. In this example, the PID associated with the Financial Reporting Service (HyS9FRReport.exe) is 3400.

8. Select “Start->Run” from the Windows Task Bar

9. Enter “cmd” (without the quotes) in the “Run” dialog and select “OK” to open a Windows Command Prompt.

10. In the Command Prompt enter:

             netstat –nao | findstr PID

NOTE: The -o option to netstat is only available on Windows 2003 servers and later

Where PID = the Process identifier identified in step 7. For this example, you would enter:

11. The netstat output lists the lines containing the PID string. The PID is displayed in the right-hand column of the output. The port is displayed in the second column of the output. In this example, the output shows that the service is listening on ports 2559 and 2562.

UNIX OS
In the general, the process to identify the LISTEN port for processes running on Linux/UNIX server is similar to that described above: Identify the Process ID for the Service, then identify the port(s) associated with that Process ID.

On most versions of Linux/UNIX, the Process ID for a running process can be identified by runing:

ps –ef | grep processName (where processName is a text string associated with the process ) 

        in a command/console window on the server where the process is running. Many of the Hyperion programs also store the Process ID of the running process in a text file, usually with a “.pid” extension. You can run the commands:

cd HYPERION_HOME
find . –name “*.pid” 

        to locate the “.pid” files under HYPERION_HOME. Identify the .pid for the service in which you are interested and read the file to get the Process ID.

Once you have identified the Process ID, on most version of Linux/UNIX, you can use 

lsof | grep ProcessID

        to identify the port associated with that process.

NOTE: lsof is a third party tool not commonly found pre-installed on Unix systems but can be added via your Unix systems package management tools. Contact your system administrator and request for this tool to be added to the system.