N1 Grid Service Provisioning System User's Guide and Release Notes for the WebLogic 8 Plug-In 1.0

Chapter 4 Using the WebLogic 8 Plug-In

The WebLogic 8 plug-in provides several specific component types and provides easy access to functions that are useful for working with BEA WebLogic 8 applications. This chapter describes the following information:

Installing and Using the WebLogic 8 Environment with the N1 Grid Service Provisioning System

Plug-In Conventions

The provisioning system enables you to provision and manage applications.

Plans and Component Procedures

The WebLogic 8 plug-in provides both plans and component procedures as tools for you to perform tasks. By using plans, you link directly to the functionality you desire. Using component procedures, you have a greater number of tasks that you can perform.

Task Names

The WebLogic8 plug-in organizes tasks in four categories: application tasks, infrastructure tasks, configuration tasks, and advanced tasks. These task categories follow the same convention for describing the task that you need to perform.

Table 4–1 Common Task Names

Task Name 

Description  

View Installations, View Configurations, View Clusters, View Cluster Members 

View a list of where all components of a particular type are installed. 

View All 

View all components of a particular type within a specified folder. 

Create 

Links to the component Details page where you can add a new component of this type to the provisioning system. You can create new components by importing them from an existing WebLogic Admin Server or by browsing the file system. 

Start or Stop 

Links to the component Details page to run the Start or Stop component procedure. 

Install, Uninstall, Remove, Join, Leave 

Represents a plan that produces the described functionality. 

Global Prerequisites

Two prerequisites exist for each task documented in this book.

Process Overview

    Creating a WebLogic 8 environment within the provisioning system is similar to the process of creating the environment without the provisioning system.

  1. Import the WebLogic 8 plug-in.

    See Importing Plug-Ins in N1 Grid Service Provisioning System 5.0 System Administration Guide.

  2. Set the WebLogic session variables: WL_DEFAULT_PASSWORD and WL_DEFAULT_USER.

    See Chapter 5, Session Variables, in N1 Grid Service Provisioning System 5.0 Plan and Component Developer’s Guide.

  3. Prepare all hosts.

    The WebLogic 8 plug-in contains a new system service that must be distributed to all hosts in the provisioning system. See Preparing a Physical Host in N1 Grid Service Provisioning System 5.0 System Administration Guide.

  4. Install the WebLogic software.

    See How to Install the WebLogic Software

  5. Create a WebLogic domain by installing an Administrative Server.

    See How to Create a WebLogic 8 Domain and Administration Server.

  6. Create a Managed Server in the new WebLogic domain.

    See How to Create a WebLogic Managed Server.

  7. Create and Install the WebLogic license component.

    See How to Create a License Component and How to Install a License Component.

  8. (Optional) Create a WebLogic 8 cluster.

    See How to Create a WebLogic Cluster.

  9. (Optional) Add a cluster member by assigning existing Managed Servers to the cluster.

    See How to Create Cluster Members.

  10. If necessary, configure the application's connection to the database.

    1. Configure a connection pool.

      See Connection Pool Component Type.

    2. (Optional) Configure a Multi Pool.

      See Multi Pool Component Type.

    3. Configure a data source or transactional data source.

      See Data Source and Transaction Data Source Component Types.

  11. If the application uses Java Messaging Service, configure the JMS server.

    See JMS Server Component Type.

  12. Capture application files (EARs, JARs, and WARs).

    See Capturing and Editing WebLogic Applications.

  13. Deploy applications to targets hosts, host sets, or clusters.

    An application can target either a cluster or a Managed Server.

    See Installing an Enterprise Application, Installing a Web Application, or Installing a JAR or EJB File.

Creating the WebLogic Infrastructure

Use the WebLogic 8 Common Tasks page as a starting point to create and manage WebLogic servers and clusters.

ProcedureHow to Create a WebLogic 8 Domain and Administration Server

You need to create a domain and Administration Server before you can set up Managed Servers to host your applications. A domain is a set of WebLogic servers that is managed by an Administration Server. All information about the domain is contained in a configuration file that is stored on the Administration Server.

When you create a new domain by installing the AdminServer component, you also:

You can use this procedure to create a new domain or you can use this procedure to register an existing domain within the provisioning system by selecting the markOnly option.


Note –

In this document, two similar terms are used: AdminServer and Administration Server. The prepackaged N1 Grid Service Provisioning System WebLogic 8 component is called the AdminServer component. AdminServer represents the provisioning system component and Administration Server represents the installed application running in the WebLogic 8 environment.


Before You Begin

To create a WebLogic 8 domain, you must belong to a user group that has the Run Component Procedures permission on the folder that contains the component. You must also have the Allow on Host Set permission for the host set on which you plan to deploy the component.

Steps
  1. Verify that your WebLogic session variables, WL_DEFAULT_USER and WL_DEFAULT_PASSWORD, are set.

    WebLogic session variables must be seven characters long and include a number.

    For more information about session variables, see Chapter 5, Session Variables, in N1 Grid Service Provisioning System 5.0 Plan and Component Developer’s Guide.

  2. In the Common Tasks section in the browser interface, click WebLogic 8.

  3. Click the Domain Management: Create link.

    The plan's Details page displays.

  4. Click Run.

    The Run page displays.

  5. In the Plan Parameters area, select the variable settings for the AdminServer component that you plan to deploy.

    • If the variable settings have been established for this component, select the appropriate settings from the menu.

    • If the settings are not available from the menu, click Select From List.

      The Select Variable Settings From List window displays.

      • To create a new set of variable settings, select Create Set.

        The following list provides commonly updated variables for the AdminServer component.

        domainName

        Required. The WebLogic domain name.

        adminPort

        Required. The default TCP port for the AdminServer virtual host to use.

        Before the domain is created, a check is performed to verify that this port is available.

        secureConnect

        Optional. True specifies that the SSL port can be used to connect the Administration Server.

        production

        Required. This variable determines whether the managed server is run in production mode. The default value of production is false. This variable can be set to true or false.

        Variables that are updated less often include configuration variables such as the following:

        adminManagedServer

        Required. The name of the managed server that hosts the domain administration console. The default value is myserver. If performing a markOnly install, set the variable to the server name used during the WebLogic install.

        targetRefName

        Required. This variable becomes the name of the domain's virtual host. The substitution variable is based on the values for the host name and for the domain name. This variable follows the format :[target:sys.hostName]_weblogic_admin_ :[domainName]. For example, sqa-420_weblogic_admin_wls.

      • To use variable components from another component, click Import Set.

        For more information about importing variable sets, see How to Run a Plan in N1 Grid Service Provisioning System 5.0 Operation and Provisioning Guide.

  6. Select the target host.

    Target the virtual host that was created when you installed the WebLogic software. See How to Install the WebLogic Software procedure.


    Note –

    The target host must be a member of the com.sun.weblogic#InstallHS host set.


  7. Deselect the Target Host Set checkbox.

  8. If you are capturing an existing WebLogic domain within the provisioning system, select the markOnly option.

  9. Click Run Plan (Includes Preflight).

ProcedureHow to Create Multiple Domains with Different Passwords

You can create multiple domains using the same user and password. However, if you prefer to have separate passwords for each of your domains, you need to update your WebLogic user and password session variables after each domain installation.

The plan that creates new domains always uses the default session variable names, WL_DEFAULT_USER and WL_DEFAULT_PASSWORD.

Steps
  1. Install the new domain and AdminServer using the default WebLogic session variables, WL_DEFAULT_USER and WL_DEFAULT_PASSWORD.

    See How to Create a WebLogic 8 Domain and Administration Server.

  2. Go to the Session Variables page by clicking Session Variables at the top of the browser interface.

  3. Create new session variables for the newly installed AdminServer.

    These new session variables have the same value as the default variables with which you installed the AdminServer.

    Attribute Name  

    Default Session Variable Names 

    New Session Variable Names 

    adminUser

    WL_DEFAULT_USER

    WL_TEST_USR

    adminPassword

    WL_DEFAULT_PASSWORD

    WL_TEST_PWD

  4. Go to the host Details page for the AdminServer you created in step 1 and click Edit.

  5. Update the AdminServer's host type attributes.

    For example, replace the adminUser value with :[session:WL_TEST_USR].

  6. If you have another domain to install, return to the Session Variables page and update the default WebLogic session variables with the new values to be used for the next domain you plan to install.

ProcedureHow to Create a WebLogic Managed Server

You can run multiple Managed Servers in each domain to host your applications. WebLogic Managed Servers are captured and represented in the provisioning system by Server components. Throughout this book, Server refers to the provisioning system component, while Managed Server refers to the installed instance of the Managed Server running in the WebLogic 8 environment.

You can use this procedure to create a new Managed Server or you can use this procedure to register an existing Managed Server within the provisioning system by selecting the markOnly option.


Note –

If you plan to create a cluster, you need to create the Managed Servers that belong to that cluster before you create the cluster.


Before You Begin

Before you can create a WebLogic Managed Server, the following criteria must be met.

Steps
  1. In the Common Tasks section in the browser interface, click WebLogic 8.

  2. Click the Application Server Management: Create link.

    The plan's Details page displays.

  3. Click Run.

    The Run page displays.

  4. In the Plan Parameters area, select the variable settings for the ManagedServer component that you plan to deploy.

    The Server component represents the Managed Server instance within the WebLogic 8 environment.

    • If the variable settings have been established for this component, select the appropriate settings from the menu.

    • If the settings are not available from the menu, click Select From List.

      The Select Variable Settings From List window displays.

      • To create a new set of variable settings, select Create Set.

        The following list provides commonly updated variables for the ManagedServer component.

        variable set name

        Required. A name for the new variable set you create

        adminServerHostName

        Required. Name of the AdminServer virtual host that hosts the new Managed Server. This value will be in the format remoteAgentName_weblogic_admin_domainName.

        You can find the virtual host on the Hosts page. The virtual host will be of type com.sun.weblogic8#AdminServerHS.

        targetName

        Required. The new Managed Server's name. This name is used in the targetRefName variable to create the Managed Server virtual host.

        startupScriptName

        Required. The name of the Managed Server's startup script.

        The default location of the startup script is /usr/local/bea/user_projects/servers/ domainName/targetName. This location can be changed by setting the altServerRoot component variable.

        serverPort

        Required if not using SSL. The default value for this variable is 7010. If this port is not available, the Managed Server does not start and an error message displays. After you free the port, you can start the Managed Server by running the Start component procedure on the Managed Server's component Details page.

        serverSslPort

        Required if using SSL. The default value for this variable is 7020. This port must be available, otherwise the Managed Server does not start and an error message displays. After you free the port, you can start the Managed Server by running the Start component procedure on the Managed Server's component Details page.

        production

        Required. This variable determines whether the managed server is run in production mode. The default value of production is false. This variable can be set to true or false.

      • To use variable components from another component, click Import Set.

        For more information about importing variable sets, see How to Run a Plan in N1 Grid Service Provisioning System 5.0 Operation and Provisioning Guide.

  5. Select the target host or target host set.

    The Managed Server resides on the Remote Agent that you target.


    Note –

    The target host must be a member of the com.sun.weblogic#AdminServer host set.


  6. Deselect the Target Host Set checkbox.

  7. If you are capturing an existing WebLogic Managed Server within the provisioning system, select the markOnly option.

  8. Click Run Plan (Includes Preflight).

ProcedureHow to Create a License Component

This procedure provides the steps on how to create a license component. After the license component is created, see How to Install a License Component to install the license.

Steps
  1. In the Common Tasks section in the browser interface, click WebLogic 8.

  2. Click the License Management: Create link.

    The component's Edit page displays.

  3. Type the name of the new license component.

  4. (Optional) Type the components label and description.

  5. Select a host that has a copy of the BEA license on its file system.

  6. Navigate through the host's file system and select the license file.

  7. Click Check In Selected Item.

    The component's Check In page displays.

  8. Choose a folder on which you have edit permissions.

  9. Click Continue to Check In.

ProcedureHow to Install a License Component

Before You Begin

Before you can install a license component, one must exist within the provisioning system. See How to Create a License Component.

Steps
  1. In the Common Tasks section in the browser interface, click WebLogic 8.

  2. Click the License Management: View All link.

    The Components page displays.

  3. In the row of the license component that you plan to install, click Details.

    The component's Details page displays.

  4. In the Component Procedures table, select the Default: Install procedure and click Run.

    The plan's Run page displays.

  5. Select the target host.

    You target the AdminServer virtual host.


    Note –

    You do not need to modify the component variables for license installation.


  6. (Optional) If you want to replace an existing license, in the Plan Variables section, select the Replace Rather Than Merge With Existing License option.


    Note –

    If you choose to replace an existing license, you need to restart the WebLogic domain for the new license to take effect.


  7. Click Run Plan (Includes Preflight).

ProcedureHow to Create a WebLogic Cluster

You might need to create a cluster for the following reasons:

A cluster appears to clients as a single WebLogic Managed Server instance. The server instances that constitute a cluster can run on the same machine, or can be located on different machines. Each cluster member in a cluster must run the same version of WebLogic.

You can use this procedure to create a new cluster or you can use this procedure to register an existing cluster within the provisioning system by selecting the markOnly option.

Before You Begin

Before you create a WebLogic cluster, you must create a WebLogic domain, an Administration Server, and the Managed Servers that you plan to use in the cluster.

To create a WebLogic cluster, you must belong to a user group that has the Run Component Procedures permission on the folder that contains the component. You must also have the Allow on Host Set permission for the host set on which you plan to deploy the component.

Steps
  1. In the Common Tasks section in the browser interface, click WebLogic 8.

  2. Click the Cluster Management: Create link.

    The plan's Details page displays.

  3. Click Run.

    The Run page displays.

  4. In the Plan Parameters area, select the variable settings for the Cluster component that you plan to deploy.

    • If the variable settings have been established for this component, select the appropriate settings from the menu.

    • If the settings are not available from the menu, click Select From List.

      The Select Variable Settings From List window displays.

      • To create a new set of variable settings, select Create Set.

        The following list provides commonly updated variables for the ManagedServer component.

        variable set name

        Required. A name for the new variable set you create

        targetName

        Required. The name of the new cluster.

        clusterAddress

        Optional. This variable can be a DNS host name that maps to multiple IP addresses or a comma-separated list of single address host names or IP addresses. No value is necessary for this variable.

        multicastAddress

        This variable provides the address that cluster members can use to communicate with each other.

      • To use variable components from another component, click Import Set.

        For more information about importing variable sets, see How to Run a Plan in N1 Grid Service Provisioning System 5.0 Operation and Provisioning Guide.

  5. Select the target host.

    Because you can only install a cluster on an Administrative Server, the target host is the AdminServer virtual host.

  6. Deselect the Target Host Set checkbox.

  7. If you are capturing an existing WebLogic cluster within the provisioning system, select the markOnly option.

  8. Click Run Plan (Includes Preflight).

ProcedureHow to Create Cluster Members

Cluster nodes are Managed Servers assigned to a cluster. You will want to create cluster members to make your applications highly available and scalable.

When a Managed Server joins the cluster, the applications that are currently targeted to the Managed Server continue to target that server, the application deployment state is preserved. The plan that creates the cluster members automatically stops the Managed Server to add it to the cluster. After the Managed Server is added, the plan restarts the Managed Server.

You can use this procedure to create a new cluster member or you can use this procedure to register an existing cluster member within the provisioning system by selecting the markOnly option.

Before You Begin

Before you can create cluster members, the following requirements must be met.

To create a cluster member, you must belong to a user group that has the Run Component Procedures permission on the folder that contains the component. You must also have the Allow on Host Set permission for the host set on which you plan to deploy the component.

Steps
  1. In the Common Tasks section in the browser interface, click WebLogic 8.

  2. Click the Cluster Member Management: Join link.

    The plan's Details page displays.

  3. Click Run.

    The plan's Run page displays.

  4. Choose the Managed Server that you want to add to the cluster.

    • Select the Target Host by typing the Managed Server's name or selecting it from a list.


      Note –

      The Target Host Set option is automatically selected. If you select a single Managed Server, deselect the Target Host Set checkbox.


    • Select the Target Host Set from the menu.

  5. Verify that the plan variable WebLogic Cluster Name contains the correct cluster name.

  6. To specify how long the provisioning system waits before verifying that the server was restarted, type the number of seconds in the Seconds to Wait Before Failing Verify Step field.

  7. If you are capturing an existing WebLogic cluster member within the provisioning system, select the markOnly option.

  8. Click Run Plan (Includes Preflight).

Managing WebLogic Domains, Servers, and Clusters

This section describes the tasks that are commonly performed with WebLogic servers and clusters after they have been installed.

Domains and Administrative Servers

Clusters

Managed Servers

Managing WebLogic Domains and Administration Servers

This section contains procedures for managing WebLogic Domains and Administration Servers.

ProcedureHow to Remove a WebLogic Domain and Administration Server

By removing a WebLogic domain through the provisioning system, you automatically perform the following tasks.


Note –

The WebLogic virtual hosts cannot contain components that do not belong to the plug-in. To successfully remove the WebLogic domain, all components that do not belong to the plug-in must be removed before running the domain uninstall plan.


Before You Begin

To remove a WebLogic domain, you must belong to a user group that has the Run Component Procedures permission on the folder that contains the component. You must also have the Allow on Host Set permission for the host set on which you plan to deploy the component.

Steps
  1. In the Common Tasks section in the browser interface, click WebLogic 8.

  2. Click the Domain Management: Remove link.

    The plan's Details page displays.

  3. Click Run.

    The plan's Run page displays.

  4. Select the target host.

    Target the virtual host that was created when you installed the WebLogic software. See How to Install the WebLogic Software procedure.


    Note –

    The target host must be a member of the com.sun.weblogic#InstallHS host set.


  5. Type the name of the WebLogic domain, in the WebLogic Domain Name field.

  6. If you want to remove the WebLogic domain, Administration Server, clusters, and Managed Server from the provisioning system and plan to keep the domain running in the WebLogic environment, select the markOnly option.

  7. Click Run Plan (Includes Preflight).

Managing WebLogic Clusters

The following section describes how to start, stop, and remove clusters.

ProcedureHow to Start or Stop Clusters

When you start or stop a cluster, you start or stop all cluster members within the cluster.


Note –

All cluster members must be in the same state to use this feature.


Steps
  1. In the Common Tasks section in the browser interface, click WebLogic 8.

  2. Click the Cluster Management: Start or Stop link.

    The component Details page displays.

  3. In the Component Procedures list, select the row containing the Start or Stop procedure and click Run.

    The plan's Run page displays.

  4. Select the cluster that you plan to start or stop.

    The cluster name is a part of the installPath.

  5. Click Run Selected Installations.

    The plan's Run page displays.

  6. Click Run Plan (Includes Preflight).

ProcedureHow to Remove a WebLogic Cluster

When you remove a cluster, all cluster members associated with that cluster are also removed. .

For more information about the behavior of cluster members returning to the role of Managed Servers, see How to Remove a WebLogic Cluster Member.


Note –

When the Managed Servers are removed from the cluster, they are stopped. If you plan to continue using the Managed Server, you must restart it. See How to Start a Managed Server


Before You Begin

To remove a cluster, you must belong to a user group that has the Run Component Procedures permission on the folder that contains the component. You must also have the Allow on Host Set permission for the host set on which you plan to deploy the component.

Steps
  1. In the Common Tasks section in the browser interface, click WebLogic 8.

  2. Click the Cluster Management: Remove link.

    The plan's Details page displays.

  3. Click Run.

    The plan's Run page displays.

  4. In the Target Host field, select the domain that hosts the cluster.

  5. Deselect the Target Host Set checkbox.

  6. In the WebLogic Cluster Name field of the Plan Variables section, type the cluster name that would display in the WebLogic interface.

  7. Select the markOnly option if you want to remove the WebLogic Cluster from the provisioning system but plan to keep the cluster running in the WebLogic environment.

  8. Click Run Plan (Includes Preflight).

ProcedureHow to Remove a WebLogic Cluster Member

When you remove a cluster member, the cluster member component is removed from the Managed Server and the Managed Server that acted as the cluster member returns to its original state. Applications that were targeted to the cluster, and therefore cluster members, are no longer hosted by the Managed Server after it is restarted. Applications targeted directly to the Managed Server continue to target the Managed Server.

When a Managed Server is removed from a cluster, the Managed Server is left in a stopped state. If you plan to continue using the Managed Server, you must restart it. See How to Start a Managed Server.

Before You Begin

To remove a cluster member, you must belong to a user group that has the Run Component Procedures permission on the folder that contains the component. You must also have the Allow on Host Set permission for the host set on which you plan to deploy the component.

Steps
  1. In the Common Tasks section in the browser interface, click WebLogic 8.

  2. Click the Clusters Member Management: Leave link.

    The plan's Details page displays.

  3. Click Run.

    The plan's Run page displays.

  4. Choose the Managed Server that you plan to remove.

  5. Deselect the Target Host Set checkbox.

  6. If you want to remove the WebLogic cluster member from the provisioning system but plan to keep the cluster member running in the WebLogic environment, select the markOnly option.

  7. Click Run Plan (Includes Preflight).

Managing WebLogic Managed Servers

ProcedureHow to Start a Managed Server

Before You Begin

To start a Managed Server, you must belong to a user group that has the Run Component Procedures permission on the folder that contains the component. You must also have the Allow on Host Set permission for the host set on which you plan to deploy the component.

Steps
  1. In the Common Tasks section in the browser interface, click WebLogic 8.

  2. Click the Application Server Management: Start link.

    The component Details page displays.

  3. In the Component Procedures list, select the row containing the Start procedure and click Run.

    The plan's Run page displays.

  4. Select the Managed Server that you need to start.

    Managed Servers follow the format host (install-path), where host represents the name of the physical host and install-path represents the name of the managed server. The managed server name displays as server_wls_managedServerName, for example, server_wls_Server-One

  5. Click Run Selected Installations.

    The plan's Run page displays.

  6. Set the Plan Variables.

    1. (Optional) To override the standard memory arguments passed to Java, type the name in the VmArgs field.

      The format used for the vmArgs field is virtualMachineName. For example, -Xms32m -Xmx200m.

    2. To specify how long the provisioning system waits before verifying that the server started, type the number of seconds in the Seconds to Wait Before Failing Verify Step field.

  7. Click Run Plan (Includes Preflight).

ProcedureHow to Stop a Managed Server

Before You Begin

To stop a Managed Server, you must belong to a user group that has the Run Component Procedures permission on the folder that contains the component. You must also have the Allow on Host Set permission for the host set on which you plan to deploy the component.

Steps
  1. In the Common Tasks section in the browser interface, click WebLogic 8.

  2. Click the Application Server Management: Stop link.

    The component Details page displays.

  3. In the Component Procedures list, select row containing the Stop procedure and click Run.

    The plan's Run page displays.

  4. Select the Managed Server that you need to start.

    Managed Servers follow the format host (install path), where host represents the name of the physical host and install path represents the name of the managed server. The managed server name displays as server_domainName_managedServerName. For example, server_wls_Server-One.

  5. Click Run Selected Installations.

    The plan's Run page displays.

  6. Click Run Plan (Includes Preflight).

ProcedureHow to Remove a Managed Server

Steps
  1. In the Common Tasks section in the browser interface, click WebLogic 8.

  2. Click the Application Server Management: Remove link.

    The plan's Details page displays.

  3. Click Run.

    The plan's Run page displays.

  4. Select the Managed Server that you plan to remove.

  5. Modify the plan variables if necessary.

    1. Type the name of the WebLogic Managed Server.

    2. Type the name of the WebLogic domain that the Managed Server is registered with.

    3. If you want to remove the WebLogic Managed Server from the provisioning system but want to keep the Managed Server running in the WebLogic environment, select the markOnly option.

  6. Click Run Plan (Includes Preflight).

Capturing and Editing WebLogic Applications

The WebLogic Common Tasks page enables you to capture, configure, and deploy WebLogic Enterprise, EJB technology, and Web Applications.

You can perform several specific tasks, as described in the following sections:


Note –

Do not deploy or manage your WebLogic applications outside of the N1 Grid Service Provisioning System. If you use the provisioning software, you must manage your WebLogic applications exclusively with the provisioning software.


ProcedureHow to Capture a WebLogic Enterprise Application or EAR File

Steps
  1. In the Common Tasks section in the browser interface, click WebLogic.

  2. Click the Enterprise Applications (EAR): Create link.

  3. Type a label for this component.

  4. Type a description for this component.

  5. Choose how you plan to import the application.

    For more information, see Browsing for an Enterprise Application.

    • If you are importing from the AdminServer, select WebLogic Admin Server and choose the WebLogic Admin Server from which you plan to import the EAR file.

    • If you are importing from a file system, select File System and choose the host from which you plan to import the EAR file.

  6. Navigate through the hierarchy to find the enterprise application to capture.

  7. Click Check-in Selected Item.

  8. Confirm the information on the check-in page, then click Continue to Check-in.

ProcedureHow to Capture a WebLogic Web Application or WAR File

Steps
  1. In the Common Tasks section in the browser interface, click WebLogic.

  2. Click Create in the Web Applications (WAR) section of the WebLogic Common Tasks page.

  3. Type a label for this component.

  4. Type a description for this component.

  5. Choose how you plan to import the application.

    For more information, see Browsing for a Web Application.

    • If you are importing from the AdminServer, select WebLogic Admin Server and choose the WebLogic Admin Server from which you plan to import the WAR file.

    • If you are importing from a file system, select File System and choose the host from which you plan to import the WAR file.

  6. Navigate through the hierarchy to find the web application to capture.

  7. Click Check-in Selected Item.

  8. Confirm the information on the check-in page, then click Continue to Check-in.

ProcedureHow to Capture a WebLogic JAR File

Steps
  1. In the Common Tasks section in the browser interface, click WebLogic.

  2. Click Create in the Java Archives Containing EJBs (JAR) section of the WebLogic Common Tasks page.

  3. Type a label for this component.

  4. Type a description for this component.

  5. Choose how you plan to import the JAR file.

    For more information, see Browsing for a JAR or EJB File.

    • If you are importing from the AdminServer, select WebLogic Admin Server and choose the WebLogic Admin Server from which you plan to import the JAR file.

    • If you are importing from a file system, select File System and choose the host from which you plan to import the JAR file.

  6. Navigate through the hierarchy to find the JAR file to capture.

  7. Click Check-in Selected Item.

  8. Confirm the information on the check-in page, then click Continue to Check-in.

Using Component Types to Deploy WebLogic Applications

The WebLogic 8 Plug-In includes several WebLogic-specific component types. These component types enable you to quickly model many of the most common WebLogic application components and to automatically associate install, uninstall, export, and snapshot behavior with a particular resource. Many of the component types are used by the software when you create and manage servers and clusters. As a result, you will only work with a few component types on a regular basis.

However, based on the needs of your application, you might need to configure the WebLogic services before you can deploy the application components. To configure the services, you might need to rely on the component types that are described in the following sections:

These configuration component types are only necessary if your application requires them. For example, if your web application uses a database to retrieve and store information, you will need to configure a connection pool and data source or transactional data source.

To use these configuration component types, select the task that you want to perform and run the associated component procedure. If you need to create and check-in a new component based on an existing component elsewhere on your file system, click Create. After checking in the new component, you can run the appropriate component procedure to configure the WebLogic environment according to your application's needs.

You usually configure and deploy these configuration component types before deploying your application. However, you can configure the WebLogic environment after the application components have been deployed by restarting the application after configuration is complete. Redeploy the application to restart it.

For more information about configuring these configuration objects, see BEA's Administration Console Online Help.

Enterprise Application (EAR) Component Type

A component of this type models an enterprise application. The component can contain either an enterprise application archive (EAR) or the expanded version of an EAR as a package.

Browsing for an Enterprise Application

You can use one of the following browsers to select your enterprise application for this component type:

Installing an Enterprise Application

To install an enterprise application component, you must use a WebLogic Managed Server or cluster as the target host. The installation process performs three main tasks:

  1. Installs the EAR file on the target.

  2. Registers the EAR with the WebLogic Administration Server.

  3. Applies any properties previously captured during domain browse.

You can install the enterprise application by navigating to the application's component Details page and running the Install component procedure.

Uninstalling an Enterprise Application

When you uninstall an enterprise application component, the enterprise application no longer targets the virtual host. If the enterprise application is not targeted elsewhere, the registration component is removed from the Administration Server.

You can uninstall the enterprise application by navigating to the application's component Details page and running the Uninstall component procedure.

Error Conditions

Table 4–2 WebLogic Enterprise Application Error Conditions

Action 

Condition 

Result 

Install 

The topology is incorrectly configured (target host does not point at correct domain host) 

Targeting fails 

Install 

The target host is not a valid WebLogic target 

Installation prohibited 

Browsing/Install/Uninstall 

Credentials are not properly configured 

Operation fails 

Browsing 

Path not correctly configured in domain host 

Browsing fails 

Web Application (WAR) Component Type

A component of this type includes a web application. The component can contain either a web application and its relevant settings or the web application without its settings.

Browsing for a Web Application

You can use one of the following browsers to select your web application for this component type:

Installing a Web Application

To install a web application component, you must use a WebLogic Managed Server or cluster as the target host. The installation process will install the component on that target, and install the contained registration component on the Administration Server of the target.

You can install the web application by navigating to the application's component Details page and running the Install component procedure.

Uninstalling a Web Application

When you uninstall a web application component, the web application no longer targets the virtual host. If the web application is not targeted elsewhere, the registration component is removed from the Administration Server.

You can uninstall the web application by navigating to the application's component Details page and running the Uninstall component procedure.

Error Conditions

Table 4–3 WebLogic Web Application Error Conditions

Action 

Condition 

Result 

Install 

The topology is incorrectly configured (target host doesn't point at correct domain host) 

Targeting fails. 

Install 

The target host is not a valid WL target. 

Installation prohibited. 

Browsing/Install/Uninstall 

Credentials aren't properly configured. 

Operation fails. 

Browsing 

Path not correctly configured in domain host. 

Browsing fails. 

Java Archive Files Containing EJBs Component Type

Browsing for a JAR or EJB File

You can use one of the following browsers to select your EJB or JAR files for this component type:

Installing a JAR or EJB File

When you install a component of this type, the file or directory is copied to the file system based on the install path. Once that copy finishes, the file or directory is registered with the WebLogic Administration Server.

You can install the JAR or EJB file by navigating to the application's component Details page and running the Install component procedure.

Uninstalling a JAR or EJB File

When you uninstall a component of this type, the file or directory is removed from the master server.

You can uninstall the JAR or EJB file by navigating to the component Details page and running the Uninstall component procedure.

Error Conditions

Table 4–4 WebLogic EJB container Error Conditions

Action 

Condition 

Result 

Uninstall 

A dependant WebLogic EJB is still installed. 

Uninstall fails indicating the dependency. 

Data Source and Transaction Data Source Component Types

Browsing for a Data Source or Transaction Data Source

You can use a WebLogic Administration Server browser from which you can select the data source or transaction data source and its relevant settings. The Administration Server browser provides an alphabetical list of applications on the Administration Server.

The WebLogic plug-in also includes a default data source and transaction data source, which eliminates the need for browsing. You can find the default components in the /com/sun/webLogic8 folder or by selecting View All from the Common Tasks page. The default components can then be installed through the component Details page using the Default: Install component procedure. The default components are named as follows:

Installing a Data Source or Transaction Data Source

When you install a component of this type, the file or directory is copied to the file system based on the install path. Once that copy finishes, the file or directory is registered with the WebLogic Administration Server.

You can install the data source or transaction data source by navigating to the component Details page and running the Install component procedure.

You must edit the following variables before installing the data source or transaction data source:

Uninstalling a Data Source or Transaction Data Source

When you uninstall a component of this type, the file or directory is removed from the master server.

You can uninstall the data source or transaction data source by navigating to the component Details page and running the Uninstall component procedure.

Connection Pool Component Type

Browsing for a Connection Pool

You can use a WebLogic Administration Server browser from which you can select a connection pool and its relevant settings. The Administration Server browser provides an alphabetical list of applications on the Administration Server.

The WebLogic plug-in also includes a default connection pool component called WLJDBCConnectionPoolConfig. This default component eliminates the need for browsing. You can find the default component in the /com/sun/webLogic8 folder or by selecting View All from the Common Tasks page. The default component can then be installed through the component Details page using the Default: Install component procedure.

Installing a Connection Pool

When you install a component of this type, the file or directory is copied to the file system based on the install path. Once that copy finishes, the file or directory is registered with the WebLogic Administration Server.

You can install the connection pool by navigating to the component Details page and running the Install component procedure.

You must edit the following variables before installing the connection pool:

Uninstalling a Connection Pool

When you uninstall a component of this type, the file or directory is removed from the Master Server.

You can uninstall the connection pool by navigating to the component Details page and running the Uninstall component procedure.

Multi Pool Component Type

Browsing for a Multi Pool

You can use a WebLogic Administration Server browser from which you can select a Multi Pool and its relevant settings. The Administration Server browser provides an alphabetical list of applications on the Administration Server.

The WebLogic plug-in also includes a default connection pool component called WLJDBCMultiPoolConfig. This default component eliminates the need for browsing. You can find the default component in the /com/sun/webLogic8 folder or by selecting View All from the Common Tasks page. The default component can then be installed through the component Details page using the Default: Install component procedure.

Installing a Multi Pool

When you install a component of this type, the file or directory is copied to the file system based on the install path. Once that copy finishes, the file or directory is registered with the WebLogic Administration Server.

You can install the multi pool by navigating to the component Details page and running the Install component procedure.

You must edit the following variables before installing the multi pool:

Uninstalling a Multi Pool

When you uninstall a component of this type, the file or directory is removed from the Master Server.

You can uninstall the Multi Pool by navigating to the component Details page and running the Uninstall component procedure.

Thread Pool Component Type

Configuring the Thread Pool

When you install a component of this type, the file or directory is copied to the file system based on the install path. Once that copy finishes, the file or directory is registered with the WebLogic Administration Server.

You can install the thread pool by navigating to the component Details page and running the Install component procedure.

You can edit the plan parameter variable settings.

Uninstalling a Thread Pool

When you uninstall a component of this type, the file or directory is removed from the Master Server.

You can uninstall the thread pool by navigating to the component Details page and running the Uninstall component procedure.

Transaction Service Component Type

Configuring the Transaction Service

When you install a component of this type, the file or directory is copied to the file system based on the install path. Once that copy finishes, the file or directory is registered with the WebLogic Administration Server.

You can install the transaction service by navigating to the component Details page and running the Install component procedure.

You can edit the plan parameter variable settings.

Uninstalling a Transaction Service

When you uninstall a component of this type, the file or directory is removed from the Master Server.

You can uninstall the transaction service by navigating to the component Details page and running the Uninstall component procedure.

JMS Server Component Type

Browsing for a JMS Server

You can use a WebLogic Administration Server browser from which you can select a JMS Server and its relevant settings. The Administration Server browser provides an alphabetical list of applications on the Administration Server.

The WebLogic plug-in also includes a default connection pool component called WLJMSServerConfig. This default component eliminates the need for browsing. You can find the default component in the /com/sun/webLogic8 folder or by selecting View All from the Common Tasks page. The default component can then be installed through the component Details page using the Default: Install component procedure.

Installing a JMS Server

When you install a component of this type, the file or directory is copied to the file system based on the install path. Once that copy finishes, the file or directory is registered with the WebLogic Administration Server.

You can install the JMS Server by navigating to the component Details page and running the Install component procedure.

You must edit the JMS Server name variable before installing the JMS Server.

Uninstalling a JMS Server

When you uninstall a component of this type, the file or directory is removed from the Master Server.

You can uninstall the JMS Server by navigating to the component Details page and running the Uninstall component procedure.

Mail Session Component Type

Browsing for a Mail Session

You can use a WebLogic Administration Server browser from which you can select a mail session and its relevant settings. The Administration Server browser provides an alphabetical list of applications on the Administration Server.

Installing a Mail Session

When you install a component of this type, the file or directory is copied to the file system based on the install path. Once that copy finishes, the file or directory is registered with the WebLogic Administration Server.

You can install the mail session by navigating to the component Details page and running the Install component procedure.

You must edit the following variables before installing the mail session:

Uninstalling a Mail Session

When you uninstall a component of this type, the file or directory is removed from the Master Server.

You can uninstall the mail session by navigating to the component Details page and running the Uninstall component procedure.

Using the CLI to Work With WebLogic

When you work with WebLogic through the provisioning system, you can use two command lines: the N1 Grid Service Provisioning System command line and the WebLogic command line.

Using the N1 Grid Service Provisioning System Command-Line Interface

By default, the provisioning system's command-line interface is located in the following directory: /opt/SUNWn1sps/N1_Grid_Service_Provisioning_system_5.0/cli/bin/cr_cli

BEA WebLogic 8 plug-in objects are located in the /com/sun/weblogic8 folder.

You can interact with plug-in components and plans much like any other custom component or plan. However, if you want to make changes to the components or plans, you need to save the component or plan to a new folder and make your changes there. For more information about using the provisioning system's command-line interface, see Chapter 1, Using the Command-Line Interface, in N1 Grid Service Provisioning System 5.0 Command-Line Interface Reference Manual

Using the WebLogic Command-Line Interface

The WebLogic command line is accessible through the WebLogic 8 Common Task page. For more information about the WebLogic 8 command-line interface, see the WebLogic Server Command Reference on BEA's web site.

ProcedureHow to Use the WebLogic Command-Line Interface Through the N1 Grid Service Provisioning System

You can run WebLogic commands on any Administration Server or Managed Server.

Steps
  1. In the Common Tasks section in the browser interface, click WebLogic 8.

  2. Select whether you plan to run the command on an Administration Server or a Managed Server.

    • If you plan to run commands on an Administration Server, click Domain Management: Start.

    • If you plan to run commands on a Managed Server, click Application Server Management: Start.

    The component Details page displays

  3. Select the Run-cli component procedure and click Run.

    The plan's Run page displays.

  4. Select the AdminServer virtual host or Managed Server virtual host on which to run the CLI and click Run Selected Installations.

  5. Type the needed information in the plan variable fields.

    Many of the plan variables do not require information and can be left blank. The following list describes the optional variables.

    The SSL arguments for the command

    This variable can be safely ignored if you do not connect to the server using SSL.

    The name of the user who must have appropriate permission to view or modify the target of the command

    This is the user name variable. The user name and password variables are mutually exclusive with the user-configuration file and key file variables. Supply either the user name and password or the user-configuration file and key file locations.

    The password that is associated with the username

    This is the password variable. The user name and password variables are mutually exclusive with the user-configuration file and key file variables. Supply either the user name and password or the user-configuration file and key file locations.

    The name and location of a user-configuration file, which contains an encrypted username and password

    This is the user-configuration file variable. The user name and password variables are mutually exclusive with the user-configuration file and key file variables. Supply either the user name and password or the user-configuration file and key file locations.

    The name and location of the key file

    This is the key file variable. The user name and password variables are mutually exclusive with the user-configuration file and key file variables. Supply either the user name and password or the user-configuration file and key file locations.

  6. Click Run Plan (Includes Preflight).


Example 4–1 Using the Command-Line Interface

This example uses the WebLogic FORCESHUTDOWN command to illustrate input for each Run-cli plan variable.

Weblogic CLI to run (weblogic.Admin or weblogic.Deployer):  

weblogic.Admin 

The SSL arguments for the command: 

 

The listen address of the server instance that runs the command: 

sun03 

This is the name of the AdminServer.

The listen port of the server instance that runs the command: 

7001 

The name of the user who must have appropriate permission to view or modify the target of the command: 

admin 

The password that is associated with the username: 

xxxxx 

The name and location of a user-configuration file, which contains an encrypted username and password: 

 

the name and location of the key file:  

 

The name of the command to run: 

FORCESHUTDOWN 

Arguments of the command: 

Server-one 


Using the WebLogic Server Scripting Tool Within the N1 Grid Service Provisioning System

You can use the WebLogic Server Scripting Tool (WLST) from the provisioning system's browser interface. For information on how to perform administrative tasks and configuration changes using the WLST, see BEA's WebLogic Server Using the WebLogic Server Scripting Tool document.

ProcedureHow to Create a WebLogic Script Component

You must first create the WebLogic script component, then install it.

Steps
  1. In the Common Tasks section in the browser interface, click WebLogic 8.

  2. Click the Command Line Interface: Create link.

    The component's Edit page displays.

  3. Type the name of the new WebLogic Script component.

  4. (Optional) Type the components label and description.

  5. Select a host that has a copy of the WebLogic script file on its file system.

  6. Navigate through the host's file system and select the file.

  7. Click Check In Selected Item.

    The component's Check In page displays.

  8. Select a folder on which you have edit permissions.

  9. Click Continue to Check In.

ProcedureHow to Install a WebLogic Script Component

Before You Begin

Before you can install a WebLogic script component, one must exist within the provisioning system. See How to Create a WebLogic Script Component.

Steps
  1. In the Common Tasks section in the browser interface, click WebLogic 8.

  2. Click the Command Line Interface: View All link.

    The Components page displays.

  3. In the row of the WLScript component that you plan to install, click Details.

    The component's Details page displays.

  4. In the Component Procedures table, select the Default: Install procedure and click Run.

    The plan's Run page displays.

  5. Select the target host.

    You target the AdminServer virtual host.


    Note –

    You do not need to modify the component variables for license installation.


  6. (Optional) Type the name of the WebLogic user who installed the software in the RunAs field.

    This user represented by the webLogicUser variable used in the software installation plan.

  7. Click Run Plan (Includes Preflight).

Using Plans

The WebLogic 8 Plug-In relies on plans to perform many of the tasks associated with installing and removing Administration Servers, Managed Servers, and clusters.

BEA WebLogic 8 plug-in plans are located in the /com/sun/weblogic8 folder and linked to from the Common Tasks page.

Troubleshooting

If you are experiencing problems managing WebLogic through the provisioning software, messages will likely appear on the screen to tell you that a problem exists.


Problems encountered during plan run or preflight
The plan (or preflight) "/com/sun/weblogic8/InstallAdminServerPlan" 
finished with 1 failed host(s). (017034)
Unable to find session variable "WL_DEFAULT_PASSWORD" (Unresolved 
session variable WL_DEFAULT_PASSWORD. This session variable was 
automatically created when the system was unable to find it.). 
Add this session variable and try the operation again. (040111)

Although the message in this example is easily understood, not all messages are this straightforward.

The following message means that the JMX interface on the Administration Server was not available or the login information is wrong.


Admin Server adminHost JMX interface
 running on port portNumber is not available;
Admin Server must be running for this operation.

To find out more information about the specific problem, follow the Run History Details links until you reach the final error block. View the output of stderr and stdout for details on the error condition.

Examples of WebLogic Installation Error Messages

This section includes examples of error messages that you might encounter during the installation of WebLogic.


Example 4–2 Invalid User Message


The user specified is not a valid system users: weblogic (017056)

You must create the system user “weblogic” or change the Install variable weblogicUser to an existing user.



Example 4–3 Target Host Error Message


Specified target(s) "sol01" were not in the required host set
 "com.sun.weblogic8#SupportedHS". (017087)

This error message could result for two reasons:



Example 4–4 Error Message in a Raise Step


Error: Installation could not be preformed check the deployment details
 for more information.

You must check the deployment details of the final execNative control to find information from the WebLogic installer.

The following messages are examples of what could be contained in the stdout output.