APPLY

APPLY — which actions are applied to database, when, and at what validation level

Synopsis

Content model

APPLY ::=
EMPTY

Attributes

NameTypeDefaultDescription
whichEnumeration:
none
data
msg
qc
none

The value for this attribute is one or more (space-delimited) words from the enumerated list. Inclusion of a word in the attribute value indicates that the batch is interested in the action of this operation.

Edit checks operate in three distinct areas:

  • data - changes that are made to data field values
  • qc - addition/modification of queries to data fields by dfaddqc() and dfeditqc or missing page query operations by dfaddmpqc() and dfdelmpqc()
  • msg - messages that are generated by dfmessage(), dfwarning(), and dferror()

none is beneficial only when used on its own. Specifying another word in addition to none is the same as not specifying none at all. For example,

which="none msg"

is equal to

which="msg"

whenEnumeration:
all
changes
NoneIf the value is all, every record, or edit check (in the case of LOG), every action is taken. If the value is changes, only those records which are changed, or edit checks (in the case of LOG) that cause a change, are actioned.
levelEnumeration: 1, 2, 3, 4, 5, 6, 7 None

Level specifies the validation level that should be assigned to processed records when they are written back to the database [a]. The level may never be greater than the maximum validation level permitted to the user.

If the level is not specified, the validation level of the record is not changed. This is equivalent to working in Edit mode in DFexplore.

[a] A processed record (a data record) will be written back to the database when:

  • the data record has been changed by one or more edit checks and which="data" has been specified, or

  • the data record has not been changed, which="data" and when="all" have been specified, and the record's current validation level does not match the level specified in level="#", or

  • a query has been added or changed, which="qc" has been specified (so the query is written), and the record's current validation level does not match the level specified in level="#".

Description

Parents

These elements contain APPLY: ACTION.

Children

The following elements occur in APPLY: None.

Examples

Example 6.28. Apply no changes to the database - this is the recommended usage for this element

<APPLY which="none"/>

Example 6.29. Apply all records to the database that have had data fields modified, qc notes added or deleted, or messages generated and assign those records a validation level of 2

<APPLY
        when="all"
        which="data msg qc"
        level="2"
/>