Copyright: Copyright © 1981-1999 by Informix Software, Inc. or their subsidiaries.          DBDK BladeManager 3.2 1Build 17   Wednesday, May 07, 2003 11:19:46
Citation: Copyright © 1981-1999 by Informix Software, Inc. or their subsidiaries.


Term: Client Files
Client Files

Client files are the files that must reside on a client computer that accesses the DataBlade module objects. Client applications and client libraries that are specific to a DataBlade module are examples of client files. Not all DataBlade modules have client files.


Term: Informix Client Workstation
IBM Informix Client Workstation

A computer that accesses objects stored on an IBM Informix database server.


Term: Database Server
Database Server

A database server is a system that manages one or more shared databases and processes database requests sent from client workstations.


Term: DataBlade Module
DataBlade Module

A collection of database objects and supporting code that extend the database server by adding new types, functions, casts, aggregates, or access methods; for example, images or HTML-encoded text.


Term: Installation (Client)
Installation (Client)

A DataBlade module is installed on a client workstation when client files are copied to the client workstation and, if applicable, registered on the client. Client installation is necessary only when the client workstation needs local files to perform actions such as retrieving and verifying data.


Term: Installation (Server)
Installation (Server)

A DataBlade module is installed on a server when the module's files are copied from distribution media to the server computer's file system.


Term: Installation Directory
Installation Directory

The installation directory is the directory in which you installed the IBM Informix software on this client machine. On an NT workstation, the directory is recorded in the registry in key HKEY_CURRENT_USER/SOFTWARE/Informix/Environment/Informixdir.


Term: Registration
Registration

Registering a DataBlade module in a database loads the module's type and function definitions into the database. Registration makes a DataBlade module available for use by client applications that open that database.


Term: Unregistration
Unregistration

Unregistering a DataBlade module from a database removes the module's type and function definitions from the database.


Term: Upgrade
Upgrade

Upgrading a DataBlade module performs the create and drop operations required to change, add, or remove database objects. An upgrade operation does not make changes for any object whose definition has not changed. After an upgrade operation the new module is registered and the old module is no longer registered.


About BladeManager

BladeManager manages DataBlade modules within an IBM Informix database.

BladeManager Tasks

You can use BladeManager to:

•	Register a DataBlade module in a database.

•	Unregister a DataBlade module from a database.

•	Upgrade a DataBlade module.

•	Install a DataBlade module's client files on a client workstation or remove the files from a workstation.

•	View information about currently installed DataBlade modules and about the registration procedure.

BladeManager Documentation

BladeManager help describes how to use the BladeManager window and commands. For additional information about BladeManager, see the DataBlade Module Installation and Registration Guide.

DataBlade Developers Kit

The DataBlade modules you manage with BladeManager can be created with the DataBlade Developers Kit. The DataBlade Developers Kit is a suite of applications for developing DataBlade modules and packaging the modules for installation in a database server.

For additional information, see the DataBlade Developers Kit User's Guide, on-line release notes, and the on-line help for each application.

Related topics


About Registration

Registering a DataBlade module in a database makes that module available to users of the database. As a result, users can create tables that contain data types defined by the DataBlade module and can run DataBlade module functions on the tables.

You can register a DataBlade module in as many databases as necessary.

Prerequisites

Before you can register a DataBlade module, the module's files must be installed on the server. Normally the files are installed from a tape or CD provided by the DataBlade module vendor. For details, see the DataBlade Module Installation and Registration Guide.

You cannot unregister a module if tables or indexes in the database depend on it. For example, if a table exists that has a column of a type defined by the module, an attempt to unregister the module will fail.

Upgrade

You upgrade a DataBlade module by registering a new version of the module. BladeManager performs the database operations required to support the changes between versions. After an upgrade operation the new module is registered and the old module is no longer registered. If the upgrade fails, BladeManager restores the database to its state before the upgrade.

Related topics


About Client Files

Client files are installed on the server with the other DataBlade module files and should be copied to each client workstation that accesses the DataBlade module's objects. Examples include:

•	Stand-alone client programs for storing and retrieving data from the database

•	Linkable client libraries for use by developers

•	Help files

•	README files

Not all DataBlade modules provide client files. For those that do, BladeManager can copy the files to the client workstation.

Related topics


BladeManager Window

This is the main window of the BladeManager application. It is divided into tabbed pages.

Pages

•	Databases: Use this page to register and unregister DataBlade modules and to select a server before displaying the other tabbed pages.

•	Client Files: Use this page to install and remove files on a client workstation.

•	Logs: Use this page to view and delete log files created during registration or unregistration of DataBlade modules.

•	Module Info: Use this page to see the description of a DataBlade module and its vendor.

Action Buttons

•	Apply works with controls in the Databases page.

•	Exit closes the BladeManager application.

•	Help displays help for the active page.

Note

The About BladeManager command is located on the System menu, which is accessible in the upper left corner of the dialog window.


Databases Page

The Databases page is one of the tabbed pages of the BladeManager window. Use it to view and change DataBlade module registration status.

List Boxes

•	Databases: An expandable tree display that displays the available databases on each server. You must select a database before you can display any of the other BladeManager pages. When you select a database in this box, the database you select becomes the relevant database for modules listed in the Registered and Available list boxes.

•	Registered: DataBlade modules that are registered in the current database.

•	Available: DataBlade modules that are installed on the server.

Action Buttons

•	Remove starts the process of unregistering one or more DataBlade modules from the current database. When you click Remove, BladeManager moves the selected names in the Available box to the Registered box. BladeManager does not actually perform the unregistration process until you click the Apply button.

•	Add starts the process of registering one or more DataBlade modules in the current database. When you click Add, BladeManager moves the selected names in the Available box to the Registered box. BladeManager does not actually perform the registration process until you click the Apply button.

•	Apply performs the registration and unregistration actions you have selected with the Remove and Add buttons. The Apply action affects only the current database.

Related topics


Client Files Page

The Client Files page is one of the tabbed pages of the BladeManager window. When a DataBlade module requires files to reside on a client, you can use the Client Files page to install the files in the Informix installation directory on your workstation.

  Tip

Select a server on the Database page before you display the Client Files page.

List Boxes

•	DataBlade modules on server that have client files: The DataBlade modules on the current server that have client files associated with them. Select a module from this list if you want to install the files on your workstation.

•	DataBlade modules with files installed on this client: The DataBlade modules whose client files are installed on your workstation. Select a module from this list if you want to remove the files from your workstation.

Action Buttons

•	Install copies the client files for the selected DataBlade module onto your workstation.

•	Remove deletes the client files for the selected DataBlade module from your workstation.

Related topics


Logs Page

The Logs page is one of the tabbed pages of the BladeManager window. Use it to view and delete BladeManager's execution log files. Execution log files show the actions taken by the registration and unregistration processes; log files are useful in confirming the actions taken by BladeManager and in determining the causes of problems.

  Tip

Select a server on the Database page before you display the Client Files page.

Display Field

The main text box lists the available log files by date. The logs are text files located in a subdirectory of the TEMP directory. The name of this directory appears in the workstation's TEMP environment variable.

Action Buttons

•	View displays the selected log file in the Log Viewer dialog box.

•	Delete deletes the selected log file.

•	Delete All deletes all log files.

Related topics


Module Info Page

The Module Info page is one of the tabbed pages of the BladeManager window. Use it to display descriptions of DataBlade modules and their vendors.

  Tip

Select a server on the Database page before you display the Module Info page.

List Box

•	DataBlade modules: Displays the names of DataBlade modules installed on the current server. Selecting a module in this box makes it the current module for display in the fields at the left.

Display Fields

•	Module: Two fields. One displays the module name; the other displays the module description.

•	Vendor: Two fields. One displays the vendor name; the other displays the vendor description.

Related topics


About Dialog Box

The About dialog box appears when you select the About BladeManager command from the System menu , which is accessible in the upper left corner of the BladeManager window.

Use this dialog box to view copyright and version information about the BladeManager application.


Log Viewer Dialog Box

The Log Viewer dialog box displays the text of a log file you selected to view in the BladeManager window. As BladeManager registers or unregisters a DataBlade module, it writes error and progress messages to this file.

Use this dialog box to examine the results of a registration or unregistration procedure.

Related Topics


User Login Dialog Box

This dialog box appears when you select from the Databases list box a server or database to which you do not have access rights. To work with this database and server, enter the name and password that grants access and click OK.


Registering a DataBlade Module

The owner of a database typically registers DataBlade modules. The registration process typically grants all necessary usage permissions on the DataBlade module's elements to the public.

To register DataBlade modules

1	Display the Databases page of the BladeManager window.

2	In the Databases list box, expand the server that contains the database by double-clicking its icon. If you do not have permission to access the server, the User Login dialog box prompts you to enter a user name and password that have the appropriate permissions.

If a server you want to access does not appear in the list, run the Setnet32 utility to add it.

3	Select the target database. If you do not have permission to access the database, the User Login dialog box prompts you to enter a user name and password that have the appropriate permissions.

The Registered and Available list boxes display the current status of the selected database.

4	For each module you want to register, select the module name in the Available list box and click the Add button.

5	When the list is complete, click the Apply button.

6	Optionally, check the log file to confirm the registration.

Related topics


Installing Client Files

The BladeManager client installation process installs client files on the workstation running BladeManager. To install client files on multiple workstations, you must run BladeManager on each.

To install client files

1	Display the Databases page of the BladeManager window.

2	In the Databases list box, expand the server that contains the client files by double-clicking its icon. If you do not have permission to access the server, the User Login dialog box prompts you to enter a user name and password that have the appropriate permissions.

If a server you want to access does not appear in the list, run the Setnet32 utility to add it.

3	Display the Client Files page of the BladeManager window.

4	In the list box at the left, select the DataBlade module whose files you want to install and click the Install button. BladeManager installs the files and displays the name of the DataBlade module in the list box on the right side of the page.

Related topics


Removing Client Files

Removing a DataBlade module's client files is possible only if the files are available for deletion. If a file is set to read-only status or is busy, BladeManager cannot remove the file. If the removed file has an associated icon in the Program Manager or Start menu, you must remove the icon separately.

To remove client files

1	Display the Databases page of the BladeManager window.

2	In the Databases list box, expand the server that contains the client files by double-clicking its icon. If you do not have permission to access the server, the User Login dialog box prompts you to enter a user name and password that have the appropriate permissions.

If a server you want to access does not appear in the list, run the Setnet32 utility to add it.

3	Display the Client Files page of the BladeManager window.

4	In the list box at the right, select the DataBlade module whose client files you want to remove and click the Remove button. BladeManager removes the client files from your workstation.

Related topics


Unregistering a DataBlade Module

The user who unregisters a DataBlade module must be the person who registered it or someone with the same or better database permissions.

Note

Before you can unregister a DataBlade module, you must ensure that the database's tables do not store any of the DataBlade module's types. If you attempt to unregister a DataBlade module that is used in a table, the unregistration will fail, and the module will continue to be available.

To unregister DataBlade modules

1	Display the Databases page of the BladeManager window.

2	In the Databases list box, expand the server that contains the database by double-clicking its icon. If you do not have permission to access the server, the User Login dialog box prompts you to enter a user name and password that have the appropriate permissions.

If a server you want to access does not appear in the list, run the Setnet32 utility to add it.

3	Select the target database. If you do not have permission to access the database, the User Login dialog box prompts you to enter a user name and password that have the appropriate permissions.

4	For each module you want to unregister, select the module name in the Registered list box and click the Remove button.

5	When the list is complete, click the Apply button.

6	Optionally, check the log file to confirm the unregistration.

Related topics


Displaying Information

BladeManager lets you display information about the DataBlade modules on the current server.

To select the server whose information you want to see

1	Display the Databases page of the BladeManager window.

2	In the Databases list box, expand the server that contains the database by double-clicking its icon. If you do not have permission to access the server, the User Login dialog box prompts you to enter a user name and password that have the appropriate permissions.

If a server you want to access does not appear in the list, run the Setnet32 utility to add it.

To see information about a DataBlade module

1	Display the Module Info page of the BladeManager window.

2	In the DataBlade modules list, select the module's name.

3	The right side of the page displays the name and description of both the module and the module's vendor.

To see the log file for a registration or unregistration

1	Display the Logs page of the BladeManager window.

2	Select the log you want to see and click the View button. The Log Viewer dialog box is displayed, showing the text of the log.

3	Read the log and then click Close to close the dialog box.

4	Optionally, delete the log file by clicking Delete. Click Delete All to delete all the log files.

Related topics


Upgrading to a Newer Version

The user who upgrades a DataBlade module must be the person who registered it or someone with the same or better database permissions.

Note

If the upgrade fails, BladeManager restores the database to its state before the upgrade.

To upgrade DataBlade modules

1	Display the Databases page of the BladeManager window.

2	In the Databases list box, expand the server that contains the database by double-clicking its icon. If you do not have permission to access the server, the User Login dialog box prompts you to enter a user name and password that have the appropriate permissions.

If a server you want to access does not appear in the list, run the Setnet32 utility to add it.

3	Select the target database. If you do not have permission to access the database, the User Login dialog box prompts you to enter a user name and password that have the appropriate permissions.

4	For each module you want to upgrade, select the module name in the Available list box and click the Add button. The name appears in the Registered list box. The name also appears in parentheses next to the currently registered modules that will be replaced by the new module.

5	When the list is complete, click the Apply button. BladeManager registers the new module and unregisters the old module.

6	Optionally, check the log file to confirm the registration and unregistration.

Related topics


About BladeManager Help

This is on-line help for BladeManager users.

BladeManager Version 4.0
Help Build 1
May 2003

© Copyright International Business Machines Corporation 2003. All rights reserved.

Trademarks

AIX; DB2; DB2 Universal Database; Distributed Relational Database Architecture; NUMA-Q; OS/2, OS/390, and OS/400; IBM Informix®; C-ISAM®; Foundation.2000™; IBM Informix® 4GL; IBM Informix® DataBlade“ Module; Client SDK™; Cloudscape™; Cloudsync™; IBM Office Connec™; IBM Informix® Driver for JDBC; Dynamic Connect™; IBM Informix® Dynamic Scalable Architecture™ (DSA); IBM Informix® Dynamic Server™; IBM Informix® Enterprise Gateway Manager (Enterprise Gateway Manager); IBM Informix“ Extended Parallel Server™; i. Financial Services™; J/Foundation™; MaxConnect™; Object Translator™; Red Brick Decision Server™; IBM Informix“ SE; IBM Informix“ SQL; InformiXML™; RedBack® ; SystemBuilder™; U2™; UniData“; UniVerse® ; wintegrate“ are trademarks or registered trademarks of International Business Machines Corporation.

Java and all Java-based trademarks and logos are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries.

Windows, Windows NT, and Excel are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.

UNIX is a registered trademark in the United States and other countries licensed exclusively through X/Open Company Limited.

Other company, product, and service names used in this publication may be trademarks or service marks of others.


Contacting IBM

We continually strive to improve the quality and usability of our documentation. We appreciate any suggestions you have about our on-line help or printed materials. You can email documentation comments to docinf@us.ibm.com.