INFORMIX
DataBlade Developers Kit User's Guide
Chapter 1: Getting Started with DataBlade Module Development
Home Contents Index Master Index New Book

Developing DataBlade Modules

This section provides an overview of how to develop DataBlade modules. This overview is intended to act as a map for information resources.

To create a DataBlade module, complete these general processes:

    1. If necessary, familiarize yourself with Informix software and documentation (see "Becoming Familiar with Informix Software and Documentation," next).

    2. Design your DataBlade module (see "Designing Your DataBlade Module").

    3. Create your DataBlade module with BladeSmith. This process can be iterative (see "Creating Your DataBlade Module").

    4. Finish your DataBlade module (see "Finishing Your DataBlade Module").

Becoming Familiar with Informix Software and Documentation

Familiarizing yourself with Informix software and documentation is critical for first-time DataBlade developers. However, it is important for experienced DataBlade developers too; Informix software and documentation are enhanced in each release.

To familiarize yourself with Informix products and documentation

    1. Read DataBlade Module Development Overview.

    This manual briefly describes the database objects you can include in your DataBlade module and other options you have when creating a DataBlade module.

    2. Join the DataBlade Partners Program, if appropriate.

    3. Install the necessary Informix software.

    4. Learn to use Informix software: at the very least, Informix Dynamic Server with Universal Data Option, the Setnet32 utility (client connectivity), and the DB-Access or SQL Editor utilities (SQL querying).

    5. Complete the DataBlade Developers Kit Tutorial.

    6. Create your own practice DataBlade module.

Some of these steps are described in the following sections.

The DataBlade Partners Program

If you are developing a DataBlade module as a commercial product, join the DataBlade Partners Program. The DataBlade Partners Program helps third-party DataBlade developers create and market new DataBlade modules. The program offers tools, training, and joint marketing opportunities. If you join the program, you can have your DataBlade module certified by Informix. Certification verifies that your DataBlade module programming and business practices comply with Informix quality standards.

Important: If you plan to have your DataBlade module certified by Informix, you must be a member of the DataBlade Partners Program.
For information on enrollment requirements and benefits, send email to datablades@informix.com.

Installing Informix Software

To develop a DataBlade module, install these Informix software products:

Install the latest version of the Informix software for your development platform. Although the DataBlade Developers Kit is only available on Windows NT, it can generate DataBlade modules for UNIX as well as Windows NT platforms.

For information on currently available Informix software releases, see the Informix Developer Network Web site at http://www.informix.com/idn.

DataBlade Developers Kit Tutorial

The DataBlade Developers Kit Tutorial offers several exercises, each focusing on a single aspect of DataBlade module development.

To access the tutorial exercises, start the tutorial from the DataBlade Developers Kit InfoShelf home page. You can launch the InfoShelf from the BladeSmith Help menu or start it independently by choosing Start Programs Informix DBDK InfoShelf.

Creating a Practice DataBlade Module

To familiarize yourself with the entire development process, create a simple practice DataBlade module containing an easily implemented object, such as a user-defined routine that takes built-in data types as arguments. Be sure to write the code, test it, and debug it. Completing a simple DataBlade module helps you create a realistic estimate of the length of your development cycle.

Designing Your DataBlade Module

DataBlade modules can contain complex operations. A good design is critical to your success.

To design your DataBlade module

    1. Read about DataBlade module design concepts.

    2. Write a functional specification.

    3. Read Informix coding guidelines.

    4. Write a design specification.

Some of these steps are described in the following sections.

Writing a Functional Specification

A functional specification describes the scope and functionality of your DataBlade module, without documenting implementation details. It also documents other issues for development, such as phases of functionality, compatibility, performance, and platform. A good functional specification shows how your DataBlade module solves the problem you designed it to solve.

For a sample functional specification, see the Informix Developer Network Web site, http://www.informix.com/idn.

Programming Resources

The following table lists the programming language options you have when writing DataBlade module code, and refers you to sources of information about them.
Language Information Sources

C

Chapter 4, "C Programming Guidelines"

Chapter 5, "Programming DataBlade Module Routines in C"

DataBlade API Programmer's Manual

ActiveX/C++
(opaque data types and their support routines only)

Chapter 6, "Creating ActiveX Value Objects"

Chapter 7, "Using ActiveX Value Objects"

Stored Procedure Language (SPL)

Informix Guide to SQL: Tutorial

For further tips on coding DataBlade modules, see the Informix Developer Network Web page, http://www.informix.com/idn.

Writing a Design Specification

A design specification describes the overall functionality of your DataBlade module and documents the specific routines available to the user, the supporting database tables used to implement the routines, error messages, and the environment used to build the DataBlade module. A design specification also documents implementation details that the DataBlade module customer does not need to know, such as internal support routines.

If you plan to have your DataBlade module certified by Informix, you must provide a detailed design specification.

For a sample design specification, see the Informix Developer Network Web page, http://www.informix.com/idn.

Creating Your DataBlade Module

Creating a DataBlade module is an iterative process that involves creating objects in BladeSmith, generating code, editing and compiling code, and testing and debugging code. When you identify errors, you must repeat the process to correct errors. DataBlade development can be iterative in another way: you can create objects in BladeSmith one by one, coding and testing each one before creating the next.

To create your DataBlade module

    1. Create an iterative development strategy.

    2. Contact the Informix DataBlade Development Partners Program registry for a name, prefix, and error codes for your production DataBlade module. Skip this step if you are not creating a production DataBlade module.

    3. Create a project in BladeSmith.

    4. Define the contents of your DataBlade module in BladeSmith.

    5. Generate DataBlade module code in BladeSmith.

    6. Edit and compile DataBlade module code.

    7. Test and debug your DataBlade module code.

    8. Repeat steps 4 through 7 until your DataBlade module is complete and the code functions properly.

Some of these steps are described in the following sections.

Creating an Iterative Development Plan

Although you can define all your DataBlade objects in BladeSmith before editing and testing the code, it is much easier to find and solve coding problems when you define, code, and test objects individually.

Keep these guidelines in mind when you create an iterative development plan:

    Some objects can depend on others; you must create new data types before you create the routines that operate on them. Create simple data types and routines before complex ones. Create objects in the smallest independently testable groups. For example, you can test an opaque data type and its support routines without any other objects. However, because the tests generated by BladeSmith only work on routines, if you want to test a row data type, you must first create a routine that operates on it.

Contacting the Informix Registry

Before you begin to create a production DataBlade module, send an email message to registry@informix.com to register the following information with the Informix DataBlade Developers Program registry:

    Using this format, a DataBlade module can have up to 1,296 error codes. If you anticipate no more than 36 error codes, you can use the three-character object name prefix in the second, third, and fourth positions, and the digits 0 through 9 and letters A through Z in the fifth position.

Finishing Your DataBlade Module

When your DataBlade module is ready for distribution, you create an installation package with BladePack. After packaging, your DataBlade module is ready to be certified by Informix.

To finish your DataBlade module

    1. Package your DataBlade module for distribution.

    2. Submit your DataBlade module for certification, if appropriate.

These steps are described in the following sections.

Packaging Your DataBlade Module

You can create an interactive installation program with BladePack. The files you must include for a DataBlade module are the shared library file, or dynamic link library, and the generated SQL scripts. However, consider including:

See Chapter 10, "Using BladePack," for more information.

Certifying Your DataBlade Module

If you intend to market your DataBlade module commercially, consider having it certified by Informix. Certification verifies that your DataBlade module programming and business practices comply with Informix quality standards. After your DataBlade module is certified, you can advertise using the Informix certification logo, and your company is eligible to participate in DataBlade module sales and marketing programs.

The Informix certification program ensures that your customers receive high-quality DataBlade modules and assists your company in marketing and selling your DataBlade modules.

Before you apply for certification, you must be a member of the DataBlade Development Partners Program. Send email to datablades@informix.com for more information.




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