Using Functions

Feedback

This documentation describes how to use functions to perform certain calculations and manipulations. It is intended for application developers. This manual is part of the FOCUS documentation set.

The documentation set consists of the following components:

The Creating Reports manual describes FOCUS Reporting environments and features.
The Describing Data manual explains how to create the metadata for the data sources that your FOCUS procedures will access.
The Developing Applications manual describes FOCUS Application Development tools and environments.
The Maintaining Databases manual describes FOCUS data management facilities and environments.
The Using Functions manual describes internal functions and user-written subroutines.
The Overview and Operating Environments manual contains an introduction to FOCUS and FOCUS tools and describes how to use FOCUS in the VM/CMS and z/OS environments.

How This Manual Is Organized

This manual includes the following chapters:

Chapter/Appendix		Contents
1	Introducing Functions	Introduces functions and explains the different types of available functions.
2	Accessing and Calling a Function	Describes the considerations for supplying arguments in a function, and explains how to use a function in a command and access functions stored externally.
3	Character Functions	Describes character functions that manipulate alphanumeric fields and character strings.
4	Maintain-specific Character Functions	Describes Maintain-specific character functions that manipulate alphanumeric fields and character strings.
5	Data Source and Decoding Functions	Describes data source and decoding functions that search for data source records, retrieve data source records or values, and assign values based on the value of an input field.
6	Date and Time Functions	Describes date and time functions that manipulate date and time values.
7	Maintain-specific Date and Time Functions	Describes Maintain-specific date and time functions that manipulate date and time values.
8	Format Conversion Functions	Describes format conversion functions that convert fields from one format to another.
9	Numeric Functions	Describes numeric functions that perform calculations on numeric constants and fields.
10	System Functions	Describes system functions that call the operating system to obtain information about the operating environment or to use a system service.
11	Input/Output Functions	Describes input/output functions that use your operating environment’s input/output routines to open, close, and write records to sequentialflat files.
A	Creating a Subroutine	Describes how to create custom subroutines in addition to the functions provided by Information Builders.

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 questions about this product?

Call Information Builders Customer Support Services (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. Be prepared to provide your six-digit site code (xxxx.xx) when you call.

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. You can connect 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 also provides usage techniques, diagnostic tips, and answers to frequently asked questions.

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:

Your six-digit site code (xxxx.xx).
The stored procedure (preferably with line numbers).
The Master File and Access File.
Run sheet (beginning at login, including call to FOCUS), containing the following information:
- ? RELEASE
- ? FDT
- ? LET
- ? LOAD
- ? COMBINE
- ? JOIN
- ? DEFINE
- ? STAT
- ? SET/? SET GRAPH
- ? TSO DDNAME or CMS QFI
The exact nature of the problem:
- Are the results or the format incorrect? Are the text or calculations missing or misplaced?
- The error message and return code, if applicable.
- Is this related to any other problem?
Has the procedure or query ever worked in its present form? Has it been changed recently? How often does the problem occur?
What release of the operating system are you using? Has it, FOCUS, your security system, or an interface system changed?
Is this problem reproducible? If so, how?
Have you tried to reproduce your problem in the simplest form possible? For example, if you are having problems joining two data sources, have you tried executing a query containing just the code to access the data source?
Do you have a trace file?
How is the problem affecting your business? Is it halting development or production? Do you just have questions about functionality or documentation?

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.