test

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

Chapter 5 Deploying and Managing Applications With the WebLogic 9 Plug-In

The WebLogic 9 Plug-In provides several specific component types to enable you to capture and provision your enterprise applications. This chapter describes the following topics.

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 Sun N1 Service Provisioning System. If you use the provisioning software, you must manage your WebLogic applications exclusively with the provisioning software.

ProcedureHow to Capture an Application Archive

This procedure describes how to capture enterprise application (EAR), web application (WAR), and Java archive (JAR) files.

Steps

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

  2. Click the Application Archives: Create link.

  3. Type a name for this component.

  4. (Optional) Type a label for this component.

  5. (Optional) Type a description for this component.

  6. In the Import From Host field, specify the system from which you want to capture the application.

    You can specify the system in two different ways.

    • Type the name of the system from which you want to capture the application, then click the Refresh link.

    • Click the Select From List link, then select the system from the Current Found Hosts list in the Select Host From List window.

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

  8. Select the appropriate options for your application.

    You can set the following options for your application.

    • Check in an application archive that has not changed since a previous check in.

    • Assign user and group ownership permissions to the application.

  9. In the Path of the Resource Descriptor File field, type the path to the resource descriptor file for this component.

    A resource descriptor file specifies the owner, group, and permission settings to use for the files and directories that comprise the resource of a component. For more information about resource descriptor files, see Using a Resource Descriptor File in Sun N1 Service Provisioning System 5.2 XML Schema Reference Guide.

  10. Click Check-in Selected Item.

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

Next Steps

If you want to use a plan to deploy your application, you must first capture your deployment plan , and then group your application archive component with the deployment plan in an Application Archive Container component. For more information about how to capture deployment plans, see How to Capture a Deployment Plan.

ProcedureHow to Capture a Deployment Plan

You can author your own XML deployment plans to coordinate the deployment of complex enterprise and web applications involving multiple components. You can then include these plans in containers that hold the deployment plan and all the necessary application archive components for your deployment.

This procedure describes how to capture your deployment plans. For information about how to author a deployment plan in XML, see Sun N1 Service Provisioning System 5.2 Plan and Component Developer’s Guide.

Steps

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

  2. Click Create in the Deployment Plans section of the WebLogic 9 Common Tasks page.

  3. Type a name for this component.

  4. (Optional) Type a label for this component.

  5. (Optional) Type a description for this component.

  6. In the Import From Host field, specify the system from which you want to capture the plan.

    You can specify the system in two different ways.

    • Type the name of the system from which you want to capture the plan, then click the Refresh link.

    • Click the Select From List link, then select the system from the Current Found Hosts list in the Select Host From List window.

  7. Navigate through the hierarchy to find the plan to capture.

  8. Select the appropriate options for your plan.

    You can set the following options for your plan.

    • Check in a plan that has not changed since a previous check in.

    • Assign user and group ownership permissions to the plan.

    • Designate the plan as a configuration template. If you check the Configuration Template check box, all the component variables for you plan will be added to the container that holds your plan and all associated components. You can then edit these variables when you deploy your application with this container.

  9. In the Path of the Resource Descriptor File field, type the path to the resource descriptor file for this component.

    A resource descriptor file specifies the owner, group, and permission settings to use for the files and directories that comprise the resource of a component. For more information about resource descriptor files, see Using a Resource Descriptor File in Sun N1 Service Provisioning System 5.2 XML Schema Reference Guide.

  10. Click Check-in Selected Item.

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

Next Steps

To use your plan to deploy your application, you must group your plan and the associated application archive components in a Application Archive container. For more information, see How to Group Application Archives and Deployment Plans in a Container.

ProcedureHow to Capture a Shared J2EE Library

Steps

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

  2. Click Create in the Shared J2EE Libraries section of the WebLogic 9 Common Tasks page.

  3. Type a name for this component.

  4. (Optional) Type a label for this component.

  5. (Optional) Type a description for this component.

  6. In the Import From Host field, specify the system from which you want to capture the J2EE library.

    You can specify the system in two different ways.

    • Type the name of the system from which you want to capture the plan, then click the Refresh link.

    • Click the Select From List link, then select the system from the Current Found Hosts list in the Select Host From List window.

  7. Navigate through the hierarchy to find the library to capture.

  8. Select the appropriate options for your library.

    You can set the following options for the J2EE library.

    • Check in a library that has not changed since a previous check in.

    • Assign user and group ownership permissions to the library.

  9. In the Path of the Resource Descriptor File field, type the path to the resource descriptor file for this component.

    A resource descriptor file specifies the owner, group, and permission settings to use for the files and directories that comprise the resource of a component. For more information about resource descriptor files, see Using a Resource Descriptor File in Sun N1 Service Provisioning System 5.2 XML Schema Reference Guide.

  10. Click Check-in Selected Item.

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

ProcedureHow to Group Application Archives and Deployment Plans in a Container

Steps

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

  2. Click Create in the Application Archive With Deployment Plan Container: section of the WebLogic Common Tasks page.

    The Component Details Edit page is displayed.

  3. Type a name for the container component.

  4. Select the appropriate platform for you container from the Platform drop down menu.

  5. Type a label for this container component

  6. Type a description for this component component.

  7. Select the Application Archive components and deployment plan that you want to group together.

    1. In the Referenced Components table, select the component type that you want to include in your Application Archive container from the Type drop down menu.

      • To specify an Application Archive, select the com.sun.weblogic9#ApplicationArchive component type.

      • To specify a Deployment Plan, select the com.sun.weblogic9#DeploymentPlan component type.

    2. Select the component that you want to include in the Application Archive container.

      • To use an existing component, follow these steps.

        1. Click the Reference Existing link in the Actions column.

          The Reference Existing Components in Current Component window is displayed.

        2. Select the component in the Reference Existing Components in Current Component window.

          Click the Change Folder link to navigate through the file system to find the component that you want to use.

      • To use a new component, follow these steps.

        1. Click the Check In New link in the Actions column.

          The Components Details Edit page is displayed.

        2. Type a name for this component.

        3. (Optional) Type a label for this component.

        4. (Optional) Type a description for this component.

        5. In the Import From Host field, specify the system from which you want to capture the application.

          You can specify the system in two different ways.

          • Type the name of the system from which you want to capture the application, then click the Refresh link.

          • Click the Select From List link, then select the system from the Current Found Hosts list in the Select Host From List window.

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

        7. Select the appropriate options for your application.

          You can set the following options for your application.

          • Check in an application archive that has not changed since a previous check in.

          • Assign user and group ownership permissions to the application.

          • If you are checking in a plan, you can designate the plan as a configuration template. If you check the Configuration Template check box, all the component variables for you plan will be added to the container that holds your plan and all associated components. You can then edit these variables when you deploy your application with this container.

        8. In the Path of the Resource Descriptor File field, type the path to the resource descriptor file for this component.

          A resource descriptor file specifies the owner, group, and permission settings to use for the files and directories that comprise the resource of a component. For more information about resource descriptor files, see Using a Resource Descriptor File in Sun N1 Service Provisioning System 5.2 XML Schema Reference Guide.

        9. Click Check-in Selected Item.

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

  8. Repeat the previous step for each Application Archive or Deployment Plan that you want to include in your Application Archive container.

  9. In the Component Variables table, set the variable settings for the Application Archive container.

    • To create new variables, follow these steps.

      1. In the text field in the Variable column of the first row, type the name of the variable you want to create.

      2. In the text field in the Prompt column, type a description of the variable.

      3. In the text field in the Value for This Component column, type the variable value that you want to use.

      4. Click the Create link.

    • To edit existing variable values, follow these steps.

      1. Select the checkbox for the variable that you want to edit.

      2. Type the variable value in the text field in the Value for This Component column.

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

        deploymentName

        Required. Specifies the deployment name to be used for the application.

        appVersion

        Optional. Specifies the version of the application to deploy. Specify a value for this variable to enable the redeployment of your application.

        stagingMode

        Required. Specifies the staging mode for the deployment of the application. The valid values are stage(default), nostage, and external_stage.

        stage deploys the container resources to the Administration Server, and the WebLogic software copies the application archive files to the target hosts.

        nostage makes the application archive files accessible to the target hosts, but does not copy the application archive files to the target hosts.

        external_stage deploys the container resources to the Administration Server, and the N1 SPS software deploys the application archive files to the staging area of the target hosts.

        target

        Required. Specifies the target host for the deployment.

        subModuleTargets

        Optional. Specifies submodule targets for the deployment.

        adminServerHostName

        Required. Specifies the logical host name for the Administration Server for the domain.

        installPath

        Required. Specifies the installation location for the application archive.

        If you specify stage or external_stage for the stagingMode variable, specify the location on the Administration Server to install the application archive.

        If you specify nostage for the stagingMode variable, specify the network path to the application archive. This location must be accessible to the target host through NFS.

  10. Click Check In.

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

Deploying WebLogic Applications

The WebLogic 9 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.

The WebLogic 9 Plug-In provides the following component types for modeling and defining your applications.

For instructions about how to create these components, see Capturing and Editing WebLogic Applications.

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 Configuring Services for WebLogic Applications.

This section describes how to perform the following deployment tasks.

ProcedureHow to Install an Application

To install an Application Archive component, either directly from the component procedures or with an Application Archive With Plan component, you must use a WebLogic Managed Server or cluster as the target host. The installation process performs two main tasks:

Steps

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

  2. Click the Components link.

    The Components page is displayed.

  3. Navigate to the location of the Application Archive or Application Archive With Plan component that you want to deploy.

    Click the Change Folder link to browse through the file system to select the location of the application archive.

  4. In the Component column, click the Application Archive or Application Archive With Plan component that you want to deploy.

    The Components Details page is displayed.

  5. In the Component Procedures table, select the type of deployment that you want to perform.

    • To deploy the application and start the application on the target host, click the Run link in the Install: Default row.

      Use this procedure to directly install an Application Archive component.

    • To deploy the application with a Deployment Plan, click the Run link in the Install: deployAppPlan row.

      Use this procedure to install an Application Archive component that is grouped with a Deployment Plan in an Application Archive With Plan container component.

    • To deploy the application to the target host, but not start and activate the application, click the Run link in the Install: Distribute or Install: DistributeAppPlan row.

      Use this procedure if you want to start the application in Administration Mode, rather than in general mode. Click the Run link for the Install: DistributeAppPlan procedure if you are using an Application Archive With Plan component.

    The Plans Details Run page is displayed.

  6. In the Plan Parameters area, select the variable settings for the ApplicationArchive 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 ApplicationArchive component.

        variable set name

        Required. A name for the new variable set you create

        deploymentName

        Required. Specifies the deployment name for the application.

        installName

        Required. Specifies the name of the Application Archive to deploy.

        appVersion

        Optional. Specifies the version of the application to deploy. Specify a value for this variable to enable the redeployment of your application.

        stagingMode

        Required. Specifies the staging mode for the deployment of the application. The valid values are stage(default), nostage, and external_stage.

        stage deploys the container resources to the Administration Server, and the WebLogic software copies the application archive files to the target hosts.

        nostage makes the application archive files accessible to the target hosts, but does not copy the application archive files to the target hosts.

        external_stage deploys the container resources to the Administration Server, and the N1 SPS software deploys the application archive files to the staging area of the target hosts.

        target

        Required. Specifies the target host for the deployment.

        subModuleTargets

        Optional. Specifies the application submodule targets for the deployment.

        adminServerHostName

        Required. Specifies the logical host name for the Administration Server for the domain.

        adminDomainRootDir

        Required. Specifies the root directory for the Administration Server for the domain.

        installPath

        Required. Specifies the installation location for the application archive.

        If you specify stage or external_stage for the stagingMode variable, specify the location on the Administration Server to install the application archive.

        If you specify nostage for the stagingMode variable, specify the network path to the application archive. This location must be accessible to the target host through NFS.

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

    Target either a Managed Server or WebLogic Cluster.

    Note –

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

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

    • (Optional) If you want to pass any Java arguments to the weblogic.Deployer command during the installation, type the arguments in the Java Arguments Used for weblogic.Deployer field.

      For information on how to perform deployment tasks using the weblogic.Deployer command, see BEA's WebLogic Server weblogic.Deployer Command-Line Reference document.

    • If you want to wait for a specified period to enable the previous version of the application to retire before installing the application, type a numerical value in seconds in the Optional: Second to Wait Before Previous Application Retires text field.

    • If you want to install and start the application in Administration Mode, type true in the Start Application in Admin Mode text field.

      You might want to start the application in Admin Mode for development systems.

      If you want to start the application in General Mode for production systems, set this value to false.

  9. Click Run Plan (includes preflight).

    The application is deployed to the target host or host set.

ProcedureHow to Install a Shared J2EE Library

Steps

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

  2. Click the Components link.

    The Components page is displayed.

  3. Navigate to the location of the shared J2EE library component that you want to deploy.

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

  4. In the Component column, click the J2EE Library 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 J2EE Library 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 J2EELibrary component.

        variable set name

        Required. A name for the new variable set you create

        extensionName

        Required. Specifies the name of the library that you want to install. This name must match the name of the library in the manifest.

        libspecver

        Optional. Specifies the version of the library. This value must match the version number in the archive, or be left blank.

        installPath

        Required. Specifies the path to the library.

        installUser

        Required. Specifies the user who will own the deployed library.

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

    Target either a Managed Server or WebLogic Cluster.

    Note –

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

  8. If you want to pass any Java arguments to the weblogic.WLST tool during the installation, type the arguments in the Java Arguments field.

    For information on how to perform deployment tasks using the weblogic.Deployer command, see BEA's WebLogic Server Using the WebLogic Server Scripting Tool document.

  9. Click Run Plan (includes preflight).

ProcedureHow to Start an Application

You can start an application in Administration Mode or General Mode.

Steps

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

  2. Click the Components link.

    The Components page is displayed.

  3. Navigate to the location of the Application Archive component that you want to start.

    Click the Change Folder link to browse through the file system to select the location of the application archive.

  4. In the Component column, click the Application Archive component that you want to start.

    The Components Details page is displayed.

  5. In the Component Procedures table, click the Run link in the startApp row.

    The Plans Details Run page is displayed.

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

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

    • (Optional) If you want to pass any Java arguments to the weblogic.Deployer command, type the arguments in the Java Arguments Used for weblogic.Deployer field.

      For information on how to perform deployment tasks using the weblogic.Deployer command, see BEA's WebLogic Server weblogic.Deployer Command-Line Reference document.

    • If you want to wait for a specified period to enable the previous version of the application to retire before starting the application, type a numerical value in seconds in the Optional: Second to Wait Before Previous Application Retires text field.

    • If you want to start the application in Administration Mode, type true in the Start Application in Admin Mode text field.

      You might want to start the application in Admin Mode for development systems.

      If you want to start the application in General Mode for production systems, set this value to false.

  8. Click Run Plan (includes preflight).

ProcedureHow to Stop an Application

You can stop an application, or transfer the application from General Mode to Admin Mode.

Steps

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

  2. Click the Components link.

    The Components page is displayed.

  3. Navigate to the location of the Application Archive component that you want to stop.

    Click the Change Folder link to browse through the file system to select the location of the Application Archive.

  4. In the Component column, click the Application Archive component that you want to stop.

    The Components Details page is displayed.

  5. In the Component Procedures table, click the Run link in the stopApp row.

    The Plans Details Run page is displayed.

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

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

    • (Optional) If you want to pass any Java arguments to the weblogic.Deployer command, type the arguments in the Java Arguments Used for weblogic.Deployer field.

      For information on how to perform deployment tasks using the weblogic.Deployer command, see BEA's WebLogic Server weblogic.Deployer Command-Line Reference document.

    • If you want to wait for all existing HTTP sessions to complete before stopping the application, type true in the Wait for Existing HTTP Clients to Complete text field.

    • If you want to stop the application and transfer the application to Administration Mode, type true in the Start Application in Admin Mode text field.

      You might want to transfer the application to Admin Mode for development systems.

  8. Click Run Plan (includes preflight).

    The application is uninstalled from the target host or host set.

ProcedureHow to Uninstall an Application

Steps

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

  2. Click the Components link.

    The Components page is displayed.

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

    Click the Change Folder link to browse through the file system to select the location of the Application Archive.

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

    The Components Details page is displayed.

  5. In the Component Procedures table, select the correct procedure to uinstall the application.

    • Click the Run link in the Uninstall: Default row to directly redeploy an application from an Application Archive component.

    • Click the Run link in the Uninstall: UninstallFromContainer row to redeploy an application from an Application Archive With Plan container.

    The Plans Details Run page is displayed.

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

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

    • (Optional) If you want to pass any Java arguments to the weblogic.Deployer command during the uninstallation, type the arguments in the Java Arguments Used for weblogic.Deployer field.

      For information on how to perform deployment tasks using the weblogic.Deployer command, see BEA's WebLogic Server weblogic.Deployer Command-Line Reference document.

    • If you want to wait for all existing HTTP sessions to complete before uninstalling the application, type true in the Wait for Existing HTTP Clients to Complete text field.

    • If you want to uninstall the application without waiting for current HTTP client sessions to complete, type true in the Ignore Current HTTP Client Sessions text field.

    • If you want to remove the Application Archive files from the Administration Server, type true in the Remove Deployment Files text field.

  8. Click Run Plan (includes preflight).

    The application is uninstalled from the target host or host set.

ProcedureHow to Uninstall Previous Versions of an Application

If you installed an application without N1 SPS software, and want to install an updated version of the application with N1 SPS, you can uninstall the previous version of the application. The application must be versioned to enable the WebLogic 9 Plug-In to uninstall the previous version of the application.

Steps

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

  2. Click the Components link.

    The Components page is displayed.

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

    Click the Change Folder link to browse through the file system to select the location of the Application Archive.

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

    The Components Details page is displayed.

  5. In the Component Procedures table, click the Run link in the undeployPreviousVersion row.

    The Plans Details Run page is displayed.

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

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

    • In the Version of This App Needed to Review text field, specify the version of the application that you want to uninstall.

    • (Optional) If you want to pass any Java arguments to the weblogic.Deployer command, type the arguments in the Java Arguments Used for weblogic.Deployer field.

      For information on how to perform deployment tasks using the weblogic.Deployer command, see BEA's WebLogic Server weblogic.Deployer Command-Line Reference document.

  8. Click Run Plan (includes preflight).

    The application is uninstalled from the target host or host set.

ProcedureHow to Update an Application

If you want to update an application with changes that you have made to the Application Archive, you can redeploy the application to your Managed Servers or cluster.

Steps

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

  2. Click the Components link.

    The Components page is displayed.

  3. Navigate to the location of the Application Archive component that you want to update.

    Click the Change Folder link to browse through the file system to select the location of the Application Archive.

  4. In the Component column, click the Application Archive component that you want to update.

    The Components Details page is displayed.

  5. In the Component Procedures table, select the correct procedure to update the application.

    • Click the Run link in the Install: Redeploy row to directly redeploy an application from an Application Archive component.

    • Click the Run link in the Install: RedeployAppPlan row to redeploy an application from an Application Archive With Plan container.

    The Plans Details Run page is displayed.

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

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

    • If you want to pass any Java arguments to the weblogic.Deployer command, type the arguments in the Java Arguments Used for weblogic.Deployer field.

      For information on how to perform deployment tasks using the weblogic.Deployer command, see BEA's WebLogic Server weblogic.Deployer Command-Line Reference document.

    • If you are using an Application Archive With Plan component to deploy your application, specify the location of the Deployment Plan in the Path for Deployment Plan text field.

    • In the Required WebLogic Target for Deployment text field, specify the systems that you want to update.

    • In the Optional WebLogic Submodule Targets for Deployment text field, specify the application submodules to target with your redeployment.

    • In the Deployment Name Used for This Application text field, specify the name of the Application Archive or Application Archive With Plan component that you want to redeploy.

    • In the App Version text field, specify the version number of the application that you want to redeploy.

  8. Click Run Plan (includes preflight).

    The application is uninstalled from the target host or host set.

ProcedureHow to Update a Deployment Plan in an Application Archive With Plan Component

If you change a Deployment Plan component that you are using with an Application Archive With Plan container component, you can update your Managed Servers or clusters with the new Deployment Plan.

Steps

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

  2. Click the Components link.

    The Components page is displayed.

  3. Navigate to the location of the Application Archive With Plan component that you want to update with a new Deployment Plan.

    Click the Change Folder link to browse through the file system to select the location of the Application Archive With Plan component.

  4. In the Component column, click the Application Archive With Plan component that you want to update.

    The Components Details page is displayed.

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

    The Plans Details Run page is displayed.

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

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

    • (Optional) If you want to pass any Java arguments to the weblogic.Deployer command, type the arguments in the Java Arguments Used for weblogic.Deployer field.

      For information on how to perform deployment tasks using the weblogic.Deployer command, see BEA's WebLogic Server weblogic.Deployer Command-Line Reference document.

    • If you want to specify the version of the plan to use, type the version number in the Optional Plan Version text field.

  8. Click Run Plan (includes preflight).

    The application is uninstalled from the target host or host set.

Error Conditions

Table 5–1 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 

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.

Using the CLI to Work With WebLogic

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

Using the Sun N1 Service Provisioning System Command-Line Interface

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

BEA WebLogic 9 plug-in objects are located in the /com/sun/weblogic9 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 Sun N1 Service Provisioning System 5.2 Command-Line Interface Reference Manual

Using the WebLogic Command-Line Interface

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

ProcedureHow to Use the WebLogic Command-Line Interface Through the Sun N1 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 9.

  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 5–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 Sun N1 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 , then check in the script as an N1 SPS component, then install it. This procedure assumes that you have an existing WLST script available on a file system.

Steps

  1. In the Common Tasks section in the browser interface, click the Create New Component link.

    The Components table is displayed.

  2. In the Action column, click the Create link.

    The Component Details Edit page is displayed.

  3. In the Component field, type the name of your component.

  4. Select com.sun.weblogic9#WLSTScript from the Type drop down menu.

  5. (Optional) Type a label and description for the component.

  6. Select a host that has a copy of the WebLogic script file in the file system.

  7. Navigate to the location of the script on the host.

  8. Select the appropriate options for your component.

    You can set the following options for your application.

    • Check in a script component that has not changed since a previous check in.

    • Assign user and group ownership permissions to the script component.

    • You can designate the script component as a configuration template. If you check the Configuration Template check box, all the component variables for your script component will be added to the container that holds your script component and all associated components. You can then edit these variables when you deploy your application with this container.

  9. In the Path of the Resource Descriptor File field, type the path to the resource descriptor file for this component.

    A resource descriptor file specifies the owner, group, and permission settings to use for the files and directories that comprise the resource of a component. For more information about resource descriptor files, see Using a Resource Descriptor File in Sun N1 Service Provisioning System 5.2 XML Schema Reference Guide.

  10. Click Check In Selected Item.

    The component's Check In page displays.

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

  12. 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 9.

  2. In the Common Tasks section in the browser interface, click the Components link.

    The Components table is displayed.

  3. If necessary, navigate to the directory that contains the script component.

  4. In the row of the WLSTScript component that you plan to install, click Details.

    The component's Details page displays.

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

    The plan's Run page displays.

  6. Select the target host.

    You target the AdminServer virtual host.

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

  8. Click Run Plan (Includes Preflight).

Using Plans

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

BEA WebLogic 9 plug-in plans are located in the /com/sun/weblogic9 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/weblogic9/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 5–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 5–3 Target Host Error Message


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

This error message could result for two reasons:

Example 5–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.