Common Parameters

This table describes the common parameters for Begin Document:

Name

Alias

I/O

Description

Job Number

JOBS

I/O

Pass Job Number created in Begin Document, if previously called; otherwise, pass zeros and assign a job number.

Document Action

ACTN

I

A or 1 = Add

C or 2 = Change

D = Delete

This is the action of the entire Document, not the individual detail lines. For example, you might modify a few detail lines in Edit Line, add a few detail lines in Edit Line, and delete a few detail lines in Edit Line, but the Document Action in Begin Document would be Change.

Process Edits

EV01

I

Optional

0 = No Edits

Any Other = Full Edits

Note: The GUI interface usually uses the partial edit, and the batch interface uses the full edit. If you leave this parameter blank, the default option is full edits.

ErrorConditions

EV02

O

Blank = No Errors

1 = Warning

2 = Error

Version

VERS

I

This field is required if this MBF is using versions.

Header Field One

****

I/O

Pass in all the header fields that are common to the entire document. Begin Document processes all of these fields and validates them, data dictionary edits, UDC editing, default values, and so on. Begin document might also fetch to the table to validate that records matching these header fields exist for Delete and Change, or do not exist for Add.

Header Field Two

****

I/O

N/A

.

.

.

****

I/O

N/A

Header Field XX

****

I/O

N/A

Work Field / Processing Flag One

****

I

List any work fields that the program needs. These could be flags for processing, dates to validate, and so on. These fields might or might not be used. For example, currency control might be saved in the header cache so that all detail records would either use currency or not.

Work Field / Processing Flag One

****

I

N/A

.

.

.

N/A

I

N/A

Work Field / Processing Flag One

N/A

I

N/A