Chapter 10. Application Server Administration

About Application Server Administration

The Application Server Administration area enables you to view the status of all applications that have been executed on Application Servers in StarPound Runtime. Application Servers are added to the system as deployment targets.

 

Application Server Operations

Users with permission to this area can:

  • View the current status of all Application Servers
  • Start and shut down an Application Server
  • View applications currently in the system
  • End applications selectively
  • View application execution journals

 

Application Server Page Example

The following is an example of the Application Server window:

The Application Server page allows you to:

  • View the list of Application Servers (deployment targets) on the system
  • Display the Application Server Detail page to view a list of the applications that are currently running on the Application Server.

 

Procedure: Viewing the Application Server Status

To view the current status of the Application Server, click the Application Server link on the Administration Home page. Clicking the Application Server link displays the Application Server page.

Note: The procedure is available only in the master organization profile.

 

Procedure: Starting and Shutting Down the Application Server

To start or shut down the Application Server:

  1. Click the Application Server link on the Administration Home page. The Application Server List page is displayed.
  2. Click the link for the Application Server you want to start or shut down. The Application Server Detail page is displayed.
  3. Do one of the following:
    • To start the Application Server, click the Start button. (Note that the Start button is displayed only when the Application Server status is “Down.”)
    • To shut down the Application Server, click the Shutdown button. (Note that the Shutdown button is displayed only when the Application Server status is “Running.”

Administrators can also cancel the shutdown process by clicking the Cancel Shutdown button. (Note that the Cancel Shutdown button is displayed only when the Application Server status is Shutting Down.

Note: The procedure is available only in the master organization profile.

 

Procedure: Monitoring Applications

To monitor applications in the system:

  1. Click the Application Server link on the Administration Home page. The Application Server List page is displayed.
  2. Click the link for the Application Server for which you want to monitor applications. The Application Server Detail page is displayed listing all executed applications on that server and listing the current status for each.
  3. To end an application, select the checkbox and click the End button.

Note: The procedure is available only in the master organization profile.

 

Procedure: Setting Properties for Deployed Applications

To specify properties for a deployed application:

  1. Click the Application Server link on the Administration Home page. The Application Server List page is displayed.
  2. Click the link for the Application Server for which you want to view application execution journal files. The Application Server Detail page is displayed listing all executed applications on that server and listing the current status for each.
  3. Click the Deployed Applications link. The Deployed Application page is displayed.
  4. Click the Edit Properties link for the deployed application for which you want to modify application properties. The Edit Properties page is displayed where you can enable application execution journals (for top level applications) and other application properties.

Note: The procedure is available only in the master organization profile.

 

Procedure: Viewing Application Execution Journals

To view application execution journals in the system:

  1. Click the Application Server link on the Administration Home page. The Application Server List page is displayed.
  2. Click the link for the Application Server for which you want to view application execution journal files. The Application Server Detail page is displayed listing all executed applications on that server and listing the current status for each.
  3. Click the Application Execution Journal link. The Application Execution Journal page is displayed.
  4. Enter criteria for the journal file you want to view and click Search. Enter an asterisk (*) in the Application Name field to view all journal files. The list of matching journal files is displayed.
  5. To view a journal file, click the Raw Journal File link for the application. The Raw Journal File page is displayed showing the contents of the journal.

Note: The procedure is available only in the master organization profile.

 

Application Server List Page

This section provides definitions for fields on the Application Server List page.

 

Fields

Target Name

The name of the deployment target, the collection of servers used to deploy applications.

Server Name

The name of the server used in the deployment target. Click the Server Name link to edit the server.

Server URL

The URL defining the server (consisting of host name or IP and port).

Server JNDI Port

The port number where the Java Naming and Directory Interface (JNDI) service is running.

 

Application Server Detail Page

This section provides definitions for fields on the Application Server Detail page:

 

Fields

Check to Kill

Selecting this checkbox and clicking the End button allows you to end the application.

Application ID

The identifier for the instance of the application.

Version

The version number of the application. The version number is incremented each time you deploy a new copy of the application.

Application Name

The name of the application as created in StarPound Studio.

Status

The current status of the application.

Start

The date and time that the system initiated the application.

 

Operations

Refresh

This page includes a button to refresh the Application Server status.

End

This page includes a button to end the selected application.

Application Execution Journal

This page includes a button to view an application execution journal.

Deployed Applications

This page includes a button to edit the properties for a deployed application.

 

Application Execution Journal Page

This section provides definitions for fields on the Application Execution Journal page.

For more information on application execution journals, see the StarPound Studio User Guide.

 

Fields

Application Name

Select the application and click Search to view all journal files.

Start Time

The date and time that the system initiated the application. Format is "YYYY/MM/DD HH:MM:SS".

Version

The version number of the application. The version number is incremented each time you deploy a new copy of the application.

 

Operations

Raw Journal File

This page has a link to display the Raw Journal File.

Export Journal File

This page has a link to export the journal file as a zip archive. You can import the journal file into StarPound Studio to review using the visual application journal. See the StarPound Studio User Guide.

 

Raw Journal File Page

This section provides definitions for fields on the Raw Journal File page.

For more information on application execution journals, see the StarPound Java Programming Guide.

 

Fields

Journal File

The journal file contains a trace of the execution path of the application. Each task executed and each event is logged to the journal file.

 

Deployed Applications Page

This section provides definitions for fields on the Deployed Applications page:

 

Fields

Application Name

The name of the application as created in StarPound Studio.

Version

The version number of the application. The version number is incremented each time you deploy a new copy of the application.

 

Operations

Edit Properties

This page has a link to display the Edit Properties page.

Undeploy

This page has a link to display the Undeploy page.

 

Edit Properties Page

This section provides definitions for fields on the Edit Properties page:

 

Fields

Application Name

The name of the application as created in StarPound Studio.

Load on Start

Indicates whether to load the deployed application into memory and create an instance pool for the deployed application
when the Application Server is started.

Enable Execution Journal

Indicates whether to enable application execution journal for this deployed application.

Allow End User Authentication

Indicates whether to allow end user authentication for this deployed application.

Instance Pool Size

The number of instances of this deployed application to create in the initial application instance pool, and the number of instances to add to the instance pool when the Instance Pool Threshold value is reached.

Instance Pool Threshold

The minimum number of instances of this deployed application to keep in the application instance pool. When this
threshold value is reached, the system creates additional instances in the instance pool. The system adds the number of instances specified in the Instance Pool Size field.

 

Undeploy Page

This section provides definitions for fields on the Undeploy page:

 

Fields

Application Name

The name of the application as created in StarPound Studio.

Version

The version of the deployed application.

Check to Undeploy

Select the checkbox to indicate that the version of the application should be undeployed.

 

Call Recording Page

This section provides definitions for fields on the Call Recording page:

 
Media Queue

Select the media queue associated with the launching queue.

Agent ID

Agent extension.

ANI

Automatic number identification.

DNIS

Dialed number identification service.

Time From

Specifies the lower limit of time interval to search within.

Time To

Specifies the upper limit of time interval to search within.