Printing Record Definitions

You can print your record definitions as references identifying all of the fields and their various attributes—any special use, edits, or PeopleCode that you applied.

To print a record definition, it must be open in the object workspace.

To print a record definition:

  1. Select File, and then Print Setup to change any of the print record defaults.

    The system retains your changes until you reset them again. The Print Setup dialog box appears.

  2. Select printing options.

    Field or Control Description

    Definition

    Print a picture of what the definition looks like.

    PeopleCode

    Select if you want the report to include a listing of any PeopleCode programs that are attached to each field, identifying the program type and listing all of the PeopleCode statements. Selected by default.

    Graphics

    Not used for record definition printing.

    Margins(mm) [margins (millimeters)]

    Set the distance (in millimeters) from the edge of the page to the left, right, top, and bottom edges of the page image or report. The defaults are: 20 (top), 5 (bottom), 5 (left), and 0 (right).

    Header

    Print a header at the top of the report indicating the date and time at which you printed the report and the database name, record name, version number, and page number. Selected by default.

    Footer

    Print a footer at the bottom of the report indicating the date and time at which you printed the report and the database name, record name, version number, and page number. Deselected by default.

    Border

    Print a border or box around a record definition report. To print reports faster, clear this check box so that the printer can print the report in character mode, rather than in graphics mode. Deselected by default.

    Border Space(mm)

    Insert a set amount of space between a graphical boarder around the record definition report and the margins of the report. The default value is 3.

  3. Click OK when you are done, to close the Print Setup dialog box and save your settings.

  4. Select File, and then Print.

Record Definition Report

The following table lists the columns in the record definition report and their contents:

Column Contents

Field Name

The name of the field.

Type

The field type.

Length

The length of the field (not specified for long character fields).

Format

The field format.

Long Name

The 30-character name of the field.

Short Name

The 15-character name of the field.

Key

Identifies key attributes (characters defined by position).

Req (required)

Yes indicates that the field is required.

TblEdt (table edit)

Prompt: Field values are edited against a specified prompt table.

Y/N: The field uses the Yes/No Table.

Xlat: The field has values in the translate table. Values (if printed) are listed below the field.

AU (auto-update)

Yes indicates that the auto-update option is enabled.

Dt (date)

Yes indicates that the reasonable date option is enabled.

PC (PeopleCode)

Yes indicates that the field contains PeopleCode. PeopleCode text (if printed) appears below the field.

Aud (audit)

Yes: The field audit flag is enabled.

A: Audit add.

C: Audit change.

D: Audit delete.

Prompt Table

The name of the prompt table.

Default Value

Any default value or constant.

You might also see these additional reference lines below each field or at the end of the report:

Reference Description

SQL View

Shows the SQL view Select statement for view-type record definitions. This appears at the top of the report.

System Maintained

Indicates that the System Maintained check box is selected. Because this option is for documentation purposes only, it doesn’t warrant its own column heading.

DbField Help Context: nnn

Indicates that the field has been assigned a field help context number to link it to a help file that describes how the field is used wherever it appears in the database.

RecField Help Context: nnn

Indicates that the field has been assigned to a record field help context number to link it to a help file that describes how the field is used only as it appears in this record definition.

Audit Record

Identifies a user-defined audit record. Lists the audit record name and the type of audit.

Set Control Field

Identifies a set control field that is designated for the record definition.

Related Language Record

Identifies a related language record that is designated for the record definition.

Query Security Record

Identifies views that are used to restrict query access to data that is stored in the table.

Parent Record Name

Identifies the hierarchical relationship of the record for query reporting.

Printing records with subrecords takes into account whether the record view is expanded or collapsed. If the record view is expanded, the subrecord fields are indented to the appropriate level of nesting.