WebSphere Enterprise Service Bus, Version 6.2.0 Operating Systems: AIX, HP-UX, i5/OS, Linux, Solaris, Windows


Creating a build definition and generating the IIP

This topic describes how to create a build definition file and generate the integrated installation package (IIP) with the IBM® WebSphere® Installation Factory.

Before you begin

You must first install the Installation Factory before you use it to create an installation package. See Getting Started with the Installation Factory for more information.

About this task

To create an IIP, first create a build definition file which the Installation Factory later uses to generate the IIP. The build definition file describes exactly which packages and configurations are included in the IIP. You can do both steps on the local workstation, or you can choose to create the build definition locally, then pass the XML file to another workstation to generate the IIP, perhaps even on a different workstation or operating system. The remote workstation must first contain the Installation Factory and all products you want to include in the IIP in order to generate an IIP from a build definition file.

In some cases, you might not be able to use the Build definition wizard on the target operating system platform. You have three options in such a case:

Use the following procedure to create the build definition file and generate the IIP.

Procedure
  1. Download the product code from the download page for the IBM WebSphere Installation Factory and unpack the code.

    See the download page for a complete list of tested operating systems.

  2. Consider which installation packages you want to include in the IIP. The Installation Factory does not contain any product installation images. You must provide the software to be installed by the Installation Factory.
  3. Start the Installation Factory console with the graphical user interface (GUI) script.
    • For AIX operating systemFor HP-UX operating systemFor Linux operating systemFor Solaris operating system Use the IF_home/bin/ifgui.sh script.
    • For Windows operating system Use the IF_home\bin\ifgui.bat script.
  4. Create a new IIP build definition or open an existing one.

    Click Create New Integrated Installation Package to create a new IIP build definition.

    Click Open Build Definition if you want to edit an existing build definition XML file.

  5. Choose whether to run the wizard in connected or disconnected mode.
    • Connected mode

      Select the check box for connected mode processing so that you can generate the IIP in addition to creating the build definition file on the local workstation. The build definition wizard will attempt to validate all directories, files, and installation packages in connected mode and must be able to access these resources locally.

    • Disconnected mode

      Select the check box for disconnected mode processing to save the build definition only and generate the IIP later. Use the wizard in disconnected mode on a supported workstation to create a build definition file for a supported operating system on another workstation. Then copy the build definition XML file to the target operating system and use the ifcli command to start the processing engine and generate the IIP. The Build Definition wizard cannot verify the installation image, the maintenance packages, or any other files or scripts that you enter in disconnected mode. You can also generate an IIP for a target platform with a similar platform, in other words generate an IIP on a Windows platform for another Windows platform, or a UNIX-style platform for another UNIX-style platform.

      The paths for all products, directories, and files you specify in the wizard must be relative to the workstation on which the IIP will be created. For example, assume that you run the console on a Red Hat Enterprise Linux® 4 system that cannot access a target AIX® system. The Build Definition wizard cannot browse file locations on the target system. However, you can type the directory path of the AIX location for the Network Deployment installation image and other elements of the IIP.

  6. Provide all required parameters to identify the package information, the output location for the build definition file, the output location for the IIP, products, installation images, additional files and directories, and authorship information. See the help panel documents for information on each step of the IIP creation process:
    Restriction: Creating IIPs using non-English locale-specific characters in the directory path is not supported. Restrict the characters that you use in directory names to printable US ASCII characters.
    Panel Description
    IIP mode selection Specify whether to work in connected or disconnected mode, and specify the target operating system for the IIP.
    IIP package identification Specify a universally unique identifier for the IIP.
    IIP build information Specify the name and location of the build definition file and the IIP.
    IIP integrated installation wizard settings Use this panel to choose whether the IIP installation wizard is displayed to the IIP user during installation, and whether this setting can be overridden.
    IIP construct the integrated installation package Add and modify installation packages for the IIP. This panel also contains the following panels:
    IIP additional files Add files and directories to the IIP.
    IIP authorship Specify an organization and description for the IIP.
    IIP preview Use this summary panel to review all of your selections for the IIP.
  7. On the Integrated Installation Package Preview panel, select whether to save the build definition file only or to save the build definition file and generate the IIP locally. Click Finish to exit the Build definition wizard.

    If you selected to build the definition file only, copy the build definition XML file to the target workstation. Run the ifcli command against the build definition file to generate your IIP. See The ifcli command for more information.

    The amount of time required to generate the IIP depends on the number and type of products that you include in the package.

  8. The Installation Factory logs a completion message in the IF_home/logs/log.txt file when the processing engine is finished.

Example

The following is an example of creating a build definition file and generating an IIP on a Windows system which contains an process server contribution and a feature pack contribution. We will create the IIP on behalf of the fictional "Plants by WebSphere" company referenced in one of the process server sample applications.
  1. Launch the IF_home\bin\ifgui.bat script.
  2. On the IBM installation Factory panel, select Create a New Integrated Installation Package.
  3. The Build definition wizard launches and the Mode selection panel is displayed. Since we are building an IIP for creation and installation on this workstation, select Connected Mode. Note that after this IIP is created, you can also install on any workstation with the same operating system and platform as the local system. Under Platforms, select your current platform. Click Next.
  4. On the Package identification panel, enter an identifier: com.plantsByWebsphere. The version can remain 1.0.0.0. Click Next.
  5. The Build information panel is displayed. Enter a file name and location of the build definition XML file you are creating. Also, choose a directory where the IIP will be generated. Make sure that you have enough space in the target directory if you are going to generate the IIP in addition to building the build definition. You may see an error indicating a non-empty directory if the default IIP directory is not empty and the Warn if the target location check box is selected. Click Next.
  6. On the Integrated installation wizard settings panel, leave both installation wizard settings selected. For maximum flexibility during install time we will allow users to override our setting which will display the IIP wizard at startup. Click Next.
  7. The Construct the integrated installation package panel is displayed. This is the main panel where you will select, add, and modify the properties of the packages you want to include in the IIP. Since we want to create a package which includes the IBM WebSphere Application Server Network Deployment product, a feature pack, and the WebSphere Process Server version 6.2, we will begin with the Network Deployment product:
    1. Select IBM WebSphere Application Server Network Deployment 6.1 in the Supported installation packages and tools field. Click Add Installer.
    2. On the Add installation package panel, you will see the name of the package, its identifier, and the operating system and architecture of the platform for which we are building the IIP. We need to provide the product code for Network Deployment on our specified platform. Click Modify.
    3. Enter the directory path of the root directory of your Network Deployment product image, or click Browse to browse for the image. Since we're in connected mode, you can click Retrieve Package Size to estimate the size of that package. Click OK.
    4. You are returned to the Add installation packages panel. You can see that the Directory path to the package and the Package size fields are filled out. Click OK.
    5. You are returned to the Construct the integrated installation package panel. You can now see your package listed in the Installation packages used in this IIP field, and an invocation of that package has been created and listed in the Installation package invocations field. Make sure your package invocation is selected and click the Modify button next to the Installation package invocations field.
    6. The Installation package invocation properties panel is displayed. Here is where you will set all of the installation properties of your package invocation.
      1. Change the display name and the description for the invocation. The user installing the IIP will see this information displayed with the package invocation. You might customize these fields to reflect your company's implementation of this package.
      2. The Make this installation invocation the primary installation invocation check box is selected. Do not change this value because the feature pack package you will add later will use the information from this package for its defaults, including the target installation directory. In fact, this setting ensures that every other package invocation you add after this package will use certain values you specify for this package unless you change them manually.
      3. Deselect the Users can suppress the installation of this package check box. Since this is a relatively simple example with only three included packages, we want users to install all three packages.
      4. Do not change the Default installation mode default values. The installation wizard for Network Deployment will be displayed during installation.
      5. Set the installation path for this package from the Default installation directory path tab. You can set the path for both Administrator and non administrator user types. Click Modify to open the Modify default installation directory path panel and enter the path where this package will be installed. Click OK to return to the current panel.
      6. Click the Response files tab. Since we are not installing this package silently we can skip over the settings for this section.
      7. Click the Exit code actions tab. These are the actions which will be taken when the package generates these exit codes. Change the action for Installation is a partial success to Ask user whether to stop or continue the installation. We want the user to decide whether the partial success is acceptable, depending on what they see in the product logs or other information. The other two exit code actions are set to stop the installation by default, which is acceptable behavior in those two cases. Click OK to exit the Installation package invocation properties panel.
  8. Add the feature pack to the IIP.
    1. Select IBM WebSphere Application Server Version 6.1 Feature Pack for Web Services from the Supported packages and tools list and follow steps a - d in the Network Deployment section, changing only the product directory path.
    2. You are returned to the Construct the integrated installation package panel. You can now see your feature pack package listed in the Installation packages used in this IIP field, and an invocation of that package has been created and listed in the Installation package invocations field. Make sure the feature pack invocation is selected and click the Modify button next to the Installation package invocations field.
      1. Change the display name and the description for the invocation. The user installing the IIP will see this information displayed with the feature pack invocation. Customize these names to reflect your company or organization.
      2. Note that the Make this installation invocation the primary installation invocation check box is not selected by default. This is the behavior we want, since the feature pack installs on top of the Network Deployment product and will inherit the Network Deployment default values.
      3. Deselect the Users can suppress the installation of this package check box. Since this is a relatively simple example with only three included packages, we want users to install all three packages.
      4. Do not change the Default installation mode default values. The installation wizard for the feature pack will be displayed during installation. However, installing the feature pack silently would make it appear to the user that the entire Plants by WebSphere IIP is installed seamlessly in one operation even though two packages are being installed. Note that if you choose silent installation here, then you must specify a response file or the IIP installer must specify one during installation.
      5. Set the installation path for this package from the Default installation directory path tab. Note that since we set the Network Deployment package as the primary installation invocation our installation path value for the feature pack has been set to $RESV{6.1.0-WS-WASND_1-1:installLocation}. This is a macro which indicates that the Result Value of the installLocation option for the Network Deployment package will be used here. See IIP macro replacement for more information on macros and their use.
      6. Click the Response files tab. Since we are not installing this package silently we can skip over the settings for this section. If you want to install this package invocation silently, specify a response file.
      7. Click the Exit code actions tab. These are the actions which will be taken when the package generates these exit codes. Change the action for Installation is a partial success to Ask user whether to stop or continue the installation. We want the user to decide whether the partial success is acceptable, depending on what they see in the product logs or other information. The other two exit code actions are set to stop the installation by default, which is acceptable behavior in those two cases. Click OK to exit the Installation package invocation properties panel.
  9. Next, add the WebSphere ESB version 6.2 to the IIP.
    1. Select IBM WebSphere Process Server 6.2 from the Supported packages and tools list and follow steps a - d in the Network Deployment section, changing only the product directory path.
    2. You are returned to the Construct the integrated installation package panel. You can now see your feature pack package listed in the Installation packages used in this IIP field, and an invocation of that package has been created and listed in the Installation package invocations field. Make sure the WebSphere ESB invocation is selected and click the Modify button next to the Installation package invocations field.
      1. Change the display name and the description for the invocation. The user installing the IIP will see this information displayed with the WebSphere ESB invocation. Customize these names to reflect your company or organization.
      2. Note that the Make this installation invocation the primary installation invocation check box is not selected by default. This is the behavior we want, since the WebSphere ESB installs on top of the Network Deployment product and will inherit the Network Deployment default values.
      3. Deselect the Users can suppress the installation of this package check box. Since this is a relatively simple example with only three included packages, we want users to install all three packages.
      4. Do not change the Default installation mode default values. The installation wizard for the WebSphere ESB will be displayed during installation. Note that if you choose silent installation here, then you must specify a response file or the IIP installer must specify one during installation.
      5. Set the installation path for this package from the Default installation directory path tab. Note that since we set the Network Deployment package as the primary installation invocation our installation path value for the feature pack has been set to $RESV{6.1.0-WS-WASND_1-1:installLocation}. This is a macro which indicates that the Result Value of the installLocation option for the Network Deployment package will be used here. See IIP macro replacement for more information on macros and their use.
      6. Click the Response files tab. Since we are not installing this package silently we can skip over the settings for this section. If you want to install this package invocation silently, specify a response file.
      7. Click the Exit code actions tab. These are the actions which will be taken when the package generates these exit codes. Change the action for Installation is a partial success to Ask user whether to stop or continue the installation. We want the user to decide whether the partial success is acceptable, depending on what they see in the product logs or other information. The other two exit code actions are set to stop the installation by default, which is acceptable behavior in those two cases. Click OK to exit the Installation package invocation properties panel.
  10. Review the properties specified for your two package invocations in the installation package invocations table. Click Next.
  11. The Additional files and directories panel is displayed. You can specify any files or directories to include with the IIP. For example, you could include a readme file in addition to any images or other material you wanted to include in the IIP. You cannot run any scripts using this feature. If you want to add scripts to run during the installation, then you can build a Process Server customized installation package (CIP) with application and profile customizations and use that in a package invocation instead of just using the generally available Process Server product image. Click Next.
  12. On the Authorship panel, enter your Organization name, for example, "Plants by WebSphere" and a description. This information can be viewed by the IIP installer by clicking the About button in the installation wizard. Click Next.
  13. The Integrated installation package preview panel is displayed. You can select to save the XML file you have built, or save the file and generate the IIP. Since the IIP was built and validated in connected mode, choose to save the file and generate the IIP. Click Finish.

What to do next

You can now install the IIP which you have created. See Installing an IIP for more information or Installing an IIP silently if you want to install silently.

task Task topic

Terms of use | Feedback


Timestamp icon Last updated: 21 June 2010


http://publib.boulder.ibm.com/infocenter/dmndhelp/v6r2mx/topic//com.ibm.websphere.wesb620.doc/doc/tins_if_iip_createbuild.html
Copyright IBM Corporation 2005, 2010. All Rights Reserved.
This information center is powered by Eclipse technology (http://www.eclipse.org).