test

Sun N1 Service Provisioning System User's Guide for BEA WebLogic 9 Plug-in 1.0

Configuring Services for WebLogic Applications

Based on the needs of your application, you might need to configure the WebLogic services before you can deploy the application components as described in Deploying WebLogic Applications. To configure the services, you might need to rely on the following component types.

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 data source or multi 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.

This section describes how to create, install, and uninstall these configuration objects. For instructions, see the following procedures.

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

Creating Configuration Services

To use the configuration objects in your WebLogic environment, you must first capture the service as a configuration component. This section provides the following procedures that describe how to capture these objects.

ProcedureHow to Create a Configuration Service

This procedure describes how to create configuration components. If you plan to use JMS Queues, Topics, Connection Factories, or Destination Keys, you must also create a JMS Module. For more information, see How to Configure a JMS Module.

Steps

  1. In the Common Tasks section of the browser interface, click WebLogic 9.

  2. In the Configuration Tasks section of the WebLogic 9 page, click the Create link for the configuration object that you want to capture.

    Click the Create link for one of the following configuration components.

    • Data Source

    • Multi Data Source

    • JMS Server

    • JMS Queues

    • JMS Topics

    • JMS File Store

    • JMS JDBC Store

    • JMS Connection Factory

    • JMS Destination Key

    • Mail Session

    The Components Details Edit page is displayed.

  3. Specify the name of the component.

  4. (Optional) Specify a label for the component.

  5. (Optional) Specify a description for the component.

  6. In the WebLogic Admin Server field, select the Managed Server or cluster from which you want to capture the configuration service.

  7. Navigate through the server file system to find the configuration service to capture.

  8. Click Check-in Selected Item.

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

Next Steps

To deploy the configuration service in your WebLogic environment, see Installing Configuration Services.

If you plan to deploy JMS Queues, Topics, Connection Factories, or Destination Keys, you must configure a JMS Module. See How to Configure a JMS Module for more information.

ProcedureHow to Configure a JMS Module

If you plan to use JMS Queues, Topics, Connection Factories, or Destination Keys, in your WebLogic environment, you must create a JMS Module container to configure these objects during deployment.

Steps

  1. In the Common Tasks section of the browser interface, click WebLogic 9.

  2. In the Configuration Tasks section of the WebLogic 9 page, click the JMS Module: Configure link.

    The Plans Details Run page is displayed.

  3. In the Plan Parameters area, select the variable settings for the JMS Module component that you plan to configure.

    • 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 JMS Module component.

        variable set name

        Required. A name for the new variable set you create

        Name

        Required. Specifies the name of the JMS Module that you want to deploy.

        DescriptorFileName

        Required. Specifies the name of the JMS Module descriptor file.

        Notes

        Optional. Specifies any additional information or notes about the JMS Module.

        installName

        Required. Specifies the name to use to deploy the JMS Module

        installPath

        Required. Specifies the location to install the JMS Module.

        pluginClassPath

        Optional. Specifies the path to the WebLogic 9 Plug-In execJava classes.

      • If you want to use another component's variable settings, click Import Set From Component.

        The Import Variable Settings window displays.

        1. If necessary, navigate to the Folder that contains the component with the variable settings you want to import.

        2. Select the component version.

          Note –

          Variable settings can vary between component versions. Ensure that the current components and the component from which you want to import variable settings share common variables. If the component from which you want to import variable settings does not share common variables with the component you want to use in your plan, the variable settings are not imported.

        3. Click Import Variable Settings.

          The variables settings are imported, and are displayed in the table.

        4. On the Plan Details Run page, select the variable settings that you imported from the Variable Settings drop-down list, then click Select.

      • If you want to use component variable settings that are stored in a file, follow these steps.

        1. In the Import Sets from File text field, enter the path to the variable settings file that you want to use.

          To browse through the file system to find the appropriate file, click the Browse button.

        2. Click Import.

          The variables settings are imported, and are displayed in the table.

          Note –

          If the file from which you want to import variable settings does not share common variables with the component you want to use in your plan, the variable set is not imported.

        3. On the Plan Details Run page, select the variable settings that you imported from the Variable Settings drop-down list, then click Select.

  4. Select the target host or target host set.

    Target either a Managed Server or WebLogic Cluster.

    Note –

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

  5. Click Run Plan (includes preflight).

Installing Configuration Services

After you create your configuration components, you can deploy these services to your Administration Server.

When you install a configuration component, 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 component by navigating to the component Details page and running the Install component procedure. Many components require that you edit certain component variables. See WebLogic Configuration Component Types and Variablesfor variables that require custom values.

ProcedureHow to Install Configuration Services

This procedure describes how to install the following components.

Before You Begin

If you want to install JMS Queues, Topics, Connection Factories, or Destination Keys, you must first configure a JMS Module to hold the configuration information for these components. See How to Configure a JMS Module for more information.

Steps

  1. In the Common Tasks section of the browser interface, click WebLogic 9.

  2. Click the Components link.

    The Components page is displayed.

  3. Navigate to the location of the configuration component that you want to deploy.

    Click the Change Folder link to browse through the file system to select the location of the configuration component.

  4. In the Component column, click the configuration component that you want to deploy.

    The Components Details page is displayed.

  5. In the Component Procedures table, click the Run link in the Install: Default row.

    The Plans Details Run page is displayed.

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

    For information about the required variables for each configuration component, see WebLogic Configuration Component Types and Variables.

    • 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.

      For

      The Select Variable Settings From List window displays.

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

        Specify the variable values that are appropriate for your installation.

      • If you want to use another component's variable settings, click Import Set From Component.

        The Import Variable Settings window displays.

        1. If necessary, navigate to the Folder that contains the component with the variable settings you want to import.

        2. Select the component version.

          Note –

          Variable settings can vary between component versions. Ensure that the current components and the component from which you want to import variable settings share common variables. If the component from which you want to import variable settings does not share common variables with the component you want to use in your plan, the variable settings are not imported.

        3. Click Import Variable Settings.

          The variables settings are imported, and are displayed in the table.

        4. On the Plan Details Run page, select the variable settings that you imported from the Variable Settings drop-down list, then click Select.

      • If you want to use component variable settings that are stored in a file, follow these steps.

        1. In the Import Sets from File text field, enter the path to the variable settings file that you want to use.

          To browse through the file system to find the appropriate file, click the Browse button.

        2. Click Import.

          The variables settings are imported, and are displayed in the table.

          Note –

          If the file from which you want to import variable settings does not share common variables with the component you want to use in your plan, the variable set is not imported.

        3. On the Plan Details Run page, select the variable settings that you imported from the Variable Settings drop-down list, then click Select.

  7. Select the target host or target host set.

  8. In the Plan Parameters section, specify any options that you want to use with the install plan.

  9. Click Run Plan (includes preflight).

Uninstalling Configuration Services

If necessary, you can uninstall configuration services from your Administration Server.

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

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

ProcedureHow to Uninstall Configuration Services.

This procedure describes how to uninstall the following configuration services.

Steps

  1. In the Common Tasks section of the browser interface, click WebLogic 9.

  2. Click the Components link.

    The Components page is displayed.

  3. Navigate to the location of the configuration component that you want to uninstall.

    Click the Change Folder link to browse through the file system to select the location of the configuration component.

  4. In the Component column, click the configuration component that you want to uninstall.

    The Components Details page is displayed.

  5. In the Component Procedures table, click the Run link in the Uninstall: Default row.

    The Plans Details Run page is displayed.

  6. Select the target host or target host set.

  7. In the Plan Parameters section, specify any options that you want to use with the uninstall plan.

  8. Click Run Plan (includes preflight).

WebLogic Configuration Component Types and Variables

The following sections contain the WebLogic configuration objects that have been modeled as a component type. These sections also provide the default component names and the component variables that require custom values.

Data Source and Multi Data Source Component Types and Variables

The WebLogic 9 Plug-In provides the Data Source and Multi Data Source component types for capturing database data sources and connection pools. The following table lists the required component variables for these component types.

Table 5–2 Data Source and Multi Data Source Component Information and Variables

Component Type 

Description 

Required Variables 

Data Source 

Specifies the database data source for your application. 

  • Data source name (Name)

  • JNDI name (JNDINames)

Multi Data Source 

Specifies the database data source and associated connection pools for your application. 

  • Multi Data source name (Name)

  • Algorithm type (either Failover or Load-Balancing) for the multi data source (AlgorithmType)

  • Comma-separated list of data sources (DataSourceList)

  • JNDI name (JNDINames)

For information about how to create and deploy these component types, see Configuring Services for WebLogic Applications.

Java Messaging Service (JMS) Components and Variables

The WebLogic 9 Plug-In provides several Java Messaging Service (JMS) component types for capturing JMS configuration components. The following table lists the required component variables for these components or component types.

Table 5–3 JMS Component Information and Variables

Component Type 

Description 

Default Component 

Required Variables 

JMS Server  

Specifies the server to store and serve JMS information. 

WLJMSServerConfig

JMS server name (Name)

JMS Module 

Specifies the configuration module for JMS Queues, Topics, Connection Factories, and Destination Keys. 

None 

  • JMS Module name (Name)

  • JMS Module descriptor file (DescriptorFileName)

JMS Queue  

Specifies the messaging queue for point-to-point messaging. 

WLJMSQueueConfig

  • JMS destination name (Name)

  • JMS module name (JMSModuleName)

  • JNDI name of the JMS destination (JNDIName)

JMS Topic 

Specifies the messaging topic for publish-and-subscribe messaging. 

WLJMSTopicConfig

  • JMS destination name (Name)

  • JMS module name (JMSModuleName)

  • JNDI name of the JMS destination (JNDIName)

JMS File Store 

Specifies the JMS backing store. 

WLJMSFileStoreConfig

Name of the JMS file store (Name)

JMS JDBC Store 

Specifies the JMS JDBC backing store. 

WLJMSJDBCStoreConfig

  • JMS JDBC store (Name)

  • The JDBC data source used by this JDBC store (DataSource)

JMS Connection Factory 

Specifies the connection factory to create JMS connections to the data source. 

WLJMSConnectionFactoryConfig

  • Name of the JMS connection factory (Name)

  • JNDI name (JNDIName)

JMS Destination Key 

Specifies the destination keys to specify the order in which messages are delivered. 

WLJMSDestinationKeyConfig

Name of the JMS destination key (Name)

For information about how to create and deploy these component types, see Configuring Services for WebLogic Applications.

Mail Session Component Type and Variables

With the WebLogic 9 Plug-In you can capture mail sessions as N1 SPS components, and then deploy these components. The following table lists the required component variables for these components.

Table 5–4 Mail Service Component Information and Variables

Component Type 

Description 

Required Variables 

Mail Service 

Specifies the mail service to use for communication between the Administration Server and Managed Servers. 

  • Mail session name (msName)

  • JNDI name (jndiName)

  • Variable generated from the WebLogic value of the mail session property

For information about how to create and deploy this component type, see Configuring Services for WebLogic Applications.