WebFOCUS API Developer's Reference

Feedback

Copyright © 2011 Information Builders

This documentation describes how to use the WebFOCUS API. It is intended for developers using the WebFOCUS API to implement WebFOCUS functionality.

How This Manual Is Organized

This manual includes the following chapters:

Chapter/Appendix

Contents

1

Introduction to WebFOCUS API

Provides an overview of the functionality available through the WebFOCUS API and information on installation and requirements.

2

WebFOCUS API Functionality

Describes the parameters used by WebFOCUS API and provides examples of their use.

3

WebFOCUS API Samples

Illustrates the use of the WebFOCUS API through JSP samples.

4

Troubleshooting

Provides information about troubleshooting the WebFOCUS API.

Documentation Conventions

The following table lists and describes the conventions that apply in this manual.

Convention

Description

THIS TYPEFACE

or

this typeface

Denotes syntax that you must enter exactly as shown.

                  this typeface                

Represents a placeholder (or variable) in syntax for a value that you or the system must supply.

                  underscore                

Indicates a default setting.

this typeface

Represents a placeholder (or variable), a cross-reference, or an important term. It may also indicate a button, menu item, or dialog box option you can click or select.

this typeface

Highlights a file name or command.

Key + Key

Indicates keys that you must press simultaneously.

{  }

Indicates two or three choices; type one of them, not the braces.

[  ]

Indicates a group of optional parameters. None are required, but you may select one of them. Type only the parameter in the brackets, not the brackets.

|

Separates mutually exclusive choices in syntax. Type one of them, not the symbol.

...

Indicates that you can enter a parameter multiple times. Type only the parameter, not the ellipsis points (...).

.

.

.

Indicates that there are (or could be) intervening or additional commands.

Related Publications

To view a current listing of our publications and to place an order, visit our Technical Documentation Library, http://documentation.informationbuilders.com. You can also contact the Publications Order Department at (800) 969-4636.

Customer Support

Do you have any questions about this product?

Join the Focal Point community. Focal Point is our online developer center and more than a message board. It is an interactive network of more than 3,000 developers from almost every profession and industry, collaborating on solutions and sharing tips and techniques, http://forums.informationbuilders.com/eve/forums.

You can also access support services electronically, 24 hours a day, with InfoResponse Online. InfoResponse Online is accessible through our World Wide Web site, http://www.informationbuilders.com. It connects you to the tracking system and known-problem database at the Information Builders support center. Registered users can open, update, and view the status of cases in the tracking system and read descriptions of reported software issues. New users can register immediately for this service. The technical support section of www.informationbuilders.com also provides usage techniques, diagnostic tips, and answers to frequently asked questions.

Call Information Builders Customer Support Service (CSS) at (800) 736-6130 or (212) 736-6130. Customer Support Consultants are available Monday through Friday between 8:00 a.m. and 8:00 p.m. EST to address all your questions. Information Builders consultants can also give you general guidance regarding product capabilities and documentation. Please be ready to provide your six-digit site code number (xxxx.xx) when you call.

To learn about the full range of available support services, ask your Information Builders representative about InfoResponse Online, or call (800) 969-INFO.

Information You Should Have

To help our consultants answer your questions effectively, be prepared to provide the following information when you call:

User Feedback

In an effort to produce effective documentation, the Documentation Services staff welcomes your opinions regarding this manual. Please use the Reader Comments form at the end of this manual to communicate suggestions for improving this publication or to alert us to corrections. You can also use the Documentation Feedback form on our Web site, http://documentation.informationbuilders.com/feedback.asp.

Thank you, in advance, for your comments.

Information Builders Consulting and Training

Interested in training? Information Builders Education Department offers a wide variety of training courses for this and other Information Builders products.

For information on course descriptions, locations, and dates, or to register for classes, visit our World Wide Web site (http://www.informationbuilders.com) or call (800) 969-INFO to speak to an Education Representative.