INFORMIX
DataBlade Developers Kit User's Guide
Chapter 10: Using BladePack
Home Contents Index Master Index New Book

Using BladePack

To package your DataBlade module, you add content to a BladePack project, assign components, customize the installation procedure, and build the package.

To build an installation package with BladePack

    1. Open a project file:

    2. Define the content of your product, including files, directories, and registry changes.

    3. Define and assign installation components.

    4. Define optional customizations.

    5. Build the installation package.

    6. Revise on-line help for the installation package.

    7. Transfer files from the build area to installation media.

Establishing Content

You can add these objects to your product in BladePack:

    For a DataBlade module, you need the project.bld file and the SQL script files. These files are automatically added to the Files to Install folder when you open a project.prd file.

    If the version of your DataBlade module you are packaging is an upgrade, you might need to specify files or directories to delete in the old installation.

    If you DataBlade module runs on Windows NT, you might have to specify registry changes.

To add a file or directory or a change to the registry

    1. Choose Edit Insert object, where object is File to Install, File to Delete, Directory to Install, Directory to Delete, or Change to Registry.

    The object appears on the Files/Directories page.

    2. Specify the properties of the object on the Details and other pages in the item view.

The following sections describe the properties of the objects on the Files/Directories page.

Files and Directories to be Installed or Deleted

The following table lists properties you define when you add files and directories to install or delete.

(1 of 2)

Property Description

Local name

The local name of the file or directory to be installed or deleted. Choose Browse to select a file from the Open dialog box.

You can have multiple operating system-specific files to install. See "Local Paths for Files for Multiple Operating Systems" for more information.

Target directory

For files and directories to install only.

The directory in which the file or directory is installed.

See "Specifying a Target Directory" for more information.

Target operating system

The operating system on which to install the file or directory.

Component

The component, subcomponent, or shared component to which the file or directory is assigned.

See "Assigning to Components" for more information on assigning to components.

File copy options

For files and directories to install only.

Options for copying files, including whether the file or DLL is installed only if it has the same or later date or version than the existing file or DLL. The default is None.

File sharing options
(Windows NT only)

For files and directories to install only.

Whether and how a file can be shared. The default is None.

See "
Windows NT
File Sharing Options"
for more information.

Icon options
(Windows NT only)

For files to install only.

Whether the file has an associated icon and information about that icon. The icon appears in the program group. Icons are typically used for applications, read me files, or help files; DataBlade modules do not require icons. The default is no icon.

Local Paths for Files for Multiple Operating Systems
If you have files that are operating system-specific, put them in a directory structure that is the same except for one directory, which is named for the operating system. When you add the file to your BladePack project, replace the directory named for the operating system with %OS%.

For example, if you compile your DataBlade module on Sun Solaris and Windows NT, you have two project.bld files, one in each of these directories:

Add the project/src/c/Solaris-sparc/project.bld file to the Files to Install folder, then replace Solaris-sparc with %OS%. When you build the BladePack project for Sun Solaris and Windows NT, BladePack adds the appropriate project.bld file to each project.

Specifying a Target Directory
The following table lists the options in the list for the Directory on target machine field.

The target directory for the DataBlade module files (project.bld and the SQL scripts) should be the extend/project directory under the $INFORMIXDIR directory.

Windows NT
File Sharing Options
File sharing options are valid for Windows NT installations only. For files in the Files to Install folder, choose one of these file sharing options from the Copy Options page:

Windows NT
Registry Changes

You can add entries to the Windows NT registry for the initialization and configuration of your DataBlade module and its associated programs.

Refer to your Microsoft Developer Studio documentation for information about the registry.

To add registry changes

    1. Choose Edit Insert Change to Registry.

    2. Fill in the Registry Changes Details page in the item view.

The following table lists the properties you define when adding registry changes.
Property Description

Registry hive

The standard primary registry keys under which you want to add a key:

Registry path

The key you want to add, expressed as a path.

Key name

The name of the key.

Key value

The value of the key.

Component

The component, subcomponent, or shared component to which the file or directory is assigned.

See "Assigning to Components" for more information on assigning to components.

Managing Components

BladePack allows you to organize your product installation package into three layers: component, subcomponent, and shared component. To see the component hierarchy for your product, click the Components tab in the project view.

Organizing an installation package into a component structure allows you to define Typical, Compact, and Custom installations. You specify whether each component or subcomponent is included in the Typical and Compact installations, and whether it is initially selected when users choose the Custom installation.

Use a shared component for those portions of your product that are shared by more than one component. A shared component is always installed with the component or subcomponent with which it is associated.

During a Custom installation, users can choose to install any components or subcomponents. When you mark a component Custom, the component is initially selected. The user can choose to include or exclude any components, except shared components, from the installation.

In most cases, the component level is sufficient to create Typical, Compact, and Custom installation options. For example, suppose you have created the following components (and no subcomponents) in your installation package, and marked them as shown:

In this scheme, users install the DataBlade module, help files, and examples if they choose the Typical installation. If they choose the Compact installation, they install the DataBlade module only. If they choose the Custom installation, the DataBlade module and debugging support are preselected. They can choose to add help and examples.

To create a component

    1. Choose Edit Insert Component.

    2. Complete the properties on the Component Details page in the item view.

To create a subcomponent

    1. Select the component to which you want the subcomponent to be subordinate.

    2. Choose Edit Insert Subcomponent.

    3. Complete the properties on the Component Details page in the item view.

To create and copy a shared component

    1. Select the component to which you want the shared component to be subordinate.

    2. Choose Edit Insert Shared Component.

    3. With the shared component still selected, choose Edit Copy.

    4. Select another component to which you want to add the shared component.

    5. Choose Edit Paste.

Component Properties

The following table lists the properties of components and subcomponents you define when creating one.
Property Description

Name

The name of the component or subcomponent that appears in the left column on the Select Installation Components screen during a custom installation

Description

The description of the component or subcomponent that appears in the right column when the item is selected on the Select Installation Components screen during a custom installation

Inclusion

What type of install the component or subcomponent is included in:

Shared components have one property: an identifier that is assigned by BladePack. You can edit the identifier; it can be an alphanumeric string up to 128 characters. Make sure it is unique among shared components. If you change an identifier, be sure to update it for every instance of that shared component.

Assigning to Components

You must assign every item on the Files/Directories and Customization pages to a component, subcomponent, or shared component. If you try to build the project with unassigned items, the build fails and you receive an error message telling you which item is not assigned to a component.

Initially, all files and directories that appear on the Files/Directories page are listed under the Unassigned Files and Directories folder on the Components page. Custom extensions are not shown on the Components page.

To assign an item to a component, use one of these methods:

Customizing the Installation

Custom extensions for the installation program are optional.

Windows NT
For Windows installation packages, you can add these custom extensions:

UNIX
For UNIX installation packages, you can add custom programs to call from the installation program.

In addition to adding the custom routines, dialog boxes, and programs in their respective folders, you must also add the file containing the custom extension to the Support Files folder. However, if you have more than one routine, dialog box, or program in a file, you need only add that file to the Support Files folder once.

To add a custom routine, dialog box, or program

    1. Choose Edit Insert Item, where Item is Custom DLL Routine, Custom DLL Dialog, or Custom Program.

    2. Complete the Details page in the item view.

    3. Choose Edit Insert Support File.

    4. Type the path and filename of the file containing the custom routine, dialog box, or program or click Browse to select the file from the Open dialog box.

To add a Read Me file

    1. Choose Edit Insert Readme File.

    2. Type the path and filename or click Browse to select the file from the Open dialog box.

The following table lists the properties of custom routines, dialog boxes, and programs you specify when you add one to your installation project.
Property Description

Name

The filename of the routine, dialog box, or program. Type the name or click Browse to select the file in the Open dialog box.

ID or command line arguments

For a custom routine, the ID string is an identifier you can use to determine which routine to call if you have more than one routine in a single DLL.

For a custom dialog box, the resource ID that you specified when creating it in Microsoft Developer Studio.

For a custom program, the command line arguments you want to use for the program during the installation process.

Target operating system

The operating system on which the custom extension runs.

Component

The component, subcomponent, or shared component to which the file or directory is assigned.

See "Assigning to Components" for more information on assigning to components.

When to run

When the custom extension is executed during the installation procedure:

Building the Installation

When the content and organization of your installation package are complete, build and test it.

To build, choose Build Build Installation. The Build Installation wizard is launched and prompts you for the following information:

    Choose one from the list. Build a separate package for every platform.

    This can be any directory. By default it is the project\install directory.

    You can bundle more than one project together in a single installation.

Installation Type

BladePack creates a directory structure in the target directory and copies files into the tree. When you build an interactive installation package for Windows, BladePack calls InstallShield to process the files and create CD-ROM and diskette images. If you build an interactive installation for a UNIX platform, BladePack includes install and uninstall shell scripts.

When you build a file tree installation, BladePack creates the file tree specified in the project in the target directory. A file tree build is useful for debugging the BladePack project.

After you successfully build an interactive installation, the target directory contains the subdirectories described in the following table.
Directory Description

tree

The root of a directory tree containing files to be included in the installation package. The tree directory can be used to debug problems in the installation package.

UNIX
On UNIX, the contents of this directory are not distributed with your installation package.

Windows NT
On Windows NT, this directory is compressed into a single archive called files.z in the cdrom directory.

cdrom

Contains an image of the installation package that can be transferred to distribution media. DataBlade module developers can rename this directory to the name of the DataBlade module before creating a tar file.

UNIX
For UNIX platforms, this directory contains an install shell script and other files that the install script uses during installation.

Windows NT
For Windows NT, this directory contains Setup.exe and other files that support an InstallShield installation.

disk1, disk2...diskn

Contain files needed for an InstallShield installation, with files split to fit on 1.4 MB diskettes. The disk1 directory contains Setup.exe and the files required to begin a diskette installation.

support

Contains copies of files to support the installation, such as project files, .dll files, and bitmap images. Its contents are not distributed with your installation package.

folder_tree

Contains a directory tree containing the contents of all of the directories to be included in the installation package. The contents of this directory are not distributed with your installation package.

Installation Screen Display Text

BladePack provides default text strings for the InstallShield installation wizard screens for Windows. You can override some of these text strings. For example, in the Select Installation Type wizard, you can change the text that appears next to the words Typical, Compact, and Custom to provide your own definitions for these three types of installations. When you save a BladePack project, BladePack saves any new string definitions in the appropriate string files.

You can change the title of the Main Screen screen. The default title is Installation for Project, where Project is the name of your BladeSmith project.

The InstallShield wizard screens, with the default text provided by BladePack, are shown in the following figures.

Figure 10-2
Installation Options

You can edit the instructions at the top of the Installation Options screen and the text to the right of the words Typical, Compact, and Custom with BladePack.

Figure 10-3
Select Installation Components

You can edit the instructions at the top of the Select Installation Components screen with BladePack.

Figure 10-4
Select Folder for Informix Applications

You can edit the instructions at the top of the Select Folder for Informix Applications screen and the default program folder with BladePack.

Figure 10-5
Ready to Install Files

You can edit the instructions at the top of the Ready to Install screen with BladePack.

Figure 10-6
Setup Complete

You can edit the instructions at the top of the Setup Complete screen with BladePack.

Figure 10-7
Setup Complete, Reboot Required

You can edit the instructions at the top and the bottom of the Setup Complete, Reboot Required screen with BladePack.

Creating Distribution Media

To ensure that customers can install DataBlade modules and other Informix products using common instructions, the product you distribute to must conform to the Informix DataBlade module installation standard. BladePack creates an interactive installation that ensures a consistent user interface.

To install a product from diskettes on a Windows platform, the installer executes the Setup.exe program on the first diskette. To create diskettes, copy the contents of the disk1 ... diskn directories to formatted 1.4 MB diskettes.

Warning: Put the Setup.exe program in a short path. Due to an InstallShield bug, if the path for Setup.exe is too long, it fails to execute.
To create all other types of media, use the cdrom directory in the build area.

Important: If you create a UNIX tar file, rename the cdrom directory to the name of your product before you copy the directory to media or the release area. For example, for the Circle DataBlade module, rename the cdrom directory to circle. (Do not include the version number in the directory name.)
Copy the renamed directory and its contents to the media or into the archive file. This makes it possible to distribute multiple products with their own installations on a CD-ROM or tape.

For example, to install the Circle DataBlade module from CD-ROM, the installer mounts the CD-ROM, changes to the circle subdirectory, and executes Setup (Windows platforms) or install (UNIX platforms).

To install the Circle DataBlade module from a file named circle3.6.tar, retrieved through a local network or the Internet, the installer extracts the file into a temporary directory, changes to the circle subdirectory, and executes install. When the installation has finished, the circle subdirectory can be removed.




DataBlade Developers Kit User's Guide, version 3.6
Copyright © 1998, Informix Software, Inc. All rights reserved.