Header File Sections

This table describes the major sections of a business function header file:

Section

What It Includes

Description and Guidelines

Header File Comment

  • Header file name

  • Description

  • History

  • Programmer

  • SAR number

  • Copyright information

Comments that the input process of the Business Function Source Librarian builds.

The programmer name and SAR number are manually updated by the programmer.

Table Header Inclusions

Include statements for header files associated with tables that are directly accessed by this business function.

Table header files include definitions for the fields in a table and the ID of the table itself.

External Business Function Header Inclusions

Include statements for headers associated with externally defined business functions that are directly accessed by this business function.

External function calls with jdeCallObject are included to use the predefined data structures.

Global Definitions

Global constants used by the business function.

Use global definitions sparingly. They include symbolic names that you enter in uppercase; words are separated by an underscore character.

Structure Type Definitions

Data structure definitions for internal processing.

To prevent naming conflicts, define this structure using structure names that are prefixed by the source file name.

DS Template Type Definition

Data structure type definitions generated by Business Function Design.

Symbolic constants for the data structure generated by Business Function Design.

Modify this structure through OMW.

Source Preprocessor

  • Undefines JDEBFRTN if it is already defined.

  • Checks for how to define JDEBFRTN.

  • Defines JDEBFRTN.

Ensures that the business function declaration and prototype are properly defined for the environment and source file, including this header.

Business Function Prototype

Prototypes for all business functions in the source file.

Defines the business functions in the source file, the parameters that are passed to them, and the type of value that they return.

Internal Function Prototype

Prototypes for all internal functions that are required to support business functions within this source file.

Defines the internal functions that are associated with the business functions in the source file, the parameters that are passed to each internal function, and the type of value that they return.